Square Single Sign-On (SSO) WordPress OAuth and OpenID | Square SSO

Configure Square Single Sign-On (SSO) with WordPress OAuth & OpenID Connect Single Sign-On (SSO) plugin. Enable secure login into WordPress using Square as OAuth and OpenID Connect provider. Square Single Sign-On (SSO) with WordPress allows your users to login to your WordPress and access the site by authenticating with their Sqaure identity provider. You can also configure plugin using different IDPs such as Azure AD, Office 365, and other custom providers. It supports advanced Single Sign-On (SSO) features such as user profile Attribute mapping, Role mapping, multi-tenant login etc. Here we will go through a guide to configure Square Single Sign-On (SSO) with WordPress for user authentication. By the end of this guide, users should be able to perform secure login to WordPress and access the site with Square SSO. To know more about other features we provide in WP OAuth Single Sign-On ( OAuth & OpenID Connect Client ) plugin, you can click here.

Pre-requisites : Download And Installation

• Log into your WordPress instance as an admin.
• Go to the WordPress Dashboard -> Plugins and click on Add New.
• Search for a WordPress OAuth Single Sign-On (SSO) plugin and click on Install Now.
• Once installed click on Activate.

Steps to configure Square Single Sign-On (SSO) Login into WordPress

1. Setup Square as OAuth Provider

• First of all, go to https://developer.squareup.com/us/en and signup / login to your Square developer account.
• Click on add application to create a new application.

• Enter the app name and click on save button.

• Go to the OAuth tab in the left section and enter the redirect url which you will get from the OAuth Single Sign-On (SSO) plugin. click on save button.

• Copy the Application ID and Application Secret and save it under Client ID and Client Secret on your miniOrange OAuth Single Sign-On (SSO) plugin Configuration.

You have successfully configured Square as OAuth Provider for for achieving Square Single Sign-On (SSO) with WordPress for user authentication.

2. Setup WordPress as OAuth Client

• Go to the Configure OAuth tab in the Plugin and search for Custom OAuth in the applications list, and select Custom OAuth 2.0 App

• Now, configure App Name, Client ID, Client Secret received from Square App.
• Enter Scope value as EMPLOYEES_READ.

• Please refer the below table for configuring the scope & endpoints for square in the plugin.

  Client ID :	Click Here
  Client Secret :	Click Here
  Scope:	EMPLOYEES_READ
  Authorize Endpoint:	https://connect.squareup.com/oauth2/authorize
  Access Token Endpoint:	https://connect.squareup.com/oauth2/token
  Get User Info Endpoint:	https://connect.squareup.com/v2/employees

• Click on Save Settings to save the configuration.

You have successfully configured WordPress as OAuth Client for achieving Square Single Sign-On (SSO) with WordPress for user authentication.

3. User Attribute Mapping

• User Attribute Mapping is mandatory for enabling users to successfully Single Sign-On into WordPress using Square SSO. We will be setting up user profile attributes for WordPress using the below settings.

Finding user attributes

• Go to Configure OAuth tab. Scroll down and click on Test Configuration.

• You will see all the values returned by your OAuth Provider to WordPress in a table. If you don't see value for First Name, Last Name, Email or Username, make the required settings in your OAuth Provider to return this information.

• Once you see all the values in Test Configuration, go to Attribute / Role Mapping tab, select attributes from Username dropdown and click on Save.


4: Role Mapping [Premium]

• Click on “Test Configuration” and you will get the list of Attribute Names and Attribute Values that are sent by your OAuth provider.
• From the Test Configuration window, map the Attribute Names in the Attribute Mapping section of the plugin. Refer to the screenshot for more details.

• Enable Role Mapping: To enable Role Mapping, you need to map Group Name Attribute. Select the attribute name from the list of attributes which returns the roles from your provider application.
  Eg: Role


• Assign WordPress role to the Provider role: Based on your provider application, you can allocate the WordPress role to your provider roles. It can be a student, teacher, administrator or any other depending on your application. Add the provider roles under Group Attribute Value and assign the required WordPress role in front of it under WordPress Role.
  
  For example, in the below image. Teacher has been assigned the role of Administrator & Student is assigned the role of Subscriber.

• Once you save the mapping, the provider role will be assigned the WordPress administrator role after SSO.
  Example: As per the given example, Users with role ‘teacher’ will be added as Administrator in WordPress and ‘student’ will be added as Subscriber.

5. Sign In Settings

• The settings in Single Sign-On (SSO) Settings tab define the user experience for Single Sign-On (SSO). To add a Square login widget on your WordPress page, you need to follow the below steps.

Sign in settings for WordPress 5.7 and before

• Go to WordPress Left Panel > Appearances > Widgets.
• Select miniOrange OAuth. Drag and drop to your favourite location and save.


Sign in settings for WordPress 5.8

• Go to WordPress Left Panel > Appearances > Widgets.
• Select miniOrange OAuth. Drag and drop to your favourite location and save.

• Open your WordPress page and you can see the Square SSO login button there. You can test the Square Single Sign-On (SSO) now.

Sign in settings for WordPress 5.9

• Make sure the "Show on login page" option is enabled for your application. (Refer to the below image)

• Now, go to your WordPress Login page. (Eg. https://< your-wordpress-domain >/wp-login.php)
• You will see an Square SSO login button there. Once you click the login button, you will be able to test the Square Single Sign-On (SSO).


In this Guide, you have successfully configured Square Single Sign-On (SSO) by configuring Square as OAuth Provider and WordPress as OAuth Client using our WP OAuth Single Sign-On ( OAuth / OpenID Connect Client ) plugin.This solution ensures that you are ready to roll out secure access to your WordPress site using Square login credentials within minutes.




Additional Resources

• What is OAuth 2.0?
• Square OAuth SSO
• Frequently Asked Questions (FAQs)



Mail us on oauthsupport@xecurify.com for quick guidance(via email/meeting) on your requirement and our team will help you to select the best suitable solution/plan as per your requirement.