mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-24 08:01:07 +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>
36 lines
1.7 KiB
Plaintext
36 lines
1.7 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Auto-auth with JSW
|
|
description: >-
|
|
Use JSON web tokens (JSW) for auto-authentication with Vault Agent or Vault
|
|
Proxy.
|
|
---
|
|
|
|
> [!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.
|
|
|
|
# Auto-auth method: JSON web tokens (JSW)
|
|
|
|
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).
|