CPanel Single Sign-On - Revision history

SarahK at 16:48, 29 June 2023

2023-06-29T16:48:55Z

SarahK at 18:26, 19 April 2022

2022-04-19T18:26:32Z

SarahK at 18:59, 30 September 2021

2021-09-30T18:59:27Z

SarahK: /* Customising Single Sign-On Shortcuts */

2020-11-20T23:06:30Z

‎Customising Single Sign-On Shortcuts

SarahK: /* Permissions */

2020-08-05T20:45:44Z

‎Permissions

John: /* Caveats */

2016-03-04T10:54:28Z

‎Caveats

Matt at 00:50, 26 June 2015

2015-06-26T00:50:41Z

Matt: /* Permissions */

2015-06-17T13:54:02Z

‎Permissions

Matt: Created page with "cPanel Single Sign-On is available in WHMCS 6.0 and later. Single Sign-On allows users to transition from WHMCS to the cPanel or WHM interfaces without having to re-authentic..."

2015-06-11T15:30:30Z

Created page with "cPanel Single Sign-On is available in WHMCS 6.0 and later. Single Sign-On allows users to transition from WHMCS to the cPanel or WHM interfaces without having to re-authentic..."

New page

cPanel Single Sign-On is available in WHMCS 6.0 and later.

Single Sign-On allows users to transition from WHMCS to the cPanel or WHM interfaces without having to re-authenticate. It is utilised:

* In the client area to login to cPanel for shared hosting accounts
* In the client area to login to WHM for reseller hosting accounts
* In the admin area to login to cPanel for shared hosting accounts
* In the admin area to login to WHM for reseller hosting accounts
* In the admin area to login to WHM for all cPanel servers configured in the WHMCS installation

For more information on the admin area capabilities, please refer to the [[WHMCS Connect]] documentation.

==Requirements==

To use cPanel Single Sign-On your servers need to be running cPanel & WHM 11.46 and higher.

To use the deep linking functionality used within the client area your servers need to be running cPanel & WHM 11.50 and higher.

==Permissions==

All clients have permission to perform single sign-on into any hosting account within their client account.

For users with administrative privileges, you can control access to Single Sign-On functionality on a per server and per admin user group basis. For example you can say that Admin Role Group 1 can perform Single Sign-On for Servers 1 and 3, while only Admin Role Group 2 can perform Single Sign-On to Server 2.

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.

[[File:Sso-permissions.png]]

==Caveats==

* cPanel Single Sign-On can be performed for any user owned by the WHM user configured for a cPanel server within the WHMCS installation. In the case of a WHM reseller account, what this means is that if you do not own your own account you will not be able to perform Single Sign-On into it. Attempting to login will result in the error "".

@@ Line 20: / Line 20: @@
 All clients can perform single sign-on into any of their hosting accounts.
-Admins can control access to single sign-on functionality on a per-server and per-admin user group basis. 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.
+Admins can perform cPanel Single Sign-On for any account that the WHM user in the server's WHMCS configuration owns. Admins can also control access to Single Sign-On functionality on a per-server and per-admin user group basis.
 To configure server permissions:
@@ Line 39: / Line 41: @@
 [[File:Whmcs-cpanel-client-area-v6.png]]

@@ Line 23: / Line 23: @@
 To configure server permissions:
-# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''Setup > Servers'''.
+# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup > Servers'''.
 # Edit the server.
 # Under '''SSO Access Control''', select '''Restricted''' for '''Access Control'''.

@@ Line 1: / Line 1: @@
-cPanel Single Sign-On is available in WHMCS 6.0 and later.
+Single Sign-On allows users to transition from WHMCS to the cPanel or WHM interfaces without having to re-authenticate.
-Single Sign-On allows users to transition from WHMCS to the cPanel or WHM interfaces without having to re-authenticate.  It is utilised:
+Use this in the Client Area to log in to:
-* In the client area to login to cPanel for shared hosting accounts
+Use this in the Admin Area to log in to:
-* In the client area to login to WHM for reseller hosting accounts
+* cPanel for shared hosting accounts.
-* In the admin area to login to cPanel for shared hosting accounts
+* WHM for reseller hosting accounts.
-* In the admin area to login to WHM for reseller hosting accounts
+* WHM for all cPanel servers configured in the WHMCS installation.
-For more information on the admin area capabilities, please refer to the [[WHMCS Connect]] documentation.
+For more information, see [[WHMCS Connect]].
 ==Requirements==
