nopCommerce SAML Single Sign-On (SSO) using Google Apps as IDP


nopCommerce SAML Single Sign-On (SSO) plugin gives the ability to enable SAML Single Sign-On for your nopCommerce applications. Using Single Sign-On you can use only one password to access your nopCommerce application and services. Our plugin is compatible with all the SAML compliant identity providers. Here we will go through a step-by-step guide to configure Single Sign-On (SSO) between nopCommerce and Google Apps considering Google Apps as IdP. To know more about the features we provide for nopCommerce SSO, click here.

Pre-requisites : Download And Installation

    Download from nopCommerce Dashboard
  • To download the plugin zip, login as admin into your nopCommerce store. In the admin dashboard, go to Configuration Tab > All Plugins and Themes or search for All Plugins and Themes in the Admin search bar.
  • Search for the SAML Single Sign-On (SSO) - miniOrange plugin and click the Download button to get the zip.
  • nopCommerce Single Sign-On (SSO) using Google as IDP - install plugin
    From nopCommerce marketplace
  • You can download the plugin zip file from nopCommerce store - nopCommerce SAML Single Sign-On (SSO)
  • To install the plugin, login as admin into your nopCommerce website. In the admin dashboard, go to Configuration Tab >> Local plugins.
  • On the top right corner of the page select the Upload plugin or theme button to upload the downloaded plugin zip. Follow the instructions further to install the plugin.

Steps to configure nopCommerce Single Sign-On (SSO) using Google Apps as Identity Provider.

1. Configure Google Apps as IDP

  • You need to send your SP metadata to identity provider, Google Apps. For SP metadata, use the SP metadata URL or download the SP metadata as a .xml file and upload it at your IdP end. You can find both these options under the Service Provider Metadata tab.
  • nopCommerce Single Sign-On (SSO) using Google as IDP - SP metadata
  • Alternatively, you can manually add the SP Entity ID and ACS URL from Service Provider metadata tab in the plugin to your IdP configurations.
  • nopCommerce Single Sign-On (SSO) using Google as IDP - SP table
  • Go to https://admin.google.com and login with your G Suite administrator account.
  • Navigate to the Apps tab in the left menu and click on Web and mobile apps.
  • nopCommerce Single Sign-On (SSO) using Google as IDP - Add SAML app
Add a SAML App
  • Click on the Add App button, then in the dropdown select Add Custom SAML app tab to create a new saml app.
  • nopCommerce Single Sign-On (SSO) using Google as IDP - Setup own custom app
  • Enter details for your custom SAML app and click on Continue button.
  • nopCommerce Single Sign-On (SSO) using Google as IDP - Setup own custom app1
IDP Information
  • Click on Download Metadata button. This will be used for configuring your Service Provider.
  • You can also copy G Suite details like SSO URL, entity ID and Certificate to configure the Service Provider manually and then click on Continue button.
  • nopCommerce Single Sign-On (SSO) using Google as IDP - SAML custom app Basic Information
Enter SP metadata in IDP
nopCommerce Single Sign-On (SSO) using Google as IDP - Service provider details
Attribute Mapping
  • Click on Add Mapping button.
  • nopCommerce Single Sign-On (SSO) using Google as IDP - Attribute mapping details
  • Add and select user fields in Google Directory, then map them to Service Provider attributes and Click on Finish button.
  • nopCommerce Single Sign-On (SSO) using Google as IDP - Attribute mapping details
User access to configured app
  • Go to SAML Apps again and click on OFF for everyone .
  • nopCommerce Single Sign-On (SSO) using Google as IDP - Turn-On go to SAML Apps
  • Then, select ON for everyone to activate SSO.
    nopCommerce Single Sign-On (SSO) using Google as IDP - Turn-On go to SAML Apps 1

You have successfully configured G Suite / Google Apps as SAML IdP (Identity Provider) for achieving G Suite / Google Apps SSO login into your nopCommerce application.

2. Configure nopCommerce as SP (SSO Plugin)

Note: After installation of the plugin, we need to setup the trust between your nopCommerce application and your Google account. SAML metadata is shared with Google so they can update their inbuilt configuration to support Single Sign-On.

2.1: Share SP SAML metadata with Google

  • Click on Add New IDP to configure nopCommerce Single Sign-On (SSO) using Google as IDP.
  • nopCommerce Single Sign-On (SSO) using Google as IDP - Add new IDP
  • Under Service Provider Metadata tab, you can either copy-paste the metadata URL on your IDP side or download the SP metadata as an XML file. Additionally, you have the choice to manually copy and paste Base URL, SP Entity ID, and ACS URL.
  • Share SAML metadata with Google.
  • nopCommerce Single Sign-On (SSO) using Google as IDP - nopCommerce SP metadata

2.2: Import Google SAML metadata

  • Under Identity Provider Settings tab, select Google as your preferred identity provider.
  • nopCommerce Single Sign-On (SSO) using Google as IDP - Choose identity provider
  • There are two methods for configuring nopCommerce as service provider:
    • To upload IDP's metadata, you can either provide the metadata URL or upload XML file.
    • nopCommerce Single Sign-On (SSO) using Google as IDP -  Upload IDP metadata
    • Alternatively, under the Identity Provider Settings tab, you can manually fill in the mandatory fields like IDP Name, IDP Entity ID and Single Sign-On URL and hit Save.
    • nopCommerce Single Sign-On (SSO) using Google as IDP - IDP Configuration

3. Testing SAML SSO

  • Before testing, please ensure the following:
    • The nopCommerce (SP) SAML metadata has been exported to Google (IDP).
    • Importing the Google (IDP) SAML metadata in nopCommerce (SP).
  • Hover on Select Action and click on the Test Configuration button to verify if you have configured the plugin correctly.
  • nopCommerce Single Sign-On (SSO) using Google as IDP - Click on Test Configuration
  • Click the Test Configuration button to verify if you have configured the plugin correctly.
  • On successful configuration, you will get Attribute Name and Attribute Values in Test Configuration window.
  • nopCommerce Single Sign-On (SSO) using Google as IDP - Test Configuration Result

4. Attribute Mapping

  • After successful test configuration, click on Edit Configuration and navigate to Attribute Mapping section.
  • On the right side, you can see the IDP response table, map attribute names provided by your IDP with your store attributes, under Attribute/Role Mapping tab.
  • Click on Save button.
  • nopCommerce Single Sign-On (SSO) using Google as IDP - Attribute Mapping

5. Enabling SSO in your nopCommerce store

  • Enable SSO for your nopCommerce store by dragging the slider as shown below.
  • nopCommerce Single Sign-On (SSO) using Google as IDP - Enable SSO
  • Under the Redirection & SSO link tab, use the URL labeled as Your Store SSO Link in your store to initiate the SSO.
  • nopCommerce Single Sign-On (SSO) using Google as IDP - Store SSO Link

Additional Resources

Need Help?

Not able to find your identity provider? Mail us on nopcommercesupport@xecurify.com and we'll help you set up SSO with your IDP and for quick guidance (via email/meeting) on your requirement and our team will help you to select the best suitable solution/plan as per your requirement.

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