Adding a User

Updated on 2024-01-19 GMT+08:00

Online Debugging

CLI Examples

View PDF

Description

This API is used by an enterprise administrator to add a user.

NOTE:

By default, a user needs to change the password when logging in to the Huawei Cloud Meeting app or Management Platform for the first time. To disable the function of changing the password upon the first login, contact Huawei sales personnel and provide your Huawei Cloud Meeting enterprise ID.

Debugging

You can debug this API in API Explorer.

Prototype

**Table 1** Prototype
Request Method	POST
Request Address	/v1/usg/dcs/corp/member
Transport Protocol	HTTPS

Request Parameters

**Table 2** Parameters
Parameter	Mandatory	Type	Location	Description
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.
account	No	String	Body	Huawei Cloud Meeting user account. If this parameter is carried, the value is used. Otherwise, the value is automatically generated by the backend. The account must be unique in the system. The account can contain letters, numbers, underscores (_), hyphens (-), periods (.), and at signs (@), and cannot contain only numbers. The at sign (@) cannot be followed by a period(.). maxLength: 64 minLength: 0 NOTE: This parameter is mandatory when account/password authentication is used.
thirdAccount	No	String	Body	Third-party user ID. The third-party user ID must be unique in the enterprise. NOTE: This parameter is mandatory when app ID authentication is used.
country	No	String	Body	Country or region that the mobile number belongs to. Default value: chinaPR. maxLength: 255 minLength: 0
deptCode	No	String	Body	Department code. If this parameter is not carried, the root department is used by default. Default value: 1.
desc	No	String	Body	Remarks. maxLength: 128 minLength: 0
email	No	String	Body	Email address. maxLength: 255 minLength: 0 NOTE: Specify the email address or mobile number. Use the unified email address format. If the enterprise disables the SMS function, the email address is mandatory.
englishName	No	String	Body	English name of the enterprise user. maxLength: 64 minLength: 0
function	No	UserFunctionDTO object	Body	User function flag.
hidePhone	No	Boolean	Body	Whether to hide the mobile number. Default value: false. true: The mobile number is not displayed in the corporate directory or meetings. false: The mobile number is displayed in the corporate directory and meetings.
name	Yes	String	Body	Name of the enterprise user. maxLength: 64 minLength: 1
phone	No	String	Body	Mobile number, which must contain the country code. For example, a mobile number in Chinese mainland is +86xxxxxxxxxxx. This parameter is combined with the country parameter. The mobile number can contain only numbers. The mobile number or email address must be specified.
pwd	No	String	Body	Password of the user account. If this parameter is carried, the actual value is used. Otherwise, the value is generated by the backend by default. The password must meet the following requirements: The password can contain 8 to 32 characters. The password cannot be the same as the account or the account spelled backwards. The password must contain at least two of the following: lowercase letters, uppercase letters, numbers, and special characters (`~!@#$%^&*()-_=+\|[{}];:",'<.>/?).
sendNotify	No	String	Body	Whether to send email and SMS notifications for registration. 0: no. If this parameter is null or set to other values, notifications are sent by default.
signature	No	String	Body	Signature. maxLength: 512 minLength: 0
sortLevel	No	Integer	Body	Sequence number in the corporate directory. A smaller value indicates a higher position in the corporate directory. Default value: 10000. maximum: 10000 minimum: 1
status	No	Integer	Body	User status. 0: normal. 1: disabled. Default value: 0.
title	No	String	Body	Job title. maxLength: 32 minLength: 0

**Table 3** UserFunctionDTO data structure
Parameter	Mandatory	Type	Location	Description
enableRoom	No	Boolean	Body	Whether to enable the intelligent whiteboard collaboration function. If the function is enabled, the account is used for the intelligent collaborative whiteboard and occupies the whiteboard resources in the enterprise. If the whiteboard resources are insufficient, the function cannot be enabled. Default value: false.

Status Codes

**Table 4** 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 5** Response parameters
Parameter	Type	Description
activeTime	Long	Activation time (UTC timestamp).
adminType	Integer	Administrator type. 0: default (super) administrator. 1: common administrator. 2: common enterprise member (This value is valid only when UserType is set to 2.)
corp	CorpBasicInfoDTO object	Enterprise registration details, which are returned only when users query the personal details of themselves.
country	String	Country or region that the mobile number of the user belongs to.
deptCode	String	Department code.
deptName	String	Department name.
deptNamePath	String	Department name path.
desc	String	Remarks.
devType	QueryDeviceInfoResultDTO object	Type of the associated device.
email	String	Email address.
englishName	String	English name.
function	UserFunctionDTO object	User function flag.
hidePhone	Boolean	Whether to hide the mobile number.
id	String	User UUID.
license	Integer	License. 0: commercial use. 1: free trial.
name	String	Name.
phone	String	Mobile number.
signature	String	Signature.
sipNum	String	SIP number.
sortLevel	Integer	Sequence number in the corporate directory. A smaller value indicates a higher position in the corporate directory.
status	Integer	User status. 0: normal. 1: disabled.
thirdAccount	String	Third-party user ID.
title	String	Job title.
userAccount	String	Huawei Cloud Meeting account.
userType	Integer	User type. 2: common user. 12: smart TV user. 13: IdeaHub user. 14: SmartRooms user.
visionAccount	String	Unique smart TV account.
vmrList	Array of UserVmrDTO objects	Cloud meeting room list.

**Table 6** QueryDeviceInfoResultDTO data structure
Parameter	Type	Description
deviceSize	String	Device dimensions.
model	String	Device model.
purchaseChannel	String	Device purchase channel.

Example Request

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

{
    "englishName": "englishName",
    "country": "chinaPR",
    "signature": "signature-info",
    "hidePhone": false,
    "sendNotify": "0",
    "title": "manager",
    "sortLevel": 100000,
    "phone": "+86173****9807",
    "function": {
        "enableRoom": true
    },
    "name": "name",
    "pwd": "******",
    "account": "3e48b79b660e403cb5e0208f7be83961",
    "email": "******",
    "deptCode": "1",
    "desc": "desc",
    "status": "status"
}

Example Response

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 160
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Server: api-gateway
X-Request-Id: ebbb9b1e50d1ec63b78d8484d170173f

{
    "id": "f521bebcbb27422cb3241c4cb19942c5",
    "userAccount": "3e48b79b660e403cb5e0208f7be83961",
    "name": "name",
    "englishName": "englishName",
    "phone": "+86173****9807",
    "country": "chinaPR",
    "email": "******",
    "sipNum": "+8657198480",
    "deptCode": "1",
    "deptName": "Root Department",
    "deptNamePath": "Root Department",
    "userType": 2,
    "adminType": 2,
    "signature": "signature-info",
    "title": "manager",
    "desc": "desc",
    "corp": null,
    "function": {
        "enableRoom": true
    },
    "devType": {
        "model": null,
        "deviceSize": null,
        "purchaseChannel": null
    },
    "status": 0,
    "sortLevel": 10000,
    "hidePhone": false,
    "visionAccount": null,
    "thirdAccount": "thirdAccount",
    "license": 0,
    "activeTime": 1601221696783,
    "vmrList": [
        {
            "id": "2c908bc76f61a5f2016f61bbfdf5039b",
            "vmrId": "912992631",
            "vmrName": "name's cloud meeting room",
            "vmrPkgId": null,
            "vmrPkgName": null,
            "vmrPkgParties": null,
            "vmrPkgLength": null,
            "status": "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 -H 'content-type: application/json' -X POST -H 'X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9' -d '{"account": "test963","country": "chinaPR","deptCode": "1","email": "******","name": "test963","phone": "+86136********","pwd": "******"}' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/member

Parent topic: APIs

Previous topic: APIs

Next topic: Modifying a User