List Identities
GET {{baseUrl}}/identities
This API returns a list of identities.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filters | string | Filter results using the standard syntax described in V3 API Standard Collection Parameters |
Filtering is supported for the following fields and operators:
id: eq, in
name: eq, sw
alias: eq, sw
firstname: eq, sw
lastname: eq, sw
email: eq, sw
cloudStatus: eq
processingState: eq
correlated: eq
protected: eq |
| sorters | string | | Sort results using the standard syntax described in V3 API Standard Collection Parameters
Sorting is supported for the following fields: name, alias, cloudStatus |
| defaultFilter | string | | Adds additional filter to filters query parameter.
CORRELATED_ONLY adds correlated=true and returns only identities that are correlated.
NONE does not add any and returns all identities that satisfy filters query parameter. |
| count | boolean | | If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.
Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.
See V3 API Standard Collection Parameters for more information. |
| limit | number | | Max number of results to return.
See V3 API Standard Collection Parameters for more information. |
| offset | number | | Offset into the full result set. Usually specified with limit to paginate through the results.
See V3 API Standard Collection Parameters for more information. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"name":"aName","id":"id12345","created":"2023-01-03T21:16:22.432Z","modified":"2023-01-03T21:16:22.432Z","alias":"walter.white","emailAddress":"sender@example.com","processingState":"ERROR","identityStatus":"LOCKED","managerRef":{"type":"IDENTITY","id":"2c4180a46faadee4016fb4e018c20626","name":"Robert Robinson"},"isManager":true,"lastRefresh":"2020-11-22T15:42:31.123Z","attributes":{},"lifecycleState":{"stateName":"active","manuallyUpdated":true}},{"name":"aName","id":"id12345","created":"2023-01-03T21:16:22.432Z","modified":"2023-01-03T21:16:22.432Z","alias":"walter.white","emailAddress":"sender@example.com","processingState":"ERROR","identityStatus":"LOCKED","managerRef":{"type":"IDENTITY","id":"2c4180a46faadee4016fb4e018c20626","name":"Robert Robinson"},"isManager":true,"lastRefresh":"2020-11-22T15:42:31.123Z","attributes":{},"lifecycleState":{"stateName":"active","manuallyUpdated":true}}]