Search Results :

×
Sign Up Contact Us
The miniOrange team will be in town for WordCamp Europe 2025 - we'd love to meet while we're there! Book a Meeting

Contents

Configure WHMCS Single Sign-On (SSO) with Joomla OAuth Client Plugin

Set up Single Sign-On (SSO) on your Joomla site using the WHMCS OAuth provider with the Joomla OAuth & OpenID Connect plugin. This integration allows users to securely log in to your Joomla websites and applications by authenticating through WHMCS's OAuth provider, using the OAuth 2.0 authentication protocol. The WHMCS OAuth Joomla plugin also offers advanced features such as automatic user creation, attribute mapping, and group mapping.

Visit our Joomla OAuth Client Plugin page to learn more about the features and pricing plans available for the Joomla OAuth Single Sign-On (OAuth & OpenID Connect) plugin.

download plugin button Download Plugin plugin pricing button plugin pricing button Pricing Plans free trial plugin free trial plugin Free Trial Handbook plugin Handbook plugin Handbook

In this configuration, WHMCS functions as the OAuth server, while Joomla allows users to log in with their WHMCS credentials by utilizing the Joomla OAuth Client Plugin.

  • Login into your Joomla site’s Administrator console.
  • From left toggle menu, click on System, then under Install section click on Extensions.
  • Now click on Or Browse for file button to locate and install the plugin file downloaded earlier.
  • Installation of plugin is successful. Now click on Get Started!
  • Under Configure OAuth -> Pre-Configured Apps tab, select your OAuth Provider. You can also search for custom OAuth or custom OpenID application in the search bar, and configure your own custom provider.
Get Started with OAuth Client Setup

  • After selecting your OAuth provider, you will be redirected to the Step 1 [Redirect URL] tab. Now copy the Callback/Redirect URL which we will use to configure the OAuth Server, then click on the Save & Next button.
Get Started with OAuth Client Setup

  • First, log into your WHMCS account.
  • You will be presented with following screen. Go to Setup -> OpenID Connect on the navigation bar on top.
WHMCS Dashboard

  • Click on Generate New Client API Credentials button.
Generate New Client API Credentials

  • You will be redirected to the app details page. Fill in the required details and enter Authorized Redirect URIs here. Click on Generate Credentials button.
OTP verification

  • Now your API credentials are generated successfully. Under the Client API Credentials section you will get Client ID and Client Secret. Click on Save Changes.
WHMCS Client ID and Secret

  • Go back to your Joomla Dashboard. Then go to Step 2 [Client ID & Secret].
  • Paste the Client ID, Client Secret and Domain. Also Set Client Credentials In header then click on Save Settings. Once Settings are saved then click on Save Configuration.
Upload IdP Metadata

  • Scope & Endpoints are given below, which are required for configuring Joomla as OAuth Client plugin to configure WHMCS as a custom OAuth or OIDC provider.
Scope read_public
Authorize Endpoint https://{yourWHMCSdomain}/oauth/authorize.php
Access Token Endpoint https://{yourWHMCSdomain}/oauth/token.php
Get User Info Endpoint https://{yourWHMCSdomain}/oauth/userinfo.php
Set Client Credentials In Both (In Header and In Body)

  • User Attribute Mapping is mandatory for enabling users to successfully login into Joomla. We will be setting up user profile attributes for Joomla using below settings.
  • Go to Step 3 [Attribute Mapping] tab and click on Test Configuration button.
Upload IdP Metadata

  • You will be able to see the attributes in the Test Configuration output as follows.
Upload IdP Metadata

  • Now go to the Step 3 [Attribute Mapping] tab and Select the attribute name for Email and Username from dropdown. Then click on Finish Configuration button.
Upload IdP Metadata

  • Now go to Step 4 [SSO URL] tab, here copy the Login/SSO URL and add it to your Site by following the given steps.
Upload IdP Metadata

  • Now logout and go to your Joomla site's pages where you have added this link. You will see a login link where you placed that button. Click on this button to perform SSO.


ADFS_sso ×
Hello there!

Need Help? We are right here!

support