Actualiza un proveedor de identidad en 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 solicitante o la clave API debe tener el rol de Propietario de la Organización en una de las organizaciones conectadas.
Nota: Cambiar tipos de autorización y/o actualizar reclamaciones de autorización puede impedir que los usuarios y/o grupos actuales accedan a la base de datos.
Este comando se genera automáticamente y corresponde 1:1 con el endpoint de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-updatefederationsettingidentityprovider.
Para obtener más información y ejemplos, consulta la documentación de la API referenciada que se encuentra en el enlace anterior.
Sintaxis
atlas api federatedAuthentication updateIdentityProvider [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--envelope | envelope | 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 | string única de 24 dígitos hexadecimales que identifica a tu federación. |
--file | string | false | ruta a tu archivo de solicitud de API. Déjelo vacío para utilizar la entrada estándar en su lugar; debe proporcionar uno u otro, pero no ambos. |
-h, --help | false | ayuda para updateIdentityProvider | |
--identityProviderId | string | true | string única que identifica al proveedor de identidad con el que conectarse. Si se utiliza una versión de la API anterior a 11-15-2023, usa el id heredado de 20dígitos hexadecimales. Este id se puede encontrar en la Consola de gestión de la federación > pestaña Proveedor de identidad haciendo clic en el icono de información en la fila IdP ID de un proveedor de identidad configurado. Para todas las demás versiones, use el ID de dígito hexadecimal de 24. |
-o, --output | string | false | formato de API preferido, puede ser ["json", go-template] Este valor predeterminado es "json". |
--outputFile | 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 la API que se utilizará al llamar a la llamada de API [opciones: "2023-11-15"], por defecto se usa la versión más reciente o el valor de configuración api_version de perfiles si se establece Este valor por defecto es "2023-11-15". |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se utilizará en tu archivo de configuración. Para aprender sobre los perfiles para el Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |