Get started
Log in
Yandex Managed Service for PostgreSQL

Method list

Retrieves the list of PostgreSQL User resources in the specified cluster.

HTTP request

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

Path parameters

Parameter Description
clusterId Required. ID of the cluster to list PostgreSQL users in. To get the cluster ID, use a list request. The maximum string length in characters is 50.

Query parameters

Parameter Description
pageSize The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
pageToken Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.

Response

HTTP Code: 200 - OK

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

A PostgreSQL User resource. For more information, see the Developer's Guide.
users[].
name		 string

Name of the PostgreSQL user.
users[].
clusterId		 string

ID of the PostgreSQL cluster the user belongs to.
users[].
permissions[]		 object

Set of permissions granted to the user.
users[].
permissions[].
databaseName		 string

Name of the database that the permission grants access to.
users[].
connLimit		 string (int64)

Number of database connections available to the user.
users[].
settings		 object

Postgresql settings for this user

Postgresql user settings config
users[].
settings.
defaultTransactionIsolation		 string
users[].
settings.
lockTimeout		 integer (int64)

in milliseconds.
users[].
settings.
logMinDurationStatement		 integer (int64)

in milliseconds.
users[].
settings.
synchronousCommit		 string
users[].
settings.
tempFileLimit		 integer (int64)

in bytes.
users[].
settings.
logStatement		 string
users[].
login		 boolean (boolean)

User can login (default True)
users[].
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_]*.
nextPageToken string

This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results.