Bulk Delete Users

POST

/api/superadmin/users/bulk-delete

curl --request POST \
  --url https://example.com/api/superadmin/users/bulk-delete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "user_ids": [ "example" ], "confirm": true }'

Bulk hard-delete users (superadmin only). Requires confirm=true.

Authorizations

• HTTPBearer

Request Body ^required

Media type application/json

BulkDeleteUsersRequest

object

user_ids

required

User Ids

Array<string>

confirm

required

Confirm

boolean

Example ^generated

{
  "user_ids": [
    "example"
  ],
  "confirm": true
}

Responses

200

Successful Response

Media type application/json

BulkDeleteUsersResponse

object

deleted

required

Deleted

integer

failed

required

Failed

Array<object>

object

key

additional properties

any

Example ^generated

{
  "deleted": 1,
  "failed": [
    {}
  ]
}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}