SSO Login into Drupal using Microsoft Entra ID as an OAuth / OpenID Connect Provider
Overview
Drupal Microsoft Entra ID SSO integration will allow the users to log in to the Drupal site using the Microsoft Entra ID 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, Drupal 10, and Drupal 11.
In this document, we will help you configure the Single Sign-On login using the OAuth protocol between the Drupal site and the Microsoft Entra ID.
Installation Steps
- Using Composer
- Using Drush
- Manual Installation
Configuration Steps
Setup Drupal as OAuth Client:
- After installing the module, navigate to the Configuration -> miniOrange OAuth Client Configuration -> Configure OAuth tab and select Microsoft Entra ID - Azure AD 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, Azure.
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.
Create SSO Application in Microsoft Entra ID:
- Log in to the Microsoft Azure portal.
- Select App registrations from the Azure services section.
- Now, click on the + New registration button.
- In the Register an application window, enter the following information:
- Name: Enter the Application name.
- Supported account types: Select the 1st option, Accounts in this organizational directory only (Test only - Single tenant). You can refer the Help me choose link.
- Redirect URI (optional): Select Web from the Select a platform dropdown list. Then, in the text field, paste the previously copied Callback/Redirect URL.
- Click on the Register button.
- Microsoft Entra ID assign a unique Application ID to your application. Copy the Application (client) ID. This is your Client ID.
- Now, click on the Add a certificate or secret link.
- Click on the New client secret button. In the Add a client secret popup, enter the required information:
- Description: Enter the description for this Secret.
- Expires: Select an expiry duration for this Secret from the dropdown.
- Click on the Add button.
- Copy the Value from the Client secrets tab. This is Client Secret.
- Navigate to the Overview from the left side panel.
- Under Essentials section, copy the Directory (tenant) ID. This will be your Tenant-ID.
Integrating Drupal with Microsoft Entra ID:
- Go to miniOrange OAuth Client module.
- In Configure OAuth tab, Paste the copied Application (client) ID and Client Secret from Microsoft Entra ID into the Client ID and Client Secret text field
- Replace the previously copied Directory (tenant) ID with the {tenant-id} in the Authorize Endpoint and Access Token Endpoint text fields, respectively.
Scope | openid email profile |
Authorize Endpoint: | https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/authorize |
Access Token Endpoint: | https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/token |
Get User Info Endpoint: | https://graph.microsoft.com/oidc/userinfo |
- Click on the Save Configuration button.
Test Connection between Drupal and Microsoft Entra ID
- After successfully saving the configurations, please click on the Perform Test Configuration button to test the connection between Drupal and Microsoft Entra ID.
- On a Test Configuration popup, if you don't have an active session in Microsoft Entra ID on the same browser, you'll be prompted to sign in to Microsoft Entra ID. Once successfully logged in, you'll receive a list of attributes retrieved from Microsoft Entra ID.
- Select the Email Attribute from the dropdown menu in which the user's email ID is obtained and click on the Done button.
- Once clicked on Done button, you will be redirected to the Attribute & Role Mapping tab, in which you can select the Username Attribute from the dropdown list and click on Save Configuration button.
Note: Mapping the Email Attribute is mandatory for your login to work.
Congratulations! You have successfully configured AWS Cognito as OAuth/OpenID Provider and Drupal as an OAuth Client.
How to perform the SSO?
- Open a new browser/private window and navigate to the Drupal site login page.
- Click on the Login using Azure link to initiate the SSO from Drupal.
- If you want to add the SSO link on other pages, 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]
[MO_CONTACT_US]