core_v2_user Script API

Verint | Telligent Community — Wed, 14 May 2025 17:08:30 GMT

Current Revision posted to API Documentation by Verint | Telligent Community on 05/14/2025 17:08:30

Enables scripted content fragments to use Users

Properties

Name	Access	Type	Description
Accessing	Read	`[[User Script API Type\|User]]`	Accessing user
AnonymousUserName	Read	`[[String Script API Type\|String]]`	The username of the anonymous system account.
ApplicationTypeId	Read	`[[Guid Script API Type\|Guid]]`	Users application type identifier
ContainerTypeId	Read	`[[Guid Script API Type\|Guid]]`	Users container type identifier
ContentTypeId	Read	`[[Guid Script API Type\|Guid]]`	Users content type identifier
Current	Read	`[[User Script API Type\|User]]`	Contextual user
FormerMemberName	Read	`[[String Script API Type\|String]]`	The username of the Former Member system account.
ServiceUserName	Read	`[[String Script API Type\|String]]`	The username of the service system account.
ThemeTypeId	Read	`[[Guid Script API Type\|Guid]]`	Users theme type identifier
TotalLicensed	Read	`[[Number Script API Type\|Number]]`	Total number licensed users
UserContentViewTypeId	Read	`[[Guid Script API Type\|Guid]]`	Obsolete. Obsolete in 12.1: Use the default view type '00000000-0000-0000-0000-000000000000' instead. Obsolete in 12.1: Use the default view type '00000000-0000-0000-0000-000000000000' instead. Obsolete in 12.1: Use the default view type '00000000-0000-0000-0000-000000000000' instead.

Methods

ChangePassword

Changes a user password

Velocity

#set($additionalInfoResponse = $core_v2_user.ChangePassword($id, $oldPassword, $newPassword))

JavaScript

var additionalInfoResponse = core_v2_user.ChangePassword(id, oldPassword, newPassword);

Parameters

Name	Type	Description	Required
id	`[[Number Script API Type\|Number]]`	Id	Required
oldPassword	`[[String Script API Type\|String]]`	Old Password	Required
newPassword	`[[String Script API Type\|String]]`	New Password	Required

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

ChangePasswordUsingToken

Changes a user password using a temporary verification token

Velocity

#set($additionalInfoResponse = $core_v2_user.ChangePasswordUsingToken($token, $newPassword))

JavaScript

var additionalInfoResponse = core_v2_user.ChangePasswordUsingToken(token, newPassword);

Parameters

Name	Type	Description	Required	Default	Options
token	`[[String Script API Type\|String]]`	Token	Required
newPassword	`[[String Script API Type\|String]]`	New Password	Required

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

Create

Create Overload 1

Creates a new user

Velocity

#set($userResponse = $core_v2_user.Create($username, $password, $privateEmail))

JavaScript

var userResponse = core_v2_user.Create(username, password, privateEmail);

Parameters

Name	Type	Description	Required
username	`[[String Script API Type\|String]]`	Username	Required
password	`[[String Script API Type\|String]]`	Password	Required
privateEmail	`[[String Script API Type\|String]]`	Private Email	Required

Create Overload 2

Creates a new user. Profile fields can be passed as options in the format _ProfileFields_FIELDNAME = 'FIELDVALUE'

Velocity

#set($userResponse = $core_v2_user.Create($username, $password, $privateEmail, "%{ AcceptTermsOfService = $acceptTermsOfServiceArg, AllowSitePartnersToContact = $allowSitePartnersToContactArg, AllowSiteToContact = $allowSiteToContactArg, Bio = $bioArg, Birthday = $birthdayArg, DisplayName = $displayNameArg, EnableEmail = $enableEmailArg, EnableFavoriteSharing = $enableFavoriteSharingArg, EnableHtmlEmail = $enableHtmlEmailArg, ExtendedAttributes = $extendedAttributesArg, Gender = $genderArg, ImportFromLdap = $importFromLdapArg, JoinDate = $joinDateArg, Language = $languageArg, Location = $locationArg, PublicEmail = $publicEmailArg, RssFeeds = $rssFeedsArg, TimeZone = $timeZoneArg, TimeZoneId = $timeZoneIdArg, WebUrl = $webUrlArg }"))

JavaScript

