From eeefe935b13e1cf4f51e51a9a4eccf1e3e118620 Mon Sep 17 00:00:00 2001 From: Seth Vargo Date: Thu, 7 Sep 2017 22:07:10 -0400 Subject: [PATCH] Add "auth list" command documentation --- .../source/docs/commands/auth/list.html.md | 43 +++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 website/source/docs/commands/auth/list.html.md diff --git a/website/source/docs/commands/auth/list.html.md b/website/source/docs/commands/auth/list.html.md new file mode 100644 index 0000000000..27d8d80363 --- /dev/null +++ b/website/source/docs/commands/auth/list.html.md @@ -0,0 +1,43 @@ +--- +layout: "docs" +page_title: "auth list - Command" +sidebar_current: "docs-commands-auth-list" +description: |- + The "auth list" command lists the auth methods enabled. The output lists the + enabled auth methods and options for those methods. +--- + +# auth list + +The `auth list` command lists the auth methods enabled. The output lists the +enabled auth methods and options for those methods. + +## Examples + +List all auth methods: + +```text +$ vault auth list +Path Type Description +---- ---- ----------- +token/ token token based credentials +userpass/ userpass n/a +``` + +List detailed auth method information: + +```text +$ vault auth list -detailed +Path Type Accessor Plugin Default TTL Max TTL Replication Description +---- ---- -------- ------ ----------- ------- ----------- ----------- +token/ token auth_token_b2166f9e n/a system system replicated token based credentials +userpass/ userpass auth_userpass_eea6507e n/a system system replicated n/a +``` + +## Usage + +The following flags are available in addition to the [standard set of +flags](/docs/commands/index.html) included on all commands. + +- `-detailed` `(bool: false)` - Print detailed information such as configuration + and replication status about each auth method.