Consulta de un proveedor de identidades OpenID Connect
Función
Esta API se proporciona para que el administrador consulte un proveedor de identidad de OpenID Connect.
Se puede invocar a la API utilizando tanto el punto de conexión global como los puntos de conexión específicos de la región. Para los puntos de conexión de IAM, consulte Regiones y puntos de conexión.
URI
GET /v3.0/OS-FEDERATION/identity-providers/{idp_id}/openid-connect-config
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
idp_id |
Sí |
String |
ID de proveedor de identidad. Longitud: 1 a 64 caracteres |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
Content-Type |
Sí |
String |
Rellene application/json;charset=utf8 en este campo. |
X-Auth-Token |
Sí |
String |
Token de acceso emitido a un usuario para acreditar su identidad y sus permisos. Para obtener más información sobre los permisos requeridos por el token, consulte Acciones. |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
object |
Configuraciones de OpenID Connect. |
Parámetro |
Tipo |
Descripción |
---|---|---|
access_mode |
String |
Tipo de acceso. Opciones:
|
idp_url |
String |
URL del proveedor de identidad OpenID Connect. Este campo corresponde al campo iss en el token ID. |
client_id |
String |
ID de un cliente registrado con el proveedor de identidad de OpenID Connect. |
authorization_endpoint |
String |
Punto de conexión de autorización del proveedor de identidad de OpenID Connect. Este campo sólo es necesario si el tipo de acceso está establecido en acceso programático y acceso a la consola de gestión. |
scope |
String |
Ámbitos de las solicitudes de autorización. Este campo sólo es necesario si el tipo de acceso está establecido en acceso programático y acceso a la consola de gestión. Valores enumerados:
NOTA:
Ejemplo: openid, openid email, openid profile y openid email profile. |
response_type |
String |
Tipo de respuesta. Este campo sólo es necesario si el tipo de acceso está establecido en acceso programático y acceso a la consola de gestión. Valor enumerado:
|
response_mode |
String |
Modo de respuesta. Este campo sólo es necesario si el tipo de acceso está establecido en acceso programático y acceso a la consola de gestión. Valores enumerados:
|
signing_key |
String |
Clave pública utilizada para firmar el token de ID del proveedor de identidad OpenID Connect. |
Ejemplo de solicitud
Solicitud de consulta de un proveedor de identidad OpenID Connect
GET https://{address}/v3.0/OS-FEDERATION/identity-providers/{idp_id}/openid-connect-config
Ejemplo de respuesta
Código de estado: 200
La solicitud se ha realizado correctamente.
{ "openid_connect_config" : { "access_mode" : "program_console", "idp_url" : "https://accounts.example.com", "client_id" : "client_id_example", "authorization_endpoint" : "https://accounts.example.com/o/oauth2/v2/auth", "scope" : "openid", "response_type" : "id_token", "response_mode" : "form_post", "signing_key" : "{\"keys\":[{\"kty\":\"RSA\",\"e\":\"AQAB\",\"use\":\"sig\",\"n\":\"example\",\"kid\":\"kid_example\",\"alg\":\"RS256\"}]}" } }
Código de estado: 400
Parámetros no válidos.
{ "error_msg" : "Request body is invalid.", "error_code" : "IAM.0011" }
Código de estado: 401
Error de autenticación.
{ "error_msg" : "Request parameter %(key)s is invalid.", "error_code" : "IAM.0007" }
Código de estado: 403
Acceso denegado.
{ "error_msg" : "Policy doesn't allow %(actions)s to be performed.", "error_code" : "IAM.0003" }
Código de estado: 404
No se puede encontrar el recurso solicitado.
{ "error_msg" : "Could not find %(target)s: %(target_id)s.", "error_code" : "IAM.0004" }
Código de estado: 500
Error interno del sistema.
{ "error_msg" : "An unexpected error prevented the server from fulfilling your request.", "error_code" : "IAM.0006" }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
La solicitud se ha realizado correctamente. |
400 |
Parámetros no válidos. |
401 |
Error de autenticación. |
403 |
Acceso denegado. |
404 |
No se puede encontrar el recurso solicitado. |
500 |
Error interno del sistema. |
Códigos de error
Para obtener más información, consulte Códigos de error.