Skip to content

Commit eb7c92f

Browse files
committed
Fixed REST API examples, links, and explanations in password rotation doc
1 parent 6b5b8e1 commit eb7c92f

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

content/operate/rs/7.8/security/access-control/manage-passwords/rotate-passwords.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,37 +42,46 @@ The new password cannot already exist as a password for the user and must meet t
4242

4343
## Rotate password
4444

45-
To rotate your password:
45+
To rotate passwords:
4646

47-
1. Add an additional password to your password list with [`POST /v1/users/password`]({{< relref "/operate/rs/7.8/references/rest-api/requests/users/password#add-password" >}}). You must provide the relevant username and current password for [basic authentication]({{<relref "/operate/rs/7.8/references/rest-api#authentication">}}) credentials when you send the request.
47+
1. Add an additional password to a user's password list with [`POST /v1/users/password`]({{< relref "/operate/rs/7.8/references/rest-api/requests/users/password#add-password" >}}).
4848

4949
```sh
5050
POST https://<host>:<port>/v1/users/password
51-
{ "new_password": "<a_new_password>" }
51+
{
52+
"username": "<target_username>",
53+
"new_password": "<a_new_password>"
54+
}
5255
```
5356

54-
After you send this request, you can authenticate with both the old and the new password.
57+
After you send this request, the user can authenticate with both the old and the new password.
5558

5659
1. Update the password in all database connections that connect with the user account.
57-
1. Delete the original password with [`DELETE /v1/users/password`]({{< relref "/operate/rs/7.8/references/rest-api/requests/users/password#update-password" >}}):
60+
1. Delete the original password with [`DELETE /v1/users/password`]({{< relref "/operate/rs/7.8/references/rest-api/requests/users/password#delete-password" >}}):
5861

5962
```sh
6063
DELETE https://<host>:<port>/v1/users/password
61-
{ "old_password": "<an_existing_password>" }
64+
{
65+
"username": "<target_username>",
66+
"old_password": "<existing_password_to_delete>"
67+
}
6268
```
6369

6470
If there is only one valid password for a user account, you cannot delete that password.
6571

6672
## Replace all passwords
6773

68-
You can also replace all existing passwords for your user account with a single password that does not match any existing passwords.
74+
You can also replace all existing passwords for a user account with a single password that does not match any existing passwords.
6975
This can be helpful if you suspect that your passwords are compromised and you want to quickly resecure the account.
7076

71-
To replace your passwords, use [`PUT /v1/users/password`]({{< relref "/operate/rs/7.8/references/rest-api/requests/users/password#delete-password" >}}). You must provide the relevant username and current password for [basic authentication]({{<relref "/operate/rs/7.8/references/rest-api#authentication">}}) credentials when you send the request.
77+
To replace a user's passwords, use [`PUT /v1/users/password`]({{< relref "/operate/rs/7.8/references/rest-api/requests/users/password#update-password" >}}).
7278
7379
```sh
7480
PUT https://<host>:<port>/v1/users/password
75-
{ "new_password": "<a_new_password>" }
81+
{
82+
"username": "<target_username>",
83+
"new_password": "<a_new_password>"
84+
}
7685
```
7786
78-
After this request, all of your existing passwords are deleted and only the new password is valid.
87+
After this request, all of the user's existing passwords are deleted and only the new password is valid.

0 commit comments

Comments
 (0)