1. Docs
  2. API Reference
  3. Get permissions for a role

Get permissions for a role

GET/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/roles/{id}/permissions

Returns the permission keys currently attached to a role as a sorted { items } array of strings. Returns 404 when the role does not exist in the current Environment. Requires the rbac.view_roles permission.

Authentication

Bearer TokenAuthorization

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

Requires capability env_roles.viewDeveloper Console

View roles and the permissions they grant. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

appSlugstring Required

The Application's slug within the Account.

envSlugstring Required

The Environment's slug within the Application.

idstring Required

Responses

application/json

  • itemsstring[]*

application/json

  • errorApiErrorBodyDto*

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.

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.

Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/value/applications/value/environments/value/roles/value/permissions" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "items": [
    "string"
  ]
}
 Related endpoints
GETList roles
POSTCreate a custom role
GETGet a role
PATCHUpdate a role
DELETEDelete a role
PUTReplace permissions on a role
 Was this page helpful?

Tell us how we can improve this guide.

Canopy