Difference between revisions of "CPanel Single Sign-On"
From WHMCS Documentation
(→Caveats) |
|||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | 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 | + | For more information, see [[WHMCS Connect]]. |
==Requirements== | ==Requirements== | ||
| − | To use | + | To use this feature, you must be running a modern version of cPanel & WHM. |
| − | |||
| − | |||
==Permissions== | ==Permissions== | ||
| − | All clients | + | All clients can perform single sign-on into any of their hosting accounts. |
| − | |||
| − | |||
| − | For example you can allow users of | + | 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>. | ||
| − | + | 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]] | ||
==Customising Single Sign-On Shortcuts== | ==Customising Single Sign-On Shortcuts== | ||
| − | + | ||
| − | Products | + | 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 | + | 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. |
| − | + | ||
| − | + | See [[Working with Module Templates]] for more information on customising the system theme template. | |
| − | + | ||
[[File:Whmcs-cpanel-client-area-v6.png]] | [[File:Whmcs-cpanel-client-area-v6.png]] | ||
| − | |||
| − | |||
| − | |||
| − | |||
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:
- Go to Configuration () > 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.
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.
