/ /

Autenticación federada

Docs Home

/ /

Recursos

Autenticación federada

Autenticación federada

Actualizar una organización conectada

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 actualizar uno organización conectada 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 llamar a este punto Organization Owner final.

Resource

PATCH /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/

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.
`ORG-ID`	string	Cadena de dígitos hexadecimales 24única que identifica la organización conectada.

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.

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 puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:

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

false

Parámetros del cuerpo de la solicitud

Nombre	Tipo	Necesidad	Descripción
`domainAllowList`	arreglo	Opcional	Lista que contiene los dominios aprobados desde los cuales los usuarios de la organización pueden iniciar sesión. Si proporciona un campo `domainAllowList` en la solicitud, la matriz que proporcione reemplaza el `domainAllowList` actual.
`domainRestrictionEnabled`	booleano	Requerido	Bandera que indica si la restricción de dominio está habilitada para la organización conectada.
`identityProviderId`	string	Requerido	Cadena de dígitos hexadecimales 20única que identifica al proveedor de identidad asociado con la organización conectada. Si se omite o si el valor `null` es, MongoDB Cloud desconecta la organización especificada por `orgId` del IdP.
`orgId`	string	Requerido	Cadena de dígitos hexadecimales 24única que identifica la organización conectada.
`postAuthRoleGrants`	arreglo	Opcional	Lista que contiene los roles predeterminados otorgados a los usuarios que se autentican a través del IdP en una organización conectada. Si proporciona un campo `postAuthRoleGrants` en la solicitud, la matriz que proporcione reemplaza el `postAuthRoleGrants` actual.
`roleMappings`	arreglo	Opcional	Lista que contiene las asignaciones de roles configuradas en esta organización. Si proporciona un campo `roleMappings` en la solicitud, la matriz que proporcione reemplaza el `roleMappings` actual.

Respuesta

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 PATCH "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}" \
     --data '
       {
         "domainRestrictionEnabled": false,
         "identityProviderId": "0oa7i0grsgbwJiIyw357",
         "orgId": "5df7a168f10fab3a149357fb",
         "roleMappings": [
           {
             "externalGroupName": "example",
             "id": "61e89721b827b56c845ff44c",
             "roleAssignments": [
               {
                 "groupId": null,
                 "orgId": "5df7a168f10fab3a149357fb",
                 "role": "ORG_OWNER"
               }
             ]
           }
         ]
       }'

Ejemplo de respuesta

{
  "domainAllowList": [],
  "domainRestrictionEnabled": false,
  "identityProviderId": "0oa7i0grsgbwJiIyw357",
  "orgId": "5df7a168f10fab3a149357fb",
  "postAuthRoleGrants": [
    "ORG_OWNER"
  ],
  "roleMappings": [
    {
      "externalGroupName": "example",
      "id": "61e89721b827b56c845ff44c",
      "roleAssignments": [
        {
          "groupId": null,
          "orgId": "5df7a168f10fab3a149357fb",
          "role": "ORG_OWNER"
        }
      ]
    }
  ],
  "userConflicts": null
}

Volver

Organización de retorno

Eliminar organización