-To use cPanel Single Sign-On your servers need to be running cPanel & WHM 11.46 and higher.
+To use this feature, you must be running a modern version of cPanel & WHM.
 ==Permissions==
-All clients have permission to perform single sign-on into any hosting account within their client account.
+All clients can perform single sign-on into any of their hosting accounts.
-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.
+Admins can control access to single sign-on functionality on a per-server and per-admin user group basis. 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.
-Permissions can be configured for a server in'''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''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.
+To configure server permissions:
 [[File:Sso-permissions.png]]
@@ Line 41: / Line 42: @@
 ==Caveats==
-* cPanel Single Sign-On can be performed for any user owned by the WHM user configured for a cPanel server within the WHMCS installation. In the case of a WHM reseller account, what this means is that if you do not own your own account you will not be able to perform Single Sign-On into it.  Attempting to login will result in the error " Action Failed Unable to auto-login. Please contact support".
+cPanel Single Sign-On can be performed for any user owned by the WHM user configured for a cPanel server within the WHMCS installation. In the case of a WHM reseller account, what this means is that if you do not own your own account you will not be able to perform Single Sign-On into it.  Attempting to login will result in the error " Action Failed Unable to auto-login. Please contact support".

@@ Line 30: / Line 30: @@
 ==Customising Single Sign-On Shortcuts==
-−
-Products assigned to the cPanel module and using a Version 6 compatible theme will see the following interface client side in WHMCS 6.0 and later.  Taking full advantage of the Single Sign-On integration between our two products, this new end-user interface is designed to provide your clients with an easy and convenient way to access many of the most commonly used functionalities of the cPanel control panel, all directly from within your WHMCS member portal.
+Products that use the cPanel module and a WHMCS 6-compatible theme will see the Client Area interface below in WHMCS 6.0 and later. Taking full advantage of the Single Sign-On integration between our two products, this new system theme is designed to provide your clients with an easy and convenient way to access many of the most commonly used functionalities of cPanel & WHM, all directly from within your WHMCS member portal.
-−
-What your end users see is controlled by the template file /modules/servers/cpanel/templates/overview.tpl and can be customised to remove any features or functionality you don't wish your users to have access to.
+What your end users see is controlled by the <tt>/modules/servers/cpanel/templates/overview.tpl</tt> file and can be customised to remove any features or functionality you don't wish your users to have access to.
-−
-Please refer to the [[Working with Module Templates]] guide for more information on how to go about customising the template.
+See [[Working with Module Templates]] for more information on customising the system theme template.
-−
 [[File:Whmcs-cpanel-client-area-v6.png]]

@@ Line 25: / Line 25: @@
 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.
-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.
+Permissions can be configured for a server in'''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''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.
 [[File:Sso-permissions.png]]

← Older revision		Revision as of 10:54, 4 March 2016
Line 41:		Line 41:
	==Caveats==		==Caveats==

−	* cPanel Single Sign-On can be performed for any user owned by the WHM user configured for a cPanel server within the WHMCS installation. In the case of a WHM reseller account, what this means is that if you do not own your own account you will not be able to perform Single Sign-On into it. Attempting to login will result in the error "".	+	* cPanel Single Sign-On can be performed for any user owned by the WHM user configured for a cPanel server within the WHMCS installation. In the case of a WHM reseller account, what this means is that if you do not own your own account you will not be able to perform Single Sign-On into it. Attempting to login will result in the error " Action Failed Unable to auto-login. Please contact support".

@@ Line 21: / Line 21: @@
 All clients have permission to perform single sign-on into any hosting account within their client account.
-For users with administrative privileges, you can control access to Single Sign-On functionality on a per server and per admin user group basis.  For example you can say that Admin Role Group 1 can perform Single Sign-On for Servers 1 and 3, while only Admin Role Group 2 can perform Single Sign-On to Server 2.
+For users with administrative privileges, you can control access to Single Sign-On functionality on a per server and per admin user group basis.
 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.