/ /

Autenticación federada

Docs Home

/ /

Recursos

Autenticación federada

Autenticación federada

Devolver todas las organizaciones conectadas

Cloud Manager dejará de ofrecer compatibilidad con automatización, copias de seguridad y monitorización para MongoDB 3.6 y 4.0 a partir del 30de agosto de 2024. Por favor, Actualice su implementación de MongoDB o migre a Atlas.

El federationSettings El recurso le permite devolver todos organizaciones conectadas para una configuración de autenticación federada.

URL base: https://cloud.mongodb.com/api/public/v1.0

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}/connectedOrgConfigs/

Parámetros de la ruta de solicitud

Nombre	Tipo	Descripción
`FEDERATION-SETTINGS-ID`	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.	`1`
artículos por página	Número	Opcional	Número de artículos a devolver por página, hasta un máximo de 500.	`100`
bonita	booleano	Opcional	Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato.	`false`
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 `envelope : true` en la consulta. Para los endpoints que devuelven una lista de resultados, el objeto `content` es un sobre. Cloud Manager añade el campo `status` al cuerpo de la respuesta.	`false`
trabajos de respaldo habilitados solamente	booleano	Opcional	Indicador que indica si se deben excluir de la respuesta los daemons no habilitados para realizar copias de seguridad de bases de datos. Establezca este valor en `false` para incluir las configuraciones de daemon con el indicador `backupJobsEnabled` establecido en `false`.	`true`

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 objetos de resultado, una matriz de objetos de enlace y un recuento de la cantidad total de objetos de resultado recuperados.

Nombre	Tipo	Descripción
resultados	matriz de objetos	Un objeto por cada elemento detallado en la sección de resultados del Documento incrustado.
enlaces	matriz de objetos	Uno o más enlaces a subrecursos o recursos relacionados. Todas las `links` matrices en las respuestas incluyen al menos un enlace `self` llamado. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.
recuento total	entero	Recuento del número total de elementos en el conjunto de resultados. Puede ser mayor que el número de objetos en la matriz de resultados si todo el conjunto de resultados está paginado.

Resultados Documento incrustado

Cada documento de la matriz result contiene la configuración de autenticación federada para cada organización conectada.

Nombre	Tipo	Descripción
`domainAllowList`	arreglo	Lista que contiene los dominios aprobados desde los cuales los usuarios de la organización pueden iniciar sesión.
`domainRestrictionEnabled`	booleano	Bandera que indica si la restricción de dominio está habilitada para la organización conectada. `userConflicts` devuelve `null` cuando `"domainRestrictionEnabled": false`.
`identityProviderId`	string	Cadena de dígitos hexadecimales 20única que identifica al proveedor de identidad asociado con la organización conectada.
`orgId`	string	Cadena de dígitos hexadecimales 24única que identifica la organización conectada.
`postAuthRoleGrants`	arreglo	Lista que contiene los roles predeterminados otorgados a los usuarios que se autentican a través del IdP en una organización conectada.
`roleMappings`	arreglo	Lista que contiene las asignaciones de roles configuradas en esta organización.
`userConflicts`	arreglo	Lista que contiene los nombres de usuario que no coinciden con ningún dominio de la lista permitida. `userConflicts` devuelve `null` cuando `"domainRestrictionEnabled": false`.

Ejemplo de solicitud

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs"

Ejemplo de respuesta

{
 "links": [
     {
         "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs?pageNum=1&itemsPerPage=100",
         "rel": "self"
     }
 ],
 "results": [
     {
         "domainAllowList": [],
         "domainRestrictionEnabled": false,
         "identityProviderId": null,
         "orgId": "5f86fb11e0079069c9ec3132",
         "postAuthRoleGrants": [],
         "roleMappings": [],
         "userConflicts": null
     }
 ],
 "totalCount": 1
}

Volver

Configuración de retorno

Organización de retorno