Developer Documentation
Child pages
  • UAPI Functions - ExternalAuthentication::configured_modules
Skip to end of metadata
Go to start of metadata

Guide to UAPI

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Calls from the WHM API

Custom UAPI Modules


 Backup

Backup:: list_backups

 Bandwidth

Bandwidth:: get_enabled_protocols

Bandwidth:: get_retention_periods

Bandwidth:: query

 Batch

Batch:: strict

 Brand

Brand:: read

 Branding

Branding:: file

Branding:: get_applications

Branding:: get_application_information

Branding:: get_available_applications

Branding:: get_information_for_applications

Branding:: image

Branding:: include

Branding:: spritelist

 CacheBuster

CacheBuster:: read

CacheBuster:: update

 Chkservd

Chkservd:: get_exim_ports

Chkservd:: get_exim_ports_ssl

 Chrome

Chrome:: get_dom

 Contactus

Contactus:: is_enabled

 cPAddons

cPAddons:: get_available_addons

cPAddons:: get_instance_settings

cPAddons:: list_addon_instances

 cPGreyList

cPGreyList:: disable_all_domains

cPGreyList:: disable_domains

cPGreyList:: enable_all_domains

cPGreyList:: enable_domains

cPGreyList:: has_greylisting_enabled

cPGreyList:: list_domains

 DomainInfo

DomainInfo:: domains_data

DomainInfo:: list_domains

DomainInfo:: main_domain_builtin_subdomain_aliases

DomainInfo:: single_domain_data

 DNSSEC

DNSSEC:: disable_dnssec

DNSSEC:: enable_dnssec

DNSSEC:: fetch_ds_records

DNSSEC:: set_nsec3

DNSSEC:: unset_nsec3

 Email

Email:: account_name

Email:: add_auto_responder

Email:: add_domain_forwarder

Email:: add_forwarder

Email:: add_list

Email:: add_mailman_delegates

Email:: add_mx

Email:: add_pop

Email:: add_spam_filter

Email:: browse_mailbox

Email:: change_mx

Email:: check_fastmail

Email:: check_pipe_forwarder

Email:: delete_auto_responder

Email:: delete_domain_forwarder

Email:: delete_filter

Email:: delete_forwarder

Email:: delete_held_messages

Email:: delete_list

Email:: delete_mx

Email:: delete_pop

Email:: disable_filter

Email:: disable_spam_assassin

Email:: disable_spam_autodelete

Email:: disable_spam_box

Email:: dispatch_client_settings

Email:: edit_pop_quota

Email:: enable_filter

Email:: enable_spam_assassin

Email:: enable_spam_box

Email:: fetch_charmaps

Email:: fts_rescan_mailbox

Email:: generate_mailman_otp

Email:: get_auto_responder

Email:: get_charsets

Email:: get_client_settings

Email:: get_default_email_quota

Email:: get_default_email_quota_mib

Email:: get_disk_usage

Email:: get_filter

Email:: get_held_message_count

Email:: get_mailman_delegates

Email:: get_main_account_disk_usage

Email:: get_main_account_disk_usage_bytes

Email:: get_max_email_quota

Email:: get_max_email_quota_mib

Email:: get_pop_quota

Email:: get_spam_settings

Email:: get_webmail_settings

Email:: has_delegated_mailman_lists

Email:: has_plaintext_authentication

Email:: hold_outgoing

Email:: is_integer

Email:: list_auto_responders

Email:: list_default_address

Email:: list_domain_forwarders

Email:: list_filters

Email:: list_filters_backups

Email:: list_forwarders

Email:: list_forwarders_backups

Email:: list_lists

Email:: list_mail_domains

Email:: list_mxs

Email:: list_pops

Email:: list_pops_with_disk

Email:: list_system_filter_info

Email:: passwd_list

Email:: passwd_pop

Email:: release_outgoing

Email:: remove_mailman_delegates

Email:: reorder_filters

