BigCommerce API Authentication for SSO

What is BigCommerce API Authentication?

BigCommerce API Authentication is a process where users can login to their external application with BigCommerce website credentials. miniOrange’s BigCommerce API authentication plugin performs the BigCommerce API integration and enables BigCommerce to serve as an IDP (Identity Provider), allowing users to access various applications and external websites with a Single Sign-On (SSO).
Users will authenticate themselves via their BigCommerce credentials and once they successfully integrate with BigCommerce API they can access all the external applications.
The BigCommerce User database is linked to miniOrange user store to provide support for BigCommerce API SSO into external multiple applications.This use case can be achieved by BigCommerce API Authentication plugin which provides SSO login security using BigCommerce API endpoints.

Why should you opt for BigCommerce API Authentication plugin?

Secure SSO login access for multiple applications and websites using BigCommerce Credentials.
You don’t need to migrate your users from BigCommerce for SSO login authentication.
On-the-fly user creation : Auto create users at the time of SSO login and auto sync up of user details.
Multiple Authentication protocol support : SAML, OAuth, JWT etc.

Step 1: Install and setup BigCommerce API Authentication Plugin

Log in to BigCommerce Admin Panel.
Go to the Advanced Settings from the menu and select API Accounts.
Click on Create API Account and choose Create V2/V3 API Token option from the menu shown.

BigCommerce API Authentication - API account

Add a suitable name for your API account.
Enable the Customers option as Modify and Customers Login option as login.
Click on Save.

BigCommerce API Authentication - API Configuration

Download the API credentials file. It contains the API token, Client ID and Client Secret.

BigCommerce API Authentication - API Credential Download

Step 2: Setup BigCommerce as an Authentication source in miniOrange

Login with your miniOrange account.
Navigate to User Stores and click on the Add User Store button.
Switch to the API tab and select Custom API from the dropdown.
Provide an API identifier name.
Under the Authentication Configuration section, Enter the following values in the respective attributes:

User Authentication:	https://api.bigcommerce.com/stores/<YOUR-STORE_HASH>/v3/customers/validate-credentials
Header:	Header Name: X-Auth-Token Header Value: <Your Acess token from BigCommerce API>
Method:	POST
User Authentication Parameters:	{ "email": ##username##, "password": ##password##, "channel_id": 1 }
Status:	error
Status Method:	message

BigCommerce as api authentication source user authentication parameters

Click on the Save button.
To test the connection, select the user store you just added and click on Test Authorization API.
Enter your BigCommerce credentials when prompted and you should be able to see a Success message.

Step 3: Configure Your application in miniOrange

Note:

If you have already configured your application in miniOrange you can skip the following steps.

With us, You can configure application according to the the protocol it supports like SAML, OAuth, JWT, Ws-fed etc.
For example lets say the application supports SAML. Then go with the configurations Shown in SAML Application Tab.

SAML Application

Login to miniOrange Admin Console.
Go to Apps >> Manage Apps. Click on Configure Apps button.

Then click on Create App under SAML.

Search for you Application. In case you do not find your app, search for Custom SAML App.

Get the ACS URL and SP Entity ID from your application.
Enter the following values OR click on Import SP Metadata:

Service Provider Name	Choose appropriate name according to your choice
SP Entity ID or Issuer	Your Application Entity ID
ACS URL X.509 Certificate (optional)	Your Application Assertion Consumer Service URL
NameID Format	Select urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
Response Signed	Unchecked
Assertion Signed	Checked
Encrypted Assertion	Unchecked
Group policy	Default
Login Method	Password

Click on Save to configure Your applcation.
Now to get the IDP metadata of the app configured, Go to apps >> your_app >> select >> metadata tab.

Click on the Show Metadata details in the Information required to Authenticate via External IDPs section. Download the metadata XML file by clicking on Download Metadata button or copy the Metadata URL link.

You need to Upload this metadata in your application.

OAuth Application

To configure OAuth application in miniOrange, login to miniOrange Admin Console.
Go to Apps >> Manage Apps Click Configure Apps button.

Click on Create App under OAuth/OIDC. Click on Open ID Connect App .

You can add any OAuth Client app here to enable miniOrange as OAuth Server. Few popular OAuth client apps for single sign-on are Salesforce, WordPress, Joomla, Atlassian, etc.

Enter following Values:

Client Name	Add appropriate Name
Redirect URL	Get the Redirect-URL from your OAuth Client
Descrption	Add if required
Group Name	Default
Policy Name	As per your Choice
Login Method	Password

Click on Save
Now to provide the required data to OAuth client go to the app configured i.e apps >> your_app >> select >> edit.

Note: Choose the Authorization Endpoint according to the identity source you configure.

When you want to use you want to use miniOrange as OAuth identity server use this endpoint: https://{mycompany.domainname.com}/moas/idp/openidsso
If you are configuring any Identity Provider in Identity Providers Menu and not using miniOrange as IDP use this endpoint: https://{mycompany.domainname.com}/broker/login/oauth{customerid}

JWT Application

Click on Create App under JWT.

Select JWT App.

Configure the name for your application and configure Redirect-URL which tells where to send JWT response. Redirect-URL should be an endpoint on your application where you want to achieve SSO.

In case you are setting up SSO with Mobile Applications where you can't create an endpoint for Redirect or Callback URL, use below URL.

https://login.xecurify.com/moas/jwt/mobile

Click Save
To get the SSO link for your application, Go to Apps >> your_app >> select >> Edit.

Then, copy the Single Sign On Url and verify SSO setup by browsing that url.

On successful authentication, you will be redirected to configured Redirect or Callback URL with JWT token
You will need to download a certificate from App > Manage Apps, and click Certificate link against your configured application. This certificate will be used for signature validation of JWT response.

Download certificate to proceed with SSO

Step 4: Setup Multiple IDPs (Optional)

You have a choice to set multiple IDPS for Single Application, i.e integrate multiple IDP and users can select IDP accordingly from which they want to authenticate themselves. There are three different ways to authenticate users using IDP.

Login using IDP selection page: It gives users an option to Select IDP from the dropdown list during login time.
Domain Mapping: Here we map the email domains to a particular IDP. So when the user enters the Email address with a specific domain he would be redirected to the respective IDP.
App Identity Provider Mapping: This feature gives users an option to select one specific IDP for their application before login.

Note : At once you can select either of them.

A] Login using IDP selection page

