Description

This function determines whether the user enabled external authentication modules.


Examples 




https://hostname.example.com:2083/cpsess##########/execute/ExternalAuthentication/has_external_auth_modules_configured



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Determines if a cPanel user enabled any external authentication modules.
$is_external_auth = $cpanel->uapi(
    'ExternalAuthentication', 'has_external_auth_modules_configured'
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Determines if a cPanel user enabled any external authentication modules.
my $is_external_auth = $cpliveapi->uapi(
    'ExternalAuthentication', 'has_external_auth_modules_configured'
);

 



<!-- Determines if a cPanel user enabled any external authentication modules. -->
[% data = execute( 'ExternalAuthentication', 'has_external_auth_modules_configured' ); %]

 



uapi --user=username ExternalAuthentication has_external_auth_modules_configured



{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  
   },
   "data":1
}



   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible ValuesExample
dataBoolean

Whether the cPanel user enabled any external modules.

For more information, read our Password and Security and External Authentication FAQ documentation.


  • 1 — Enabled.
  • 0Not enabled.
1