Configuración de inicio de sesión único (SSO)
Descripción
Esta API se utiliza para configurar la autenticación SSO.
Depuración
Puede depurar esta API en API Explorer.
Prototipo
Método de solicitud |
POST |
|---|---|
Dirección de solicitud |
/v1/usg/acs/authorizeconfig |
Protocolo de transporte |
HTTPS |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Localización |
Descripción |
|---|---|---|---|---|
X-Access-Token |
Sí |
String |
Header |
Token de autorización. Utilice el valor de accessToken en la respuesta a la solicitud de Autenticación de un ID de aplicación. |
X-Request-ID |
No |
String |
Header |
ID de solicitud, que se utiliza para el seguimiento y la localización de fallos. Se recomienda utilizar una UUID. Si este parámetro no se incluye, se genera automáticamente una ID de solicitud. |
Accept-Language |
No |
String |
Header |
Idioma. Valores: zh-CN para chino (predeterminado) y en-US para inglés. |
Content-Type |
Sí |
String |
Header |
Formato de los medios de comunicación del cuerpo. Valor: application/json o charset=UTF-8 |
enableSSO |
Sí |
Boolean |
Body |
Si el inicio de sesión único está habilitado. |
domain |
No |
String |
Body |
Nombre de dominio de empresa.
NOTA:
Este parámetro es obligatorio cuando el inicio de sesión único está habilitado. |
authorizeUrl |
No |
String |
Body |
URL del centro de autorización.
NOTA:
Este parámetro es obligatorio cuando el inicio de sesión único está habilitado. |
getTokenUrl |
No |
String |
Body |
URL para obtener un token.
NOTA:
Este parámetro es obligatorio cuando el inicio de sesión único está habilitado. |
clientId |
No |
String |
Body |
ID de aplicación.
NOTA:
Este parámetro es obligatorio cuando el inicio de sesión único está habilitado. |
clientSecret |
No |
String |
Body |
appKey.
NOTA:
Cuando el inicio de sesión único está habilitado, si no es necesario cambiar la appKey, deje este parámetro vacío. |
scope |
No |
String |
Body |
Ámbito de autorización. El valor de OIDC para OAuth2.0 es openid. |
accFieldName |
No |
String |
Body |
Campo de cuenta en el sistema de terceros.
NOTA:
Este parámetro es obligatorio cuando el inicio de sesión único está habilitado. |
getUserInfoUrl |
No |
String |
Body |
URL para consultar los detalles del usuario. |
oauth2ServerType |
No |
Integer |
Body |
Modo de autenticación. Establezca el valor 0 para la autenticación OAuth 2.0. |
pcSchemaUrl |
No |
String |
Body |
Esquema de inicio del cliente de PC. |
androidSchemaUrl |
No |
String |
Body |
Esquema de inicio de la aplicación Android. |
iosSchemaUrl |
No |
String |
Body |
Esquema de inicio de la aplicación iOS. |
thirdName |
No |
String |
Body |
Campo de Nombre en el sistema de terceros. |
thirdEmail |
No |
String |
Body |
Campo de dirección de correo electrónico en el sistema de terceros. |
thirdMobile |
No |
String |
Body |
Campo de número de móvil en el sistema de terceros. |
thirdAccessToken |
No |
String |
Body |
Campo de token de acceso en el sistema de terceros.
NOTA:
Este parámetro es obligatorio cuando el inicio de sesión único está habilitado. |
thirdHeadImgUrl |
No |
String |
Body |
Campo de imagen de perfil en el sistema de terceros. |
Códigos de estado
Código de estado de HTTP |
Descripción |
|---|---|
200 |
Operación exitosa. |
400 |
Parámetros no válidos. |
401 |
La autenticación no se realiza o falla. |
403 |
Permisos insuficientes. |
500 |
Excepción del servidor. |
Parámetros de respuesta
Ninguno
Ejemplo de solicitud
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
}
Ejemplo de respuesta
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 error
Si se devuelve un código de error que comienza con MMC o USG cuando utiliza esta API, corrija el error siguiendo las instrucciones proporcionadas en Centro de errores de la API de Huawei Cloud.
Ejemplo 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'
