Step By Step Guide To Configure Google As An OAuth Server For Drupal 8

Step 1: Configure Google Apps as an OAuth Server

  • Go to https://console.developers.google.com/ and Sign up/Login.
  • google sign up/login
  • Click on Select Project.
  • Google Apps Project
  • Click on NEW PROJECT button to create a new project or else select one from the existing projects.
  •  create a new project
  • Enter your Project name under the Project Name field.
  •  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.
  •  Select a Project
  • Click on ENABLE APIS AND SERVICES to enable Google PLUS API.
  •  ENABLE APIS AND SERVICES
  • Search for Google PLUS API in the search bar and click on Google+ API from the search results.
  • Google PLUS API
  • Click on the ENABLE option to enable Google+ API.
  •  ENABLE option
  • Go to Navigation Menu->APIs & Services-> Credentials.
  •  Navigation Menu
  • Click on Create Credentials button and then select OAuth Client ID from the options provided.
  • 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.
  • Configure consent screen
  • Enter your application name under the Application Name Shown to Users field. Click on the Save button to save your settings.
  •  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.
  •  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 ID and Client Secret

    Congratulations, you have successfully completed your Google App OAuth Server side configurations.

Step 2: Configure miniOrange Drupal 8 OAuth Client module.

  • Click on the link here to download the miniOrange OAuth Client module.
  • Scroll down and download module by clicking in the zip option under Downloads.
  • Drupal go to link
  • Login in your Drupal 8 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 8 site.
  • Drupal install module
  • Upload the downloaded zip file of the Module and click on the Install button to continue.
  • Select Enable newly added modules.
  • Drupal install module
  • 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 navigation bar
  • Click on Configuration from the top navigation bar and Select Drupal OAuth client Configuration.
  • Drupal configuration page
  • Register/Login to your miniOrange account.
  • Drupal register login
  • 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 click on save
  • 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 test configuration
  • 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.
  • Drupal test configuration
  • 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 click on save
  • Now logout and go to your Drupal 8 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 logout
  • If you want to check out our complete list of features and our various licensing plans, you can go to the Licensing Plan tab in the module.
  • 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@miniorange.com.
  • Congratulations, you have successfully configured the miniOrange Drupal 8 OAuth Client module.