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

Get in Touch

Set up Single Sign-On (SSO) on your Joomla site via WHMCS OAuth provider with the help of Joomla OAuth & OpenID Connect plugin. Integrating WHMCS Single Sign-On (SSO) into Joomla using OAuth 2.0 authentication protocol allows your users to securely login into your Joomla websites and applications by authenticating with WHMCS OAuth provider. The WHMCS OAuth Joomla plugin also provides advanced features such as, Auto create users, Attribute Mapping, Group Mapping etc.

Visit our Joomla OAuth Client Plugin page to learn more about the features and Pricing plans we offer for the Joomla OAuth Single Sign-on (OAuth & OpenID connect) plugin.

Pre-requisites : Download And Installation

Setup WHMCS as OAuth Provider with Joomla OAuth Client

1. Download and Setup Joomla OAuth Client

• Download the zip file for the miniOrange OAuth Client plugin for Joomla from the link here .
• Login into your Joomla site’s administrator console.
• From Menu, click on System, then under Install section click on Extension.
• Upload the downloaded zip file to install the Joomla OAuth Client plugin.
• After successful installation of plugin, click on Start Using miniOrange OAuth Client plugin button.
• Under Configure OAuth tab. Select WHMCS as an OAuth Provider.

• Copy the Callback/Redirect URL from Configure OAuth tab of Joomla OAuth Client plugin. We will require it later.

2. Configure WHMCS as OAuth Provider

• First, log into your WHMCS 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 which is copied from here. Click on Generate Credentials button.

• Now your API credentials generated successfully. In section of Client API Credentials you will get Client ID and Client Secret.

• Click on Save Changes.

3. Integrating Joomla with WHMCS

• Go back to your Joomla Dashboard. Then go to Components.
• Now go to the Joomla OAuth Client plugin, under Configure OAuth tab, enter the all the details. Then click on Save Settings and then click on Test Configuration.

3.1. Scope and Endpoints

• Scope & Endpoints are given below, which are required for configuring Joomla as OAuth Client plugin to configure Okta 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)

4. User Attribute Mapping

• 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.
• Click on Test Configuration button, you will see all the values returned by WHMCS to Joomla in a table.

• Now go to do Attribute Mapping tab. Here you can map all the Attribute Mapping details in the given fields below.

5. Role/Group Mapping [Premium Feature]

• Go to the Role Mapping tab. Here you can Enable Role Mapping and select default groups for new users.
• Based on your provider application, you can allocate the Joomla role to your provider roles.

6. Login Settings [Premium Feature]

• Now you can use Login / SSO URL to perform SSO.

• 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.
• Go to the Login/Logout Settings tab. Here, you can configure user login/logout behavior for your Joomla application.

• Congratulations, you have successfully configured the miniOrange OAuth Client plugin with your Okta OAuth Provider.
• Click on the Upgrade Plans tab to check out our complete list of features and various licensing plans. OR you can click here to check features and licensing plans.
• If you want to purchase any of the paid version of the plugin, you have to register/login with us in Account Setup tab. OR you can register/login here.
• In case, you are facing some issue or have any question in mind, you can reach out to us by sending us your query through the Support button in the plugin or by sending us a mail at joomlasupport@xecurify.com.

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

Additional Resources

• What is OAuth 2.0?
• Frequently Asked Questions (FAQs)
• How to configure OAuth / OpenID Connect SSO with Azure AD
• How to configure OAuth / OpenID Connect SSO with Salesforce
• How to configure OAuth / OpenID Connect SSO with AWS Cognito
• How to configure OAuth / OpenID Connect SSO with Discord
• How to configure OAuth / OpenID Connect SSO with Facebook
• How to configure OAuth / OpenID Connect SSO with Google Apps
• How to configure OAuth / OpenID Connect SSO with Instagram
• How to configure OAuth / OpenID Connect SSO with Keycloak

Mail us on joomlasupport@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.