Google Apps Single Sign-On SSO Magento Setup Guide with OAuth OpenID Connect

Google Apps Single Sign-On SSO Magento Setup Guide with OAuth OpenID Connect


Integration of Google Apps Login ( Google Apps SSO ) with Magento using OAuth 2.0 Protocol. The Magento OAuth / OpenID Connect Single Sign-On (SSO) plugin makes it easy to use OAuth2 to set up Google Apps Login on Magento (Google Apps Single Sign on).

The plugin can be set up using other Social Media sources, as well as custom OAuth and OIDC providers. It contains a lot of Single Sign-On (SSO) features, like Attribute Mapping for user profiles, Role Mapping, and so on. In this guide, we'll go over how to set up SSO between Magento and Google Apps. At the end of this guide, users should be able to log into Magento using Google Apps. Click here to read more about the Magento OAuth Single Sign-On (OAuth & OpenID Connect Client) plugin's extra features.

The Magento OAuth & OpenID Connect Single Sign-On (SSO) plugin makes it possible to log into Magento securely using Google Apps as an OAuth and OpenID Connect provider. You can also use alternative Oauth providers, such as Azure AD, Azure B2C, Office 365, and other custom providers, to configure the plugin. Advanced Single Sign-On features such as user profile Attribute Mapping, Role Mapping, and so on are supported. We'll go over how to set up SSO between Magento and Google Apps in this article. Users should be able to log in to Magento through Google Apps by the end of this guide.

Click here to know more about other features we provide in Magento OAuth Single Sign-On ( OAuth & OpenID Connect Client ) plugin

Pre-requisites : Download And Installation

  • You can download the miniOrange OAuth OpenID Connect SSO Free plugin from the Magento Marketplace.
  • Select Your Magento Store version from the Dropdown.
  • Click on Add to cart.
  • Go to the cart and checkout to buy the plugin.
  • Click on Download and save the miniOrange OAuth OpenID Connect SSO Plugin zip.
  • Unzip all contents of the zip inside the MiniOrange/OAuth directory.
  • {Root Directory of Magento} app code MiniOrange OAuth

  • Run the following commands on command prompt to enable the plugin
  •       1. php bin/magento setup:upgrade
          2. php bin/magento setup:di:compile

Magento OAuth OpenID Connect SSO extension allows login (Single Sign-On) into Magento with your Azure AD, Azure B2C, AWS Cognito, WSO2, Okta, LinkedIn, Google, Facebook, Slack, Discord or other custom OAuth 2.0 providers [24/7 SUPPORT]

 Tested with 2.4.4

Steps to configure Google Apps OAuth & OpenID Single Sign-On (SSO) Login into Magento

1. Setup Google Apps as OAuth Provider

Follow the steps below to configure Google Apps as OAuth Provider

