ListUsers
Description
Queries a list of users.
Request parameters
Parameter | Type | Required | Description |
PageNumber | Integer | Yes | The page number. |
PageSize | Integer | Yes | The number of entries per page. |
Response parameters
Parameter | Type | Description |
ErrorCode | int | The error code. |
Message | String | The error message. |
Success | boolean | The request status. |
RequestId | String | The request ID. |
Data | Struct | The returned data. For more information, see the Data structure. |
Data structure
Parameter | Type | Description |
TotalCount | Integer | The total number of entries. |
PageSize | Integer | The number of entries per page. |
PageNumber | Integer | The page number. |
UserInfos | Struct[] | The list of user information. For more information, see the UserInfo structure. |
UserInfo structure
Parameter | Type | Description |
UserId | String | The user ID. |
UserName | String | The user name. |
CreateTime | Long | Creation Time |
GroupId | String | Enterprise ID |
GroupName | String | Enterprise Name |
UserTel | String | The user's landline number. |
UserEmail | String | The user's mailbox. |
UserMobile | String | Mobile phone |
UserAvatarUrl | String | The URL of the user's profile picture. |
DepartId | String | The department ID. |
DepartName | String | The department name. |
Response example
{
"RequestId": "123",
"Message": "successful!",
"Data":{
"TotalCount":"1",
"PageSize":"10",
"PageNumber":"0",
"UserInfos":[{
"UserId":"test1",
"DepartId": "123",
"UserAvatarUrl": "example.aliyundoc.com",
"UserMobile": "123",
"GroupName": "123",
"UserTel": "123",
"CreateTime": 1571119775000,
"DepartName": "123123",
"UserName": "123",
"UserEmail": "123",
"GroupId": "123"
},{
"UserId":"test2",
"DepartId": "123",
"UserAvatarUrl": "example.aliyundoc.com",
"UserMobile": "123",
"GroupName": "123",
"UserTel": "123",
"CreateTime": 1571119775000,
"DepartName": "123123",
"UserName": "123",
"UserEmail": "123",
"GroupId": "123"
}]
},
"Success": true,
"ErrorCode": 0
}