How to configure OpenID Connect (OIDC) / OAuth Client Single Sign On (SSO) login module?
How to configure OpenID Connect (OIDC) / OAuth Client Single Sign On (SSO) login module?
You can enable Single Sign-on (SSO) in your Drupal site using our OAuth/OIDC SSO module and connect it to any OAuth Provider. See our integration guides with the most popular OAuth/OpenID Providers like (Azure AD, Azure B2C, Keycloak, Okta, Salesforce, Google, AWS Cognito, OAuth0, Apple, Microsoft Office 365, Github, Gitlab, Discord, Pingfedrate, Slack, LinkedIn, Facebook, Instagram, Ping Identity, FusionAuth, Delegate OAuth, WSO2 Identity Server, cloudfoundry, Bitbucket, Fitbit, Onelogin, WildApricot, WHMCS and many more). We provide Drupal OAuth/OpenID Connect SSO login module which is compatible with Drupal 7, Drupal 8, and as well as Drupal 9.
If you have any doubts or queries, you can contact us at drupalsupport@xecurify.com. We will help you to configure the module. If you want, we can also schedule an online meeting to help you configure the Drupal OpenID/OAuth 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
1. Setup Drupal as OAuth Client
- After installing the module, go to the Configuration tab and click on the miniOrange OAuth Client Configuration module link.
- In the Configure OAuth tab, select OAuth Provider from the Select Application dropdown list.
- Copy the Callback URL from the Callback / Redirect URL text field and keep it handy.
- Enter the application name in the Display Name text field. For example, Azure, Facebook, Discord, Google etc
- Go to the Sign In Settings tab.
- In the Base /Site URL text field, enter your Drupal site’s base/root URL with HTTPS ( For eg. if your site is http://abc.com, you will need to save this value: https://abc.com ).
- Click on the Update button.
Note: In case you do not find your OAuth Provider listed in the dropdown, please select Custom OAuth Provider and continue.
Please note: A few of the popular service providers like Azure AD, Azure B2C, Facebook etc. support only HTTPS Callback URL (However, HTTP URL will work in the case of localhost). So, currently, if your site is HTTP, you can change it to HTTPS by following the steps listed down below :
2. Integarting Drupal with OAuth Provider
- Your OAuth Provider assign a unique Application ID to your Application. Copy the Client ID & Client Secret and Keep it handy.
- In Drupal’s Configure OAuth tab and paste the copied Client ID and Client Secret (copied from the OAuth Provider Portal) in the Client ID and Client Secret text-field.
- These information are required to configure your Drupal OIDC/OAuth Client module:
| Client ID : | These Information provide your OAuth Provider like (Azure AD, Azure B2C, Facebook) |
| Client Secret : | These Information provide your OAuth Provider like (Azure AD, Azure B2C, Facebook) |
| Scope: | Copy and Paste the information from your OAuth/OpenID Provider |
| Authorize Endpoint: | Copy and Paste the information from your OAuth/OpenID Provider |
| Access Token Endpoint: | Copy and Paste the information from your OAuth/OpenID Provider |
| Get User Info Endpoint: | Copy and Paste the information from your OAuth/OpenID Provider |
3. SSO Test Configuration
- After successfully saving the configurations, click on the Perform Test Configuration button to test the connection between Drupal and OAuth/OIDC Provider.
- This Test Configuration window will provide you with a list of the attributes that are coming from the OAuth/OpenID Provider
- 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 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 :
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 login - OAuth2 Client SSO module.
Additional Resources
- What is OAuth 2.0?
- What is OpenID Connect?
- What is OAuth 2.0 Authorization Code Grant?
- What is OAuth 2.0 Impicit Grant?
- What is OAuth 2.0 Password Grant?
- Frequently Asked Questions (FAQs)
Our Other modules
Need Help? We are right here!
