open-vault/website/pages/docs/auth/index.mdx
Jeff Escalante 8eed94b072
🌷 Docs Website Maintenance (#8985)
* website maintenance round
* improve docs, revert bug workaround as it was fixed
* boost memory
* remove unnecessary code
2020-05-21 13:18:17 -04:00

46 lines
1.5 KiB
Plaintext

---
layout: docs
page_title: Auth Methods
sidebar_title: Auth Methods
description: Auth methods are mountable methods that perform authentication for Vault.
---
# Auth Methods
Auth methods are the components in Vault that perform authentication and are
responsible for assigning identity and a set of policies to a user.
Having multiple auth methods enables you to use an auth method that makes the
most sense for your use case of Vault and your organization.
For example, on developer machines, the [GitHub auth method](/docs/auth/github)
is easiest to use. But for servers the [AppRole](/docs/auth/approle)
method is the recommended choice.
To learn more about authentication, see the
[authentication concepts page](/docs/concepts/auth).
## Enabling/Disabling Auth Methods
Auth methods can be enabled/disabled using the CLI or the API.
```shell-session
$ vault auth enable userpass
```
When enabled, auth methods are similar to [secrets engines](/docs/secrets):
they are mounted within the Vault mount table and can be accessed
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.
```shell-session
$ vault auth enable -path=my-login userpass
```
When an auth method is disabled, all users authenticated via that method are
automatically logged out.