Atlas
Admin — Roles

Delete custom role

Permanently removes a custom role. Built-in roles cannot be deleted.

DELETE
/api/v1/admin/roles/{id}

Path Parameters

id*string
Length1 <= length <= 128

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "http://localhost:3001/api/v1/admin/roles/role_abc123"
{
  "message": "string"
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}