Difference between revisions of "WHMCS Connect"
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | WHMCS Connect | + | 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. | |
| − | |||
| − | Currently, you can use cPanel & WHM | ||
<div class="docs-alert-info"> | <div class="docs-alert-info"> | ||
| − | |||
This feature supports the Firefox® and Safari® browsers. Chromium-based browsers browsers (for example, Chrome™) are not supported. | This feature supports the Firefox® and Safari® browsers. Chromium-based browsers browsers (for example, Chrome™) are not supported. | ||
</div> | </div> | ||
| Line 12: | Line 11: | ||
==Using WHMCS Connect== | ==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. | 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. | ||
| Line 23: | Line 22: | ||
# Log in to WHM. | # Log in to WHM. | ||
| − | # Navigate to '''Server Configuration >> Tweak Settings''' | + | # Navigate to '''WHM >> Server Configuration >> Tweak Settings''' |
# Set '''Use X-Frame-Options and X-Content-Type-Options headers with cpsrvd''' to '''Off'''. | # Set '''Use X-Frame-Options and X-Content-Type-Options headers with cpsrvd''' to '''Off'''. | ||
# Click '''Save'''. | # Click '''Save'''. | ||
| − | |||
| − | |||
==Permissions== | ==Permissions== | ||
| Line 35: | Line 32: | ||
===Admin Role Groups=== | ===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. | + | 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. |
| − | To allow additional admin role groups access, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > | + | 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'''. |
===Per Server and Per Admin User Group=== | ===Per Server and Per Admin User Group=== | ||
| Line 44: | Line 41: | ||
<div class="docs-alert-warning"> | <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'''. | + | 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> | </div> | ||
To configure permissions for a server: | To configure permissions for a server: | ||
| − | # Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers'''. | + | # 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. | # Edit the desired server. | ||
# Find the '''SSO Access Control''' section. | # Find the '''SSO Access Control''' section. | ||
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.
Contents
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
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:
- Go to Configuration () > 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.