Email:: set_always_accept

Email:: set_default_address

Email:: set_list_privacy_options

Email:: stats_db_status

Email:: store_filter

Email:: suspend_incoming  

Email:: suspend_login  

Email:: suspend_outgoing

Email:: trace_filter

Email:: unsuspend_incoming

Email:: unsuspend_login

Email:: unsuspend_outgoing

Email:: verify_password

 ExternalAuthentication

ExternalAuthentication:: add_authn_link

ExternalAuthentication:: configured_modules

ExternalAuthentication:: get_authn_links

ExternalAuthentication:: has_external_auth_modules_configured  

ExternalAuthentication:: remove_authn_link  

 Features

Features:: has_feature

Features:: list_features

 Fileman

Fileman:: autocompletedir

Fileman:: empty_trash

Fileman:: get_file_content

Fileman:: get_file_information

Fileman:: list_files

Fileman:: save_file_content

Fileman:: transcode

Fileman:: upload_files

 Integration

Integration:: fetch_url

 KnownHosts

KnownHosts:: create

KnownHosts:: delete

KnownHosts:: update

KnownHosts:: verify

 LastLogin

LastLogin:: get_last_or_current_logged_in_ip

 Locale

Locale:: get_attributes

 Mailboxes

Mailboxes:: expunge_mailbox_messages  

Mailboxes:: expunge_messages_for_mailbox_guid

Mailboxes:: get_mailbox_status

 ModSecurity

ModSecurity:: disable_all_domains

ModSecurity:: disable_domains

ModSecurity:: enable_all_domains

ModSecurity:: enable_domains

ModSecurity:: has_modsecurity_installed

ModSecurity:: list_domains

 Notifications

Notifications:: get_notifications_count

 NVData

NVData:: get

NVData:: set

 Parser

Parser:: firstfile_relative_uri

 PassengerApps

PassengerApps:: disable_application

PassengerApps:: edit_application    

PassengerApps:: enable_application

PassengerApps:: list_applications

PassengerApps:: register_application

PassengerApps:: unregister_application

 PasswdStrength

PasswdStrength:: get_required_strength

 Personalization

Personalization::set

Personalization::get

 Postgresql

Postgresql:: create_database

Postgresql:: create_user

Postgresql:: delete_database

Postgresql:: get_restrictions

Postgresql:: grant_all_privileges

Postgresql:: rename_database

Postgresql:: rename_user

Postgresql:: rename_user_no_password

Postgresql:: revoke_all_privileges

Postgresql:: set_password

 Pushbullet

Pushbullet:: send_test_message

 Quota

Quota:: get_quota_info

 Resellers

Resellers:: list_accounts

 ResourceUsage

ResourceUsage:: get_usages

 Restore

Restore:: directory_listing

Restore:: get_users

Restore:: query_file_info

Restore:: restore_file  

 Session

Session:: create_temp_user

 SiteTemplates

SiteTemplates:: list_site_templates

SiteTemplates:: list_user_settings

SiteTemplates:: publish

 SpamAssassin

SpamAssassin:: clear_spam_box

SpamAssassin:: get_symbolic_test_names

SpamAssassin:: get_user_preferences

SpamAssassin:: update_user_preference

 SSH

SSH:: get_port

 StatsBar

StatsBar:: get_stats

 Styles

Styles:: current

Styles:: list

Styles:: set_default

Styles:: update

 SubDomain

SubDomain:: addsubdomain

 Themes

Themes:: get_theme_base  

Themes:: list

Themes:: update

 TwoFactorAuth

TwoFactorAuth:: generate_user_configuration

TwoFactorAuth:: get_user_configuration

TwoFactorAuth:: remove_user_configuration

TwoFactorAuth:: set_user_configuration

 UserManager

UserManager:: check_account_conflicts

UserManager:: create_user

UserManager:: delete_user

UserManager:: dismiss_user

UserManager:: edit_user

UserManager:: list_users

