2017-05-11 21:38:54 +00:00
|
|
|
|
---
|
2020-01-18 00:18:09 +00:00
|
|
|
|
layout: api
|
|
|
|
|
page_title: MongoDB - Database - Secrets Engines - HTTP API
|
|
|
|
|
sidebar_title: MongoDB
|
|
|
|
|
description: >-
|
|
|
|
|
The MongoDB plugin for Vault's database secrets engine generates database
|
|
|
|
|
credentials to access MongoDB servers.
|
2017-05-11 21:38:54 +00:00
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# MongoDB Database Plugin HTTP API
|
|
|
|
|
|
2017-09-20 20:05:00 +00:00
|
|
|
|
The MongoDB database plugin is one of the supported plugins for the database
|
|
|
|
|
secrets engine. This plugin generates database credentials dynamically based on
|
2017-05-11 21:38:54 +00:00
|
|
|
|
configured roles for the MongoDB database.
|
|
|
|
|
|
|
|
|
|
## Configure Connection
|
|
|
|
|
|
|
|
|
|
In addition to the parameters defined by the [Database
|
|
|
|
|
Backend](/api/secret/databases/index.html#configure-connection), this plugin
|
|
|
|
|
has a number of parameters to further configure a connection.
|
|
|
|
|
|
2020-01-18 00:18:09 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
| :----- | :----------------------- |
|
|
|
|
|
| `POST` | `/database/config/:name` |
|
2017-05-11 21:38:54 +00:00
|
|
|
|
|
|
|
|
|
### Parameters
|
2017-12-05 20:31:01 +00:00
|
|
|
|
|
|
|
|
|
- `connection_url` `(string: <required>)` – Specifies the MongoDB standard
|
2020-01-18 00:18:09 +00:00
|
|
|
|
connection string (URI). This field can be templated and supports passing the
|
|
|
|
|
username and password parameters in the following format {{field_name}}. A
|
2018-04-09 16:20:29 +00:00
|
|
|
|
templated connection URL is required when using root credential rotation.
|
2017-12-05 20:31:01 +00:00
|
|
|
|
- `write_concern` `(string: "")` - Specifies the MongoDB [write
|
|
|
|
|
concern][mongodb-write-concern]. This is set for the entirety of the session,
|
|
|
|
|
maintained for the lifecycle of the plugin process. Must be a serialized JSON
|
|
|
|
|
object, or a base64-encoded serialized JSON object. The JSON payload values
|
|
|
|
|
map to the values in the [Safe][mgo-safe] struct from the mgo driver.
|
2020-01-18 00:18:09 +00:00
|
|
|
|
- `username` `(string: "")` - The root credential username used in the connection URL.
|
|
|
|
|
- `password` `(string: "")` - The root credential password used in the connection URL.
|
2017-05-11 21:38:54 +00:00
|
|
|
|
|
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"plugin_name": "mongodb-database-plugin",
|
|
|
|
|
"allowed_roles": "readonly",
|
2018-04-09 16:20:29 +00:00
|
|
|
|
"connection_url": "mongodb://{{username}}:{{password}}@mongodb.acme.com:27017/admin?ssl=true",
|
|
|
|
|
"write_concern": "{ \"wmode\": \"majority\", \"wtimeout\": 5000 }",
|
|
|
|
|
"username": "admin",
|
|
|
|
|
"password": "Password!"
|
2017-05-11 21:38:54 +00:00
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request POST \
|
|
|
|
|
--data @payload.json \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/database/config/mongodb
|
2017-05-11 21:38:54 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Statements
|
|
|
|
|
|
|
|
|
|
Statements are configured during role creation and are used by the plugin to
|
2018-03-20 18:54:10 +00:00
|
|
|
|
determine what is sent to the database on user creation, renewing, and
|
2017-05-11 21:38:54 +00:00
|
|
|
|
revocation. For more information on configuring roles see the [Role
|
2017-09-20 20:05:00 +00:00
|
|
|
|
API](/api/secret/databases/index.html#create-role) in the database secrets engine docs.
|
2017-05-11 21:38:54 +00:00
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
The following are the statements used by this plugin. If not mentioned in this
|
|
|
|
|
list the plugin does not support that statement type.
|
|
|
|
|
|
|
|
|
|
- `creation_statements` `(string: <required>)` – Specifies the database
|
|
|
|
|
statements executed to create and configure a user. Must be a
|
2017-09-20 20:05:00 +00:00
|
|
|
|
serialized JSON object, or a base64-encoded serialized JSON object.
|
2017-05-11 21:38:54 +00:00
|
|
|
|
The object can optionally contain a "db" string for session connection,
|
|
|
|
|
and must contain a "roles" array. This array contains objects that holds
|
|
|
|
|
a "role", and an optional "db" value, and is similar to the BSON document that
|
|
|
|
|
is accepted by MongoDB's `roles` field. Vault will transform this array into
|
|
|
|
|
such format. For more information regarding the `roles` field, refer to
|
|
|
|
|
[MongoDB's documentation](https://docs.mongodb.com/manual/reference/method/db.createUser/).
|
|
|
|
|
|
|
|
|
|
- `revocation_statements` `(string: "")` – Specifies the database statements to
|
2017-09-20 20:05:00 +00:00
|
|
|
|
be executed to revoke a user. Must be a serialized JSON object, or a base64-encoded
|
2017-05-11 21:38:54 +00:00
|
|
|
|
serialized JSON object. The object can optionally contain a "db" string. If no
|
|
|
|
|
"db" value is provided, it defaults to the "admin" database.
|
|
|
|
|
|
|
|
|
|
### Sample Creation Statement
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"db": "admin",
|
|
|
|
|
"roles": [
|
|
|
|
|
{
|
|
|
|
|
"role": "read",
|
2018-01-03 19:02:31 +00:00
|
|
|
|
"db": "foo"
|
2017-05-11 21:38:54 +00:00
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
2017-09-20 20:05:00 +00:00
|
|
|
|
```
|
2020-01-18 00:18:09 +00:00
|
|
|
|
|
2017-12-05 20:31:01 +00:00
|
|
|
|
[mongodb-write-concern]: https://docs.mongodb.com/manual/reference/write-concern/
|
2018-01-03 19:02:31 +00:00
|
|
|
|
[mgo-safe]: https://godoc.org/gopkg.in/mgo.v2#Safe
|