OAuth Single Sign-On (SSO) For Shopify Using AWS Cognito as Identity Provider

Overview

miniOrange allows AWS Cognito to act as an IDP (Identity Provider), which allows users to Single Sign-On (SSO) into Shopify using AWS Cognito 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 AWS Cognito as IdP (Identity Provider) and Shopify store as SP (Service Provider).

Download Application Pricing Plans

Pre-requisite: Shopify Single Sign-On - SSO Application

To configure SSO into Shopify with AWS Cognito as IDP, you will need to install the miniOrange Shopify Single Sign On - SSO Login application on your store.

Configuration Steps

Setup guide for Configuring AWS Cognito as IDP for SSO into Shopify

Step 1: Get the Callback URL from the Shopify SSO App

• 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 OAuth 2.0 protocol.

• Now choose AWS Cognito from the list of IDPs.

• Copy the OAuth Callback URL and keep it handy as it will be used in further steps.

Step 2: Configuring Shopify as a Service Provider (SP) in AWS Cognito

• Go to Amazon Console and sign up/log in to your account to Configure AWS Cognito.

• Search for Cognito in the AWS Services search bar as shown below.

Note: If you already have a User Pool then follow the steps provided here, else follow the steps provided below.

• Click on Create a User Pool button to create a new User Pool.

• Select the Application type as a Traditional web application. Provide a name for your application and choose the attributes in your user pool to be used during the sign-in process. Select the attributes that you require during the sign-up process from the Required attributes for the sign-up section.

• Paste the Callback URL that has been copied from Step 1 in the Return URL field under the Add a Return URL section. Click on the Create button.

• Scroll down and click on the Go to Overview button.

• To configure how your user pool sends email messages to users, navigate to the Authentication methods under the Authentication tab and click on Edit under the Email section.

• Here, you can add the email address that your user pool will use to send emails to users. Click on Save Changes.

• Navigate to the App Clients tab under the Applications section, and select your App Client. If you don't have an app client, then click on Create app client button.

• Copy the Client ID and Client Secret and keep them handy as they will be used in further steps.

• Go to the Attribute permissions tab. Click on the Edit and select the attributes that you want during the sign-up process. Click on Save.

• Now go to the Login pages tab and click on the Edit button as shown in the below image.

• Verify that the Callback URL is added to the URL field under the Allowed Callback URLs section and under the Identity Provider section, the Identity Provider selected is the Cognito user pool.

• Select Authorization code grant under the OAuth 2.0 grant types. Under the OpenID Connect scopes section the scopes selected are Email, OpenID, and Profile. (Please refer to the images below) Click on the Save Changes button.

• Go to the Users tab under the User Management section, and click Create user.

• Enter details such as email address, phone number & password. Click on Create user to save the details.

• Go to the Domain tab under the Branding section and copy the complete domain name {your domain name}.auth.{region name}.amazoncognito.com. This should be entered into the endpoints field under the Shopify Single Sign-On (SSO) application so keep them handy.

You have completed the AWS Cognito side configuration to configure SSO into Shopify using AWS Cognito Credentials.

Step 3: Configure AWS Cognito as IDP in Shopify

• Navigate back to the miniOrange Single Sign On-SSO application.

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

• Select OAuth 2.0 protocol.

• From the list of IDPs, select AWS Cognito.

• Now, fill in the required details like Client ID, Client Secret, Endpoints, and Scope.
• Please refer to the below table for configuring the values.
• Note: You can find the cognito domain from Step 2.

• Now you can click on Save.

You have completed the Shopify side configuration to set up SSO between AWS Cognito and Shopify.

Step 4: Test Connection

• 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 AWS Cognito 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 5: Attribute Mapping

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

• Map the attributes by referring to the table below:

• Click on Next.

Step 6: 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.

In this Guide, you have configured AWS Cognito Single Sign-On (SSO) by configuring AWS Cognito as an OAuth Provider and Shopify as an OAuth Client using our Shopify Single Sign-On - SSO Login App. This solution ensures that you are ready to roll out secure access to your Shopify Store using AWS Cognito login credentials within minutes.

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.