Method update

Updates the specified PostgreSQL user.

HTTP request

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

Path parameters

Parameter Description
clusterId Required. 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. Required. Name of the user to be updated. 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_]*.

Body parameters

{
  "updateMask": "string",
  "password": "string",
  "permissions": [
    {
      "databaseName": "string"
    }
  ],
  "connLimit": "string",
  "settings": {
    "defaultTransactionIsolation": "string",
    "lockTimeout": "integer",
    "logMinDurationStatement": "integer",
    "synchronousCommit": "string",
    "tempFileLimit": "integer"
  }
}
Field Description
updateMask string

Field mask that specifies which fields of the PostgreSQL User resource should be updated.

A comma-separated names off ALL fields to be updated. Оnly the specified fields will be changed. The others will be left untouched. If the field is specified in updateMask and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0.

If updateMask is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default.

password string

New password for the user.

The string length in characters must be 8-128.

permissions[] object

New set of permissions for the user.

permissions[].
databaseName
string

Name of the database that the permission grants access to.

connLimit string (int64)

Number of connections that should be available to the user.

The minimum value is 10.

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.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // end of the list of possible fields

}

An Operation resource. For more information, see Operation.

Field Description
id string

ID of the operation.

description string

Description of the operation. 0-256 characters long.

createdAt string (date-time)

Creation timestamp.

String in RFC3339 text format.

createdBy string

ID of the user or service account who initiated the operation.

modifiedAt string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format.

done boolean (boolean)

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadata object

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.

error object
The error result of the operation in case of failure or cancellation.
includes only one of the fields error, response

The error result of the operation in case of failure or cancellation.

error.
code
integer (int32)

Error code. An enum value of google.rpc.Code.

error.
message
string

An error message.

error.
details[]
object

A list of messages that carry the error details.

response object
includes only one of the fields error, response

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.