Actualiza una configuración de organización conectada desde la federación especificada.
El subcomando atlas api se genera automáticamente desde la API de administración de MongoDB Atlas y ofrece cobertura completa de dicha API. Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puede consultar a través del enlace de documentación del punto final de la API.
Para utilizar este recurso, la cuenta de servicio o la clave API solicitante debe tener el rol de propietario de la organización.
Nota: Si la configuración de la organización no tiene un proveedor de identidad asociado, no podrá usar este recurso para actualizar asignaciones de roles ni para publicar concesiones de roles de autorización.
Nota: El campo domainRestrictionEnabled tiene como valor predeterminado falso si no se proporciona en la solicitud.
Nota: Si no se proporciona el campo identityProviderId, desconectará la organización y el proveedor de identidad.
Nota: Los proveedores de identidad de acceso a datos conectados actualmente que no estén en el campo dataAccessIdentityProviderIds se desconectarán.
Este comando se genera automáticamente y corresponde 1:1 con el punto final de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-updatefederationsettingconnectedorgconfig.
Para obtener más información y ejemplos, consulte la documentación de la API referenciada en el enlace anterior.
Sintaxis
atlas api federatedAuthentication updateConnectedOrgConfig [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--sobre | envolvente | false | Indicador que indica si la aplicación envuelve la respuesta en un objeto JSON tipo sobre. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como sobre. La aplicación añade el parámetro de estado al cuerpo de la respuesta. |
--federationSettingsId | string | true | Cadena de dígitos hexadecimales 24única que identifica su federación. |
--file | string | false | Ruta a tu archivo de solicitud de API. Déjalo en blanco para usar la entrada estándar; debes proporcionar una u otra, pero no ambas. |
-h, --ayuda | false | ayuda para updateConnectedOrgConfig | |
--orgId | string | true | Cadena de dígitos hexadecimales 24única que identifica la configuración de la organización conectada que se actualizará. |
-o, --output | string | false | formato de API preferido, puede ser ["json", go-template] Este valor predeterminado es "json". |
--archivo de salida | string | false | archivo para guardar la salida de la api. Este flag es necesario cuando la salida de un endpoint es binaria (ej.: gzip) y el comando no se redirige (ej.: comando atlas > out.zip) |
--versión | string | false | Versión de API a utilizar al llamar a la llamada de API [opciones: "2023-01-01"], el valor predeterminado es la última versión o el valor de configuración api_version de los perfiles si está configurado. Este valor predeterminado es "2023-01-01". |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se usará en el archivo de configuración. Para obtener más información sobre los perfiles de la CLI de Atlas, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |