Managed Service for Redis API, gRPC: UserService.List
Retrieves the list of Redis User resources in the specified cluster.
gRPC request
rpc List (ListUsersRequest) returns (ListUsersResponse)
ListUsersRequest
{
"cluster_id": "string",
"page_size": "int64",
"page_token": "string"
}
|
Field |
Description |
|
cluster_id |
string Required field. ID of the cluster to list Redis users in. |
|
page_size |
int64 The maximum number of results per page to return. If the number of available |
|
page_token |
string Page token. To get the next page of results, set |
ListUsersResponse
{
"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"
},
"enabled": "bool",
"acl_options": "string"
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
users[] |
List of Redis 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 |
User
A Redis User resource. For more information, see the
Developer's Guide.
|
Field |
Description |
|
name |
string Name of the Redis user. |
|
cluster_id |
string ID of the Redis cluster the user belongs to. |
|
permissions |
Set of permissions to grant to the user. |
|
enabled |
bool Is redis user enabled |
|
acl_options |
string Raw ACL string inside of Redis |
Permissions
|
Field |
Description |
|
patterns |
Keys patterns user has permission to. |
|
pub_sub_channels |
Channel patterns user has permissions to. |
|
categories |
Command categories user has permissions to. |
|
commands |
Commands user can execute. |
|
sanitize_payload |
SanitizePayload parameter. |