La federationSettings el recurso te permite devolver todos los
proveedores 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/
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. |
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
Num. de pág. | Número | Opcional | Entero basado en uno que devuelve una subsección de resultados. |
|
elementosPorPágina | Número | Opcional | Número de elementos a devolver por página, hasta un máximo de 500. |
|
bonito | booleano | Opcional | Indicador que señala si el cuerpo de la 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 Los clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para remediarlo, establezca Para los endpoints que devuelven una lista de resultados, el objeto |
|
protocolo | string | Opcional | El (los) protocolo(s) de los IdPs de destino. Los valores posibles son:
Si este parámetro no se especifica, este punto final solo devuelve |
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
Documento de respuesta
El documento de respuesta JSON incluye un arreglo de result objetos, un arreglo de link objetos y una cantidad del número total de result objetos recuperados.
Nombre | Tipo | Descripción |
|---|---|---|
| arreglo | El arreglo incluye un objeto para cada elemento detallado en la sección del |
| arreglo | El arreglo incluye uno o más enlaces a subrecursos y/o recursos relacionados. Las relaciones entre URLse explican en la Especificación de enlace web. |
| Número | Recuento entero del número total de elementos en el conjunto de resultados. Puede ser superior al número de objetos en el arreglo results si el conjunto de resultados completo está paginado. |
results embeddedDocument
Cada documento en el arreglo results contiene la configuración de autenticación federada para cada organización conectada.
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. El proveedor de identidad está Inactive hasta que se asigne al menos un dominio al proveedor de identidad. |
ejemplo SAML Request
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 SAML Response
{ "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 OIDC Request
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 OIDC Response
{ "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 }