The agent object
UUID uniquely identifying the agent.
Human-readable name for the agent.
Optional description of the agent’s purpose.
Current status of the agent. One of
"active", "suspended", or "revoked". Only "active" agents can receive "allowed" authorization decisions.ISO 8601 timestamp of when the agent was created.
ISO 8601 timestamp of the last update.
POST /v1/agents
Create a new agent in your workspace.Requires an API key with
admin scope.Human-readable name for the agent. Must be between 1 and 255 characters.
Optional description. Maximum 2,000 characters.
201.
GET /v1/agents
List all agents in your workspace.Maximum number of agents to return. Must be between 1 and 200.
Number of agents to skip. Use with
limit for pagination.GET /v1/agents/:id
Retrieve a single agent by UUID. Returns the agent object, or404 with AGENT_NOT_FOUND if it does not exist in your workspace.
PATCH /v1/agents/:id
Update an existing agent. All fields are optional — only the fields you include are updated.Requires an API key with
admin scope.New name for the agent. Must be between 1 and 255 characters.
New description. Set to
null to clear it. Maximum 2,000 characters.New status. One of
"active", "suspended", or "revoked".Setting status to "suspended" or "revoked" immediately causes all subsequent authorization requests for this agent to be denied without policy evaluation.DELETE /v1/agents/:id
Permanently delete an agent. This cascades to all policies and audit logs associated with the agent.Requires an API key with
admin scope.204 No Content on success.