Help Center/ Meeting/ Server API Reference/ User Management/ APIs/ Modifying the User Status in Batches
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Modifying the User Status in Batches

Description

This API is used by an enterprise administrator to modify user status in batches. When some user account resources or whiteboard (SmartRooms) resources expire and the number of user accounts or whiteboard access accounts in the enterprise exceeds the upper limit, the system will automatically disable the accounts at random. In this case, the enterprise administrator can use this API to modify the user status.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

PUT

Request Address

/v1/usg/dcs/corp/member/status/{value}

Transport Protocol

HTTPS

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Location

Description

value

Yes

Integer

Path

New user status.

  • 0: normal.
  • 1: disabled.

accountType

No

Integer

Query

Account type. Default value: 0.

  • 0: Huawei Cloud Meeting account, which is used for account and password authentication.
  • 1: third-party user ID, which is used for app ID authentication.

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.

[Array element]

Yes

Array of strings

Body

User account list.

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

None

Example Request

PUT /v1/usg/dcs/corp/member/status/0?accountType=0
Connection: keep-alive
X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9
Content-Type: application/json
Content-Length: 11
Host: api.meeting.huaweicloud.com 
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

["test010"]

Example Response

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 143
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: 0ecdde61a9c0aedc6c17ed7add46033c

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 -H 'content-type: application/json' -X PUT -H 'X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9' -d '["test010"]' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/member/status/0?accountType=0
Parent topic: APIs