var userResponse = core_v2_user.Create(username, password, privateEmail, { AcceptTermsOfService: acceptTermsOfServiceArg, AllowSitePartnersToContact: allowSitePartnersToContactArg, AllowSiteToContact: allowSiteToContactArg, Bio: bioArg, Birthday: birthdayArg, DisplayName: displayNameArg, EnableEmail: enableEmailArg, EnableFavoriteSharing: enableFavoriteSharingArg, EnableHtmlEmail: enableHtmlEmailArg, ExtendedAttributes: extendedAttributesArg, Gender: genderArg, ImportFromLdap: importFromLdapArg, JoinDate: joinDateArg, Language: languageArg, Location: locationArg, PublicEmail: publicEmailArg, RssFeeds: rssFeedsArg, TimeZone: timeZoneArg, TimeZoneId: timeZoneIdArg, WebUrl: webUrlArg });

Parameters

Name	Type	Description	Required	Options
username	`[[String Script API Type\|String]]`	Username	Required
password	`[[String Script API Type\|String]]`	Password	Required
privateEmail	`[[String Script API Type\|String]]`	Private Email	Required
options	Options	Set of optional parameters including:	Required
AcceptTermsOfService	`[[Boolean Script API Type\|Boolean]]`	Registers that a user has accepted the terms of service for this community when applicable. The default is false.	Optional
AllowSitePartnersToContact	`[[Boolean Script API Type\|Boolean]]`	Allow Site Partners To Contact	Optional
AllowSiteToContact	`[[Boolean Script API Type\|Boolean]]`	Allow Site To Contact	Optional
Bio	`[[String Script API Type\|String]]`	Obsolete in 13: Use profile fields instead.	Optional
Birthday	`[[DateTime Script API Type\|DateTime]]`	Obsolete in 13: Use profile fields instead.	Optional
DisplayName	`[[String Script API Type\|String]]`	Display Name	Optional
EnableEmail	`[[Boolean Script API Type\|Boolean]]`	Allow user to receive emails.	Optional
EnableFavoriteSharing	`[[Boolean Script API Type\|Boolean]]`	Allow user's bookmarks to be viewed by others..	Optional
EnableHtmlEmail	`[[Boolean Script API Type\|Boolean]]`	Allow user to receive emails in the HTML format.	Optional
ExtendedAttributes	`[[String Script API Type\|String]]`	Extended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue".	Optional
Gender	`[[String Script API Type\|String]]`	Obsolete in 13: Use profile fields instead.	Optional	Female, Male, NotSet
ImportFromLdap	`[[Boolean Script API Type\|Boolean]]`	Import From Ldap	Optional
JoinDate	`[[DateTime Script API Type\|DateTime]]`	Join Date	Optional
Language	`[[String Script API Type\|String]]`	Language	Optional
Location	`[[String Script API Type\|String]]`	Obsolete in 13: Use profile fields instead.	Optional
PublicEmail	`[[String Script API Type\|String]]`	Public Email	Optional
RssFeeds	`[[List Script API Type\|List]] of [[String Script API Type\|String]]`	Rss Feeds	Optional
TimeZone	`[[Number Script API Type\|Number]]`	OBSOLETE in 14: Use TimeZoneId instead	Optional
TimeZoneId	`[[String Script API Type\|String]]`	Time Zone Id	Optional
WebUrl	`[[String Script API Type\|String]]`	Obsolete in 13: Use profile fields instead.	Optional

Returns

[[User Script API Type|User]]

CreateFromLdap

CreateFromLdap Overload 1

Obsolete in 13. Obsolete in 13

Velocity

#set($userResponse = $core_v2_user.CreateFromLdap($username))

JavaScript

var userResponse = core_v2_user.CreateFromLdap(username);

Parameters

Name	Type	Description	Required	Default	Options
username	`[[String Script API Type\|String]]`	Username	Required

CreateFromLdap Overload 2

Obsolete in 13. Obsolete in 13

Velocity

#set($userResponse = $core_v2_user.CreateFromLdap($username, $privateEmail))

JavaScript

var userResponse = core_v2_user.CreateFromLdap(username, privateEmail);

Parameters

Name	Type	Description	Required	Default	Options
username	`[[String Script API Type\|String]]`	Username	Required
privateEmail	`[[String Script API Type\|String]]`	Private Email	Required

