Add documentation for new ldap param (#23817)

This commit is contained in:
kpcraig
2023-11-01 11:33:53 -04:00
committed by GitHub
parent 95535193a4
commit dd15e5296f

View File

@@ -63,6 +63,9 @@ to search and change entry passwords in LDAP.
- `client_tls_cert` `(string: <optional>)` - Client certificate to provide to the LDAP server, must be x509 - `client_tls_cert` `(string: <optional>)` - Client certificate to provide to the LDAP server, must be x509
PEM encoded. PEM encoded.
- `client_tls_key` `(string: <optional>)` - Client key to provide to the LDAP server, must be x509 PEM encoded. - `client_tls_key` `(string: <optional>)` - Client key to provide to the LDAP server, must be x509 PEM encoded.
- `skip_static_role_import_rotation` `(bool: false)` - The default value to use for `skip_import_rotation` when
creating static roles. This field can be overridden on an individual role level during [role creation](#static-roles).
See the [static roles section](#static-roles) for more detailed information and caveats.
**Deprecated Parameters**: **Deprecated Parameters**:
@@ -181,6 +184,10 @@ The `static-role` endpoint configures Vault to manage the passwords of existing
- `rotation_period` `(string: <required>)` - How often Vault should rotate the password of the user entry. Accepts - `rotation_period` `(string: <required>)` - How often Vault should rotate the password of the user entry. Accepts
[duration format strings](/vault/docs/concepts/duration-format). The minimum rotation period is 5 seconds.<br /> [duration format strings](/vault/docs/concepts/duration-format). The minimum rotation period is 5 seconds.<br />
**Example:** `"3600", "5s", "1h"` **Example:** `"3600", "5s", "1h"`
- `skip_import_rotation` `(boolean: false)` - When set on a role creation request, Vault will not rotate the
pre-existing password of the associated LDAP entry. Note: This means that Vault will not be able to supply the
password to `GET` requests until the password is rotated (either automatically or manually by `rotate-role`). This
field overrides `skip_static_role_import_rotation` from the ldap config if both are set.
### Sample payload ### Sample payload