identities

Modify Identity

Authentication

AuthorizationBearer

Header authentication of the form Bearer <token>

Path Parameters

identity_idstringRequiredformat: "^identity-[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"=45 characters

The ID of the identity in the format ‘identity-<uuid4>’

Request

This endpoint expects an object.
identifier_keystring or nullOptional

External, user-generated identifier key of the identity.

namestring or nullOptional
The name of the identity.
identity_typeenum or nullOptional
The type of the identity.
Allowed values:
propertieslist of objects or nullOptional
List of properties associated with the identity.
agent_idslist of strings or nullOptionalDeprecated
The agent ids that are associated with the identity.
block_idslist of strings or nullOptionalDeprecated
The IDs of the blocks 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 stringsDeprecated
The IDs of the agents associated with the identity.
block_idslist of stringsDeprecated
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