Returns

[[User Script API Type|User]]

Delete

Deletes a user

Velocity

#set($additionalInfoResponse = $core_v2_user.Delete("%{ DeleteAllContent = $deleteAllContentArg, Id = $idArg, MergeToReassignedUser = $mergeToReassignedUserArg, ReassignedUserId = $reassignedUserIdArg, ReassignedUsername = $reassignedUsernameArg, Username = $usernameArg }"))

JavaScript

var additionalInfoResponse = core_v2_user.Delete({ DeleteAllContent: deleteAllContentArg, Id: idArg, MergeToReassignedUser: mergeToReassignedUserArg, ReassignedUserId: reassignedUserIdArg, ReassignedUsername: reassignedUsernameArg, Username: usernameArg });

Parameters

Name	Type	Description	Required	Default
options	Options	Set of optional parameters including:	Required
DeleteAllContent	`[[Boolean Script API Type\|Boolean]]`	If DeleteAllContent is set to true, ReassignUserId and ReassignUsername are ignored. User's content and related content will be deleted. (For example, if user has authored a blog post, that post and all related comments, likes, bookmarks, etc will be removed.)	Optional	False
Id	`[[Number Script API Type\|Number]]`	Either Id or Username is required.	Optional
MergeToReassignedUser	`[[Boolean Script API Type\|Boolean]]`	This options should only be used if the user being deleted was created mistakenly as a duplicate account of the existing user. If true, in addition to content being reassigned to the reassign user, all group memberships, profile data, security roles, conversations, subscriptions, notification settings and friendships will be merged. Cannot be merged with a system account.	Optional
ReassignedUserId	`[[Number Script API Type\|Number]]`	Reassign the deleted user's content to the user with this Id. If not specified, content will be reassigned to the 'Former Member' account.	Optional
ReassignedUsername	`[[String Script API Type\|String]]`	Reassign the deleted user's content to the user with this username. If not specified, content will be reassigned to the 'Former Member' account.	Optional
Username	`[[String Script API Type\|String]]`	Either Id or Username is required.	Optional

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

Get

Gets a user

Velocity

#set($userResponse = $core_v2_user.Get("%{ ContentId = $contentIdArg, Email = $emailArg, Id = $idArg, Username = $usernameArg }"))

JavaScript

var userResponse = core_v2_user.Get({ ContentId: contentIdArg, Email: emailArg, Id: idArg, Username: usernameArg });

Parameters

Name	Type	Description	Required
options	Options	Set of optional parameters including:	Required
ContentId	`[[Guid Script API Type\|Guid]]`	Either Id, ContentId, Email or Username is required.	Optional
Email	`[[String Script API Type\|String]]`	Either Id, ContentId, Email or Username is required.	Optional
Id	`[[Number Script API Type\|Number]]`	Either Id, ContentId, Email or Username is required.	Optional
Username	`[[String Script API Type\|String]]`	Either Id, ContentId, Email or Username is required.	Optional

Returns

[[User Script API Type|User]]

HasActionLinks

Returns whether a user has action links

Velocity

#set($booleanResponse = $core_v2_user.HasActionLinks($id))

JavaScript

var booleanResponse = core_v2_user.HasActionLinks(id);

Parameters

Name	Type	Description	Required	Default	Options
id	`[[Number Script API Type\|Number]]`	User Id	Required

Returns

[[Boolean Script API Type|Boolean]]

IsNewAccount

Used to determine if an account is newly created. Returns false if no account exists that matches the key.

Velocity

#set($booleanResponse = $core_v2_user.IsNewAccount($key))

JavaScript

var booleanResponse = core_v2_user.IsNewAccount(key);

Parameters

Name	Type	Description	Required	Default	Options
key	`[[String Script API Type\|String]]`	Key	Required

Returns

[[Boolean Script API Type|Boolean]]

IsRegistered

Determines whether a user is registered

Velocity

#set($booleanResponse = $core_v2_user.IsRegistered($id))

JavaScript

var booleanResponse = core_v2_user.IsRegistered(id);

Parameters

Name	Type	Description	Required	Default	Options
id	`[[Number Script API Type\|Number]]`	Id	Required

Returns

[[Boolean Script API Type|Boolean]]

IsUserUnverified

Indicates the user has never verified any email address.

Velocity