UserManager:: lookup_service_account

UserManager:: lookup_user

UserManager:: merge_service_account

UserManager:: unlink_service_account

 UserTasks

UserTasks:: delete

UserTasks:: retrieve

 VersionControl

VersionControl:: create

VersionControl:: delete

VersionControl:: retrieve

VersionControl:: update

 VersionControlDeployment

VersionControlDeployment:: create

VersionControlDeployment:: delete

VersionControlDeployment:: retrieve

 WebDisk

WebDisk:: delete_user

WebDisk:: set_homedir

WebDisk:: set_password

WebDisk:: set_permissions

 WebmailApps

WebmailApps:: listwebmailapps

 WebVhosts

WebVhost:: list_domains

WebVhost:: list_ssl_capable_domains

 WordPressInstanceManager

WordPressInstanceManager:: cancel_scan

WordPressInstanceManager:: cleanup_scan

WordPressInstanceManager:: change_admin_password

WordPressInstanceManager:: configure_autoupdate

WordPressInstanceManager:: get_api_version 

WordPressInstanceManager:: get_instance_by_id

WordPressInstanceManager:: get_instances

WordPressInstanceManager:: get_latest_wordpress_version_from_wordpress_org

WordPressInstanceManager:: get_scan_results

WordPressInstanceManager:: is_installable_addon_available

WordPressInstanceManager:: start_scan

 

 



 

 

Description

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

