REST API - GET User

This operation returns a list of users.

Request

Syntax

GET <webservice>/User?level={level} HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name	Description	Required
level	Controls the user properties included in the response. Valid values are: 10, user properties such as the description and email address 30, additional user properties such as quota information 40, associated internal and external user groups, security associations, and the user properties returned by level 30 50, users who can manage the user and the information returned by level 40	No

Name

Description

Required

level

Controls the user properties included in the response.

Valid values are:

10, user properties such as the description and email address
30, additional user properties such as quota information
40, associated internal and external user groups, security associations, and the user properties returned by level 30
50, users who can manage the user and the information returned by level 40

Request Headers

Name	Description
Host	The host name of the Web Server or Web Console used in the API request.
Accept	The format of the response. Valid values are: application/xml or application/json.
Authtoken	The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter	Description	Element
userId	The system-generated ID assigned to the user.	userEntity
userName	The name of the user.	userEntity

Examples

Sample Request

GET <webservice>/User HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

This is the response when the level request parameter is not used.

{ "users": [ { "removeOtherActiveSessions": true, "associatedUserGroupsOperationType": 2, "idleTime": 0, "lastLogIntime": 0, "associatedExternalUserGroupsOperationType": 2, "loggedInMode": 2, "userEntity": { "userGUID": "60sssA6D-2yuu-4E3B-ACAD-AAD489examEA7", "userName": "admin", "userId": 1 } }, { "removeOtherActiveSessions": true, "associatedUserGroupsOperationType": 2, "idleTime": 0, "lastLogIntime": 0, "associatedExternalUserGroupsOperationType": 2, "loggedInMode": 0, "userEntity": { "userGUID": "Dsss5DD5-2ucc-4D7C-B9A2-EA8E9exm5FA2", "userName": "user001", "userId": 4 } }, { "removeOtherActiveSessions": true, "associatedUserGroupsOperationType": 2, "idleTime": 42, "lastLogIntime": 0, "associatedExternalUserGroupsOperationType": 2, "loggedInMode": 1, "userEntity": { "userGUID": "6sssA924-3xcc-4E0A-BC72-13E1exmEF129", "userName": "user002", "userId": 5 } } ]
}

This is the response when the level request parameter is set to 10.

{ "users": [ { "description": "Administrator", "removeOtherActiveSessions": true, "associatedUserGroupsOperationType": 2, "idleTime": 1, "email": "admin@mycompany.com", "lastLogIntime": 1518116686, "associatedExternalUserGroupsOperationType": 2, "fullName": "Administrator", "loggedInMode": 2, "enableUser": true, "userEntity": { "userGUID": "60sssA6D-2yuu-4E3B-ACAD-AAD489examEA7", "userName": "admin", "userId": 1 } }, { "description": "", "removeOtherActiveSessions": true, "associatedUserGroupsOperationType": 2, "idleTime": 0, "email": "user001@mycompany.com", "lastLogIntime": 1517434820, "associatedExternalUserGroupsOperationType": 2, "fullName": "", "loggedInMode": 0, "enableUser": true, "userEntity": { "userGUID": "Dsss5DD5-2ucc-4D7C-B9A2-EA8E9exm5FA2", "userName": "user001", "userId": 4 } }, { "description": "", "removeOtherActiveSessions": true, "associatedUserGroupsOperationType": 2, "idleTime": 263, "email": "user002@mycompany.com", "lastLogIntime": 1518022883, "associatedExternalUserGroupsOperationType": 2, "fullName": "", "loggedInMode": 1, "enableUser": true, "userEntity": { "userGUID": "6sssA924-3xcc-4E0A-BC72-13E1exmEF129", "userName": "user002", "userId": 5 } } ]
}