cPanel API 2 Functions - MysqlFE::userdbprivs

Description

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

Warning:

  • This function is currently deprecated and does not function. We strongly recommend that you use the MysqlFE::getdbuserprivileges function.
  • 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=userdbprivs&db=example_db1&dbuser=example_user1

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// List privileges for "example_user1" on "example_db1"
$list_privs = $cpanel->api2(
    'MysqlFE', 'userdbprivs',
    array(
        'db'     => 'example_db1',
        'dbuser' => 'example_user1',
  )
);

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# List privileges for "example_user1" on "example_db1"
my $list_privs = $cpliveapi->api2(
    'MysqlFE', 'userdbprivs',
    {
        'db'     => 'example_db1',
        'dbuser' => 'example_user1',
 }
);

 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 userdbprivs db=example_db1 dbuser=example_user1

 

Notes:

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

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "userdbprivs",
    "data": [
      {
        "DELETE": 1,
        "EXECUTE": 1
      }
    ],
    "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_db1

 dbuser

string

Required

The database username.

 A valid database username 

 example_user1 

 

Returns

Note:

This function's Boolean values only return if the database user has privileges for that database. If the value is 0, the function will not return that value.

Return
Type
Description
Possible values
Example
ALL PRIVILEGES Boolean Whether the user has all privileges on the database.
  • 1 — The user has all privileges.
 1
ALTER Boolean Whether the user has this privilege on the database.
  • 1 — The user has this privilege.
 1

ALTER ROUTINE

 Boolean Whether the user has this privilege on the database.
  • 1 — The user has this privilege.
 1
CREATE Boolean Whether the user has this privilege on the database.
  • 1 — The user has this privilege.
 1

CREATE ROUTINE

 Boolean Whether the user has this privilege on the database.
  • 1 — The user has this privilege.
 1
CREATE TEMPORARY TABLES Boolean Whether the user has this privilege on the database.
  • 1 — The user has this privilege.
 1
CREATE VIEW Boolean Whether the user has this privilege on the database.
  • 1 — The user has this privilege.
 1
DELETE Boolean Whether the user has this privilege on the database.
  • 1 — The user has this privilege.
 1
DROP Boolean Whether the user has this privilege on the database.
  • 1 — The user has this privilege.
 1
EVENT Boolean Whether the user has this privilege on the database.
  • 1 — The user has this privilege.
 1
EXECUTE Boolean Whether the user has this privilege on the database.
  • 1 — The user has this privilege.
 1
INDEX Boolean Whether the user has this privilege on the database.
  • 1 — The user has this privilege.
 1
INSERT Boolean Whether the user has this privilege on the database.
  • 1 — The user has this privilege.
 1
LOCK TABLES Boolean Whether the user has this privilege on the database.
  • 1 — The user has this privilege.
 1
REFERENCES Boolean Whether the user has this privilege on the database.
  • 1 — The user has this privilege.
 1
SELECT Boolean Whether the user has this privilege on the database.
  • 1 — The user has this privilege.
 1

SHOW VIEW

 Boolean Whether the user has this privilege on the database.
  • 1 — The user has this privilege.
 1
TRIGGER Boolean Whether the user has this privilege on the database.
  • 1 — The user has this privilege.
 1
UPDATE Boolean Whether the user has this privilege on the database.
  • 1 — The user has this privilege.
 1
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
  • 7 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....