Examples 

 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/ExternalAuthentication/configured_modules


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List the external authentication identity provider modules configured on the server
$configured_modules = $cpanel->uapi(
    'ExternalAuthentication', 'configured_modules'

);


Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List the external authentication identity provider modules configured on the server
my $configured_modules = $cpliveapi->uapi(
    'ExternalAuthentication', 'configured_modules',

);


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Template Toolkit
<!-- List the external authentication identity provider modules configured on the server -->
[% data = execute( 'ExternalAuthentication', 'configured_modules'} ); %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username ExternalAuthentication configured_modules


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 

  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  

   },
   "data":[  
         {  
            "link":"/openid_connect/google",
            "icon":"iVBORw0KGgoAAAANSUhEUgAAACEAAAAhCAYAAABX5MJvAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAV1JREFUeNrsVtGNwjAMJegGYIRucBmhtwEjdAMyQjYoG2SEG6HcBGUDugFskHOQg1zTlFaN\/\/KkqMh2yYvt53S3KygomIZaE+y9P8BDJ9xXpdSDxT9jwX7dxDJsDMvCuvl33GF1sBwS5O8GX7eVgCabGyRkGJF25v0sJHrcyDH7iMhWEl9zWSD1\/xs1klJn8J\/gZ4WxNdgu8KyiDXGIfmJ7LO6R8CI5rJnwO+Kv0Wb9Z7xlZr+wMt8f\/ANmyCoCMF3CUmP8rOmHip1AM\/8tdbLcjfnL5NigYmIp+ilp5iYRJNkmajtLIBuJiUZ1S+aDKGDjI8tGk+N\/9yuy0ODcGIjL8UEmcXKLDelRDQ5tHcuIkSLQE1WYhIRfMRIEmiV1Z7NES5Rh9nIisRGVWGOyyyflC5fSkDsTmk1KnVBMbForqQw+IVtUCP3KEpdojffHnRGKcq3LZ3pBgST+BRgANXt+WPKE7tYAAAAASUVORK5CYII=",
            "icon_type":"image/svg+xml";
            "provider_protocol":"openid_connect",
            "provider_id":"google",
            "display_name":"Google",
            "documentation_url":"https://developers.google.com/identity/protocols/OpenIDConnect",
            "color":"dd4b39",
            "label":"Log in with a Google+ Account",
            "textcolor":"FFFFFF"
         },
         {  
            "link":"/openid_connect/microsoft_live",
            "icon":"iVBORw0KGgoAAAANSUhEUgAAACMAAAAhCAYAAABTERJSAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw\/eHBhY2tldCBiZWdpbj0i77u\/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDoxMTNFRUVGMzIyODUxMUU1OUM1RERGODcwRjIwNTQ4MCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDoxMTNFRUVGNDIyODUxMUU1OUM1RERGODcwRjIwNTQ4MCI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOjExM0VFRUYxMjI4NTExRTU5QzVEREY4NzBGMjA1NDgwIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOjExM0VFRUYyMjI4NTExRTU5QzVEREY4NzBGMjA1NDgwIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+oa0v2AAAA3VJREFUeNrsWM1uFEcQruqent3Z9Y43DmuD2YT1LoIICSIgEULKC+SaF8gr5JAnyD3XKCcChxxyyhNYiFMU5ZRTzE8UuGCQY8DGeGd3Zqrydc\/ajiWjBHCEpWxLPf1T01VfV\/d09TesqnRUUuQfN+5tUzMylAsRM9EOPlTJV0V9qWQg3BgLXek4+mUtpxKy+bqhAvIcLxVSlT4FHVAQITegO7Z8vGFpqeW4P+N40Iy434rNR23Hcd3ymV0wL00TNIJH6UsY2syVsrICuTlWGFJyAJlYrtVj7jUi9gZhzPQSS4tJRO+1nF1C\/aThoHFfgp7n+zzjZ+GNjUWDB7yHRPYAQQnV8MCMOu04ughvPEbzztV599UHbXvOGe7OwHhsKH3jZdrKiZwhgrtcYs0ilJ6A4ffhytMpZtmAa\/3s4OYuQFhg\/m75IX1xtm2\/XKjbw90zn3Zr19+p81W4dr5mqP0vxslkOx3+Bu6n9jOsROttf02GjlCagpmCmYI5VDD8GuP0tYYdHP72HXq3N4prTcfHEA6ev8ir2OSjLwK0jkvRoRAjNmlkFG1aGAktPxrK6NZq\/o3lwh1POPtkIQ4ncqm7Y2lcqua4o4zKKr4h66ggLrSSo2zinfUrnXgPzM9r+c0P51wySE22NhTBNUEQnVGqbuZSrm6LXJhzMkit\/JmVdfT\/vl1QcXej+H4r91cLyrtNW\/ZmrG4AydORytMRyrHXpfJgq5TL70Zy+Vgs97JCnwS5yhOgRD3fAUP+coW8qa+Q4Kxr3\/72Il0dFqEtPsuubLctupdflqSyHXBEkzvFq26AfYGS\/7b4hg\/YDNNPewpmCuZ\/DwYn5I\/rI7mLY\/7ZW2eUy6ujz\/0ZBZoSz8a8CB50ohkRqIo57QkZiNhS6mw\/qaiKwYHmySXzfwGmorZKw1LGOjb3s7K8r8o\/CRXhIPXZU9Sa5Q441aVByz5CoMtXnpVfyyydQ4DtQt4DzXkjhsE+JvzwRxZ4smeToKehHpgtVzxbAuPUwDwR2Oj8XES\/rueB5nbqDJCeBJo6xvZmQG8bEQ1mY3Mqifgk+jzb9H3dgzzp6S3603\/m2hOv+OwmRDnFTQHLFdaphWAL8h68mpWSbRW08lBoxf8I8IQfohCrEu9VLD1Yqmel\/TQOSz5oxfzxrDN2h5TyUfolcqQ+7b8EGACd0Ob6pUnq9QAAAABJRU5ErkJggg==",
            "icon_type":"image/svg+xml";
            "provider_protocol":"openid_connect",
            "provider_id":"microsoft_live",
            "display_name":"Microsoft Live",
            "documentation_url":"https://dev.onedrive.com/app-registration.htm",
            "color":"00aef0",
            "label":"Log in with a Microsoft Account",
            "textcolor":"FFFFFF"
         },
         {  
            "link":"/openid_connect/cpanelid",
            "icon":"iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAACXBIWXMAAAsTAAALEwEAmpwYAAAKT2lDQ1BQaG90b3Nob3AgSUNDIHByb2ZpbGUAAHjanVNnVFPpFj333vRCS4iAlEtvUhUIIFJCi4AUkSYqIQkQSoghodkVUcERRUUEG8igiAOOjoCMFVEsDIoK2AfkIaKOg6OIisr74Xuja9a89+bN\/rXXPues852zzwfACAyWSDNRNYAMqUIeEeCDx8TG4eQuQIEKJHAAEAizZCFz\/SMBAPh+PDwrIsAHvgABeNMLCADATZvAMByH\/w\/qQplcAYCEAcB0kThLCIAUAEB6jkKmAEBGAYCdmCZTAKAEAGDLY2LjAFAtAGAnf+bTAICd+Jl7AQBblCEVAaCRACATZYhEAGg7AKzPVopFAFgwABRmS8Q5ANgtADBJV2ZIALC3AMDOEAuyAAgMADBRiIUpAAR7AGDIIyN4AISZABRG8lc88SuuEOcqAAB4mbI8uSQ5RYFbCC1xB1dXLh4ozkkXKxQ2YQJhmkAuwnmZGTKBNA\/g88wAAKCRFRHgg\/P9eM4Ors7ONo62Dl8t6r8G\/yJiYuP+5c+rcEAAAOF0ftH+LC+zGoA7BoBt\/qIl7gRoXgugdfeLZrIPQLUAoOnaV\/Nw+H48PEWhkLnZ2eXk5NhKxEJbYcpXff5nwl\/AV\/1s+X48\/Pf14L7iJIEyXYFHBPjgwsz0TKUcz5IJhGLc5o9H\/LcL\/\/wd0yLESWK5WCoU41EScY5EmozzMqUiiUKSKcUl0v9k4t8s+wM+3zUAsGo+AXuRLahdYwP2SycQWHTA4vcAAPK7b8HUKAgDgGiD4c93\/+8\/\/UegJQCAZkmScQAAXkQkLlTKsz\/HCAAARKCBKrBBG\/TBGCzABhzBBdzBC\/xgNoRCJMTCQhBCCmSAHHJgKayCQiiGzbAdKmAv1EAdNMBRaIaTcA4uwlW4Dj1wD\/phCJ7BKLyBCQRByAgTYSHaiAFiilgjjggXmYX4IcFIBBKLJCDJiBRRIkuRNUgxUopUIFVIHfI9cgI5h1xGupE7yAAygvyGvEcxlIGyUT3UDLVDuag3GoRGogvQZHQxmo8WoJvQcrQaPYw2oefQq2gP2o8+Q8cwwOgYBzPEbDAuxsNCsTgsCZNjy7EirAyrxhqwVqwDu4n1Y8+xdwQSgUXACTYEd0IgYR5BSFhMWE7YSKggHCQ0EdoJNwkDhFHCJyKTqEu0JroR+cQYYjIxh1hILCPWEo8TLxB7iEPENyQSiUMyJ7mQAkmxpFTSEtJG0m5SI+ksqZs0SBojk8naZGuyBzmULCAryIXkneTD5DPkG+Qh8lsKnWJAcaT4U+IoUspqShnlEOU05QZlmDJBVaOaUt2ooVQRNY9aQq2htlKvUYeoEzR1mjnNgxZJS6WtopXTGmgXaPdpr+h0uhHdlR5Ol9BX0svpR+iX6AP0dwwNhhWDx4hnKBmbGAcYZxl3GK+YTKYZ04sZx1QwNzHrmOeZD5lvVVgqtip8FZHKCpVKlSaVGyovVKmqpqreqgtV81XLVI+pXlN9rkZVM1PjqQnUlqtVqp1Q61MbU2epO6iHqmeob1Q\/pH5Z\/YkGWcNMw09DpFGgsV\/jvMYgC2MZs3gsIWsNq4Z1gTXEJrHN2Xx2KruY\/R27iz2qqaE5QzNKM1ezUvOUZj8H45hx+Jx0TgnnKKeX836K3hTvKeIpG6Y0TLkxZVxrqpaXllirSKtRq0frvTau7aedpr1Fu1n7gQ5Bx0onXCdHZ4\/OBZ3nU9lT3acKpxZNPTr1ri6qa6UbobtEd79up+6Ynr5egJ5Mb6feeb3n+hx9L\/1U\/W36p\/VHDFgGswwkBtsMzhg8xTVxbzwdL8fb8VFDXcNAQ6VhlWGX4YSRudE8o9VGjUYPjGnGXOMk423GbcajJgYmISZLTepN7ppSTbmmKaY7TDtMx83MzaLN1pk1mz0x1zLnm+eb15vft2BaeFostqi2uGVJsuRaplnutrxuhVo5WaVYVVpds0atna0l1rutu6cRp7lOk06rntZnw7Dxtsm2qbcZsOXYBtuutm22fWFnYhdnt8Wuw+6TvZN9un2N\/T0HDYfZDqsdWh1+c7RyFDpWOt6azpzuP33F9JbpL2dYzxDP2DPjthPLKcRpnVOb00dnF2e5c4PziIuJS4LLLpc+Lpsbxt3IveRKdPVxXeF60vWdm7Obwu2o26\/uNu5p7ofcn8w0nymeWTNz0MPIQ+BR5dE\/C5+VMGvfrH5PQ0+BZ7XnIy9jL5FXrdewt6V3qvdh7xc+9j5yn+M+4zw33jLeWV\/MN8C3yLfLT8Nvnl+F30N\/I\/9k\/3r\/0QCngCUBZwOJgUGBWwL7+Hp8Ib+OPzrbZfay2e1BjKC5QRVBj4KtguXBrSFoyOyQrSH355jOkc5pDoVQfujW0Adh5mGLw34MJ4WHhVeGP45wiFga0TGXNXfR3ENz30T6RJZE3ptnMU85ry1KNSo+qi5qPNo3ujS6P8YuZlnM1VidWElsSxw5LiquNm5svt\/87fOH4p3iC+N7F5gvyF1weaHOwvSFpxapLhIsOpZATIhOOJTwQRAqqBaMJfITdyWOCnnCHcJnIi\/RNtGI2ENcKh5O8kgqTXqS7JG8NXkkxTOlLOW5hCepkLxMDUzdmzqeFpp2IG0yPTq9MYOSkZBxQqohTZO2Z+pn5mZ2y6xlhbL+xW6Lty8elQfJa7OQrAVZLQq2QqboVFoo1yoHsmdlV2a\/zYnKOZarnivN7cyzytuQN5zvn\/\/tEsIS4ZK2pYZLVy0dWOa9rGo5sjxxedsK4xUFK4ZWBqw8uIq2Km3VT6vtV5eufr0mek1rgV7ByoLBtQFr6wtVCuWFfevc1+1dT1gvWd+1YfqGnRs+FYmKrhTbF5cVf9go3HjlG4dvyr+Z3JS0qavEuWTPZtJm6ebeLZ5bDpaql+aXDm4N2dq0Dd9WtO319kXbL5fNKNu7g7ZDuaO\/PLi8ZafJzs07P1SkVPRU+lQ27tLdtWHX+G7R7ht7vPY07NXbW7z3\/T7JvttVAVVN1WbVZftJ+7P3P66Jqun4lvttXa1ObXHtxwPSA\/0HIw6217nU1R3SPVRSj9Yr60cOxx++\/p3vdy0NNg1VjZzG4iNwRHnk6fcJ3\/ceDTradox7rOEH0x92HWcdL2pCmvKaRptTmvtbYlu6T8w+0dbq3nr8R9sfD5w0PFl5SvNUyWna6YLTk2fyz4ydlZ19fi753GDborZ752PO32oPb++6EHTh0kX\/i+c7vDvOXPK4dPKy2+UTV7hXmq86X23qdOo8\/pPTT8e7nLuarrlca7nuer21e2b36RueN87d9L158Rb\/1tWeOT3dvfN6b\/fF9\/XfFt1+cif9zsu72Xcn7q28T7xf9EDtQdlD3YfVP1v+3Njv3H9qwHeg89HcR\/cGhYPP\/pH1jw9DBY+Zj8uGDYbrnjg+OTniP3L96fynQ89kzyaeF\/6i\/suuFxYvfvjV69fO0ZjRoZfyl5O\/bXyl\/erA6xmv28bCxh6+yXgzMV70VvvtwXfcdx3vo98PT+R8IH8o\/2j5sfVT0Kf7kxmTk\/8EA5jz\/GMzLdsAAAAgY0hSTQAAeiUAAICDAAD5\/wAAgOkAAHUwAADqYAAAOpgAABdvkl\/FRgAAAcVJREFUeNrs1k+IT1EUB\/DP783DlIaSjZVC+VM2E42V2EupmShRYmFhYUGU1WQjsrK3UlOjkLJRqMlilL\/FjiI2jGYxocn4OTb3V8\/t\/eY3T5Hi1Ol2z\/ned+75nntOrxURfrcU\/oD820EGcBXvMZXpa9zE8E8nIqKpHoqFyXhEDESE8hcy2bFA3Aj6MNJq+IQX4xk2NDizN89kPfZhCMsz3zQuYk3FNof9eJvqO4TRVLeOHK5yfSIiZubheCIijma25zU1O55h3nQyOYVzPdK+g62ZbaIGdz+nuMBmnO0RYAb3sL0mcC67s\/1UiSNYlDkup1t+S\/sn6Me6CuZTwmzCWpTpEseybz0QEY8yDi916Y\/TGe52ROyKiNke\/bKtwKos8lgXynbW1OMAlsxD8wVMFviaOQZrwCuxpbL\/jlc1NepIG+fTg1LiBVZXAKP4gocJ\/DIFXlHBvMPHNL8+VOyf8RhXMFmdXcNduGxHxFxEnIyIM5nvVkQUEdGX1o7WzrsC13Cjy4QuU1Y5LXcTZe20drReUrRlEXG9JpvZ9ILySTDYZHKXlWbbk+bQQWzE0lSX\/tQv02kdw9MmU7X1\/0firwvyYwBM1QP5WTjUAAAAAABJRU5ErkJggg==",
            "icon_type":"image/svg+xml";
            "provider_protocol":"openid_connect",
            "provider_id":"cpanelid",
            "display_name":"CpanelID",
            "documentation_url":"http://go.cpanel.net/cpanelidmanage",
            "color":"FF6C2C",
            "label":"Log in with a cPanelID",
            "textcolor":"000000"
         }
      ]
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample

