Drupal OneLogin Single Sign-On (SSO) Integration using OAuth / OpenID connect
Drupal Onelogin SSO integration will allow the users to log in to the Drupal site using the Onelogin Credentials. This SSO integration is achieved by the miniOrange OAuth Client module which uses the OAuth 2.0 and OpenID Connect (OIDC) Protocol. This module is compatible with Drupal 7, Drupal 8, Drupal 9, as well as Drupal 10.
In this document, we will help you to configure the single Sign-on login using the OAuth protocol between the Drupal site and the Onelogin.
Installation Steps:
- 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
Setup Drupal as OAuth Client:
- After installing the module, navigate to the Configuration -> miniOrange OAuth Client Configuration -> Configure OAuth tab and select Onelogin 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, Onelogin
Configure OAuth/OpenID SSO Application in Onelogin:
- Sign in to your OneLogin Admin console.
- Navigate to Applications and select Applications on hover.
- Click on the Add App button.
- In the search box, enter OpenId Connect and click on the OpenId Connect ( OIDC) link.
- By default, the Display Name is pre-filled with OpenId Connect (OIDC). Please Enter an appropriate display name, scroll to the bottom, provide a Description, and click on the Save button.
- From the left navigation panel, click on the Configuration.
- Paste the copied Callback/Redirect URL into the Redirect URI's text field and click on the Save button.
Integrating Drupal with Onelogin:
- Navigate to the OneLogin portal.
- From the left navigation panel, click on the SSO tab.
- From the Enable OpenID Connect section copy the Client ID.
- Navigate to the Drupal site and paste the copied Client ID into the respective text field.
- Navigate back to the OneLogin portal and click on the Show client secret link. Copy the Client Secret.
- Head back to the Drupal site, and paste the copied Client Secret into the Client Secret text field.
- In the Endpoint URLs replace ‘
’ with the OneLogin subdomain. - The 'Send Client ID and Secret in Header or Body' checkbox allows you to specify whether the Client ID and Secret should be included in the header or the body of the Token Endpoint Request. If you're unsure which option to select, you can stick with the default settings.
- Click on the checkbox to Enable Login with OAuth, scroll down, and click the Save Configuration button.
Please find the OneLogin Scope and Endpoints from the table below:
| Scope | openid |
|---|---|
| Authorize EndPoint | https://<site-url>.onelogin.com/oidc/auth |
| Access Token Endpoint | https://<site-url>.onelogin.com/oidc/token |
How to Assign Users in the OneLogin Application:
- Go to the Onelogin Dashboard.
- Navigate to the Users tab in the top menu and select Users on hover.
- Search for users in the search box, and then select the user to whom you want to grant access.
- From the left navigation menu, click on the Applications.
- Under Applications, click the Plus (+) sign button.
- On the popup, select the application from the dropdown list for which you want to enable SSO for that assigned user, and then click the Continue button.
- On the next screen, check the box to Allow the user to sign in and then click on the Save button.
The user has been assigned to your application.
Test connection between Drupal and OneLogin:
- 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 OneLogin on the same browser, you'll be prompted to sign in to OneLogin. Once successfully logged in, you'll receive a list of attributes retrieved from OneLogin.
- 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.
- Scroll to the bottom and click on the Save Configuration button.
Please note: Mapping the Email Attribute is mandatory for Single Sign-On.
Congratulations! You have successfully configured OneLogin as OAuth/OpenID Provider and Drupal as an OAuth Client.
How to perform the SSO?
- Now, open a new browser/private window and go to your Drupal site login page.
- Click on the Login using the Onelogin link to initiate the SSO from Drupal.
- If you want to add the SSO link to other pages as well, please follow the steps given in the image below:
Need Assistance?
If you face any issues during the configuration or if you want some additional features, please contact us at drupalsupport@xecurify.com.
Additional Features:
- Attribute Mapping - map user’s attributes received from OAuth Provider with Drupal fields
- Role mapping - assign a Drupal Role to users on the basis of their role/attribute on the OAuth provider
- Enable single logout - Logout user from the OAuth Provider (i.e. AWS Cognito, Azure AD B2C, Keycloak, Okta) when they logs out form Drupal
- Restrict anonymous access to the complete site or a particular section of the site
- Add Multiple OAuth Provides
- Explore All the features offered by the OAuth Client
Troubleshooting:
Follow the steps mentioned HERE
Follow the steps mentioned HERE
The logout functionality you’ve mentioned here is the default behavior of a module. It’s logging you out of Drupal but not from your Application/Provider. To allow the module to logout from your provider/application account (what you are looking for), you need to make the below configurations: [know more]
As you have upgraded to one of our paid versions of the Drupal module and replaced the free module with the paid one, you must first activate the paid module. Please refer to the below steps. [Know more]
Need Help? We are right here!
