Update PostgreSQL username

This function renames a PostgreSQL® database user.

Important:

When you disable the PostgreSQL role, the system disables this function.

SecurityBasicAuth

Request

query Parameters

newname required	string The database user's new name. Note: If database prefixing is enabled, this parameter must include the database prefix for the account. Example: newname=dbuser2
oldname required	string The database user's current name. Note: If database prefixing is enabled, this parameter must include the database prefix for the account. Example: oldname=dbuser
password required	string The database user's new password. Example: password=123456luggage

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/Postgresql/rename_user

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Postgresql \
  rename_user \
  oldname='dbuser' \
  newname='dbuser2' \
  password='123456luggage'

Response samples

application/json

{"apiversion": 3,
"func": "rename_user",
"module": "Postgresql",
"result": {"data": null,
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}