Configuração de logon único (SSO)
Descrição
Esta API é usada para configurar a autenticação SSO.
Depuração
Você pode depurar essa API no API Explorer.
Protótipo
Método de solicitação |
POST |
---|---|
Endereço de solicitação |
/v1/usg/acs/authorizeconfig |
Protocolo de transporte |
HTTPS |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Localização |
Descrição |
---|---|---|---|---|
X-Access-Token |
Sim |
String |
Cabeçalho |
Token de autorização. Use o valor de accessToken na resposta à solicitação de Autenticação de um ID de aplicação. |
X-Request-ID |
Não |
String |
Cabeçalho |
ID da solicitação, que é usado para rastreamento e localização de falhas. É aconselhável usar um UUID. Se este parâmetro não for transportado, um ID de solicitação é gerado automaticamente. |
Accept-Language |
Não |
String |
Cabeçalho |
Idioma. Valores: zh-CN para chinês (padrão) e en-US para inglês. |
Content-Type |
Sim |
String |
Cabeçalho |
Formato de mídia do corpo. Valor: application/json ou charset=UTF-8 |
enableSSO |
Sim |
Boolean |
Corpo |
Se o SSO está ativado. |
domain |
Não |
String |
Corpo |
Nome de domínio empresarial.
NOTA:
Esse parâmetro é obrigatório quando o SSO está ativado. |
authorizeUrl |
Não |
String |
Corpo |
URL do centro de autorização.
NOTA:
Esse parâmetro é obrigatório quando o SSO está ativado. |
getTokenUrl |
Não |
String |
Corpo |
URL para obter um token.
NOTA:
Esse parâmetro é obrigatório quando o SSO está ativado. |
clientId |
Não |
String |
Corpo |
ID de aplicação.
NOTA:
Esse parâmetro é obrigatório quando o SSO está ativado. |
clientSecret |
Não |
String |
Corpo |
appKey.
NOTA:
Quando o SSO estiver ativado, se a appKey não precisar ser alterada, deixe esse parâmetro vazio. |
scope |
Não |
String |
Corpo |
Escopo de autorização. O valor de OIDC para OAuth2.0 é openid. |
accFieldName |
Não |
String |
Corpo |
Campo de conta no sistema de terceiros.
NOTA:
Esse parâmetro é obrigatório quando o SSO está ativado. |
getUserInfoUrl |
Não |
String |
Corpo |
URL para consultar detalhes do usuário. |
oauth2ServerType |
Não |
Integer |
Corpo |
Modo de autenticação. Defina-o como 0 para autenticação OAuth 2.0. |
pcSchemaUrl |
Não |
String |
Corpo |
Esquema de iniciar o cliente de PC. |
androidSchemaUrl |
Não |
String |
Corpo |
Esquema de iniciar a aplicação de Android. |
iosSchemaUrl |
Não |
String |
Corpo |
Esquema de iniciar a aplicação de iOS. |
thirdName |
Não |
String |
Corpo |
Campo de nome no sistema de terceiros. |
thirdEmail |
Não |
String |
Corpo |
Campo de endereço de e-mail no sistema de terceiros. |
thirdMobile |
Não |
String |
Corpo |
Campo de número de celular no sistema de terceiros. |
thirdAccessToken |
Não |
String |
Corpo |
Campo de token de acesso no sistema de terceiros.
NOTA:
Esse parâmetro é obrigatório quando o SSO está ativado. |
thirdHeadImgUrl |
Não |
String |
Corpo |
Campo de imagem de perfil no sistema de terceiros. |
Códigos de status
Código de status HTTP |
Descrição |
---|---|
200 |
Operação bem-sucedida. |
400 |
Parâmetros inválidos. |
401 |
A autenticação não é executada ou falha. |
403 |
Permissões insuficientes. |
500 |
Exceção do servidor. |
Parâmetros de resposta
Nenhum
Exemplo de solicitação
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 }
Exemplo de resposta
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
Códigos de erro
Se um código de erro começando com MMC ou USG for retornado quando você usar essa API, corrija a falha seguindo as instruções fornecidas no Centro de erros da API da Huawei Cloud.
Exemplo de comando 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'