Route4Me SAML – Security Assertion Markup Language
In this guide, you can learn how to use Single Sign-On (SSO) with SAML (Security Assertion Markup Language) to log into Service Provider websites such as Route4Me with your existing user identity from your website or app. Additionally, you can learn how to add your app as an SAML Identity Provider for SSO to Route4Me.
Table of Contents
How SAML SSO Works
SAML SSO works by transferring a user’s identity from one place to another, from the Identity Provider to the Service Provider. Specifically, your website is the Identity Provider, and Route4Me is the Service Provider. The identity transfer is done with an exchange of digitally signed XML documents.
For example, you are logged into a system (Identity Provider) and want to log in to a remote application, such as a support or accounting application (the Service Provider). In that scenario, you can follow the steps below.
- Open the SAML login page on the Route4Me website and enter your work Email.
- The application identifies your origin by Email and redirects you back to the Identity Provider, asking for authentication (authentication request).
- You either have an active browser session with the Identity Provider or create one by logging into the Identity Provider.
- The Identity Provider builds the authentication response as an XML document that contains your Username or Email address, signs it using an X.509 certificate, and sends this information to the Service Provider.
- The Service Provider, which already knows the Identity Provider and has a certificate fingerprint, retrieves the authentication response and validates it with the certificate fingerprint.
- Your identity is established, and you gain app access.
SAML SSO Flow
The diagram below illustrates the SAML Single Sign-On flow.
Add Your App as an Identity Provider
Furthermore, it’s possible to add your app as an Identity Provider for SAML Single Sign-On to Route4Me.
Go to the SAML General Settings page and fill the following fields.
| Field | Description |
|---|---|
| Domain | Your website domain. It must match your users’ Email domain. |
| Audience/Entity ID | The URL of your website (https://your-website.com). |
| Single Sign-On URL | URL to send an Authentication request to (https://your-website.com/saml/SSO). |
| X.509 Certificate | The IDP’s certificate data to verify the signature in the SAMLResponse issued by your website. |
| Sign Request | Indicates if outbound SAMLRequest should be signed. |
Next, go to the SAML Attributes Mapping page. You must map attributes in the Identity Provider (IDP) response to the respective user attributes used by Route4Me. Specifically, Email, First Name, and Last Name are required attributes, while Phone and Role are optional attributes.
Furthermore, after completing both previous steps, you can generate an XML file with the configuration that you have to set up on your website to register Route4Me as the Service Provider.
Additionally, you are required to add your company users to Route4Me. Go to the “Team” page to add your users.
Then, after completing the above steps, you can log into Route4Me by SAML.
