Get Users By Role

Release Time

06/07/2018

Views

2623 times

Execution

Sample execution can be handled via Postman Application.

​

Header part can be handled via Postman Application

​

Success Output

{
  "model": [
    {
      "id": 2,
      "username": "testuser",
      "email": "testuser@example.com",
      "assigned_roles": 1,
      "is_msp_user": false,
      "passwd": null,
      "phone_number": null,
      "time_add": null,
      "time_last_login": null,
      "status": null,
      "passwd_reset_key": null,
      "autologin_key": null,
      "autologin_valid_time": null,
      "count_autologin_left": null,
      "is_ldap_user": null,
      "change_password_time": null,
      "block_status": null,
      "domain": null,
      "sso_password": null,
      "salt": null,
      "password_strategy": null,
      "requires_new_password": null,
      "login_attempts": null,
      "is_protected": null,
      "company_id": null,
      "timezone": null,
      "c_one_types": null
    },
        ....
    {
      "id": 24,
      "username": "testuser24",
      "email": "testuser24@example.com",
      "assigned_roles": 1,
      "is_msp_user": false,
      "passwd": null,
      "phone_number": null,
      "time_add": null,
      "time_last_login": null,
      "status": null,
      "passwd_reset_key": null,
      "autologin_key": null,
      "autologin_valid_time": null,
      "count_autologin_left": null,
      "is_ldap_user": null,
      "change_password_time": null,
      "block_status": null,
      "domain": null,
      "sso_password": null,
      "salt": null,
      "password_strategy": null,
      "requires_new_password": null,
      "login_attempts": null,
      "is_protected": null,
      "company_id": null,
      "timezone": null,
      "c_one_types": null
    }
  ],
  "status": "SUCCESS"
}

 
{
  "model": [
    {
      "id": 2,
      "username": "testuser",
      "email": "testuser@example.com",
      "assigned_roles": 1,
      "is_msp_user": false,
      "passwd": null,
      "phone_number": null,
      "time_add": null,
      "time_last_login": null,
      "status": null,
      "passwd_reset_key": null,
      "autologin_key": null,
      "autologin_valid_time": null,
      "count_autologin_left": null,
      "is_ldap_user": null,
      "change_password_time": null,
      "block_status": null,
      "domain": null,
      "sso_password": null,
      "salt": null,
      "password_strategy": null,
      "requires_new_password": null,
      "login_attempts": null,
      "is_protected": null,
      "company_id": null,
      "timezone": null,
      "c_one_types": null
    },
        ....
    {
      "id": 24,
      "username": "testuser24",
      "email": "testuser24@example.com",
      "assigned_roles": 1,
      "is_msp_user": false,
      "passwd": null,
      "phone_number": null,
      "time_add": null,
      "time_last_login": null,
      "status": null,
      "passwd_reset_key": null,
      "autologin_key": null,
      "autologin_valid_time": null,
      "count_autologin_left": null,
      "is_ldap_user": null,
      "change_password_time": null,
      "block_status": null,
      "domain": null,
      "sso_password": null,
      "salt": null,
      "password_strategy": null,
      "requires_new_password": null,
      "login_attempts": null,
      "is_protected": null,
      "company_id": null,
      "timezone": null,
      "c_one_types": null
    }
  ],
  "status": "SUCCESS"
}

Error Output

Possible  HTTP codes
200	      Ok.
400	      Bad request
401	      Unauthorized
403   	  Forbidden
404	      Not found

 
Possible  HTTP codes
     Ok.
     Bad request
     Unauthorized
      Forbidden
     Not found
​

Param Name	Description	Limitations
role_id	id of user role

Key	Value	Description
Http method	POST	Http method
Content-Type	application/json
x-auth-type	5	Authentication type identifier
x-auth-token	access token