Prerequisites
Mailosaur's Okta integration supports authentication via SAML, OpenID Connect (OIDC) and SCIM provisioning (depending on plan level).
Before beginning, ensure that you have:
- A Mailosaur account with SSO enabled. SSO is available on the Enterprise plan, and as an optional bolt-on to the Professional plan.
- Access with the role of Account Administrator.
Supported Features
- SP-initiated SSO
- JIT (Just-In-Time) provisioning
- SCIM provisioning (Enterprise plan only)
SAML
Configuration Steps
Follow these steps if you wish to integrate Okta and Mailosaur using SAML. Alternatively, you can configure using OpenID Connect (OIDC).
Configuration within Okta
Log into your Okta administrative portal.
Click Applications in the left-hand sidebar, and then Browse App Catalog near the top of the resulting page.
Search for "mailosaur" in the search bar, and then click the Mailosaur integration from the results.
Click the Add Integration button to add the Mailosaur integration to your Okta instance.
When the app integration is added to your Okta instance, you will be redirected to the applications assignments page. Click on the Sign On tab then copy the Metadata URL value, you will need this later.
Verify your company domain in Mailosaur
So that your users can be automatically redirected to Okta if they try to log in via the Mailosaur login page, you need to verify that you own the domain in their email address (for example, if your users used some.person@example.com
, you would verify ownership of example.com
). To do this:
Log into the Mailosaur Dashboard.
Click Admin (cog icon) in the top-right of the screen, then select Domains.
Click Add Domain and type in the domain that you wish to verify (e.g.
example.com
)Leave all other options unchanged, and click Add Domain.
Follow the on-screen instructions to verify that you own this domain (contact our support team if you're unsure how to do this).
Setup SSO within Mailosaur
If you are not already logged in, then log into the Mailosaur Dashboard.
Click Admin (cog icon) in the top-right of the screen, then select Single Sign-On.
Select your verified domain from the list of domains (see step above if you haven't verified a domain yet).
From the list of Identity providers, choose Okta.
Now fill in the Identity provider (IdP) metadata URL field. The value for this is what you copied above and can be found on the Sign On tab within the Okta administrative portal.
Paste in this value and click Save.
SSO is now configured on your account. You can optionally choose to enable JIT (Just-In-Time) Provisioning, which will automatically add any new users onto your account when they first log into Mailosaur.
You can also make SSO mandatory (however, you must first log in with Okta before you can do this).
Users can now log in via the URL shown on-screen e.g. https://mailosaur.com/sso/{company}
Configure a tile to allow users to log in via the Okta Dashboard
Mailosaur only supports Service Provider Initiated (SP-initiated) logins. Because of this, users are unable to click on the application tile provided by Okta. Instead, you should hide this default tile, and create an Okta Bookmark App tile:
- Log into Okta as an administrator
- Open the configuration for the Mailosaur application, and ensure you have hidden it's default tile by checking Do not display application icon to users under General Settings > Application Visibility
- Select Applications in the left drop-down menu
- Select Browse App Catalog
- Select Bookmark App and then Add
- Type in your desired name for the Mailosaur tile
- Enter
https://mailosaur.com/sso/{company}
into the URL box - Save your bookmark
- Your users can now log into Mailosaur by clicking this tile
OpenID Connect (OIDC)
Configuration Steps
Follow these steps if you wish to integrate Okta and Mailosaur using OpenID Connect (OIDC). Alternatively, you can configure using SAML.
Configuration within Okta
Log into your Okta administrative portal.
Click Applications in the left-hand sidebar, and then Browse App Catalog near the top of the resulting page.
Search for "mailosaur" in the search bar, and then click the Mailosaur integration from the results.
Click the Add Integration button to add the Mailosaur integration to your Okta instance.
When the app integration is added to your Okta instance, you will be redirected to the applications assignments page.
On the General tab, make a note of the Client ID that is shown.
Click on the Sign On tab then make a note of the Issuer URL.
Contact support with the Client ID and Issuer URL noted above, so that our team can complete OIDC configuration on our side.
Our team will provide you information on how your users can login.
Configure tiles for your users, using an Okta Bookmark App.
Configure a tile to allow users to log in via the Okta Dashboard
Mailosaur only supports Service Provider Initiated (SP-initiated) logins. Because of this, users are unable to click on the application tile provided by Okta. Instead, you should hide this default tile, and create an Okta Bookmark App tile:
- Log into Okta as an administrator
- Open the configuration for the Mailosaur application, and ensure you have hidden it's default tile by checking Do not display application icon to users under General Settings > Application Visibility
- Select Applications in the left drop-down menu
- Select Browse App Catalog
- Select Bookmark App and then Add
- Type in your desired name for the Mailosaur tile
- Enter
https://mailosaur.com/sso/{company}
into the URL box - Save your bookmark
- Your users can now log into Mailosaur by clicking this tile
SCIM
Supported Features
- Create users
- Update user attributes
- Deactivate users
- Push groups
For more information on the features listed below, we recommend visiting this glossary from Okta.
Configuration Steps
Generate a token for use with SCIM
Log into the Mailosaur Dashboard.
Click Admin (cog icon) in the top-right of the screen, then select API keys.
Click Create Key, name the new key
SCIM
and click Create Key again.Find the newly-created key and click Reveal Key, copy the revealed value for use later (below).
Configuring provisioning in Okta
Log into your Okta administrative portal.
Click Applications in the left-hand sidebar, and navigate into the Mailosaur application that you already have configured (see configuration steps for SAML or OIDC above).
Select the Provisioning tab and check the Configure API Integration box.
Check the Enable API integration checkbox
Paste in the API key that you created in the steps above.
Click Test API Credentials - a success message should appear.
Click Save.
Select To App in the left panel then click Edit.
Enable Create users, Update User Attributes and Deactivate Users, then click Save.
Select users to be provisionned
- The Assignments tab will let you provision your Okta users to Mailosaur.
Sync groups
On the Push Groups tab:
- Select Push Groups, then Find groups by name.
- Enter the name of your group.
- Click Save & Add Another.
Known Issues / Troubleshooting
Please reach our team at support@mailosaur.com if you encounter any issue.