Fuselage
Powered By GitBook
Delete User Endpoint
Deletes an existing user.
Requires delete-user permission.
URL
Requires Auth
HTTP Method
/api/v1/users.delete
yes
POST

Payload

Argument
Example
Required
Description
userId or username
BsNr28znDkG8aeo7W
Required
The id or username of the user.
confirmRelinquish
true
Optional Default: false
Deletes user even if it is the last owner of a room.

Example Call - Via userId

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

Example Result

1
{
2
"success": true
3
}
Copied!

Example Call - Via username

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

Example Result

1
{
2
"success": true
3
}
Copied!

Change Log

Version
Description
3.7.0
Added confirmRelinquish to the payload.
0.35.0
Added
Last modified 2mo ago