Skip to main content
GET
List SCIM groups

Authorizations

Authorization
string
required
This API uses OAuth 2.0 with the authorization code grant flow.

Query

filter
string
A SCIM filter expression. Supported attributes: displayName. Example: displayName eq "Engineering".
startIndex
integer
default:"1"
1-based index of the first result to return.
count
integer
Maximum number of results to return. Capped at 100.
excludedAttributes
string
Comma-separated list of attributes to exclude from results. Supports "members" to omit the members array for efficiency.

Response

schemas
string[]
Always ["urn:ietf:params:scim:api:messages:2.0:ListResponse"].
totalResults
integer
Total number of groups matching the filter.
startIndex
integer
The 1-based index of the first result returned.
itemsPerPage
integer
The number of results returned in this page.
Resources
object[]
The list of groups. Each group has the same shape as the Get a SCIM group response. When excludedAttributes=members is specified, the members field is omitted entirely from each group object.