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

Update an operational-administrator role

PATCH/api/v1/admin-roles/{adminRoleId}

Changes a custom role's name, description or is_active, or replaces its whole capabilities set. New capabilities are checked against the catalog and the role's existing scope, which cannot change. System roles answer 403, and a name already used by another role in the Account answers 409. Send the role's version in If-Match to refuse a stale edit: a mismatch answers 409 with the current role in error.data.current, and without the header the check is skipped. Requires admin_governance.manage, and the change is recorded in the audit log. An API key changes only a role within its own ceiling, and may only give it, capabilities its own scopes cover; anything beyond answers 403 (admin_role.capability_beyond_key) naming them in error.data.capabilities. Two capabilities are beyond every key whatever it holds, because the person given one hands out authority without the key's bound: admin_governance.manage (any role) and api_keys.manage (a full-access Environment key). A developer's MCP client, when its approval names only some capabilities, is held to them the same way, and never hands out those two (403, admin_role.capability_beyond_mcp_grant).

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

Headers

  • If-Match

    Optimistic-lock version of the resource. Send the `version` field returned on read; the server rejects with 409 if the row has changed since. Leave it out to skip the check; a header that names no version (not a whole number) is refused with 400 `if_match.invalid`.

Request body

application/json

namestring Optional

Administrator role name

descriptionstring Optional

Administrator role description

capabilitiesstring[] Optional

Replacement set of operational capability keys

is_activeboolean Optional

Whether the role is active

Responses

application/json

  • dataAdminRoleResponseDto*

application/json

  • errorApiErrorBodyDto*

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.

Returned object

AdminRoleResponseDtoView all properties on this resource
Request
curl -X PATCH "https://auth.canopy-io.com/api/v1/admin-roles/value" \
  -H "If-Match: "3"" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "capabilities": [
      "string"
    ],
    "is_active": false
  }'
Response
{
  "data": {
    "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
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
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