Suspend an admin user.

POST

/api/admin/admins/{id}/suspend

Code sample: Shell / cURL

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

Suspends an Admin user in the current tenant. The handler rejects self-suspension and suspending the last active platform administrator.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

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