Child pages
  • UAPI Functions - ExternalAuthentication::has_external_auth_modules_configured

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function determines

if a cPanel

whether the user enabled

any

external authentication modules.


Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


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

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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'
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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'
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Template Toolkit


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

Include Page
LIB:_TTLink
LIB:_TTLink

 


Expand
titleCommand Line


Code Block
languagebash
uapi --user=username ExternalAuthentication has_external_auth_modules_configured

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  
   },
   "data":1
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible ValuesExample
dataBoolean

Whether the cPanel user enabled any external modules.

Note
titleNote:

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


  • 1 — Enabled.
  • 0Not enabled.
1