Configure Federated Authentication from Okta
On this page
This guide shows you how to configure federated authentication using Okta as your IdP.
After integrating Okta and Atlas, you can use your company's credentials to log in to Atlas and other MongoDB cloud services.
Note
If you are using Okta's built-in MongoDB Cloud app, you can use Okta's documentation.
If you are creating your own SAML app, use the procedures described here.
Required Access
To manage federated authentication, you must have
Organization Owner
access to one or more organizations that are
delegating federation settings to the instance.
Prerequisites
To use Okta as an IdP for Atlas, you must have:
A custom, routable domain name.
Procedures
Throughout the following procedure, it is helpful to have one browser tab open to your Atlas Federation Management Console and one tab open to your Okta account.
Configure Okta as an Identity Provider
Download your Okta origination certificate.
In your Okta account, click Admin in the upper right corner to access the Administrator environment.
In the left-hand pane, navigate to Applications -> Applications.
Click Create App Integration. Select SAML 2.0 for the Sign-in method and click Next.
Fill in the App name text field with your desired application name.
Optionally, add a logo image and set app visibility. Click Next.
On the Configure SAML screen, enter the following information:
FieldValueSingle sign-on URLhttp://localhost
Audience URIurn:idp:default
Important
These are placeholder values and are not intended for use in production. You will replace them in a later step.
Leave the other fields empty or set to their default values and click Next at the bottom of the page.
On the Feedback screen, select I'm an Okta customer adding an internal app and click Finish.
At the bottom of the page under the heading SAML Signing Certificates, locate the newest certificate with a Status of
Active
--this is the certificate you just created.Click Actions and select Download certificate from the drop-down menu. The generated certificate is a
.cert
file. You must convert it to a.pem
certificate for use later in this procedure. To do this, open a terminal of your choosing and run the following:openssl x509 -in path/to/mycert.crt -out path/to/mycert.pem -outform PEM
Open the Federation Management Console.
In Atlas, go to the Organization Settings page.
If it's not already displayed, select your desired organization from the Organizations menu in the navigation bar.
Click the Organization Settings icon next to the Organizations menu.
The Organization Settings page displays.
In Federated Authentication Settings, click Open Federation Management App.
Provide Okta credentials to Atlas.
Click Identity Providers in the left-hand pane. If you have previously configured an IdP, click Add Identity Provider in the upper-right corner of the page, then click Setup Identity Provider. If you have not previously configured an IdP, click Setup Identity Provider.
On the Configure Identity Provider screen, enter the following information:
FieldValueConfiguration NameDescriptive label that identifies the configurationIssuer URIFill with Placeholder ValuesSingle Sign-On URLFill with Placeholder ValuesIdentity Provider Signature CertificateCertificate you received from Okta in a prior stepRequest BindingHTTP POST
Response Signature AlgorithmSHA-256
Click the Next button to see the values for the Okta configuration.
Click Finish.
Configure your SAML integration.
In your Okta account, return to the page for your SAML application and ensure the General tab is selected.
In the SAML Settings pane, click Edit.
On the General Settings page, click Next.
On the Configure SAML screen, enter the following information:
Okta Data FieldValueSingle sign on URLAssertion Consumer Service URL from the Atlas FMC.
Checkboxes:
Check Use this for Recipient URL and Destination URL.
Clear Allow this app to request other SSO URLs.
Audience URI (SP Entity ID)Audience URI from the Atlas FMC.Default RelayStateOptionally, add a RelayState URL to your IdP to send users to a URL you choose and avoid unnecessary redirects after login. You can use:
DestinationRelayState URLMongoDB AtlasLogin URL generated for your identity provider configuration in the Atlas Federation Management App.MongoDB Support Portalhttps://auth.mongodb.com/app/salesforce/exk1rw00vux0h1iFz297/sso/saml MongoDB Universityhttps://auth.mongodb.com/home/mongodb_thoughtindustriesstaging_1/0oadne22vtcdV5riC297/alndnea8d6SkOGXbS297 MongoDB Community Forumshttps://auth.mongodb.com/home/mongodbexternal_communityforums_3/0oa3bqf5mlIQvkbmF297/aln3bqgadajdHoymn297 MongoDB Feedback Enginehttps://auth.mongodb.com/home/mongodbexternal_uservoice_1/0oa27cs0zouYPwgj0297/aln27cvudlhBT7grX297 MongoDB JIRAhttps://auth.mongodb.com/app/mongodbexternal_mongodbjira_1/exk1s832qkFO3Rqox297/sso/saml Name ID formatUnspecifiedApplication usernameEmailUpdate application username onCreate and updateClick the Click Show Advanced Settings link in the Okta configuration page and ensure that the following values are set:
Okta Data FieldValueResponseSigned
Assertion SignatureSigned
Signature AlgorithmRSA-SHA256
Digest AlgorithmSHA256
Assertion EncryptionUnencrypted
Leave the remaining Advanced Settings fields in their default state.
Scroll down to the Attribute Statements (optional) section and create four attributes with the following values:
NameName FormatValuefirstNameUnspecifieduser.firstName
lastNameUnspecifieduser.lastName
Important
The values in the Name column are case-sensitive. Enter them exactly as shown.
Note
These values may be different if Okta is connected to an Active Directory. For the appropriate values, use the Active Directory fields that contain a user's first name, last name, and full email address.
(Optional) If you plan to use role mapping, scroll down to the Group Attribute Statements (optional) section and create an attribute with the following values:
NameName FormatFilterValuememberOfUnspecifiedMatches regex.*
This filter matches all group names associated with the user. To filter the group names sent to Atlas further, adjust the Filter and Value fields.
Click Next at the bottom of the page.
On the Feedback screen, click Finish.
Replace placeholder values in the Atlas FMC.
On the Okta application page, click View Setup Instructions in the middle of the page.
In the Atlas FMC, navigate to the Identity Providers page. Locate your Okta and click Edit.
Replace the placeholder values in the following fields:
FMC Data FieldValueIssuer URIIdentity Provider Issuer value from the Okta Setup Instructions page.Single Sign-on URLIdentity Provider Single Sign-On URL value from the Okta Setup Instructions page.Identity Provider Signature CertificateCopy the X.509 Certificate from the Okta Setup Instructions page and paste the contents directly.Click Next.
Click Finish.
Assign users to your Okta application.
On the Okta application page, click the Assignments tab.
Ensure that all your Atlas organization users who will use Okta are enrolled.
Map your Domain
Mapping your domain to the IdP lets Atlas know that users from your domain should be directed to the Login URL for your identity provider configuration.
When users visit the Atlas login page, they enter their email address. If the email domain is associated with an IdP, they are sent to the Login URL for that IdP.
Important
You can map a single domain to multiple identity providers. If you do, users who log in using the MongoDB Cloud console are automatically redirected to the first matching IdP mapped to the domain.
To log in using an alternative identity provider, users must either:
Initiate the MongoDB Cloud login through the desired IdP, or
Log in using the Login URL associated with the desired IdP.
Use the Federation Management Console to map your domain to the IdP:
Open the FMC.
In Atlas, go to the Organization Settings page.
If it's not already displayed, select your desired organization from the Organizations menu in the navigation bar.
Click the Organization Settings icon next to the Organizations menu.
The Organization Settings page displays.
In Manage Federation Settings, click Open Federation Management App.
Enter domain mapping information.
Click Add a Domain.
On the Domains screen, click Add Domain.
Enter the following information for your domain mapping:
FieldDescriptionDisplay NameLabel to easily identify the domain.Domain NameDomain name to map.Click Next.
Choose your domain verification method.
Note
You can choose the verification method once. It cannot be modified. To select a different verification method, delete and recreate the domain mapping.
Select the appropriate tab based on whether you are verifying your domain by uploading an HTML file or creating a DNS TXT record:
Upload an HTML file containing a verification key to verify that you own your domain.
Click HTML File Upload.
Click Next.
Download the
mongodb-site-verification.html
file that Atlas provides.Upload the HTML file to a web site on your domain. You must be able to access the file at
<https://host.domain>/mongodb-site-verification.html
.Click Finish.
Create a DNS TXT record with your domain provider to verify that you own your domain. Each DNS record associates a specific Atlas organization with a specific domain.
Click DNS Record.
Click Next.
Copy the provided TXT record. The TXT record has the following form:
mongodb-site-verification=<32-character string> Log in to your domain name provider (such as GoDaddy.com or networksolutions.com).
Add the TXT record that Atlas provides to your domain.
Return to Atlas and click Finish.
Verify your domain.
The Domains screen displays both unverified and verified domains you've mapped to your IdP. To verify your domain, click the target domain's Verify button. Atlas shows whether the verification succeeded in a banner at the top of the screen.
Associate Your Domain with Your Identity Provider
After successfully verifying your domain, use the Federation Management Console to associate the domain with Okta:
Click Identity Providers in the left navigation.
For the IdP you want to associate with your domain, click Edit next to Associated Domains.
Select the domain you want to associate with the IdP.
Click Confirm.
Test Your Domain Mapping
Important
Before you begin testing, copy and save the Bypass SAML Mode URL for your IdP. Use this URL to bypass federated authentication in the event that you are locked out of your Atlas organization.
While testing, keep your session logged in to the Federation Management Console to further ensure against lockouts.
To learn more about Bypass SAML Mode, see Bypass SAML Mode.
Use the Federation Management Console to test the integration between your domain and Okta:
In a private browser window, navigate to the Atlas log in page.
Enter a username (usually an email address) with your verified domain.
Example
If your verified domain is mongodb.com
, use an email
address of the form username@mongodb.com
.
Click Next. If you mapped your domain correctly, you'll be redirected to your IdP to authenticate. Upon successful authentication, you'll be redirected back to Atlas.
Note
You can bypass the Atlas log in page by navigating directly to your IdP Login URL.
(Optional) Map an Organization
Use the Federation Management Console to assign your domain's users access to specific Atlas organizations:
In Atlas, go to the Organization Settings page.
If it's not already displayed, select your desired organization from the Organizations menu in the navigation bar.
Click the Organization Settings icon next to the Organizations menu.
The Organization Settings page displays.
Connect an organization to the Federation Application.
Click View Organizations.
Atlas displays all organizations where you are an
Organization Owner
.Organizations which are not already connected to the Federation Application have Connect button in the Actions column.
Click the desired organization's Connect button.
Apply an Identity Provider to the organization.
From the Organizations screen in the management console:
Click the Name of the organization you want to map to an IdP.
On the Identity Provider screen, click Apply Identity Provider.
Atlas directs you to the Identity Providers screen which shows all IdPs you have linked to Atlas.
For the IdP you want to apply to the organization, click Add Organizations.
In the Apply Identity Provider to Organizations modal, select the organizations to which this IdP applies.
Click Confirm.
(Optional) Configure Advanced Federated Authentication Options
You can configure the following advanced options for federated authentication for greater control over your federated users and authentication flow:
Note
The following advanced options for federated authentication require you to map an organization.
Sign in to Atlas Using Your Login URL
All users you assigned to the Okta application can log in to Atlas using their Okta credentials on the Login URL. Users have access to the organizations you mapped to your IdP.
Important
You can map a single domain to multiple identity providers. If you do, users who log in using the MongoDB Cloud console are automatically redirected to the first matching IdP mapped to the domain.
To log in using an alternative identity provider, users must either:
Initiate the MongoDB Cloud login through the desired IdP, or
Log in using the Login URL associated with the desired IdP.
If you selected a default organization role, new users who log in to Atlas using the Login URL have the role you specified.