mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-17 03:57:01 +02:00
* VAULT-15546 First pass at Vault Proxy docs * VAULT-15546 correct errors * VAULT-15546 fully qualify paths * VAULT-15546 remove index * VAULT-15546 Some typos and clean up * VAULT-15546 fix link * VAULT-15546 Add redirects so old links stay working * VAULT-15546 more explicit redirects * VAULT-15546 typo fixes * Suggestions for Vault Agent & Vault Proxy docs (#20612) * Rename 'agentandproxy' to 'agent-and-proxy' for better URL * Update the index pages for each section * VAULT-15546 fix link typo --------- Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
31 lines
1.2 KiB
Plaintext
31 lines
1.2 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Vault Auto-Auth JWT Method
|
|
description: JWT Method for Vault Auto-Auth
|
|
---
|
|
|
|
# Vault Auto-Auth JWT Method
|
|
|
|
The `jwt` method reads in a JWT from a file and sends it to the [JWT Auth
|
|
method](/vault/docs/auth/jwt).
|
|
|
|
## Configuration
|
|
|
|
- `path` `(string: required)` - The path to the JWT file
|
|
|
|
- `role` `(string: required)` - The role to authenticate against on Vault
|
|
|
|
- `remove_jwt_after_reading` `(bool: optional, defaults to true)` -
|
|
This can be set to `false` to disable the default behavior of removing the
|
|
JWT after it's been read.
|
|
|
|
- `remove_jwt_follows_symlinks` `(bool: optional, defaults to false)` -
|
|
This can be set to `true` to follow symlinks when removing the JWT after it has been read
|
|
when executing the `remove_jwt_after_reading` behaviour. If set to false, it will delete
|
|
the symlink, not the JWT. Does nothing if `remove_jwt_after_reading` is false.
|
|
|
|
- `jwt_read_period` `(duration: "0.5s", optional)` - The duration after which
|
|
Agent will attempt to read the JWT stored at `path`. Defaults to `1m` if
|
|
`remove_jwt_after_reading` is set to `true`, or `0.5s` otherwise.
|
|
Uses [duration format strings](/vault/docs/concepts/duration-format).
|