WHMCS Single Sign-On (SSO) WordPress OAuth & OpenID | WHMCS SSO

WHMCS Single Sign-On (SSO) WordPress OAuth & OpenID | WHMCS SSO


Configure WHMCS Single Sign-On (SSO) with WordPress OAuth & OpenID Connect Single Sign-On (SSO) plugin. Enable secure login into WordPress using WHMCS as OAuth and OpenID Connect provider. WHMCS Single Sign-On (SSO) with WordPress allows your users to login to your WordPress and access the site by authenticating with their WHMCS identity provider. You can also configure plugin using different IDPs such as Azure AD, Office 365, and other custom providers. It supports advanced Single Sign-On (SSO) features such as user profile Attribute mapping, Role mapping, multi-tenant login etc. Here we will go through a guide to configure WHMCS Single Sign-On (SSO) with WordPress for user authentication. By the end of this guide, users should be able to perform secure login to WordPress and access the site with WHMCS SSO. To know more about other features we provide in WP OAuth Single Sign-On ( OAuth & OpenID Connect Client ) plugin, you can click here.

Pre-requisites : Download And Installation


  • Log into your WordPress instance as an admin.
  • Go to the WordPress Dashboard -> Plugins and click on Add New.
  • Search for a WordPress OAuth Single Sign-On (SSO) plugin and click on Install Now.
  • Once installed click on Activate.



Steps to configure WHMCS Single Sign-On (SSO) Login into WordPress

1. Setup WHMCS as OAuth Provider

  • First of all, go to your WHMCS domain and log into your WHMCS Administrator account.
  • You will be presented with following screen. Go to Setup OpenID Connect on the navigation bar on top.
  • WHMCS Single Sign-On (SSO) - Configure OpenID Connect in WHMCS
  • Click on Generate New Client API Credentials button.
  • WHMCS Single Sign-On (SSO) - Create new Client Credentials
  • You will be redirected to the app details page. Fill in the required details and enter Authorized Redirect URIs from miniOrange OAuth/OpenID Connect Plugin and click on Generate Credentials.
  • WHMCS Single Sign-On (SSO) - Configure New Client
  • You will be brought to App details page. Here, you can find Client ID and Client Secret.
  • WHMCS Single Sign-On (SSO) - Check your client configuration
  • Copy these credentials in MO OAuth Plugin configuration on corresponding fields.

You have successfully configured WHMCS as OAuth Provider for achieving WHMCS Single Sign-On (SSO) with WordPress for user authentication.


2. Setup WordPress as OAuth Client

  • After Plugin is activated, go to the plugin and search for WHMCS. Select Whmcs from the OAuth Providers list.
  • WHMCS Single Sign-On (SSO) - save settings
  • Go to Configure OAuth tab and configure App Name, Client ID, Client Secret from provided Endpoints.
  • Enter Scope value as email profile openid.
  • Please refer the below table for configuring the scope & endpoints for WHMCS in the plugin.

    Client ID : Click Here
    Client Secret : Click Here
    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
  • Click on Save Settings to save the configuration.
  • WHMCS Single Sign-On (SSO) - save settings

You have successfully configured WordPress as OAuth Client for achieving WHMCS Single Sign-On (SSO) with WordPress for user authentication.


3. User Attribute Mapping

  • User Attribute Mapping is mandatory for enabling users to successfully login into WordPress. We will be setting up user profile attributes for WordPress using below settings.
  • Finding user attributes

    • Go to Configure OAuth tab. Scroll down and click on Test Configuration.
    • WHMCS Single Sign-On (SSO) -  test congifuration
    • You will see all the values returned by your OAuth Provider to WordPress in a table. If you don't see value for First Name, Last Name, Email or Username, make the required settings in your OAuth Provider to return this information.
    • WHMCS Single Sign-On (SSO) - test congifuration result
    • Once you see all the values in Test Configuration, go to Attribute / Role Mapping tab, you will get the list of attributes in a Username dropdown.
    • WHMCS Single Sign-On (SSO) - attribute/role mapping

    4: Role Mapping [Premium]

    • Click on “Test Configuration” and you will get the list of Attribute Names and Attribute Values that are sent by your OAuth provider.
    • From the Test Configuration window, map the Attribute Names in the Attribute Mapping section of the plugin. Refer to the screenshot for more details.
    • WHMCS Single Sign-On (SSO) - attribute mapping
    • Enable Role Mapping: To enable Role Mapping, you need to map Group Name Attribute. Select the attribute name from the list of attributes which returns the roles from your provider application.
      Eg: Role

    • WHMCS Single Sign-On (SSO) - test configuration - role mapping
    • Assign WordPress role to the Provider role: Based on your provider application, you can allocate the WordPress role to your provider roles. It can be a student, teacher, administrator or any other depending on your application. Add the provider roles under Group Attribute Value and assign the required WordPress role in front of it under WordPress Role.

      For example, in the below image. Teacher has been assigned the role of Administrator & Student is assigned the role of Subscriber.
    • WHMCS Single Sign-On (SSO) - test configuration - role mapping
    • Once you save the mapping, the provider role will be assigned the WordPress administrator role after SSO.
      Example: As per the given example, Users with role ‘teacher’ will be added as Administrator in WordPress and ‘student’ will be added as Subscriber.

    5: Login Settings / Sign In Settings

    • The settings in Single Sign-On (SSO) Settings tab define the user experience for Single Sign-On (SSO). To add a Whmcs login widget on your WordPress page, you need to follow the below steps.
    • 1. Sign in settings for wordpress 5.7 and before :

      • Go to WordPress Left Panel > Appearances > Widgets.
      • Select miniOrange OAuth. Drag and drop to your favourite location and save.
      • WHMCS Single Sign-On (SSO) - create-newclient login button setting

      2. Sign in settings for wordpress 5.8 :

      • Go to WordPress Left Panel > Appearances > Widgets.
      • Select miniOrange OAuth. Drag and drop to your favourite location and save.
      • WHMCS Single Sign-On (SSO) - create-newclient login button setting
      • Open your WordPress page and you can see the Whmcs SSO login button there. You can test the Whmcs Single Sign-On (SSO) now.

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


      Additional Resources


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

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