La federationSettings el recurso te permite devolver uno
proveedor de identidad para una configuración de autenticación federada.
Roles necesarios
Debe tener el rol Organization Owner para al menos una organización conectada en la configuración de la federación para poder llamar a este endpoint.
Resource
GET /federationSettings/{FEDERATION-SETTINGS-ID}/identityProviders/{IDP-ID}
Parámetros de ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| string | string única de 24 dígitos hexadecimales que identifica la configuración de autenticación federada. |
| string | Unique 20-hexadecimal digit string that identifica el proveedor de identidad. |
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
bonito | booleano | Opcional | Indicador que señala si el cuerpo de respuesta debe estar en un prettyprint formato. |
| ||||||
envelope | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
Nombre | Tipo | Descripción | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| string | URL del servicio consumidor de aserciones al que el proveedor de identidad envía la respuesta SAML. | |||||||||
| arreglo | Lista que contiene los dominios configurados desde los cuales los usuarios pueden iniciar sesión en este proveedor de identidad. | |||||||||
| arreglo | Lista que contiene las organizaciones desde las cuales los usuarios pueden iniciar sesión para este proveedor de identidad. | |||||||||
| string | Identificador para la audiencia prevista de la Afirmación SAML. | |||||||||
| string | Etiqueta legible por humanos que identifica al proveedor de identidad. | |||||||||
| string | Identificador del emisor de la aserción SAML. | |||||||||
| string | Cadena única de 20 dígitos hexadecimales que identifica al proveedor de identidad. | |||||||||
| arreglo | Lista que contiene la información del archivo, incluyendo: fecha de inicio y fecha de vencimiento del certificado PEMcodificado de llave pública del proveedor de identidad.
| |||||||||
| string | SAML Protocolo de vinculación de solicitud de autenticación utilizado para enviar AuthNRequest. Cloud Manager admite los siguientes valores de enlace:
| |||||||||
| string | Algoritmo utilizado para cifrar la firma del proveedor de identidad. Cloud Manager admite los siguientes valores de algoritmos de firma:
| |||||||||
| booleano | Indicador que muestra si el proveedor de identidad tiene la depuración de SSO habilitada. | |||||||||
| string | URL del receptor de la SAML AuthNRequest. | |||||||||
| string | Etiqueta que indica si el proveedor de identidad está activo. The proveedor de identidad is Inactive hasta que asocies al menos un dominio al proveedor de identidad. |
Solicitud de ejemplo
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/identityProviders/{IDP-ID}"
Respuesta de ejemplo
{ "acsUrl" : "https://example.mongodb.com/sso/saml2/12345678901234567890", "associatedDomains" : [ ], "associatedOrgs" : [ ], "audienceUri" : "https://www.example.com/saml2/service-provider/abcdefghij1234567890", "displayName" : "Test", "issuerUri" : "urn:123456789000.us.provider.com", "oktaIdpId" : "1234567890abcdefghij", "pemFileInfo" : { "certificates" : [ { "notAfter" : "2035-09-29T15:03:55Z", "notBefore" : "2022-01-20T15:03:55Z" } ], "fileName" : "file.pem" }, "requestBinding" : "HTTP-POST", "responseSignatureAlgorithm" : "SHA-256", "ssoDebugEnabled" : true, "ssoUrl" : "https://123456789000.us.provider.com/samlp/12345678901234567890123456789012", "status" : "INACTIVE" }