- Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de Atlas CLI.
Elimina el proveedor de identidad especificado de tu configuración de federación.
Vista previa pública: El subcomando atlas api, generado automáticamente desde la API de administración de MongoDB Atlas, ofrece cobertura completa de la API de administración y se encuentra actualmente en vista previa pública (envíe sus comentarios en https://feedback.mongodb.com/forums/930808-atlas-cli). 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 comando, debe autenticarse con una cuenta de usuario o una clave API con el rol de Propietario de la organización.
Sintaxis
atlas federatedAuthentication federationSettings identityProvider delete <identityProviderId> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
ID del proveedor de identidad | string | true | ID del proveedor de identidad. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--federationSettingsId | string | true | Cadena de dígitos hexadecimales 24única que identifica la configuración de la federación. |
--force | false | Bandera que indica si se debe omitir la solicitud de confirmación antes de continuar con la acción solicitada. | |
-h, --ayuda | false | ayuda para eliminar | |
-o, --output | string | false | Formato de salida. Los valores válidos son json, json-path, go-template o go-template-file. Para ver la salida completa, use la opción -o json. |
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. |
Salida
Si el comando se ejecuta correctamente, la CLI devuelve un resultado similar al siguiente ejemplo. Los valores entre paréntesis representan sus valores.
Identity provider '<Name>' deleted
Ejemplos
# elete the identity provider with ID aa2223b25a115342acc1f108 from your federation settings with federationSettingsId 5d1113b25a115342acc2d1aa. atlas federatedAuthentication federationSettings identityProvider delete aa2223b25a115342acc1f108 --federationSettingsId 5d1113b25a115342acc2d1aa