Sign in

v36

latestOpenAPI 3.1.0raw.githubusercontent.com2025-10-091882241.2 MB
identities
identities

Modify Identity

patch/v1/identities/{identity_id}

Path parameters

identity_idstring required

Request body

identifier_keystring nullable

External, user-generated identifier key of the identity.

namestring nullable

The name of the identity.

identity_type'org' | 'user' | 'other'

Enum to represent the type of the identity.

agent_idsstring[] nullable

The agent ids that are associated with the identity.

block_idsstring[] nullable

The IDs of the blocks associated with the identity.

Response

Successful Response

idstring

The human-friendly ID of the Identity

identifier_keystring required

External, user-generated identifier key of the identity.

namestring required

The name of the identity.

identity_type'org' | 'user' | 'other' required

Enum to represent the type of the identity.

project_idstring nullable

The project id of the identity, if applicable.

agent_idsstring[] required

The IDs of the agents associated with the identity.

block_idsstring[] required

The IDs of the blocks associated with the identity.

Example response

{
  "id": "identity-123e4567-e89b-12d3-a456-426614174000"
}