1. Docs
  2. API Reference
  3. List the permission scopes a scoped key can hold

List the permission scopes a scoped key can hold

GET/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/api-keys/scopes

Returns the platform's static API-key scope catalog as an unpaginated { items } list — the fixed set of capabilities a scoped key may be granted, independent of any Environment's RBAC permission catalog. Reference data with no authorization check.

Authentication

Bearer TokenAuthorization

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

Requires capability api_keys.viewDeveloper Console

View API keys. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Responses

application/json

  • itemsApiKeyScopeDto[]*

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.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

Returned object

ApiKeyScopeDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/api-keys/scopes" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "items": [
    {
      "key": "string",
      "description": "string",
      "category": "string"
    }
  ]
}
 Related endpoints
GETList API keys for Application
POSTCreate a new API key
GETActive/inactive API key counts for the environment
PATCHActivate or deactivate an API key
DELETEDelete an API key
POSTRotate an API key's secret
 Was this page helpful?

Tell us how we can improve this guide.

Canopy