GET api/scim/users?filter={filter}&startIndex={startIndex}&count={count}

Retrieves a paginated list of SCIM users, optionally filtered by a SCIM-compliant filter expression.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
filter

Optional SCIM filter expression to narrow down the user results. Example: `userName eq "jdoe"`

string

None.

startIndex

The 1-based index of the first result to return. Defaults to 1.

integer

Default value is 1

count

The maximum number of results to return. Defaults to -1 (interpreted as 5000 max).

integer

Default value is -1

Body Parameters

None.

Response Information

Resource Description

On success: HTTP 200 OK with a SCIM-compliant list response containing user data. On failure: HTTP 400 Bad Request if an error occurs during processing.

IHttpActionResult

None.

Response Formats

application/json, text/json, application/scim+json

Sample:

Sample not available.