icon

string

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

A valid Base64-encoded image file.
 Click to view...
iVBORw0KGgoAAAANSUhEUgAAACMAAAAhCAYAAABTERJSAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDoxMTNFRUVGMzIyODUxMUU1OUM1RERGODcwRjIwNTQ4MCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDoxMTNFRUVGNDIyODUxMUU1OUM1RERGODcwRjIwNTQ4MCI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOjExM0VFRUYxMjI4NTExRTU5QzVEREY4NzBGMjA1NDgwIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOjExM0VFRUYyMjI4NTExRTU5QzVEREY4NzBGMjA1NDgwIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+oa0v2AAAA3VJREFUeNrsWM1uFEcQruqent3Z9Y43DmuD2YT1LoIICSIgEULKC+SaF8gr5JAnyD3XKCcChxxyyhNYiFMU5ZRTzE8UuGCQY8DGeGd3Zqrydc/ajiWjBHCEpWxLPf1T01VfV/d09TesqnRUUuQfN+5tUzMylAsRM9EOPlTJV0V9qWQg3BgLXek4+mUtpxKy+bqhAvIcLxVSlT4FHVAQITegO7Z8vGFpqeW4P+N40Iy434rNR23Hcd3ymV0wL00TNIJH6UsY2syVsrICuTlWGFJyAJlYrtVj7jUi9gZhzPQSS4tJRO+1nF1C/aThoHFfgp7n+zzjZ+GNjUWDB7yHRPYAQQnV8MCMOu04ughvPEbzztV599UHbXvOGe7OwHhsKH3jZdrKiZwhgrtcYs0ilJ6A4ffhytMpZtmAa/3s4OYuQFhg/m75IX1xtm2/XKjbw90zn3Zr19+p81W4dr5mqP0vxslkOx3+Bu6n9jOsROttf02GjlCagpmCmYI5VDD8GuP0tYYdHP72HXq3N4prTcfHEA6ev8ir2OSjLwK0jkvRoRAjNmlkFG1aGAktPxrK6NZq/o3lwh1POPtkIQ4ncqm7Y2lcqua4o4zKKr4h66ggLrSSo2zinfUrnXgPzM9r+c0P51wySE22NhTBNUEQnVGqbuZSrm6LXJhzMkit/JmVdfT/vl1QcXej+H4r91cLyrtNW/ZmrG4AydORytMRyrHXpfJgq5TL70Zy+Vgs97JCnwS5yhOgRD3fAUP+coW8qa+Q4Kxr3/72Il0dFqEtPsuubLctupdflqSyHXBEkzvFq26AfYGS/7b4hg/YDNNPewpmCuZ/DwYn5I/rI7mLY/7ZW2eUy6ujz/0ZBZoSz8a8CB50ohkRqIo57QkZiNhS6mw/qaiKwYHmySXzfwGmorZKw1LGOjb3s7K8r8o/CRXhIPXZU9Sa5Q441aVByz5CoMtXnpVfyyydQ4DtQt4DzXkjhsE+JvzwRxZ4smeToKehHpgtVzxbAuPUwDwR2Oj8XES/rueB5nbqDJCeBJo6xvZmQG8bEQ1mY3Mqifgk+jzb9H3dgzzp6S3603/m2hOv+OwmRDnFTQHLFdaphWAL8h68mpWSbRW08lBoxf8I8IQfohCrEu9VLD1Yqmel/TQOSz5oxfzxrDN2h5TyUfolcqQ+7b8EGACd0Ob6pUnq9QAAAABJRU5ErkJggg==
icon_typestringThe icon file's MIME type.A valid image format's MIME type.image/svg+xml

link

string

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

A valid URL.https://hostname.example.com:2083/openid_connect/cpanelid

provider_name

string

The identity provider's system name.

A valid string.cpanelid

display_name

string

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

A valid string.cPanel ID

documentation_url

string

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

A valid URL.
https://go.cpanel.net/OpenIDConnect

color

string

The background color of the button on the cPanel interface.

A valid RGB hexadecimal color value.00aef0

label

string

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

A valid string.Log in with a cPanel ID Account

textcolor

string

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

A valid RGB hexadecimal color value.FFFFFF

Function information

Module:

ExternalAuthentication

API Version:

UAPI

Available in:

cPanel 54+

Methods:

GET, POST

Required Parameters:

(none)

Return formats:

JSON, XML

Legacy Equivalents:

(none)

About this module

The ExternalAuthentication module manages third-party authentication.

About UAPI

UAPI accesses and modifies data for cPanel accounts.

Notes:

  • These functions may require specific features. To enable or disable features, use WHM's Feature Manager interface.
  • Unless you call this API via the WHM API, you must use the appropriate cPanel ports (2082 or 2083). You can also call some functions via cPanel's Webmail ports (2095 or 2096). 
  

Find a function

Related functions