POST
/scim/v2/Users/.searchSearch SCIM users
Searches SCIM users using criteria supplied in the request body. Use filter to specify a resource filter, sortBy and sortOrder to control sorting, and startIndex and count to paginate results.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
SCIM search criteria for selecting, sorting, and paginating user resources; the request body is required.
attributesunknownoptional
A list of resource attribute names to include in the response.
countintegeroptional
The number of resources to retrieve.
excludedAttributesunknownoptional
A list of resource attribute names to exclude from the default response attributes.
filterunknownoptional
A filter expression for selecting user resources.
schemasarray<string>optional
SCIM search request schema identifiers; the defined value is `urn:ietf:params:scim:api:messages:2.0:SearchRequest`.
sortByunknownoptional
The field to sort results by.
sortOrderstringoptional
Order of sorting (ascending or descending).
startIndexintegeroptional
The starting index for pagination.
200Returns matching user resources and the total number of users found.
Resourcesarray<object>optional
schemasarray<string>optional
totalResultsintegeroptional
Total number of users found.
400Returned when the search request is invalid.
401Returned when the request is unauthenticated.
403Returned when the request is unauthorized.
500Returned when an internal server error occurs.
Error handling
A 400 is returned when the search request is invalid. A 401 is returned when the request is unauthenticated, and a 403 when it is unauthorized. A 500 indicates an internal server error; provide search criteria using fields such as filter, sortBy, or startIndex.