1. Docs
  2. API Reference
  3. Remove a permission

Remove a permission

DELETE/api/v1/permissions/{id}

Deletes a custom permission by id, scoped to the current Environment. System permissions (source: system) are protected and cannot be deleted. Supports optimistic concurrency via the If-Match header (409 on a version mismatch). Responds 204 No Content on success and 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.

Responses

Permission deleted

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*
Request
curl -X DELETE "https://auth.canopy-io.com/api/v1/permissions/value" \
  -H "if-match: value" \
  -H "If-Match: value" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
HTTP/1.1 204 Permission deleted

(empty body)
 Related endpoints
GETList permission catalog
POSTRegister new permission(s)
GETGet a permission
PATCHUpdate permission metadata
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