更新时间:2022-05-05 GMT+08:00
分享

刷新Token

描述

该接口提供刷新Token功能,根据传入的Token,刷新Token失效时间并返回结果。

SLA

请求成功率:>99.99%

TP99请求时延:97ms

调试

您可以在API Explorer中调试该接口。

接口原型

表1 接口原型

请求方法

PUT

请求地址

/v1/usg/acs/token

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

X-Access-Token

String

Header

token鉴权。

X-Request-ID

String

Header

请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用uuId,若不携带,则后台自动生成。

Accept-Language

String

Header

语言参数,默认为中文zh-CN,英文为en-US。

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常

401

未鉴权或鉴权失败。

403

权限受限。

500

服务端异常。

响应参数

表4 响应参数

参数

类型

描述

accessToken

String

接入Token字符串。

clientType

Integer

登录帐号类型。

  • 72:API调用类型

createTime

Long

业务token的创建时间戳,单位:毫秒。

daysPwdAvailable

Integer

密码有效天数。

delayDelete

Boolean

是否延时删除状态。

expireTime

Long

Token的失效时间戳,单位:秒。

firstLogin

Boolean

是否首次登录。

说明:

首次登录表示尚未修改过密码。首次登录时,系统会提醒用户需要修改密码。

默认值:false。

forceLoginInd

Integer

抢占登录标识。

  • 0:非抢占
  • 1:抢占(未启用)

proxyToken

ProxyTokenDTO object

代理鉴权信息。

pwdExpired

Boolean

密码是否过期。

默认值:false。

refreshCreateTime

Long

刷新token的创建时间戳,单位:毫秒。

refreshExpireTime

Long

刷新token的失效时间戳,单位:秒。

refreshToken

String

刷新token字符串。

refreshValidPeriod

Long

刷新token有效时长,单位:秒。

tokenIp

String

用户IP。

tokenType

Integer

token类型。

  • 0:用户ACCESS TOKEN
  • 1:会控TOKEN
  • 2:一次性TOKEN

user

UserInfo object

用户鉴权信息。

validPeriod

Long

Token的有效时长,单位:秒。

请求消息示例

PUT /v1/usg/acs/token
Connection: keep-alive
X-Access-Token: stbo3vX1pyduWpSFsjMCmR93mJkfQGnohjvQ
Content-Type: application/json
Content-Length: 88
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

响应消息示例

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 714
Connection: keep-alive
X-Request-Id: f90fbd8714328398fcbedddde0f1303c

{
    "accessToken": "stbo3vX1pyduWpSFsjMCmR93mJkfQGnohjvQ",
    "clientType": 72,
    "createTime": 1599102826754,
    "daysPwdAvailable": -18172,
    "delayDelete": false,
    "expireTime": 1577979513,
    "firstLogin": true,
    "forceLoginInd": null,
    "proxyToken": null,
    "pwdExpired": false,
    "refreshCreateTime": 1599102826754,
    "refreshExpireTime": 1601694826,
    "refreshToken": "stbdkkBy2XkfsiPh4cP9xev0oGL5EmiQxP1a",
    "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 PUT  -H 'X-Access-Token:stbo3vX1pyduWpSFsjMCmR93mJkfQGnohjvQ' 'https://api.meeting.huaweicloud.com/v1/usg/acs/token'
分享:

    相关文档

    相关产品

关闭导读