Docs Menu

Docs HomeMongoDB Command Line Interface

mongocli atlas dbusers update

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output
  • Examples

Modify the details for a database user for your project.

To use this command, you must authenticate with a user account or an API key that has the Project Owner role.

Command Syntax
mongocli atlas dbusers update <username> [options]
Name
Type
Required
Description
username
string
true
Username to update in the MongoDB database.
Name
Type
Required
Description
-h, --help
false
help for update
-o, --output
string
false
Output format. Valid values are json, json-path, go-template, or go-template-file. To see full output, use the -o json option.
-p, --password
string
false
Password for the database user.
--projectId
string
false
Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
--role
strings
false
User's roles and the databases or collections on which the roles apply. Passing this flag replaces preexisting data.
--scope
strings
false
Array of clusters and Atlas Data Lakes that this user has access to. Passing this flag replaces preexisting data.
-u, --username
string
false
Username for authenticating to MongoDB.
Name
Type
Required
Description
-P, --profile
string
false

If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.

Successfully updated database user '<Username>'.
# Update roles for a database user named myUser for the project with the ID 5e2211c17a3e5a48f5497de3:
mongocli atlas dbuser update myUser --role readWriteAnyDatabase --projectId 5e2211c17a3e5a48f5497de3
# Update scopes for a database user named myUser for the project with the ID 5e2211c17a3e5a48f5497de3:
mongocli atlas dbuser update myUser --scope resourceName:resourceType --projectId 5e2211c17a3e5a48f5497de3
←  mongocli atlas dbusers listmongocli atlas events →
Share Feedback
© 2023 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2023 MongoDB, Inc.