- 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.
Devuelve los detalles de la configuración de Federación para la organización especificada.
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 describe [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-h, --ayuda | false | ayuda para describir | |
--orgId | string | false | ID de organización a utilizar. Esta opción anula la configuración del archivo de configuración o la variable de entorno. |
-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.
ID IDENTITY PROVIDER ID IDENTITY PROVIDER STATUS <Id> <IdentityProviderId> <IdentityProviderStatus>
Ejemplos
# Return the JSON-formatted Federation Settings details: atlas federatedAuthentication federationSettings describe --orgId 5e2211c17a3e5a48f5497de3 --output json