Delete role

DELETE

/api/admin/roles/{id}

Code sample: Shell / cURL

curl --request DELETE \
  --url https://auth.example.com/api/admin/roles/example \
  --header 'Authorization: Bearer <token>'

Deletes a custom tenant role. System roles, roles outside the caller hierarchy, and roles with active assignments are rejected.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Responses

200

Role deletion response.

Media type application/json

object

success

required

boolean

message

required

string

key

additional properties

Example

{
  "success": true,
  "message": "Role 'custom_viewer' has been deleted"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}