Remove an admin user role.

DELETE

/api/admin/admins/{id}/roles/{roleId}

Code sample: Shell / cURL

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

Removes a role from an Admin user. Platform administrator roles cannot be removed if doing so would remove the last active platform administrator or the caller removes their own platform admin role.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Admin user id.

roleId

required

string

Admin role id.

Responses

200

Successful admin action response.

Media type application/json

object

success

required

boolean

message

string

id

string

deleted_user_id

string

deleted_count

integer

key

additional properties

Example

{
  "success": true,
  "message": "Operation completed"
}

400

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"
}

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"
}