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

Overview

The Drupal SAML integration using the miniOrange SAML SP module establishes seamless SSO between Okta and the Drupal site. The users will be able to log in to the Drupal site using their Okta credentials. This document will walk you through the steps to configure Single Sign-On - SSO between Drupal as a Service Provider (SP) and Okta 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, 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

Configure SAML Single Sign-On Application in Okta

Login into your Okta admin console.
Navigate to Applications from the left panel and click on the Applications.

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

Under Applications, click on the Create App Integration button.

Okta saml single sign on login - click on create app integration button

Select SAML 2.0 and click on Next button.

Configure Okta as IDP -SAML Single Sign-On(SSO) for drupal - Okta SSO Login - SAML 2.0 Configure

In the General Settings, enter the App Name and click on the Next button.

Configure Okta as IDP -SAML Single Sign-On(SSO) for Drupal - Okta SSO Login - SAML_SETTINGS

In the Display Name, enter the name of the application and then click the Next button.

Paste the copied information from the Service Provider tab of Drupal site, under the SAML Settings section referring below.

Okta Field	Service Provider Information (Drupal)
Single Sign On URL	SP ACS URL
Audience URI (SP Entity ID)	SP Entity ID/Issuer

Configure Okta as SAML IDP - Provide the required information in corresponding fields

Click on the Save button.
Under Feedback, select the appropriate option from Are you a customer or partner? Click on the Finish button.

Under the Sign On tab, click on the Copy link to copy the Metadata URL. Keep it handy. (This is required to configure Drupal as SAML SP.)

Configure Okta as SAML IDP - Copy the IdP metadata URL and keep it handy

Assign Groups/People in Okta Application

Navigate to the Assignments tab.

Click on the Assign button and select the Assign to People option.

Click on the Assign button corresponding to the user to be assigned to this application.

Click on the Save and Go Back button.

Okta SAML SSO - click on Save and Go Back buttton

The user has been successfully assigned to application.

Okta SAML SSO - people assign to applicatio successfully

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 Okta 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 Okta 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 Okta.

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

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

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

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