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

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

Written by
Updated at September 4, 2026
View in Markdown

List all users

gRPC request

rpc List (ListUsersRequest) returns (ListUsersResponse)

ListUsersRequest

{
  "cluster_id": "string"
}

Field

Description

cluster_id

string

Required field. ID of the Greenplum® cluster.

The maximum string length in characters is 50.

ListUsersResponse

{
  "users": [
    {
      "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

users[]

User

List of cluster users.

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.
Previous
Overview
Next
Create