identities

List Identities

Get a list of all identities in the database

Authentication

AuthorizationBearer

Header authentication of the form Bearer <token>

Query parameters

namestring or nullOptional
project_idstring or nullOptional
identifier_keystring or nullOptional
identity_typeenum or nullOptional
Enum to represent the type of the identity.
Allowed values:
beforestring or nullOptional
Identity ID cursor for pagination. Returns identities that come before this identity ID in the specified sort order
afterstring or nullOptional
Identity ID cursor for pagination. Returns identities that come after this identity ID in the specified sort order
limitinteger or nullOptionalDefaults to 50
Maximum number of identities to return
orderenumOptionalDefaults to desc
Sort order for identities by creation time. 'asc' for oldest first, 'desc' for newest first
Allowed values:
order_by"created_at"Optional
Field to sort by

Response

Successful Response
identifier_keystring

External, user-generated identifier key of the identity.

namestring
The name of the identity.
identity_typeenum
The type of the identity.
Allowed values:
agent_idslist of strings
The IDs of the agents associated with the identity.
block_idslist of strings
The IDs of the blocks associated with the identity.
idstring or nullformat: "^identity-[a-fA-F0-9]{8}"

The human-friendly ID of the Identity

project_idstring or null
The project id of the identity, if applicable.
propertieslist of objects or null
List of properties associated with the identity

Errors