Skip to main content

IdP Groups API

The Platform IdP Groups API lists the identity provider (IdP) groups that Glean loads from the directory.

Use Cases

Directory Groups

List the IdP groups that Glean loads from the directory. Inactive groups are left out unless you filter for them.

Usage Limit Targets

Find the group IDs that other Platform APIs use, for example to name an IdP group as a usage limit target.

API Endpoints

MethodEndpointPurpose
GET/api/admin/idp-groupsList IdP groups

Use idp_group_id to name a group in other Platform APIs, for example as a usage limit target. 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.

The caller must be able to read the workspace configuration or the workspace billing.

These endpoints are experimental. Send X-Glean-Include-Experimental: true on each request, or they are not exposed.

For error responses, see Platform API Errors for the shared ProblemDetail code reference and remediation guidance.