校验Token - CheckToken
描述
该接口提供校验token合法性功能。服务器收到请求后,验证token合法性并返回结果。如果参数needGenNewToken为true时,生成新的token并返回。
调试
您可以在API Explorer中调试该接口。
URI
POST /v1/usg/acs/token/validate
请求参数
参数 | 是否必须 | 类型 | 位置 | 描述 |
|---|---|---|---|---|
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。 |
token | 是 | String | Body | Access Token。 |
needGenNewToken | 是 | Boolean | Body | 是否生成新的token。 true:生成新的token值。 false:不生成新的token值。 |
needAccountInfo | 否 | Boolean | Body | 是否需要返回用户账号信息(账号、用户名称等信息)。 |
状态码
HTTP状态码 | 描述 |
|---|---|
200 | 操作成功。 |
400 | 参数异常。 |
401 | 未鉴权或鉴权失败。 |
403 | 权限受限。 |
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/token/validate
Connection: keep-alive
Content-Type: application/json
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
{
"needGenNewToken": false,
"needAccountInfo": true,
"token": "stbNYluHvordsmyF2Ubt271qDr6WDAVLtLRb"
} 响应消息示例
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
X-Request-Id: f90fbd8714328398fcbedddde0f1303c
{
"accessToken": "stbNYluHvordsmyF2Ubt271qDr6WDAVLtLRb",
"tokenIp": "10.8.0.130",
"validPeriod": null,
"expireTime": 1582901905,
"createTime": null,
"user": {
"userId": "zhangsan@cloudlinkwp",
"ucloginAccount": "zhangsan@cloudlinkwp",
"serviceAccount": "sip:878587543144724349434080@huaweicloud.com",
"numberHA1": "1ead5e5ce44849bc2718d5cb479c890f",
"alias1": null,
"companyId": "12345",
"spId": "3be969ebb05a4723a234d534bcf36680",
"companyDomain": null,
"realm": "huawei.com",
"userType": 2,
"adminType": 2,
"name": "zhangsan",
"nameEn": null,
"isBindPhone": null,
"freeUser": false,
"thirdAccount": "zhangsan@cloudlinkwp",
"visionAccount": null,
"headPictureUrl": null
},
"clientType": 72,
"forceLoginInd": null,
"firstLogin": false,
"pwdExpired": false,
"daysPwdAvailable": null
} 错误码
当您使用华为云会议服务端API时,如果遇到“MMC”或者“USG”开头的错误码,请参考华为云API错误中心。
CURL命令示例
curl -k -i -X POST -H 'Content-Type:application/json' -d '{"needGenNewToken":false,"needAccountInfo":true,"token":"stbNYluHvordsmyF2Ubt271qDr6WDAVLtLRb"}'
'https://api.meeting.huaweicloud.com/v1/usg/acs/token/validate' 
