UAPI Functions - Mysql::get_privileges_on_database - Knowledgebase

Description

This function lists a MySQL® database user's privileges.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Mysql/get_privileges_on_database?user=dbuser&database=mydb

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Get the dbuser user's privileges for the mydb database.
$get_dbuser_privs = $cpanel->uapi(
    'Mysql', 'get_privileges_on_database',
    array(
        'user'       => 'dbuser',
        'database'   => 'mydb',
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Get the dbuser user's privileges for the mydb database.
my $get_dbuser_privs = $cpliveapi->uapi(
    'Mysql', 'get_privileges_on_database',
    {
        'user'       => 'dbuser',
        'database'   => 'mydb',
    }
);

cPanel Template Toolkit

[% execute( 'Mysql', 'get_privileges_on_database', { user => 'dbuser', database => 'mydb' } ); %]

Command Line

uapi --user=username Mysql get_privileges_on_database user=dbuser database=mydb

Notes:

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

 Output (JSON)

{ 
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{ 
      "transformed":1
   },
   "data":[ 
      "SELECT",
      "UPDATE",
      "CREATE",
      "DROP",
      "INDEX",
      "CREATE TEMPORARY TABLES",
      "LOCK TABLES",
      "EXECUTE",
      "CREATE VIEW",
      "SHOW VIEW",
      "EVENT"
   ]
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
user	string	Required The database user's name.	A MySQL user on the cPanel account. Important: If database prefixing is enabled, you must prefix this value with the account prefix and an underscore (_). For example, for the dbuser user on the user cPanel account, pass in a value of user_dbuser.	dbuser
database	string	Required The database.	A MySQL database on the cPanel account.	12345luggage

Parameter

Type

Description

Possible values

Example

user

string

Required

The database user's name.

A MySQL user on the cPanel account.

Important:

If database prefixing is enabled, you must prefix this value with the account prefix and an underscore (_).

For example, for the dbuser user on the user cPanel account, pass in a value of user_dbuser.

dbuser

database

string

Required

The database.

A MySQL database on the cPanel account.

12345luggage

Returns

Return	Type	Description	Possible values	Example
data	array	An array of privileges. Note: If the user database user does not have privileges on thedatabase database, this array will return empty.	ALL PRIVILEGES One or more of the following individual 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	CREATE

Return

Type

Description

Possible values

Example

data

array

An array of privileges.

Note:

If the user database user does not have privileges on thedatabase database, this array will return empty.

ALL PRIVILEGES
One or more of the following individual 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

CREATE

Knowledgebase

Categories

Categories