Skip to content

Root-Rotation: Documentation update #1916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nayak-prajna wants to merge 4 commits into
base: main
Choose a base branch
from
+18 −0
Open

Root-Rotation: Documentation update #1916

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0cd06e8
Added root rotation content
nayak-prajna Feb 26, 2026
93d30ee
Merge branch 'main' into 42257_root_rotation_doc
nayak-prajna Feb 27, 2026
49603bf
Merge branch 'main' into 42257_root_rotation_doc
nayak-prajna Mar 2, 2026
961c043
Merge branch 'main' into 42257_root_rotation_doc
nayak-prajna Mar 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions content/vault/v1.21.x/content/api-docs/auth/ldap.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,24 @@ $ curl \
}
```

## Rotate root password

The `rotate-root` endpoint offers password rotation for the `binddn` entry used to manage LDAP.
This generated password will only be known to Vault and will not be retrievable once rotated.
Copy link
Contributor

@schavis schavis Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This generated password will only be known to Vault and will not be retrievable once rotated.
The root password becomes irretrievable and only known to Vault once you rotate it.

Style correction: write in active voice, avoid "this" as a pronoun


| Method | Path |
| :----- | :---------------------- |
| `POST` | `auth/ldap/rotate-root` |

### Sample request

```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
http://127.0.0.1:8200/v1/auth/ldap/rotate-root
Comment on lines +217 to +220
Copy link
Contributor

@schavis schavis Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
http://127.0.0.1:8200/v1/auth/ldap/rotate-root
$ curl \
--request POST \
--header "X-Vault-Token: ${VAULT_TOKEN}" \
${VAULT_ADDR}/v1/auth/ldap/rotate-root

We're slowly moving example code over to using standard env variables to reduce how much folks need to edit the example before running it.

```

## List LDAP groups

This endpoint returns a list of existing groups in the method.
Expand Down
Loading