Skip to main content
GET
Get the permission catalog
The catalog is reference data: what permissions and roles mean, never who holds them. A credential whose role grants, narrowed by its scopes, hold roles:read at its acting organization reads all of it; otherwise the call is 403 permission_denied with error.requiredPermission: "roles:read". The operation takes no parameters. data.verbs lists the five verbs (read, use, write, manage, approve) with their labels. data.families lists the six families (Build, Run, Connect, Govern, Org, Platform), each with its resources, and each resource with its permissions. A permission carries its key, verb, label, description, whether it is elevated, the roles that include it (includedIn), and how many access-control rows enforce it by surface kind (enforcedAt). Per-credential compatibility roles (one per API key or External App) are never listed in includedIn, because each names the credential that holds it. A named legacy compatibility role is listed with compatibility: true. meta.partial: true means the role read reached its 200-role cap, so an includedIn may be short. For each role’s own permission list and containment, call listRoleDefinitions. To give or revoke a role, call giveRole or revokeRole, which need grants:manage. See Roles and grants.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Response

The permission catalog

data
object
required

The permission catalog in words: the five verbs, then the six families, each with its resources and each resource's permissions. A permission carries its key, verb, label, description, whether it is elevated, the roles that include it (includedIn, each flagged compatibility when it is a named legacy compatibility role) and how many access-control rows enforce it, by surface kind. Per-credential compatibility roles are never listed.

meta
object
required