diff --git a/content/operate/rs/references/rest-api/objects/cluster/_index.md b/content/operate/rs/references/rest-api/objects/cluster/_index.md index c54b49279b..71aa443db9 100644 --- a/content/operate/rs/references/rest-api/objects/cluster/_index.md +++ b/content/operate/rs/references/rest-api/objects/cluster/_index.md @@ -50,6 +50,7 @@ An API object that represents the cluster. | name | string | Cluster's fully qualified domain name (read-only) | | password_complexity | boolean (default: false) | Enforce password complexity policy | | password_expiration_duration | integer (default: 0) | The number of days a password is valid until the user is required to replace it | +| password_min_length | integer, (range: 8-256) (default: 8) | The minimum length required for a password. | | proxy_certificate | string | Cluster's proxy certificate | | proxy_max_ccs_disconnection_time | integer | Cluster-wide proxy timeout policy between proxy and CCS | | rack_aware | boolean | Cluster operates in a rack-aware mode (read-only) | diff --git a/content/operate/rs/security/access-control/manage-passwords/password-complexity-rules.md b/content/operate/rs/security/access-control/manage-passwords/password-complexity-rules.md index 1859817040..1fa73c1467 100644 --- a/content/operate/rs/security/access-control/manage-passwords/password-complexity-rules.md +++ b/content/operate/rs/security/access-control/manage-passwords/password-complexity-rules.md @@ -1,11 +1,11 @@ --- -Title: Enable password complexity rules +Title: Configure password complexity rules alwaysopen: false categories: - docs - operate - rs -description: Enable password complexity rules. +description: Enable password complexity rules and configure minimum password length. linkTitle: Password complexity rules toc: 'true' weight: 30 @@ -28,32 +28,59 @@ In addition, the password: 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. -You can use the Cluster Manager UI or the REST API to enable password complexity rules. +## Enable password complexity rules -## Enable using the Cluster Manager UI +To enable password complexity rules, use one of the following methods: -To enable password complexity rules using the Cluster Manager UI: +- Cluster Manager UI: -1. Go to **Cluster > Security > Preferences**, then select **Edit**. + 1. Go to **Cluster > Security > Preferences**, then select **Edit**. + + 1. In the **Password** section, enable **Complexity rules**. + + 1. Select **Save**. + +- [Update cluster]({{}}) REST API request: + + ```sh + PUT https://[host][:port]/v1/cluster + { "password_complexity": true } + ``` + +## Change minimum password length -1. In the **Password** section, turn on **Complexity rules**. +When password complexity rules are enabled, passwords must have at least 8 characters by default. -1. Select **Save**. +If you change the minimum password length, the new minimum is enforced for new users and when existing users change their passwords. -## Enable using the REST API +To change the minimum password length, use one of the following methods: -To use the REST API to enable password complexity rules: +- Cluster Manager UI: -``` REST -PUT https://[host][:port]/v1/cluster -{"password_complexity":true} -``` + 1. Go to **Cluster > Security > Preferences**. + + 1. Click **Edit**. + + 1. In the **Password** section, enable **Complexity rules**. + + 1. Set the number of characters for **Minimum password length**. + + {{The minimum password length setting appears in the password section of the cluster security preferences screen when complexity rules are enabled.}} + + 1. Click **Save**. + +- [Update cluster]({{}}) REST API request: + + ```sh + PUT https://[host][:port]/v1/cluster + { "password_min_length": } + ``` ## Deactivate password complexity rules -To deactivate password complexity rules: +To deactivate password complexity rules, use one of the following methods: -- Use the Cluster Manager UI: +- Cluster Manager UI: 1. Go to **Cluster > Security > Preferences**, then select **Edit**. @@ -61,4 +88,9 @@ To deactivate password complexity rules: 1. Select **Save**. -- Use the `cluster` REST API endpoint to set `password_complexity` to `false` +- [Update cluster]({{}}) REST API request: + + ```sh + PUT https://[host][:port]/v1/cluster + { "password_complexity": false } + ``` diff --git a/static/images/rs/screenshots/cluster/security-preferences-min-password-length.png b/static/images/rs/screenshots/cluster/security-preferences-min-password-length.png new file mode 100644 index 0000000000..f89569de5f Binary files /dev/null and b/static/images/rs/screenshots/cluster/security-preferences-min-password-length.png differ