Identities

Upsert Identity

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

X-ProjectstringOptional

Request

This endpoint expects an object.
identifier_keystringRequired

External, user-generated identifier key of the identity.

namestringRequired
The name of the identity.
identity_typeenumRequired
The type of the identity.
Allowed values:
project_idstringOptional
The project id of the identity, if applicable.
agent_idslist of stringsOptional
The agent ids that are associated with the identity.
block_idslist of stringsOptional
The IDs of the blocks associated with the identity.
propertieslist of objectsOptional
List of properties associated with the identity.

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