Joomla OAuth Client Integration with Google Apps Single Sign-On (SSO)

Overview

Streamline your Joomla user experience with seamless Google Apps Single Sign-on (G Suite SSO) integration using the powerful OAuth 2.0 Protocol. With the miniOrange Joomla OAuth / OpenID Connect Single Sign-on (SSO) plugin, setting up Google Apps SSO into Joomla becomes effortless, ensuring a secure login process. This allows users to access the Joomla site easily and securely by authenticating with their Google Apps OAuth Provider credentials. The Google Apps OAuth Joomla plugin also provides advanced features such as, Auto create users, Attribute Mapping, Group Mapping etc. Visit our Joomla OAuth Client Plugin page to learn more about the features and pricing plans we offer for the Joomla OAuth Single Sign-on (OAuth & OpenID connect) plugin.

To setup OAuth Single Sign-On between Joomla and Google Apps, you can also follow this step by step Setup Video.

Configuration Steps

In this configuration, Google Apps functions as the OAuth server, while Joomla allows users to log in with their Google Apps credentials by utilizing the Joomla OAuth Client Plugin.

Step 1: Install Joomla OAuth Client Plugin

Login into your Joomla site’s Administrator console.
From left toggle menu, click on System, then under Install section click on Extensions.
Now click on Or Browse for file button to locate and install the plugin file downloaded earlier.
Installation of plugin is successful. Now click on Get Started!
Under Configure OAuth -> Pre-Configured Apps tab, select your OAuth Provider. You can also configure your own custom provider, by navigating to the Custom Application tab.

After selecting your OAuth provider, copy the Callback/Redirect URL which we will use to configure the OAuth Server, then click on the Save & Next button.

Step 2: Configure Google Apps as OAuth Server

Go to Google Apps Console and Sign Up/Login into your Dashboard. Here, Click on the Select Project button.

Click on New Project to create a new Google Apps Project for Joomla OAuth Client.

Enter the Project name in the given field and click on the Create button. After the project is created you may have to select the newly created project from the Project Picker (The Select Project button).

Now click on the APIs & Services button from the Quick Access section. You can also find the APIs & Services button in the sidebar.

Now click on Credentials button in the sidebar.

Now click on Configure consent screen button. Then. click on the Get started button.

Now enter the App information, select the Target Audience, enter Contact Information, and agree to the Terms & Conditions. Then, click on the Create button.

Now go to the Data Access tab.

Here, click on the Add or remove scopes button. And select the scopes you want the project to access. Then, click on the Update button.

Now, go to the Client tab from the sidebar. Then, click on the Create Client button.

Here select Web application from the dropdown. Then enter the App Name and enter the redirect URI we copied earlier in Step 1. Then, click on the Create button.

Now copy the Client ID & Client Secret. You can also download the JSON file and store it for backup.

Step 3: Configure Client ID & Secret

Go back to your Joomla Dashboard. Then go to Step 2 in the Configure OAuth tab.
Enter the Client ID, Client Secret and Scope in the given fields. Also Set Client Credentials In Header and Body then click on Save Settings. Once Settings are saved then click on Save Configuration.

Scope & Endpoints are given below, which are required for configuring Joomla as OAuth Client plugin to configure Google Apps as a custom OAuth or OIDC provider.

Scope	openid 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
Set Client Credentials	In Both (In Header and In Body)

Step 4: Configure Attribute Mapping

User Attribute Mapping is mandatory for enabling users to successfully login into Joomla. We will be setting up user profile attributes for Joomla using below settings.
Go to Step 3 in the Configure OAuth tab and click on Test Configuration button.

You will be able to see the attributes in the Test Configuration output as follows.

Now select the attribute name for Email and Username from dropdown. Then click on Finish Configuration button.

Step 5: Setup Login/SSO URL

Now go to Step 4, here copy the Login/SSO URL and add it to your Site.

Now logout and go to your Joomla site's pages where you have added this link. You will see a login link where you placed that button. Click on this button to perform SSO.

Contents