Page tree
Skip to end of metadata
Go to start of metadata

 

This documentation is for a previous release of cPanel & WHM. To view our latest documentation, visit our Home page.

For cPanel & WHM 54

(Home >> Security Center >> Manage External Authentications)

Overview

The Manage External Authentications interface allows you to manage the OpenID Connect-compliant identity providers that your server's users can use to log in to cPanel, WHM, or Webmail.

Notes:

  • You cannot currently link an external account to multiple cPanel accounts, WHM accounts, or Webmail accounts. However, you can link an external account to a cPanel account, a WHM account, and a Webmail account. Also, you can link multiple external accounts to the same cPanel, WHM, or Webmail account. We expect to expand this functionality in a future release.

  • If you link to an external account through an identity provider that has two-factor authentication enabled, you must also authenticate through that identity provider in addition to any two-factor authentication that you configure on your server.

Configure and enable authentication method

To add an authentication method for a cPanel service, perform the following steps:

  1. Click the Configuration tab.
  2. In the desired identity provider's row, click Configure. A new interface will appear.
  3. Enter the identity provider's configuration settings in the appropriate text boxes.
    • Most OpenID Connect-compliant identity providers require Client ID, Client Secret, and  entries.
  4. Click Save. The list of identity providers will appear.
  5. Click the appropriate switch to toggle the provider for a service from Disabled to Enabled.

To disable an identity provider for a service, click the appropriate switch to toggle the provider from Enabled to Disabled.

Important:

  • If you remove an identity provider, the system will revoke access for all credentials that require that identity provider.

  • The system automatically disables missing or misconfigured identity provider modules.
  • If you use change your server's hostname, you must update the Redirection URI settings in the configuration settings at the identity provider's site to reflect the new hostname.

Note:

Your server will automatically configure cPanelID and populate that identity provider with the necessary Client ID and Client Secret from the license server when you perform a cPanel Update (upcp).

Manage credentials

The Credentials section of the interface lists cPanel services accounts and the external authentication credentials with which they are associated.

To unlink external authentication credentials from a cPanel account, perform the following steps:

  1. Click the Manage Users tab.
  2. Click Manage in the appropriate row for that user and service.
  3. Click Unlink next to the appropriate account.
  4. Click Unlink to confirm that you wish to revoke the account.

To associate a local server account with credentials through an authentication method, read our How to Access cPanel & WHM Services documentation.

Additional documentation

  • Guide to Pluggable External Authentication — This document explains how to add a custom external authentication method to your server. This is useful for service providers who wish to allow their customers to use their portal credentials to log in to their servers.
  • OpenID Connect — cPanel uses OpenID Connect for external authentication, which is an extension of the OAuth 2.0 protocol.
  • What is cPanelID? — This document explains cPanelID.

  • No labels