Managed Service for MongoDB API, REST: User.Update
Updates the specified MongoDB user.
HTTP request
PATCH https://mdb.api.cloud.yandex.net/managed-mongodb/v1/clusters/{clusterId}/users/{userName}
Path parameters
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. |
Body parameters
{
"updateMask": "object",
"password": "string",
"permissions": [
{
"databaseName": "string",
"roles": [
"string"
]
}
]
}
Field |
Description |
updateMask |
object (field-mask) A comma-separated names off ALL fields to be updated. If |
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 |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"clusterId": "string",
"userName": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"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 |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
string (date-time) The time when the Operation resource was last modified. String in RFC3339 To work with values in this field, use the APIs described in the |
done |
boolean 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. |
Status
The error result of the operation in case of failure or cancellation.
Field |
Description |
code |
integer (int32) Error code. An enum value of google.rpc.Code |
message |
string An error message. |
details[] |
object A list of messages that carry the error details. |
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 |