Change password hashing algorithm requests

REST API requests to change the hashing algorithm for user passwords.

Redis Enterprise Software
Method Path Description
PATCH /v1/cluster/change_password_hashing_algorithm Change the hashing policy for user passwords

Change password hashing algorithm

PATCH /v1/cluster/change_password_hashing_algorithm

Changes the password hashing algorithm for the entire cluster. When you change the hashing algorithm, it rehashes the administrator password and passwords for all users, including default users.

The hashing algorithm options are SHA-256 or PBKDF2. The default hashing algorithm is SHA-256.

Required permissions

Permission name
update_cluster

Request

Example HTTP request

PATCH /v1/cluster/change_password_hashing_algorithm

Example JSON body

{ "algorithm": "PBKDF2" }

Request headers

Key Value Description
Host cnm.cluster.fqdn Domain name
Accept application/json Accepted media type

Request body

Include a JSON object { "algorithm": "<option>" } in the request body. The hashing algorithm options are SHA-256 or PBKDF2.

Response

Returns a status code that indicates the success or failure of the update.

Status codes

Code Description
200 OK Success
400 Bad Request Supported algorithm must be provided, or this algorithm is already set
RATE THIS PAGE
Back to top ↑