deactivate-idle-users.md

Deactivate Idle Users

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

{% hint style="info" %} Permission required: edit-other-user-active-status {% endhint %}

Body Parameters

Key	Example Value	Description
daysIdle*	2	The number of days that the user is idle.
role	admin	The user role. By default, the value is user.

{% hint style="info" %} The last login of the users is considered for deactivation. If no last login exists, then the date of creation is considered. {% endhint %}

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

Version	Description
3.1.0	Added