Deactivate Idle Users

Permission required: edit-other-user-active-status

Body Parameters

The last login of the users is considered for deactivation. If no last login exists, then the date of creation is considered.

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-type:application/json" \
     http://localhost:3000/api/v1/users.deactivateIdle \
     -d '{ 
          "daysIdle": 2, 
          "role": "admin" }'

Example Response

{
  "count": 1,
  "success": true
}

Change Log

Last updated

Rocket.Chat versions receive support for six months after release.