El federationSettings El recurso le permite devolver todos
proveedores de identidad para una configuración de autenticación federada.
Roles necesarios
Debe tener el rol para al menos una organización conectada en la configuración de la federación para llamar a este punto Organization Owner final.
Resource
GET /federationSettings/{FEDERATION-SETTINGS-ID}/identityProviders/
Parámetros de la ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| string | Cadena de dígitos hexadecimales 24única que identifica la configuración de autenticación federada. |
Parámetros de consulta de solicitud
Los siguientes parámetros de consulta son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
número de página | Número | Opcional | Entero basado en uno que devuelve una subsección de resultados. |
|
artículos por página | Número | Opcional | Número de artículos a devolver por página, hasta un máximo de 500. |
|
bonita | booleano | Opcional | Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato. |
|
envolvente | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure Para los endpoints que devuelven una lista de resultados, el objeto |
|
protocolo | string | Opcional | Los protocolos de los proveedores de identidad de destino. Los valores posibles son:
Si esto no se especifica, este punto solo devuelve |
|
Parámetros del cuerpo de la solicitud
Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.
Respuesta
Documento de respuesta
El documento JSON de respuesta incluye una matriz de result objetos, una matriz de link objetos y un recuento del número total de result objetos recuperados.
Nombre | Tipo | Descripción |
|---|---|---|
| arreglo | La matriz incluye un objeto para cada elemento detallado en la |
| arreglo | La matriz incluye uno o más enlaces a subrecursos o recursos relacionados. Las relaciones entre las URLse explican en la Especificación de Enlaces Web. |
| Número | Número entero del número total de elementos en el conjunto de resultados. Puede ser mayor que el número de objetos en la matriz results si todo el conjunto de resultados está paginado. |
results Documento incrustado
Cada documento de la matriz results contiene la configuración de autenticación federada para cada organización conectada.
Nombre | Tipo | Descripción | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| string | URL del servicio de consumidor de aserciones a la que el IdP envía la respuesta SAML. | |||||||||
| arreglo | Lista que contiene los dominios configurados desde los cuales los usuarios pueden iniciar sesión para este IdP. | |||||||||
| arreglo | Lista que contiene las organizaciones desde las cuales los usuarios pueden iniciar sesión para este IdP. | |||||||||
| string | Identificador de la audiencia prevista de la afirmación SAML. | |||||||||
| string | Etiqueta legible por humanos que identifica al IdP. | |||||||||
| 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 de clave pública codificado en PEM del proveedor de identidad.
| |||||||||
| string | Enlace del protocolo de solicitud de autenticación SAML utilizado para enviar la solicitud AuthNRequest. Cloud Manager admite los siguientes valores de enlace:
| |||||||||
| string | Algoritmo utilizado para cifrar la firma del IdP. Cloud Manager admite los siguientes valores de algoritmo 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. El IdP es Inactive hasta que se le asigne al menos un dominio. |
Ejemplo de solicitudSAML
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"
Ejemplo de respuesta SAML
{ "links": [ { "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/identityProviders?pretty=true&pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "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" } ], "totalCount": 1 }
Ejemplo de solicitudOIDC
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?protocol=OIDC"
Ejemplo de respuesta de OIDC
{ "links": [ { "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/identityProviders?pretty=true&pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "associatedDomains": [], "associatedOrgs": [], "audienceClaim": [ "audience" ], "clientId": "clientId", "description": "OIDC IdP response example", "displayName": "OIDC IdP", "groupsClaim": "groups", "id": "32b6e34b3d91647abb20e7b8", "issuerUri": "issuer.com", "oktaIdpId": null, "protocol": "OIDC", "requestedScopes": [ "scopes" ], "userClaim": "sub" } ], "totalCount": 1 }