The User type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
| ChangePassword | Change the password for this user | |
| CheckPasswordComplexity | Check the password to see if it meets the complexity requirements. | |
| Equals | (Inherited from Object.) | |
| Finalize | (Inherited from Object.) | |
| GetHashCode | (Inherited from Object.) | |
| GetPasswordComplexityDescription | Returns an xml document describing the password complexity requirements for this user's firm | |
| GetType | (Inherited from Object.) | |
| IsInRole |
Method to determine whether the user is in the specified role or not.
| |
| MemberwiseClone | (Inherited from Object.) | |
| SaveUserSettings |
Save the current xml document user settings.
| |
| ToString | (Inherited from Object.) |
Properties
| Name | Description | |
|---|---|---|
| Accounts | The list of accounts that this user can see | |
| LoginResult | The result of the login attempt | |
| Master | Whether this is the main api user or not | |
| PwdComplexity | Whether password complexity is required | |
| PwdExpireDays | How frequently passwords must be changed | |
| PwdExpiresAt |
When the users current password expires and must be changed by.
| |
| PwdHistoryDays | How long until a password can be reused | |
| Roles | Method that returns the list of roles that this user can perform. | |
| ServerName | The name of the server we logged into | |
| UserID | ID of the user | |
| Username | Username | |
| UserSettings |
XML document containing any settings for this user and application.
|
Events
| Name | Description | |
|---|---|---|
| LoginFailure |
Event raised when login fails.
| |
| LoginSuccess |
Event raised when login succeeds.
| |
| PasswordChangeResponse |
Event raised following an attempt to change the user's password by this api instance.
|