Work with Users
This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IUsers>() and is defined in Telligent.Evolution.Platform.dll
Events
Events.AfterAuthenticate
Handler
void UserAfterAuthenticateEventHandler(UserAfterAuthenticateEventArgs e);
Events.AfterCreate
Handler
void UserAfterCreateEventHandler(UserAfterCreateEventArgs e);
Events.AfterDelete
Handler
void UserAfterDeleteEventHandler(UserAfterDeleteEventArgs e);
Events.AfterIdentify
Handler
void UserAfterIdentifyEventHandler(UserAfterIdentifyEventArgs e);
Events.AfterLockout
Handler
void UserAfterLockoutEventHandler(UserAfterLockoutEventArgs e);
Events.AfterUpdate
Handler
void UserAfterUpdateEventHandler(UserAfterUpdateEventArgs e);
Events.BeforeCreate
Handler
void UserBeforeCreateEventHandler(UserBeforeCreateEventArgs e);
Events.BeforeDelete
Handler
void UserBeforeDeleteEventHandler(UserBeforeDeleteEventArgs e);
Events.BeforeUpdate
Handler
void UserBeforeUpdateEventHandler(UserBeforeUpdateEventArgs e);
Events.Merge
Handler
void UserMergeEventHandler(UserMergeEventArgs e);
Events.Reassign
Handler
void UserReassignEventHandler(UserReassignEventArgs e);
Events.Render
Handler
void UserRenderEventHandler(UserRenderEventArgs e);
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| AccessingUser | User | Get the user currently accessing the API | ||
| AnonymousUserName | string | Anonymous User Name | ||
| ApplicationTypeId | Guid | Users application type identifier | ||
| ContainerTypeId | Guid | Users container type identifier | ||
| ContentTypeId | Guid | Content type Id | ||
| FormerMemberName | string | |||
| ServiceUserName | string | Service User Name | ||
| ThemeTypeId | Guid | Users theme type identifier | ||
| TotalLicensed | int |
Methods
AdditionalInfo ChangePassword(int userId, string oldPassword, string newPassword);
Change a User's Password
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| userId | int | User Id | Required | ||
| oldPassword | string | User's old password | Required | ||
| newPassword | string | User's new password | Required |
Return Type
AdditionalInfo ChangePassword(string token, string newPassword);
Change a User's Password using a temporary verification token
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| token | string | Temporary verification token | Required | ||
| newPassword | string | User's new password | Required |
Return Type
User Create(string username, string password, string privateEmail, UsersCreateOptions options = null);
Create a User
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| username | string | User's name | Required | ||
| password | string | User's password | Required | ||
| privateEmail | string | User's private email | Required | ||
| options | UsersCreateOptions | User's attributes value for create operation | Optional |
Return Type
User CreateFromLdap(string username, string password);
Create a user from an LDAP user
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| username | string | User's name | Required | ||
| password | string | User's password | Required |
Return Type
AdditionalInfo Delete(UsersDeleteOptions options);
Delete a User
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | UsersDeleteOptions | User's attributes value for delete operation | Required |
Return Type
User Get(UsersGetOptions options);
Get a User
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | UsersGetOptions | User get options | Required |
Return Type
PagedList<User> List(UsersListOptions options = null);
List Users
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | UsersListOptions | User list get options | Optional |
Return Type
ApiList<User> Lookup(string queryText, UsersLookupOptions options);
List Users
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| queryText | string | Query Text | Required | ||
| options | UsersLookupOptions | Options | Required |
Return Type
AdditionalInfo RequestExport(int? userId = null);
Initializes a request to export user data. If no UserID is provided, the accessing user's data is requested. The accessing user will receive a conversation message or email when the export is complete and ready for downloading.
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| userId | int? | The identifier of the user to export. Defaults to the accessing user. | Optional |
Return Type
Task<T> RunAsUser<T>(string username, Func<Task<T>> action);
Perform some functionality as the specified user
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| username | string | User's name | Required | ||
| action | Func<Task<T>> | Action | Required |
Return Type
Task<T>
Task RunAsUser(Guid membershipId, Func<Task> action);
Perform some functionality as the specified user
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| membershipId | Guid | Membership Id | Required | ||
| action | Func<Task> | Action | Required |
Return Type
Task
Task RunAsUser(int userId, Func<Task> action);
Perform some functionality as the specified user
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| userId | int | User Id | Required | ||
| action | Func<Task> | Action | Required |
Return Type
Task
Task RunAsUser(string username, Func<Task> action);
Perform some functionality as the specified user
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| username | string | User's name | Required | ||
| action | Func<Task> | Action | Required |
Return Type
Task
T RunAsUser<T>(Guid membershipId, Func<T> action);
Perform some functionality as the specified user
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| membershipId | Guid | Membership Id | Required | ||
| action | Func<T> | Action | Required |
Return Type
T
void RunAsUser(string username, Action action);
Perform some functionality as the specified user
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| username | string | User's name | Required | ||
| action | Action | Action | Required |
T RunAsUser<T>(string username, Func<T> action);
Perform some functionality as the specified user
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| username | string | User's name | Required | ||
| action | Func<T> | Action | Required |
Return Type
T
void RunAsUser(Guid membershipId, Action action);
Perform some functionality as the specified user
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| membershipId | Guid | Membership Id | Required | ||
| action | Action | Action | Required |
void RunAsUser(int userId, Action action);
Perform some functionality as the specified user
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| userId | int | User Id | Required | ||
| action | Action | Action | Required |
Task<T> RunAsUser<T>(int userId, Func<Task<T>> action);
Perform some functionality as the specified user
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| userId | int | User Id | Required | ||
| action | Func<Task<T>> | Action | Required |
Return Type
Task<T>
T RunAsUser<T>(int userId, Func<T> action);
Perform some functionality as the specified user
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| userId | int | User Id | Required | ||
| action | Func<T> | Action | Required |
Return Type
T
Task<T> RunAsUser<T>(Guid membershipId, Func<Task<T>> action);
Perform some functionality as the specified user
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| membershipId | Guid | Membership Id | Required | ||
| action | Func<Task<T>> | Action | Required |
Return Type
Task<T>
User Update(UsersUpdateOptions options);
Update a User
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | UsersUpdateOptions | User's attributes value for update operation | Required |