设置SSO登录配置
描述
该接口用于设置SSO登录的鉴权配置。
调试
您可以在API Explorer中调试该接口。
URI
POST /v1/usg/acs/authorizeconfig
请求参数
|
参数 |
是否必须 |
类型 |
位置 |
描述 |
|---|---|---|---|---|
|
X-Access-Token |
是 |
String |
Header |
授权令牌。获取“执行App ID鉴权”响应的accessToken。 |
|
X-Request-ID |
否 |
String |
Header |
请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 |
|
Accept-Language |
否 |
String |
Header |
语言参数，默认为中文zh-CN，英文为en-US。 |
|
Content-Type |
是 |
String |
Header |
Body的媒体格式。取值:application/json; charset=UTF-8 |
|
enableSSO |
是 |
Boolean |
Body |
是否开启SSO登录。 |
|
domain |
否 |
String |
Body |
企业域名。
说明：
开启SSO登录时必填。 |
|
authorizeUrl |
否 |
String |
Body |
鉴权中心URL。
说明：
开启SSO登录时必填。 |
|
getTokenUrl |
否 |
String |
Body |
获取Token URL。
说明：
开启SSO登录时必填。 |
|
clientId |
否 |
String |
Body |
APPID。
说明：
开启SSO登录时必填。 |
|
clientSecret |
否 |
String |
Body |
APP密钥。
说明：
|
|
scope |
否 |
String |
Body |
授权范围。
|
|
accFieldName |
否 |
String |
Body |
第三方账号的字段名称。
说明：
开启SSO登录时必填。 |
|
getUserInfoUrl |
否 |
String |
Body |
用户信息查询URL。 |
|
oauth2ServerType |
否 |
Integer |
Body |
鉴权类型。
|
|
pcSchemaUrl |
否 |
String |
Body |
拉起PC端终端的schema。 |
|
androidSchemaUrl |
否 |
String |
Body |
拉起安卓端终端的schema。 |
|
iosSchemaUrl |
否 |
String |
Body |
拉起ios端终端的schema。 |
|
thirdName |
否 |
String |
Body |
第三方名称的字段名称。 |
|
thirdEmail |
否 |
String |
Body |
第三方邮箱的字段名称。 |
|
thirdMobile |
否 |
String |
Body |
第三方手机号的字段名称。 |
|
thirdAccessToken |
否 |
String |
Body |
第三方accessToken的字段名称。
说明：
开启SSO登录时必填。 |
|
thirdHeadImgUrl |
否 |
String |
Body |
第三方头像链接的字段名称。 |
状态码
|
HTTP状态码 |
描述 |
|---|---|
|
200 |
操作成功。 |
|
400 |
参数异常 |
|
401 |
未鉴权或鉴权失败。 |
|
403 |
权限受限。 |
|
500 |
服务端异常。 |
响应参数
无
请求消息示例
POST /v1/usg/acs/authorizeconfig
Connection: keep-alive
X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF
Content-Type: application/json
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
{
"enableSSO": true,
"domain": "clouddragon.huawei.com",
"authorizeUrl": "http://127.0.0.1:8444/sns/userinfo",
"getTokenUrl": "http://127.0.0.1:8444/sns/oauth2/access_token",
"clientId": "18bc94a643bd4b93aab3179726120943",
"clientSecret": null,
"scope": null,
"accFieldName": "openid",
"getUserInfoUrl": "http://127.0.0.1:8444/sns/userinfo",
"oauth2ServerType": 0,
"pcSchemaUrl": "http://127.0.0.1:8444/schema/pc",
"androidSchemaUrl": "http://127.0.0.1:8444/schema/android",
"iosSchemaUrl": "http://127.0.0.1:8444/schema/ios",
"thirdName": "openid",
"thirdEmail": null,
"thirdMobile": null,
"thirdAccessToken": "access_token",
"thirdHeadImgUrl": null
}
响应消息示例
HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 28007a3bf4d6478e530b09589582f26s
错误码
当您使用华为云会议服务端API时，如果遇到“MMC”或者“USG”开头的错误码，请参考华为云API错误中心。
CURL命令示例
curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' -d '{"enableSSO": true,"domain": "clouddragon.huawei.com","authorizeUrl": "http://127.0.0.1:8444/sns/userinfo","getTokenUrl": "http://127.0.0.1:8444/sns/oauth2/access_token","clientId": "18bc94a643bd4b93aab3179726120943","clientSecret": null,"scope": null,"accFieldName": "openid","getUserInfoUrl": "http://127.0.0.1:8444/sns/userinfo","oauth2ServerType": 0,"pcSchemaUrl": "http://127.0.0.1:8444/schema/pc","androidSchemaUrl": "http://127.0.0.1:8444/schema/android","iosSchemaUrl": "http://127.0.0.1:8444/schema/ios","thirdName": "openid","thirdEmail": null,"thirdMobile": null,"thirdAccessToken": "access_token","thirdHeadImgUrl": null}'
'https://api.meeting.huaweicloud.com/v1/usg/acs/authorizeconfig'
