Contents

Shopify OAuth Single Sign-On (SSO) using F5 as Identity Provider

Configure Single Sign On (SSO) login into Shopify store using F5 as an Identity provider (IDP). miniOrange allows F5 to act as an IDP (Identity Provider), which allows users to Single Sign-On (SSO) into Shopify store using F5 credentials. This document will guide you through the easy step-by-step process of configuring SSO login into Shopify store with F5 using OAuth protocol. This solution ensures that you are ready to roll out secure access to your Shopify store using F5 within minutes

Pre-requisite : Single Sign On - SSO Application

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

Shopify Single Sign-On (SSO)

By miniOrange

miniOrange Provides Secure Single Sign-On (SSO) access to your Shopify stores (Plus and Non-Plus).

Get this application

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

1. Step to get the Redirect URI for the OAuth Server

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

Shopify SSO - single sign on application

Select OAuth protocol.

From the list of identity providers (IDPs), select Custom IDP.

Note down the Callback URL which will be required while configuring SSO.

Click on Save.

2. Configure Shopify as SP in F5

Go to developer console page of F5.
Navigate to Access > Federation > OAuth Authorization Server > Client Application
Enter the basic details required for configuring app.
Enter the Callback URI which is copied from Shopify store.
Click on Finished button.
Copy your Client ID and Client Secret and keep these values handy as you will need them later.

You have successfully completed your F5 OAuth Server side configurations.

3. Configure F5 as an Identity Provider (IDP) in Shopify

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

Select OAuth protocol.

From the list of identity providers (IDPs), select Custom IDP.

Enter the identity provider (IDP) display name.
Now, fill in the required details like Endpoints, Client ID, Client Secret, and Scope.
Please refer to the below table for configuring the values:

App Name	Custom IDP
App Display Name	As per your convenience
Authorize Endpoint	https://f5-oauth2/v1/authorize
Token Endpoint	https://f5-oauth2/v1/token
User Info Endpoint	https://f5-oauth2/v1/userinfo
Client ID	From Step 2
Client Secret	From Step 2
Scopes	contacts email

Click on Save.

4. Test Connection

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

On entering valid F5 credentials you will see a pop-up window which as shown in below screen.

Shopify Single Sign On SSO SucessTestConnection

Click on the Fetch Attributes to fetch IDP attribute.

5. Attribute Mapping

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

Map the attributes by referring the table below:

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

Click on Save.
Navigate to the application home page. Click More actions against the configured IDP, and click on Make Default to set your IDP as default.

6. Testing 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 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.

Hence you have successfully configured Shopify Single Sign-On (SSO) using F5 as IDP and Shopify as SP using miniOrange Single Sign-On (SSO) login application. This solution ensures that you are ready to roll out secure access to your Shopify store using F5 login credentials within minutes.

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, follow the steps given here.

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.

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.