Skip to content

Delete a User

DELETE
/api/v1/admin/users/{id}
curl --request DELETE \
--url https://example.com/api/v1/admin/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "archive_days": 1, "policy": "archive" }'

Deletes a User. It requires a signed-in User with the admin scope and the admin or owner Role. It can return 400 if the request is invalid, 401 if the session is missing or expired, 403 if access is denied and 409 if the request conflicts with the current state. Route: /api/v1/admin/users/{id}. Inputs: id. A recent account assertion is required. Do not automatically replay this operation after an uncertain result.

id
required
string format: uuid
Media typeapplication/json
One of:
object
archive_days
integer | null format: int32
policy
required
string
Allowed values: archive
Media typeapplication/json
object
state
required
string
Allowed values: pending
user_id
required
string format: uuid
Example
{
"state": "pending"
}