List Identities

Get a list of all identities in the database

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

Query parameters

namestringOptional
project_idstringOptional
identifier_keystringOptional
identity_typeenumOptional

Enum to represent the type of the identity.

Allowed values:
beforestringOptional
afterstringOptional
limitintegerOptional

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.

idstringOptionalformat: "^identity-[a-fA-F0-9]{8}"

The human-friendly ID of the Identity

project_idstringOptional

The project id of the identity, if applicable.

propertieslist of objectsOptional

List of properties associated with the identity

Errors