Skip to main content

Prerequisites

Before you begin, set up a SAML 2.0 identity provider (IDP) server.

Setup

To set up SAML SSO login for the Client Dashboard:
  1. Create a SAML SSO application in your IDP.
  2. Create and assign users to your SAML SSO application in your IDP. Users must have the following attributes:
    • First name
    • Last name
    • Email
  3. Contact MX for your Client ID. You’ll set this value in your IDP in step 5.
  4. Send MX the following:
    • A valid X.509 certificate used to verify the SAML responses you send, or an XML configuration file
    • The certificate fingerprint
    • The certificate fingerprint algorithm
  5. Configure your SAML SSO application in your IDP:
    • Set Entity ID to https://dashboard.mx.com/saml/sp.
    • Set Reply URL (Assertion Consumer Service URL) to https://dashboard.mx.com/saml.
    • Set Relay URL to https://dashboard.mx.com/.
    • Set Client ID to the value sent by MX.
    • See Attributes for a list of all attributes, their supported formats, and descriptions.
    The Reply URL and Relay URL values may differ if you’re testing in a different environment.

Attributes

Use the following attributes when configuring your SAML SSO application in your IDP.

Just-In-Time Users

Users without an existing login can sign in to the Client Dashboard if their first name, last name, and email attributes associate them with your institution. These just-in-time (JIT) users are created as new analytics users with the ID, name, and email from the sign-in, and that ID identifies them on later sign-ins. By default, JIT users can view only the User lookup, API keys and whitelisting, Webhooks, and OAuth screens. A user with the Admin role must grant any additional permissions.