1. Docs
  2. API Reference
  3. Delete a role

Delete a role

DELETE/api/v1/roles/{id}

Authentication

  • Bearer Token Authorization

    JWT access token

  • API Key X-API-Key

    API key for management-tier access

Path Parameters

Name Required Type Description
idRequiredstring

Headers

  • if-match required
  • If-Match

    Optimistic-lock version of the resource. Send the `version` field returned on read; the server rejects with 409 if the row has changed since.

Code samples

cURLJavaScriptPythonGo
curl -X DELETE "https://api.canopy.dev/api/v1/roles/value" \
  -H "if-match: value" \
  -H "If-Match: value" \
  -H "X-API-Key: $CANOPY_API_KEY"

Responses

204 Role deleted
401 Invalid or expired token
403 System role cannot be deleted
404 Role not found
409 Version mismatch — the resource was modified since the version supplied in If-Match. Refresh and retry.
On this page

Related endpoints

GETList roles
POSTCreate a custom role
GETGet a role
PATCHUpdate a role
GETGet permissions for a role
PUTReplace permissions on a role