Skip to content

Delete an admin role assignment.

DELETE
/api/admin/admin-roles/{id}/assignments/{assignmentId}
Code sample: Shell / cURL
curl --request DELETE \
--url https://auth.example.com/api/admin/admin-roles/example/assignments/example \
--header 'Authorization: Bearer <token>'

Removes a role assignment by id. Platform administrator assignments cannot be removed when this would leave no active platform administrator.

id
required
string

Admin role id.

assignmentId
required
string

Admin role assignment id.

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

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

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

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

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

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