Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
UAPI Functions - ExternalAuthentication::has_external_auth_modules_configured - Developer Documentation - cPanel Documentation
Child pages
  • UAPI Functions - ExternalAuthentication::has_external_auth_modules_configured
Skip to end of metadata
Go to start of metadata

Description

This function determines whether the user enabled external authentication modules.

Examples 


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


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.
 
// Determines if a cPanel user enabled any external authentication modules.
$is_external_auth = $cpanel->uapi(
    'ExternalAuthentication', 'has_external_auth_modules_configured'
);


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.
 
# Determines if a cPanel user enabled any external authentication modules.
my $is_external_auth = $cpliveapi->uapi(
    'ExternalAuthentication', 'has_external_auth_modules_configured'
);


Note:

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


 Command Line
uapi --user=username ExternalAuthentication has_external_auth_modules_configured


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":1
}


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
dataBoolean

Whether the cPanel user enabled any external modules.

Note:

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

  • 1 — Enabled.
  • 0Not enabled.
1