List identities (search)
GET/identities/v2
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
List identities from the identities search index.
Use standard collection parameters for paging (limit, offset, count). Default page size is 25 when no collection parameters are sent. Maximum limit is 250. Requests that specify a larger limit are capped at 250. offset + limit cannot exceed 10,000. To page beyond that window, use searchAfter instead of a large offset. searchAfter cannot be combined with offset. Always include id in sorters when using searchAfter. Refer to Paginating Search Queries for more information.
privilegeLevel is returned when the IDNARC_ENABLE_IDENTITY_EFFECTIVE_PRIVILEGE feature flag is enabled. When the flag is disabled, privilegeLevel is null and a filter or sort on privilegeLevel.effective is rejected. When the flag is enabled, an identity with no privilege level is returned as NONE. Comparisons on privilegeLevel.effective are case-insensitive, and returned values are uppercase: HIGH, MEDIUM, LOW, or NONE. An identity with no privilege level matches privilegeLevel.effective eq "NONE" and does not match isnull.
Request
Responses
- 200
- 400
- 401
- 403
- 429
- 500
List of identity objects.
Response Headers
The total result count (returned when count=true is passed).
Client Error - Returned if the request body is invalid.
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
Internal Server Error - Returned if there is an unexpected error.