Skip to main content
GET
List SCIM users

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: userName, emails.value, id, name.givenName, name.familyName, active. Supported operators: eq, ne, co, sw, ew. Example: userName eq "john@example.com".
startIndex
integer
default:"1"
1-based index of the first result to return.
count
integer
Maximum number of results to return. Capped at 100.

Response

schemas
string[]
Always ["urn:ietf:params:scim:api:messages:2.0:ListResponse"].
totalResults
integer
Total number of users 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 users. Each user has the same shape as the Get a SCIM user response.