Setup WHMCS Single Sign-on with Drupal OAuth Client
Overview
Drupal miniOrange SSO integration will allow you to configure Single Sign-On ( SSO ) login between your Drupal site and WHMCS using OAuth/OpenID protocol. Drupal OAuth 2.0/OpenID connect module gives the ability to enable login using OAuth 2.0/OIDC Single Sign-On to Drupal Site. We provide the Drupal OAuth/OpenID Client module for Drupal 7, Drupal 8, Drupal 9, Drupal 10, and Drupal 11.
Installation Steps
- Using Composer
- Using Drush
- Manual Installation
Configuration Steps
Setup Drupal as OAuth Client
- After installing the module, navigate to the Configuration -> miniOrange OAuth Client Configuration -> Configure OAuth tab and select Custom OAuth 2.0 Provider from the Select Application dropdown list.
- Copy the Callback/Redirect URL and keep it handy.
- Enter the application name in the Display Name text field. For example, WHMCS.
Note: If your provider only supports HTTPS Callback/Redirect URLs and you have an HTTP site, please make sure to enable the 'Enforce HTTPS Callback URL' checkbox at the bottom of the tab.
Create Application in WHMCS
- Go to the WHMCS site and log in using the WHMCS Administrator account.
- Navigate to the Setup -> OpenID Connect from the navigation bar on top.
- Click on the Generate New Client API Credentials button.
- Provide the required details below:
- Enter Drupal as the Application name in the Name text-field.
- Provide a Description of your application.
- Paste the Callback/Redirect URL into the Authorized Redirect URIs text-field.
- Click on the Generate Credentials button.
Integrating Drupal with WHMCS
- Copy the Client ID and Client Secret from the Client API Credentials section.
- Go to the Drupal's Configure OAuth tab and paste the copied Client ID and Client secret into the respective text-fields.
- Copy and paste the following scope and endpoints in Drupal's Configure OAuth tab.
| 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?access_token= |
- Click on the Save Configuration button.
Test Configuration of Drupal with WHMCS
- After successfully saving the configurations, click on the Perform Test Configuration button to test the connection between Drupal and WHMCS.
- On a Test Configuration popup, if you don't have an active session in the same browser, you will be asked to sign in to WHMCS. After successfully logging into WHMCS, you will be provided with a list of attribute that's coming from the WHMCS.
- Select the Email Attribute from the dropdown menu in which the user's email ID is obtained and click on the Done button.
- After clicking on Done button, you will be redirected to the Attribute & Role Mapping tab, in which you can select the Username Attribute from the dropdown list and click on Save Configuration button.
Note: Mapping the Email Attribute is mandatory for your login to work.
- Now log out and go to your Drupal site’s login page. You will automatically find a Login with WHMCS link there. If you want to add the SSO link to other pages as well, please follow the steps given in the image below :
Need Assistance?
If you face any issues during the configuration or if you want some additional features, please contact us at drupalsupport@xecurify.com.
Additional Features:
Troubleshooting:
More FAQs ➔Getting error: 'Username not received. Check your
Attribute Mapping configuration.' OR Getting Error: 'Email not received. Check your Attribute Mapping
configuration.' 
Follow the steps mentioned HERE
I am getting "Client Credentials were not found in
the headers or body"
when I try to perform test configuration
Follow the steps mentioned HERE
After I click on the logout in Drupal, it sends me back to
the Drupal homepage. However, when I try to login with other user, it doesn't ask me to login but
automatically logs me in with same user
The logout functionality you've mentioned here is the default behavior of a module. It's logging you out of Drupal but not from your Application/Provider. To allow the module to logout from your provider/application account (what you are looking for), you need to make the below configurations: [know more]
I purchased the paid Drupal module and replaced it with
the free module, but still I am not able to use paid features.
As you have upgraded to one of our paid versions of the Drupal module and replaced the free module with the paid one, you must first activate the paid module. Please refer to the below steps. [Know more]
Contact us
[MO_CONTACT_US]
