Seleccione un método de conexión
Cuando se realiza la conexión a una cuenta Atlas existente desde Atlas CLI, es posible autenticarse con una de las siguientes opciones para el comando atlas auth login:
Opción | Método de autenticación | Caso de uso |
|---|---|---|
| Credenciales de inicio de sesión de Atlas y un token de autenticación | Mejor para uso no programático |
| Cuenta de servicio | Mejor para uso programático con una Cuenta de Servicio |
| Claves API | Ideal para el uso programático con una clave API |
Importante
Para las versiones de Atlas CLI anteriores a 1.47, Las claves API se almacenan en texto sin formato en el archivo de configuración de Atlas CLI. Tus claves API son como contraseñas. Asegúrate de asegurar adecuadamente el archivo de configuración. Atlas CLI 1.47+ intenta almacenar las credenciales de manera segura.
Para crear una nueva cuenta de Atlas o incorporar una cuenta existente que no tenga ningún clúster, consulta Primeros pasos con Atlas.
Seleccione un caso de uso a continuación para aprender más sobre las opciones de conexión disponibles:
Utilice el comando atlas auth login con la opción UserAccount para autenticarse con sus credenciales de inicio de sesión en Atlas y un token de autenticación de un solo uso. La opción UserAccount requiere el inicio de sesión manual y la verificación de un token de autenticación, el cual es válido durante 12 horas. Las claves API son opcionales al conectarse con la opción UserAccount.
Después de ejecutar atlas auth login con la opción UserAccount, se puede:
Conectarse con la configuración mínima requerida y especificar las banderas
--projectIdy--orgIdcon cada comando. Esta es la manera más rápida de comenzar para el primer inicio de sesión.Guarda tus configuraciones de conexión en un perfil. Los perfiles almacenan los ID del proyecto, los Identificadores de la organización y, opcionalmente, las claves API que se utilizarán en futuras sesiones de Atlas CLI. Para ahorrar tiempo, puedes especificar un perfil en lugar de usar las banderas
--projectIdy--orgIdcon cada comando.
Cuando se ejecuta el comando atlas auth login con la opción ServiceAccounts, el Atlas CLI solicita que se proporcione el ID de cliente y el secreto. La opción ServiceAccounts es buena para uso programático porque permite automatizar y gestionar recursos de MongoDB. Las cuentas de servicio, también conocidas como aplicaciones OAuth, permiten el acceso programático a través del ID de cliente seguro y el secreto especificados. Este método funciona bien para casos prácticos de script y flujos de trabajo de integración continua o entrega continua.
Nota
Este proceso es interactivo. Para la autenticación programática, configura las variables de entorno MONGODB_ATLAS_CLIENT_ID y MONGODB_ATLAS_CLIENT_SECRET antes de utilizar {atlas-cli+}. Para aprender más sobre todas las variables de entorno compatibles, consulta Atlas CLI Environment Variables.
Debe configurar las claves de API para autenticarse con este comando.
Cuando se ejecuta el comando atlas auth login con la opción APIKeys, Atlas CLI solicita que se proporcionen las claves API y se crea automáticamente un perfil que almacena las claves API. La opción APIKeys es adecuada para el uso programático porque no requiere inicio de sesión manual ni verificación de token.
Cuando utilizas la conexión mediante el comando atlas auth login con la opción APIKeys, puedes:
Conectarse con la configuración mínima requerida y especificar las banderas
--projectIdy--orgIdcon cada comando. Esta es la manera más rápida de comenzar para el primer inicio de sesión.Guarda configuraciones adicionales de conexión en un perfil. Los perfiles almacenan los ID del proyecto, los Identificadores de la organización y, opcionalmente, las claves API que se utilizarán en futuras sesiones de Atlas CLI. Para ahorrar tiempo, puedes especificar un perfil en lugar de usar las banderas
--projectIdy--orgIdcon cada comando.
Conéctate con la configuración mínima requerida
Seleccione un caso de uso y siga los pasos para conectarse desde la Atlas CLI con la configuración mínima necesaria.
Completar los requisitos previos
Añadir la dirección IP del host a la lista de acceso IP.
Si se autentica con las credenciales de usuario de Atlas y los propietarios de su organización habilitan la lista de acceso IP para la Interfaz de Usuario de Atlas para una organización, su dirección IP debe ser añadida a la lista de acceso IP para ejecutar comandos en esta organización. Para obtener más información, consultar Requiere lista de acceso IP para la Interfaz de Usuario de Atlas.
Antes de comenzar, asegúrese de tener:
Una organización activa de Atlas.
Una cuenta de servicio ha sido creada y configurada. Para obtener más información, consulta Conceder acceso programático a una Organización.
El ID del cliente y el secreto de la cuenta de servicio.
Siga estos pasos
Seleccione un caso de uso y siga el procedimiento para conectarse rápidamente desde el Atlas CLI.
Regresar a la Atlas CLI y acepte las opciones de perfil por defecto.
Regresar a la terminal. Si se conecta correctamente, verá un mensaje:
Successfully logged in as {Your Email Address}.
Acepte la configuración de perfil por defecto pulsando Enter si aparecen las siguientes opciones:
Default Org IDDefault Project IDDefault Output FormatDefault MongoDB Shell Path
Importante
Si previamente configuró algún perfil con claves API para MongoCLI, sus perfiles migran automáticamente. Algunos perfiles migrados podrían hacer que los comandos de Atlas CLI fallen al autenticarse con atlas auth login. El siguiente mensaje se muestra cuando ejecuta atlas auth login si hay un conflicto:
There was an error fetching your organizations: Global user is from outside access listed subnets.
Para resolver el conflicto, abrir el archivo de configuración, eliminar el perfil por defecto y ejecutar atlas auth login nuevamente.
Emite comandos usando las banderas --projectId y --orgId.
Cuando se ejecuten comandos de Atlas CLI durante la sesión de Atlas CLI, especificar el ID del grupo y ID de organización usando las banderas --projectId y --orgId.
Ejemplo
atlas alerts list --projectId 60b3c81153cf986293e2608b
Emite comandos usando las banderas --projectId y --orgId.
Cuando se ejecuten comandos de Atlas CLI durante la sesión de Atlas CLI, especificar el ID del grupo y ID de organización usando las banderas --projectId y --orgId.
Ejemplo
atlas alerts list --projectId 60b3c81153cf986293e2608b
Emite comandos usando las banderas --projectId y --orgId.
Cuando se ejecuten comandos de Atlas CLI durante la sesión de Atlas CLI, especificar el ID del grupo y ID de organización usando las banderas --projectId y --orgId.
Ejemplo
atlas alerts list --projectId 60b3c81153cf986293e2608b
Da los siguientes pasos
Comience a usar los comandos de Atlas CLI.
Para guardar la configuración de conexión modificando el perfil por defecto o crear un perfil diferente, consulta Guardar la configuración de conexión.