Managed Service for MySQL API, REST: User methods
A set of methods for managing MySQL users.
See the documentation for details.
JSON Representation
{
"name": "string",
"clusterId": "string",
"permissions": [
{
"databaseName": "string",
"roles": [
"string"
]
}
],
"globalPermissions": [
"string"
],
"connectionLimits": {
"maxQuestionsPerHour": "integer",
"maxUpdatesPerHour": "integer",
"maxConnectionsPerHour": "integer",
"maxUserConnections": "integer"
},
"authenticationPlugin": "string"
}
Field | Description |
---|---|
name | string Name of the user. |
clusterId | string ID of the cluster the user belongs to. |
permissions[] | object Set of permissions granted to the user. |
permissions[]. databaseName |
string Name of the database that the permission grants access to. |
permissions[]. roles[] |
string Required. Roles granted to the user within the database. See the documentation for details. The minimum number of elements is 1.
|
globalPermissions[] | string Set of global permissions to grant to the user.
|
connectionLimits | object Set of user connection limits. |
connectionLimits. maxQuestionsPerHour |
integer (int64) The maximum permitted number of user questions per hour. The minimum value is 0. |
connectionLimits. maxUpdatesPerHour |
integer (int64) The maximum permitted number of user updates per hour. The minimum value is 0. |
connectionLimits. maxConnectionsPerHour |
integer (int64) The maximum permitted number of simultaneous client connections per hour. The minimum value is 0. |
connectionLimits. maxUserConnections |
integer (int64) The maximum number of simultaneous connections permitted to any given MySQL user account. The minimum value is 0. |
authenticationPlugin | string User authentication plugin.
|
Methods
Method | Description |
---|---|
create | Creates a user in a cluster. |
delete | Deletes a user in a cluster. |
get | Retrieves information about the specified user. |
grantPermission | Grants permission to access a database to a user in a cluster. |
list | Retrieves the list of users in a cluster. |
revokePermission | Revokes permission to access a database from a user in a cluster. |
update | Updates a user in a cluster. |