Methods
ChangePassword
Changes a user password
Usage
#set($additionalInfoResponse = $core_v2_user.ChangePassword($id, $oldPassword, $newPassword))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Id | Required | | |
| oldPassword | string | Old Password | Required | | |
| newPassword | string | New Password | Required | | |
Return Type
AdditionalInfo
Create
Creates a new user
Usage
#set($userResponse = $core_v2_user.Create($username, $password, $privateEmail))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| username | string | Username | Required | | |
| password | string | Password | Required | | |
| privateEmail | string | Private Email | Required | | |
Return Type
User
Create
Creates a new user. Profile fields can be passed as options in the format _ProfileFields_FIELDNAME = 'FIELDVALUE'
Usage
#set($userResponse = $core_v2_user.Create($username, $password, $privateEmail, "%{AllowSitePartnersToContact = $allowSitePartnersToContactArg, AllowSiteToContact = $allowSiteToContactArg, Bio = $bioArg, Birthday = $birthdayArg, DisplayName = $displayNameArg, Gender = $genderArg, ImportFromLdap = $importFromLdapArg, Language = $languageArg, Location = $locationArg, PublicEmail = $publicEmailArg, RssFeeds = $rssFeedsArg, TimeZone = $timeZoneArg, WebUrl = $webUrlArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| username | string | Username | Required | | |
| password | string | Password | Required | | |
| privateEmail | string | Private Email | Required | | |
| AllowSitePartnersToContact | bool | Allow Site Partners To Contact | Optional | | |
| AllowSiteToContact | bool | Allow Site To Contact | Optional | | |
| Bio | string | Bio | Optional | | |
| Birthday | DateTime | Birthday | Optional | | |
| DisplayName | string | Display Name | Optional | | |
| Gender | string | Gender | Optional | | |
| ImportFromLdap | bool | Import From Ldap | Optional | | |
| Language | string | Language | Optional | | |
| Location | string | Location | Optional | | |
| PublicEmail | string | Public Email | Optional | | |
| RssFeeds | IList<string> | Rss Feeds | Optional | | |
| TimeZone | double | Time Zone | Optional | | |
| WebUrl | string | Web Url | Optional | | |
Return Type
User
CreateFromLdap
Creates a new user from LDAP
Usage
#set($userResponse = $core_v2_user.CreateFromLdap($username))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| username | string | Username | Required | | |
Return Type
User
CreateFromLdap
Creates a new user from LDAP
Usage
#set($userResponse = $core_v2_user.CreateFromLdap($username, $privateEmail))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| username | string | Username | Required | | |
| privateEmail | string | Private Email | Required | | |
Return Type
User
Delete
Deletes a user
Usage
#set($additionalInfoResponse = $core_v2_user.Delete("%{Id = $idArg, Username = $usernameArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| Id | int | Either Id or Username is required. | Optional | | |
| Username | string | Either Id or Username is required. | Optional | | |
Return Type
AdditionalInfo
Get
Gets a user
Usage
#set($userResponse = $core_v2_user.Get("%{Email = $emailArg, Id = $idArg, Username = $usernameArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| Email | string | Either Id, Email, or Username is required. | Optional | | |
| Id | int | Either Id, Email, or Username is required. | Optional | | |
| Username | string | Either Id, Email, or Username is required. | Optional | | |
Return Type
User
IsRegistered
Determines whether a user is registered
Usage
#set($booleanResponse = $core_v2_user.IsRegistered($id))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Id | Required | | |
Return Type
bool
List
Lists users
Usage
#set($pagedListResponse = $core_v2_user.List())
Return Type
PagedList<User>
List
Lists users
Usage
#set($pagedListResponse = $core_v2_user.List("%{EmailAddress = $emailAddressArg, IncludeHidden = $includeHiddenArg, JoinDate = $joinDateArg, LastUpdatedUtcDate = $lastUpdatedUtcDateArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, RoleId = $roleIdArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, Usernames = $usernamesArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| EmailAddress | string | Used to limit to a specific user based on email address. | Optional | | |
| IncludeHidden | bool | By default 'hidden' users (like service accounts) will not be returned. Set IncludeHidden=true to return all users. | Optional | | |
| JoinDate | DateTime | Used to limit to just users who have joined since the specified date. | Optional | | |
| LastUpdatedUtcDate | DateTime | Last Updated Utc Date | Optional | | |
| PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
| PageSize | int | Specify the number of results to return per page. | Optional | 20 | |
| RoleId | int | Role Id | Optional | | |
| SortBy | string | Sort By | Optional | | Email, JoinedDate, LastActiveDate, Posts, RecentPosts, Score:SCORE_ID, Username, Website |
| SortOrder | string | Sort Order | Optional | | Ascending, Descending |
| Usernames | string | Used to limit to a specific set of users. | Optional | | |
Return Type
PagedList<User>
Update
Updates a user. Profile fields can be passed as options in the format _ProfileFields_FIELDNAME = 'FIELDVALUE'
Usage
#set($userResponse = $core_v2_user.Update("%{AccountStatus = $accountStatusArg, AllowSitePartnersToContact = $allowSitePartnersToContactArg, AllowSiteToContact = $allowSiteToContactArg, Bio = $bioArg, Birthday = $birthdayArg, DisplayName = $displayNameArg, EnabledActivityMessageTypes = $enabledActivityMessageTypesArg, EnableUserSignatures = $enableUserSignaturesArg, Gender = $genderArg, Id = $idArg, Language = $languageArg, Location = $locationArg, ModerationLevel = $moderationLevelArg, NewPassword = $newPasswordArg, OldPassword = $oldPasswordArg, PrivateEmail = $privateEmailArg, PublicEmail = $publicEmailArg, RssFeeds = $rssFeedsArg, TimeZone = $timeZoneArg, Username = $usernameArg, WebUrl = $webUrlArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| AccountStatus | string | Account Status | Optional | | |
| AllowSitePartnersToContact | bool | Allow Site Partners To Contact | Optional | | |
| AllowSiteToContact | bool | Allow Site To Contact | Optional | | |
| Bio | string | Bio | Optional | | |
| Birthday | DateTime | Birthday | Optional | | |
| DisplayName | string | Display Name | Optional | | |
| EnabledActivityMessageTypes | string | Enabled Activity Message Types | Optional | | |
| EnableUserSignatures | bool | Enable User Signatures | Optional | | |
| Gender | string | Gender | Optional | | |
| Id | int | Either Id or Username is required. | Optional | | |
| Language | string | Language | Optional | | |
| Location | string | Location | Optional | | |
| ModerationLevel | string | Moderation Level | Optional | | |
| NewPassword | string | New Password | Optional | | |
| OldPassword | string | Required if changing the password. | Optional | | |
| PrivateEmail | string | Private Email | Optional | | |
| PublicEmail | string | Public Email | Optional | | |
| RssFeeds | IList<string> | Rss Feeds | Optional | | |
| TimeZone | double | Time Zone | Optional | | |
| Username | string | Either Id or Username is required. | Optional | | |
| WebUrl | string | Web Url | Optional | | |
Return Type
User