WHMCS Single Sign-On (SSO) with WordPress OAuth

WHMCS Single Sign-On (SSO) with WordPress OAuth


Get Free Trial

Enable WHMCS Single Sign-On, using WordPress OAuth & OpenID Connect Single Sign-On (SSO) plugin (SSO). WHMCS can be used as an OpenID Connect and OAuth provider to enable safe login for WordPress websites. By using their WHMCS identity provider, your users can log in and access your WordPress site with WHMCS Single Sign-On (SSO). The plugin can also be configured using a variety of IDPs, including Azure AD, Office 365, and other specialized providers. It provides strong SSO capabilities including multi-tenant login, role mapping, and user profile attribute mapping, among others. In this tutorial, we'll go through how to integrate WordPress user authentication with WHMCS Single Sign-On (SSO). By the end of this article, users should be able to securely enter into WordPress and use WHMCS SSO to access the website. To find out more about the additional features offered by the WP OAuth Single Sign-On (OAuth & OpenID Connect Client) plugin, 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 SSO with WHMCS WordPress Plugin - Configure OpenID Connect in WHMCS
  • Click on Generate New Client API Credentials button.
  • WHMCS SSO with WHMCS WordPress Plugin - 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 SSO with WHMCS WordPress Plugin - Configure New Client
  • You will be brought to App details page. Here, you can find Client ID and Client Secret.
  • WHMCS SSO with WHMCS WordPress Plugin - Check your client configuration
  • Copy these credentials in MO OAuth Plugin configuration on corresponding fields.

Your WordPress site has been successfully set up WHMCS Single Sign-On (SSO) with WHMCS as an OAuth Provider, enabling users to securely access their digital resources with a single set of login credentials and establishing user authentication using WHMCS WordPress login.


2. Setup WordPress as OAuth Client


  • Go to Configure OAuth tab and click Add New Application to add a new client application into your website.
  • WHMCS SSO with WHMCS WordPress Plugin - Add new application
  • Choose your Application from the list of OAuth / OpenID Connect Providers, Here WHMCS.
  • WHMCS SSO with WHMCS WordPress Plugin - Select Application
  • Copy the Callback URL to be used in OAuth Provider Configuration and click Next.
  • WHMCS SSO with WHMCS WordPress Plugin - Callback URL
  • Please refer the below table for configuring the endpoints for WHMCS in the plugin. Click Next.

  • App Name WHMCS
    Authorize Endpoint: https://{yourWHMCSdomain}/oauth/authorize.php
    Access Token Endpoint: https://{yourWHMCSdomain}/oauth/token.php
    Get User Info Endpoint: https://{yourWHMCSdomain}/oauth/userinfo.php
    WHMCS SSO with WHMCS WordPress Plugin - Add App name, TenantID
  • Enter the Client Credentials like Client ID & Client Secret as shown in the setup dialogue box, openid profile email is already filled. Click Next.
  • WHMCS SSO with WHMCS WordPress Plugin - Client ID & Client Secret
  • Verify the configuration details and click on Finish to save the configuration.
  • WHMCS SSO with WHMCS WordPress Plugin - Finish configuration

You have successfully configured WordPress as an OAuth Client, allowing users to securely access their digital resources using a single set of login credentials and attaining user authentication with WHMCS Single Sign-On (SSO) login into your WordPress site.


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 SSO with WHMCS WordPress Plugin -  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.
    • 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 SSO with WHMCS WordPress Plugin - 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 SSO with WHMCS WordPress Plugin - 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 SSO with WHMCS WordPress Plugin - 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 SSO with WHMCS WordPress Plugin - 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. 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.
      • Go to WordPress Left Panel > Appearances > Widgets.
      • Select miniOrange OAuth. Drag and drop to your favourite location and save.
      •  WHMCS SSO with WHMCS WordPress Plugin - WordPress create-newclient login button setting
      • Go to WordPress Left Panel > Appearances > Widgets.
      • Select miniOrange OAuth. Drag and drop to your favourite location and save.
      • WHMCS SSO with WHMCS WordPress Plugin - WordPress 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.
      • Make sure the "Show on login page" option is enabled for your application. (Refer to the below image)
      • WHMCS SSO with WHMCS WordPress Plugin - WordPress create-newclient login button setting
      • Now, go to your WordPress Login page. (Eg. https://< your-wordpress-domain >/wp-login.php)
      • You will see an WHMCS SSO login button there. Once you click the login button, you will be able to test the WHMCS Single Sign-On (SSO).
      • WHMCS SSO with WHMCS WordPress Plugin - WordPress create-newclient login button setting

In this Guide, you have successfully configured WHMCS SSO Integration with WordPress OAuth Plugin using WHMCS as OAuth Provider and WordPress as OAuth Client. Due to WHMCS WordPress integration, 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