SAML Single Sign-On (SSO) into Drupal using Auth0 as IdP

Overview

The Drupal SAML integration using the miniOrange SAML SP module establishes seamless SSO between Auth0 and the Drupal site. The users will be able to log in to the Drupal site using their Auth0 credentials. This document will walk you through the steps to configure Single Sign-On - SSO between Drupal as a Service Provider (SP) and Auth0 as an Identity Provider (IdP). The module is compatible with Drupal 7, Drupal 8, Drupal 9, and Drupal 10, and Drupal 11.

Play Ground

Schedule a Meeting

Installation Steps

Using Composer
Using Drush
Manual Installation

Download the module:

Composer require 'drupal/miniorange_saml'

Navigate to Extend menu on your Drupal admin console and search for miniOrange SAML Service Provider using the search box.
Enable the module by checking the checkbox and click on install button.

Configure the module at

{BaseURL}/admin/config/people/miniorange_saml/idp_setup

Install the module:
```
drush en drupal/miniorange_saml
```
Clear the cache:
```
 drush cr
```

Configure the module at

{BaseURL}/admin/config/people/miniorange_saml/idp_setup

Navigate to Extend menu on your Drupal admin console and click on Install new module button.
Install the Drupal SAML SP 2.0 Single Sign On (SSO) - SAML Service Provider module either by downloading the zip or from the URL of the package (tar/zip).
Click on Enable newly added modules.
Enable this module by checking the checkbox and click on install button.

Configure the module at

{BaseURL}/admin/config/people/miniorange_saml/idp_setup

Configuration Steps

Drupal SAML SP Metadata:

Go to Configuration → People → SAML Login Configuration in the Administration menu. (/admin/config/people/miniorange_saml/idp_setup)

Drupal SAML SP - select miniOrange SAML Login Configuration

Under the Service Provider Metadata tab, scroll down and copy the SP Entity ID/Issuer and the SP ACS URL. Keep it handy. (This is required to configure IdP.)

Drupal SAML SP - Copy SP Entity ID and SP ACS URL

Setup Auth0 as SAML Identity Provider

Log into your Auth0 admin console.
Navigate to the Applications and select Applications.

Auth0-SAML-Single-Sign-On-navigate-to-application

Click on Create Application button.

Auth0-SAML-Single-Sign-On-click-on-Create-application-btn

On the Create application, enter the Name of application (in this case, DrupalSAML) and select Regular Web Applications. Click on the Create button.

Auth0-SAML-Single-Sign-On-enter-application-name-and-select-application-type

Navigate to the Addons tab and enable the SAML2 WEB APP toggle.

On the Addon: SAML2 Web App window, navigate to the Settings tab and provide the information into the corresponding text field from the Service Provider Metadata tab of the module.

Auth0 Field	Service Provider Information (Drupal)
Application Callback URL	SP ACS URL
audience	SP Entity ID/Issuer
recipient	SP ACS URL

Auth0-SAML-Single-Sign-On-paste-the-copied-SP-Entity-and-SP-ACS-URL-under-settings

Scroll down and click on Enable button, then click Save button to save SAML SP information.

On the same window, navigate to the Usage tab, find the Identity Provider Metadata and click the Download link to get the IdP metadata file. Keep the IdP metdata file handy. This information is required to configure Drupal as SAML Service Provider (SP).

Configure Drupal as SAML Service Provider:

Navigate to the Service Provider Setup tab of the Drupal site and click on Upload IDP Metadata.

In the Upload Metadata File field and upload the IdP metadata file that you downloaded from Auth0. Then, click on Upload File button to proceed.

drupal saml Single Sign On as SP - upload idp metadata url

Note: To update Identity Provider Name, follow these steps:

Under Action, select the Edit.
Enter Auth0 in the Identity Provider Name text field.
Scroll down and click on the Save Configuration button.

Click on the Test link to test the connection between Drupal and Auth0.

drupal saml Single Sign On as SP - click on Test link to check the connection

On a Test Configuration popup, if you don't have an active session in the Auth0 on the same browser, you will be asked to sign in to Auth0. After successfully login into Auth0, you will be provided with a list of attributes that are received from the Auth0. Click on Done

Congratulations! you have successfully configure Auth0 as SAML Identity Provider (IdP) and Drupal as SAML Service Provider.

How does SAML SSO login work?

Open a new browser/private window and navigate to the Drupal site login page.
Click the Login using Identity Provider (Auth0) link.
You will be redirected to the Auth0 login page. Enter the Auth0 credentials. After successful authentication, the user will be redirected back to the Drupal site.