#set($booleanResponse = $core_v2_user.IsUserUnverified($userId))

JavaScript

var booleanResponse = core_v2_user.IsUserUnverified(userId);

Parameters

Name	Type	Description	Required	Default	Options
userId	`[[Number Script API Type\|Number]]`	User Id	Required

Returns

[[Boolean Script API Type|Boolean]]

List

List Overload 1

Lists users

Velocity

#set($pagedListResponse = $core_v2_user.List())

JavaScript

var pagedListResponse = core_v2_user.List();

List Overload 2

Lists users

Velocity

#set($pagedListResponse = $core_v2_user.List("%{ AccountStatus = $accountStatusArg, ContentIds = $contentIdsArg, DisplayName = $displayNameArg, EmailAddress = $emailAddressArg, IncludeHidden = $includeHiddenArg, JoinDate = $joinDateArg, JoinDateEnd = $joinDateEndArg, LastUpdatedUtcDate = $lastUpdatedUtcDateArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, Presence = $presenceArg, RoleId = $roleIdArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, Usernames = $usernamesArg }"))

JavaScript

var pagedListResponse = core_v2_user.List({ AccountStatus: accountStatusArg, ContentIds: contentIdsArg, DisplayName: displayNameArg, EmailAddress: emailAddressArg, IncludeHidden: includeHiddenArg, JoinDate: joinDateArg, JoinDateEnd: joinDateEndArg, LastUpdatedUtcDate: lastUpdatedUtcDateArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, Presence: presenceArg, RoleId: roleIdArg, SortBy: sortByArg, SortOrder: sortOrderArg, Usernames: usernamesArg });

Parameters

Name	Type	Description	Required	Default	Options
options	Options	Set of optional parameters including:	Required
AccountStatus	`[[String Script API Type\|String]]`	Used to filter by user account status.	Optional		All, ApprovalPending, Approved, Banned, Disapproved, PendingDeletion
ContentIds	`[[String Script API Type\|String]]`	Comma separated list of ContentIds. Used to limit to a specific set of users as well as sort order if SortBy is set to ContentIdsOrder.	Optional
DisplayName	`[[String Script API Type\|String]]`	Used to limit to users with a specific display name.	Optional
EmailAddress	`[[String Script API Type\|String]]`	Used to limit to a specific user based on email address.	Optional
IncludeHidden	`[[Boolean Script API Type\|Boolean]]`	By default 'hidden' users (like service accounts) will not be returned. Set IncludeHidden=true to return all users.	Optional
JoinDate	`[[DateTime Script API Type\|DateTime]]`	Used to limit results to just users who have joined on or after the specified date (see JoinDateEnd for end range options).	Optional
JoinDateEnd	`[[DateTime Script API Type\|DateTime]]`	When JoinDate is set, JoinDateEnd specifies the optional end date for the inclusive range of join dates for users to retrieve. When JoinDate is set and JoinDateEnd is not set, users with join dates equal to or greater than JoinDate are included.	Optional
LastUpdatedUtcDate	`[[DateTime Script API Type\|DateTime]]`	Last Updated Utc Date	Optional
PageIndex	`[[Number Script API Type\|Number]]`	Specify the page number of paged results to return. Zero-based index.	Optional	0
PageSize	`[[Number Script API Type\|Number]]`	Specify the number of results to return per page.	Optional	20
Presence	`[[String Script API Type\|String]]`	Presence	Optional		Offline, Online
RoleId	`[[Number Script API Type\|Number]]`	Role Id	Optional
SortBy	`[[String Script API Type\|String]]`	Sort By	Optional		ContentIdsOrder, DisplayName, Email, JoinedDate, LastVisitedDate, Posts, RecentPosts, Score:SCORE_ID, Username, Website
SortOrder	`[[String Script API Type\|String]]`	Sort Order	Optional		Ascending, Descending
Usernames	`[[String Script API Type\|String]]`	Used to limit to a specific set of users.	Optional

Returns

[[PagedList Script API Type|PagedList]] of [[User Script API Type|User]]

ListActionLinks

Returns action links for a user

Velocity

#set($listResponse = $core_v2_user.ListActionLinks($id))

JavaScript

var listResponse = core_v2_user.ListActionLinks(id);

Parameters

