Configure WSO2 Identity Server Single Sign-On (SSO) with WordPress OAuth

Get Free Trial

Set up Single Sign-On (SSO) on your WordPress website via the WSO2 Identity Provider (IDP) with the WordPress OAuth & OpenID Connect Single Sign-On plugin. Implementing WSO2 SSO allows users to log into your websites and applications with a single set of credentials using the enterprise-level WSO2 OAuth provider.

WSO2 acts as the OAuth Provider and WordPress acts as the OAuth Client. WordPress WSO2 Authentication provides smooth login between these two, removing the need to remember usernames and passwords.

The WSO2 OAuth WordPress plugin also provides advanced SSO features like user profile attribute mapping, role mapping, and granting site access based on WSO2 user groups. You can also protect your complete WordPress site behind SSO. WSO2 WordPress OAuth SSO plugin secures the user’s login process and improves user authentication authority. Follow the steps in the guide below to install this plugin.

Prerequisites: 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 WSO2 Single Sign-On (SSO) Login into WordPress

1. Setup WSO2 as OAuth Provider

• First, let’s register this Consumer App in WSO2 IS. Download and start WSO2 IS.

• Once logged in, go to Main -> Service Provider and click on Add.

• Enter the Service Provider Name and Description and click on Register.

• Now go to the Service Provider->List and edit the Service Provider you have created.
• Scroll down and select Inbound Authentication Configuration and then select OAuth/OpenID Connect Configuration and click on Configure.

• Select the OAuth Version 2.0 and enter the Redirect/Callback URL from the plugin in Callback URL field. Click on Add.

• When the app has been added, Client ID and Client Secret are generated for the application. Configure the WordPress OAuth SSO plugin with Client ID, Client Secret, Authentication and Access Token, Get User Info Endpoint of WSO2. Endpoints are provided at the bottom of this guide.

• Attribute Mapping: To get attributes from WSO2 you have to add following Claim URIs in your WSO2 application.
• Go to Service Provider->Claim Configuration.
• Select https://wso2.org/claims/emailaddress from Subject Claim URI dropdown.
• Add following URIs in Service Provider Claim Dialect: https://wso2.org/oidc/claim & https://wso2.org/claims

• You have successfully completed your WSO2 Server side configurations.

WSO2 Identity Server as an OAuth Provider is successfully configured from the above step for achieving WSO2 Single Sign-On (SSO) with WSO2 login credentials into your WordPress Site.

2. Setup WordPress as OAuth Client

• Free
• Premium

• Go to Configure OAuth tab and click Add New Application to add a new client application into your website.

• Choose your Application from the list of OAuth / OpenID Connect Providers, here WSO2

• Copy the Callback URL to be used in OAuth Provider Configuration. Click Next.

• Insert the WSO2 domain here and click Next.

• Enter the Client Credentials like Client ID & Client Secret as shown in the setup dialogue box, openid is already filled. Click Next.

• Click on Finish to save the configuration.

• Go to Configure OAuth tab and search your application name to add a new client application into your website, here WSO2.

• Insert the WSO2 domain here and configure Client ID and Client Secret from WSO2's configuration and click Save Settings.

• Choose your Grant Type from the list of options & Click on Save Settings to save the configuration.

Single Sign-On (SSO) using the WSO2 Identity Server was successfully configured as OAuth Provider and WordPress as OAuth Client using our WordPress SSO (OAuth / OpenID Connect Client) plugin. This solution ensures that you can securely log in to the WordPress web application by establishing WSO2 Identity Server Single Sign-On (SSO) and using WSO2 login credentials for authentication.

3. User Attribute Mapping

• User Attribute Mapping is mandatory for enabling users to successfully login into WordPress. We will be setting up user profile attributes for WordPress using 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, you will get the list of attributes in a Username dropdown.

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 WSO2 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 WSO2 SSO login button there. You can test the WSO2 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 WSO2 SSO login button there. Once you click the login button, you will be able to test the WSO2 Single Sign-On (SSO).