1. Docs
  2. API Reference
  3. Revoke an operational administrator

Revoke an operational administrator

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

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

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

adminAssignmentIdstring Required

Responses

Administrator assignment revoked

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*
Request
curl -X DELETE "https://auth.canopy-io.com/portal/v1/accounts/value/admin-assignments/value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
HTTP/1.1 204 Administrator assignment revoked

(empty body)
 Related endpoints
GETList operational administrators in an Environment
POSTGrant an operational administrator
 Was this page helpful?

Tell us how we can improve this guide.

Canopy