Skip to content

Commit 8fc474d

Browse files
authored
RS: Configure minimum password length (#690)
* DOC-4279 RS: Add password_min_length to cluster REST API object reference * DOC-4279 RS: Document how to change minimum password length * Fix spacing in REST API example * Add alt text for screenshot
1 parent c51f0a0 commit 8fc474d

File tree

3 files changed

+50
-17
lines changed

3 files changed

+50
-17
lines changed

content/operate/rs/references/rest-api/objects/cluster/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ An API object that represents the cluster.
5050
| name | string | Cluster's fully qualified domain name (read-only) |
5151
| password_complexity | boolean (default: false) | Enforce password complexity policy |
5252
| password_expiration_duration | integer (default: 0) | The number of days a password is valid until the user is required to replace it |
53+
| password_min_length | integer, (range: 8-256) (default: 8) | The minimum length required for a password. |
5354
| proxy_certificate | string | Cluster's proxy certificate |
5455
| proxy_max_ccs_disconnection_time | integer | Cluster-wide proxy timeout policy between proxy and CCS |
5556
| rack_aware | boolean | Cluster operates in a rack-aware mode (read-only) |
Lines changed: 49 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
Title: Enable password complexity rules
2+
Title: Configure password complexity rules
33
alwaysopen: false
44
categories:
55
- docs
66
- operate
77
- rs
8-
description: Enable password complexity rules.
8+
description: Enable password complexity rules and configure minimum password length.
99
linkTitle: Password complexity rules
1010
toc: 'true'
1111
weight: 30
@@ -28,37 +28,69 @@ In addition, the password:
2828

2929
Password complexity rules apply when a new user account is created and when the password is changed. Password complexity rules are not applied to accounts authenticated by an external identity provider.
3030

31-
You can use the Cluster Manager UI or the REST API to enable password complexity rules.
31+
## Enable password complexity rules
3232

33-
## Enable using the Cluster Manager UI
33+
To enable password complexity rules, use one of the following methods:
3434

35-
To enable password complexity rules using the Cluster Manager UI:
35+
- Cluster Manager UI:
3636

37-
1. Go to **Cluster > Security > Preferences**, then select **Edit**.
37+
1. Go to **Cluster > Security > Preferences**, then select **Edit**.
38+
39+
1. In the **Password** section, enable **Complexity rules**.
40+
41+
1. Select **Save**.
42+
43+
- [Update cluster]({{<relref "/operate/rs/references/rest-api/requests/cluster#put-cluster">}}) REST API request:
44+
45+
```sh
46+
PUT https://[host][:port]/v1/cluster
47+
{ "password_complexity": true }
48+
```
49+
50+
## Change minimum password length
3851
39-
1. In the **Password** section, turn on **Complexity rules**.
52+
When password complexity rules are enabled, passwords must have at least 8 characters by default.
4053
41-
1. Select **Save**.
54+
If you change the minimum password length, the new minimum is enforced for new users and when existing users change their passwords.
4255
43-
## Enable using the REST API
56+
To change the minimum password length, use one of the following methods:
4457
45-
To use the REST API to enable password complexity rules:
58+
- Cluster Manager UI:
4659
47-
``` REST
48-
PUT https://[host][:port]/v1/cluster
49-
{"password_complexity":true}
50-
```
60+
1. Go to **Cluster > Security > Preferences**.
61+
62+
1. Click **Edit**.
63+
64+
1. In the **Password** section, enable **Complexity rules**.
65+
66+
1. Set the number of characters for **Minimum password length**.
67+
68+
{{<image filename="images/rs/screenshots/cluster/security-preferences-min-password-length.png" alt="The minimum password length setting appears in the password section of the cluster security preferences screen when complexity rules are enabled." >}}
69+
70+
1. Click **Save**.
71+
72+
- [Update cluster]({{<relref "/operate/rs/references/rest-api/requests/cluster#put-cluster">}}) REST API request:
73+
74+
```sh
75+
PUT https://[host][:port]/v1/cluster
76+
{ "password_min_length": <integer between 8-256> }
77+
```
5178
5279
## Deactivate password complexity rules
5380
54-
To deactivate password complexity rules:
81+
To deactivate password complexity rules, use one of the following methods:
5582
56-
- Use the Cluster Manager UI:
83+
- Cluster Manager UI:
5784
5885
1. Go to **Cluster > Security > Preferences**, then select **Edit**.
5986
6087
1. In the **Password** section, turn off **Complexity rules**.
6188
6289
1. Select **Save**.
6390
64-
- Use the `cluster` REST API endpoint to set `password_complexity` to `false`
91+
- [Update cluster]({{<relref "/operate/rs/references/rest-api/requests/cluster#put-cluster">}}) REST API request:
92+
93+
```sh
94+
PUT https://[host][:port]/v1/cluster
95+
{ "password_complexity": false }
96+
```
43.2 KB
Loading

0 commit comments

Comments
 (0)