2015-04-18 00:41:56 +00:00
|
|
|
---
|
|
|
|
layout: "docs"
|
2017-09-13 01:48:52 +00:00
|
|
|
page_title: "Auth Methods"
|
New Docs Website (#5535)
* 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
2018-10-19 15:40:11 +00:00
|
|
|
sidebar_title: "Auth Methods"
|
2015-04-18 00:41:56 +00:00
|
|
|
sidebar_current: "docs-auth"
|
|
|
|
description: |-
|
2017-09-13 01:48:52 +00:00
|
|
|
Auth methods are mountable methods that perform authentication for Vault.
|
2015-04-18 00:41:56 +00:00
|
|
|
---
|
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
# Auth Methods
|
2015-04-18 00:41:56 +00:00
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
Auth methods are the components in Vault that perform authentication and are
|
|
|
|
responsible for assigning identity and a set of policies to a user.
|
2015-04-18 00:41:56 +00:00
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
Having multiple auth methods enables you to use an auth method that makes the
|
|
|
|
sense for your use case of Vault and your organization.
|
2015-04-18 00:41:56 +00:00
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
For example, on developer machines, the [GitHub auth method](/docs/auth/github.html)
|
2016-07-28 18:32:20 +00:00
|
|
|
is easiest to use. But for servers the [AppRole](/docs/auth/approle.html)
|
2017-09-13 01:48:52 +00:00
|
|
|
method is the recommended choice.
|
2015-04-18 00:41:56 +00:00
|
|
|
|
|
|
|
To learn more about authentication, see the
|
|
|
|
[authentication concepts page](/docs/concepts/auth.html).
|
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
## Enabling/Disabling Auth Methods
|
2015-04-18 00:41:56 +00:00
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
Auth methods can be enabled/disabled using the CLI or the API.
|
2015-04-18 00:41:56 +00:00
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
```text
|
|
|
|
$ vault auth enable userpass
|
|
|
|
```
|
|
|
|
|
|
|
|
When enabled, auth methods are similar to [secrets engines](/docs/secrets/index.html):
|
2015-04-18 00:41:56 +00:00
|
|
|
they are mounted within the Vault mount table and can be accessed
|
2017-09-13 01:48:52 +00:00
|
|
|
and configured using the standard read/write API. All auth methods are mounted underneath the `auth/` prefix.
|
|
|
|
|
|
|
|
By default, auth methods are mounted to `auth/<type>`. For example, if you
|
|
|
|
enable "github", then you can interact with it at `auth/github`. However, this
|
|
|
|
path is customizable, allowing users with advanced use cases to mount a single
|
|
|
|
auth method multiple times.
|
2015-04-18 00:41:56 +00:00
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
```text
|
|
|
|
$ vault auth enable -path=my-login userpass
|
|
|
|
```
|
2015-04-18 00:41:56 +00:00
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
When an auth method is disabled, all users authenticated via that method are
|
|
|
|
automatically logged out.
|