/ /

Autenticación federada

Docs Home

/ /

Recursos

Autenticación federada

Autenticación federada

Retornar Todas las Organizaciones Conectadas

Cloud Manager dejará de admitir la Automatización, la Copia de seguridad y la Supervisión para MongoDB 3.6 y 4.0 después del 30de agosto de 2024. Por favor actualiza tu implementación de MongoDB o migra a Atlas.

La federationSettings el recurso te permite devolver todos los 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	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.	`1`
elementosPorPágina	Número	Opcional	Número de elementos a devolver por página, hasta un máximo de 500.	`100`
bonito	booleano	Opcional	Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato.	`false`
envelope	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`
backupJobsEnabledOnly	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 endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Documento de respuesta

El documento de respuesta JSON incluye un arreglo de objetos result, un arreglo de objetos link y el recuento del número total de objetos result recuperados.

Nombre	Tipo	Descripción
Resultados	Arreglo de objetos	Un objeto para cada elemento detallado en la sección documento incrustado.
enlaces	Arreglo de objetos	Uno o más enlaces a subrecursos y/o recursos relacionados. Todos los `links` arreglos en las respuestas incluyen al menos un enlace llamado `self`. Las relaciones entre URLs se explican en la Especificación de Enlaces Web.
recuento total	entero	Conteo del número total de elementos en el conjunto de resultados. Puede ser superior al número de objetos en el arreglo de resultados si todo el conjunto de resultados está paginado.

resultados Documento incrustado

Cada documento en el arreglo 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 única de 20 dígitos hexadecimales que identifica al proveedor de identidad asociado con la organización conectada.
`orgId`	string	string única de 24 dígitos hexadecimales que identifica a la organización conectada.
`postAuthRoleGrants`	arreglo	Lista que contiene los roles por defecto concedidos a los usuarios que se autentican a través del proveedor de identidad 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`.

Solicitud de ejemplo

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"

Respuesta de ejemplo

{
 "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 devolución

Return Organización