cPanel API 2 Functions - Htaccess::listusers

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

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

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

DirectoryPrivacy::list_users — This function returns the users who can access a password-protected directory on the cPanel account.

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

Note:

For more information, read our Calls from the WHM API documentation.

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',
    )
);

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.

# Check authorized users who can knock on "heavensdoor" directory.
my $authorized_users = $cpliveapi->api2(
    'Htaccess', 'listusers',
    {
        'dir' => '/home/example/public_html/heavensdoor',
    }
);

Note:

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

cPanel Tag System (deprecated)

Warnings:

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

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.
You must include the --user=username option.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listusers",
    "data": [
      {
        "user": "bobdylan"
      },
      {
        "user": "wzevon"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Htaccess"
  }
}

Note:

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

Parameters

Parameter Type Description Possible values Example

Parameter	Type	Description	Possible values	Example
`dir`	string	Required The directory's name.	The absolute path to the directory.	`/home/example/public_html/heavensdoor`

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. This function only returns a `reason` value 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`