Create a custom database role for your project.
To use this command, you must authenticate with a user account, a service account, or an API key with the Project Owner role.
Syntax
atlas customDbRoles create <roleName> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
roleName | string | true | Name of the custom role to create. |
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for create | |
--inheritedRole | strings | false | List of inherited roles and the database on which the role is granted. |
-o, --output | string | false | Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. |
--privilege | strings | false | List of actions per database and collection. If no database or collections are provided, cluster scope is assumed. For details on actions specific to clusters, databases, or collections, see https://dochub.mongodb.org/core/privilege-actions. |
--projectId | string | false | Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. |
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 the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
Custom database role '<RoleName>' successfully created.
Examples
# Create a custom database role atlas customDbRoles create customRole --privilege FIND@databaseName,UPDATE@databaseName.collectionName
# Create a custom database role on multiple collections atlas customDbRoles create customRole --privilege FIND@databaseName,UPDATE@databaseName.firstCollectionName,UPDATE@databaseName.secondCollectionName
# Create a customer database role with granted action on the cluster resource atlas customDbRoles create customRole --privilege GET_CMD_LINE_OPTS
# Use an inherited role atlas customDbRoles create customRole --inheritedRole read@databaseName