Create Identity

POST
/v1/identities/

Headers

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
Allowed values: orguserother

The type of the identity.

project_idstringOptional

The project id of the identity, if applicable.

agent_idslist of stringsOptional

The agent ids that are 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
Allowed values: orguserother

The type of the identity.

agent_idslist of strings

The IDs of the agents 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

Built with