Description
This function sets a MySQL® database user's privileges.
Examples
cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Mysql/set_privileges_on_database?user=dbuser&database=mydb&privileges=DELETE%2CUPDATE%2CCREATE%2CALTER
LiveAPI PHP Class
$cpanel = new CPANEL();
$set_dbuser_privs = $cpanel->uapi(
'Mysql', 'set_privileges_on_database',
array(
'user' => 'dbuser',
'database' => 'mydb',
'privileges' => 'DELETE,UPDATE,CREATE,ALTER',
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $set_dbuser_privs = $cpliveapi->uapi(
'Mysql', 'set_privileges_on_database',
{
'user' => 'dbuser',
'database' => 'mydb',
'privileges' => 'DELETE,UPDATE,CREATE,ALTER',
}
);
cPanel Template Toolkit
[% execute('Mysql', 'set_privileges_on_database', { name => 'dbuser', database => 'mydb', privileges => 'DELETE,UPDATE,CREATE,ALTER' } ) %]
Command Line
uapi --user=username Mysql set_privileges_on_database user=dbuser database=mydb privileges=DELETE,UPDATE,CREATE,ALTER
|
Output (JSON)
{
"messages": null,
"errors": null,
"status": 1,
"metadata": {
},
"data": null
}
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's name.
|
A MySQL database on the cPanel account.
|
mydb
|
|
privileges
|
string
|
A list of privileges.
Note:
This list replaces, rather than adds to, the existing privilege list.
|
- ALL PRIVILEGES
- A comma-separated list of 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
Note:
In browser-based calls, separate multiple values with %2C.
|
DELETE,UPDATE,CREATE,ALTER
|
Returns
This function only returns metadata.