Name	Type	Description	Required	Default	Options
id	`[[Number Script API Type\|Number]]`	User Id	Required

Returns

[[List Script API Type|List]] of [[UserActionLink Script API Type|UserActionLink]]

ListUnverifiedEmails

ListUnverifiedEmails Overload 1

Displays any email addresses for the specified user that have not been verified.

Velocity

#set($apiListResponse = $core_v2_user.ListUnverifiedEmails($verificationContext))

JavaScript

var apiListResponse = core_v2_user.ListUnverifiedEmails(verificationContext);

Parameters

Name	Type	Description	Required	Default	Options
verificationContext	`[[Guid Script API Type\|Guid]]`	Verification Context	Required

ListUnverifiedEmails Overload 2

Displays any email addresses for the specified user that have not been verified.

Velocity

#set($apiListResponse = $core_v2_user.ListUnverifiedEmails($userId))

JavaScript

var apiListResponse = core_v2_user.ListUnverifiedEmails(userId);

Parameters

Name	Type	Description	Required	Default	Options
userId	`[[Number Script API Type\|Number]]`	User Id	Required

Returns

[[ApiList Script API Type|ApiList]] of [[UnverifiedEmail Script API Type|UnverifiedEmail]]

Lookup

Velocity

#set($apiListResponse = $core_v2_user.Lookup($queryText, "%{ AccountStatus = $accountStatusArg, IncludeHidden = $includeHiddenArg, PageSize = $pageSizeArg }"))

JavaScript

var apiListResponse = core_v2_user.Lookup(queryText, { AccountStatus: accountStatusArg, IncludeHidden: includeHiddenArg, PageSize: pageSizeArg });

Parameters

Name	Type	Description	Required	Default	Options
queryText	`[[String Script API Type\|String]]`	Query Text	Required
options	Options	Set of optional parameters including:	Required
AccountStatus	`[[String Script API Type\|String]]`	Used to filter by user account status. Optional Parameter	Optional	Approved	All, ApprovalPending, Approved, Banned, Disapproved, PendingDeletion
IncludeHidden	`[[Boolean Script API Type\|Boolean]]`	By default 'hidden' users (like service accounts) will not be returned. Set IncludeHidden=true to return all users. Optional parameter	Optional
PageSize	`[[Number Script API Type\|Number]]`	Specify the number of results to return per page.	Optional	20

Returns

[[ApiList Script API Type|ApiList]] of [[User Script API Type|User]]

RequestExport

RequestExport Overload 1

Initializes a request to export user data. The accessing user will receive a conversation message or email when the export is complete and ready for downloading.

Velocity

#set($additionalInfoResponse = $core_v2_user.RequestExport())

JavaScript

var additionalInfoResponse = core_v2_user.RequestExport();

RequestExport Overload 2

Initializes a request to export user data.The accessing user will receive a conversation message or email when the export is complete and ready for downloading.

Velocity

#set($additionalInfoResponse = $core_v2_user.RequestExport("%{ UserId = $userIdArg }"))

JavaScript

var additionalInfoResponse = core_v2_user.RequestExport({ UserId: userIdArg });

Parameters

Name	Type	Description	Required	Default	Options
options	Options	Set of optional parameters including:	Required
UserId	`[[Number Script API Type\|Number]]`	The user to export.	Optional

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

SendVerificationEmail

SendVerificationEmail Overload 1

Resends a verification email to the specified email address.

Velocity

#set($additionalInfoResponse = $core_v2_user.SendVerificationEmail($verificationContext))

JavaScript

var additionalInfoResponse = core_v2_user.SendVerificationEmail(verificationContext);

Parameters

Name	Type	Description	Required	Default	Options
verificationContext	`[[Guid Script API Type\|Guid]]`	Verification Context	Required

SendVerificationEmail Overload 2

Resends a verification email to the specified email address.

Velocity

#set($additionalInfoResponse = $core_v2_user.SendVerificationEmail($userId))

JavaScript

var additionalInfoResponse = core_v2_user.SendVerificationEmail(userId);

Parameters

Name	Type	Description	Required	Default	Options
userId	`[[Number Script API Type\|Number]]`	User Id	Required

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

ToString

Velocity

#set($stringResponse = $core_v2_user.ToString())

JavaScript

var stringResponse = core_v2_user.ToString();

Returns

[[String Script API Type|String]]

