Manage Your Two-Factor Authentication Options
On this page
- OAuth 2.0 authentication for programmatic access to Cloud Manager is available as a Preview feature.
- The feature and the corresponding documentation might change at any time during the Preview period. To use OAuth 2.0 authentication, create a service account to use in your requests to the Cloud Manager Public API.
Two-factor authentication provides a second layer of security for your Cloud Manager account.
Important
Legacy 2FA is deprecated. If you currently have legacy 2FA enabled you can continue to use it, but it is recommended that you switch to multi-factor authentication. To use multi-factor authentication, disable legacy two-factor authentication and enable multi-factor authentication instead.
Note
Google Authentication Uses Google 2-Step Verification
Google manages your 2FA. You can't use Cloud Manager two factor authentication and won't be prompted for a Cloud Manager 2FA verification when you log into Cloud Manager. Google should verify your identity using Google 2-Step Verification
Cloud Manager requires 2FA to help users control access to their Cloud Manager accounts.
To log into Cloud Manager, a user must provide their password ("something you know"), as well as a second time-sensitive verification code, delivered during authentication ("something you have"). By requiring both factors, Cloud Manager can grant authentication requests with a higher degree of confidence.
Note
If an Organization Owner enables multi-factor authentication for an
organization, all
organization members must enable multi-factor authentication individually to access the
organization. Organization members who have not enabled MFA are
able to access Cloud Manager, but not the organization for which MFA is
required.
After you enter your username and password, you are prompted for a six-digit time-sensitive verification code. This code is sent to a separate device, such as a mobile phone or security token, that you can read and enter into Cloud Manager and complete your login.
Cloud Manager provides the following sources for 2FA verification codes:
- Text Messages (SMS)
When Cloud Manager prompts you for a verification code, Cloud Manager sends the 6-digit verification code using text (SMS) to the provided phone number.
The cellular carrier's SMS rates apply.
- Automated Voice Calls (US / Canada only)
When Cloud Manager prompts you for a verification code, Cloud Manager calls the provided phone number. An automated system repeats the 6-digit verification code a total of three times before hanging up.
The cellular carrier's Voice Call rates apply.
Note
Cloud Manager users who operate within a geographic region with limited cellular service coverage or reliability may encounter delays in receiving the 2FA code via SMS or Voice. Consider using a 2FA app or device instead.
When Cloud Manager prompts you for a verification code, you can provide one that is generated in a 2FA app. You must pair the 2FA app with Cloud Manager first.
This tutorial uses the Google Authenticator mobile app.
There are other mobile device apps and web browser plug-ins that provide 2FA capabilities. You can use any that support the TOTP.
You can pair only one app with Cloud Manager at any one time.
When Cloud Manager prompts you for a verification code, you can provide one that is generated in a 2FA PIV device. You must pair the PIV device app with Cloud Manager first using an 2FA app. These devices must support TOTP.
This procedure uses a YubiKey security key, specifically those that work with Authenticator Codes. Other 2FA PIV hardware devices that use TOTP should work in a similar fashion.
Note
Informational Reference only
MongoDB does not endorse the aforementioned service, and its reference is intended only as informational. Defer to your organization's procedures in selecting the appropriate vendor or service for supporting 2FA via smart card or similar device.
Configure Two-Factor Authentication
Configure Voice/SMS Authentication.
Click Primary Method
Click Voice/SMS Number.
In the Enter your phone number box, enter your preferred mobile phone number.
Select your preferred method of receiving codes:
Text Message (SMS) or
Voice Call (US / Canada Only)
Click Verify.
Once you receive the verification code, enter that code into the into the Verify your code boxes. Each digit is entered in its own box.
Cloud Manager automatically verifies the code and saves your settings.
On your mobile device or web browser, install Google Authenticator.
Although only Google Authenticator is displayed in the UI, any TOTP mobile app or web browser plug-in may be used.
Note
Wherever you see the phrase Google Authenticator in this procedure, you can substitute the name of your preferred 2FA app.
Add Cloud Manager to Google Authenticator.
Start Google Authenticator.
Click +.
Choose how to pair the Google Authenticator app with Cloud Manager.
If your mobile device or web browser supports scanning barcodes, click Scan a barcode.
Enable the device's camera, if prompted, and point the device at the Cloud Manager page to capture the barcode.
If your mobile device or web browser does not support scanning barcodes, or if you prefer to enter a key, click Enter provided key.
Cloud Manager displays the Cloud Manager Account with a Key.
In Google Authenticator, click Enter provided key then enter the account and key.
(Duo Mobile, Authy and other apps have similar prompts.)
After the barcode is scanned or account and key are entered, the Google Authenticator app produces a 6-digit code to verify the pairing.
Once you receive the verification code, enter that code into the into the Verify your code boxes. Each digit is entered in its own box.
Cloud Manager automatically verifies the code and saves your settings.
Tip
See also:
Pairing third-party applications with Duo Mobile
Pairing third-party applications with Authy
Pairing third-party applications with Microsoft Authenticator
Download and install the Yubico Authenticator.
From a web browser, download the Yubico Authenticator application.
Double-click on the installer and follow the prompts.
Add Cloud Manager to the Yubikey.
Start the Yubico Authenticator.
Make sure that your web browser is open to your Cloud Manager Two-Factor Authentication modal with the Google Authenticator button selected.
From the File menu in Yubico Authenticator, select Scan QR code....
In the New credential dialog box, confirm the following settings:
OptionAccepted ValueKeep Default?Issuer
The name you want to display in the Yubico Authenticator application for Cloud Manager.
Your choice
Account name
Your Cloud Manager username.
Yes
Secret key
Token generated from the QR code.
Yes
Type
Method that determines when to generate a new code.
Yes
Algorithm
Encryption algorithm the token uses.
Yes
Period
Duration that each verification code is valid.
Yes
Digits
Number of digits in the verification code.
Yes
Requires touch
Indicates user must be touching the contacts on the Yubikey when verification code is accepted.
User choice
Click Save credential.
The verification code displays in the Yubico Authenticator under the heading you gave Cloud Manager as the Issuer.
Once you receive the verification code, enter that code into the into the Verify your code boxes. Each digit is entered in its own box.
Note
You can copy the code from the Yubico Authenticator application. Click the name you gave as Issuer then select Copy to Clipboard from the Edit menu.
Cloud Manager automatically verifies the code and saves your settings.
Two-Factor Authentication on a Shared Account
A global team that shares the same Cloud Manager account can use Google Authenticator and use the same seed code for all team members. To generate a common seed code that all team members can use, select the Can't scan the barcode? link when Configuring Two-Factor Authentication with Google Authenticator.
Generate New Recovery Codes
As a backup, you can generate recovery codes to use in place of a sent code when you do not have access to a phone, 2FA app or 2FA device. Each recovery code is single-use, and you should save these codes in a secure place. When you generate new recovery codes, you invalidate previously generated ones.
Reset Legacy Two Factor Authentication
If you have legacy 2FA enabled and you lose access to your 2FA device, you can reset 2FA for your account.
Because legacy 2FA is deprecated, you cannot re-establish it after you reset it. Instead, you can enable multi-factor authentication.
Important
The following procedure resets legacy 2FA for your Cloud Manager account. To edit multi-factor authentication settings, see multi-factor authentication.
Log in to Cloud Manager with your username and password.
When the 2FA prompt displays:
Click the Reset your two-factor authentication link.
Click Cloud Manager user? Click here at the bottom of the Reset Two Factor Authentication modal.
Type your Cloud Manager username.
Click Reset Two Factor Authentication.
Cloud Manager emails a link to the e-mail account associated with the Cloud Manager username.
Check your email.
Click the link that Cloud Manager sent to start the 2FA reset procedure.
Follow the directions on the 2FA reset page. After completing the reset procedure, Cloud Manager allows you to log in to the Cloud Manager account without requiring a 2FA code.