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:

Playground Schedule a Meeting

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.




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.



• Copy the Callback/Redirect URL and keep it handy. This will be required while configuring the OAuth Provider.






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 name in the Custom App Name text field. For example, Generic OAuth

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 OAuth 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 OAuth Provider

• After successfully saving the configurations, please click on the Perform Test Configuration button to test the connection between Drupal and OAuth Provider.

• On a Test Configuration popup, if you don't have any active sessions on the same browser, you will be requested to login to the OAuth Provider. After successfully logging, you will be provided a list of attributes received from the OAuth Provider.
• Select the Email Attribute from the dropdown menu in which the user's email ID is obtained and click on the Done button.


Note: Mapping the Email Attribute is mandatory to perform SSO i.e. login to the Drupal site with OAuth Provider credentials.

• On the Attribute & Role Mapping tab, please select the Username Attribute from the dropdown list 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 OAuth Provider link there. 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:

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]

24/7 Support

The Drupal developers at miniOrange offer quick and active support for your queries. We can assist you from choosing the best solution for your use case.

 Contact us

Case Studies

miniOrange has successfully catered to the use cases of 400+ trusted customers with its highly flexible/customizable Drupal solutions.

 Read more

Other Solutions

Feel free to explore other Drupal solutions that we offer the popular solutions used by our trusted customers include 2FA, User Provisioning, Website Security.

 Know More