Search Results :

×

Setup WHMCS Single Sign-on with Drupal OAuth Client

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.

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

  • Enter the application name in the Display Name text field. For example, WHMCS.
Drupal oauth client configure oauth tab

  • 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.
Drupal WHMCS OpenID Single Sign-On - Go to Setup - Select OpenID Connect

  • Click on the Generate New Client API Credentials button.
Drupal WHMCS OpenID Single Sign-On - Click Generate New Client API Credentials

  • 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.
Drupal WHMCS OpenID Single Sign-On - Provide the required details like Name, Callback URL

  • Click on the Generate Credentials button.
  • Copy the Client ID and Client Secret from the Client API Credentials section.
Drupal WHMCS OpenID Single Sign-On - Copy Client API Credentials

  • Go to the Drupal's Configure OAuth tab and paste the copied Client ID and Client secret into the respective text-fields.
Paste the copied Client ID and Client Secret into the Drupal's Configure OAuth tab

  • 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=
Provide the Scope and Endpoints into the corresponding text field of Drupal's Configure OAuth tab of the module

  • Click on the Save Configuration button.
  • After successfully saving the configurations, click on the Perform Test Configuration button to test the connection between Drupal and WHMCS.
Testing the Single Sign-On connection

  • 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.
WHMCS sso login with drupal OAuth OpenID Single Single On WHMCS test Configuration successfully

  • 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.
WHMCS sso login with drupal OAuth OpenID Single Single On WHMCS test Configuration successfully

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 :
miniOrange sso login with drupal OAuth OpenID Single Single On miniOrange test Configuration successfully

If you face any issues during the configuration or if you want some additional features, please contact us at drupalsupport@xecurify.com.

More FAQs ➔

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]


ADFS_sso ×
Hello there!

Need Help? We are right here!

support
Contact miniOrange Support
success

Thanks for your inquiry.

If you dont hear from us within 24 hours, please feel free to send a follow up email to info@xecurify.com

Hello there!

Need Help? We are right here!

support
Contact miniOrange Support
success

Thanks for your inquiry.

If you dont hear from us within 24 hours, please feel free to send a follow up email to info@xecurify.com