atlas api customDatabaseRoles
Public Preview: please provide feedback: Returns, adds, edits, and removes custom database user privilege roles.
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
Use custom roles to specify custom sets of actions that the MongoDB Cloud built-in roles can't describe. You define custom roles at the project level, for all clusters in the project. This resource supports a subset of MongoDB privilege actions. You can create a subset of custom role actions. To create a wider list of custom role actions, use the MongoDB Cloud user interface. Custom roles must include actions that all project's clusters support, and that are compatible with each MongoDB version that your project's clusters use. For example, if your project has MongoDB 4.2 clusters, you can't create custom roles that use actions introduced in MongoDB 4.4.
Options
Name | Type | Required | Description |
---|---|---|---|
-h, --help | false | help for customDatabaseRoles |
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. |
Related Commands
atlas api customDatabaseRoles createCustomDatabaseRole - Public Preview: please provide feedback: Creates one custom role in the specified project.
atlas api customDatabaseRoles deleteCustomDatabaseRole - Public Preview: please provide feedback: Removes one custom role from the specified project.
atlas api customDatabaseRoles getCustomDatabaseRole - Public Preview: please provide feedback: Returns one custom role for the specified project.
atlas api customDatabaseRoles listCustomDatabaseRoles - Public Preview: please provide feedback: Returns all custom roles for the specified project.
atlas api customDatabaseRoles updateCustomDatabaseRole - Public Preview: please provide feedback: Updates one custom role in the specified project.