Configure Google As An OAuth Server For Drupal

miniOrange OAuth/OpenID module for Drupal gives the ability to enable OAuth/OpenID Single Sign On for your Drupal site. The Drupal OAuth Client module is compatible with all the OAuth/OpenID Providers. Here we will go through a guide to configure SSO between Drupal and Google Apps. By the end of this guide, Google apps users should be able to login and register to your Drupal site.
If you have any doubts or queries you can contact us at drupalsupport@xecurify.com. We will help you to configure the module.

Step 1: Configure Google Apps as an OAuth Server

  • Go to https://console.developers.google.com/ and Sign up/Login.
  • Client_sso_google sign up/login
  • Click on Select Project.
  • Client_sso_Google Apps Project
  • Click on NEW PROJECT button to create a new project or else select one from the existing projects.
  • Client_sso_ create a new project
  • Enter your Project name under the Project Name field.
  • Client_sso_ Project Name field
  • Now, again click on Select Project (highlighted in the image below) and select the newly created Project by clicking on the project name that you entered in the previous step.
  • Client_sso_ Select a Project
  • Click on ENABLE APIS AND SERVICES to enable Google PLUS API.
  • Client_sso_ ENABLE APIS AND SERVICES
  • Search for Google PLUS API in the search bar and click on Google+ API from the search results.
  • Client_sso_Google PLUS API
  • Click on the ENABLE option to enable Google+ API.
  • Client_sso_ ENABLE option
  • Go to Navigation Menu->APIs & Services-> Credentials.
  • Client_sso_ Navigation Menu
  • Click on Create Credentials button and then select OAuth Client ID from the options provided.
  • Client_sso_Create Credentials
  • In case you are facing some warning saying that To create an OAuth Client ID, you must first set a product name on the consent screen (as shown in below image). Click on the Configure Consent Screen button.
  • Client_sso_Configure consent screen
  • Enter your application name under the Application Name Shown to Users field. Click on the Save button to save your settings.
  • Client_sso_ product name
  • Select Web Application from the options below Application Type. Enter the name you want for your Client under the Name field and enter the Redirect/Callback URI from miniOrange OAuth Client module under the Authorized redirect URIs field.
  • Client_sso_ Redirect/Callback URI
  • Click on the Create button to save your configurations.
  • Copy your Client ID and Client Secret and save it on your miniOrange OAuth Client module Configuration.
  • Client_sso_ Client ID and Client Secret
  • Google apps Endpoints and scope:
  • Client ID : from the step above
    Client Secret : from the step above
    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

Step 2: Configure miniOrange Drupal OAuth Client module.

  • Login in your Drupal site’s admin console and click on Extend from the top navigation bar.
  • Select the Install new module option to install a new module on your Drupal site.
  • Drupal OAuth Client module - Install
  • Upload the downloaded zip file of the Module and click on the Install button to continue.
  • Drupal OAuth Client module - Upload
  • Select Enable newly added modules.
  • Drupal OAuth Client module - Update manager
  • Scroll down till you find miniOrange OAuth Client. Click on the checkbox next to it and click on the Install button to enable the module.
  • Drupal OAuth Client module - Enable module
  • Click on Configuration from the top navigation bar and Select Drupal OAuth client Configuration.
  • Drupal OAuth Client - Configuration
  • Click on the Configure OAuth Client tab and select your OAuth Provider from the Select Application dropdown. In case you do not find your OAuth Provider listed in the dropdown, please select Custom OAuth Provider and continue.
  • Drupal OAuth Client - Configure module
  • Enter your OAuth Provider information in their respective fields and click on the Save button to continue. Also, copy the Callback/Redirect URL and save it on your OAuth Provider.
  • Drupal OAuth Client - Configure OAuth tab
  • Now click on the Test Configuration option. This Test Configuration link will give you the list of the attributes that are coming from your OAuth Provider.
  • Copy the email and the name attributes and save them under the Attribute & Role Mapping tab in the Email Attribute and Name Attribute text field respectively.
  • Please note: This step is mandatory for your login to work. Click on the Save button on the bottom of the page to save your attribute configurations.

    Drupal OAuth Client Attribute Mapping
  • If your OAuth Provider supports only HTTPS Root URL or Base URL (for eg. Azure, Azure B2C) you can change it under Sign In Settings tab.
  • Drupal OAuth Client Redirect URL
  • Now logout and go to your Drupal site’s login page, you will automatically find a Login withYour OAuth Provider link there. If you want to add your login link to other pages as well, please follow the steps given in the below image:
  • Drupal OAuth Client login link
  • If you want to check out our complete list of features and our various licensing plans, you can go to the Upgrade Plan tab in the module.
  • If you want to purchase any of the paid version of the module, you have to register/login with us in Register/Login tab.
  • Still, if you are facing any difficulty or if you have any questions in mind, you can reach out to us by submitting a query in the Support tab of a module or by sending us a mail at info@xecurify.com.
  • Congratulations, you have successfully configured the miniOrange Drupal OAuth Client module.