Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -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) |
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -28,37 +28,69 @@ 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]({{<relref "/operate/rs/references/rest-api/requests/cluster#put-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**.

{{<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." >}}

1. Click **Save**.

- [Update cluster]({{<relref "/operate/rs/references/rest-api/requests/cluster#put-cluster">}}) REST API request:

```sh
PUT https://[host][:port]/v1/cluster
{ "password_min_length": <integer between 8-256> }
```

## 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**.

1. In the **Password** section, turn off **Complexity rules**.

1. Select **Save**.

- Use the `cluster` REST API endpoint to set `password_complexity` to `false`
- [Update cluster]({{<relref "/operate/rs/references/rest-api/requests/cluster#put-cluster">}}) REST API request:

```sh
PUT https://[host][:port]/v1/cluster
{ "password_complexity": false }
```
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading