User

A set of methods for managing MongoDB User resources.

JSON Representation

{
  "name": "string",
  "clusterId": "string",
  "permissions": [
    {
      "databaseName": "string",
      "roles": [
        "string"
      ]
    }
  ]
}
Field Description
name string

Name of the MongoDB user.

clusterId string

ID of the MongoDB 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

MongoDB roles for the databaseName database that the permission grants.

Methods

Method Description
create Creates a MongoDB user in the specified cluster.
delete Deletes the specified MongoDB user.
get Returns the specified MongoDB User resource.
grantPermission Grants permission to the specified MongoDB user.
list Retrieves the list of MongoDB User resources in the specified cluster.
revokePermission Revokes permission from the specified MongoDB user.
update Updates the specified MongoDB user.