From 3f31c2b3fd69e90fe59aced01bddbbb389a5d675 Mon Sep 17 00:00:00 2001 From: Seth Vargo Date: Thu, 7 Sep 2017 22:07:07 -0400 Subject: [PATCH] Add "auth help" command documentation --- .../source/docs/commands/auth/help.html.md | 45 +++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 website/source/docs/commands/auth/help.html.md diff --git a/website/source/docs/commands/auth/help.html.md b/website/source/docs/commands/auth/help.html.md new file mode 100644 index 0000000000..73a4cbe785 --- /dev/null +++ b/website/source/docs/commands/auth/help.html.md @@ -0,0 +1,45 @@ +--- +layout: "docs" +page_title: "auth help - Command" +sidebar_current: "docs-commands-auth-help" +description: |- + The "auth help" command prints usage and help for an auth method. +--- + +# auth help + +The `auth help` command prints usage and help for an auth method. + + - If given a TYPE, this command prints the default help for the auth method of + that type. + + - If given a PATH, this command prints the help output for the auth method + enabled at that path. This path must already exist. + +Each auth method produces its own help output. + +## Examples + +Get usage instructions for the userpass auth method: + +```text +$ vault auth help userpass +Usage: vault login -method=userpass [CONFIG K=V...] + + The userpass authentication method allows users to authenticate using Vault's + internal user database. + +# ... +``` + +Print usage for the auth method enabled at my-method/ + +```text +$ vault auth help my-method/ +# ... +``` + +## Usage + +There are no flags beyond the [standard set of flags](/docs/commands/index.html) +included on all commands.