Managed Service for MySQL API, gRPC: UserService.List
Retrieves the list of users in a cluster.
gRPC request
rpc List (ListUsersRequest) returns (ListUsersResponse)
ListUsersRequest
{
"clusterId": "string",
"pageSize": "int64",
"pageToken": "string"
}
Field |
Description |
clusterId |
string Required field. ID of the cluster to list the users in. To get this ID, make a ClusterService.List request. |
pageSize |
int64 The maximum number of results per page to return. If the number of available results is larger than |
pageToken |
string Page token that can be used to iterate through multiple pages of results. To get the next page of results, set |
ListUsersResponse
{
"users": [
{
"name": "string",
"clusterId": "string",
"permissions": [
{
"databaseName": "string",
"roles": [
"Privilege"
]
}
],
"globalPermissions": [
"GlobalPermission"
],
"connectionLimits": {
"maxQuestionsPerHour": "google.protobuf.Int64Value",
"maxUpdatesPerHour": "google.protobuf.Int64Value",
"maxConnectionsPerHour": "google.protobuf.Int64Value",
"maxUserConnections": "google.protobuf.Int64Value"
},
"authenticationPlugin": "AuthPlugin"
}
],
"nextPageToken": "string"
}
Field |
Description |
users[] |
List of users. |
nextPageToken |
string The token that can be used to get the next page of results. If the number of results is larger than ListUsersRequest.pageSize, use the Each of the subsequent UserService.List requests should use the |
User
An object that represents MySQL user.
See the documentation for details.
Field |
Description |
name |
string Name of the user. |
clusterId |
string ID of the cluster the user belongs to. |
permissions[] |
Set of permissions granted to the user. |
globalPermissions[] |
enum GlobalPermission Set of global permissions to grant to the user.
|
connectionLimits |
Set of user connection limits. |
authenticationPlugin |
enum AuthPlugin User authentication plugin.
|
Permission
Field |
Description |
databaseName |
string Name of the database that the permission grants access to. |
roles[] |
enum Privilege Roles granted to the user within the database. See the documentation for details.
|
ConnectionLimits
Field |
Description |
maxQuestionsPerHour |
The maximum permitted number of user questions per hour. |
maxUpdatesPerHour |
The maximum permitted number of user updates per hour. |
maxConnectionsPerHour |
The maximum permitted number of simultaneous client connections per hour. |
maxUserConnections |
The maximum number of simultaneous connections permitted to any given MySQL user account. |