1. Docs
  2. API Reference
  3. Delete an administrator role

Delete an administrator role

DELETE/portal/v1/accounts/{accountSlug}/admin-roles/{adminRoleId}

Permanently deletes a custom administrator role and its capability rows. System roles answer 403. A role that anyone still holds answers 409, with the number of active grants in error.data.assignment_count, so those grants must be revoked first. Requires admin_governance.manage; the audit entry keeps the role's name, scope and capabilities.

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.

adminRoleIdstring Required

Responses

Administrator role deleted

application/json

  • errorApiErrorBodyDto*

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-roles/value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
HTTP/1.1 204 Administrator role deleted

(empty body)
 Related endpoints
GETList operational-administrator roles for the Account
POSTCreate an operational-administrator role
GETList the operational capabilities a role may grant
GETGet an operational-administrator role
PATCHUpdate an operational-administrator role
GETList the identity roles an administrator role may grant in an Environment
PUTSet the identity roles an administrator role may grant in an Environment
 Was this page helpful?

Tell us how we can improve this guide.

Canopy