cPanel API 2 Functions - MysqlFE::getdbuserprivileges - Knowledgebase

Description

This function lists a database user's privileges on a database.

Warning:

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

Mysql::get_privileges_on_database — This function lists a MySQL® database user's privileges.

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=getdbuserprivileges

LiveAPI PHP Class

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

// Retrieve the permissions that a database user has on a database

$get_permissions = $cpanel->api2(

'MysqlFE', 'getdbuserprivileges',

);

LiveAPI Perl Module

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

# Retrieve the permissions that a database user has on a database

my $get_permissions = $cpliveapi->api2(

'MysqlFE', 'getdbuserprivileges',

);

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.

 Output (JSON)

 {
  "cpanelresult": {
    "apiversion": 2,
    "data": [
      "ALTER",
      "CREATE ROUTINE",
      "CREATE TEMPORARY TABLES",
      "DROP",
      "INSERT",
      "LOCK TABLES",
      "SHOW VIEW",
      "TRIGGER"
    ],
    "func": "getdbuserprivileges",
    "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
dbuser	string	Required The database user's name.	A valid username.	example_user1
db	string	Required The database's name.	A valid database name.	example_database

Parameter

Type

Description

Possible values

Example

dbuser

string

Required

The database user's name.

A valid username.

example_user1

string

Required

The database's name.

A valid database name.

example_database

Returns

Return	Type	Description	Possible values	Example
data	array of strings	A list of permissions that the database user has on the database.	ALL PRIVILEGES ALTER ALTER ROUTINE CREATE CREATE ROUTINE CREATE TEMPORARY TABLES CREATE VIEW DELETE DROP EVENT EXECUTE INDEX INSERT LOCK TABLES REFERENCES SELECT SHOW VIEW TRIGGER UPDATE	ALL_PRIVILEGES
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

Knowledgebase

Categories

Categories