Difference between revisions of "WHMCS Connect"

From WHMCS Documentation

(→‎Permissions)
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
WHMCS Connect is a single centralised interface to administer and manage all of your servers.
+
WHMCS Connect allows you to access the control panels for all configured servers that use supported control panels. This allows you to work with these servers without the need to reauthenticate.
−
 
 
−
Utilising Single Sign-On Technology, WHMCS Connect allows you and your administrators to quickly and easily access the control panels of all the servers configured in your WHMCS installation that support Single Sign-On, enabling you and your staff to administer and make changes without ever needing to re-authenticate.
 
−
 
 
−
At the time of writing, Single Sign-On is supported by cPanel/WHM servers only.  Support for more control panels will be added in due course.
 
−
 
 
−
==Benefits==
 
−
 
 
−
* Instant access to any server configured within WHMCS
 
−
* No longer do you have to share root passwords with your employees
 
−
* Faster and more efficient access to perform required operations
 
−
* Easier to revoke access from individual members of staff
 
−
* Fine grained permission controls
 
−
* Centralised storage and updating of API authentication details
 
−
 
 
−
[[File:Whmcs_connect.png|800px]]
 
−
 
 
−
==How to Use It==
 
−
 
 
−
WHMCS Connect can be accessed from the Admin Area via the Utilities menu from any page.
 
−
 
 
−
The dropdown located at the top right of the interface provides a list of all servers that support Single Sign-On.  Simply select one from the dropdown to connect.
 
−
 
 
−
Upon choosing a server from the dropdown, WHMCS will securely communicate via the API to establish a session, and load the admin control panel interface in the lower frame.  Should a session fail to be established successfully, you will receive an error message.
 
  
 +
You can access this feature at '''Utilities > WHMCS Connect'''.
 +
 +
Currently, you can use cPanel & WHM with Single Sign-On.
 +
 +
<div class="docs-alert-info">
 +
This feature supports the Firefox® and Safari® browsers. Chromium-based browsers browsers (for example, Chrome™) are not supported.
 +
</div>
 +
 +
==Using WHMCS Connect==
 +
 +
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:
 +
 +
# Log in to WHM.
 +
# Navigate to '''WHM >> Server Configuration >> Tweak Settings'''
 +
# Set '''Use X-Frame-Options and X-Content-Type-Options headers with cpsrvd''' to '''Off'''.
 +
# Click '''Save'''.
 +
 
==Permissions==
 
==Permissions==
−
 
+
−
Access to WHMCS Connect is controlled via an admin role group permission named "WHMCS Connect". By default, only full administrator users have access to the WHMCS Connect interface.
+
Several sets of permissions control access to WHMCS Connect servers.
−
 
+
−
To allow additional admin user groups access, navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Admin Users''' or, prior to WHMCS 8.0, '''Setup > Administrator Roles''' and edit the role group you wish to add it to, select the "WHMCS Connect" checkbox, and then save.
+
===Admin Role Groups===
−
 
+
−
In addition, access to Single Sign-On functionality can be controlled on a per server and per admin user group basis.
+
Access to WHMCS Connect is controlled via the '''WHMCS Connect''' [[Administrator Roles|admin role group]] permission. By default, only '''Full Administrator''' admins have access to WHMCS Connect.
−
 
+
−
<div class="docs-alert-warning">By default, all administrator users have permission to perform Single Sign-On into any server configured within the WHMCS instance. Only those with access to WHMCS Connect or the Configure Servers setup pages can access the Single Sign-On functions however.</div>
+
To allow additional admin role groups access, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Administrator Roles]]''' or, prior to WHMCS 8.0, '''Setup > Administrator Roles'''. Then, edit the desired role group, select '''WHMCS Connect''', and click '''Save'''.
−
 
+
−
For example you can allow users of 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.
+
===Per Server and Per Admin User Group===
−
 
+
−
Permissions can be configured for a server in '''Setup > Servers'''. Edit the server you wish to adjust the permissions for, scroll down until you reach the '''SSO Access Control''' section. Then under the ''Access Control'' setting select '''Restricted''' after which a list of admin role groups will be displayed for you to be able to choose which admin role groups should be allowed to utilise Single Sign-On with the selected server.
+
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.
−
 
+
−
[[File:Sso-permissions.png]]
+
<div class="docs-alert-warning">
 +
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 (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.
 +
</div>
 +
 +
To configure permissions for a server:
 +
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.
 +
# Edit the desired server.
 +
# Find the '''SSO Access Control''' section.
 +
# Set '''Access Control''' to '''Restricted'''. A list of admin role groups will display.
 +
# Select the admin role groups that you want to grant permission to.
 +
# Save your changes.

Latest revision as of 20:56, 10 May 2022

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

You can access this feature at Utilities > WHMCS Connect.

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

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

Using WHMCS Connect

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 WHM >> Server Configuration >> Tweak Settings
  3. Set Use X-Frame-Options and X-Content-Type-Options headers with cpsrvd to Off.
  4. Click Save.

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 () > System Settings > Administrator Roles 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 or, prior to WHMCS 8.0, Setup > Products/Services > Servers.

To configure permissions for a server:

  1. Go to Configuration () > System Settings > Servers or, prior to WHMCS 8.0, Setup > Products/Services > 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.
Retrieved from "http://3.17.75.209/index.php?title=WHMCS_Connect&oldid=32627"