Sign in

v3

latestOpenAPI 3.0.02026-08-081996601.2 MB
Agent Identity

Get agent identity

Returns the identity associated with an agent. The identity is the service account the agent uses when executing tools.

In auto mode (the default), the platform keeps the identity's roles in sync with the agent's tool configuration.

In manual mode, the roles are frozen. The platform does not modify them when the agent is updated.

get/v2/agents/{agent_key}/identity

Path parameters

agent_keystring required

A unique key that identifies an agent.

Example:customer_support

The unique key of the agent.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

The agent's identity details.

mode'auto' | 'manual' required

The role management mode of the agent's identity.

  • auto: The platform keeps roles in sync with the agent's tool configuration. When tools change, the platform recomputes roles automatically.
  • manual: The caller manages the roles. The platform does not modify roles when the agent is updated.
client_idstring required

The OAuth2 client ID of the agent's service account.

api_rolesApiRole[] required

Customer-level roles assigned to this identity.

Example response

{
  "mode": "auto",
  "client_id": "abc123def456"
}