We're experiencing difficulty. Our engineers are on it. Please check status.mailgun.com for real-time updates.

SAML SSO

Using the SAML 2.0 protocol, Mailgun allows you to integrate with your Identity Provider to authenticate users via single sign-on, also known as SSO. Theoretically, as long as your current Identity Provider supports the SAML 2.0 protocol (Okta, Auth0, Onelogin, Azure AD, etc), then you should be able to use your provider with Mailgun. 

Mailgun supports just-in-time provisioning, so that when a user logs into Mailgun using our SSO integration, that user automatically becomes a user under your Mailgun account.

Note: SAML SSO is only available on Scale and above plans. See our plan comparison here.

 

Requirements to enable SAML SSO on Mailgun:

Verified domain

In order to setup SAML, you will need to verify that you own your corporate domain (the domain being used in the SAML configuration to login). There are two methods for verifying your corporate domain on the Mailgun platform:

  • Verified sending domain - if you plan on or are using your corporate domain for sending on Mailgun, you can use our current method of adding SPF and DKIM records to verify the domain as a sending domain on Mailgun. This domain must match the FQDN in your corporate email address used to authenticate. If the domain is already a verified sending domain on your account, no further action is required.
  • TXT record - Mailgun can generate a unique TXT record for you to add to your corporate domain’s DNS that will allow us to verify you own this domain. In order to use this method, head to the SAML Setup page ( Settings > Details in the left hand nav and then scroll down to the Authentication section and in the SAML Auth sub-section, click on Setup SAML SSO) enter your corporate domain in the Domain Name field under Domain TXT Record Generation, and hit Generate. Copy the TXT record from the modal and add that to your DNS records for your domain.

You’ll need to provide the following to Mailgun from your Identity Provider:

  • IdP Entity ID (Also known as Identity Provider Issuer)
  • Single Sign-on URL
  • X509 Certificate

You’ll need to provide the following SAML Provider details to your Identity Provider from Mailgun:

  • Entity ID
  • Assertion Consumer Service URL
  • Single Logout Service URL

 

Accessing and enabling SAML SSO on Mailgun

Note: only Admin users have access to enable/disable SAML on an account.

In order to access the SAML configuration on Mailgun, click on Settings > Details in the left hand nav and then scroll down to the Authentication section and in the SAML Auth sub-section, click on Setup SAML SSO:

Settings.PNG

Once there, you will find the relevant SAML Provider details, as well as the information you’ll need to provide Mailgun:

Setup.png

Disabling SAML SSO

Note: only Admin users have access to enable/disable SAML on an account.

In order to disable SAML SSO on your account, click on Settings > Details in the left hand nav and then scroll down to the Authentication section and in the SAML Auth sub-section, Deactivate.

Any users that were created prior to activating SAML will be able to login at https://login.mailgun.com/ with their prior username and password combo for their Mailgun account. Any users that were created using JiT via SAML will need to initiate a password reset at https://login.mailgun.com/recovery/new.

 

Okta

Setting up SAML SSO using Okta

First, you’ll need an Okta account. If you already have one, great! If not, you can register at https://developer.okta.com and follow the instructions to get a free developer account.

The following instructions and screenshots will assume you are using Okta’s Classic UI, which can be accessed by a dropdown in the upper left hand corner.

classic_UI.png

Once you have an Okta account, navigate to Applications and click on Add Application and then Create New App. When the modal pops up, select the Web Platform and SAML 2.0 as the Sign on method.

SAML_create_app.png

Give your app a descriptive name, and a logo, if you wish, and then click on Next.

Enter your:

    • Single sign on URL (this is referred to as “Assertion Consumer Service URL” in your Mailgun Dashboard)
    • Audience URI (Entity ID in your Mailgun Dashboard)
    • Leave Default RelayState blank
    • Name ID format should be set to `EmailAddress`
    • Application username should be set to `email`.


SAML_Settings.png


Configuring Attributes in Okta

UserAttributes.png

You’ll need to provide Attribute Statements for FirstAndLastName (otherwise we’ll provide a generic name)

Okta organizes users into groups. Typically those groups will organize users by the role they hold within the organization. Those groups should be mapped to roles within Mailgun as well. The following is a simple example for configuring role mapping in Mailgun. This configuration will simply pass the group names from Okta in the SAML assertion in the “UserGroup” attribute and allow Mailgun rolemapping to decide which role should be assigned to the user. 

In Mailgun, this is saying that IdP attribute “UserGroup” (which we configured above to pass the Okta Group name in) that has the name “Developers” should be assigned to the “Developer” role.

SAMLroleMapping.png

Notes:

  • A user must map to a particular role or login will not be allowed and an appropriate error message will be displayed. 
  • Not every Mailgun role needs to have a mapping. For example, if there is no need to have an “Analyst” role log in to Mailgun, just leave that mapping blank in the Mailgun UI. 
  • Mailgun’s rolemapping feature only supports case-sensitive string matches. Regex’s are not supported at this time.
  • Account owners can never perform an SP-initiated login flow by entering their email address at login.mailgun.com. This is to prevent the account owner from locking themselves out. The account owner can perform an IdP-initiated login, however. 

 