Update

Updates a user. Profile fields can be passed as options in the format _ProfileFields_FIELDNAME = 'FIELDVALUE'

Velocity

#set($userResponse = $core_v2_user.Update("%{ AcceptTermsOfService = $acceptTermsOfServiceArg, AccountStatus = $accountStatusArg, AllowSitePartnersToContact = $allowSitePartnersToContactArg, AllowSiteToContact = $allowSiteToContactArg, BannedUntil = $bannedUntilArg, BanReason = $banReasonArg, Bio = $bioArg, Birthday = $birthdayArg, DisplayName = $displayNameArg, EnabledActivityMessageTypes = $enabledActivityMessageTypesArg, EnableDisplayInMemberList = $enableDisplayInMemberListArg, EnableDisplayName = $enableDisplayNameArg, EnableEmail = $enableEmailArg, EnableFavoriteSharing = $enableFavoriteSharingArg, EnableHtmlEmail = $enableHtmlEmailArg, EnablePresenceTracking = $enablePresenceTrackingArg, EnableUserSignatures = $enableUserSignaturesArg, ExtendedAttributes = $extendedAttributesArg, ForceLogin = $forceLoginArg, Gender = $genderArg, Id = $idArg, IsBirthdaySet = $isBirthdaySetArg, IsIgnored = $isIgnoredArg, Language = $languageArg, Location = $locationArg, ModerationLevel = $moderationLevelArg, NewPassword = $newPasswordArg, OldPassword = $oldPasswordArg, PrivateEmail = $privateEmailArg, PublicEmail = $publicEmailArg, RssFeeds = $rssFeedsArg, TimeZone = $timeZoneArg, TimeZoneId = $timeZoneIdArg, Username = $usernameArg, WebUrl = $webUrlArg }"))

JavaScript

var userResponse = core_v2_user.Update({ AcceptTermsOfService: acceptTermsOfServiceArg, AccountStatus: accountStatusArg, AllowSitePartnersToContact: allowSitePartnersToContactArg, AllowSiteToContact: allowSiteToContactArg, BannedUntil: bannedUntilArg, BanReason: banReasonArg, Bio: bioArg, Birthday: birthdayArg, DisplayName: displayNameArg, EnabledActivityMessageTypes: enabledActivityMessageTypesArg, EnableDisplayInMemberList: enableDisplayInMemberListArg, EnableDisplayName: enableDisplayNameArg, EnableEmail: enableEmailArg, EnableFavoriteSharing: enableFavoriteSharingArg, EnableHtmlEmail: enableHtmlEmailArg, EnablePresenceTracking: enablePresenceTrackingArg, EnableUserSignatures: enableUserSignaturesArg, ExtendedAttributes: extendedAttributesArg, ForceLogin: forceLoginArg, Gender: genderArg, Id: idArg, IsBirthdaySet: isBirthdaySetArg, IsIgnored: isIgnoredArg, Language: languageArg, Location: locationArg, ModerationLevel: moderationLevelArg, NewPassword: newPasswordArg, OldPassword: oldPasswordArg, PrivateEmail: privateEmailArg, PublicEmail: publicEmailArg, RssFeeds: rssFeedsArg, TimeZone: timeZoneArg, TimeZoneId: timeZoneIdArg, Username: usernameArg, WebUrl: webUrlArg });

Parameters

