1. Docs
  2. API Reference
  3. Delete a role

Delete a role

DELETE/api/v1/roles/{id}

Deletes a custom role by id; dependent role-assignment and role-permission rows are removed by database cascade. System roles are protected and return 403, and a missing role returns 404. Supports optimistic concurrency via the If-Match header (409 on a version mismatch). Responds 204 No Content 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

Role deleted

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

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

(empty body)
 Related endpoints
GETList roles
POSTCreate a custom role
GETGet a role
PATCHUpdate a role
GETGet permissions for a role
PUTReplace permissions on a role
 Was this page helpful?

Tell us how we can improve this guide.

Canopy