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

执行鉴权

描述

该接口使用华为云会议帐号和密码鉴权,鉴权通过后生成一个Access Token。

SLA

请求成功率:>99.99%

TP99请求时延:135ms

  • 当clientType取值为72时,同一个account,同时最多能创建64个Token。比如已经创建了64个Token,并且Token都在有效期内,再用同一个account创建一个Token,前64个Token中最早创建的Token将失效。
  • 当clientType取值为非72时,同一个account,同时最多能创建1个Token。
  • Token有效期是12~24小时。

调试

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

接口原型

表1 接口原型

请求方法

POST

请求地址

/v1/usg/acs/auth/account

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

Authorization

String

Header

授权令牌,携带用户帐号密码信息。使用时需要对帐号密码进行Base64转码操作

  • 规则:

Basic Base64(username:password)

  • 样例:

Basic eWMyOjE5OTUwwWWM=

说明:

password最少6个字符,最多32个字符。

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。

HA2

String

Body

-

account

String

Body

用户账号(华为云会议账号)。

样例:zhangsan@huawei

业务账号请提前申请,具体申请方法请参见开发流程

说明:
  • account最少1个字符,最多255个字符。

clientType

Integer

Body

登录客户端类型。

  • 72:API调用类型

createTokenType

Integer

Body

是否生成Token。

  • 0:生成token,用于登录鉴权
  • 1:不生成token

默认值为0。

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

401

鉴权失败。

412

账号被停用。

423

账号已被锁定。

500

服务端异常。

响应参数

表4 响应参数

参数

类型

描述

accessToken

String

接入Token字符串。

clientType

Integer

登录帐号类型。

  • 72:API调用类型

createTime

Long

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

daysPwdAvailable

Integer

密码有效天数。

expireTime

Long

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

firstLogin

Boolean

是否首次登录。

说明:

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

默认值:false。

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的有效时长,单位:秒。

forceLoginInd

Integer

抢占登录标识

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

delayDelete

Boolean

是否延时删除状态

表5 ProxyTokenDTO 数据结构

参数

类型

描述

accessToken

String

代理鉴权服务器的短token字符串。

enableRerouting

Boolean

是否开启二次路由。

longAccessToken

String

代理鉴权服务器的长token字符串。

middleEndInnerUrl

String

中台内网地址。

middleEndUrl

String

中台地址。

validPeriod

Long

token有效时长,单位:秒。

表6 UserInfo 数据结构

参数

类型

描述

adminType

Integer

管理员类型。

  • 0:默认管理员;
  • 1:普通管理员;
  • 2:非管理员,即普通企业成员,“userType”“2”时有效。

appId

String

应用ID。

cloudUserId

String

华为云账号ID。

companyDomain

String

企业域名。

companyId

String

企业ID。

corpType

Integer

企业套餐类型。

  • 0:企业版;
  • 5:免费版;
  • 6:专业版。

freeUser

Boolean

标识是否是免费试用用户。

grayUser

Boolean

标识是否是灰度用户。

headPictureUrl

String

头像链接。

isBindPhone

Boolean

标识是否绑定手机。

name

String

用户姓名。

nameEn

String

用户英文姓名。

numberHA1

String

号码对应的HA1。

alias1

String

用户别名1

paidAccount

String

付费用户机机账号,用于智慧屏登录。

paidPassword

String

付费用户机机密码,用于智慧屏登录。

password

String

机机密码,用于智慧屏登录。

realm

String

本地鉴权。

serviceAccount

String

用户关联的号码,SIP格式。

登录类型不一样获取到的号码也不同,如软终端和硬终端、客户端登录获取的号码不同。 若未关联号码,则该值为空。

spId

String

SP ID。

status

Integer

用户状态。

  • 0:正常;
  • 1:停用。

thirdAccount

String

用户的第三方账号,例如华为账号登录时获取到的union_id。

tr069Account

String

tr069帐号。

ucloginAccount

String

华为云会议帐号。

userId

String

用户UUID。

userType

Integer

用户类型。

  • 1:SP管理用户;
  • 2:企业用户;
  • 3:免费注册用户;
  • 10:企业设备用户;
  • 11:匿名用户;
  • 12:智慧屏用户;
  • 13:IdeaHub用户;
  • 14:电子白板用户;

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": "user01",
    "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": "stbl2oG5GKrcNirGSOVLEAm3dSaOiygp3E1v",
    "clientType": 72,
    "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": "76aaaba8a12f4c0a8a43192ac1fg42ac4",
        "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 'Authorization:Basic dGVzdDp0ZXN0' -d '{"account": "user01","clientType": 72,"createTokenType": 0}' 'https://api.meeting.huaweicloud.com/v1/usg/acs/auth/account'
分享:

    相关文档

    相关产品

close