Difference between revisions of "CPanel Single Sign-On"

From WHMCS Documentation

(→‎Customising Single Sign-On Shortcuts)
 
(2 intermediate revisions by the same user not shown)
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:
 +
* cPanel for shared hosting accounts.
 +
* WHM for reseller hosting accounts.
  
−
* 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.
−
* 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.
+
For more information, see [[WHMCS Connect]].
  
 
==Requirements==
 
==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.
−
 
 
−
To use the deep linking functionality used within the client area your servers need to be running cPanel & WHM 11.50 and higher.
 
  
 
==Permissions==
 
==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 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 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.
 +
* 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.
 +
* If you are using a reseller account, you '''must''' own your own account in order to perform Single Sign-On into it. If you do not, attempting to log in will result in the error <tt>Action Failed Unable to auto-login. Please contact support</tt>.
  
−
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:
 +
# 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'''.
 +
# Choose the admin role groups to allow to use single sign-on.
  
 
[[File:Sso-permissions.png]]
 
[[File:Sso-permissions.png]]
Line 38: Line 41:
 
   
 
   
 
[[File:Whmcs-cpanel-client-area-v6.png]]
 
[[File:Whmcs-cpanel-client-area-v6.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 " Action Failed Unable to auto-login. Please contact support".
 

Latest revision as of 16:48, 29 June 2023

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

Use this in the Client Area to log in to:

  • cPanel for shared hosting accounts.
  • WHM for reseller hosting accounts.

Use this in the Admin Area to log in to:

  • cPanel for shared hosting accounts.
  • WHM for reseller hosting accounts.
  • WHM for all cPanel servers configured in the WHMCS installation.

For more information, see WHMCS Connect.

Requirements

To use this feature, you must be running a modern version of cPanel & WHM.

Permissions

All clients can perform single sign-on into any of their hosting accounts.

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.

  • 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.
  • If you are using a reseller account, you must own your own account in order to perform Single Sign-On into it. If you do not, attempting to log in will result in the error Action Failed Unable to auto-login. Please contact support.

To configure server permissions:

  1. Go to Configuration () > System Settings > Servers or, prior to WHMCS 8.0, Setup > Servers.
  2. Edit the server.
  3. Under SSO Access Control, select Restricted for Access Control.
  4. Choose the admin role groups to allow to use single sign-on.

Sso-permissions.png

Customising Single Sign-On Shortcuts

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 /modules/servers/cpanel/templates/overview.tpl file and can be customised to remove any features or functionality you don't wish your users to have access to.

See Working with Module Templates for more information on customising the system theme template.

Whmcs-cpanel-client-area-v6.png

Retrieved from "http://3.17.75.209/index.php?title=CPanel_Single_Sign-On&oldid=34128"