Method create

Creates a PostgreSQL user in the specified cluster.

HTTP request

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

Path parameters

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

Body parameters

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

Required. Properties of the user to be created.

userSpec.
name
string

Required. Name of the PostgreSQL user.

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

userSpec.
password
string

Required. Password of the PostgreSQL user.

The string length in characters must be 8-128.

userSpec.
permissions[]
object

Set of permissions to grant to the user.

userSpec.
permissions[].
databaseName
string

Name of the database that the permission grants access to.

userSpec.
connLimit
integer (int64)

Number of database connections that should be available to the user.

The minimum value is 10.

userSpec.
settings
object

Postgresql settings for this user

Postgresql user settings config

userSpec.
settings.
defaultTransactionIsolation
string
userSpec.
settings.
lockTimeout
integer (int64)

in milliseconds.

userSpec.
settings.
logMinDurationStatement
integer (int64)

in milliseconds.

userSpec.
settings.
synchronousCommit
string
userSpec.
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 in RFC3339 text format.

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. This value is in RFC3339 text format.

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
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.