Help Center/ Meeting/ Server API Reference/ Login Authentication/ APIs/ Querying the SSO Configuration
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the SSO Configuration

Description

This API is used to query the SSO login settings.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

GET

Request Address

/v1/usg/acs/authorizeconfig

Transport Protocol

HTTPS

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Location

Description

X-Access-Token

Yes

String

Header

Authorization token. Use the value of accessToken in the response to the request for Authenticating an App ID.

X-Request-Id

No

String

Header

Request ID, which is used for fault tracing and locating. You are advised to use a UUID. If this parameter is not carried, a request ID is automatically generated.

Accept-Language

No

String

Header

Language. Values: zh-CN for Chinese (default) and en-US for English.

Status Codes

Table 3 Status codes

HTTP Status Code

Description

200

Operation successful.

400

Invalid parameters.

401

Authentication is not performed or fails.

403

Insufficient permissions.

500

Server exception.

Response Parameters

Table 4 Response Parameters

Parameter

Type

Description

enableSSO

Boolean

Whether SSO is enabled.

domain

String

Enterprise domain name.

authorizeUrl

String

Authorization center URL.

getTokenUrl

String

URL for obtaining a token.

clientId

String

App ID.

clientSecret

String

appKey.

scope

String

Authorization scope.

  • openid: OIDC of OAuth 2.0.

accFieldName

String

Account field in the third-party system.

getUserInfoUrl

String

URL for querying user details.

oauth2ServerType

Integer

Authentication mode.

  • 0: OAuth 2.0 authentication.

pcSchemaUrl

String

Schema of starting the PC client.

androidSchemaUrl

String

Schema of starting the Android app.

iosSchemaUrl

String

Schema of starting the iOS app.

thirdName

String

Name field in the third-party system.

thirdEmail

String

Email address field in the third-party system.

thirdMobile

String

Mobile number field in the third-party system.

thirdAccessToken

String

Access token field in the third-party system.

thirdHeadImgUrl

String

Profile picture field in the third-party system.

Example Request

GET /v1/usg/acs/authorizeconfig
Connection: keep-alive
X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9
Host: api.meeting.huaweicloud.com 
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

Example Response

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: 551aeb8cafbbaa7bbbdc7b1c76bba8ac

{
    "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
}

Error Codes

If an error code starting with MMC or USG is returned when you use this API, rectify the fault by following the instructions provided in Huawei Cloud API Error Center.

Example cURL Command

curl -k -i -X GET -H 'X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9' https://api.meeting.huaweicloud.com/v1/usg/acs/authorizeconfig
Parent topic: APIs