mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-23 23:51:08 +02:00
a43e292424
* 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
60 lines
2.0 KiB
Markdown
60 lines
2.0 KiB
Markdown
---
|
|
layout: "docs"
|
|
page_title: "auth enable - Command"
|
|
sidebar_title: "enable"
|
|
sidebar_current: "docs-commands-auth-enable"
|
|
description: |-
|
|
The "auth enable" command enables an auth method at a given path. If an auth
|
|
method already exists at the given path, an error is returned. After the auth
|
|
method is enabled, it usually needs configuration.
|
|
---
|
|
|
|
# auth enable
|
|
|
|
The `auth enable` command enables an auth method at a given path. If an auth
|
|
method already exists at the given path, an error is returned. After the auth
|
|
method is enabled, it usually needs configuration. The configuration varies by
|
|
auth method.
|
|
|
|
An auth method is responsible for authenticating users or machines and assigning
|
|
them policies and a token with which they can access Vault. Authentication is
|
|
usually mapped to policy. Please see the [policies
|
|
concepts](/docs/concepts/policies.html) page for more information.
|
|
|
|
## Examples
|
|
|
|
Enable the auth method "userpass" enabled at "userpass/":
|
|
|
|
```text
|
|
$ vault auth enable userpass
|
|
Success! Enabled the userpass auth method at: userpass/
|
|
```
|
|
|
|
Create a user:
|
|
|
|
```text
|
|
$ vault write auth/userpass/users/sethvargo password=secret
|
|
Success! Data written to: auth/userpass/users/sethvargo
|
|
```
|
|
|
|
For more information on the specific configuration options and paths, please see
|
|
the [auth method](/docs/auth/index.html) documentation.
|
|
|
|
## Usage
|
|
|
|
The following flags are available in addition to the [standard set of
|
|
flags](/docs/commands/index.html) included on all commands.
|
|
|
|
- `-description` `(string: "")` - Human-friendly description for the purpose of
|
|
this auth method.
|
|
|
|
- `-local` `(bool: false)` - Mark the auth method as local-only. Local auth
|
|
methods are not replicated nor removed by replication.
|
|
|
|
- `-path` `(string: "")` - Place where the auth method will be accessible. This
|
|
must be unique across all auth methods. This defaults to the "type" of the
|
|
auth method. The auth method will be accessible at `/auth/<path>`.
|
|
|
|
- `-plugin-name` `(string: "")` - Name of the auth method plugin. This plugin
|
|
name must already exist in the Vault server's plugin catalog.
|