DocsAPI reference
Permissions
Every permission a role can carry, grouped by area, with who can hold it and the endpoints that require it.
Updated Sep 22, 2026
Organization
| Permission | Description | Held by | Used by |
|---|---|---|---|
organization.deleteDangerous | Schedule the organization for deletion | People, api_key | No published endpoint |
organization.read | Read organization settings and policy | People, api_key, organization_api_key | No published endpoint |
organization.settings.write | Change organization settings and policy | People, api_key | No published endpoint |
Membership
| Permission | Description | Held by | Used by |
|---|---|---|---|
membership.invite | Invite people and manage pending invitations | People, api_key | |
membership.read | List members and pending invitations | People, api_key, organization_api_key | |
membership.write | Suspend, reactivate, and remove members | People, api_key |
Team
| Permission | Description | Held by | Used by |
|---|---|---|---|
team.escalation.activate | Activate, roll back, and deactivate team escalation policies | People, api_key, organization_api_key | |
team.escalation.write | Create team escalation policy revisions | People, api_key, organization_api_key | |
team.member.write | Change who is on a team | People, api_key | |
team.read | List teams and their rosters | People, api_key, organization_api_key | |
team.write | Create, rename, and archive teams | People, api_key |
Agent
| Permission | Description | Held by | Used by |
|---|---|---|---|
agent.credential.issueDangerous | Issue instance credentials and provisioner tokens | People, api_key, organization_api_key | |
agent.credential.revoke | Revoke instance credentials and provisioner tokens | People, api_key, organization_api_key | |
agent.read | View agents, their instances, and credential state | People, api_key, organization_api_key | |
agent.write | Create agents and change their status | People, api_key, organization_api_key |
Pipeline
| Permission | Description | Held by | Used by |
|---|---|---|---|
pipeline.activate | Activate and roll back pipeline revisions | People, api_key, organization_api_key | |
pipeline.read | Read request approval pipelines and their revisions | People, api_key, organization_api_key | GET /api/v1/request-approval-pipelinesGET/api/v1/request-approval-pipelines/organizationGET/api/v1/request-approval-pipelines/organization/revisionsGET/api/v1/request-approval-pipelines/organization/revisions/{revision}GET/api/v1/request-approval-pipelines/agents/{agent_slug}GET/api/v1/request-approval-pipelines/agents/{agent_slug}/revisionsGET/api/v1/request-approval-pipelines/agents/{agent_slug}/revisions/{revision} |
pipeline.write | Create and preview request approval pipeline revisions | People, api_key, organization_api_key |
Escalation path
| Permission | Description | Held by | Used by |
|---|---|---|---|
escalation_path.activate | Activate, roll back, and archive escalation paths | People, api_key, organization_api_key | |
escalation_path.read | Read escalation paths and their revisions | People, api_key, organization_api_key | |
escalation_path.write | Create escalation paths and their revisions | People, api_key, organization_api_key |
Request
| Permission | Description | Held by | Used by |
|---|---|---|---|
request.claim | Claim a pending request while reviewing it | People, api_key | |
request.create | Create approval requests | Agents | |
request.decide | Approve or deny requests routed to you | People, api_key | |
request.decide.unroutedDangerous | Decide requests that were routed to other people (break glass) | People, api_key | No published endpoint |
request.read | Read approval requests and their outcomes | People, api_key, organization_api_key, Agents | |
request.read.unrouted | Read requests that were routed to other people, whatever the visibility policy | People, api_key, organization_api_key | No published endpoint |
Gateway
| Permission | Description | Held by | Used by |
|---|---|---|---|
gateway.callHosted edition | Relay tool calls through the MCP gateway | Gateway | No published endpoint |
gateway.readHosted edition | View MCP gateway servers and credentials | People, api_key, organization_api_key | |
gateway.writeHosted edition | Configure MCP gateway servers and credentials | People, api_key, organization_api_key |
Webhook
| Permission | Description | Held by | Used by |
|---|---|---|---|
webhook.read | View webhook endpoints | People, api_key, organization_api_key | |
webhook.write | Create, edit, rotate, and delete webhook endpoints | People, api_key, organization_api_key | POST /api/v1/webhook_endpoints/{endpoint_key}/revisionsPOST/api/v1/webhook_endpoints/{endpoint_key}/revisions/{revision}/activatePOST/api/v1/webhook_endpoints/{endpoint_key}/revisions/{revision}/testDELETE/api/v1/webhook_endpoints/{endpoint_key}/activePOST/api/v1/webhook_endpoints/{endpoint_key}/rotate_secret |
Connection
| Permission | Description | Held by | Used by |
|---|---|---|---|
connection.read | View SSO, directory, chat, and domain connections | People, api_key | No published endpoint |
connection.writeDangerous | Connect and disconnect SSO, directories, chat apps, and domains | People, api_key | No published endpoint |
Audit
| Permission | Description | Held by | Used by |
|---|---|---|---|
audit.readHosted edition | Read the audit log | People, api_key, organization_api_key |
Api key
| Permission | Description | Held by | Used by |
|---|---|---|---|
api_key.issue | Mint personal API keys and manage your own | People | |
api_key.read | List every API key in the organization | People | |
api_key.revoke | Revoke any API key in the organization | People | |
api_key.organization.issueDangerousHosted edition | Issue organization API keys | People |
Permission policy
| Permission | Description | Held by | Used by |
|---|---|---|---|
permission_policy.read | Read permission policies and available permissions | People, api_key | No published endpoint |
permission_policy.writeDangerous | Grant and revoke permission policies for people and teams | People, api_key | POST /api/v1/members/{id}/permission_policiesPUT/api/v1/members/{id}/permission_policies/{policy_id}DELETE/api/v1/members/{id}/permission_policies/{policy_id}POST/api/v1/teams/{id}/permission_policiesPUT/api/v1/teams/{id}/permission_policies/{policy_id}DELETE/api/v1/teams/{id}/permission_policies/{policy_id}POST/api/v1/api_keys/{id}/permission_policiesPUT/api/v1/api_keys/{id}/permission_policies/{policy_id}DELETE/api/v1/api_keys/{id}/permission_policies/{policy_id} |