luxolus
/
open-vault
2
0
Fork 0
Code Issues 1 Pull Requests Releases Activity

Merge pull request #1957 from hashicorp/website-list-userpass 

Added user listing endpoint to userpass docs
This commit is contained in:
Vishal Nayak 2016-10-04 14:10:49 -04:00 committed by GitHub
parent 5fb6758538 aef1a88de4
commit 4141b632fa
13 changed files with 149 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
website/source/docs/auth/approle.html.md
View File

@ -171,10 +171,10 @@ $ curl -XPOST "http://127.0.0.1:8200/v1/auth/approle/login" -d '{"role_id":"50be
</dd>
<dt>Method</dt>
<dd>`/auth/approle/role` (LIST) or `/auth/approle/role?list=true` (GET)</dd>
<dd>LIST/GET</dd>
<dt>URL</dt>
<dd>`LIST/GET`</dd>
<dd>`/auth/approle/role` (LIST) or `/auth/approle/role?list=true` (GET)</dd>
<dt>Parameters</dt>
<dd>
@ -218,7 +218,7 @@ $ curl -XPOST "http://127.0.0.1:8200/v1/auth/approle/login" -d '{"role_id":"50be
</dd>
<dt>Method</dt>
<dd>`POST`</dd>
<dd>POST</dd>
<dt>URL</dt>
<dd>`/auth/approle/role/[role_name]`</dd>
@ -316,7 +316,7 @@ $ curl -XPOST "http://127.0.0.1:8200/v1/auth/approle/login" -d '{"role_id":"50be
</dd>
<dt>Method</dt>
<dd>`GET`</dd>
<dd>GET</dd>
<dt>URL</dt>
<dd>`/auth/approle/role/[role_name]`</dd>
@ -363,7 +363,7 @@ $ curl -XPOST "http://127.0.0.1:8200/v1/auth/approle/login" -d '{"role_id":"50be
</dd>
<dt>Method</dt>
<dd>`DELETE`</dd>
<dd>DELETE</dd>
<dt>URL</dt>
<dd>`/auth/approle/role/[role_name]`</dd>
@ -388,7 +388,7 @@ $ curl -XPOST "http://127.0.0.1:8200/v1/auth/approle/login" -d '{"role_id":"50be
</dd>
<dt>Method</dt>
<dd>`GET`</dd>
<dd>GET</dd>
<dt>URL</dt>
<dd>`/auth/approle/role/[role_name]/role-id`</dd>
@ -426,7 +426,7 @@ $ curl -XPOST "http://127.0.0.1:8200/v1/auth/approle/login" -d '{"role_id":"50be
</dd>
<dt>Method</dt>
<dd>`POST`</dd>
<dd>POST</dd>
<dt>URL</dt>
<dd>`/auth/approle/role/[role_name]/role-id`</dd>
@ -462,7 +462,7 @@ $ curl -XPOST "http://127.0.0.1:8200/v1/auth/approle/login" -d '{"role_id":"50be
</dd>
<dt>Method</dt>
<dd>`POST`</dd>
<dd>POST</dd>
<dt>URL</dt>
<dd>`/auth/approle/role/[role_name]/secret-id`</dd>
@ -521,7 +521,7 @@ the role.
</dd>
<dt>Method</dt>
<dd>`LIST/GET`</dd>
<dd>LIST/GET</dd>
<dt>URL</dt>
<dd>`/auth/approle/role/[role_name]/secret-id` (LIST) or `/auth/approle/role/[role_name]/secret-id?list=true` (GET)</dd>
@ -566,7 +566,7 @@ the role.
</dd>
<dt>Method</dt>
<dd>`POST`</dd>
<dd>POST</dd>
<dt>URL</dt>
<dd>`/auth/approle/role/[role_name]/secret-id/lookup`</dd>
@ -615,7 +615,7 @@ Secret ID attached to the role
</dd>
<dt>Method</dt>
<dd>`DELETE`</dd>
<dd>DELETE</dd>
<dt>URL</dt>
<dd>`/auth/approle/role/[role_name]/secret-id/destroy`</dd>
@ -647,7 +647,7 @@ Secret ID attached to the role
</dd>
<dt>Method</dt>
<dd>`POST`</dd>
<dd>POST</dd>
<dt>URL</dt>
<dd>`/auth/approle/role/[role_name]/secret-id-accessor/lookup`</dd>
@ -697,7 +697,7 @@ Accessor of the secret ID
</dd>
<dt>Method</dt>
<dd>`DELETE`</dd>
<dd>DELETE</dd>
<dt>URL</dt>
<dd>`/auth/approle/role/[role_name]/secret-id-accessor/destroy`</dd>
@ -730,7 +730,7 @@ Accessor of the secret ID
</dd>
<dt>Method</dt>
<dd>`POST`</dd>
<dd>POST</dd>
<dt>URL</dt>
<dd>`/auth/approle/role/[role_name]/custom-secret-id`</dd>
@ -800,7 +800,7 @@ the role.
</dd>
<dt>Method</dt>
<dd>`POST`</dd>
<dd>POST</dd>
<dt>URL</dt>
<dd>`/auth/approle/login`</dd>
@ -869,7 +869,7 @@ the role.
</dd>
<dt>Method</dt>
<dd>`POST/GET/DELETE`</dd>
<dd>POST/GET/DELETE</dd>
<dt>URL</dt>
<dd>`/auth/approle/role/[role_name]/[field_name]`</dd>

