Querying Users in Pages
Description
This API is used by an enterprise administrator to query enterprise users in pages.
Debugging
You can debug this API in API Explorer.
Prototype
Request Method |
GET |
---|---|
Request Address |
/v1/usg/dcs/corp/member |
Transport Protocol |
HTTPS |
Request Parameters
Parameter |
Mandatory |
Type |
Location |
Description |
---|---|---|---|---|
offset |
No |
Integer |
Query |
Query offset. If the value exceeds the maximum number of records available, records on the last page are returned. |
limit |
No |
Integer |
Query |
Number of records to query. Default value: 10. |
searchKey |
No |
String |
Query |
Search criteria. Fuzzy search by name, mobile number, email address, account, and third-party user ID is supported. |
sortField |
No |
String |
Query |
Sort field. Options:
|
isAsc |
No |
Boolean |
Query |
Whether to sort records in ascending order. |
deptCode |
No |
String |
Query |
Department code. If this parameter is not specified, all departments are queried. |
enableSubDept |
No |
Boolean |
Query |
Whether to query sub-departments. Default value: true. |
adminType |
No |
Integer |
Query |
Query by administrator type.
|
enableRoom |
No |
Boolean |
Query |
Whether to query SmartRooms users.
NOTE:
This parameter will be discarded. Do not use it. |
userType |
No |
Array of integers |
Query |
User type. If the request does not contain this parameter, common users are queried by default.
|
status |
No |
Integer |
Query |
User status. If this parameter is not specified, all records are queried.
|
containsUnActive |
No |
Boolean |
Query |
Whether to query inactive terminals. Default value: false. |
X-Access-Token |
Yes |
String |
Header |
Authorization token. Use the value of accessToken in the response to the request for Authenticating an App ID. |
X-Request-Id |
No |
String |
Header |
Request ID, which is used for fault tracing and locating. You are advised to use a UUID. If this parameter is not carried, a request ID is automatically generated. |
Accept-Language |
No |
String |
Header |
Language. Values: zh-CN for Chinese (default) and en-US for English. |
Status Codes
HTTP Status Code |
Description |
---|---|
200 |
Operation successful. |
400 |
Invalid parameters. |
401 |
Authentication is not performed or fails. |
403 |
Insufficient permissions. |
500 |
Server exception. |
Response Parameters
Parameter |
Type |
Description |
---|---|---|
count |
Integer |
Total number of records. |
limit |
Integer |
Number of records displayed per page. Default value: 10. |
offset |
Integer |
Number of the query start page. The value starts from 0. |
data |
Array of SearchUserResultDTO objects |
Enterprise user details. |
Parameter |
Type |
Description |
---|---|---|
activeCode |
String |
Activation code. |
activeCodeExpireTime |
Long |
Expiration time of the activation code, which is a UTC timestamp. |
activeTime |
Long |
Activation time (UTC timestamp). |
adminType |
Integer |
Administrator type.
|
country |
String |
Country or region that the mobile number belongs to. |
deptCode |
String |
Department code. |
deptNamePath |
String |
Department name path. |
desc |
String |
Remarks. |
|
String |
Email address. |
englishName |
String |
English name. |
expireTime |
Long |
Expiration time of an activated terminal, which is a UTC timestamp. |
hidePhone |
Boolean |
Whether to hide the mobile number. |
id |
String |
User UUID. |
license |
Integer |
License. |
name |
String |
Name. |
phone |
String |
Mobile number. |
signature |
String |
Signature. |
sortLevel |
Integer |
Sequence number in the corporate directory. A smaller value indicates a higher position in the corporate directory. maximum: 10000 minimum: 1 |
status |
Integer |
User status.
|
thirdAccount |
String |
Third-party user ID. |
title |
String |
Job title. |
userAccount |
String |
Huawei Cloud Meeting account. |
userType |
Integer |
User type.
|
visionAccount |
String |
Smart TV account. |
vmrId |
String |
Personal cloud meeting room ID. |
Example Request
GET /v1/usg/dcs/corp/member Connection: keep-alive X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9 Content-Type: application/json Content-Length: 125 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
Example Response
HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 1329 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 63facce44898efa03629afd189da7f0f { "count": 1, "data": [ { "activeCode": null, "activeCodeExpireTime": null, "activeTime": 1601221696783, "adminType": 2, "country": "chinaPR", "deptCode": "1", "deptNamePath": "Root Department", "desc": "desc", "email": "email@huawei.com", "englishName": "englishName", "expireTime": null, "hidePhone": false, "id": "a7f78791553d4ec6b3a4b721f0946286", "license": 0, "name": "name", "phone": "+86123456789", "signature": "signature", "sortLevel": 10000, "status": 0, "thirdAccount": "thirdAccount", "title": "manager", "userAccount": "4036ca5e54d144d9b9e3ed25b9368d3a", "userType": 2, "visionAccount": null, "vmrId": "911150978" } ], "limit": 10, "offset": 0 }
Error Codes
If an error code starting with MMC or USG is returned when you use this API, rectify the fault by following the instructions provided in Huawei Cloud API Error Center.
Example cURL Command
curl -k -i -X GET -H 'X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/member
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot