Description

This function lists MySQL® database users that are authorized to use a database.

Examples 




https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=MysqlFE&cpanel_jsonapi_func=listusersindb&db=example_database



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List database users.
$list_users = $cpanel->api2(
    'MysqlFE', 'listusersindb', 
    array(
        'db' => 'example_database',
 ) 
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List database users.
my $list_users = $cpliveapi->api2(
    'MysqlFE', 'listusersindb',
    { 
        'db' => 'example_database',
    }
);

 




cpapi2 --user=username MysqlFE listusersindb db=example_database



{
  "cpanelresult": {
    "apiversion": 2,
    "data": [
      {
        "db": "example_db1",
        "user": "example_user1"
      }
    ],
    "func": "listusersindb",
    "event": {
      "result": 1
    },
    "module": "MysqlFE"
  }
}



Parameters

ParameterTypeDescriptionPossible valuesExample
dbstring

Required

The database name.

A valid database name.
example_database

Returns

Return TypeDescriptionPossible valuesExample
 hashA hash of databases and their authorized users.A hash of the db and user returns. 

db

string

The database name.

The function returns this value in the hash of database information.

A valid database name.
example_database

user

string

The database username.

The function returns this value in the hash of database information.

A valid database username.example_user1
reasonstring

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.
resultBoolean

Whether the function succeeded.

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