Identities

List Identities

get/v1/identities/

Create Identity

post/v1/identities/

Upsert Identity

put/v1/identities/

Retrieve Identity

get/v1/identities/{identity_id}

Modify Identity

patch/v1/identities/{identity_id}

Delete Identity

delete/v1/identities/{identity_id}

ModelsExpand Collapse

Identity = object { id, agent_ids, block_ids, 5 more }

id: string

The human-friendly ID of the Identity

Deprecatedagent_ids: array of string

The IDs of the agents associated with the identity.

Deprecatedblock_ids: array of string

The IDs of the blocks associated with the identity.

identifier_key: string

External, user-generated identifier key of the identity.

identity_type: IdentityType

The type of the identity.

Accepts one of the following:

"org"

"user"

"other"

name: string

The name of the identity.

project_id: optional string

The project id of the identity, if applicable.

properties: optional array of IdentityProperty { key, type, value }

List of properties associated with the identity

key: string

The key of the property

type: "string" or "number" or "boolean" or "json"

The type of the property

Accepts one of the following:

"string"

"number"

"boolean"

"json"

value: string or number or boolean or map[unknown]

The value of the property

Accepts one of the following:

UnionMember0 = string

UnionMember1 = number

UnionMember2 = boolean

UnionMember3 = map[unknown]

IdentityProperty = object { key, type, value }

A property of an identity

key: string

The key of the property

type: "string" or "number" or "boolean" or "json"

The type of the property

Accepts one of the following:

"string"

"number"

"boolean"

"json"

value: string or number or boolean or map[unknown]

The value of the property

Accepts one of the following:

UnionMember0 = string

UnionMember1 = number

UnionMember2 = boolean

UnionMember3 = map[unknown]

IdentityType = "org" or "user" or "other"

Enum to represent the type of the identity.

Accepts one of the following:

"org"

"user"

"other"

IdentitiesProperties

Upsert Identity Properties

put/v1/identities/{identity_id}/properties

IdentitiesAgents

List Agents For Identity

get/v1/identities/{identity_id}/agents

IdentitiesBlocks

List Blocks For Identity

get/v1/identities/{identity_id}/blocks