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

Remove an assignment

DELETE/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/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

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

Requires capability env_identities.manageDeveloper Console

Create, invite, edit, and remove identities and assign their roles. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Production Environments require production_identities.accessDeveloper Console

Access identities in production Environments. Applies to users only, and only in an Environment marked production: its identities are real end users. API keys and identity principals are exempt.

Path Parameters

idstring Required

Responses

Assignment removed

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

403environment.production_identities_forbiddenForbidden
When it happens

The Environment is marked production and the caller is a user without production identity access.

Remediation

Manage these people in the Admin Workspace, or ask an administrator to grant the Production Support role, then retry.

Request
curl -X DELETE "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/assignments/value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
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