User object
An API object that represents a Redis Enterprise user
| Name | Type/Value | Description |
|---|---|---|
| uid | integer | User's unique ID |
| account_id | integer | SM account ID |
| action_uid | string | Action UID. If it exists, progress can be tracked by the GET /actions/{uid} API request (read-only) |
| auth_method | 'regular' 'certificate' 'entraid' |
User's authentication method |
| bdbs_email_alerts | complex object | UIDs of databases that user will receive alerts for |
| cluster_email_alerts | boolean | Activate cluster email alerts for a user |
| string | User's email (pattern matching only ASCII characters) | |
| email_alerts | boolean (default: true) | Activate email alerts for a user |
| name | string | User's name (pattern does not allow non-ASCII and special characters &,<,>,") |
| 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. |
| password_hash_method | '1' | Used when password is passed pre-hashed to specify the hashing method |
| password_issue_date | string | The date in which the password was set (read-only) |
| role | 'admin' 'cluster_member' 'cluster_viewer' 'db_member' 'db_viewer' 'user_manager' 'none' |
User's role |
| role_uids | array of integers | UIDs of user's roles for role-based access control |
| status | 'active' 'locked' 'password_expired' |
User sign-in status (read-only) active: able to sign in locked: unable to sign in password_expired: unable to sign in because the password expired |