Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Managed Service for MongoDB API, gRPC: UserService.Update

Written by
Updated at November 26, 2024

Updates the specified MongoDB user.

gRPC request

rpc Update (UpdateUserRequest) returns (operation.Operation)

UpdateUserRequest

{
  "cluster_id": "string",
  "user_name": "string",
  "update_mask": "google.protobuf.FieldMask",
  "password": "string",
  "permissions": [
    {
      "database_name": "string",
      "roles": [
        "string"
      ]
    }
  ]
}

Field

Description

cluster_id

string

Required field. ID of the MongoDB cluster the user belongs to.
To get the cluster ID, use a ClusterService.List request.

user_name

string

Required field. Name of the user to be updated.
To get the name of the user, use a UserService.List request.

update_mask

google.protobuf.FieldMask

Field mask that specifies which fields of the MongoDB User resource should be updated.

password

string

New password for the user.

permissions[]

Permission

New set of permissions for the user.

Permission

Field

Description

database_name

string

Name of the database that the permission grants access to.

roles[]

string

MongoDB roles for the database_name database that the permission grants.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "cluster_id": "string",
    "user_name": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "name": "string",
    "cluster_id": "string",
    "permissions": [
      {
        "database_name": "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.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

UpdateUserMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

User

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

UpdateUserMetadata

Field

Description

cluster_id

string

ID of the MongoDB cluster the user belongs to.

user_name

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.

cluster_id

string

ID of the MongoDB cluster the user belongs to.

permissions[]

Permission

Set of permissions granted to the user.

Permission

Field

Description

database_name

string

Name of the database that the permission grants access to.

roles[]

string

MongoDB roles for the database_name database that the permission grants.
Previous
Create
Next
Delete