Docs Home

/ /

Autenticación federada

Docs Home

/ /

Recursos

Autenticación federada

Autenticación federada

Devuelve la Configuración de Federación para una Organización

El recurso federationSettings permite retornar la configuración de autenticación federada de una organización.

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

Roles necesarios

Debe tener el rol Organization Owner para llamar a este endpoint.

Resource

GET /orgs/{ORG-ID}/federationSettings

Parámetros de ruta de solicitud

Nombre	Tipo	Descripción
`ORG-ID`	string	string única de 24 dígitos hexadecimales que identifica a la organización.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonito

booleano

Opcional

Indicador que muestra si el cuerpo de la respuesta debe estar en formato prettyprint.

false

envelope

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query.

Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuesta HTTP
`content`	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Nombre	Tipo	Descripción
`federatedDomains`	Arreglo de cadenas	Lista que contiene los dominios asociados con el proveedor de identidad de la organización.
`hasRoleMappings`	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 Gestión de la asignación de roles de Cloud Manager a grupos de IdP.
`id`	string	string única de 24 dígitos hexadecimales que identifica esta federación.
`identityProviderId`	string	string única de 20 dígitos hexadecimales que identifica al proveedor de identidad conectado a esta organización.
`identityProviderStatus`	string	Valor que indica si el proveedor de identidad está activo. Cloud Manager devuelve `ACTIVE` si el proveedor de identidad está activo y `INACTIVE` si el proveedor de identidad está inactivo.

Solicitud de ejemplo

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"

Respuesta de ejemplo

{
  "federatedDomains": [
    "example.com"
  ],
  "hasRoleMappings": false,
  "id": "5e8cc670a16506712e0b1e95",
  "identityProviderId": "0oa8i0grsgbwDiIyw453",
  "identityProviderStatus": "INACTIVE"
}

Volver

Autenticación federada

Devolver todas las organizaciones