Shopify Single Sign-On (SSO) using JWT Protocol

Overview

What is JWT (JSON Web Token)?

JWT, or JSON Web Token, is an open standard used to share information between two parties securely — a client and a server. In most cases, it’s an encoded JSON containing a set of claims and a signature. The client will have to authenticate once with the server with the credentials. The server verifies the credentials and delivers a JSON Web Token to the client (JWT). The client may use this JSON Web Token (JWT) to authenticate itself to the server for avoiding the need to submit credentials such as username and password again.

This solution allows you to setup Single Sign-On (SSO) into Shopify store and authenticate via JWT from your client application. When you use single sign-on (SSO) with JWT authentication, a user's identity is verified when they sign in to the client application. The user can then access Shopify store without having to enter any additional sign-in credentials. Only users who have completed Shopify JWT Single Sign-On and authenticated by the client application have access to Shopify store.

Whenever a user logs in to your client application, their details are taken from the application userbase by the JWT issuer for creating a JWT token having three parts header, payload, and signature. This JWT token is then appended in the Shopify SSO link and when the user clicks on the SSO link, there will be a signature validation process and if the signature is validated, the user is authentic and will be granted access to the Shopify store; otherwise, the access will be denied.

Download Plugin Pricing Plans

Pre-requisites: Single Sign On - SSO Login Application

To configure Shopify JWT Single Sign-On into your store, you will need to install the miniOrange Shopify Single Sign On - SSO Login Application on your store.

Configuration Steps

Step by Step guide for Single Sign-On in Shopify Store Using JWT Token

Step 1: Configure JWT Authentication in Shopify Single Sign-on (SSO) application

• Go to your Shopify store and 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 JWT protocol.

• Fill out the below fields by referring the below table:

• Click on Save.
• Go to your configured application and locate the 'Application Key' field, which will act as the IdpIdentifier, shown in the image below:

Step 2: Create the SSO link to Single Sign-On into Shopify

• Append the data in the below URL format.

URL Format:

https://store.xecurify.com/moas/broker/login/jwt/callback/{customerId}/{idpIdentifier}/{jwtToken}?relay=https://store.xecurify.com/moas/broker/login/shopify/<store-domain>/account

• After substituting the values click on the Single Sign-On (SSO) link. You will be redirected and logged-in to the Shopify store.

Step 3: Attribute Mapping

• Click on the + Attribute Mapping button to map attributes.

• Map the attributes by refering the table below:

• Click on Save.

Step 4: Enable & Test SSO Configurations

Select Shopify Store Type:

• Non-Plus Store
• Plus Store

SSO Configuration in Non-Plus Shopify Stores

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

• Customer Accounts
• Legacy Customer Accounts

• Go to the application dashboard, enable the customer accounts extension as shown in the below image.

• Enable the New Customer Accounts extension and click on Save.

• Navigate to the application home page and enable the IDP Login toggle option against the IDP you have configured.

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

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

• 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 the application dashboard, you will see a warning box to add the login button extension on the Account page, click on the login widget extension link as shown in the below image to enable it.

• Navigate to the application home page and enable the IDP Login toggle option against the IDP you have configured.

• If you want to configure SSO into Shopify using multiple IDPs, then select your IDP from the list provided here, and setup SSO using that IDP.
• Enable the IDP login toggle option for enabling SSO into Shopify using multiple IDPs.

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

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

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

• After login, 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.

SSO Configuration in Plus Shopify Stores

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

• Customer Accounts
• Legacy Customer Accounts

• 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 shopifysupport@xecurify.com.

• 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 identity provider as Active.

• Navigate to the application home page and enable the IDP Login toggle option against the IDP you have configured.

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

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

• 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.

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

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

• Enable the Multipass Token option. Refer to this Faq to get the Multipass token value and paste it in the below field.

• Click on Save.

• Go to the application dashboard, you will see a warning box to add the login button extension on the Account page, click on the login widget extension link as shown in the below image to enable it.

• Navigate to the application home page and enable the IDP Login toggle option against the IDP you have configured.

• If you want to configure SSO into Shopify using multiple IDPs, then select your IDP from the list provided here, and setup SSO using that IDP.
• Enable the IDP login toggle option for enabling SSO into Shopify using multiple IDPs.

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

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

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

• 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.

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

Hence you have successfully configured Shopify JWT Single Sign On (SSO) using miniorange Single Sign-On (SSO) login application. This solution ensures that you are ready to roll out secure access to your store using Shopify JWT within minutes.

ADDITIONAL RESOURCES

• Shopify Security Solutions
• Shopify Single Sign-On (SSO)
• Shopify Content restriction
• Shopify Subscription
• Shopify – Okta SCIM Provisioning And Deprovisioning

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.