Docs Menu

Docs HomeAtlas Command Line Interface

atlas customDbRoles delete

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output

Remove the specified custom database role from your project.

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

atlas customDbRoles delete <roleName> [options]
Name
Type
Required
Description
roleName
string
true
Name of the custom role to delete.
Name
Type
Required
Description
--force
false
Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action.
-h, --help
false
help for delete
--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
Human-readable label that identifies 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. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file.

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

Custom database role '<Name>' deleted
←  atlas customDbRoles createatlas customDbRoles describe →

Specify your version