17
website/source/docs/auth/aws-ec2.html.md
View File

@ -565,10 +565,10 @@ The response will be in JSON. For example:
</dd>
<dt>Method</dt>
<dd>GET</dd>
<dd>LIST/GET</dd>
<dt>URL</dt>
<dd>`/auth/aws-ec2/config/certificates?list=true`</dd>
<dd>`/auth/aws-ec2/config/certificates` (LIST) or `/auth/aws-ec2/config/certificates?list=true` (GET)</dd>
<dt>Parameters</dt>
<dd>
@ -974,10 +974,10 @@ in `*`).
</dd>
<dt>Method</dt>
<dd>GET</dd>
<dd>LIST/GET</dd>
<dt>URL</dt>
<dd>`/auth/aws-ec2/roles?list=true`</dd>
<dd>`/auth/aws-ec2/roles` (LIST) or `/auth/aws-ec2/roles?list=true` (GET)</dd>
<dt>Parameters</dt>
<dd>
@ -1295,10 +1295,10 @@ tag, the `nonce` holds no significance.
</dd>
<dt>Method</dt>
<dd>GET</dd>
<dd>LIST/GET</dd>
<dt>URL</dt>
<dd>`/auth/aws-ec2/roletag-blacklist?list=true`</dd>
<dd>`/auth/aws-ec2/roletag-blacklist` (LIST) or `/auth/aws-ec2/roletag-blacklist?list=true` (GET)</dd>
<dt>Parameters</dt>
<dd>
@ -1440,11 +1440,10 @@ tag, the `nonce` holds no significance.
</dd>
<dt>Method</dt>
<dd>GET</dd>
<dd>LIST/GET</dd>
<dt>URL</dt>
<dd>`/auth/aws-ec2/identity-whitelist?list=true`</dd>
<dd>`/auth/aws-ec2/identity-whitelist` (LIST) or `/auth/aws-ec2/identity-whitelist?list=true` (GET)</dd>
<dt>Parameters</dt>
<dd>
None.

11
website/source/docs/auth/token.html.md
View File

@ -41,7 +41,7 @@ of the header should be "X-Vault-Token" and the value should be the token.
## API
### /auth/token/accessors
#### LIST or GET
#### LIST
<dl class="api">
<dt>Description</dt>
@ -52,11 +52,10 @@ of the header should be "X-Vault-Token" and the value should be the token.
</dd>
<dt>Method</dt>
<dd>LIST or GET</dd>
<dd>LIST/GET</dd>
<dt>URL</dt>
<dd>`/auth/token/accessors` (LIST)<dd>
<dd>`/auth/token/accessors?list=true` (GET)<dd>
<dd>`/auth/token/accessors` (LIST) or `/auth/token/accessors?list=true` (GET)<dd>
<dt>Parameters</dt>
<dd>
@ -684,10 +683,10 @@ of the header should be "X-Vault-Token" and the value should be the token.
</dd>
<dt>Method</dt>
<dd>GET</dd>
<dd>LIST/GET</dd>
<dt>URL</dt>
<dd>`/auth/token/roles?list=true`<dd>
<dd>`/auth/token/roles` (LIST) or `/auth/token/roles?list=true` (GET)<dd>
<dt>Parameters</dt>
<dd>

100
website/source/docs/auth/userpass.html.md
View File

@ -164,6 +164,72 @@ necessary.
</dd>
</dl>
#### GET
<dl class="api">
<dt>Description</dt>
<dd>
Reads the properties of an existing username.
</dd>
<dt>Method</dt>
<dd>GET</dd>
<dt>URL</dt>
<dd>`/auth/userpass/users/[username]`</dd>
<dt>Parameters</dt>
<dd>
None.
</dd>
<dt>Returns</dt>
<dd>
```javascript
{
"request_id": "812229d7-a82e-0b20-c35b-81ce8c1b9fa6",
"lease_id": "",
"lease_duration": 0,
"renewable": false,
"data": {
"max_ttl": 0,
"policies": "default,dev",
"ttl": 0
},
"warnings": null
}
```
</dd>
</dl>
#### DELETE
<dl class="api">
<dt>Description</dt>
<dd>
Deletes an existing username from the backend.
</dd>
<dt>Method</dt>
<dd>DELETE</dd>
<dt>URL</dt>
<dd>`/auth/userpass/users/[username]`</dd>
<dt>Parameters</dt>
<dd>
None.
</dd>
<dt>Returns</dt>
<dd>`204` response code.
</dd>
</dl>
### /auth/userpass/users/[username]/password
#### POST
<dl class="api">
@ -295,3 +361,37 @@ necessary.
</dd>
</dl>
### /auth/userpass/users
#### LIST
<dl class="api">
<dt>Description</dt>
<dd>
List the users registered with the backend.
</dd>
<dt>Method</dt>
<dd>LIST/GET</dd>
<dt>URL</dt>
<dd>`/auth/userpass/users` (LIST) `/auth/userpass/users?list=true` (GET)</dd>
<dt>Parameters</dt>
<dd>
None
</dd>
<dt>Returns</dt>
<dd>
```javascript
[
"devuser",
"produser"
]
```
</dd>
</dl>