It is entirely possible that a user can be in two groups in Okta or simply map to multiple roles in mailgun. If this happens, Mailgun will observe the higher-priority role for that user. The roles are given the following priority in descending order.

  • admin
  • developer
  • support
  • billing
  • Analyst

 

So, for example, if a user maps to a “developer” and “admin”, they will be “admin” in Mailgun since it holds higher priority.

OneLogin

Setting up SAML SSO using OneLogin

Login to your OneLogin Administration page; on the navbar head over to "Applications"
mceclip0.png

In Applications, create your own application by selecting "Add App"

mceclip2.png

You'll be presented with categories on the subsequent page. Head to the search bar and search for "SAML". From the results select "SAML Custom Connector (Advanced)"

mceclip5.png

Give the connector app some details such as a display name, a description for other admins in your organization to see such as configuration recommendations or process. You can also choose if you would like to make the app visible to users OneLogin dashboards/profiles. You can customize the logo using our assets over on our GitHub Repo

mceclip7.png

When you save, you'll land on a similar page with additional options to select from, as seen below.

mceclip0.png

For the next section load your Mailgun SAML details from your dashboard if you haven't had them in another tab/window already. You'll be copying over the Mailgun Service Provider details, note the copy buttons to make sure there are no character format issues or leading/trailing spaces.
mceclip9.png

Copy these over to OneLogin by going to "Configuration"

  • Entity ID will go into the Audience (EntityID) field.
  • Assertion Consumer Service URL (ACS URL) will go into the ACS (Consumer) URL Validator field and the ACS (Consumer) URL field.
  • Single Logout Service will go into the Single Logout URL field
  • NOTE: Mailgun requires BOTH the assertion and response to be signed. You need to change SAML signature element to BOTH.
 

mceclip12.png

Now you will need to provide information from OneLogin to Mailgun. Head over to to "SSO" section. Note the copy buttons to make things easier. mceclip13.png

To copy the X.509 Certificate you will need to click "View Details" and be taken to this page, again note the copy button. Change nothing else, DO NOT HIT DELETE simply navigate back to your app configuration.

mceclip14.png

  • Issuer URL will go in the IdP Entity ID field
  • SAML 2.0 Endpoint (HTTP) will go in the Single Sign-On URL field
  • SLO Endpoint (HTTP) will go in the Single Logout Service URL field
  • X.509 certificate will go into the X.509 certificate field

mceclip15.png

Hit "Update" you should receive toast notifications informing you each field has been updated successfully.

 

Configuring Attributes in Onelogin

From here you'll need to configure parameters for either platform to be able to target values so roles are assigned as you desire. You'll need to configure an Attribute Name for each role you would like to set up, depending on how your organization handles their Identity Access Management (IAM) these can be the same or different. For more about how to best implement your IAM for your organization connect with your OneLogin support team or engineer.

For the below example we will be configuring against a OneLogin users "Title" as the identifier in OneLogin, you may find your organization utilizes groups, departments, teams, etc.

To start we created "MG.Role" as the Attribute Name and the targeted Value for each to correspond to either.

mceclip16.png

In OneLogin go to "Parameters" you will be creating a custom parameter connector field that matches the Attribute Name over in Mailgun that you chose. For this example, "MG.Role", and ensure "Include SAML Assertion" is toggled on.

mceclip18.png

The page will update and you will be allowed to choose your target OneLogin Value to apply against.

mceclip20.png

Notes:

  • A user must map to a particular role or login will not be allowed and an appropriate error message will be displayed. 
  • Not every Mailgun role needs to have a mapping. For example, if there is no need to have an “Analyst” role log in to Mailgun, just leave that mapping blank in the Mailgun UI. 
  • Mailgun’s role mapping feature only supports case-sensitive string matches. Regex’s are not supported at this time.
  • Account owners can never perform an SP-initiated login flow by entering their email address at login.mailgun.com. This is to prevent the account owner from locking themselves out. The account owner can perform an IdP-initiated login, however. 

Save All your changes. 


Finally, you will need to ensure your desired users are assigned the application you just finished creating. In this example, as I only have a single user, I did so directly in the user details section. You may find your organization's IAM setup with OneLogin may utilize Groups, Departments, Roles, for Role-Based Access Control (RBAC) assignment to apply applications at scale. To configure and assist with ensuring users are assigned appropriately work with OneLogin support. 

mceclip21.png

 

To test things out, it's recommended you create a test user in OneLogin, setup as desired there, and head over to our Login Page IN A NEW INCOGNITO WINDOW. When you sign in as the new user you should be redirected to authenticate the user with OneLogin.
mceclip22.png

To confirm back in your cached browser session (Aka the non-incognito session) navigate to your account security page. Here, if completed successfully, you will see your new user automatically created with a "SAML Auth" flag.

mceclip23.png

Done!

Powered by Zendesk