UAPI Functions - Postgresql::rename_user_no_password - Knowledgebase

Description

This function renames a PostgreSQL® database user.

Warnings:

If you rename a PostgreSQL user, you must set the password for the database user. This is required because of the md5 hash that PostgreSQL creates to store user passwords.
We strongly recommend that you use the Postgresql::rename_user function instead of this one.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Postgresql/rename_user_no_password?oldname=dbuser&newname=dbuser2

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Renames database user "dbuser" into "dbuser2"
$rename_user_no_password = $cpanel->uapi(
    'Postgresql', 'rename_user_no_password',
    array(
        'oldname'  => 'dbuser',
        'newname'  => 'dbuser2',
        )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Renames database user "dbuser" into "dbuser2"
my $rename_user_no_password = $cpliveapi->uapi(
    'Postgresql', 'rename_user_no_password',
    {
        'oldname'    => 'database',
        'newname'    => 'database2',
    }
);

cPanel Template Toolkit

<!-- Renames database user "dbuser" into "dbuser2" -->
[% data = execute( 'Postgresql', 'rename_user_no_password', { oldname => 'dbuser', newname => 'dbuser2'} ); %]

Notes:

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

Command Line

uapi --user=username Postgresql rename_user_no_password oldname=dbuser newname=dbuser2

Notes:

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

 Output (JSON)

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

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
oldname	string	Required The database user's current name.	A valid string. Note: If database prefixing is enabled, this parameter must include the database prefix for the account.	dbuser
newname	string	Required The database user's new name.	A valid string. Note: If database prefixing is enabled, this parameter must include the database prefix for the account.	dbuser2

Parameter

Type

Description

Possible values

Example

oldname

string

Required

The database user's current name.

A valid string.

Note:

If database prefixing is enabled, this parameter must include the database prefix for the account.

dbuser

newname

string

Required

The database user's new name.

A valid string.

Note:

If database prefixing is enabled, this parameter must include the database prefix for the account.

dbuser2

Returns

This function only returns metadata.

Knowledgebase

Categories

Categories