You can let Admin Dashboard users sign in through your own identity provider (IdP) with SAML 2.0, for example Okta, OneLogin or Microsoft Entra ID. This page lists the values mxHERO needs in your IdP, the values your IdP gives back, and how to turn SAML on in the dashboard.
SAML applies to the Admin Dashboard only. End User App sign-in is set separately in Settings › Security. See Security settings.
Before you begin
- You need an Owner or Administrator user in mxHERO, and an administrator in your IdP who can create SAML applications.
- Find your mxHERO organization ID: Settings › Organization and domains › Organization, shown as ID under your organization name. In this page it appears as
{organizationId}, for exampleexample-inc. - Every person who will sign in with SAML must already exist on Settings › Users with the same email address they have in your IdP. mxHERO does not create users from SAML.
- Keep User and Password (or another method) on while you test, so you can't lock yourself out.
Values to enter in your identity provider
mxHERO uses one service-provider (SP) identity for every IdP.
| IdP setting (names vary) | Value |
|---|---|
| SP Entity ID / Audience URI / Identifier | https://dashboard-v3.mxhero.com/sp |
| Assertion Consumer Service (ACS) URL / Single sign-on URL / Reply URL | https://dashboard-api.mxhero.com/auth/saml/{organizationId}/sso |
| ACS binding | HTTP-POST |
| Name ID format |
urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress (EmailAddress) |
| Name ID value | The user's email address |
| Attributes | None needed |
| Signing | Sign the response or the assertion (required) |
| Single Logout URL | Leave empty. mxHERO doesn't support SAML Single Logout. |
For example, for organization ID example-inc the ACS URL is https://dashboard-api.mxhero.com/auth/saml/example-inc/sso.
mxHERO also publishes SP metadata at https://dashboard-api.mxhero.com/auth/saml/{organizationId}/metadata. It is available only after SAML has been saved for your organization, so most IdPs are set up with the values above instead.
Values to get from your identity provider
| mxHERO field | What to copy from your IdP |
|---|---|
| Entity ID | The IdP's own entity ID, also called Issuer or Identity Provider Issuer. It must match the Issuer in the SAML response exactly. |
| Single Sign In URL | The IdP's SAML 2.0 single sign-on URL (HTTP-Redirect). |
| Certificate | The IdP's X.509 signing certificate: the complete certificate (PEM text), not its fingerprint. |
IdP-specific steps:
Turn on SAML in mxHERO
Open Settings › Security.
On the mxHERO Dashboard card, turn on SAML, then click Edit.
-
In SAML Settings, enter:
- Entity ID: the IdP entity ID / issuer.
- Single Sign In URL: the IdP SSO URL.
- The certificate: paste the complete X.509 certificate.
Click Save in the dialog.
Click Save Settings on the card. If asked, authenticate again.
After the first save, the certificate is hidden. To keep it, leave Change certificate empty when you edit the settings later. To replace it, paste the new certificate.
How sign-in works
- The user enters their email on
https://dashboard-v3.mxhero.comand chooses Use your own domain (SAML). If SAML is the only method, they go to the IdP automatically. - The IdP authenticates the user and posts a signed response to the ACS URL.
- mxHERO checks the issuer, the signature and the time window, then signs in the user whose email matches the Name ID.
- If 2FA is on, the user also enters an emailed code.
Users can also start from the mxHERO tile in the IdP's portal (IdP-initiated sign-in).
Signing out of mxHERO ends only the mxHERO session. It doesn't sign the user out of the IdP.
Verify
- Assign a test user to the mxHERO application in your IdP. The user must exist on Settings › Users.
- In a private browser window, go to
https://dashboard-v3.mxhero.com, enter the test user's email, and choose Use your own domain (SAML). - The dashboard opens after the IdP sign-in.
- In Reports › User Activity, the login event shows the SAML method.
When SAML works for everyone, you can turn other methods off in Settings › Security.
Troubleshooting
Errors appear on the page you return to after the IdP.
| Error | Cause | Fix |
|---|---|---|
USER_NOT_FOUND |
The Name ID isn't the email of a user in your mxHERO organization | Send the email address as Name ID. Add the user on Settings › Users with the same address. |
SAML_NOT_SUPPORTED |
SAML isn't configured or saved for the organization in the URL | Check {organizationId} in the ACS URL. Save the SAML settings. |
ERR_UNMATCH_ISSUER |
The Entity ID in mxHERO doesn't match the IdP's issuer | Copy the IdP entity ID / issuer again, exactly. |
ERR_FAILED_MESSAGE_SIGNATURE_VERIFICATION |
Unsigned response, or the certificate in mxHERO doesn't match the IdP's signing certificate | Enable signing in the IdP. Paste the current full certificate. |
ERR_SUBJECT_UNCONFIRMED |
The response is outside its validity time, often because of a clock difference | Check the IdP's clock and try again. |
| The IdP shows an error before returning to mxHERO | The SP Entity ID or ACS URL in the IdP is wrong | Use the values in the first table. |
Comments
0 comments
Please sign in to leave a comment.