WHMCS OAuth & OpenID connect Single Sign-On (SSO) | WHMCS SSO Login

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



WHMCS Endpoints and Scope:




Client ID :	Click Here
Client Secret :	Click Here
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

You have successfully configured WHMCS as OAuth Provider for achieving WHMCS login into your WordPress Site.

Step 2: Setup WordPress as OAuth Client

• After Plugin is activated, go to the plugin and search for WHMCS. Select Whmcs from the OAuth Providers list.

• Go to Configure OAuth tab and configure App Name, Client ID, Client Secret from provided Endpoints.
• Enter Scope value as email profile openid.
• Click on Save Settings to save the configuration.

You have successfully configured WordPress as OAuth Client for achieving WHMCS login into your WordPress Site.

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

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

Step 5: Login Settings / 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.

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


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

In this Guide, you have successfully configured WHMCS Single Sign-On (SSO) by configuring WHMCS 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 WHMCS login credentials within minutes.

Additional Resources

• What is OAuth 2.0?
• WHMCS as OAuth Provider / OpenID Connect
• Frequently Asked Questions (FAQs)