open-vault/website/source/docs/commands/auth/list.html.md

53 lines
1.7 KiB
Markdown
Raw Normal View History

2017-09-08 02:07:10 +00:00
---
layout: "docs"
page_title: "auth list - Command"
sidebar_title: "<code>list</code>"
2017-09-08 02:07:10 +00:00
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.
CLI Enhancements (#3897) * Use Colored UI if stdout is a tty * Add format options to operator unseal * Add format test on operator unseal * Add -no-color output flag, and use BasicUi if no-color flag is provided * Move seal status formatting logic to OutputSealStatus * Apply no-color to warnings from DeprecatedCommands as well * Add OutputWithFormat to support arbitrary data, add format option to auth list * Add ability to output arbitrary list data on TableFormatter * Clear up switch logic on format * Add format option for list-related commands * Add format option to rest of commands that returns a client API response * Remove initOutputYAML and initOutputJSON, and use OutputWithFormat instead * Remove outputAsYAML and outputAsJSON, and use OutputWithFormat instead * Remove -no-color flag, use env var exclusively to toggle colored output * Fix compile * Remove -no-color flag in main.go * Add missing FlagSetOutputFormat * Fix generate-root/decode test * Migrate init functions to main.go * Add no-color flag back as hidden * Handle non-supported data types for TableFormatter.OutputList * Pull formatting much further up to remove the need to use c.flagFormat (#3950) * Pull formatting much further up to remove the need to use c.flagFormat Also remove OutputWithFormat as the logic can cause issues. * Use const for env var * Minor updates * Remove unnecessary check * Fix SSH output and some tests * Fix tests * Make race detector not run on generate root since it kills Travis these days * Update docs * Update docs * Address review feedback * Handle --format as well as -format
2018-02-12 23:12:16 +00:00
### Output Options
- `-format` `(string: "table")` - Print the output in the given format. Valid
formats are "table", "json", or "yaml". This can also be specified via the
`VAULT_FORMAT` environment variable.
### Command Options
2017-09-08 02:07:10 +00:00
- `-detailed` `(bool: false)` - Print detailed information such as configuration
and replication status about each auth method.