From 2b5b56febd568a74a201216eab76ebdc9e636d21 Mon Sep 17 00:00:00 2001 From: Matt Hurne Date: Tue, 5 Jul 2016 09:50:23 -0400 Subject: [PATCH] mongodb secret backend: Update documentation --- .../source/docs/secrets/mongodb/index.html.md | 62 ++++++++++++++++++- 1 file changed, 60 insertions(+), 2 deletions(-) diff --git a/website/source/docs/secrets/mongodb/index.html.md b/website/source/docs/secrets/mongodb/index.html.md index 5344e108f8..47df5b9d5b 100644 --- a/website/source/docs/secrets/mongodb/index.html.md +++ b/website/source/docs/secrets/mongodb/index.html.md @@ -155,7 +155,65 @@ applications are restricted in the credentials they are allowed to read.
Returns
- A `204` response code. + A `200` response code. +
+
+ + ```javascript + { + "lease_id": "", + "renewable": false, + "lease_duration": 0, + "data": null, + "wrap_info": null, + "warnings": [ + "Read access to this endpoint should be controlled via ACLs as it will return the connection URI as it is, including passwords, if any." + ], + "auth": null + } + ``` + +
+ + +#### GET + +
+
Description
+
+ Queries the connection configuration. Access to this endpoint should be controlled via ACLs as it will return the + connection URI as it is, including passwords, if any. +
+ +
Method
+
GET
+ +
URL
+
`/mongodb/config/connection`
+ +
Parameters
+
+ None +
+ +
Returns
+
+ + ```javascript + { + "lease_id": "", + "renewable": false, + "lease_duration": 0, + "data": { + "uri": "mongodb://admin:Password!@mongodb.acme.com:27017/admin?ssl=true", + "verify_connection": true + }, + "wrap_info": null, + "warnings": null, + "auth": null + } + ``` +
@@ -374,7 +432,7 @@ applications are restricted in the credentials they are allowed to read. "data": { "db": "foo", "password": "de0f7b50-d700-54e5-4e81-5c3724283999", - "username": "token-b32098cb-7ff2-dcf5-83cd-d5887cedf81b" + "username": "vault-token-b32098cb-7ff2-dcf5-83cd-d5887cedf81b" }, "wrap_info": null, "warnings": null,