Accounts List
GET {{baseUrl}}/accounts
This returns a list of accounts.
A token with ORGADMIN, SOURCEADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
detailLevel | string | Determines whether Slim, or increased level of detail is provided for each account in the returned list. FULL is the default behavior. | |
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. | |||
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. |
| 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, sw
identityId: eq, in, sw
name: eq, in, sw
nativeIdentity: eq, in, sw
sourceId: eq, in, sw
uncorrelated: eq
entitlements: eq
origin: eq, in
manuallyCorrelated: eq
identity.name: eq, in, sw
identity.correlated: eq
identity.identityState: eq, in
source.displayableName: eq, in
source.authoritative: eq
source.connectionType: eq, in |
| sorters | string | | Sort results using the standard syntax described in V3 API Standard Collection Parameters
Sorting is supported for the following fields: id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"attributes":null,"authoritative":true,"created":"2021-09-28T02:15:44.644Z","description":null,"disabled":false,"features":"PROVISIONING, GROUP_PROVISIONING, SYNC_PROVISIONING, AUTHENTICATE","hasEntitlements":true,"id":"2c9180867c184ff6017c2a2fbf031667","identityId":"2c9180867c184ff6017c2a2fbf031666","locked":false,"manuallyCorrelated":false,"modified":"2021-09-28T02:16:12.207Z","name":"Geovanni.0a7cad6df","nativeIdentity":"CN=Geovanni 0a7cad6df,OU=hpun,OU=org-data-service,DC=TestAutomationAD,DC=local","sourceId":"2c91808b7c28b350017c2a2ec5790aa1","systemAccount":false,"uncorrelated":false,"uuid":"{e4218fa4-da52-4bb0-aa41-d2dcc08a7ad8}"}]