API Reference

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

Identities

List Identities

identities.list(IdentityListParams**kwargs) -> SyncArrayPage[Identity]

get/v1/identities/

Create Identity

identities.create(IdentityCreateParams**kwargs) -> Identity

post/v1/identities/

Upsert Identity

identities.upsert(IdentityUpsertParams**kwargs) -> Identity

put/v1/identities/

Retrieve Identity

identities.retrieve(stridentity_id) -> Identity

get/v1/identities/{identity_id}

Modify Identity

identities.modify(stridentity_id, IdentityModifyParams**kwargs) -> Identity

patch/v1/identities/{identity_id}

Delete Identity

identities.delete(stridentity_id) -> object

delete/v1/identities/{identity_id}

ModelsExpand Collapse

class Identity: …

id: str

The human-friendly ID of the Identity

Deprecatedagent_ids: List[str]

The IDs of the agents associated with the identity.

Deprecatedblock_ids: List[str]

The IDs of the blocks associated with the identity.

identifier_key: str

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: str

The name of the identity.

project_id: Optional[str]

The project id of the identity, if applicable.

properties: Optional[List[IdentityProperty]]

List of properties associated with the identity

key: str

The key of the property

type: Literal["string", "number", "boolean", "json"]

The type of the property

Accepts one of the following:

"string"

"number"

"boolean"

"json"

value: Union[str, float, bool, Dict[str, object]]

The value of the property

Accepts one of the following:

ValueUnionMember0 = str

ValueUnionMember1 = float

ValueUnionMember2 = bool

ValueUnionMember3 = Dict[str, object]

class IdentityProperty: …

A property of an identity

key: str

The key of the property

type: Literal["string", "number", "boolean", "json"]

The type of the property

Accepts one of the following:

"string"

"number"

"boolean"

"json"

value: Union[str, float, bool, Dict[str, object]]

The value of the property

Accepts one of the following:

ValueUnionMember0 = str

ValueUnionMember1 = float

ValueUnionMember2 = bool

ValueUnionMember3 = Dict[str, object]

IdentityType = Literal["org", "user", "other"]

Enum to represent the type of the identity.

Accepts one of the following:

"org"

"user"

"other"

IdentitiesProperties

Upsert Identity Properties

identities.properties.upsert(stridentity_id, PropertyUpsertParams**kwargs) -> object

put/v1/identities/{identity_id}/properties

IdentitiesAgents

List Agents For Identity

identities.agents.list(stridentity_id, AgentListParams**kwargs) -> SyncArrayPage[AgentState]

get/v1/identities/{identity_id}/agents

IdentitiesBlocks

List Blocks For Identity

identities.blocks.list(stridentity_id, BlockListParams**kwargs) -> SyncArrayPage[BlockResponse]

get/v1/identities/{identity_id}/blocks