Activate or deactivate a user in the workspace.
Any one of the following permissions is required:
edit-other-user-active-status: Change another user's active status.manage-moderation-actions: Manage moderation actions on reported users.
When a user is deactivated (activeStatus=false), Rocket.Chat revokes all of the user's login tokens and OAuth access tokens, refresh tokens, and authorization codes. The user can no longer call the REST API with previously issued OAuth credentials.
Changelog
| Version | Description |
|---|---|
| 8.5.0 | Added OAuth access token, refresh token, and authorization code revocation on deactivation. |
| 3.7.0 | Added confirmRelinquish to the payload. |
| 0.75.0 | Added |
The authenticated user ID.
The authenticated user token.
When deactivating a user (activeStatus=false) and confirmRelinquish=true:
- If the user is the last owner of a room that has other active members, the member who joined earliest becomes the new owner.
- If the user is the only member of a private room, or no other active member can take ownership, that room is deleted, together with every discussion that belongs to it, regardless of who is a member of those discussions. Public channels are not deleted.
When confirmRelinquish is omitted or false and the user is the last owner of any room, or the only member of a private room, the request fails with user-last-owner and no change is made. details.shouldBeRemoved names the rooms that would be deleted. details.shouldChangeOwner names the rooms that would get a new owner. Child discussions that the user is not subscribed to are not listed; any room in shouldBeRemoved also takes its discussions with it.
The value of the active status.
The user ID whose status value is to be changed.
Only used when activeStatus is false. Set to true to deactivate the user even if they are the last owner of a room, or the only member of a private room. If omitted or false and the user is the last owner of any room, the request fails with user-last-owner.
{
"user": {
"_id": "jJNyu4BQFqdgEcqnR",
"active": false
},
"success": true
}Bad Request
{
"success": false,
"error": "must have required property 'activeStatus'\n[invalid-params]",
"errorType": "invalid-params"
}{
"success": false,
"error": "[user-last-owner]",
"errorType": "user-last-owner",
"details": {
"shouldBeRemoved": [
"cascade-test-group"
],
"shouldChangeOwner": []
}
}Unauthorized
{
"status": "error",
"message": "You must be logged in to do this."
}