Guide to External Authentication




Pluggable external authentication modules allow users to log in through OpenID Connect-compliant identity providers. This is useful for service providers who wish to allow their customers to authenticate through their company portal.



If your server uses a firewall, you must allow traffic over ports 2083, 2087, and 2096 for External Authentication to function.


Authentication development workflow


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.


Authentication deployment workflow


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


  1. Navigate to WHM's Manage External Authentications interface (Home >> Security Center >> Manage External Authentications).
  2. Enter the Client ID and Secret parameters.
  3. Test the authentication with an account on a non-production development server.


Available platforms


We strongly recommend that you develop authentication modules in Perl.


Authentication icons


When you create your authentication module, your icons must follow these standards:


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


  • 8 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....