主頁(yè) > 服務(wù)與支持 > 開(kāi)發(fā)平臺(tái) > 服務(wù)端API參考 > 登錄鑒權(quán) > 接口參考 執(zhí)行鑒權(quán)
更新時(shí)間:2019-11-19
該接口用來(lái)執(zhí)行鑒權(quán)。如果請(qǐng)求消息中包含“是否生成Token”參數(shù),則創(chuàng)建Token并返回。
請(qǐng)求方法 |
PUT |
---|---|
請(qǐng)求地址 |
/rest/usg/sso/v1/auth/account |
傳輸協(xié)議 |
HTTPS |
參數(shù) |
是否必須 |
類(lèi)型 |
位置 |
描述 |
---|---|---|---|---|
Authorization |
是 |
String |
Header |
授權(quán)令牌。 攜帶用戶帳號(hào)信息。使用時(shí)需要進(jìn)行Base64轉(zhuǎn)碼操作 樣例:Basic Base64(username:password) |
account |
是 |
String |
Body |
用戶賬號(hào)(華為云會(huì)議賬號(hào))。 樣例:zhangsan@huawei 業(yè)務(wù)賬號(hào)請(qǐng)?zhí)崆吧暾?qǐng),具體申請(qǐng)方法請(qǐng)參見(jiàn)開(kāi)發(fā)流程。 |
clientType |
是 |
Integer |
Body |
登錄客戶端類(lèi)型。
|
createTokenType |
是 |
Integer |
Body |
是否生成Token。
|
forceLoginInd |
否 |
Integer |
Body |
搶占登錄標(biāo)識(shí)(預(yù)留字段)。
|
參數(shù) |
類(lèi)型 |
描述 |
---|---|---|
returnCode |
String |
業(yè)務(wù)返回碼。 |
returnMessage |
String |
返回描述。 |
achievementTime |
String |
響應(yīng)產(chǎn)生時(shí)間。 |
requestId |
String |
統(tǒng)一的請(qǐng)求ID。 |
data |
用戶Token信息。 |
參數(shù) |
類(lèi)型 |
描述 |
---|---|---|
accessToken |
String |
接入Token字符串。 |
tokenIp |
String |
用戶IP。 |
validPeriod |
Integer |
Token的有效時(shí)長(zhǎng),單位:秒。 |
expireTime |
Integer |
Token的失效時(shí)間戳,單位:秒。 |
user |
用戶鑒權(quán)信息。 |
|
clientType |
Integer |
登錄帳號(hào)類(lèi)型。
|
forceLoginInd |
Integer |
搶占登錄標(biāo)識(shí)。
|
firstLogin |
Boolean |
是否首次登錄。
說(shuō)明:
首次登錄表示尚未修改過(guò)密碼。首次登錄時(shí),系統(tǒng)會(huì)提醒用戶需要修改密碼。 默認(rèn)值:false。 |
pwdExpired |
Boolean |
密碼是否過(guò)期。 默認(rèn)值:false。 |
daysPwdAvailable |
Integer |
密碼有效天數(shù)。 |
參數(shù) |
類(lèi)型 |
描述 |
---|---|---|
ucloginAccount |
String |
用戶UC帳號(hào)。 |
serviceAccount |
String |
用戶關(guān)聯(lián)的號(hào)碼,SIP格式。 登錄類(lèi)型不一樣獲取到的號(hào)碼也不同,如軟終端和硬終端客戶端登錄獲取的號(hào)碼不同。 若未關(guān)聯(lián)號(hào)碼,則該值為空。 |
alias1 |
String |
用戶別名。 |
companyId |
Int |
企業(yè)ID。 SP用戶登錄時(shí)為SP ID。 |
companyDomain |
String |
企業(yè)域名。 |
realm |
String |
本地鑒權(quán)。 |
userType |
Int |
用戶類(lèi)型。
|
adminType |
Int |
管理員類(lèi)型。
|
name |
String |
號(hào)碼短號(hào)。 |
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 -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'