4
website/source/docs/secrets/aws/index.html.md
View File

@ -560,10 +560,10 @@ errors for exceeding the AWS limit of 32 characters on STS token names.
</dd>
<dt>Method</dt>
<dd>GET</dd>
<dd>LIST/GET</dd>
<dt>URL</dt>
<dd>`/aws/roles/?list=true`</dd>
<dd>`/aws/roles` (LIST) or `/aws/roles/?list=true` (GET)</dd>
<dt>Parameters</dt>
<dd>

4
website/source/docs/secrets/cubbyhole/index.html.md
View File

@ -137,10 +137,10 @@ As expected, the value previously set is returned to us.
</dd>
<dt>Method</dt>
<dd>GET</dd>
<dd>LIST/GET</dd>
<dt>URL</dt>
<dd>`/cubbyhole/<path>?list=true`</dd>
<dd>`/cubbyhole/<path>` (LIST) or `/cubbyhole/<path>?list=true` (GET)</dd>
<dt>Parameters</dt>
<dd>

4
website/source/docs/secrets/generic/index.html.md
View File

@ -120,10 +120,10 @@ seconds (one hour) as specified.
</dd>
<dt>Method</dt>
<dd>GET</dd>
<dd>LIST/GET</dd>
<dt>URL</dt>
<dd>`/secret/<path>?list=true`</dd>
<dd>`/secret/<path>` (LIST) or `/secret/<path>?list=true` (GET)</dd>
<dt>Parameters</dt>
<dd>

4
website/source/docs/secrets/mongodb/index.html.md
View File

@ -386,10 +386,10 @@ applications are restricted in the credentials they are allowed to read.
</dd>
<dt>Method</dt>
<dd>GET</dd>
<dd>LIST/GET</dd>
<dt>URL</dt>
<dd>`/mongodb/roles/?list=true`</dd>
<dd>`/mongodb/roles` (LIST) or `/mongodb/roles/?list=true` (GET)</dd>
<dt>Parameters</dt>
<dd>

4
website/source/docs/secrets/mssql/index.html.md
View File

@ -280,10 +280,10 @@ allowed to read.
</dd>
<dt>Method</dt>
<dd>GET</dd>
<dd>LIST/GET</dd>
<dt>URL</dt>
<dd>`/roles/?list=true`</dd>
<dd>`/mssql/roles` (LIST) or `/mssql/roles/?list=true` (GET)</dd>
<dt>Parameters</dt>
<dd>

4
website/source/docs/secrets/mysql/index.html.md
View File

@ -327,10 +327,10 @@ the default on versions prior to that.
</dd>
<dt>Method</dt>
<dd>GET</dd>
<dd>LIST/GET</dd>
<dt>URL</dt>
<dd>`/roles/?list=true`</dd>
<dd>`/mysql/roles` (LIST) or `/mysql/roles/?list=true` (GET)</dd>
<dt>Parameters</dt>
<dd>

8
website/source/docs/secrets/pki/index.html.md
View File

@ -496,10 +496,10 @@ subpath for interactive help output.
</dd>
<dt>Method</dt>
<dd>GET</dd>
<dd>LIST/GET</dd>
<dt>URL</dt>
<dd>`/pki/certs/?list=true`</dd>
<dd>`/pki/certs` (LIST) or `/pki/certs?list=true` (GET)</dd>
<dt>Parameters</dt>
<dd>
@ -1285,10 +1285,10 @@ subpath for interactive help output.
</dd>
<dt>Method</dt>
<dd>GET</dd>
<dd>LIST/GET</dd>
<dt>URL</dt>
<dd>`/pki/roles/?list=true`</dd>
<dd>`/pki/roles` (LIST) or `/pki/roles?list=true` (GET)</dd>
<dt>Parameters</dt>
<dd>

4
website/source/docs/secrets/postgresql/index.html.md
View File

@ -298,10 +298,10 @@ subpath for interactive help output.
</dd>
<dt>Method</dt>
<dd>GET</dd>
<dd>LIST/GET</dd>
<dt>URL</dt>
<dd>`/roles/?list=true`</dd>
<dd>`/postgresql/roles` (LIST) or `/postgresql/roles/?list=true` (GET)</dd>
<dt>Parameters</dt>
<dd>

4
website/source/docs/secrets/ssh/index.html.md
View File

@ -517,10 +517,10 @@ username@<IP of remote host>:~$
</dd>
<dt>Method</dt>
<dd>GET</dd>
<dd>LIST/GET</dd>
<dt>URL</dt>
<dd>`/roles/?list=true`</dd>
<dd>`/ssh/roles` (LIST) or `/ssh/roles?list=true` (GET)</dd>
<dt>Parameters</dt>
<dd>