Managed Service for MongoDB API, gRPC: UserService.Update
Updates the specified MongoDB user.
gRPC request
rpc Update (UpdateUserRequest) returns (operation.Operation)
UpdateUserRequest
{
"clusterId": "string",
"userName": "string",
"updateMask": "google.protobuf.FieldMask",
"password": "string",
"permissions": [
{
"databaseName": "string",
"roles": [
"string"
]
}
]
}
Field |
Description |
clusterId |
string Required field. ID of the MongoDB cluster the user belongs to. |
userName |
string Required field. Name of the user to be updated. |
updateMask |
Field mask that specifies which fields of the MongoDB User resource should be updated. |
password |
string New password for the user. |
permissions[] |
New set of permissions for the user. |
Permission
Field |
Description |
databaseName |
string Name of the database that the permission grants access to. |
roles[] |
string MongoDB roles for the |
operation.Operation
{
"id": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"createdBy": "string",
"modifiedAt": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"clusterId": "string",
"userName": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"name": "string",
"clusterId": "string",
"permissions": [
{
"databaseName": "string",
"roles": [
"string"
]
}
]
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
Creation timestamp. |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
The time when the Operation resource was last modified. |
done |
bool If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
UpdateUserMetadata
Field |
Description |
clusterId |
string ID of the MongoDB cluster the user belongs to. |
userName |
string Name of the user that is being updated. |
User
A MongoDB User resource. For more information, see the
Developer's Guide.
Field |
Description |
name |
string Name of the MongoDB user. |
clusterId |
string ID of the MongoDB cluster the user belongs to. |
permissions[] |
Set of permissions granted to the user. |
Permission
Field |
Description |
databaseName |
string Name of the database that the permission grants access to. |
roles[] |
string MongoDB roles for the |