WHMCS Connect

From WHMCS Documentation

WHMCS Connect provides a single centralised interface to administer and manage all of your servers.

WHMCS Connect allows admins to access the control panels for all configured servers that use supported control panels. This allows admins to work with these servers without the need to reauthenticate.

Currently, you can use cPanel & WHM and Plesk servers with Single Sign-On.

Browser Compatibility
This feature supports the Firefox® and Safari® browsers. Chromium-based browsers browsers (for example, Chrome™) are not supported.

Using WHMCS Connect

To use WHMCS Connect, go to Utilities > WHMCS Connect in the Admin Area. The menu at the top-right of the interface provides a list of all servers that support Single Sign-On. Select one from the menu to connect.

When you choose a server from the menu, WHMCS will securely communicate via the API to establish a session and load the control panel interface in the lower frame. If a session cannot be established successfully, you will receive an error message.

Disable Use X-Frame-Options

WHMCS Connect requires the use of an iframe.

To do this in cPanel & WHM:

  1. Log in to WHM.
  2. Navigate to Server Configuration >> Tweak Settings
  3. Set Use X-Frame-Options and X-Content-Type-Options headers with cpsrvd to Off.
  4. Click Save.

For other supported control panels (currently, Plesk), consult the appropriate documentation.

Permissions

Several sets of permissions control access to WHMCS Connect servers.

Admin Role Groups

Access to WHMCS Connect is controlled via the WHMCS Connect admin role group permission. By default, only Full Administrator admins have access to WHMCS Connect.

To allow additional admin role groups access, go to Configuration () > Admin Users or, prior to WHMCS 8.0, Setup > Administrator Roles. Then, edit the desired role group, select WHMCS Connect, and click Save.

Per Server and Per Admin User Group

Access to Single Sign-On functionality can also be controlled on a per-server and per-admin user group basis. For example, you can allow users in Admin Role Group 1 to perform Single Sign-On for servers 1 and 3, while users of Admin Role Group 2 can only perform Single Sign-On to server 2.

By default, all admins can perform Single Sign-On into any server in WHMCS. However, Single Sign-On is only available through WHMCS Connect or at Configuration () > System Settings > Servers.

To configure permissions for a server:

  1. Go to Configuration () > System Settings > Servers.
  2. Edit the desired server.
  3. Find the SSO Access Control section.
  4. Set Access Control to Restricted. A list of admin role groups will display.
  5. Select the admin role groups that you want to grant permission to.
  6. Save your changes.