SAML Single Sign-On (SSO) Solution For Shopify Using Keycloak as IDP
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).
Pre-requisite : Single Sign On - SSO Application
To configure SSO into Shopify using Keycloak as IDP, you will need to install the miniOrange Single Sign On - SSO Application on your Shopify store:
miniOrange Provides Secure Single Sign-On (SSO) access to your Shopify Store(both plus and Non plus Stores).
Step by Step guide to setup Single Sign-On in Shopify Store Using Keycloak as IDP
1. Configure Shopify as SP (Service Provider) 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 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 SAML protocol.
- Now choose Keycloak from the list of IDPs.
- Click on the Get metadata button as shown in the below screen to get the service provider metadata.
- Navigate to SP Initiated Metadata section and copy down the ACS URL and Entity ID or Issuer.
- Enter the values provided by Shopify as follows:
- Click on Save for further configuration.
- 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.
| Client ID | EntityID / Issuer |
| Client SAML Endpoint | ACS URL |
| Name | Provide the name as your choice |
| Client Protocol | SAML |
| Sign Assertion | On |
| Encrypt Assertion | Off |
| Client Signature Required | Off |
| Name ID Format | Username |
| Valid Redirect URIs | ACS URL |
| Assertion Consumer Service POST Binding URL | ACS URL |
| Logout Service Redirect Binding URL | Single Sign-Out URL |
2. Configure Keycloak as IDP in Shopify
- Navigate back to the miniOrange Single Sign On-SSO application and click on 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.
3. Test Connection
-
After saving the IDP configuration, you will be redirected to
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 Okta credentials you will see a pop-up window which is shown in the below screen.
- Click on the Fetch Attributes button to fetch IDP attribute.
4. Attribute Mapping
- Click on the + Attribute Mapping button to map attributes between Shopify and Okta.
- Map the attributes by refering the table below:
- Click on Save.
- Navigate to the application home page. Go to More actions against the IDP you have configured and click on Make Default button to make the IDP default.
| Attribute Name in Shopify | Choose the attribute from the list of predefined attributes |
| Attribute Type | IDP Attribute |
| Attribute Value | Select the attribute value you have fetched from your IDP |
5. Testing SSO
- 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 login page of the IDP you configured in previous step. Log in with your IDP account credentials.
- You’ll be successfully logged in to your Shopify store.
Troubleshooting
invalid_request
This may be because your primary domain would be different from your Shopify domain. To check your primary domain and make SSO work, contact us at shopifysupport@xecurify.com
shopify_plan_expired
This issue arises when either the trial period of your Development plan is expired. Or if your plan is not auto-renewed from the Shopify end. Contact us at shopifysupport@xecurify.com to resolve the plan upgrade issue and get smooth functioning of the SSO – Single Sign On Application.
invalid_attributes_received
As email is a required entity in Shopify for account creation as well as login operation, Single Sign On is not successful in this case. To resolve this error, please follow given here.
encountered_an_error
When I am performing SSO, I am getting ‘Please verify if Shopify App is installed’ error. To resolve this error, please follow given here.
If your error or query is not listed here, click here to see others.
Frequently Asked Questions (FAQs)
I have followed the steps to set IdP but where can I check SSO?
Follow the steps outlined here to configure SSO in Shopify with your preferred IDP.
I installed the Shopify SSO application. I clicked on the “SETUP IDP” option but nothing opened up.
Redirection to any other site might be blocked in the browser. Please follow the steps given here to resolve the issue.
When I try to perform SSO, I get redirected to the “Incorrect App Configuration” page and then after subsequent attempts, I get redirected to https://store.xecurify.com/moas/login page.
You might be trying to perform SSO in the different tab of the same
browser where you have opened our Single Sign-On – SSO Application or
accessed the configuration portal of our application. In this case,
SSO will be restricted due to security reasons.
Try to perform Single Sign On in a
new incognito/private window or in a
different browser in order to make SSO work.
After performing SSO, I want my customers to redirect to the collections or discount offer page.
Follow the steps outlined here to redirect your customer to collections/cart or any other page.
How do I enable the SSO application’s auto redirect to IDP feature on my Shopify store?
You must upgrade to the SSO application’s Enterprise plan to enable the Auto-Redirect to the IDP feature. Follow the steps outlined here to enable this feature.
Choose your preferred Identity Provider and start setting up SSO for Shopify right away
Additional Resources
If you are looking for anything which you cannot find, please drop us an email on shopifysupport@xecurify.com.
Need Help? We are right here!
