1. Docs
  2. API Reference
  3. List operational-administrator roles for the Account

List operational-administrator roles for the Account

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

The Account's active administrator roles, system roles first and then by name. Each role carries its capability keys, its version and an assignment_count of its active grants across the whole Account. Inactive roles are left out. Requires admin_governance.view; the response is an unpaginated { items } array.

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.

Responses

application/json

  • itemsAdminRoleResponseDto[]*

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/value/admin-roles" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "is_system": false,
      "system_key": "string",
      "is_active": false,
      "scope": "account",
      "capabilities": [
        "string"
      ],
      "assignment_count": 0,
      "version": 0,
      "created_at": "2026-04-20T12:00:00.000Z",
      "updated_at": "2026-04-20T12:00:00.000Z"
    }
  ]
}
 Related endpoints
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
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