Setup Office 365 Single Sign-on with Drupal OAuth Client
Overview
Drupal miniOrange SSO integration will allow you to configure Single Sign-On ( SSO ) login between your Drupal site and Office 365 using OAuth/OpenID protocol. Drupal OAuth 2.0/OpenID connect module gives the ability to enable login using OAuth 2.0/OIDC Single Sign-On to Drupal Site. We provide the Drupal OAuth/OpenID Client module for Drupal 7, Drupal 8, Drupal 9 and Drupal 10, Drupal 11.
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 Custom OAuth 2.0 Provider from the Select Application dropdown list.
- Copy the Callback/Redirect URL and keep it handy.
- Enter the application name in the Display Name text field. For example, Office 365.
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 Application in 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 Configuration of Drupal with 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.
Note: Mapping the Email Attribute is mandatory for your login to work.
- Now log out and go to your Drupal site’s login page. You will automatically find a Login with Office365 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:
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]