1. Docs
  2. API Reference
  3. Update permission metadata

Update permission metadata

PATCH/api/v1/permissions/{id}

Updates a permission's name, description, and/or category by id (description accepts null to clear; name and category can be changed but never cleared); the permission key and source are immutable. Supports optimistic concurrency via the If-Match header carrying the permission's current version — a stale version returns 409. 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 name

descriptionstring Optional

Updated description

categorystring Optional

Updated category

Responses

application/json

  • dataPermissionResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

PermissionResponseDtoView all properties on this resource
Request
curl -X PATCH "https://auth.canopy-io.com/api/v1/permissions/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",
    "category": "string"
  }'
Response
{
  "data": {
    "id": "string",
    "application_id": "string",
    "key": "string",
    "name": "string",
    "description": "string",
    "category": "string",
    "source": "system",
    "created_at": "2026-04-20T12:00:00.000Z",
    "version": 0
  }
}
 Related endpoints
GETList permission catalog
POSTRegister new permission(s)
GETGet a permission
DELETERemove a permission
GETGet where a permission is used
POSTEvaluate authorization
POSTBulk evaluate authorization
POSTExplain a node-scoped authorization decision
 Was this page helpful?

Tell us how we can improve this guide.

Canopy