a3dfde5cec
* conversion stage 1 * correct image paths * add sidebar title to frontmatter * docs/concepts and docs/internals * configuration docs and multi-level nav corrections * commands docs, index file corrections, small item nav correction * secrets converted * auth * add enterprise and agent docs * add extra dividers * secret section, wip * correct sidebar nav title in front matter for apu section, start working on api items * auth and backend, a couple directory structure fixes * remove old docs * intro side nav converted * reset sidebar styles, add hashi-global-styles * basic styling for nav sidebar * folder collapse functionality * patch up border length on last list item * wip restructure for content component * taking middleman hacking to the extreme, but its working * small css fix * add new mega nav * fix a small mistake from the rebase * fix a content resolution issue with middleman * title a couple missing docs pages * update deps, remove temporary markup * community page * footer to layout, community page css adjustments * wip downloads page * deps updated, downloads page ready * fix community page * homepage progress * add components, adjust spacing * docs and api landing pages * a bunch of fixes, add docs and api landing pages * update deps, add deploy scripts * add readme note * update deploy command * overview page, index title * Update doc fields Note this still requires the link fields to be populated -- this is solely related to copy on the description fields * Update api_basic_categories.yml Updated API category descriptions. Like the document descriptions you'll still need to update the link headers to the proper target pages. * Add bottom hero, adjust CSS, responsive friendly * Add mega nav title * homepage adjustments, asset boosts * small fixes * docs page styling fixes * meganav title * some category link corrections * Update API categories page updated to reflect the second level headings for api categories * Update docs_detailed_categories.yml Updated to represent the existing docs structure * Update docs_detailed_categories.yml * docs page data fix, extra operator page remove * api data fix * fix makefile * update deps, add product subnav to docs and api landing pages * Rearrange non-hands-on guides to _docs_ Since there is no place for these on learn.hashicorp, we'll put them under _docs_. * WIP Redirects for guides to docs * content and component updates * font weight hotfix, redirects * fix guides and intro sidenavs * fix some redirects * small style tweaks * Redirects to learn and internally to docs * Remove redirect to `/vault` * Remove `.html` from destination on redirects * fix incorrect index redirect * final touchups * address feedback from michell for makefile and product downloads
82 lines
2 KiB
Markdown
82 lines
2 KiB
Markdown
---
|
|
layout: "docs"
|
|
page_title: "auth - Command"
|
|
sidebar_title: "auth"
|
|
sidebar_current: "docs-commands-auth"
|
|
description: |-
|
|
The "auth" command groups subcommands for interacting with Vault's auth
|
|
methods. Users can list, enable, disable, and get help for different auth
|
|
methods.
|
|
---
|
|
|
|
# auth
|
|
|
|
The `auth` command groups subcommands for interacting with Vault's auth methods.
|
|
Users can list, enable, disable, and get help for different auth methods.
|
|
|
|
For more information, please see the [auth method
|
|
documentation](/docs/auth/index.html) or the [authentication
|
|
concepts](/docs/concepts/auth.html) page.
|
|
|
|
To authenticate to Vault as a user or machine, use the [`vault login`](/docs/commands/login.html) command instead. This command is for
|
|
interacting with the auth methods themselves, not authenticating to Vault.
|
|
|
|
## Examples
|
|
|
|
Enable an auth method:
|
|
|
|
```text
|
|
$ vault auth enable userpass
|
|
Success! Enabled userpass auth method at: userpass/
|
|
```
|
|
|
|
List all auth methods:
|
|
|
|
```text
|
|
$ vault auth list
|
|
Path Type Description
|
|
---- ---- -----------
|
|
token/ token token based credentials
|
|
userpass/ userpass n/a
|
|
```
|
|
|
|
Get help about how to authenticate to a particular auth method:
|
|
|
|
```text
|
|
$ vault auth help userpass/
|
|
Usage: vault login -method=userpass [CONFIG K=V...]
|
|
# ...
|
|
```
|
|
|
|
Disable an auth method:
|
|
|
|
```text
|
|
$ vault auth disable userpass/
|
|
Success! Disabled the auth method (if it existed) at: userpass/
|
|
```
|
|
|
|
Tune an auth method:
|
|
|
|
```text
|
|
$ vault auth tune -max-lease-ttl=30m userpass/
|
|
Success! Tuned the auth method at: userpass/
|
|
```
|
|
|
|
## Usage
|
|
|
|
```text
|
|
Usage: vault auth <subcommand> [options] [args]
|
|
|
|
# ...
|
|
|
|
Subcommands:
|
|
disable Disables an auth method
|
|
enable Enables a new auth method
|
|
help Prints usage for an auth method
|
|
list Lists enabled auth methods
|
|
tune Tunes an auth method configuration
|
|
```
|
|
|
|
For more information, examples, and usage about a subcommand, click on the name
|
|
of the subcommand in the sidebar.
|