You can configure multiple IDPs (Identity Providers) and give users the option to select the IDP of their choice to authenticate with.
For Example - It could be multiple AD domains belonging to different departments or multiple okta organizations.

Few usecases where customers configure multiple IDPs -

Suppose you have a product which many of your clients use and each client has their own unique IDP so you want them to SSO into your product as well using their existing IDP only. miniOrange provides a centralized way to connect with all IDPs in a very easy manner and integrate SSO into your application.
Suppose you are providing a course to many universities, each having a unique SAML, OAuth protocol supported IDP's like Shibboleth, ADFS, CAS, etc. You can provide Single Sign-On (SSO) into your course application to all these universities by integrating with all of them using a single platform provided by miniOrange.
This is the endpoint to call from your SAML application -

For Cloud IDP - https://login.xecurify.com/moas/discovery?customerId=<customer_id>

For On-Premise IDP - https://yourdomain.com/discovery?customerId=<customer_id>
You should copy the Customer Key from admin console-> Settings -> and replace it with <customer_id> here. Once configured in SP, when you initiate the login from Service Provider, a user will be redirected to IDP Selection Page listing all IDPs configured for that account.

You can see the screenshot below of the IDP Selection Page with a list of IDPs .

Note: To view the IDP in drop-down list, go to Identity Providers tab > against your configured IDP > Select >Edit , here Enable the Show IdP to Users option.

Select your IDP (Identity Provider) to login

You can also change the look and feel of this page. Login to miniOrange Admin console. Navigate to Customization -> Branding Configuration. See the below screenshot for reference-

You can customize the title of this page.
Change the logo and favicon for this page.
Change the background and button color for this page from admin UI.

B] Login via Domain Mapping

If you have multiple IDPs and you want a certain set of users to authenticate from one IdP whereas another set of users to authenticate from another IdP, based on their email domains then you can achieve this by using the following steps:- Our domain mapping feature

We have provided a Domain Mapping field under each IdP where admins can enter the domain eg. demo.com , example.com as shown in the screenshot below.

For your reference , Azure AD and Okta is being used as two different IDPs and WordPress is being used as SP. Follow the guides to set up Okta and WordPress at your end.

Once the setup is complete you can login through your Wordpress site.
Lets Say in Azure AD IDP Domain field we enter example.com and in Okta IDP Domain field we enter demo.com
So a user logging in with the example.com domain will be redirected to Azure AD IDP.

User logging in with email address having demo.com domain will be redirected to Okta IDP.

Once the user will authenticate itself through respective IDPs, it will be redirected back to Wordpress site.

C] Login via App Identity Provider Mapping

If you have multiple IDPs (identity provider) and you want a certain application user to authenticate with one IDP and other application users with another IDP then you can achieve this by our Identity Source Feature.

Go to apps >> your_app >> select >>edit.

Here You will have an option called as an Identity source.

The dropdown list would show the list of configured IDPs (Identity providers) in miniOrange Identity Providers tab and Userstore.

Select one IDP you want for this application. Click on Save.

Select IDP from which you want to authenticate users

Now the users of this application would be able to authenticate only by the IDP (Identity Provider) selected from the Identity Source dropdown list.

Step 1Install and setup BigCommerce API Authentication
Plugin
Step 2Setup BigCommerce as an Authentication source in miniOrange
Step 3Configure Your application in miniOrange

A] SAML Application
B] OAuth Application
C] JWT Application

Step 4Setup Multiple IDPs (optional)

A] Login using IDP selection page
B] Login via Domain Mapping
C] Login via App Identity Provider Mapping

SSO Login Using BigCommerce API Authentication Plugin