Name	Type	Description	Required	Options
options	Options	Set of optional parameters including:	Required
AcceptTermsOfService	`[[Boolean Script API Type\|Boolean]]`	Registers that a user has accepted the terms of service for this community when applicable. The default is false.	Optional
AccountStatus	`[[String Script API Type\|String]]`	Account Status	Optional	All, ApprovalPending, Approved, Banned, Disapproved, PendingDeletion
AllowSitePartnersToContact	`[[Boolean Script API Type\|Boolean]]`	Allow Site Partners To Contact	Optional
AllowSiteToContact	`[[Boolean Script API Type\|Boolean]]`	Allow Site To Contact	Optional
BannedUntil	`[[DateTime Script API Type\|DateTime]]`	Banned Until	Optional
BanReason	`[[String Script API Type\|String]]`	Ban Reason	Optional	Advertising, Aggresive, BadSignature, BadUsername, BanDodging, Other, Profanity, Spam
Bio	`[[String Script API Type\|String]]`	Obsolete in 13: Use profile fields instead.	Optional
Birthday	`[[DateTime Script API Type\|DateTime]]`	Obsolete in 13: Use profile fields instead.	Optional
DisplayName	`[[String Script API Type\|String]]`	Display Name	Optional
EnabledActivityMessageTypes	`[[String Script API Type\|String]]`	Now that Activity Stories have superseded activity messages, use ActivityStoryUserPreferences to get more accurate information.	Optional
EnableDisplayInMemberList	`[[Boolean Script API Type\|Boolean]]`	Enable Display In Member List	Optional
EnableDisplayName	`[[Boolean Script API Type\|Boolean]]`	Enable Display Name	Optional
EnableEmail	`[[Boolean Script API Type\|Boolean]]`	Allow user to receive emails.	Optional
EnableFavoriteSharing	`[[Boolean Script API Type\|Boolean]]`	Allow user's bookmarks to be viewed by others.	Optional
EnableHtmlEmail	`[[Boolean Script API Type\|Boolean]]`	Allow user to receive emails in the HTML format.	Optional
EnablePresenceTracking	`[[Boolean Script API Type\|Boolean]]`	Allow presence tracking and reporting.	Optional
EnableUserSignatures	`[[Boolean Script API Type\|Boolean]]`	Enable User Signatures	Optional
ExtendedAttributes	`[[String Script API Type\|String]]`	Extended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue".	Optional
ForceLogin	`[[Boolean Script API Type\|Boolean]]`	Force Login	Optional
Gender	`[[String Script API Type\|String]]`	Obsolete in 13: Use profile fields instead.	Optional	Female, Male, NotSet
Id	`[[Number Script API Type\|Number]]`	Either Id or Username is required.	Optional
IsBirthdaySet	`[[Boolean Script API Type\|Boolean]]`	Is Birthday Set	Optional
IsIgnored	`[[Boolean Script API Type\|Boolean]]`	Is Ignored	Optional
Language	`[[String Script API Type\|String]]`	Language	Optional
Location	`[[String Script API Type\|String]]`	Obsolete in 13: Use profile fields instead.	Optional
ModerationLevel	`[[String Script API Type\|String]]`	Moderation Level	Optional	Moderated, Unmoderated
NewPassword	`[[String Script API Type\|String]]`	New Password	Optional
OldPassword	`[[String Script API Type\|String]]`	Required if changing the password.	Optional
PrivateEmail	`[[String Script API Type\|String]]`	Private Email	Optional
PublicEmail	`[[String Script API Type\|String]]`	Public Email	Optional
RssFeeds	`[[List Script API Type\|List]] of [[String Script API Type\|String]]`	Rss Feeds	Optional
TimeZone	`[[Number Script API Type\|Number]]`	OBSOLETE in 14: Use TimeZoneId instead	Optional
TimeZoneId	`[[String Script API Type\|String]]`	Time Zone Id	Optional
Username	`[[String Script API Type\|String]]`	Either Id or Username is required. Changing a username requires a user can manage membership, or a user has been granted the 'Change Own Username' permission to change their own account's username.	Optional
WebUrl	`[[String Script API Type\|String]]`	Obsolete in 13: Use profile fields instead.	Optional

Returns

[[User Script API Type|User]]

VerifyWithKey

Attempts to validate a given key against any possible unverified email records.

Velocity

#set($stringResponse = $core_v2_user.VerifyWithKey($key))

JavaScript

var stringResponse = core_v2_user.VerifyWithKey(key);

Parameters

Name	Type	Description	Required	Default	Options
key	`[[String Script API Type\|String]]`	Key	Required

Returns

[[String Script API Type|String]]

VerifyWithoutKey

Attempt to verify a user's email without a key. This is intended as an administrative bypass, and requires permission to manage membership accounts.

Velocity

#set($stringResponse = $core_v2_user.VerifyWithoutKey($userId, $emailAddress))

JavaScript

var stringResponse = core_v2_user.VerifyWithoutKey(userId, emailAddress);

Parameters

Name	Type	Description	Required	Default	Options
userId	`[[Number Script API Type\|Number]]`	User Id	Required
emailAddress	`[[String Script API Type\|String]]`	Email Address	Required

Returns

[[String Script API Type|String]]