miniorange img Configure Google Apps as OAuth Provider
  • Go to https://console.developers.google.com/ and sign up/login.
  • Click on Select Project to create a new Google Apps Project for Magento Oauth Client, you will see a popup with the list of all your projects.
  • Google Apps G Suite SSO Magento create new project
  • Click on the New project button to create new project.
  • Google Apps G Suite SSO Magento create new project
  • Enter your Project Name in project name field and click on Create.
  •  G Suite SSO with Magento OIDC OAuth, Google Apps SSO for Magento, enter project name
  • Go to Navigation MenuAPIsServicesCredentials.
  •  G Suite SSO with Magento OIDC OAuth, Google Apps SSO for Magento, credentials
  • Click on Create Credentials button and then select OAuth Client ID from the options provided in the dropdown menu.
  •  G Suite SSO with Magento OIDC OAuth, Google Apps SSO for Magento, OAuth client id
  • Choose how you want to configure and register your app (User Type) and click on create button.
  • Google Apps GSuite SSO Magento configure consent screen
  • In case you are facing some warning saying that in order to create an OAuth Client ID, you must set a product name on consent screen (as shown in below image). Click on the Configure consent screen button.
  •  G Suite SSO with Magento OIDC OAuth, Google Apps SSO for Magento, configure consent screen
  • Fill up the required information, such as the App Name and User Support Email. and then select the Save and Continue option.
  •  G Suite SSO with Magento OIDC OAuth, Google Apps SSO for Magento, save settings  G Suite SSO with Magento OIDC OAuth, Google Apps SSO for Magento, save settings
  • Now for configuring scopes, click on Add or Remove the Scopes button.
  •  G Suite SSO with Magento OIDC OAuth, Google Apps SSO for Magento, create oauth client id
  • Now, Select the Scopes to allow your project to access specific types of private user data from their Google Account and click on Save and Continue button.
  •  G Suite SSO with Magento OIDC OAuth, Google Apps SSO for Magento, create oauth client id
  • Go to the Credentials tab and click on Create Credentials button. Select Web Application from dropdown list to create new application.
  •  G Suite SSO with Magento OIDC OAuth, Google Apps SSO for Magento, create oauth client id
  • Enter the name you want for your Client ID under the name field and enter the Redirect/Callback URI from Magento OAuth and OpenID Single Sign On (SSO) plugin under the Authorized redirect URIs field and click on Create button.
  •  G Suite SSO with Magento OIDC OAuth, Google Apps SSO for Magento, redirect URL
  • You will see a popup with the Client ID and Client Secret Copy your Client ID and Client Secret and save it on your Magento OAuth and OpenID Single Sign On (SSO) plugin Configuration.
  •  G Suite SSO with Magento OIDC OAuth, Google Apps SSO for Magento, client id client secret

You have successfully configured Google Apps as OAuth Provider for achieving Google Apps Single Sign-On (SSO) with Magento for user authentication.

2. Configuring Magento 2 as OAuth Client

  • After successfully configuring OAuth Provider, go to OAuth Provider tab and configure OAuth Provider Name, Client ID, Client Secret, Scope and provided endpoints. (You can copy these values in STEP 2 from the application dashboard.)

    Please refer below Endpoints to configure the OAuth client


    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
  • Click on the Save button to save the settings.
  • Click on the Test Configuration button.
  • Magento 2 OAuth credentials Google apps SSO OAuth
  • You will see all the values returned by your OAuth Provider to Magento in a table. If you don't see value for First Name, Last Name, Email or Username, make the required settings in your OAuth Provider to return this information.
  • The miniOrange Premium Plugin also provides you the the feature to auto redirect your user to the IdP Login Page.
  • Magento 2 OAuth auto redirect to idp
  • Go to the Sign In Settings tab and check options to enable SSO on your Magento site.
  • Magento 2 OAuth enable SSO
  • You have successfully configured your Magento 2 as an OAuth Client. You will see the SSO button on your frontend. Click on the button and test the SSO.
  • Magento 2 OAuth SSO Google apps SSO Google apps magento SSO magento 2 OAuth client SSO Google apps SSO

3: Attribute / Custom Mapping (Optional). *This is Premium feature.

  • You can map attributes in the Attribute Mapping tab. Only username and email are allowed to be mapped in free version of the plugin. However, in the premium version of the plugin, you can map various attributes coming from your OAuth Provider to the attributes present in your Magento site.
  • Magento 2 OAuth attribute mapping

4: Role Mapping (Optional). *This is Premium feature.

  • You can specify a default role in the free plugin that will be allocated to all non-admin users when they conduct SSO.
  • Go to Attribute/Role mapping tab and navigate to Role Mapping section.
  • Select the Default Role and click on the Save button.
  • Google apps Magento SSO - Google apps Single Sign-On(SSO) Login in Magento - role mapping

By configuring Google Apps as an OAuth Provider and Magento as an OAuth Client using our Magento OAuth Client plugin, you have successfully installed Magento Google Apps Single Sign-On (SSO). Within minutes, you'll be able to provide safe access to your Magento site utilising Google Apps login credentials thanks to this solution.

Additional Resources


If you are looking for anything which you cannot find, please drop us an email on magentosupport@xecurify.com

Hello there!

Need Help? We are right here!

support
Contact miniOrange Support
success

Thanks for your inquiry.

If you dont hear from us within 24 hours, please feel free to send a follow up email to info@xecurify.com