SSO Login into Drupal using Office 365 as OAuth / OpenID Connect Provider
SSO Login into Drupal using Office 365 as OAuth / OpenID Connect Provider
Drupal OAuth/OpenID Connect SSO integration enables SSO between the Drupal site and Office 365. This setup guide helps in configuring Single Sign-On (SSO) between the Drupal site and Office 365 using the OAuth/OpenID Connect module. When you incorporate the OAuth/OpenID Connect module with the Drupal site, you can log into the Drupal site seamlessly with Office 365 credentials. This module is compatible with Drupal 7, Drupal 8, Drupal 9, and Drupal 10.
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
Set up Drupal as OAuth Client:
- After installing the module, navigate to the Configuration -> miniOrange OAuth Client Configuration -> Configure OAuth tab.
- Select Custom OAuth 2.0 Provider from the Select Application dropdown.
- Copy the Callback/Redirect URL and keep it handy.
- Enter Office365 in the Display Name text field.
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 OAuth/OpenID SSO Application in Microsoft Office 365:
- Log in/Sign up for the Microsoft Office 365 Admin console.
- Go to the Azure services section and select Azure Active Directory service.
- Navigate to the App registration -> New registration from the left navigation menu.
- Enter the following information on the Register an Application page:
- Enter the display name for the application in Name text field.
- Supported account types: Select Accounts in this organizational directory only (Test only - Single tenant). If you are unsure which option to select, click on the Help me choose link.
- Redirect URI (optional): Select a Platform as Web. Paste the copied Callback/Redirect URL into the Redirect URI text field.
- Click on the Register button to create the new application.
Integrating Drupal with Office 365:
- Copy the Application (client) ID from the Microsoft Office portal.
- Go to Drupal's Configure OAuth and paste the copied Application ID into the Client ID text field.
- On the Microsoft Office portal, click on Add a certificate or secret under the Essentials section.
- Click on the New client secret button.
- Provide the required information on the Add a client secret window:
- Enter a Description for this client secret
- Select Expires duration from the dropdown.
- Click on the Add button.
- Then, copy the Value from the Client secrets tab. It's your app’s Client Secret key.
- Go to Drupal's Configure OAuth tab and paste the copied Client secrets Value into the Client Secret text field.
- Go to the Microsoft Office 365 portal, navigate to the API permissions -> Add a permission -> Microsoft APIs -> Office 365 Management APIs -> Application permissions.
- Select desired Permissions and click on the Add permissions button.
- Navigate to the Overview and click on Endpoints button.
- Copy the OAuth 2.0 authorization endpoint (v2) & OAuth 2.0 token endpoint (v2).
- Navigate to Drupal’s Configure OAuth tab and paste the authorization endpoint and token endpoint into the respective test fields.
- Click on Save Configuration button.
You can also refer the Office 365 Endpoints and Scope in the table below:
| Scope | openid |
| 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 |
Test connection between Drupal and Office 365:
- After successfully saving the configurations, click on the Perform Test Configuration button to test the connection between Drupal and Office 365.
- On a Test Configuration popup, if you don't have any active session in Office 365 on the same browser, you will be asked to login into the Office 365. Once you are successfully logged into the Office 365, you will be provided with a list of the attributes that are received from the Office 365.
- Select the Email Attribute from the dropdown menu in which the user's email ID is obtained and click on the Done button.
- After clicking on Done button, you will be redirected to the Attribute & Role Mapping tab, in which you can also choose the Username Attribute from the drop-down and click on the Save Configuration button.
Please note: Mapping the Email Attribute is mandatory for Login.
Congratulations! You have successfully configured Office 365 (O365) as an OAuth 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 with Office365 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:
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]
Frequently Asked Questions (FAQ)
Case Studies
miniOrange has successfully catered to the use cases of 400+ trusted customers with its highly
flexible/customizable Drupal solutions. Feel free to check out some of our unique case studies using
this link.
Other Solutions
Feel free to explore other Drupal solutions that we offer here. The
popular solutions used by our trusted customers include Two Factor Authentication - 2FA, Website
Security, REST & JSON API Authentication, User Provisioning and Sync.
24*7 Active 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 to deploying and maintaining the solution.
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!
