Manage Password Blocklist

You can manage a password blocklist to prevent users from using common or weak passwords. The password blocklist is a list of passwords that users cannot use when setting or updating their passwords. The password blocklist is enforced when users set or update their passwords.

info

Refer to Password Requirements and Security to learn more about the password requirements and security in Palette.

The internal System API is used to manage the password blocklist. Review the following sections to learn how to maintain the password blocklist.

View Passwords in the Blocklist

The actual password values in the blocklist are not stored in the database. Due to this reason, there is no way to retrieve the plain text list of passwords in the blocklist. There is no GET endpoint to retrieve the list of passwords in the blocklist. All passwords are hashed and salted, and the cryptographic key of the password is stored in the internal system database.

tip

Store the list of passwords in the blocklist in a secure location that enforces access control so you can refer to it when needed.

Insert Passwords into the Blocklist

Use the following steps to insert new passwords into the password blocklist.

Prerequisites

Access to the Palette system console.
The role of root administrator or operations administrator.
curl or any other tool to make HTTP requests.
Access to a shell terminal.

warning

If you enabled passkeys for your system administrator account, the System API login endpoint will be disabled. Refer to the Passkeys and API Access page for guidance on how to use passkeys to access the System API.

Insert Passwords

Open a terminal session and log in to the Palette System API by using the /v1/auth/syslogin endpoint. Use the curl command below and replace the URL with the custom domain URL you assigned to Palette or use the IP address. Ensure you replace the credentials below with your system console credentials.
```
curl --location 'https://palette.example.com/v1/auth/syslogin' \
--header 'Content-Type: application/json' \
--data '{
  "password": "**********",
  "username": "**********"
}'
```
tip
If you are using the default self-signed certificate, you can use the --insecure flag to bypass the certificate check.

Output
```
{
  "Authorization": "**********.",
  "IsPasswordReset": true
}
```
Using the output you received, copy the authorization value to your clipboard and assign it to a shell variable. Replace the authorization value below with the value from the output.
```
TOKEN=**********
```
Use the curl command below to insert new passwords into the password blocklist. Replace the URL with the custom domain URL you assigned to Palette or use the IP address. Ensure you replace the TOKEN value with the value you assigned to the shell variable.
```
curl --location 'https://palette.example.com/v1/sys/passwords' \
--header "Authorization: $TOKEN" \
--header 'Content-Type: application/json' \
--data '{
  "spec": {
      "passwords": [
            "Password",
            "password",
            "123456",
            "qwerty",
      ]
  }
}'
```
info
The payload expects the spec.passwords field to be an array of strings. You can add as many passwords as you want as long as they are separated by a comma.
The endpoint returns a 204 status code if the operation is successful. No output is returned. If the operation fails, the endpoint returns an error message. In case of an error, verify the authorization token is valid and the password blocklist is in the expected format.

Validate

To validate the password blocklist, use the following steps.

Log in to the Palette system console. Refer to Access the System Console guide.
From the left Main Menu select My Account.
In the field Current Password type the current password of your admin user.
In the field New Password type one of the passwords you added to the password blocklist.
Type the new password again in the field Re-Enter New Password.
Click Change Password to save the changes.
An error message is displayed and the password is not updated. The error message indicates the password is in the blocklist.

Remove Passwords from the Blocklist

Use the following steps to remove passwords from the password blocklist.

Prerequisites

Access to the Palette system console.
The role of root administrator or operations administrator.
curl or any other tool to make HTTP requests.
Access to a shell terminal.

warning

Remove Passwords

Open a terminal session and log in to the Palette System API by using the /v1/auth/syslogin endpoint. Use the curl command below and replace the URL with the custom domain URL you assigned to Palette or use the IP address. Ensure you replace the credentials below with your system console credentials.
```
curl --location 'https://palette.example.com/v1/auth/syslogin' \
--header 'Content-Type: application/json' \
--data '{
  "password": "**********",
  "username": "**********"
}'
```
tip
If you are using the default self-signed certificate, you can use the --insecure flag to bypass the certificate check.

Output
```
{
  "Authorization": "**********.",
  "IsPasswordReset": true
}
```
Using the output you received, copy the authorization value to your clipboard and assign it to a shell variable. Replace the authorization value below with the value from the output.
```
TOKEN=**********
```
Use the curl command below to remove passwords from the password blocklist. Replace the URL with the custom domain URL you assigned to Palette or use the IP address. Ensure you replace the TOKEN value with the value you assigned to the shell variable.
```
curl --location --request DELETE 'https://palette.example.com/v1/sys/passwords' \
--header "Authorization: $TOKEN" \
--header 'Content-Type: application/json' \
--data '{
  "spec": {
      "passwords": [
            "Password",
            "password",
            "123456",
            "qwerty",
      ]
  }
}'
```
info
The payload expects the spec.passwordsfield to be an array of strings. You can remove as many passwords as you want as long as they are separated by a comma.
The endpoint returns a 204 status code if the operation is successful. No output is returned. If the operation fails, the endpoint returns an error message. In case of an error, verify the authorization token is valid and the password blocklist is in the expected format.

Validate

To validate the password blocklist, use the following steps.

Log in to the Palette system console. Refer to Access the System Console guide.
From the left Main Menu select My Account.
In the field Current Password type the current password of your admin user.
In the field New Password type one of the passwords you removed from the password blocklist.
Type the new password again in the field Re-Enter New Password.
Click Change Password to save the changes.
The password is updated successfully.

View Passwords in the Blocklist​

Insert Passwords into the Blocklist​

Prerequisites​

Insert Passwords​

Validate​

Remove Passwords from the Blocklist​

Prerequisites​

Remove Passwords​

Validate​

View Passwords in the Blocklist

Insert Passwords into the Blocklist

Prerequisites

Insert Passwords

Validate

Remove Passwords from the Blocklist

Prerequisites

Remove Passwords

Validate