Users In-Process API Service

Ben Tiedt — Tue, 19 Nov 2019 20:04:02 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:04:02

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 In-Process API Event Argument|UserAfterAuthenticateEventArgs]] e);

Events.AfterCreate

Handler

void UserAfterCreateEventHandler([[UserAfterCreateEventArgs In-Process API Event Argument|UserAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void UserAfterDeleteEventHandler([[UserAfterDeleteEventArgs In-Process API Event Argument|UserAfterDeleteEventArgs]] e);

Events.AfterIdentify

Handler

void UserAfterIdentifyEventHandler([[UserAfterIdentifyEventArgs In-Process API Event Argument|UserAfterIdentifyEventArgs]] e);

Events.AfterLockout

Handler

void UserAfterLockoutEventHandler([[UserAfterLockoutEventArgs In-Process API Event Argument|UserAfterLockoutEventArgs]] e);

Events.AfterUpdate

Handler

void UserAfterUpdateEventHandler([[UserAfterUpdateEventArgs In-Process API Event Argument|UserAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void UserBeforeCreateEventHandler([[UserBeforeCreateEventArgs In-Process API Event Argument|UserBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void UserBeforeDeleteEventHandler([[UserBeforeDeleteEventArgs In-Process API Event Argument|UserBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void UserBeforeUpdateEventHandler([[UserBeforeUpdateEventArgs In-Process API Event Argument|UserBeforeUpdateEventArgs]] e);

Events.Render

Handler

void UserRenderEventHandler([[UserRenderEventArgs In-Process API Event Argument|UserRenderEventArgs]] e);

Properties

Name	Type	Description
AccessingUser	`[[User In-Process API Supplementary Type\|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
userId	`int`	User Id	Required
oldPassword	`string`	User's old password	Required
newPassword	`string`	User's new password	Required

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

User Create(string username, string password, string privateEmail, UsersCreateOptions options = null);

Create a User

Parameters

Name	Type	Description	Required
username	`string`	User's name	Required
password	`string`	User's password	Required
privateEmail	`string`	User's private email	Required
options	`[[UsersCreateOptions In-Process API Supplementary Type\|UsersCreateOptions]]`	User's attributes value for create operation	Optional

Return Type

[[User In-Process API Supplementary Type|User]]

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

[[User In-Process API Supplementary Type|User]]

AdditionalInfo Delete(UsersDeleteOptions options);

Delete a User

Parameters

Name	Type	Description	Required	Default	Options
options	`[[UsersDeleteOptions In-Process API Supplementary Type\|UsersDeleteOptions]]`	User's attributes value for delete operation	Required

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

User Get(UsersGetOptions options);

Get a User

Parameters

Name	Type	Description	Required	Default	Options
options	`[[UsersGetOptions In-Process API Supplementary Type\|UsersGetOptions]]`	User get options	Required

Return Type

[[User In-Process API Supplementary Type|User]]

PagedList<User> List(UsersListOptions options = null);

List Users

Parameters

Name	Type	Description	Required	Default	Options
options	`[[UsersListOptions In-Process API Supplementary Type\|UsersListOptions]]`	User list get options	Optional

Return Type

[[PagedList(T) In-Process API Supplementary Type|PagedList]]<[[User In-Process API Supplementary Type|User]]>

ApiList<User> Lookup(string queryText, UsersLookupOptions options);

List Users

Parameters

Name	Type	Description	Required	Default	Options
queryText	`string`	Query Text	Required
options	`[[UsersLookupOptions In-Process API Supplementary Type\|UsersLookupOptions]]`	Options	Required

Return Type

[[ApiList(T) In-Process API Supplementary Type|ApiList]]<[[User In-Process API Supplementary Type|User]]>

AdditionalInfo RequestExport(int? userId = null);

Initializes a request to export user data. If no UserID is provided, the accesing 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

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

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

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

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

User Update(UsersUpdateOptions options);

Update a User

Parameters

Name	Type	Description	Required	Default	Options
options	`[[UsersUpdateOptions In-Process API Supplementary Type\|UsersUpdateOptions]]`	User's attributes value for update operation	Required

Return Type

[[User In-Process API Supplementary Type|User]]