| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
The unique identifier for the user. |
globally unique identifier |
None. |
| AgreementDate |
The date the user accepted the privacy policy and data processing agreement. This field is read-only. |
date |
None. |
| AccountID |
The unique identifier for the account. |
globally unique identifier |
None. |
| AdminUser |
Determines if the user is an admin user. |
boolean |
None. |
| DateCreated |
The date the user account was created. |
date |
None. |
| DateModified |
The date the user account was last modified. |
date |
None. |
| DeclineDate |
The date the user declined the privacy policy and data processing agreement. This field is read-only. |
date |
None. |
| DisplayName |
The name of the user. |
string |
Required |
| DPAVersion |
The version of the data processing agreement that the user has accepted. This field is only read-only. |
string |
None. |
| EmailAddress |
The email address of the user. |
string |
Required Data type: EmailAddress |
| Enabled |
Determines the status of the user. |
boolean |
Required |
| LanguageID |
The Id of the language of the user. |
globally unique identifier |
Required |
| MobilePhone |
The mobile phone of the user |
string |
Required Matching regular expression pattern: ^(?=.*?\d.*?\d.*?\d.*?\d.*?\d)([+]?)([\d\s\(\)-]{5,20})$ |
| Password |
The password of the user. |
string |
None. |
| Pin |
Sets the security pin when two factor has been enable. Set it to null if you want it to randonly generate each login. |
string |
None. |
| Preferences | Preferences |
None. |
|
| PrivacyPolicyVersion |
The version of the privacy policy that the user has accepted. This field is only read-only. |
string |
None. |
| SSOEnabled |
Determines if the user is part of a SSO setup. |
boolean |
None. |
| TimeZone |
The timezone of the user. |
string |
Required |
| Username |
The username of the user to log into the system. |
string |
Required |