Drupal Azure AD B2C SSO integration using OAuth / OpenID connect

Overview

Drupal OAuth Client module enables Single Sign-On i.e. SSO for a Drupal site with any Identity Provider using OAuth or OpenID connect protocol. Here we will go through the steps to configure the module with the Azure AD B2C. Once this configuration is done, users will be able to log in to the Drupal site using their Azure B2C credentials.
The integration of Drupal with Azure AD B2C simplifies and secures the login process, completely removing the need to store, remember, and reset multiple passwords.

Playground Schedule a Meeting

Configuration Steps

Configure Drupal as an OAuth Client

• Go to Configuration → People → miniOrange OAuth Client Configuration in the Administration menu. (/admin/config/people/miniorange_oauth_client)

• Under the Configure OAuth tab select desired OAuth Provider from the dropdown.


Note: If the desired OAuth Provider is not listed in the dropdown, please select 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 OAuth provider name in the Display Name text field.

Create SSO Application in Azure AD B2C:

• Log in to the Microsoft Azure portal.
• In the Azure services section, select Azure AD B2C.

• To build a new Azure AD B2C application, navigate to the App registrations under Manage section in the left-hand navigation panel, then click on the New registration button.

• In the Register an application window, enter the necessary information for creating a new application:
• Name: Enter the application's name in the Name text field.
• Supported account types: Select the 3rd option, Accounts in any organizational directory (for authenticating users with user flows). You can also refer to Help me choose option if it is worthwhile.
• From the Select a platform drop-down option, choose 'Web' for the Redirect URI (recommended). Paste the previously copied Callback/Redirect URL into the text field.
• Click on the Register button.

• Azure AD B2C assign a unique Application ID to your application. Copy the Application (client) ID. This is your Client ID.

• Now, then select Certificates and secrets from the left side panel, and then click on New client secret button to generate a client secret.

• 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.

• Click on Azure AD B2C | App registrations link from the top left.

• Navigate to the Overview tab from the left side panel.

• Under Essentials section, copy the Domain name. This will be your Tenant-ID.

Create User Flow Policy in Azure AD B2C

• Go to the Microsoft Azure portal.
• Select User flows from the Policies section.

• Click on the New user flow button.

• Select the Sign up and sign in card/box for user flow in the Create a user flow panel.

• Select the Recommended card/box under Version. Then, click on the Create button.

• Enter the following information in the Create window:
• Enter the Name of the user flow. For instance, B2C_1_ AzureB2CTest. (This cannot be altered once a user flow has been created.)
• Select Email signup under Identity Providers.
• Select the Multifactor authentication option as per your requirement. if you are not sure, keep the default option.
• User attributes and token claims: Select the claims and attributes you wish to collect from the user during the sign-up process. Click the Show more button to reveal additional options. In the Create popup window, ensure that you enable the checkboxes for Email Address (under 'Collect attribute') and Email Addresses (under 'Return claim'). You can also add any other required attributes. Finally, click the Ok button.

• Then, click on Create button to add user flow. (The B2C_1_ prefix is automatically appended to the name.)
• Copy the Name for user flow. (This is your Policy name)

Integrating Drupal with Azure AD B2C:

• 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 Domain name with the {tenant-name} in the Authorize Endpoint and Access Token Endpoint text fields in Drupal's Configure OAuth tab.

• Replace the previously copied Name with the {policy-name} in the Authorize Endpoint and Access Token Endpoint text fields.
• 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.
• Now, click on the Save Configuration button.

Scope:	openid
Authorize Endpoint:	https://{tenant-name}.b2clogin.com/{tenant-name}.onmicrosoft.com/{policy-name}/oauth2/v2.0/authorize
Access Token Endpoint:	https://{tenant-name}.b2clogin.com/{tenant-name}.onmicrosoft.com/{policy-name}/oauth2/v2.0/token

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 for your login to OAuth Provider.

• 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

[MO_CONTACT_US]