mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-23 23:51:08 +02:00
0660ea6fac
* Update README Let contributors know that docs will now be located in UDR * Add comments to each mdx doc Comment has been added to all mdx docs that are not partials * chore: added changelog changelog check failure * wip: removed changelog * Fix content errors * Doc spacing * Update website/content/docs/deploy/kubernetes/vso/helm.mdx Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> --------- Co-authored-by: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
47 lines
1.4 KiB
Plaintext
47 lines
1.4 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: auth help - Command
|
|
description: The "auth help" command prints usage and help for an auth method.
|
|
---
|
|
|
|
> [!IMPORTANT]
|
|
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
|
|
|
|
# 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:
|
|
|
|
```shell-session
|
|
$ vault auth help userpass
|
|
Usage: vault login -method=userpass [CONFIG K=V...]
|
|
|
|
The userpass auth method allows users to authenticate using Vault's
|
|
internal user database.
|
|
|
|
# ...
|
|
```
|
|
|
|
Print usage for the auth method enabled at my-method/
|
|
|
|
```shell-session
|
|
$ vault auth help my-method/
|
|
# ...
|
|
```
|
|
|
|
## Usage
|
|
|
|
There are no flags beyond the [standard set of flags](/vault/docs/commands)
|
|
included on all commands.
|