Yandex Cloud
Documentation
PresentationContact UsTry it for free
© 2026 Direct Cursus Technology L.L.C.
Yandex Managed Service for Valkey™
  • Getting started
  • Access management
  • Inspections and recommendations
  • Pricing policy
  • Terraform reference
    • API authentication
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
  • Monitoring metrics
  • Audit Trails events
  • Public materials
  • Release notes
  • FAQ

In this article:

  • gRPC request
  • ListUsersRequest
  • ListUsersResponse
  • User
  • Permissions
  • ConnectionManager
  1. API reference
  2. gRPC
  3. User
  4. List

Managed Service for Redis API, gRPC: UserService.List

Written by
Yandex Cloud
Updated at October 7, 2026
View in Markdown
  • gRPC request
  • ListUsersRequest
  • ListUsersResponse
  • User
  • Permissions
  • ConnectionManager

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

gRPC requestgRPC request

rpc List (ListUsersRequest) returns (ListUsersResponse)

ListUsersRequestListUsersRequest

{
  "cluster_id": "string",
  "page_size": "int64",
  "page_token": "string"
}

Field

Description

cluster_id

string

Required field. ID of the cluster to list Valkey users in.
To get the cluster ID, use a ClusterService.List request.

The maximum string length in characters is 50.

page_size

int64

The maximum number of results per page to return. If the number of available
results is larger than page_size, the service returns a ListUsersResponse.next_page_token
that can be used to get the next page of results in subsequent list requests.

Acceptable values are 0 to 1000, inclusive.

page_token

string

Page token. To get the next page of results, set page_token to the
ListUsersResponse.next_page_token returned by the previous list request.

The maximum string length in characters is 400.

ListUsersResponseListUsersResponse

{
  "users": [
    {
      "name": "string",
      "cluster_id": "string",
      "permissions": {
        "patterns": "google.protobuf.StringValue",
        "pub_sub_channels": "google.protobuf.StringValue",
        "categories": "google.protobuf.StringValue",
        "commands": "google.protobuf.StringValue",
        "sanitize_payload": "google.protobuf.StringValue",
        "databases": "google.protobuf.StringValue"
      },
      "enabled": "bool",
      "acl_options": "string",
      "connection_manager": {
        "connection_id": "string"
      },
      "auth_type": "AuthType"
    }
  ],
  "next_page_token": "string"
}

Field

Description

users[]

User

List of Valkey User resources.

next_page_token

string

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

UserUser

A Valkey User resource. For more information, see the
Developer's Guide.

Field

Description

name

string

Name of the Valkey user.

cluster_id

string

ID of the Valkey cluster the user belongs to.

permissions

Permissions

Set of permissions to grant to the user.

enabled

bool

Is Valkey user enabled

acl_options

string

Raw ACL string inside of Valkey

connection_manager

ConnectionManager

Connection Manager connection configuration.

auth_type

enum AuthType

Authentication type for the user

  • AUTH_TYPE_PASSWORD: Password-based authentication
  • AUTH_TYPE_IAM: IAM-based authentication

PermissionsPermissions

Field

Description

patterns

google.protobuf.StringValue

Keys patterns user has permission to.

pub_sub_channels

google.protobuf.StringValue

Channel patterns user has permissions to.

categories

google.protobuf.StringValue

Command categories user has permissions to.

commands

google.protobuf.StringValue

Commands user can execute.

sanitize_payload

google.protobuf.StringValue

Deprecated. This parameter is ignored.

databases

google.protobuf.StringValue

Databases parameter.

ConnectionManagerConnectionManager

Connection Manager connection configuration.

Field

Description

connection_id

string

ID of Connection Manager connection.

Was the article helpful?

Previous
Get
Next
Create
© 2026 Direct Cursus Technology L.L.C.