Setup OpenAthens Single Sign-on with Drupal OAuth Client

Overview

Drupal miniOrange SSO integration will allow you to configure Single Sign-On ( SSO ) login between your Drupal site and OpenAthens using OAuth/OpenID protocol. Drupal OAuth 2.0/OpenID connect module gives the ability to enable login using OAuth 2.0/OIDC Single Sign-On to Drupal Site. We provide the Drupal OAuth/OpenID Client module for Drupal 7, Drupal 8, Drupal 9, Drupal 10, and Drupal 11.

Installation Steps

• Using Composer
• Using Drush
• Manual Installation

• Download the module:

  composer require 'drupal/miniorange_oauth_client'

• Navigate to Extend menu on your Drupal admin console and search for miniOrange OAuth Client Configuration using the search box.
• Enable the module by checking the checkbox and click on the Install button.
• You can configure the module at:

  {BaseURL}/admin/config/people/miniorange_oauth_client/config_clc

• Install the module:

  drush en drupal/miniorange_oauth_client

• Clear the cache:

   drush cr

• You can configure the module at:

  {BaseURL}/admin/config/people/miniorange_oauth_client/config_clc

• Navigate to Extend menu on your Drupal admin console and click on Install new module.
• Install the Drupal OAuth & OpenID Connect Login - OAuth2 Client SSO Login 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.
• You can configure the module at:

  {BaseURL}/admin/config/people/miniorange_oauth_client/config_clc

Configuration Steps

Setup Drupal as OAuth Client

• After installing the module, navigate to the Configuration -> miniOrange OAuth Client Configuration -> Configure OAuth tab and select Custom OAuth 2.0 Provider from the Select Application dropdown list.
• Copy the Callback/Redirect URL and keep it handy.

Note: If your provider only supports HTTPS Callback/Redirect URLs and you have an HTTP site, please make sure to enable the 'Enforce HTTPS Callback URL' checkbox at the bottom of the tab.

• Enter the application name in the Display Name text field. For example, OpenAthens.

Create Application in OpenAthens

• First of all, go to the publisher dashboard of OpenAthens https://sp.openathens.net and login in your account to Configure OpenAthens.
• Click on Configuration dropdown, and select Applications.

• Next, click on the Create new application button to create new application.

• Select OpenID Connect from the list and click on the Configure button.

• Enter the application's name and URL in the text fields, Application Name and Application URL, respectively. Under the Redirect URL textfield, enter the Redirect/Callback URI from the miniOrange OAuth Client module.
• Click on Create application button.

• You will see the Client ID and Client Secret generated.
• Copy the Client ID and Client Secret and keep it handy.

Integrating Drupal with OpenAthens

• Under the Configure OAuth tab paste the copied Client ID and Client Secret.

• Enter the scope and endpoints given in below table.
• Click on the Save Configuration button to save the configuration.

• OpenAthens Endpoints and Scope:

Scope:	openid
Authorize Endpoint:	https://connect.openathens.net/oidc/auth
Access Token Endpoint:	https://connect.openathens.net/oidc/token
Get User Info Endpoint:	https://connect.openathens.net/oidc/userinfo
Custom redirect URL after logout:[optional]	https://sp.yourdomain.com/oa/logout

Test Configuration of Drupal with OpenAthens

• Navigate to the Drupal site and click on the Perform Test Configuration button.

• On a Test Configuration popup, if you don't have an active session in OpenAthens on the same browser, you'll be prompted to sign in to OpenAthens. Once successfully logged in, you'll receive a list of attributes retrieved from OpenAthens.

• Scroll down and click on the Configure Attribute / Role Mapping button.
• On the Attribute & Role Mapping tab, please select the attribute under which the email of the user is received from the Email Address drop-down menu. Similarly, you can select the suitable option from the Name Attribute drop-down menu.

• Now log out and go to your Drupal site’s login page. You will automatically find a Login with OpenAthens link there. If you want to add the SSO link to other pages as well, please follow the steps given in the image below :