User

A set of methods for managing PostgreSQL User resources.

JSON Representation

{
  "name": "string",
  "clusterId": "string",
  "permissions": [
    {
      "databaseName": "string"
    }
  ],
  "connLimit": "string",
  "settings": {
    "defaultTransactionIsolation": "string",
    "lockTimeout": "integer",
    "logMinDurationStatement": "integer",
    "synchronousCommit": "string",
    "tempFileLimit": "integer"
  },
  "login": true,
  "grants": [
    "string"
  ]
}
Field Description
name string

Name of the PostgreSQL user.

clusterId string

ID of the PostgreSQL cluster the user belongs to.

permissions[] object

Set of permissions granted to the user.

permissions[].
databaseName
string

Name of the database that the permission grants access to.

connLimit string (int64)

Number of database connections available to the user.

settings object

Postgresql settings for this user

Postgresql user settings config

settings.
defaultTransactionIsolation
string
settings.
lockTimeout
integer (int64)

in milliseconds.

settings.
logMinDurationStatement
integer (int64)

in milliseconds.

settings.
synchronousCommit
string
settings.
tempFileLimit
integer (int64)

in bytes.

login boolean (boolean)

User can login (default True)

grants[] string

User grants (GRANT TO ), role must be other user

The maximum string length in characters for each value is 63. Each value must match the regular expression [a-zA-Z0-9_]*.

Methods

Method Description
create Creates a PostgreSQL user in the specified cluster.
delete Deletes the specified PostgreSQL user.
get Returns the specified PostgreSQL User resource.
grantPermission Grants permission to the specified PostgreSQL user.
list Retrieves the list of PostgreSQL User resources in the specified cluster.
revokePermission Revokes permission from the specified PostgreSQL user.
update Updates the specified PostgreSQL user.