Post
/api/v1/users.delete
Deletes an existing user from your workspace. Permission required: delete-user
Changelog
| Version | Description |
|---|---|
| 3.7.0 | Added confirmRelinquish to the payload. |
| 0.35.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authenticated user token.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The authenticated user ID.
ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example 1
{
"userId": "BsNr28znDkG8aeo7W",
"confirmRelinquish": true
}object
userId
string Required
The userId of the user. Alternatively, you can use the username property and value.
confirmRelinquish
boolean
Deletes user even if it is the last owner of a room. By default, it is set to false.
Defaultfalse
Responses
200
OK
Success
{
"success": true
}object
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "The required \"userId\" or \"username\" param was not provided [error-user-param-not-provided]",
"errorType": "error-user-param-not-provided"
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
Permission Error
{
"success": false,
"error": "unauthorized"
}object
success
boolean
error
string