Deletes an existing user. Requires delete-user
permission.
URL | Requires Auth | HTTP Method |
|
|
|
Argument | Example | Required | Description |
|
| Required | The id or username of the user. |
|
| Optional Default: | Deletes user even if it is the last owner of a room. |
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" }'
{"success": true}
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" }'
{"success": true}
Version | Description |
3.7.0 | Added |
0.35.0 | Added |