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

Overview

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

Playground

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, copy the metadata URL by clicking the Copy button. (This is required to configure IdP.)

Configure SAML Single Sign-On Application in Google Apps

Login into your G-Suite Administration account.
Navigate to the Apps from the left panel and click on Web and mobile apps.

Okta saml single sign on login - click on applications and select applications

Click on the Add app, and select the Add custom SAML app from the dropdown.

Google SAML Single Sign-On - Select Add Custom SAML app

Enter the App name and Description (optional). Click on the CONTINUE.

Google SAML Single Sign-On - Enter App name

Click on the DOWNLOAD METADATA button. Keep the downloaded file handy. (This is needed to configure Drupal as SAML SP.)

Google SAML Single Sign-On - Download IdP Metadata, it's required to configure Drupal as SP

Paste the copied SP Entity ID/Issuer and SP ACS URL (from Drupal site) into the Entity ID and ACS URL text field, respectively. Click on CONTINUE.

Google-SAMl-Single-Sign-On-Provide-the-required-information-and-click-save

In the Attribute mapping panel, select a user field from the dropdown under the Google Directory attribute (First name) and the corresponding attribute key to be sent in the response (field_fname). You can add more attributes using ADD.

Drupal-Google-SAML-Single-Sign-On-Map-Attribute

Add Users to Google (G Suit) Application:

In the Google Admin console, navigate to Menu → Apps → Web and mobile apps.
Select the application that you have created on Google Apps. (In this case, Drupal_SAML).
Click on the User access

Drupal Google SAML Single Sign-On - User access

Enable the checkbox ON for everyone and click on the SAVE button.

Google SAML Single Sign-On - Enable the checkbox On for everyone

Configure Drupal as Service Provider:

Navigate to the Service Provider Setup tab of the Drupal site and click on Upload IDP Metadata.
Paste the previously copied Google Apps Metadata URL into the Upload Metadata URL text field. Click on the Fetch Metadata button.

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 Google Apps 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 Google Apps.

Drupal-SAML-Click-on-Test-link-to-verify-the-connection-between-drupal-and-google apps

On a Test Configuration popup sign in using Google Apps credentials (if an active session is not present). After successful authentication, a list of attributes that are received from Google Apps will be displayed. Click on the Done.

drupal saml Single Sign On as SP - click on Done button

Congratulations! you have successfully configure Google Apps as SAML Identity Provider 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 (Google Apps) link.
You will be redirected to the Google Apps login page. Enter the Google Apps credentials. After successful authentication, the user will be redirected back to the Drupal site.