cPanel API 2 Functions - Htaccess::listusers

Description

This function retrieves a directory's authorized users from the .htaccess file.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

 

Examples 


 WHM API (JSON)

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Htaccess&cpanel_jsonapi_func=listusers&dir=%2Fhome%2Fexample%2Fpublic_html%2Fheavensdoor

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// Check authorized users who can knock on "heavensdoor" directory.
$authorized_users $cpanel->api2(
    'Htaccess''listusers'
    array(
        'dir' => '/home/example/public_html/heavensdoor',
    
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Check authorized users who can knock on "heavensdoor" directory.
my $authorized_users $cpliveapi->api2(
    'Htaccess''listusers',
    {
        'dir' => '/home/example/public_html/heavensdoor',
    }
);

 cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that youonly use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 

 Command Line

cpapi2 --user=username Htaccess listusers dir=%2Fhome%2Fexample%2Fpublic_html%2Fheavensdoor

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)

 

Note:

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

 

Parameters

 Parameter 

 Type 

Description

Possible values

Example

 dir

 string 

 Required

 The directory's name. 

 The absolute path to the directory. 

 /home/example/public_html/heavensdoor 

 

Returns

 Return

Type

Description

Possible values

Example

 

 array of hashes 

 An array of hashes that contains information about each authorized user. 

 This array of hashes includes the user return. 

 

 user

 string

 The authorized user's username.

 The function returns this value in the unnamed array of hashes.

 A valid cPanel username.

 bobdylan

 reason

 string

 A reason for failure.

 Note:

 This function only returns a reasonvalue if it failed.

 A string that describes the error.

 This is an error message. 

 result

 Boolean

 Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.

 1

 

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....