Revoke an operational administrator

DELETE

/api/v1/admin-assignments/{adminAssignmentId}

Revokes an administrator grant by setting its revoked_at. The row is kept and the revocation is recorded in the audit log. Revoking a grant that is already revoked answers 204 and changes nothing, and a grant in another Account answers 404. Requires admin_governance.manage.

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.

Requires permission admin_governance.manageAccount

Create administrator roles and grant them, carrying only capabilities this key's own scopes cover. A scoped API key must hold it as a scope; a full-access key holds every scope within its Environment except the named-only and account scopes; a developer's token needs the Console capability that covers it. A credential without it is refused with 403.

Path Parameters

adminAssignmentIdstring Required

Responses

Administrator assignment revoked

application/json

errorApiErrorBodyDto*

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, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs. A request refused by an authorization check answers 403 with the code authorization.denied, and its data names the denial_reason and the permission checked.

403authorization.deniedForbidden

When it happens

The credential does not hold the permission this operation checks: a scoped API key without the scope, a developer without the Console capability that covers it, or a permission granted somewhere other than the node the request targets. The error's data names the permission.

Remediation

Add the permission named in the Authentication section to the key's scopes, or ask an account administrator to grant the covering capability, then retry. For a node-scoped operation, make sure the grant reaches the node you are acting on.

Request

curl -X DELETE "https://auth.canopy-io.com/api/v1/admin-assignments/value" \
  -H "X-API-Key: $CANOPY_API_KEY"

Response

HTTP/1.1 204 Administrator assignment revoked

(empty body)

GETList operational administrators in an Environment
POSTGrant an operational administrator

Was this page helpful?

Tell us how we can improve this guide.