Development Guides Home

Guide to External Authentication

Introduction

External Authentication modules allow users to log in through OpenID Connect-compliant identity providers. OpenID Connect is an identity standard that overlays the OAuth 2.0 standard for Google®, Microsoft®, PayPal®, and other major online companies and organizations. For more information about OpenID Connect, read OpenID Connect's website.

Basic usage

When you develop your authentication module, we recommend the following workflow:

1. Research the supported parameters for your chosen identity provider.
2. Copy the provided sample authentication module.
3. Configure the module with overrides that match the supported parameters for your identity provider.

After you develop and configure your authentication module, we recommend the following workflow to deploy the module:

• Navigate to WHM's Manage External Authentications interface ( WHM >> Home >> Security Center >> Manage External Authentications ).
• Enter the appropriate information in the Client ID and Secret text boxes.
• Test authentication with an account on a non-production development server.

Icons

When you create your authentication module, your icons must meet the following criteria:

• Icons should be 32 pixels by 32 pixels.
• Image files must be in the JPG or PNG formats.
• Images must have white backgrounds and cannot be transparent.

Provider modules

cPanelID and WHMCS External Authentication identity provider modules are available by default in cPanel & WHM version 54 and later. Additional modules for Facebook®, Google, and Amazon® are available as samples to allow service providers to develop their own modules.

cPanelID uses the same username and password that the cPanel Tickets System, the Manage2 billing system, and the cPanel Store use. It uses OpenID standards to allow cross-platform authentication and logins.