El federationSettings El recurso le permite devolver el
Configuración de autenticación federada para una organización.
URL base: https://cloud.mongodb.com/api/public/v1.0
Roles necesarios
Debe tener el rol para llamar a este punto Organization Owner final.
Resource
GET /orgs/{ORG-ID}/federationSettings
Parámetros de la ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| string | Cadena de dígitos hexadecimales 24única que identifica a la organización. |
Parámetros de consulta de solicitud
Los siguientes parámetros de consulta son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
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 envelope=true en la consulta. Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo de la solicitud
Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.
Respuesta
Nombre | Tipo | Descripción |
|---|---|---|
| matriz de cadenas | Lista que contiene los dominios asociados con el proveedor de identidad de la organización. |
| booleano | Indicador que indica si esta organización tiene la asignación de roles configurada. Para obtener más información sobre la asignación de roles, consulte Administrar la asignación de roles de Cloud Manager a grupos de IdP. |
| string | string única de 24 dígitos hexadecimales que identifica esta federación. |
| string | Cadena de dígitos hexadecimales 20única que identifica al proveedor de identidad conectado a esta organización. |
| string | Valor que indica si el proveedor de identidad está activo. Cloud Manager devuelve |
Ejemplo de solicitud
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/orgs/{ORG-ID}/federationSettings"
Ejemplo de respuesta
{ "federatedDomains": [ "example.com" ], "hasRoleMappings": false, "id": "5e8cc670a16506712e0b1e95", "identityProviderId": "0oa8i0grsgbwDiIyw453", "identityProviderStatus": "INACTIVE" }