Sign in

v25

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015053126.2 KB
Users

Update a Redis Software user

Update a user configuration by unique ID

put/v1/users/{uid}

Path parameters

uidinteger required

The user unique ID

Query parameters

dry_runboolean

Validate the request without persisting changes

Request body

account_idinteger

SM account ID

auth_method'regular' | 'certificate' | 'entraid' | 'sso'
bdbs_email_alertsstring[]

UIDs of databases that user will receive alerts for.

certificate_subject_linestring

The certificate's subject line as defined by RFC2253 (for certificate based authentication users only)

cluster_email_alertsboolean

Activate cluster email alerts for a user.

emailstring

User's email.

email_alertsboolean

Activate email alerts for a user.

namestring

User's name. (pattern does not allow non ascii and special characters &,<,>,")

passwordstring

User's password for regular authentication. Required for regular auth method.

password_hash_method1

Used when password is passed pre-hashed

role'none' | 'db_viewer' | 'cluster_viewer' | 'db_member' | 'cluster_member' | 'user_manager' | 'admin'

Name of the management role.

role_uidsinteger[]

List of role uids associated with the user

uidinteger

User's unique uid.

Response

User updated successfully

account_idinteger

SM account ID

action_uidstring

Action uid. If exists - progress can be tracked by the GET /actions/<uid> API

auth_method'regular' | 'certificate' | 'entraid' | 'sso' required
bdbs_email_alertsstring[]

UIDs of databases that user will receive alerts for.

certificate_subject_linestring

The certificate's subject line as defined by RFC2253 (for certificate based authentication users only)

cluster_email_alertsboolean

Activate cluster email alerts for a user.

emailstring

User's email. (pattern matching only ascii characters)

email_alertsboolean

Activate email alerts for a user.

last_logininteger

Timestamp of the user's last login time. This denotes the last time an authentication with the user's credentials was successful.

namestring required

User's name. (pattern does not allow non ascii and special characters &,<,>,")

passwordstring

User's password. Note that it could also be an already-hashed value, in which case 'password_hash_method' parameter is also provided.

password_issue_datestring date-time

The date in which the password was set.

role'none' | 'db_viewer' | 'cluster_viewer' | 'db_member' | 'cluster_member' | 'user_manager' | 'admin' required

Name of the management role.

role_uidsinteger[] required

List of role uids associated with the user

status'active' | 'locked' | 'password_expired'

Status of the user.

uidinteger required

User's unique uid.

Example response

{
  "auth_method": "regular",
  "email": "user@redis.com",
  "email_alerts": true,
  "last_login": 1760618047,
  "name": "John Doe",
  "password_issue_date": "2025-03-02T09:43:34Z",
  "role_uids": [
    1
  ],
  "status": "active"
}