SAML Single Sign-On (SSO) For Shopify Using Keycloak as Identity Provider

Overview

miniOrange allows Keycloak to act as an IDP (Identity Provider), which allows users to Single Sign-On (SSO) into Shopify using Keycloak Credentials. Our application is compatible with all the SAML / OAuth-compliant Identity Providers. We will go through a step-by-step guide to configure Single Sign-On (SSO) into Shopify using Keycloak as IdP (Identity Provider) and Shopify store as SP (Service Provider).

Download Plugin Pricing Plans

Pre-requisites: Single Sign On - SSO Login Application

To configure SSO into Shopify with Keycloak as IDP (SAML), you will need to install the miniOrange Shopify Single Sign On - SSO Login Application on your store.

Configuration Steps

Step by Step guide for Configuring Keycloak as IDP for SSO into Shopify

Step 1: Configure Shopify as SP in Keycloak

• Log in to the Keycloak Admin Panel.
• Click on Clients from the left menu and then click on Create button to create a new client/application.

• For the above SAML configuration, you need to get the Entity ID and ACS URL from Shopify.
• Now go to your Shopify store, navigate to the App section and click on Single Sign On - SSO login application.

• Click on the Add Identity Provider button to add your IDP.

• Select SAML protocol.

• Now choose Keycloak from the list of IDPs.

• Click on the Get metadata button, as shown on the screen below, to get the service provider metadata.

• Navigate to the SP Initiated Metadata section and copy down the ACS URL and Entity ID or Issuer.

• Enter the values provided by Shopify as follows:

• Enter the values provided by Shopify as follows:
• Provide the configurations values from Shopify over here:

• Now in Fine Grain SAML Endpoint Configuration enter values as follows.

• Click on the Save button.
• For IDP metadata, Go to Realms in left panel and click on SAML 2.0 Identity Provider Metadata.

You have completed the Okta side configuration.

Step 2: Configure Keycloak as IDP in Shopify

• Navigate back to the miniOrange Single Sign On-SSO application and click on the Add Identity Provider button.

• Select SAML protocol.

• From the list of IDPs, select Keycloak.

• Click on the Import IDP Metadata button.

• Select the upload method as Metadata Link. Paste the copied XML file link from Step 1 and Click on Import.

• Add the appropriate IDP Name and click on Save.

You have completed Shopify side configuration.

Step 3: Test Connections

• After saving the IDP configuration, you will be redirected to the Test Connection step.
  Please perform Test Connection before mapping or fetching attributes, test connection ensures that your IDP configuration is correct.
• Click on the Test Connection button.

• On entering valid Keycloak credentials you will see a pop-up window which is shown in the below screen.

• Click on the Fetch Attributes button to fetch the IDP attribute.

Step 4: Attribute Mapping

• Click on the + Attribute Mapping button to map attributes between Shopify and Okta.

• Map the attributes by referring to the table below:

• Click on Next.

Step 5: Enable SSO Configurations

Select Shopify Store Type:

Non-Plus Store

Plus Store

SSO Configuration in Non-Plus Shopify Stores

Choose the type of customer account you have enabled on your Shopify Store:

Customer Accounts

Legacy Customer Accounts

• Navigato to the Advanced Settings section and then go to Customer Account. Enable the Customer Account SSO option as shown in the below image and then click on the clicking here link to enable the extension.

• Enable the Customer Account extension and click on Save.

Note: In case of Shopify Non Plus Store (legacy customer account) no additional configurations is required. Follow the steps provided below to complete the SSO setup between Keycloak and Shopify.

SSO Configuration in Plus Shopify Stores

Choose the type of customer account you have enabled on your Shopify Store:

Customer Accounts

Legacy Customer Accounts

• Navigato to the Advanced Settings section and then go to Customer Account. Enable the Customer Account SSO option as shown in the below image and then click on the clicking here link to enable the extension.

• Enable the Customer Account extension and click on Save.

• Go back to the SSO application, and navigate to Connect Store tab. Copy the Client ID, Client Secret, Post-Logout redirect URL and Discovery Endpoint URL and keep them handy.

• Click on the Customer accounts link as shown in the below image.

• Select the Customer accounts option recommended by Shopify & look for the Identity Provider option, if not present please reach out to Shopify support.

• If the Identity Provider is present, click on Manage.

• Click on Connect to Provider button.

• Add the Identity Provider name and fill in the details such as Discovery endpoint URL, Client ID, Client secret, Additional Scopes, Post-logout redirect URI parameter that you copied from above step. Click on Save.

• Once the Identity Provider has been added, do the Test Connection.

• After verifying the flow make the IDP as Active.

• Now, click on the Setup Guide button and follow the steps mentioned to get multipass token.

• Enable the Multipass Token option and paste the value copied from above in the below field.

• Click on Save.

• Navigate to the application home page. Go to More actions against the IDP you have configured and click on the Make Default button to make the IDP default.

Step 6: Testing Single Sign-On (SSO) for your Shopify store

Please select your store type to test Single Sign-On (SSO) for your Shopify store:

• Plus Stores
• Non-Plus Stores

• Go to your Shopify Store login page.(https://<your-shopify-storedomain>/account/login)
• Click on the User login icon.

• If you encounter an "invalid or missing reCAPTCHA token" error, accompanied by a "Something went wrong" message, refer to this FAQ to resolve the error.

• Else, you’ll be redirected to the login page of the identity provider (IDP) you configured in the previous step. Log in with your IDP account credentials.
• Next, enter the six-digit OTP that will be sent to your registered email address. (This is a one-time process)

• You’ll be successfully logged in to your Shopify store.

• Go to your Shopify Store login page.(https://<your-shopify-storedomain>/account/login)
• Click on the login button you customized earlier.

• If you encounter an "invalid or missing reCAPTCHA token" error, accompanied by a "Something went wrong" message, refer to this FAQ to resolve the error.

• Else, you'll be redirected to the identity provider (IDP) login page. Now log in with your existing account credentials.

• You’ll be successfully logged in to your Shopify store.

Hence your configuration of Keycloak as IDP in Shopify is successfully completed.

Additional Resources

• Shopify Security Solutions
• Shopify Single Sign-On (SSO)
• Shopify Content restriction
• Shopify Subscription

Get in Touch

Please reach out to us at shopifysupport@xecurify.com, and our team will assist you with setting up the Shopify SSO application. Our team will help you to select the best suitable solution/plan as per your requirement.