Discuss with expertTry it for free
© 2026 Direct Cursus Technology L.L.C.

Managed Service for Greenplum® API, gRPC: UserService.Create

Written by
Updated at September 4, 2026
View in Markdown

Creates user

gRPC request

rpc Create (CreateUserRequest) returns (operation.Operation)

CreateUserRequest

{
  "cluster_id": "string",
  "user": {
    "name": "string",
    "password": "string",
    "login": "google.protobuf.BoolValue",
    "resource_group": "string",
    "settings": {
      "pool_mode": "PoolMode",
      "pool_size": "google.protobuf.Int64Value",
      "pool_client_idle_timeout": "google.protobuf.Int64Value",
      "pool_idle_in_transaction_timeout": "google.protobuf.Int64Value"
    }
  }
}

Field

Description

cluster_id

string

Required field. ID of the Greenplum® cluster.

The maximum string length in characters is 50.

user

User

Required field. Definition of the user to create.

User

Field

Description

name

string

Required field. User name

The string length in characters must be 1-63. Value must match the regular expression ^[a-zA-Z_][a-zA-Z0-9_]{0,62}$.

password

string

User password. Used only in create and update requests

The maximum string length in characters is 128.

login

google.protobuf.BoolValue

Is user allowed to login. Corresponds LOGIN user privilege. Default value: True

resource_group

string

Resource group for user's queries

Value must match the regular expression ^([^\|/*?.,;'<>]+|)$.

settings

UserSettingsConfig

DB and Pooler specific settings

UserSettingsConfig

Field

Description

pool_mode

enum PoolMode

Odyssey® route server pool mode.
When POOL_MODE_UNSPECIFIED, uses the cluster-level pool.mode setting.

  • SESSION: Assign server connection to a client until it disconnects.
  • TRANSACTION: Assign server connection to a client for a transaction processing.

pool_size

google.protobuf.Int64Value

Odyssey® server pool size.
The number of servers in the server pool. Clients are placed in a wait queue when all servers are busy.
Set to zero to disable the limit.
If not set, uses the cluster-level pool.size setting.

The minimum value is 0.

pool_client_idle_timeout

google.protobuf.Int64Value

Odyssey® client pool idle timeout, in seconds.
Drop stale client connection after this much seconds of idleness, which is not in transaction.
Set to zero to disable.
If not set, uses the cluster-level pool.client_idle_timeout setting.

The minimum value is 0.

pool_idle_in_transaction_timeout

google.protobuf.Int64Value

Odyssey® client pool idle in transaction timeout, in seconds.
Drop client connection in transaction after this much seconds of idleness.
Set to zero to disable.
If not set, uses the cluster-level pool.idle_in_transaction_timeout setting.

The minimum value is 0.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // 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.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

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

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

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

google.protobuf.Any

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

google.rpc.Status

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

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

google.protobuf.Any

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.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.
Previous
List
Next
Update