Skip to content

Commit 5923b05

Browse files
rrelledgerrelledge
committed
DOC-5248 RS: Fixed outdated password rotation docs
1 parent 321c0ec commit 5923b05

File tree

2 files changed

+30
-49
lines changed

2 files changed

+30
-49
lines changed

‎content/operate/rs/references/rest-api/requests/users/password.md‎

Lines changed: 17 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ weight: $weight
1313

1414
| Method | Path | Description |
1515
|----------------------------|----------------------|-----------------------------|
16-
| [PUT](#update-password) | `/v1/users/password` | Change an existing password |
17-
| [POST](#add-password) | `/v1/users/password` | Add a new password |
18-
| [DELETE](#delete-password) | `/v1/users/password` | Delete a password |
16+
| [PUT](#update-password) | `/v1/users/password` | Replace the password of the authenticated user |
17+
| [POST](#add-password) | `/v1/users/password` | Add a new password for the authenticated user |
18+
| [DELETE](#delete-password) | `/v1/users/password` | Delete a password for the authenticated user |
1919

2020
## Update password {#update-password}
2121

2222
PUT /v1/users/password
2323

24-
Reset the password list of an internal user to include a new password.
24+
Replaces the password list of the user making this request with a single new password.
2525

2626
### Request {#put-request}
2727

@@ -33,8 +33,6 @@ Reset the password list of an internal user to include a new password.
3333

3434
```json
3535
{
36-
"username": "johnsmith",
37-
"old_password": "a password that exists in the current list",
3836
"new_password": "the new (single) password"
3937
}
4038
```
@@ -47,12 +45,10 @@ Reset the password list of an internal user to include a new password.
4745

4846
#### Request body
4947

50-
The request must contain a single JSON object with the following fields:
48+
The request must contain a JSON object with the following fields:
5149

5250
| Field | Type | Description |
5351
|-------|------|-------------|
54-
| username | string | Affected user (required) |
55-
| old_password | string | A password that exists in the current list (required) |
5652
| new_password | string | The new password (required) |
5753

5854
### Response {#put-response}
@@ -74,16 +70,14 @@ The following are possible `error_code` values:
7470

7571
| Code | Description |
7672
|------|-------------|
77-
| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | Success, password changed |
78-
| [400 Bad Request](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1) | Bad or missing parameters. |
79-
| [401 Unauthorized](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2) | The user is unauthorized. |
80-
| [404 Not Found](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5) | Attempting to reset password to a non-existing user. |
73+
| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | Success, password changed. |
74+
| [400 Bad Request](https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request) | Bad or missing parameters. |
8175

8276
## Add password {#add-password}
8377

8478
POST /v1/users/password
8579

86-
Add a new password to an internal user's passwords list.
80+
Adds a new password to the password list of the user making this request.
8781

8882
### Request {#post-request}
8983

@@ -95,8 +89,6 @@ Add a new password to an internal user's passwords list.
9589

9690
```json
9791
{
98-
"username": "johnsmith",
99-
"old_password": "an existing password",
10092
"new_password": "a password to add"
10193
}
10294
```
@@ -109,13 +101,11 @@ Add a new password to an internal user's passwords list.
109101

110102
#### Request body
111103

112-
The request must contain a single JSON object with the following fields:
104+
The request must contain a JSON object with the following fields:
113105

114106
| Field | Type | Description |
115107
|-------|------|-------------|
116-
| username | string | Affected user (required) |
117-
| old_password | string | A password that exists in the current list (required) |
118-
| new_password | string | The new (single) password (required) |
108+
| new_password | string | New password to add (required) |
119109

120110
### Response {#post-response}
121111

@@ -136,15 +126,14 @@ The following are possible `error_code` values:
136126

137127
| Code | Description |
138128
|------|-------------|
139-
| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | Success, new password was added to the list of valid passwords. |
140-
| [400 Bad Request](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1) | Bad or missing parameters. |
141-
| [401 Unauthorized](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2) | The user is unauthorized. |
142-
| [404 Not Found](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5) | Attempting to add a password to a non-existing user. |
129+
| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | Success, new password was added to the list of valid passwords. |
130+
| [400 Bad Request](https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request) | Bad or missing parameters. |
143131

144132
## Delete password {#delete-password}
133+
145134
DELETE /v1/users/password
146135

147-
Delete a password from an internal user's passwords list.
136+
Deletes a password from the password list of the user making this request.
148137

149138
### Request {#delete-request}
150139

@@ -156,7 +145,6 @@ Delete a password from an internal user's passwords list.
156145

157146
```json
158147
{
159-
"username": "johnsmith",
160148
"old_password": "an existing password"
161149
}
162150
```
@@ -169,11 +157,10 @@ Delete a password from an internal user's passwords list.
169157

170158
#### Request body
171159

172-
The request must contain a single JSON with the following fields:
160+
The request must contain a JSON object with the following fields:
173161

174162
| Field | Type | Description |
175163
|-------|------|-------------|
176-
| username | string | Affected user (required) |
177164
| old_password | string | Existing password to be deleted (required) |
178165

179166
### Response {#delete-response}
@@ -192,7 +179,5 @@ The following are possible `error_code` values:
192179

193180
| Code | Description |
194181
|------|-------------|
195-
| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | Success, new password was deleted from the list of valid passwords. |
196-
| [400 Bad Request](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1) | Bad or missing parameters. |
197-
| [401 Unauthorized](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2) | The user is unauthorized. |
198-
| [404 Not Found](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5) | Attempting to delete a password to a non-existing user. |
182+
| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | Success, new password was deleted from the list of valid passwords. |
183+
| [400 Bad Request](https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request) | Bad or missing parameters. |

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

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ weight: 70
1313

1414
Redis Enterprise Software lets you implement password rotation policies using the [REST API]({{< relref "/operate/rs/references/rest-api" >}}).
1515

16-
You can add a new password for a database user without immediately invalidating the old one (which might cause authentication errors in production).
16+
You can add a new password for a database user without immediately invalidating the old one to prevent possible authentication errors in production.
1717

1818
{{< note >}}
1919
Password rotation does not work for the default user. [Add additional users]({{< relref "/operate/rs/security/access-control/create-users" >}}) to enable password rotation.
@@ -27,7 +27,7 @@ you can set a [password expiration policy]({{< relref "/operate/rs/security/acce
2727
However, for database connections that rely on password authentication,
2828
you need to allow for authentication with the existing password while you roll out the new password to your systems.
2929

30-
With the Redis Enterprise Software REST API, you can add additional passwords to a user account for authentication to the database or the Cluster Manager UI and API.
30+
With the Redis Enterprise Software REST API, you can add additional passwords to your user account for authentication to the database or the Cluster Manager UI and API.
3131

3232
After the old password is replaced in the database connections, you can delete the old password to finish the password rotation process.
3333

@@ -41,13 +41,13 @@ The new password cannot already exist as a password for the user and must meet t
4141

4242
## Rotate password
4343

44-
To rotate the password of a user account:
44+
To rotate your password:
4545

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

4848
```sh
49-
POST https://[host][:port]/v1/users/password
50-
'{"username":"<username>", "old_password":"<an_existing_password>", "new_password":"<a_new_password>"}'
49+
POST https://<host>:<port>/v1/users/password
50+
{ "new_password": "<a_new_password>" }
5151
```
5252
5353
After you send this request, you can authenticate with both the old and the new password.
@@ -56,26 +56,22 @@ To rotate the password of a user account:
5656
1. Delete the original password with [`DELETE /v1/users/password`]({{< relref "/operate/rs/references/rest-api/requests/users/password#update-password" >}}):
5757
5858
```sh
59-
DELETE https://[host][:port]/v1/users/password
60-
'{"username":"<username>", "old_password":"<an_existing_password>"}'
59+
DELETE https://<host>:<port>/v1/users/password
60+
{ "old_password": "<an_existing_password>" }
6161
```
6262
6363
If there is only one valid password for a user account, you cannot delete that password.
6464
6565
## Replace all passwords
6666
67-
You can also replace all existing passwords for a user account with a single password that does not match any existing passwords.
67+
You can also replace all existing passwords for your user account with a single password that does not match any existing passwords.
6868
This can be helpful if you suspect that your passwords are compromised and you want to quickly resecure the account.
6969
70-
To replace all existing passwords for a user account with a single new password, use [`PUT /v1/users/password`]({{< relref "/operate/rs/references/rest-api/requests/users/password#delete-password" >}}):
70+
To replace your passwords, use [`PUT /v1/users/password`]({{< relref "/operate/rs/references/rest-api/requests/users/password#delete-password" >}}). You must provide the relevant username and current password for [basic authentication]({{<relref "/operate/rs/references/rest-api#authentication">}}) credentials when you send the request.
7171
7272
```sh
73-
PUT https://[host][:port]/v1/users/password
74-
'{"username":"<username>", "old_password":"<an_existing_password>", "new_password":"<a_new_password>"}'
73+
PUT https://<host>:<port>/v1/users/password
74+
{ "new_password": "<a_new_password>" }
7575
```
7676
77-
All of the existing passwords are deleted and only the new password is valid.
78-
79-
{{<note>}}
80-
If you send the above request without specifying it is a `PUT` request, the new password is added to the list of existing passwords.
81-
{{</note>}}
77+
After this request, all of your existing passwords are deleted and only the new password is valid.

0 commit comments

Comments
 (0)