cPanel module

ExternalAuthentication

5 functions, invoked through the cpanel_uapi tool.

scope cpanel:uapi

Call any function with cpanel_uapi(service_id, module="ExternalAuthentication", function, params). Live availability depends on the cPanel features JetHost has enabled on your account — call list_cpanel_operations to see what is active.

add_authn_link GET#

Add external authentication link

This function adds an External Authentication authorization link to an account.

preferred_usernamestringRequired

The preferred username of the account on the identity provider.

provider_idstringRequired

The name of the identity provider.

subject_unique_identifierstringRequired

The unique identifier for the user at the identity provider.

usernamestringRequired

The username.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.

configured_modules GET#

Return server's external authentication providers

This function lists the display information for your server's available and configured external authentication identity provider modules.

No parameters.

Response — normalized as { ok, data, errors[], warnings[] }; data is an array of:

colorstring

The background color of the button on the cPanel interface.

display_namestring

The identity provider's friendly name. cPanel & WHM interfaces will display this value.

documentation_urlstring

The public URL of the identity provider's implementation documentation.

iconstring

The icon file to display on the button in the cPanel login interface.

icon_typestring

The icon file's MIME type.

labelstring

The text label of the login icon in the cPanel login interface.

linkstring

link to the identity provider's configuration for the appropriate service on the system.

provider_namestring

The identity provider's system name.

textcolorstring

The color of the text label in the cPanel login interface.

get_authn_links GET#

Return external authentication links

This function lists the external authentication links to the current cPanel account.

No parameters.

Response — normalized as { ok, data, errors[], warnings[] }; data is an array of:

link_timeinteger

When the user linked their account to the identity provider.

preferred_usernamestring

The preferred username of the account on the identity provider.

provider_idstring

The system's unique key for the identity provider.

provider_protocolstring

The identity provider's protocol.

subject_unique_identifierinteger

The unique identifier for the user at the identity provider.

has_external_auth_modules_configured GET#

Return external authentication user status

This function determines whether the user enabled external authentication modules.

No parameters.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Whether the cPanel user enabled any external modules. 1 - Enabled. 0 - Not enabled. Note: For more information, read our Password and Security and External Authentication FAQ documentation.

remove_authn_link GET#

Remove external authentication link

This function removes a link to an account at an external authentication identity provider.

providerstringRequired

The name of the identity provider.

subject_unique_identifierstringRequired

The unique identifier for the user at the identity provider.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.