1. Docs
  2. API Reference
  3. List the operational capabilities a role may grant

List the operational capabilities a role may grant

GET/api/v1/admin-roles/capabilities

The platform capability catalog that administrator roles are built from. Each entry has its key, description, category, product, scope and ownerOnly flag. Owner-only capabilities such as account.delete are left out unless include_owner_only=true; any other value is treated as false. Requires admin_governance.view. The response is an unpaginated { items } array.

Authentication

Bearer TokenAuthorization Option A

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Requires permission admin_governance.viewAccount

View administrator roles and who holds them. A scoped API key must hold it as a scope; a full-access key holds every scope within its Environment except the named-only and account scopes; a developer's token needs the Console capability that covers it. A credential without it is refused with 403.

Query Parameters

include_owner_onlystring Optional

Responses

application/json

  • itemsAdminCapabilityDto[]*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs. A request refused by an authorization check answers 403 with the code authorization.denied, and its data names the denial_reason and the permission checked.

403authorization.deniedForbidden
When it happens

The credential does not hold the permission this operation checks: a scoped API key without the scope, a developer without the Console capability that covers it, or a permission granted somewhere other than the node the request targets. The error's data names the permission.

Remediation

Add the permission named in the Authentication section to the key's scopes, or ask an account administrator to grant the covering capability, then retry. For a node-scoped operation, make sure the grant reaches the node you are acting on.

Returned object

AdminCapabilityDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/admin-roles/capabilities?include_owner_only=value" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "items": [
    {
      "key": "string",
      "description": "string",
      "category": "string",
      "product": "console",
      "scope": "account",
      "ownerOnly": false
    }
  ]
}
 Related endpoints
GETList operational-administrator roles for the Account
POSTCreate an operational-administrator role
GETGet an operational-administrator role
PATCHUpdate an operational-administrator role
DELETEDelete an administrator role
GETList the identity roles an administrator role may grant in an Environment
PUTSet the identity roles an administrator role may grant in an Environment
 Was this page helpful?

Tell us how we can improve this guide.

Canopy