Get Users
Get All Users
Query Parameters
- laptopUsers boolean
Returns only laptop users when set to true. This param is only effective when EdgeMode header is passed.
- userGroupId integer
Returns the list of users associated to the userGroupId provided.
- 200
- 404
Success
- application/json
- Schema
- Example (from schema)
Schema
- numberOfUsers int32
users object[]
id int32User id
name stringThe user name of the user.
GUID stringglobally unique identifier
email stringEmail-id of the user. This email-id can be used for logging in the user.
fullName stringfull name of the user
plan object
id int32name stringenabled booleanGives information on whether the user is enabled or disabled.
lockInfo object
isLocked booleanReturns if the user is locked or unlocked.
startTime int32If the user is locked, it returns user lock start time in unix time format.
endTime int32If the user is locked, it returns user lock end time in unix time format.
numberOfLaptops int32Returns the number of laptops associated with the user
company object
id int32name stringcommcell object
name stringName of the commcell the entity belongs to.
userPrincipalName stringUser Principal Name(UPN) of the user. This User Principal Name can be used for logging in the user.
{
"numberOfUsers": 0,
"users": [
{
"id": 0,
"name": "string",
"GUID": "string",
"email": "string",
"fullName": "string",
"plan": {
"id": 0,
"name": "string"
},
"enabled": true,
"lockInfo": {
"isLocked": true,
"startTime": 0,
"endTime": 0
},
"numberOfLaptops": 0,
"company": {
"id": 0,
"name": "string"
},
"commcell": {
"name": "string"
},
"userPrincipalName": "string"
}
]
}
Requested Details not found