Method get

Returns the specified PostgreSQL User resource.

To get the list of available PostgreSQL User resources, make a list request.

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/{clusterId}/users/{userName}

Path parameters

Parameter Description
clusterId Required. ID of the PostgreSQL cluster the user belongs to. To get the cluster ID, use a list request. The maximum string length in characters is 50.
userName Required. Name of the PostgreSQL User resource to return. To get the name of the user, use a list request. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_]*.

Response

HTTP Code: 200 - OK

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

A PostgreSQL User resource. For more information, see the Developer's Guide.

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_]*.