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

Create an operational-administrator role

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

Authentication

Bearer TokenAuthorization

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

Request body

application/json

namestring Required

Administrator role name

descriptionstring Optional

Administrator role description

scopeenum Required

How the role is granted. `account` roles apply account-wide and carry account-global capabilities (Console access, billing, who administers). `environment` roles are granted in one Environment, optionally narrowed to a hierarchy node, and carry the people work scoped to it. Immutable once created.

one of "account" · "environment"

capabilitiesstring[] Required

Capability keys the role grants. Every key must match the role's scope.

Responses

application/json

  • dataAdminRoleResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

AdminRoleResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/admin-roles" \
  -H "Authorization: Bearer $CANOPY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "scope": "account",
    "capabilities": [
      "string"
    ]
  }'
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
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