List or Search Users

Lists users with pagination or searches for users matching a SCIM filter expression. When a filter is provided, it takes precedence and pagination parameters are ignored. Without a filter, returns a paginated list of all users for the tenant. Supported filter operators: eq on attributes userName, emails.value, externalId.
When no filter is provided and pagination parameters are omitted, defaults apply: startIndex defaults to 1 and count defaults to 100.
Pagination follows RFC 7644 §3.4.2.4: startIndex < 1 is clamped to 1, negative count is treated as 0, and count=0 returns totalResults without resources.

Query Params
string

SCIM filter expression. Supported filters: userName eq "<value>", emails.value eq "<value>", externalId eq "<value>". The filter value must be URL-encoded. When omitted, a paginated user list is returned.

int32
Defaults to 1

1-based index of the first result to return (RFC 7644 §3.4.2.4). Values less than 1 are interpreted as 1. Defaults to 1 if omitted. Ignored when filter is present.

int32
Defaults to 100

Maximum number of results per page (RFC 7644 §3.4.2.4). Negative values are interpreted as 0. A value of 0 returns totalResults only. Values exceeding 200 are capped at 200. Defaults to 100 if omitted. Ignored when filter is present.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/scim+json