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/portal/v1/accounts/{accountSlug}/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

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

Path Parameters

accountSlugstring Required

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

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*
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/value/admin-roles/value/grantable-roles?environmentId=value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
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