Managed Service for SPQR API, gRPC: UserService.List
Retrieves the list of SPQR 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 SPQR users in. 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 Acceptable values are 0 to 1000, inclusive. |
|
page_token |
string Page token. To get the next page of results, set The maximum string length in characters is 100. |
ListUsersResponse
{
"users": [
{
"name": "string",
"cluster_id": "string",
"permissions": [
{
"database_name": "string"
}
],
"settings": {
"connection_limit": "google.protobuf.Int64Value",
"connection_retries": "google.protobuf.Int64Value"
},
"grants": [
"string"
],
"deletion_protection": "google.protobuf.BoolValue"
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
users[] |
List of SPQR 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 SPQR User resource. For more information, see the
Developer's Guide.
|
Field |
Description |
|
name |
string Name of the SPQR user. |
|
cluster_id |
string ID of the SPQR cluster the user belongs to. |
|
permissions[] |
Set of permissions granted to the user. |
|
settings |
SPQR Settings for this user |
|
grants[] |
string User grants The maximum string length in characters for each value is 63. Each value must match the regular expression |
|
deletion_protection |
Deletion Protection inhibits deletion of the user |
Permission
|
Field |
Description |
|
database_name |
string Name of the database that the permission grants access to. |
UserSettings
|
Field |
Description |
|
connection_limit |
|
|
connection_retries |