Update a role

PATCH

/api/v1/roles/{id}

Updates a role's name, description, and/or is_active flag by id. A name that collides with another role in the Environment returns 409, and a missing role returns 404. Supports optimistic concurrency via the If-Match header carrying the role's current version (409 on a version mismatch). Requires the rbac.manage_roles permission.

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.

Path Parameters

idstring Required

Headers

if-match required
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.

Request body

application/json

namestring Optional

Updated role name

descriptionstring Optional

Updated role description

is_activeboolean Optional

Whether the role is active

Responses

application/json

dataRoleResponseDto*

application/json

errorApiErrorBodyDto*

application/json

errorApiErrorBodyDto*

application/json

errorApiErrorBodyDto*

application/json

errorApiErrorBodyDto*

Returned object

RoleResponseDtoView all properties on this resource

Request

curl -X PATCH "https://auth.canopy-io.com/api/v1/roles/value" \
  -H "if-match: value" \
  -H "If-Match: value" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "is_active": false
  }'

Response

{
  "data": {
    "id": "string",
    "application_id": "string",
    "name": "string",
    "description": "string",
    "is_system_role": false,
    "system_key": "string",
    "is_active": false,
    "created_at": "2026-04-20T12:00:00.000Z",
    "updated_at": "2026-04-20T12:00:00.000Z",
    "version": 0,
    "permission_count": 0,
    "member_count": 0
  }
}

GETList roles
POSTCreate a custom role
GETGet a role
DELETEDelete a role
GETGet permissions for a role
PUTReplace permissions on a role

Was this page helpful?

Tell us how we can improve this guide.