Description

This function renames a MySQL® database user.

Examples




https://hostname.example.com:2083/cpsess##########/execute/Mysql/rename_user?oldname=dbuser&newname=mynewusername



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Rename the dbuser user.
$rename_db_user = $cpanel->uapi(
    'Mysql', 'rename_user',
    array(
        'oldname'       => 'dbuser',
        'newname'       => 'mynewusername',
    )
);



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Rename the dbuser user.
my $rename_db_user = $cpliveapi->uapi(
    'Mysql', 'rename_user',
    {
        'oldname'       => 'dbuser',
        'newname'       => 'mynewusername',
    }
);



<!-- Rename the user. -->
[% execute('Mysql', 'rename_user', { oldname => 'dbuser', newname => 'mynewusername' } ) %]



uapi --user=username Mysql rename_user oldname=dbuser newname=mynewusername



{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
     
  },
  "data": null
}



Parameters

ParameterTypeDescriptionPossible valuesExample
oldnamestring

Required

The user's current name.

A MySQL database user on the cPanel account.

dbuser
newnamestring

Required

The user's new name.

A valid MySQL database username.

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


mynewusername

Returns

This function only returns metadata.