Contact UsGet started

Managed Service for Redis API, REST: User.Create

Written by
Updated at January 23, 2025

Creates a Redis user in the specified cluster.

HTTP request

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

Path parameters

Field

Description

clusterId

string

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

Body parameters

{
  "userSpec": {
    "name": "string",
    "passwords": [
      "string"
    ],
    "permissions": {
      "patterns": "string",
      "pubSubChannels": "string",
      "categories": "string",
      "commands": "string",
      "sanitizePayload": "string"
    },
    "enabled": "boolean"
  }
}

Field

Description

userSpec

UserSpec

Properties of the user to be created.

UserSpec

Field

Description

name

string

Required field. Name of the Redis user.

passwords[]

string

Password of the Redis user.

permissions

Permissions

Set of permissions to grant to the user.

enabled

boolean

Is Redis user enabled

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.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "clusterId": "string",
    "userName": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "name": "string",
    "clusterId": "string",
    "permissions": {
      "patterns": "string",
      "pubSubChannels": "string",
      "categories": "string",
      "commands": "string",
      "sanitizePayload": "string"
    },
    "enabled": "boolean",
    "aclOptions": "string"
  }
  // 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.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

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.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

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

CreateUserMetadata

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

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

User

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.

CreateUserMetadata

Field

Description

clusterId

string

ID of the Redis cluster the user is being created in.

userName

string

Name of the user that is being created.

Status

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

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

User

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.
Previous
List
Next
Update