The User Object represents an individual user account within your application. It stores all the information necessary to enable you to create and authenticate users in a structured and secure manner.
| Friendly Field Name | Data Field Name | General Data Type | Description | Optimised for Filtering |
|---|---|---|---|---|
| Unique Identifier | uuid | UUID | Universally unique identifier (UUID) for the object. | Yes |
| Application Identifier | app_uuid | UUID | Identifier for the application associated with the user. | Yes |
| Application Context Reference | app_context_ref | Text (max length 50) | You can use this field to provide searchable context to your object – for example this may be an external identifier, or a lookup UUID to another object in your application. | Yes |
| Sub Identifier | sub_uuid | UUID | This field can be used to store a UUID to another Object. | Yes |
| Linked Identity Account UUID | linked_identity_acct_uuid | UUID | Identifier for the Account to which the data value applies – linked to an identity.acct Object. The Account Object must already exist, otherwise an error will occur when creating this Object.Optional | Yes |
| User Context | user_context | Enumerated List | User context level. Allowable values are:default, user, super-user, admin, super-adminDefault: 'default' | Yes |
| Username | username | Text (max length 100) | Username for the user account. | Yes |
| User Level Key | user_level_key | Text (max length 20) | Key representing the user’s access level. | No |
email | Text (max length 100) | Email address associated with the user. | Yes | |
| First Name | first_name | Text (max length 50) | First name of the user. | Yes |
| Last Name | last_name | Text (max length 50) | Last name of the user. | Yes |
| Mobile Number | mobile_num | Text (max length 20) | Mobile phone number of the user. | No |
| One-Time Password (OTP) | otp | Text (max length 100) | Temporary OTP for user authentication. | No |
| Temporary Password | password_tmp | Text (max length 100) | Temporary password for the user account. Always store this as a hashed or encrypted value. | No |
| Password Hash | password_hash | Text (max length 100) | Hash of the user’s password. Never store this in plain text form. | No |
| Password Salt | password_salt | Text (max length 40) | Salt used in password hashing. | No |
| Password Version | password_version | Number | Version number of the password scheme. | No |
| Authentication Method | auth_method | Enumerated List | Method of authentication. Allowable values are:custom, jwt, magic-link, password, otpOptional | Yes |
| Authentication Key Hash | auth_key_hash | Text (max length 100) | Hash of the authentication key. | Yes |
| Authentication Key Salt | auth_key_salt | Text (max length 40) | Salt used for the authentication key. | No |
| Authentication Token | auth_token | Text (max length 255) | Authentication token for the user session. | Yes |
| Authentication Token Expiry | auth_token_expiry | DateTime | Expiry date and time for the authentication token. | No |
| Two-Factor Authentication | has_2fa | Boolean | Indicates if two-factor authentication is enabled. | No |
| User Status | user_status | Enumerated List | Status of the user account. Allowable values are:active, archived, awaiting_otp, blocked, closed, inactive, pending, suspended, otherDefault: 'active'Required | Yes |
| Is Enabled | is_enabled | Boolean | Indicates if the user account is enabled. | No |
| Terms Accepted | terms_accepted | Boolean | Indicates if the user has accepted the terms and conditions. | No |
| GDPR Accepted | gdpr_accepted | Boolean | Indicates if the user has accepted GDPR policies. | No |
| Valid From | valid_from | DateTime | Start date and time for user account validity. | No |
| Valid To | valid_to | DateTime | End date and time for user account validity. | No |
| Additional Data 1 | data_1 | Text (max length 50) | Custom data field 1 for additional information. | No |
| Additional Data 2 | data_2 | Text (max length 50) | Custom data field 2 for additional information. | No |
| Additional Data 3 | data_3 | Text (max length 50) | Custom data field 3 for additional information. | No |
| Taxonomy | taxonomy | Text (max length 100) | Categorisation for the user record. | Yes |
| Created At | created_at | DateTime | Date and time when the object was created. | No |
| Updated At | updated_at | DateTime | Date and time when the object was last updated. | No |
| Created By | created_by | Text (max length 50) | You can use this field to record who or what created the Object record. | No |
| Updated By | updated_by | Text (max length 50) | You can use this field to record who or what last updated the Object record. | No |