1. Docs
  2. API Reference
  3. List the identity roles an administrator role may grant in an Environment

List the identity roles an administrator role may grant in an Environment

GET/api/v1/admin-roles/{adminRoleId}/grantable-roles

The IDs of the identity roles that this administrator role may grant in the Environment named by the required environmentId query parameter. Only editing a role's grantable roles reads this, so it requires admin_governance.manage, not view. Answers 404 when the administrator role or the Environment is not in the Account. The response is an unpaginated { items } array of role ID strings.

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.manageAccount

Create administrator roles and grant them, carrying only capabilities this key's own scopes cover. 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.

Path Parameters

adminRoleIdstring Required

Query Parameters

environmentIdstring Required

Environment whose grantable roles to read

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. 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.

Request
curl -X GET "https://auth.canopy-io.com/api/v1/admin-roles/value/grantable-roles?environmentId=value" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "items": [
    "string"
  ]
}
 Related endpoints
GETList operational-administrator roles for the Account
POSTCreate an operational-administrator role
GETList the operational capabilities a role may grant
GETGet an operational-administrator role
PATCHUpdate an operational-administrator role
DELETEDelete an administrator role
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