执行鉴权
描述
该接口使用华为云会议账号和密码鉴权，鉴权通过后生成一个Access Token。
- 当clientType取值为72时，同一个account，同时最多能创建64个Token。比如已经创建了64个Token，并且Token都在有效期内，再用同一个account创建一个Token，前64个Token中最早创建的Token将失效。
- 当clientType取值为非72时，同一个account，同时最多能创建1个Token。
- Token有效期是12~24小时。
调试
您可以在API Explorer中调试该接口。
接口原型
|
请求方法 |
POST |
|---|---|
|
请求地址 |
/v1/usg/acs/auth/account |
|
传输协议 |
HTTPS |
请求参数
|
参数 |
是否必须 |
类型 |
位置 |
描述 |
|---|---|---|---|---|
|
Authorization |
是 |
String |
Header |
鉴权信息，携带用户账号密码信息。使用时需要对账号密码进行Base64转码操作。
Basic Base64(account:password)
Basic eWMyOjE5OTUwwWWM=
说明：
password最少8个字符，最多32个字符。 |
|
Content-Type |
是 |
String |
Header |
Body的媒体格式。
|
|
X-Request-ID |
否 |
String |
Header |
请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 |
|
Accept-Language |
否 |
String |
Header |
语言参数，默认为中文zh-CN，英文为en-US。 |
|
HA2 |
否 |
String |
Body |
验证码信息，用于验证码场景携带服务端返回的验证码信息。 |
|
account |
是 |
String |
Body |
用户账号（华为云会议账号）。
业务账号请提前申请，具体申请方法请参见开发流程。
说明：
|
|
clientType |
是 |
Integer |
Body |
登录客户端类型。
|
|
createTokenType |
否 |
Integer |
Body |
是否生成Token，默认值为0。
|
状态码
|
HTTP状态码 |
描述 |
|---|---|
|
200 |
操作成功。 |
|
400 |
参数异常。 |
|
401 |
鉴权失败。 |
|
412 |
账号被停用。 |
|
423 |
账号已被锁定。 |
|
500 |
服务端异常。 |
响应参数
|
参数 |
类型 |
描述 |
|---|---|---|
|
accessToken |
String |
Access Token字符串。 |
|
clientType |
Integer |
登录账号类型。
|
|
createTime |
Long |
Access Token的创建时间戳，单位：毫秒。 |
|
daysPwdAvailable |
Integer |
密码有效天数。 |
|
expireTime |
Long |
Access Token的失效时间戳，单位：秒。 |
|
firstLogin |
Boolean |
是否首次登录。
说明：
首次登录表示尚未修改过密码。首次登录时，系统会提醒用户需要修改密码。 默认值：false。 |
|
proxyToken |
ProxyTokenDTO object |
代理鉴权信息。 |
|
pwdExpired |
Boolean |
密码是否过期。 默认值：false。 |
|
refreshCreateTime |
Long |
Refresh Token的创建时间戳，单位：毫秒。 |
|
refreshExpireTime |
Long |
Refresh Token的失效时间戳，单位：秒。 |
|
refreshToken |
String |
Refresh Token字符串。 |
|
refreshValidPeriod |
Long |
Refresh Token有效时长，单位：秒。 |
|
tokenIp |
String |
用户IP。 |
|
tokenType |
Integer |
Token类型。
|
|
user |
UserInfo object |
用户鉴权信息。 |
|
validPeriod |
Long |
Access Token的有效时长，单位：秒。 |
|
forceLoginInd |
Integer |
抢占登录标识。
|
|
delayDelete |
Boolean |
是否延时删除状态。 |
|
参数 |
类型 |
描述 |
|---|---|---|
|
accessToken |
String |
代理鉴权服务器的短token字符串。 |
|
enableRerouting |
Boolean |
是否开启二次路由。 |
|
longAccessToken |
String |
代理鉴权服务器的长token字符串。 |
|
middleEndInnerUrl |
String |
中台内网地址。 |
|
middleEndUrl |
String |
中台地址。 |
|
validPeriod |
Long |
Token有效时长，单位：秒。 |
|
参数 |
类型 |
描述 |
|---|---|---|
|
adminType |
Integer |
管理员类型。
|
|
appId |
String |
应用ID。 |
|
cloudUserId |
String |
华为云账号ID。 |
|
companyDomain |
String |
企业域名。 |
|
companyId |
String |
用户归属的企业ID。 |
|
corpType |
Integer |
企业套餐类型。
|
|
freeUser |
Boolean |
标识是否是免费试用用户。 |
|
grayUser |
Boolean |
标识是否是灰度用户。 |
|
headPictureUrl |
String |
头像链接。 |
|
isBindPhone |
Boolean |
标识是否绑定手机。 |
|
name |
String |
用户名称。 |
|
nameEn |
String |
用户英文名称。 |
|
numberHA1 |
String |
号码对应的HA1。 |
|
alias1 |
String |
用户别名。 |
|
paidAccount |
String |
付费用户机机账号，用于智慧屏登录。 |
|
paidPassword |
String |
付费用户机机密码，用于智慧屏登录。 |
|
password |
String |
机机密码，用于智慧屏登录。 |
|
realm |
String |
本地鉴权。 |
|
serviceAccount |
String |
用户关联的SIP号码。 |
|
spId |
String |
用户所在企业归属的SP ID。 |
|
status |
Integer |
用户状态。
|
|
thirdAccount |
String |
第三方的用户账号。 |
|
tr069Account |
String |
tr069账号。 |
|
ucloginAccount |
String |
华为云会议账号。 |
|
userId |
String |
用户UUID。 |
|
userType |
Integer |
用户类型。
|
|
visionAccount |
String |
智慧屏设备ID。 |
|
weLinkUser |
Boolean |
标识是否是WeLink用户。 |
请求消息示例
POST /v1/usg/acs/auth/account
Connection: keep-alive
Authorization: Basic dGVzdDp0ZXN0
Content-Type: application/json
Content-Length: 94
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
{
"account": "zhangsan@huawei.com",
"clientType": 72,
"createTokenType": 0
}
响应消息示例
HTTP/1.1 200 OK
Date: Tue, 17 Dec 2019 09:32:47 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 591
Connection: keep-alive
X-Request-Id: f90fbd8714328398fcbedddde0f1303c
{
"accessToken": "cnr1810Ukd9iiytRVdcrK3LiSj0KrGHl6IbtGIgz",
"clientType": 72,
"createTime": 1663576164818,
"daysPwdAvailable": -18172,
"delayDelete": false,
"expireTime": 1663657182,
"firstLogin": true,
"forceLoginInd": null,
"proxyToken": null,
"pwdExpired": false,
"refreshCreateTime": 1663576164818,
"refreshExpireTime": 1666168164,
"refreshToken": "cnr1810GCy8II2HIuNitisGTsl7FELztZ3PvQf9D",
"refreshValidPeriod": 2592000,
"tokenIp": "10.8.0.90",
"tokenType": 0,
"user": {
"adminType": 2,
"alias1": null,
"appId": null,
"cloudUserId": null,
"companyDomain": null,
"companyId": "972897387",
"corpType": 0,
"freeUser": false,
"grayUser": false,
"headPictureUrl": null,
"isBindPhone": null,
"name": "xxxx_name",
"nameEn": null,
"numberHA1": "1ead5e5ce44849bc2718d5c....",
"paidAccount": null,
"paidPassword": null,
"password": null,
"realm": "huaweicloud.com",
"serviceAccount": "sip:+99111217192335617@huaweicloud.com",
"spId": "666bd8558e4646e1a7e1a0c99cf898e8",
"status": 0,
"thirdAccount": "zhangsan@huawei.com",
"tr069Account": "",
"ucloginAccount": "zhangsan@huawei.com",
"userId": "d2bee87b30544ee68562912fb08b1074",
"userType": 2,
"visionAccount": null,
"weLinkUser": false
},
"validPeriod": 84616
}
错误码
当您使用华为云会议服务端API时，如果遇到“MMC”或者“USG”开头的错误码，请参考华为云API错误中心。
CURL命令
curl -k -i -H 'content-type: application/json' -X POST -H 'Authorization:Basic dGVzdDp0ZXN0' -d '{"account": "user01","clientType": 72,"createTokenType": 0}' 'https://api.meeting.huaweicloud.com/v1/usg/acs/auth/account'
