{
  "id": "user",
  "title": "User object",
  "url": "https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/objects/user/",
  "summary": "An API object that represents a Redis Enterprise user",
  "content": "\n| Name | Type/Value | Description |\n|------|------------|-------------|\n| uid | integer | User's unique ID |\n| account_id | integer | SM account ID |\n| action_uid | string | Action UID. If it exists, progress can be tracked by the `GET`\u0026nbsp;`/actions/{uid}` API request (read-only) |\n| auth_method | **'regular'**\u003cbr /\u003e'certificate'\u003cbr /\u003e'entraid' | User's authentication method |\n| bdbs_email_alerts | complex object | UIDs of databases that user will receive alerts for |\n| certificate_subject_line | string | The certificate’s subject line as defined by RFC2253. Used for certificate-based authentication users only. |\n| cluster_email_alerts | boolean | Activate cluster email alerts for a user |\n| email | string | User's email (pattern matching only ASCII characters) |\n| email_alerts | boolean (default:\u0026nbsp;true) | Activate email alerts for a user |\n| name | string | User's name (pattern does not allow non-ASCII and special characters \u0026,\\\u003c,\u003e,\") |\n| password | string | User's password. If `password_hash_method` is set to `1`, the password should be hashed using SHA-256. The format before hashing is `username:clustername:password`. | \n| password_hash_method | '1' | Used when password is passed pre-hashed to specify the hashing method |\n| password_issue_date | string | The date in which the password was set (read-only) |\n| role | 'admin'\u003cbr /\u003e'cluster_member'\u003cbr /\u003e'cluster_viewer'\u003cbr /\u003e'db_member'\u003cbr /\u003e **'db_viewer'** \u003cbr /\u003e'user_manager'\u003cbr /\u003e'none' | User's [role]() |\n| role_uids | array of integers | UIDs of user's roles for role-based access control |\n| status | 'active'\u003cbr /\u003e'locked'\u003cbr /\u003e'password_expired' | User sign-in status (read-only)\u003cbr /\u003e**active**: able to sign in\u003cbr /\u003e**locked**: unable to sign in\u003cbr /\u003e**password_expired**: unable to sign in because the password expired |\n",
  "tags": ["docs","operate","rs"],
  "last_updated": "2026-04-01T08:10:08-05:00"
}