智慧服务，成就美好体验 项目咨询

主页 > 服务与支持 > 开发平台 > 服务端API参考 > 登录鉴权 > 接口参考 执行鉴权

入门使用

执行鉴权

更新时间：2019-11-19

描述

该接口用来执行鉴权。如果请求消息中包含“是否生成Token”参数，则创建Token并返回。

接口原型

表1 接口原型

请求方法

PUT

请求地址

/rest/usg/sso/v1/auth/account

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

Authorization

是

String

Header

授权令牌。

携带用户帐号信息。使用时需要进行Base64转码操作

样例：Basic Base64(username:password)

account

是

String

Body

用户账号（华为云会议账号）。

样例：zhangsan@huawei

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

clientType

是

Integer

Body

登录客户端类型。

  • 0：Web客户端类型
  • 5：cloudlink pc
  • 6：cloudlink mobile
  • 16：workplace pc

createTokenType

是

Integer

Body

是否生成Token。

  • 0：生成token，用于登录鉴权
  • 1：不生成token

forceLoginInd

否

Integer

Body

抢占登录标识(预留字段)。

  • 0：非抢占
  • 1：抢占；未启用

响应参数

表3 参数说明

参数

类型

描述

returnCode

String

业务返回码。

returnMessage

String

返回描述。

achievementTime

String

响应产生时间。

requestId

String

统一的请求ID。

data

TokenDTO

用户Token信息。
表4 TokenDTO 数据结构

参数

类型

描述

accessToken

String

接入Token字符串。

tokenIp

String

用户IP。

validPeriod

Integer

Token的有效时长，单位：秒。

expireTime

Integer

Token的失效时间戳，单位：秒。

user

UserInfo

用户鉴权信息。

clientType

Integer

登录帐号类型。

  • 0：Web客户端类型
  • 5：cloudlink pc
  • 6：cloudlink mobile
  • 16：workplace pc

forceLoginInd

Integer

抢占登录标识。

  • 0：非抢占
  • 1：抢占（未启用）

firstLogin

Boolean

是否首次登录。

说明：

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

默认值：false。

pwdExpired

Boolean

密码是否过期。

默认值：false。

daysPwdAvailable

Integer

密码有效天数。
表5 UserInfo 数据结构

参数

类型

描述

ucloginAccount

String

用户UC帐号。

serviceAccount

String

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

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

alias1

String

用户别名。

companyId

Int

企业ID。

SP用户登录时为SP ID。

companyDomain

String

企业域名。

realm

String

本地鉴权。

userType

Int

用户类型。

  • 0：系统管理用户；
  • 1：SP管理用户；
  • 2：企业用户；
  • 10：TE终端用户；
  • 11：匿名用户；

adminType

Int

管理员类型。

  • 0：超级管理员；
  • 1：普通管理员；
  • 2：非管理员，即普通企业成员，“userType”为“2”时有效。

name

String

号码短号。

请求消息示例

PUT /rest/usg/sso/v1/auth/account
Connection: keep-alive
Authorization: Basic dXNlcjAxOkh1YXdlaUAxMjM=
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": 0,
    "createTokenType": 0
}
 

响应消息示例

HTTP/1.1 200 
Date: Wed, 27 Mar 2019 03:49:36 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 712
Connection: keep-alive

{
    "returnCode": "000000000",
    "returnMessage": "Success",
    "achievementTime": "2019-03-27 03:48:48.256",
    "requestId": "1f8c3f6750e596d74b0191dd6b49b1dc",
    "data": 
    {
        "accessToken": "HM88JOOjgXPuClBZG9d66NHPawgf5q6eD",
        "tokenIp": "124.160.218.132",
        "validPeriod": 46124,
        "expireTime": 1553704652,
        "user": 
        {
            "userId": "ff8080816933ab4801694865840a00c2",
            "ucloginAccount": "user01",
            "serviceAccount": "sip:+86571100080@huaweicloud.com",
            "numberHA1": "2758cce3d1ed864769694137e6a5bc8a",
            "alias1": null,
            "companyId": "41916",
            "spId": "ff808081691589280169192f359c0029",
            "companyDomain": null,
            "realm": "huaweicloud.com",
            "userType": 2,
            "adminType": 2,
            "name": "user01"
        },
        "clientType": 0,
        "forceLoginInd": null,
        "firstLogin": false,
        "pwdExpired": false,
        "daysPwdAvailable": 68
    }
}
 

CURL命令

curl -k -i -H 'content-type: application/json' -X PUT  -H 'Authorization:Basic dXNlcjAxOkh1YXdlaUAxMjM=' -d '{"account": "user01","clientType": 0,"createTokenType": 0}' 'https://api.meeting.huaweicloud.com/rest/usg/sso/v1/auth/account'