Managed Service for Redis API, REST: User.List
Retrieves the list of Redis User resources in the specified cluster.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/{clusterId}/users
Path parameters
|
Field |
Description |
|
clusterId |
string Required field. ID of the cluster to list Redis users in. |
Query parameters
|
Field |
Description |
|
pageSize |
string (int64) The maximum number of results per page to return. If the number of available |
|
pageToken |
string Page token. To get the next page of results, set |
Response
HTTP Code: 200 - OK
{
"users": [
{
"name": "string",
"clusterId": "string",
"permissions": {
"patterns": "string",
"pubSubChannels": "string",
"categories": "string",
"commands": "string",
"sanitizePayload": "string"
},
"enabled": "boolean",
"aclOptions": "string"
}
],
"nextPageToken": "string"
}
|
Field |
Description |
|
users[] |
List of Redis User resources. |
|
nextPageToken |
string This token allows you to get the next page of results for list requests. If the number of results |
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 |
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. |