OpenAthens SSO Login with Drupal OAuth Client | Drupal SSO Login
Drupal OpenAthens 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 and Drupal 10.
Here we will go through a guide to configure the SSO login between Drupal and OpenAthens. By following these steps,
users of OpenAthens will be able to log into the Drupal site using their OpenAthens credentials.
If you have any queries or if you need any sort of assistance in configuring the module, you can contact us at drupalsupport@xecurify.com. If you want, we can also schedule an online meeting to help you configure the Drupal
OAuth & OpenID Connect Login – OAuth2 Client SSO Login module.
Pre-requisite: Download and 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
- Navigate to the Configure OAuth tab and search for your Provider/Application using the search box. If you can't find a desired application/provider, select Custom OAuth Provider.
- Copy the Callback/Redirect URL and keep it handy.
1. Setup OpenAthens as an OAuth Provider
- First of all, go to the publisher dashboard of OpenAthens https://sp.openathens.net and login in your account to Configure OpenAthens.
- Click on Applications tab, click on Create new application to create new application.
- Select OpenID Connect from the list.
- Add the name you want to give to your application, URL of the application under the Application Name and Application URL fields respectively. Enter the Redirect/Callback URI from miniOrange OAuth Client module under the Authorized redirect URIs field.
- Click on Create application button.
- You will see the Client ID and Client Secret generated.
- Copy the Client ID and Client Secret and save it on your miniOrange OAuth Client module Configuration.
- You have successfully completed your OpenAthens App OAuth Server side configurations.
- Activate the OAuth Single Sign On - SSO (OAuth Client) plugin.
- Go to the Configure OAuth tab and select Custom OAuth 2.0 App from the Custom Applications list.
- Enter the Client ID and Client Secret generated from openathens application.
- Enter the scope and endpoints given in below table.
- Click on the Save button to save the configuration and click on the Test Configuration.
- In Drupal’s Configure OAuth tab and paste the copied Client ID and Client Secret (copied from the OpenAthens) in the Client ID and Client Secret text-field.
2. Integrating Drupal with OpenAthens
OpenAthens Endpoints and Scope:
| Scope: | openid |
| Authorize Endpoint: | https://sp.openathens.net/oauth2/authorize |
| Access Token Endpoint: | https://sp.openathens.net/oauth2/token |
| Get User Info Endpoint: | https://sp.openathens.net/oauth2/userInfo |
| Custom redirect URL after logout:[optional] | https://sp.yourdomain.com/oa/logout |
3. Test Configuration of Drupal with OpenAthens
- After successfully saving the configurations, please click on the Test Configuration button to test the connection between Drupal and OpenAthens.
- This Test Configuration window will provide you with a list of the attributes that are coming from the OpenAthens.
- Select the Email Attribute from the dropdown menu in which the user's email ID is obtained and click on the Done button.
- Now, in the Attribute & Role Mapping tab, you can also choose the Username Attribute from the dropdown and click on the Save Configuration button.
- 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 :
Please note: Mapping the Email Attribute is mandatory for your login to work.
24*7 Active Support
If you face any issues or if you have any questions, please feel free to reach out to us at drupalsupport@xecurify.com. In case you want some additional features to be included in the module, please get in touch with us, and we can get that custom-made for you. Also, If you want, we can also schedule an online meeting to help you configure the Drupal OAuth/OpenID Single Sign On module.
Additional Resources
Our Other modules
Need Help? We are right here!
