Child pages
  • cPanel API 2 Functions - MysqlFE::getdbuserprivileges

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

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


Warning
titleWarning:

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

  • Mysql::get_privileges_on_database

    Excerpt Include
    DD:UAPI Functions - Mysql::get_privileges_on_databaseDD:
    UAPI Functions - Mysql::get_privileges_on_database
    nopaneltrue

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledMySQLRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleWHM API (JSON)


Code Block
languagetext
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&dbuser=username&db=example_database

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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',
        array(       
            'dbuser'      => 'username',
            'db'          => 'example_database',
    )
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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',
    (       
            'dbuser'      => 'username',
            'db'          => 'example_database',
    )
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning


Expand
titleCommand Line


Code Block
languagebash
cpapi2 --user=username MysqlFE getdbuserprivileges dbuser=username db=example_database

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
 {
  "cpanelresult": {
    "apiversion": 2,
    "data": [
      "ALTER",
      "CREATE ROUTINE",
      "CREATE TEMPORARY TABLES",
      "DROP",
      "INSERT",
      "LOCK TABLES",
      "SHOW VIEW",
      "TRIGGER"
    ],
    "func": "getdbuserprivileges",
    "event": {
      "result": 1
    },
    "module": "MysqlFE"
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
dbuserstring

Required

The database user's name.

A valid username.
example_user1
dbstring

Required

The database's name.

A valid database name.example_database

Returns

ReturnTypeDescriptionPossible valuesExample
dataarrayA 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
reasonstring

A reason for failure.

Note
titleNote:

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