Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
  • Blog
  • Pricing
  • Documentation
Yandex project
© 2025 Yandex.Cloud LLC
Yandex Managed Service for Valkey™
  • Getting started
  • Access management
  • Terraform reference
    • Authentication with the API
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
  • Monitoring metrics
  • Audit Trails events
  • Public materials
  • Release notes
  • FAQ

In this article:

  • HTTP request
  • Path parameters
  • Response
  • Permissions
  1. API reference
  2. REST
  3. User
  4. Get

Managed Service for Redis API, REST: User.Get

Written by
Yandex Cloud
Updated at January 23, 2025
  • HTTP request
  • Path parameters
  • Response
  • Permissions

Returns the specified Redis User resource.

To get the list of available Redis User resources, make a List request.

HTTP request

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

Path parameters

Field

Description

clusterId

string

Required field. ID of the Redis cluster the user belongs to.
To get the cluster ID, use a ClusterService.List request.

userName

string

Required field. Name of the Redis User resource to return.
To get the name of the user, use a UserService.List request.

Response

HTTP Code: 200 - OK

{
  "name": "string",
  "clusterId": "string",
  "permissions": {
    "patterns": "string",
    "pubSubChannels": "string",
    "categories": "string",
    "commands": "string",
    "sanitizePayload": "string"
  },
  "enabled": "boolean",
  "aclOptions": "string"
}

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

Field

Description

name

string

Name of the Redis user.

clusterId

string

ID of the Redis cluster the user belongs to.

permissions

Permissions

Set of permissions to grant to the user.

enabled

boolean

Is redis user enabled

aclOptions

string

Raw ACL string inside of Redis

Permissions

Field

Description

patterns

string

Keys patterns user has permission to.

pubSubChannels

string

Channel patterns user has permissions to.

categories

string

Command categories user has permissions to.

commands

string

Commands user can execute.

sanitizePayload

string

SanitizePayload parameter.

Was the article helpful?

Previous
Overview
Next
List
Yandex project
© 2025 Yandex.Cloud LLC