delete-user.md

Delete User

HTTP Method	URL	Requires Auth
POST	/api/v1/users.delete	yes

{% hint style="info" %} Permission required: delete-user {% endhint %}

Body Parameters

Key	Example Value	Description
userId* or username*	BsNr28znDkG8aeo7W or test	The ID or username of the user.
confirmRelinquish	true	Deletes user even if it is the last owner of a room. The default value is false.

Example Call

With userID:

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-type:application/json" \
     http://localhost:3000/api/v1/users.delete \
     -d '{ 
          "userId": "BsNr28znDkG8aeo7W" }'

With username:

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-type:application/json" \
     http://localhost:3000/api/v1/users.delete \
     -d '{ 
          "username": "test" }'

Example Response

{
  "success": true
}

Change Log

Version	Description
3.7.0	Added confirmRelinquish to the payload.
0.35.0	Added