Google Drupal SSO Login integration using OAuth / OpenID connect

Overview

Google Drupal OAuth / OpenID Connect integration enables SSO between the Drupal site and Google. This setup guide helps in configuring Single Sign-On (SSO) between the Drupal site and Google using the OAuth/OpenID Connect module. This module is compatible with Drupal 7, Drupal 8, Drupal 9, Drupal 10, and Drupal 11. When you incorporate the OAuth / OpenID Connect module with the Drupal site, you can log into the Drupal site seamlessly with the Google credentials.

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.

Configure SSO Application in Google:

• Log in to the Google Developer Administrator console.
• Select a project from the left side's top header.

• On the Select a project popup, click on the NEW PROJECT button to create a new project or choose one of the current ones to continue.

• In the New Project panel, enter the following information:
• Enter the name of your project into the Project name text field.
• Click on CREATE button to create the project.

• From the left navigation panel, click on Credentials.

• Click the CREATE CREDENTIALS button, and select OAuth client ID from the list of options.

• If you get a warning that says, To create an OAuth Client ID, you must first set a product name on the consent screen (as shown in the image below), ignore it. Click on the CONFIGURE CONSENT SCREEN button.

• On the OAuth consent screen window, choose how you want to configure and register your app, select the User Type and click on CREATE button.

• Enter the following information in the Edit app registration window:
• In the App name text field, enter the name of the application.
• Enter your email address in the User support email text field so that people can contact you with queries concerning their consent.
• In the Developer contact information text field, type in the email address. (Its email addresses are essential for Google to notify you of any changes to your project.)

• Then, click on SAVE AND CONTINUE button.
• On the Scopes screen, click on the ADD OR REMOVE SCOPES button.

• Select Scopes to grant your project access to specific types of user information from their Google Account, then scroll down and click on UPDATE button.

• After you've finished adding scopes, click on the SAVE AND CONTINUE option.

• Then, from the left side panel, select the Credentials tab and click the + CREATE CREDENTIALS button.

• When you click the CREATE CREDENTIALS button and choose the OAuth client ID from the drop-down menu.

• Enter the following information in the Create OAuth client ID window:
• Choose Web application from the Application type dropdown menu.
• Name: Enter the Name of your OAuth 2.0 client. (This name is just used to identify the client in the console.)
• Authorised redirect URIs: Click the ADD URI button and paste the previously copied Callback/Redirect URL from Drupal into the text field.

• Then, click on CREATE button.
• From the popup copy the Client ID and Client Secret. Keep it handy. It will require to configure Drupal as OAuth client.

Integrating Drupal with Google:

• Go to miniOrange OAuth Client module.
• In Drupal’s Configure OAuth tab paste the copied Client ID and Client Secret from Google in the Client ID and Client Secret text fields.

• Confirm the Scope and Endpoints from the table below and click on the Save Configuration button.

Scope	email+profile
Authorize EndPoint	https://accounts.google.com/o/oauth2/auth
Access Token Endpoint	https://www.googleapis.com/oauth2/v4/token
Get User Info Endpoint	https://www.googleapis.com/oauth2/v1/userinfo

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 to perform SSO i.e. login to the Drupal site with OAuth Provider credentials.

• 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