Help Center/ Meeting/ Server API Reference/ Enterprise Administrator Management/ APIs/ Querying Enterprise Administrators in Pages
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Enterprise Administrators in Pages

Description

This API is used to query enterprise administrators in pages.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

GET

Request Address

/v1/usg/dcs/corp/admin

Transport Protocol

HTTPS

Request Parameters

Table 2 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 account is supported.

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

Table 3 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

Table 4 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 QueryAdminResultDTO objects

Returned details about enterprise administrators.
Table 5 QueryAdminResultDTO parameters

Parameter

Type

Description

account

String

User account (Huawei Cloud Meeting account).

adminType

Integer

Administrator type.

  • 0: default administrator.
  • 1: common administrator.

country

String

Country or region that the mobile number belongs to.

dept

DeptBasicDTO object

Basic department details.

email

String

Email address.

id

String

User UUID.

name

String

Administrator name.

phone

String

Mobile number.
Table 6 DeptBasicDTO parameters

Parameter

Type

Description

corpId

String

Enterprise ID.

deptCode

String

Department code.

deptName

String

Department name.

deptNamePath

String

Department name path.

parentDeptCode

String

Parent department code.

Example Request

GET /v1/usg/dcs/corp/admin
Connection: keep-alive
X-Access-Token: stbH3o4N83uDQPOcFtScKC9nbqCXt3cIDB1U
content-type: application/json
Content-Length: 40
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
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: efd3e53b2d9fa554d11267d5d66ca0bf

{
    "offset": 0,
    "limit": 10,
    "count": 1,
    "data": [
        {
            "id": "ff8080816a024f05016a4e1c2c570a5d",
            "account": "test006",
            "name": "test006",
            "adminType": 1,
            "email": "menmeng1@huawei.com",
            "phone": null,
            "country": null,
            "dept": null
        }
    ]
}

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: stbH3o4N83uDQPOcFtScKC9nbqCXt3cIDB1U' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/admin
Parent topic: APIs