/ /

Autenticación federada

Docs Home

/ /

Recursos

Autenticación federada

Autenticación federada

Actualizar una organización conectada

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 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 Organization Owner para llamar a este endpoint.

Resource

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

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

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonito

booleano

Opcional

Indicador que señala si el cuerpo de respuesta debe estar en un prettyprint formato.

false

envelope

booleano

Opcional

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

Algunos Los clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar este problema, configure 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

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 se da un campo `domainAllowList` en la solicitud, el arreglo que proporcionas reemplaza la `domainAllowList` actual.
`domainRestrictionEnabled`	booleano	Requerido	Indicador que señala si la restricción de dominio está habilitada para la organización conectada.
`identityProviderId`	string	Requerido	string única de 20 dígitos hexadecimales que identifica al proveedor de identidad asociado con la organización conectada. Si se omite o si el valor es `null`, MongoDB nube desconecta la organización especificada por `orgId` del proveedor de identidad.
`orgId`	string	Requerido	string única de 24 dígitos hexadecimales que identifica a la organización conectada.
`postAuthRoleGrants`	arreglo	Opcional	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. Si se da un campo `postAuthRoleGrants` en la solicitud, el arreglo que proporcionas reemplaza la `postAuthRoleGrants` actual.
`roleMappings`	arreglo	Opcional	Lista que contiene las asignaciones de roles configuradas en esta organización. Si se da un campo `roleMappings` en la solicitud, el arreglo que proporcionas reemplaza la `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	Indicador que señala si la restricción de dominio está habilitada para la organización conectada. `userConflicts` devuelve `null` cuando `"domainRestrictionEnabled": false`.
`identityProviderId`	string	string ú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 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"
               }
             ]
           }
         ]
       }'

Respuesta de ejemplo

{
  "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

Return Organización

Remover organización