cPanel API 2 Functions - MysqlFE::listusers - Knowledgebase

Description

This function lists an account's MySQL® database users.

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=MysqlFE&cpanel_jsonapi_func=listusers

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// List database users.

$list_users = $cpanel->api2(

'MysqlFE', 'listusers'

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# List database users.

my $list_users = $cpliveapi->api2(

'MysqlFE', 'listusers',

);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only 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 MysqlFE listusers

Notes:

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

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "data": [
      {
        "dblist": [
            
        ],
        "shortuser": "cpses_ex24NqG8AX",
        "user": "cpses_ex24NqG8AX"
      },
      {
        "dblist": [
            
        ],
        "shortuser": "cpses_exbO3uMNZD",
        "user": "cpses_exbO3uMNZD"
      },
      {
        "dblist": [
            
        ],
        "shortuser": "bobby",
        "user": "example_bobby"
      },
      {
        "dblist": [
          {
            "db": "example_fred",
            "user": "example_fred"
          }
        ],
        "shortuser": "fred",
        "user": "example_fred"
      },
      {
        "dblist": [
          {
            "db": "example_test",
            "user": "example_username"
          }
        ],
        "shortuser": "username",
        "user": "example_username"
      }
    ],
    "func": "listusers",
    "event": {
      "result": 1
    },
    "module": "MysqlFE"
  }
}

Note:

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

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
dblist	hash	A hash of databases and their authorized users.	A hash that contains the dband user returns.
db	string	The database name. The function returns this value in thedblist hash.	A valid database name.	example_database
user	string	The database username. The function returns this value in thedblist hash.	A valid database username.	example_user1
shortuser	string	The short version of the database username.	A valid database username, without any database prefix.	user1
user	string	The database username.	A valid database username.	example_user1
reason	string	A reason for failure. Note: This function only returns areason 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

Knowledgebase

Categories

Categories