Single Sign-On (SSO) Login into Drupal using Custom OAuth 2.0 / OpenID connect Provider
Overview
Drupal OAuth 2.0 / OpenID Connect (OIDC) SSO integration enables SSO between the Drupal site and any Identity Provider. This Integration is achieved by the miniOrange OAuth Client module which is compatible with Drupal 7, Drupal 8, Drupal 9, Drupal 10 as well as Drupal 11.
The module allows an external OpenID Connect login provider to authenticate and login users to the Drupal site. Check out the integration steps with some popular OAuth / OpenID providers like Azure AD, Azure AD B2C, Keycloak, Okta, Salesforce, Active Directory Federation Services (AD FS), AWS Cognito, Auth0, Microsoft Office 365, Github, Gitlab, OneLogin, Ping Identity, FusionAuth, WSO2 Identity Server, Bitbucket, Fitbit, Gluu, Onelogin, WildApricot, WHMCS, ForgeRock Identity Platform and many more.
The module is also compatible with social login providers such as Google, Discord, Slack, LinkedIn, Facebook,
Instagram, Apple, Amazon, Yahoo, Pinterest, Snapchat, and Twitter (X).
In this document, we will go through the steps to configure the module:
Installation Steps
- Using Composer
- Using Drush
- Manual Installation
Configuration Steps
Setup Drupal as OAuth Client:
- After installing the module, go to the Configuration tab and click on the miniOrange OAuth Client Configuration -> Configure OAuth tab and select the application from the Select Application dropdown list.
- Copy the Callback/Redirect URL and keep it handy. This will be required while configuring the Identity Provider.
- Enter the name in the Custom App Name text field. For example, Generic OAuth
Note: In case the desired OAuth Provider is not listed in the dropdown, please select Custom OAuth/ Custom OAuth Provider / Custom OpenID Provider and continue.
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.
Integrating Drupal with Identity Provider:
- Configure the callback/redirect URL in your IdP and complete the further steps.
- Add the below details on the Drupal site (You will get these all from the Identity provider).
| Client ID | Unique identifier for the OAuth 2 client application. |
| Client Secret | Confidential information used to authenticate the client. |
| Scope | The extent of access that the client is requesting from the user and authorization server. |
| Authorize Endpoint: | URL where the user is authenticated and grants permissions to the client. |
| Access Token Endpoint: | URL where the client exchanges authorization code for an access token. |
| Get User Info Endpoint: | Optional URL for retrieving user information |
- 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.
Test Connection between Drupal and Identity Provider:
- Click on the Perform Test Configuration button.
- On a Test Configuration popup, if you don't have an active session on IdP on the same browser, you'll be prompted to sign in to Identity Provider (IdP). Once successfully logged in, you'll receive a list of attributes retrieved from the IdP.
- Select the Email Attribute from the dropdown menu in which the user's email ID is obtained and click on the Done button.
- Once click on the Done button, you will be redirected to the Attribute & Role Mapping tab. Now, you can also choose the Username Attribute from the dropdown and click on the Save Configuration button.
Note: Mapping the Email Attribute is mandatory for Login.
Congratulations! You have successfully configured 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 {Identity Provider Name} 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:
Troubleshooting:
More FAQs ➔Getting error: 'Username not received. Check your
Attribute Mapping configuration.' OR Getting Error: 'Email not received. Check your Attribute Mapping
configuration.' 
Follow the steps mentioned HERE
I am getting "Client Credentials were not found in
the headers or body"
when I try to perform test configuration
Follow the steps mentioned HERE
After I click on the logout in Drupal, it sends me back to
the Drupal homepage. However, when I try to login with other user, it doesn't ask me to login but
automatically logs me in with same user
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]
I purchased the paid Drupal module and replaced it with
the free module, but still I am not able to use paid features.
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]
Contact us
