IdP Groups

List IdP groups

Changed on

List the identity provider (IdP) groups that Glean loads from the directory, ordered by display_name and then by idp_group_id. Use idp_group_id to name a group in other Platform APIs. An IdP group is active when Glean loaded it from the directory. An IdP group is inactive when only a usage limit names it, for example after the group was removed from the identity provider. Inactive IdP groups are left out unless an is_active filter includes the value "false". Usage limits apply only to IdP groups from the datasource instance that the usage settings select, so use the provider_instance filter to list only those groups. Internal O365 ownership groups and SharePoint groups are left out. The caller must be able to read the workspace configuration or the workspace billing.

get/api/admin/idp-groups

Request

  • Base URL: https://instance-name-be.glean.com
  • URL: https://instance-name-be.glean.com/api/admin/idp-groups
  • Auth: HTTP bearer

Query parameters

page_sizeinteger

Maximum number of IdP groups to return. Defaults to 50. Maximum is 100.

cursorstring

Opaque pagination cursor from a previous response. Send the same filters that the previous request used.

JSON-encoded filters that choose which IdP groups are returned. The supported fields are is_active, with the values "true" and "false", and provider_instance, with datasource instance names such as "okta". provider_instance values match without case. The only supported operator is EQUALS. Multiple values OR within a filter. Multiple filters AND together. Without an is_active filter, only active IdP groups are returned. To return active and inactive IdP groups, send [{"field":"is_active","values":["true","false"]}].

Response

Successful response.

has_moreboolean required

Whether more IdP groups are available after this page.

next_cursorstring nullable

Opaque cursor for the next page; null or absent when has_more is false.

request_idstring required

Request identifier for correlating this response.

Changes