mongocli atlas dbusers create
mongocli atlas commands are now deprecated and will be removed in a future release. To enjoy the same capabilities and the latest features, use the new, dedicated CLI for Atlas users. To learn more, see Migrate to the Atlas CLI.Create a database user for your project.
If you set --ldapType, --x509Type, and --awsIAMType to NONE, Atlas authenticates this user through SCRAM-SHA. To learn more, see https://www.mongodb.com/docs/manual/core/security-scram/.
To use this command, you must authenticate with a user account or an API key that has the Project Owner role.
Syntax
Command Syntax
mongocli atlas dbusers create [builtInRole]... [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
builtInRole | string | false | Atlas built-in role that you want to assign to the user. |
Options
Name | Type | Required | Description |
|---|---|---|---|
--awsIAMType | string | false | AWS IAM method by which the provided username is authenticated. Valid values are NONE, USER, or ROLE. If you set this to USER or ROLE, the user authenticates with IAM credentials and doesn't need a password. If you set this to USER or ROLE, you can't set --x509Type or --ldapType to any value other than NONE. This value defaults to "NONE". |
--deleteAfter | string | false | Timestamp in ISO 8601 in UTC after which Atlas deletes the user. |
-h, --help | false | help for create | |
--ldapType | string | false | LDAP method by which the provided username is authenticated. Valid values are NONE, USER, or GROUP. If you set this to USER or GROUP, the user authenticates with LDAP. If you set this to USER or GROUP, you can't set --x509Type or --awsIAMType to any value other than NONE. This value defaults to "NONE". |
-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 | Comma-separated list that specifies the user's roles and the databases or collections on which the roles apply.
The roles format is roleName[@dbName[.collection]].
roleName can either be a built-in role or a custom role.
dbName and collection are required only for built-in roles. |
--scope | strings | false | Array of clusters and Atlas Data Lakes that this user has access to. |
-u, --username | string | true | Username for authenticating to MongoDB. |
--x509Type | string | false | X.509 method by which the provided username is authenticated. Valid values are NONE, MANAGED, or CUSTOMER. If you set this to MANAGED the user authenticates with an Atlas-managed X.509 certificate. If you set this to CUSTOMER, the user authenticates with a self-managed X.509 certificate. If you set this to MANAGED or CUSTOMER, you can't set --awsIAMType or --ldapType to any value other than NONE. This value defaults to "NONE". |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
Database user '<Username>' successfully created.
Examples
# Create an Atlas database admin user named myAdmin for the project with ID 5e2211c17a3e5a48f5497de3: mongocli atlas dbusers create atlasAdmin --username myAdmin --projectId 5e2211c17a3e5a48f5497de3
# Create a database user named myUser with read/write access to any database for the project with ID 5e2211c17a3e5a48f5497de3: mongocli atlas dbusers create readWriteAnyDatabase --username myUser --projectId 5e2211c17a3e5a48f5497de3
# Create a database user named myUser with multiple roles for the project with ID 5e2211c17a3e5a48f5497de3: mongocli atlas dbusers create --username myUser --role clusterMonitor,backup --projectId 5e2211c17a3e5a48f5497de3
# Create a database user named myUser with multiple scopes for the project with ID 5e2211c17a3e5a48f5497de3: mongocli atlas dbusers create --username myUser --role clusterMonitor --scope <REPLICA-SET ID>,<storeName> --projectId 5e2211c17a3e5a48f5497de3