cPanel API 2 Functions - MysqlFE::listusersindb

Description

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

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=listusersindb&db=example_database

 LiveAPI PHP Class

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

 LiveAPI Perl Module

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

 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 listusersindb db=example_database

 

Notes:

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

 Output (JSON)

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

 

Note:

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

 

Parameters

 Parameter 

 Type 

Description

Possible values

Example

 db

 string 

Required

 The database name. 

 A valid database name. 

 example_database 

 

Returns

 Return

Type

Description

Possible values

Example

 

 hash

A hash of databases and their authorized users.

A hash of the dband 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

 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

 

  • 4 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....