Skip to content
Kapten
Esc
↑↓navigate↵open⌘Jpreview

Get the Permission catalog

Every Permission a Grant can give, and for each scope the Permissions it can hold, for example to build a Role editor. The catalog is the same for every organization.

GET/permissions
Authorization
AuthorizationBearer token (JWT) · headerrequired

An access token issued by this service (RFC 9068), in the Authorization header as Bearer <token>.

Responses
200

The catalog.

resourcespermission_resource[]required
Show properties
Array of permission_resource
resourcestringrequired
labelstringrequired
operationsstring[]required
scopesscope_catalog[]required
Show properties
Array of scope_catalog
typescope_typerequired
Allowed:organizationprojectenvironmentclusterintegration
descriptionstringrequired
allbooleanrequired

Whether the scope offers every instance of its type.

permissionsscope_permission[]required
Show properties
Array of scope_permission
permissionstringrequired
labelstringrequired
descriptionstringrequired
requires_allbooleanrequired

Only valid when the scope is every instance of its type (creation is checked on the organization).

default

The request failed.

errorstringrequired

Stable machine-readable code.

Allowed:invalid_requestunauthorizedforbiddennot_foundconflictgoneunavailableinternal
messagestringrequired

Human-readable explanation.

Request
curl -X GET 'https://auth.kapten.io/permissions' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "resources": [
    {
      "resource": "string",
      "label": "string",
      "operations": [
        "string"
      ]
    }
  ],
  "scopes": [
    {
      "type": "organization",
      "description": "string",
      "all": true,
      "permissions": [
        {
          "permission": "string",
          "label": "string",
          "description": "string",
          "requires_all": true
        }
      ]
    }
  ]
}

Was this page helpful?