代理鉴权
描述
该接口使用第三方的账号进行代理鉴权,鉴权通过后生成一个Access Token。当前支持的第三方代理账号包括:
- Welink的账号和密码
- 支持OAuth2.0标准的第三方账号
- 当clientType取值为72时,同一个account,同时最多能创建64个Token。比如已经创建了64个Token,并且Token都在有效期内,再用同一个account创建一个Token,前64个Token中最早创建的Token将失效。
- 当clientType取值为非72时,同一个account,同时最多能创建1个Token。
- Token有效期是12~24小时。
调试
您可以在API Explorer中调试该接口。
URI
POST /v1/usg/acs/auth/proxy
请求参数
|
参数 |
是否必须 |
类型 |
位置 |
描述 |
|---|---|---|---|---|
|
Content-Type |
是 |
String |
Header |
Body的媒体格式(样例:application/json; charset=UTF-8)。 |
|
X-Request-ID |
否 |
String |
Header |
请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 |
|
Accept-Language |
否 |
String |
Header |
语言参数,默认为中文zh-CN,英文为en-US。 |
|
account |
否 |
String |
Body |
认证账号。 maxLength: 255 minLength: 0 |
|
authServerType |
是 |
String |
Body |
鉴权服务类型。
|
|
authType |
是 |
String |
Body |
鉴权类型。
|
|
clientType |
是 |
Integer |
Body |
登录账号类型。
|
|
createTokenType |
否 |
Integer |
Body |
是否生成Token。默认0。
|
|
credential |
否 |
String |
Body |
OAuth2.0时填从鉴权中心获取的临时Code。 |
|
domain |
否 |
String |
Body |
企业域名。OAuth2.0鉴权时需要填写。 |
|
pwd |
否 |
String |
Body |
认证密码。Welink代理鉴权时需要填写。 maxLength: 255 minLength: 0 |
|
remark |
否 |
String |
Body |
备注信息。 |
状态码
|
HTTP状态码 |
描述 |
|---|---|
|
200 |
操作成功。 |
|
400 |
参数异常。 |
|
401 |
鉴权失败。 |
|
403 |
没有权限。 |
|
412 |
账号被停用。 |
|
423 |
账号已被锁定。 |
|
500 |
服务端异常。 |
响应参数
|
参数 |
类型 |
描述 |
|---|---|---|
|
accessToken |
String |
接入Token字符串。 |
|
clientType |
Integer |
登录账号类型。
|
|
createTime |
Long |
业务token的创建时间戳,单位:毫秒。 |
|
daysPwdAvailable |
Integer |
密码有效天数。 |
|
delayDelete |
Boolean |
是否延时删除状态。 |
|
expireTime |
Long |
Token的失效时间戳,单位:秒。 |
|
firstLogin |
Boolean |
是否首次登录。
说明:
首次登录表示尚未修改过密码。首次登录时,系统会提醒用户需要修改密码。 默认值:false。 |
|
forceLoginInd |
Integer |
抢占登录标识。
|
|
proxyToken |
ProxyTokenDTO object |
代理鉴权信息。 |
|
pwdExpired |
Boolean |
密码是否过期。 默认值:false。 |
|
refreshCreateTime |
Long |
刷新token的创建时间戳,单位:毫秒。 |
|
refreshExpireTime |
Long |
刷新token的失效时间戳,单位:秒。 |
|
refreshToken |
String |
刷新token字符串。 |
|
refreshValidPeriod |
Long |
刷新token有效时长,单位:秒。 |
|
tokenIp |
String |
用户IP。 |
|
tokenType |
Integer |
token类型。
|
|
user |
UserInfo object |
用户鉴权信息。 |
|
validPeriod |
Long |
Token的有效时长,单位:秒。 |
请求消息示例
POST /v1/usg/acs/auth/proxy
Connection: keep-alive
Content-Type: application/json
X-Request-ID: 5162fa32dc7e47afafeee39a72a2eec3
Accept-Language: zh-CN
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
{
"clientType": "72",
"authServerType": "workplace",
"authType": "AccountAndPwd",
"pwd": "******",
"createTokenType": 0,
"account": "******"
}
响应消息示例
HTTP/1.1 200
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 745
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Expires: Thu, 01 Jan 1970 00:00:00 GMT
X-XSS-Protection: 1; mode=block
X-Download-Options: noopen
X-Content-Type-Options: nosniff
strict-transport-security: max-age=16070400; includeSubDomains
X-Frame-Options: SAMEORIGIN
Content-Security-Policy: default-src 'self' 'unsafe-inline' 'unsafe-eval' blob: data: http: https: ; child-src * ; connect-src *
x-request-id: 5162fa32dc7e47afafeee39a72a2eec3
Server: CloudPortal
{
"accessToken": "stbNxmD2UXEDkHQD73sqMhXB6eXw6ngvSbo9",
"clientType": 0,
"createTime": 1599102826754,
"daysPwdAvailable": -18172,
"delayDelete": false,
"expireTime": 1577979513,
"firstLogin": true,
"forceLoginInd": null,
"proxyToken": null,
"pwdExpired": false,
"refreshCreateTime": 1599102826754,
"refreshExpireTime": 1601694826,
"refreshToken": "stbYaza5VVRr3IGuLSs6ZvF0lMHHvGO0tQ0f",
"refreshValidPeriod": 2592000,
"tokenIp": "10.8.0.90",
"tokenType": 0,
"user": {
"adminType": 2,
"alias1": null,
"appId": null,
"cloudUserId": "76aaaba8a12f4c0a8a43192...",
"companyDomain": null,
"companyId": "f5968fc4f9c14d50905e8e66672dabc6",
"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:xxxx@huaweicloud.com",
"spId": "666bd8558e4646e1a7e1a0c99cf898e8",
"status": 0,
"thirdAccount": "62fe180o133fd...",
"tr069Account": "X3M537A6IX4SC...",
"ucloginAccount": "z8b2vo875ioh54r29ad5e3552vb3gm8np2j167...",
"userId": "0d5202707123429d876....",
"userType": 2,
"visionAccount": null,
"weLinkUser": false
},
"validPeriod": 84616
}
错误码
当您使用华为云会议服务端API时,如果遇到“MMC”或者“USG”开头的错误码,请参考华为云API错误中心。
CURL命令示例
curl -k -i -H 'content-type: application/json' -X POST -H 'X-Request-ID: 5162fa32dc7e47afafeee39a72a2eec3,Content-Type: application/json,Accept-Language: zh-CN' -H 'date: 20190329T074551Z' -d '{"clientType":0,"authServerType":"workplace","authType":"AccountAndPwd","pwd":"******","createTokenType":0,"account":"******"}'
'https://api.meeting.huaweicloud.com/v1/usg/acs/auth/proxy'