Docs Menu

Docs HomeAtlas CLI

atlas customDbRoles create

On this page

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

Create a custom database role for your project.

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

Command Syntax
atlas customDbRoles create <roleName> [options]
Name
Type
Required
Description
roleName
string
true
Name of the custom role to create.
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.
--projectId
string
false
Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
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.

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.
# Create a custom database role
atlas customDbRoles create customRole --privilege FIND@databaseName,UPDATE@databaseName.collectionName
# 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
←  atlas customDbRolesatlas customDbRoles delete →