The user class represents a user in Contensis.
Members
| Name | Type | Description |
|---|---|---|
| AvatarUrl | String | The URL of the user's avatar. |
| Created | DateTime | The user creation datetime. |
| Credentials.Provider.Type | enum | The type of credential provider for the user, 'Sys', 'Contensis', 'External'. |
| Credentials.Provider.Name | string | The name of credential provider. |
| Custom | Dictionary<string,string></string,string> | The user's custom properties, |
| String | The email address. | |
| FirstName | String | The user's firstname. |
| Id | Guid | The user's unique identifier. |
| LastLogin | DateTime? | The user's last login datetime. |
| LastName | String | The user's lastname. |
| Modified | DateTime? | The last modification datetime. |
| OptOutOfNotifications | Boolean | Shows if the user has opted out of receiving all notifications generated by Contensis. |
| PasswordChanged | DateTime? | The last password change datetime. |
| Status | UserStatus | The user's status properties. |
| Timezone | String | The user's timezone. |
| Username | String | The user's username. |
Methods
| Method | Returns | Description |
|---|---|---|
| Delete | void | Deletes the user. |
| DeleteAsync | void | Deletes the user asynchronously. |
| Groups | PagedList<Group> | Lists group memberships. |
| GroupsAsync | PagedList<Group> | Lists group memberships asynchronously. |
| IsMemberOf | bool | Checks if the user is a member of the specified group(s). |
| IsMemberOfAsync | bool | Checks if the user is a member of the specified group(s) asynchronously. |
| Save | void | Updates the changes to the user, or creates a new user. |
| SaveAsync | void | Saves the changes to the user, or creates a new user asynchronously. |
| UpdatePassword | void | Updates the user's password. |
| UpdatePasswordAsync | void | Updates the user's password asynchronously. |
| Suspend | void | Sets the user's status to suspended so they cannot log in. |
| SuspendAsync | void | Sets the user's status to suspended, asynchronously, so they cannot log in. |
| Unsuspend | void | Sets the user's status to active so they can log in. |
| UnsuspendAsync | void | Sets the user's status to active, asynchronously, so they can log in. |
| Unlock | void | Unlocks a locked user so they can log in. |
| UnlockAsync | void | Unlocks a locked user, asynchronously, so they can log in. |