Configure WHMCS Single Sign-On (SSO) with WordPress OAuth

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

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

The WHMCS OAuth WordPress plugin also provides advanced SSO features like user profile attribute mapping, role mapping, and granting website pages and posts access based on user groups present in WHMCS. You can also protect your complete WordPress site behind SSO. WHMCS 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 WHMCS Single Sign-On (SSO) Login into WordPress

1. Setup WHMCS as OAuth Provider

• First of all, go to your WHMCS domain and log into your WHMCS Administrator account.
• You will be presented with following screen. Go to Setup OpenID Connect on the navigation bar on top.

• Click on Generate New Client API Credentials button.

• You will be redirected to the app details page. Fill in the required details and enter Authorized Redirect URIs from miniOrange OAuth/OpenID Connect Plugin and click on Generate Credentials.

• You will be brought to App details page. Here, you can find Client ID and Client Secret.

• Copy these credentials in MO OAuth Plugin configuration on corresponding fields.

Your WordPress site has been successfully set up WHMCS Single Sign-On (SSO) with WHMCS as an OAuth Provider, enabling users to securely access their digital resources with a single set of login credentials and establishing user authentication using WHMCS WordPress login.

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 WHMCS.

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


• Please refer the below table for configuring the endpoints for WHMCS in the plugin. Click Next.

Note: Once you create the WHMCS account, you'll find the domain url and you will need to add the same in the below endpoints.




Authorize Endpoint:	https://{yourWHMCSdomain}/oauth/authorize.php
Access Token Endpoint:	https://{yourWHMCSdomain}/oauth/token.php
Get User Info Endpoint:	https://{yourWHMCSdomain}/oauth/userinfo.php


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

• Verify the configuration details and click on Finish to save the configuration.

You have successfully configured WordPress as an OAuth Client, allowing users to securely access their digital resources using a single set of login credentials and attaining user authentication with WHMCS Single Sign-On (SSO) login into your WordPress site.

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


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

  Note: Once you create the WHMCS account, you'll find the domain url and you will need to add the same in the below endpoints.

  
  

  Scope:	openid profile email
  Authorize Endpoint:	https://{yourWHMCSdomain}/oauth/authorize.php
  Access Token Endpoint:	https://{yourWHMCSdomain}/oauth/token.php
  Get User Info Endpoint:	https://{yourWHMCSdomain}/oauth/userinfo.php


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

You have successfully configured WordPress as an OAuth Client, allowing users to securely access their digital resources using a single set of login credentials and attaining user authentication with WHMCS SSO login your WordPress site.

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