1. Docs
  2. API Reference
  3. Remove an assignment

Remove an assignment

DELETE/api/v1/assignments/{id}

Removes a single role assignment by id, revoking the role's permissions at its node and all inherited descendants. Authorization is re-evaluated as rbac.manage_assignments at the assignment's node; a missing assignment returns 404. Responds 204 No Content on success and emits an assignment.removed audit event carrying the affected identity, node, and role so cache-invalidating consumers can evict the right identity.

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

Responses

Assignment removed

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*
Request
curl -X DELETE "https://auth.canopy-io.com/api/v1/assignments/value" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
HTTP/1.1 204 Assignment removed

(empty body)
 Related endpoints
GETList all assignments across the Application
GETGet App-wide assignment summary
POSTAssign a role to an identity at a node
PATCHUpdate an assignment
POSTBulk remove assignments
POSTBulk change role on assignments
POSTBulk-create role assignments. All-or-nothing: any failure rolls back the entire batch
 Was this page helpful?

Tell us how we can improve this guide.

Canopy