Post
/api/v1/users.deactivateIdle
Permission required: edit-other-user-active-status
Changelog
| Version | Description |
|---|---|
| 3.1.0 | Added |
Header parameters
X-User-Id
stringRequired
The authenticated user ID.
ExamplerbAXPnMktTFbNpwtJ
X-Auth-Token
stringRequired
The authenticated user token.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
Body parameters
Example 1
{
"daysIdle": 2,
"role": "user"
}object
daysIdle
integer Required
The number of days that the user is idle.
Example2
role
string
The user role.
Default"user"
Exampleadmin
Responses
200
Success Example
{
"count": 1,
"success": true
}object
count
integer
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "must have required property 'daysIdle' [invalid-params]",
"errorType": "invalid-params"
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
Permission Error
{
"success": false,
"error": "unauthorized"
}object
success
boolean
error
string