diff --git a/website/content/docs/agent-and-proxy/autoauth/methods/ldap.mdx b/website/content/docs/agent-and-proxy/autoauth/methods/ldap.mdx new file mode 100644 index 000000000000..f2569e378fd7 --- /dev/null +++ b/website/content/docs/agent-and-proxy/autoauth/methods/ldap.mdx @@ -0,0 +1,32 @@ +--- +layout: docs +page_title: Vault Auto-Auth LDAP Method +description: LDAP Method for Vault Auto-Auth +--- + +# Vault Auto-Auth LDAP Method + +The `ldap` method reads in a password from a file and sends it to the [LDAP Auth +method](/vault/docs/auth/ldap). + +## Configuration + +- `password_file_path` `(string: required)` - The path to the password file + +- `username` `(string: required)` - The username to authenticate against on Vault + +- `remove_password_after_reading` `(bool: optional, defaults to true)` - + This can be set to `false` to disable the default behavior of removing the + password after it's been read. + +- `remove_password_follows_symlinks` `(bool: optional, defaults to false)` - +This can be set to `true` to follow symlinks when removing the password after +it has been read when executing the `remove_password_after_reading` behaviour. +If set to false, it will delete the symlink, not the password file. Does +nothing if `remove_password_after_reading` is false. + +- `password_read_period` `(duration: "0.5s", optional)` - The duration after which +auto-auth will attempt to read the password stored at `password_file_path`. +Defaults to `1m` if `remove_password_after_reading` is set to `true`, or `0.5s` +otherwise. Uses [duration format +strings](/vault/docs/concepts/duration-format). diff --git a/website/data/docs-nav-data.json b/website/data/docs-nav-data.json index 09a13ded3c62..bdb2beb8ae00 100644 --- a/website/data/docs-nav-data.json +++ b/website/data/docs-nav-data.json @@ -1008,6 +1008,10 @@ "title": "JWT", "path": "agent-and-proxy/autoauth/methods/jwt" }, + { + "title": "LDAP", + "path": "agent-and-proxy/autoauth/methods/ldap" + }, { "title": "Kerberos", "path": "agent-and-proxy/autoauth/methods/kerberos"