Permissions

List the permission catalogue

Changed on

List every permission, flagged with whether the caller may grant it to an agent.

Each entry gives the permission name, a description, the permissions it implies, and grantable_by_caller — whether POST /agents and PUT /agents/{agent_id}/permissions would accept it from this caller. org:admin is listed only to callers who hold it. Use it to build an agent permission picker. Any signed-in caller may call it.

get/permissions

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /permissions
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL /authorize, token URL /oauth/token)

Response

Successful Response

Example response

{
  "data": [
    {
      "description": "Create, update, and disable users",
      "grantable_by_caller": true,
      "implies": [
        "users:read"
      ],
      "name": "users:write"
    }
  ]
}

Changes