Disable users via API.

Disable users via API.




Disable users via API.



Introduction

Welcome, this is a tutorial to disable user via API.


Note: Disable inactive users. Permission required:    edit-other-user-active-status.

Parameters


URL
Require Authentication
Method HTTP
/api/v1/users.deactivateIdle

yes
POST


Payloads

Arguments
Example
Required
Description
daysIdle

2


Require


The stopped days.


role
admin
Optional, default  user

User role.





Call Example


  1. 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"}'

Result:
  1. {

    "count" :
    1 ,

    "success" : true
    }
Observation:

In case of doubts or suggestions, please contact our support via e-mail: suportebr@myhive.global

















    • Related Articles

    • List users and information via API

      List users and information via API Introduction Welcome, this is a tutorial to list users and their information via API. Listing Gets all users in the system and their information, the result is limited only to what the receiver has access to view. ...
    • Set status via API

      Set status via API. Introduction Welcome, this is a tutorial to help set status via API. Defines a user status when status message and status are provided. Arguments: URL Require Authentication Method HTTP /api/v1/users.setAvatar yes POST  Payloads ...
    • Paging via API

      Paging via API. Introduction Welcome, this is a tutorial to help understand how to count, offset, sort via API. As of version, some of the endpoints support query parameters, and . However, the defaults are different by server due to configuration ...
    • Creating user via API.

      Creating user via API. Introduction Welcome, this is a tutorial to login via API Parameters URL Require Authentication Method HTTP /api/v1/users.create yes POST Variables Note: To save customFields, you must first define customFields in the admin ...
    • Set Avatar Image via API

      Set Avatar Image via API. Introduction Welcome, this is a tutorial to set avatar image via API. Uploading a file. Arguments: URL Require Authentication Method HTTP /api/v1/users.setAvatar yes POST Payloads Arguments Example Required Description image ...