Select a Connection Method
When you connect to an existing Atlas account from the Atlas CLI, you can authenticate with one of the following options for the atlas auth login command:
Option | Authentication Method | Use Case |
|---|---|---|
| Atlas login credentials and an authentication token | Best for non-programmatic use |
| Service Account | Best for programmatic use with a Service Account |
| API keys | Best for programmatic use with an API Key |
Important
For Atlas CLI versions before 1.47, API keys are stored in plaintext in the Atlas CLI configuration file. Your API keys are like passwords. Ensure that you secure the configuration file appropriately. Atlas CLI 1.47+ attempts to store credentials securely.
To create a new Atlas account or onboard an existing account that doesn't have any clusters, see Get Started with Atlas.
Select a use case below to learn more about the available connection options:
Use the atlas auth login command with the UserAccount option to authenticate with your Atlas login credentials and a one-time authentication token. The UserAccount option requires manual login and verification of an authentication token, which is valid for 12 hours. API keys are optional when connecting with the UserAccount option.
After you run atlas auth login with the UserAccount option, you can:
Connect with minimum required settings and specify the
--projectIdand--orgIdflags with each command. This is the quickest way to get started for first-time login.
When you run the atlas auth login command with the ServiceAccounts option, the Atlas CLI prompts you to provide your client ID and secret. The ServiceAccounts option is good for programmatic use because it allows you to automate and manage MongoDB resources. Service Accounts, also referred to as OAuth applications, allows programmatic access through the specified secure client ID and secret. This method works well for scripting use cases and continuous integration or delivery workflows.
Note
This process is interactive. For programmatic authentication, set the MONGODB_ATLAS_CLIENT_ID and MONGODB_ATLAS_CLIENT_SECRET environment variables before you use the {atlas-cli+}. To learn more about all the supported environment variables, see Atlas CLI Environment Variables.
You must configure API keys to authenticate with this command.
When you run the atlas auth login command with the APIKeys option, the Atlas CLI prompts you to provide your API keys and automatically creates a profile that stores the API keys. The APIKeys option is good for programmatic use because it doesn't require manual login or token verification.
When you use connect using the atlas auth login command with the APIKeys option, you can:
Connect with minimum required settings and specify the
--projectIdand--orgIdflags with each command. This is the quickest way to get started for first-time login.
Connect With Minimum Required Settings
Select a use case and follow the steps to connect from the Atlas CLI with minimum required settings.
Complete the Prerequisites
Add your host's IP address to the IP access list.
If you authenticate with your Atlas user credentials and your organization's owners enable IP access list for the Atlas UI for an organization, your IP address must be added to the IP access list to run commands in this organization. To learn more, see Require IP Access List for the Atlas UI.
Before you start, ensure you have:
An active Atlas organization.
A Service Account created and configured. To learn more, see Grant Programmatic Access to an Organization.
The client ID and secret of your Service Account.
Follow These Steps
Select a use case and follow the procedure to quickly connect from the Atlas CLI.
atlas auth login The command opens a browser window and returns a one-time activation code. This code expires after 10 minutes.
Return to the Atlas CLI and accept the default profile options.
Return to the terminal. If you connect successfully, you see a message:
Successfully logged in as {Your Email Address}.
Accept the default profile configuration by pressing Enter if the following options display:
Default Org IDDefault Project IDDefault Output FormatDefault MongoDB Shell Path
Important
If you previously set up any profiles with API keys for MongoCLI, your profiles migrate automatically. Some migrated profiles might cause Atlas CLI commands to fail when authenticating with atlas auth login. The following message displays when you run atlas auth login if there is a conflict:
There was an error fetching your organizations: Global user is from outside access listed subnets. To fix the conflict, open the :ref:`configuration file <config-toml-location>`, remove the default profile, and run ``atlas auth login`` again. .. step:: Issue commands using the ``--projectId`` and ``--orgId`` flags. When you run :ref:`Atlas CLI commands <atlas>` for the duration of your Atlas CLI session, specify your Project ID and Org ID using the ``--projectId`` and ``--orgId`` flags. .. example:: .. code-block:: sh atlas alerts list --projectId 60b3c81153cf986293e2608b .. tab:: Service Account :tabid: service-account .. procedure:: :style: normal .. include:: /includes/steps-atlas-cli-auth-prog-default.rst .. step:: Select the ``ServiceAccount`` option and press ``Enter``. .. step:: Enter the Service Account Credentials. Provide the client ID and secret of the Service Account you created and press ``Enter``. .. step:: Select the default project and output format. a. If your Service Account is at organization level, the CLI prompts you to select a default project to run commands on. #. Select the output format. .. step:: Issue commands using the ``--projectId`` and ``--orgId`` flags. When you run :ref:`Atlas CLI commands <atlas>` for the duration of your Atlas CLI session, specify your Project ID and Org ID using the ``--projectId`` and ``--orgId`` flags. .. example:: .. code-block:: sh atlas alerts list --projectId 60b3c81153cf986293e2608b .. tab:: API Keys :tabid: api-keys .. procedure:: :style: normal .. include:: /includes/steps-atlas-cli-auth-prog-default.rst .. step:: Select the ``APIKeys`` option and press ``Enter``. .. step:: Enter your |api| keys. Enter your public and private keys when prompted. .. step:: Accept the default profile options. Accept the remaining default profile options by pressing :guilabel:`Enter` when the following options display: - ``Default Org ID`` - ``Default Project ID`` - ``Default Output Format`` - ``Default MongoDB Shell Path`` .. step:: Issue commands using the ``--projectId`` and ``--orgId`` flags. When you run :ref:`Atlas CLI commands <atlas>` for the duration of your Atlas CLI session, specify your Project ID and Org ID using the ``--projectId`` and ``--orgId`` flags. .. example:: .. code-block:: sh atlas alerts list --projectId 60b3c81153cf986293e2608b
Take the Next Steps
Start using the Atlas CLI commands.
To save connection settings by modifying the default profile or create a different profile, see Save Connection Settings.