WHMCS Connect - Revision history

SarahK at 20:56, 10 May 2022

2022-05-10T20:56:22Z

PeterM at 11:58, 4 May 2022

2022-05-04T11:58:19Z

SarahK at 22:40, 14 April 2022

2022-04-14T22:40:04Z

SarahK at 21:53, 1 March 2022

2022-03-01T21:53:26Z

SarahK at 13:11, 28 September 2021

2021-09-28T13:11:17Z

John at 14:13, 9 June 2021

2021-06-09T14:13:37Z

John: /* How to Use It */

2021-01-26T12:04:08Z

‎How to Use It

SarahK at 20:42, 25 August 2020

2020-08-25T20:42:15Z

SarahK: /* Permissions */

2020-08-06T12:09:06Z

‎Permissions

SarahK at 17:21, 5 August 2020

2020-08-05T17:21:29Z

@@ Line 32: / Line 32: @@
 ===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>) > Admin Users''' or, prior to WHMCS 8.0, '''Setup > Administrator Roles'''. Then, edit the desired role group, select '''WHMCS Connect''', and click '''Save'''.
+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===
@@ Line 41: / Line 41: @@
 <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>
 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.
 # Find the '''SSO Access Control''' section.

@@ Line 3: / Line 3: @@
 You can access this feature at '''Utilities > WHMCS Connect'''.
-Currently, you can use cPanel & WHM and Plesk servers with Single Sign-On.
+Currently, you can use cPanel & WHM with Single Sign-On.
 <div class="docs-alert-info">
@@ Line 25: / Line 25: @@
 # Set '''Use X-Frame-Options and X-Content-Type-Options headers with cpsrvd''' to '''Off'''.
 # Click '''Save'''.
 ==Permissions==

@@ Line 1: / Line 1: @@
-WHMCS Connect provides 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.
-You can access WHMCS Connect at '''Utilities > WHMCS Connect'''.
+You can access this feature at '''Utilities > WHMCS Connect'''.
 Currently, you can use cPanel & WHM and Plesk servers 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>

@@ Line 1: / Line 1: @@
 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.
@@ Line 12: / Line 14: @@
 ==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.
+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.
@@ Line 23: / Line 25: @@
 # 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'''.
 # Click '''Save'''.

@@ Line 1: / Line 1: @@
-WHMCS Connect is a single centralised interface to administer and manage all of your servers.
+WHMCS Connect provides a single centralised interface to administer and manage all of your servers.
-−
-Utilising [[WHMCS_Single_Sign-On|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.
+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.
-−
-At the time of writing, Single Sign-On is supported by cPanel/WHM servers.
+Currently, you can use cPanel & WHM and Plesk servers with Single Sign-On.
-−
 <div class="docs-alert-info">
 <span class="title">Browser Compatibility</span><br />
-Supported browsers include '''Firefox''' and '''Safari'''.
+This feature supports the Firefox® and Safari® browsers. Chromium-based browsers browsers (for example, Chrome™) are not supported.
 </div>
-−
-==Benefits==
+==Using WHMCS Connect==
-−
-* Instant access to any server configured within WHMCS
+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.
-* No longer do you have to share root passwords with your employees
-* Faster and more efficient access to perform required operations
+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.
-* Easier to revoke access from individual members of staff
 ===Disable Use X-Frame-Options===
-WHMCS Connect uses an iframe to load the WHM interface. Therefore you must allow WHM to be rendered within an iframe. To do this:
-# Login to WHM
+WHMCS Connect requires the use of an iframe.
-# Navigate to '''Server Configuration »Tweak Settings'''
-# Set the ''Use X-Frame-Options and X-Content-Type-Options headers with cpsrvd'' value to ''Off''
+To do this in cPanel & WHM:
 # Click Save
+# Log in to WHM.
 ==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''' 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>) > Admin Users''' 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">

@@ Line 18: / Line 18: @@
 ==How to Use It==
-WHMCS Connect can be accessed from the Admin Area via the Utilities menu from any page.
+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.
 ==Permissions==

@@ Line 28: / Line 28: @@
 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.
-To allow additional admin user groups access, navigate to '''Setup > Administrator Roles''' and edit the role group you wish to add it to, select the "WHMCS Connect" checkbox, and then save.
+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.
 In addition, access to Single Sign-On functionality can be controlled on a per server and per admin user group basis.