1. Docs
  2. API Reference
  3. Get an operational-administrator role

Get an operational-administrator role

GET/portal/v1/accounts/{accountSlug}/admin-roles/{adminRoleId}

Authentication

Bearer TokenAuthorization

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

Path Parameters

adminRoleIdstring Required

Responses

application/json

  • dataAdminRoleResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

AdminRoleResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/admin-roles/value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "is_system": false,
    "system_key": "string",
    "is_active": false,
    "scope": "account",
    "capabilities": [
      "string"
    ],
    "assignment_count": 0,
    "created_at": "2026-04-20T12:00:00.000Z",
    "updated_at": "2026-04-20T12:00:00.000Z"
  }
}
 Related endpoints
GETList operational-administrator roles for the Account
POSTCreate an operational-administrator role
GETList the operational capabilities a role may grant
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