SSO Login into Drupal using WHMCS as OAuth / OpenID Connect Provider
Drupal OAuth / OpenID Connect SSO integration enables SSO between the Drupal site and WHMCS.This setup guide helps in configuring Single Sign-On (SSO) between the Drupal site and WHMCS using the OAuth / OpenID Connect module. This module is compatible with Drupal 7, Drupal 8, Drupal 9, and Drupal 10. When you incorporate the OAuth / OpenID Connect module with the Drupal site, you can log into the Drupal site seamlessly with WHMCS credentials.
Installation Steps:
- Download the module:
composer require 'drupal/miniorange_oauth_client'
- Navigate to Extend menu on your Drupal admin console and search for miniOrange OAuth Client Configuration using the search box.
- Enable the module by checking the checkbox and click on the Install button.
- You can configure the module at:
{BaseURL}/admin/config/people/miniorange_oauth_client/config_clc
- Install the module:
drush en drupal/miniorange_oauth_client
- Clear the cache:
drush cr
- You can configure the module at:
{BaseURL}/admin/config/people/miniorange_oauth_client/config_clc
- Navigate to Extend menu on your Drupal admin console and click on Install new module.
- Install the Drupal OAuth & OpenID Connect Login - OAuth2 Client SSO Login module either by downloading the zip or from the URL of the package (tar/zip).
- Click on Enable newly added modules.
- Enable this module by checking the checkbox and click on install button.
- You can configure the module at:
{BaseURL}/admin/config/people/miniorange_oauth_client/config_clc
Setup Drupal as OAuth Client:
- On the Drupal site, navigate to Configuration -> miniOrange OAuth Client Configuration -> Configure OAuth tab.
- Select Custom OAuth 2.0 Provider from the Select Application drop-down.
- Copy the Callback/Redirect URL and keep it handy.
- Enter WHMCS as the application name in the Display Name text-field.
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 OAuth/OpenID SSO 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 Connection between Drupal and WHMCS:
- Click on the Perform Test Configuration button to check the connection between Drupal and WHMCS.
- On a Test Connection popup, if you don't have an active session in WHMCS on the same browser, you will be asked to sign in to your WHMCS account. After successfully logging into a WHMCS account, you will be provided with a list of attributes that are received from the WHMCS.
- Select the Email Attribute from the dropdown menu in which the user's email is obtained and click the Done button.
Please note: Mapping the Email Attribute is mandatory for your login to work.
Congratulations! You have successfully configured WHMCS as OAuth/OpenID Provider and Drupal as an OAuth Client.
How to perform the SSO?
- Now, open a new browser/private window and go to your Drupal site login page.
- Click on the Login using the WHMCS link to initiate the SSO from Drupal.
- 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:
- Attribute Mapping - map user’s attributes received from OAuth Provider with Drupal fields
- Role mapping - assign a Drupal Role to users on the basis of their role/attribute on the OAuth provider
- Enable single logout - Logout user from the OAuth Provider (i.e. AWS Cognito, Azure AD B2C, Keycloak, Okta) when they logs out form Drupal
- Restrict anonymous access to the complete site or a particular section of the site
- Add Multiple OAuth Provides
- Explore All the features offered by the OAuth Client
Troubleshooting:
Follow the steps mentioned HERE
Follow the steps mentioned HERE
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]
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]
Need Help? We are right here!
