MongoDB Atlas Database Secrets Engine
MongoDB Atlas is one of the supported plugins for the database secrets engine. This plugin generates database credentials dynamically based on configured roles for MongoDB Atlas databases. It cannot support rotating the root user's credentials because it uses a public and private key pair to authenticate.
See the database secrets engine docs for more information about setting up the database secrets engine.
Capabilities
Plugin Name | Root Credential Rotation | Dynamic Roles | Static Roles | Username Customization |
---|---|---|---|---|
mongodbatlas-database-plugin | No | Yes | Yes | Yes (1.8+) |
Setup
Enable the database secrets engine if it is not already enabled:
By default, the secrets engine will enable at the name of the engine. To enable the secrets engine at a different path, use the
-path
argument.Configure Vault with the proper plugin and connection information:
Configure a role that maps a name in Vault to a MongoDB Atlas command that executes and creates the database user credential:
Usage
After the secrets engine is configured and a user/machine has a Vault token with the proper permissions, it can generate credentials.
Generate a new credential by reading from the
/creds
endpoint with the name of the role:
API
The full list of configurable options can be seen in the MongoDB Atlas Database Plugin HTTP API page.
For more information on the database secrets engine's HTTP API please see the Database Secrets Engine API page.