Vista previa pública: proporcione comentarios: elimina la instancia de configuración de la federación y todos los datos asociados, incluidos los proveedores de identidad y los dominios.
El subcomando de la API de Atlas, generado automáticamente a partir de la API de administración de MongoDB Atlas, ofrece cobertura total de la API de administración y actualmente se encuentra en Vista Previa Pública (por favor, proporciona comentarios en https://feedback.mongodb.com/forums/930808-atlas-cli). Las capacidades de la Admin API tienen su propio ciclo de vida de lanzamientos, que se puede consultar en el enlace de documentación del endpoint de API proporcionado.
Para usar este recurso, la cuenta de servicio o clave API solicitante debe tener el rol de propietario de la organización en la última organización conectada. Nota: Las solicitudes a este recurso fallarán si hay más de una organización conectada en la federación.
Este comando se genera automáticamente y 1 corresponde:1 con el punto final de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-deletefederationapp.
Para obtener más información y ejemplos, consulte la documentación de la API referenciada en el enlace anterior.
Sintaxis
atlas api federatedAuthentication deleteFederationApp [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--federationSettingsId | string | true | Cadena única de 24 dígitos hexadecimales que identifica su federación. |
-h, --ayuda | false | Ayuda para deleteFederationApp | |
-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. |
Ejemplos
atlas api federatedAuthentication deleteFederationApp --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e