Add "auth list" command documentation

This commit is contained in:
Seth Vargo
2017-09-07 22:07:10 -04:00
parent 3f31c2b3fd
commit eeefe935b1

View File

@@ -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.