Verint | Telligent Community
Verint | Telligent Community
  • Site
  • User
  • Site
  • Search
  • User
Verint Community 12.x
  • Verint Community
Verint Community 12.x
API Documentation core_v2_user Script API
  • User Documentation
  • Ask the Community
  • API Documentation
  • Manager Training
  • Developer Training
  • Tags
  • More
  • Cancel
  • New
  • API Documentation
  • +In-Process API Documentation
  • +Plugin API Documentation
  • +REST API Documentation
  • -Widget, Theme, and Automation APIs
    • +Automation Events
    • +Client-side APIs
    • +Dynamic Configuration
    • +LESS Functions
    • +Script API Types
    • -Script APIs
      • articles_v1_articleCategories Script API
      • articles_v1_articleCollections Script API
      • articles_v1_articles Script API
      • articles_v1_articleTypes Script API
      • articles_v1_articleUrls Script API
      • articles_v1_articleVersionCategories Script API
      • articles_v1_articleVersions Script API
      • articles_v1_categories Script API
      • articles_v1_helpfulness Script API
      • articles_v1_helpfulnessResponseTypes Script API
      • articles_v1_permissions Script API
      • articles_v1_publishGroups Script API
      • articles_v1_subscriptionTypes Script API
      • calendar_v1_calendars Script API
      • calendar_v1_events Script API
      • calendar_v1_permissions Script API
      • calendar_v1_registrations Script API
      • calendar_v1_resources Script API
      • calendar_v1_UI Script API
      • calendar_v1_urls Script API
      • context_v2_automationState Script API
      • context_v2_automationTrigger Script API
      • context_v2_embeddable Script API
      • context_v2_propertyRule Script API
      • context_v2_propertyTemplate Script API
      • context_v2_scheduledFile Script API
      • context_v2_themeBody Script API
      • context_v2_themeHeader Script API
      • core_v1_reportingPermissions Script API
      • core_v1_reportingUrls Script API
      • core_v2_abuseAppeal Script API
      • core_v2_abuseReport Script API
      • core_v2_abusiveContent Script API
      • core_v2_achievement Script API
      • core_v2_achievementSummary Script API
      • core_v2_activityStory Script API
      • core_v2_activityStorySitePreference Script API
      • core_v2_activityStoryUserPreference Script API
      • core_v2_apiKey Script API
      • core_v2_application Script API
      • core_v2_applicationMerge Script API
      • core_v2_applicationSubscription Script API
      • core_v2_applicationType Script API
      • core_v2_authentication Script API
      • core_v2_authorQualityScore Script API
      • core_v2_automation Script API
      • core_v2_blog Script API
      • core_v2_blogConfiguration Script API
      • core_v2_blogPermissions Script API
      • core_v2_blogPost Script API
      • core_v2_blogPostSummary Script API
      • core_v2_blogUrls Script API
      • core_v2_bookmark Script API
      • core_v2_calculatedScores Script API
      • core_v2_captureThreadToArticle Script API
      • core_v2_cfs Script API
      • core_v2_comments Script API
      • core_v2_commentSummary Script API
      • core_v2_commentVotes Script API
      • core_v2_configuration Script API
      • core_v2_container Script API
      • core_v2_containerType Script API
      • core_v2_content Script API
      • core_v2_contentConversion Script API
      • core_v2_contentPresence Script API
      • core_v2_contentQualityScore Script API
      • core_v2_contentRecommendation Script API
      • core_v2_contentSubscribers Script API
      • core_v2_contentSubscription Script API
      • core_v2_contentType Script API
      • core_v2_contentViews Script API
      • core_v2_conversation Script API
      • core_v2_conversationMessage Script API
      • core_v2_customNavigation Script API
      • core_v2_customPage Script API
      • core_v2_dynamicForm Script API
      • core_v2_editableGroup Script API
      • core_v2_editor Script API
      • core_v2_email Script API
      • core_v2_emailDigest Script API
      • core_v2_emoticon Script API
      • core_v2_encoding Script API
      • core_v2_eventLog Script API
      • core_v2_exceptions Script API
      • core_v2_follower Script API
      • core_v2_following Script API
      • core_v2_forum Script API
      • core_v2_forumConfiguration Script API
      • core_v2_forumPermissions Script API
      • core_v2_forumReply Script API
      • core_v2_forumReplyVote Script API
      • core_v2_forumThread Script API
      • core_v2_forumThreadVote Script API
      • core_v2_forumUrls Script API
      • core_v2_friendship Script API
      • core_v2_gallery Script API
      • core_v2_group Script API
      • core_v2_groupAuthorQualityScore Script API
      • core_v2_groupContactRequest Script API
      • core_v2_groupPermissions Script API
      • core_v2_groupRoleMember Script API
      • core_v2_groupUrls Script API
      • core_v2_groupUserMember Script API
      • core_v2_hashTag Script API
      • core_v2_http Script API
      • core_v2_infoResult Script API
      • core_v2_language Script API
      • core_v2_ldapGroups Script API
      • core_v2_ldapUsers Script API
      • core_v2_leader Script API
      • core_v2_leaderboard Script API
      • core_v2_leaderboardUrls Script API
      • core_v2_like Script API
      • core_v2_likedItem Script API
      • core_v2_media Script API
      • core_v2_mediaConfiguration Script API
      • core_v2_mediaPermissions Script API
      • core_v2_mediaUrls Script API
      • core_v2_mention Script API
      • core_v2_mentionable Script API
      • core_v2_message Script API
      • core_v2_moderationTemplates Script API
      • core_v2_notification Script API
      • core_v2_notificationCategory Script API
      • core_v2_notificationDistributionType Script API
      • core_v2_notificationType Script API
      • core_v2_notificationUserPreference Script API
      • core_v2_oauthClient Script API
      • core_v2_page Script API
      • core_v2_permission Script API
      • core_v2_pointTransaction Script API
      • core_v2_poll Script API
      • core_v2_process Script API
      • core_v2_ratedItem Script API
      • core_v2_rating Script API
      • core_v2_reviewableContent Script API
      • core_v2_role Script API
      • core_v2_roleUsers Script API
      • core_v2_rssFeedItem Script API
      • core_v2_search Script API
      • core_v2_searchCategory Script API
      • core_v2_searchResult Script API
      • core_v2_servicePresence Script API
      • core_v2_sitePermissions Script API
      • core_v2_statusMessage Script API
      • core_v2_submittableEditor Script API
      • core_v2_systemNotification Script API
      • core_v2_taggedContent Script API
      • core_v2_tags Script API
      • core_v2_theme Script API
      • core_v2_themeFooter Script API
      • core_v2_themeHeader Script API
      • core_v2_themePage Script API
      • core_v2_tourTip Script API
      • core_v2_ui Script API
      • core_v2_uploadedFile Script API
      • core_v2_urls Script API
      • core_v2_user Script API
      • core_v2_userAchievement Script API
      • core_v2_userFile Script API
      • core_v2_userFolder Script API
      • core_v2_userInvitation Script API
      • core_v2_userPermission Script API
      • core_v2_userProfileField Script API
      • core_v2_userProfileFieldGroup Script API
      • core_v2_userRecommendation Script API
      • core_v2_userValidation Script API
      • core_v2_utility Script API
      • core_v2_webhook Script API
      • core_v2_webhookEvent Script API
      • core_v2_widget Script API
      • core_v2_wiki Script API
      • core_v2_wikiConfiguration Script API
      • core_v2_wikiFiles Script API
      • core_v2_wikiPage Script API
      • core_v2_wikiPageCommentSubscriptions Script API
      • core_v2_wikiPageRevision Script API
      • core_v2_wikiPermissions Script API
      • core_v2_wikiToc Script API
      • core_v2_wikiUrls Script API
      • core_v3_feature Script API
      • core_v3_permission Script API
      • telligentIdeas_v1_challenges Script API
      • telligentIdeas_v1_ideaCategories Script API
      • telligentIdeas_v1_ideaPermissions Script API
      • telligentIdeas_v1_ideas Script API
      • telligentIdeas_v1_ideaStatuses Script API
      • telligentIdeas_v1_statuses Script API
      • telligentIdeas_v1_urls Script API
      • telligentIdeas_v1_userVoteSummaries Script API
      • telligentIdeas_v1_votes Script API

core_v2_user Script API


Enables scripted content fragments to use Users

  • Properties
  • ChangePassword
  • ChangePasswordUsingToken
  • Create
  • CreateFromLdap
  • Delete
  • Get
  • HasActionLinks
  • IsNewAccount
  • IsRegistered
  • IsUserUnverified
  • List
  • ListActionLinks
  • ListUnverifiedEmails
  • Lookup
  • RequestExport
  • SendVerificationEmail
  • Update
  • VerifyWithKey
  • VerifyWithoutKey

Properties

NameAccessTypeDescription
AccessingReadUserAccessing user
AnonymousUserNameReadStringThe username of the anonymous system account.
ApplicationTypeIdReadGuidUsers application type identifier
ContainerTypeIdReadGuidUsers container type identifier
ContentTypeIdReadGuidUsers content type identifier
CurrentReadUserContextual user
FormerMemberNameReadStringThe username of the Former Member system account.
ServiceUserNameReadStringThe username of the service system account.
ThemeTypeIdReadGuidUsers theme type identifier
TotalLicensedReadInt32Total number licensed users
UserContentViewTypeIdReadGuid
Obsolete. DEPRECATED in v12.1: Use the default view type '00000000-0000-0000-0000-000000000000' instead.
Id used to track a view to the user. DEPRECATED in v12.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

NameTypeDescriptionRequiredDefaultOptions
idInt32IdRequired
oldPasswordStringOld PasswordRequired
newPasswordStringNew PasswordRequired

Returns

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

NameTypeDescriptionRequiredDefaultOptions
tokenStringTokenRequired
newPasswordStringNew PasswordRequired

Returns

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

NameTypeDescriptionRequiredDefaultOptions
usernameStringUsernameRequired
passwordStringPasswordRequired
privateEmailStringPrivate EmailRequired

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

NameTypeDescriptionRequiredDefaultOptions
usernameStringUsernameRequired
passwordStringPasswordRequired
privateEmailStringPrivate EmailRequired
optionsOptionsSet of optional parameters including:Required
AcceptTermsOfServiceBooleanRegisters that a user has accepted the terms of service for this community when applicable. The default is false.Optional
AllowSitePartnersToContactBooleanAllow Site Partners To ContactOptional
AllowSiteToContactBooleanAllow Site To ContactOptional
BioStringBioOptional
BirthdayDateTimeBirthdayOptional
DisplayNameStringDisplay NameOptional
EnableEmailBooleanAllow user to receive emails.Optional
EnableFavoriteSharingBooleanAllow user's bookmarks to be viewed by others..Optional
EnableHtmlEmailBooleanAllow user to receive emails in the HTML format.Optional
ExtendedAttributesStringExtended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue".Optional
GenderStringGenderOptionalFemale, Male, NotSet
ImportFromLdapBooleanImport From LdapOptional
JoinDateDateTimeJoin DateOptional
LanguageStringLanguageOptional
LocationStringLocationOptional
PublicEmailStringPublic EmailOptional
RssFeedsIList of StringRss FeedsOptional
TimeZoneDoubleTime ZoneOptional
TimeZoneIdStringTime Zone IdOptional
WebUrlStringWeb UrlOptional

Returns

User

CreateFromLdap

CreateFromLdap Overload 1

Creates a new user from LDAP

Velocity

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

JavaScript

var userResponse = core_v2_user.CreateFromLdap(username);

Parameters

NameTypeDescriptionRequiredDefaultOptions
usernameStringUsernameRequired

CreateFromLdap Overload 2

Creates a new user from LDAP

Velocity

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

JavaScript

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
usernameStringUsernameRequired
privateEmailStringPrivate EmailRequired

Returns

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

NameTypeDescriptionRequiredDefaultOptions
optionsOptionsSet of optional parameters including:Required
DeleteAllContentBooleanIf 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.)OptionalFalse
IdInt32Either Id or Username is required.Optional
MergeToReassignedUserBooleanThis 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
ReassignedUserIdInt32Reassign the deleted user's content to the user with this Id. If not specified, content will be reassigned to the 'Former Member' account.Optional
ReassignedUsernameStringReassign the deleted user's content to the user with this username. If not specified, content will be reassigned to the 'Former Member' account.Optional
UsernameStringEither Id or Username is required.Optional

Returns

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

NameTypeDescriptionRequiredDefaultOptions
optionsOptionsSet of optional parameters including:Required
ContentIdGuidEither Id, ContentId, Email or Username is required.Optional
EmailStringEither Id, ContentId, Email or Username is required.Optional
IdInt32Either Id, ContentId, Email or Username is required.Optional
UsernameStringEither Id, ContentId, Email or Username is required.Optional

Returns

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

NameTypeDescriptionRequiredDefaultOptions
idInt32User IdRequired

Returns

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

NameTypeDescriptionRequiredDefaultOptions
keyStringKeyRequired

Returns

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

NameTypeDescriptionRequiredDefaultOptions
idInt32IdRequired

Returns

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

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

Returns

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("%{ ContentIds = $contentIdsArg, EmailAddress = $emailAddressArg, IncludeHidden = $includeHiddenArg, JoinDate = $joinDateArg, LastUpdatedUtcDate = $lastUpdatedUtcDateArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, Presence = $presenceArg, RoleId = $roleIdArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, Usernames = $usernamesArg }"))

JavaScript

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
optionsOptionsSet of optional parameters including:Required
ContentIdsStringComma 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
EmailAddressStringUsed to limit to a specific user based on email address.Optional
IncludeHiddenBooleanBy default 'hidden' users (like service accounts) will not be returned. Set IncludeHidden=true to return all users.Optional
JoinDateDateTimeUsed to limit to just users who have joined since the specified date.Optional
LastUpdatedUtcDateDateTimeLast Updated Utc DateOptional
PageIndexInt32Specify the page number of paged results to return. Zero-based index.Optional0
PageSizeInt32Specify the number of results to return per page.Optional20
PresenceStringPresenceOptionalOffline, Online
RoleIdInt32Role IdOptional
SortByStringSort ByOptionalContentIdsOrder, DisplayName, Email, JoinedDate, LastVisitedDate, Posts, RecentPosts, Score:SCORE_ID, Username, Website
SortOrderStringSort OrderOptionalAscending, Descending
UsernamesStringUsed to limit to a specific set of users.Optional

Returns

PagedList of User

ListActionLinks

Returns action links for a user

Velocity

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

JavaScript

var iListResponse = core_v2_user.ListActionLinks(id);

Parameters

NameTypeDescriptionRequiredDefaultOptions
idInt32User IdRequired

Returns

IList of 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

NameTypeDescriptionRequiredDefaultOptions
verificationContextGuidVerification ContextRequired

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

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

Returns

ApiList of UnverifiedEmail

Lookup

Velocity

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

JavaScript

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
queryTextStringQuery TextRequired
optionsOptionsSet of optional parameters including:Required
PageSizeInt32Specify the number of results to return per page.Optional20

Returns

ApiList of 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

NameTypeDescriptionRequiredDefaultOptions
optionsOptionsSet of optional parameters including:Required
UserIdInt32The user to export.Optional

Returns

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

NameTypeDescriptionRequiredDefaultOptions
verificationContextGuidVerification ContextRequired

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

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

Returns

AdditionalInfo

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

NameTypeDescriptionRequiredDefaultOptions
optionsOptionsSet of optional parameters including:Required
AcceptTermsOfServiceBooleanRegisters that a user has accepted the terms of service for this community when applicable. The default is false.Optional
AccountStatusStringAccount StatusOptionalAll, ApprovalPending, Approved, Banned, Disapproved, PendingDeletion
AllowSitePartnersToContactBooleanAllow Site Partners To ContactOptional
AllowSiteToContactBooleanAllow Site To ContactOptional
BannedUntilDateTimeBanned UntilOptional
BanReasonStringBan ReasonOptionalAdvertising, Aggresive, BadSignature, BadUsername, BanDodging, Other, Profanity, Spam
BioStringBioOptional
BirthdayDateTimeBirthdayOptional
DisplayNameStringDisplay NameOptional
EnabledActivityMessageTypesStringNow that Activity Stories have superseded activity messages, use ActivityStoryUserPreferences to get more accurate information.Optional
EnableDisplayInMemberListBooleanEnable Display In Member ListOptional
EnableDisplayNameBooleanEnable Display NameOptional
EnableEmailBooleanAllow user to receive emails.Optional
EnableFavoriteSharingBooleanAllow user's bookmarks to be viewed by others.Optional
EnableHtmlEmailBooleanAllow user to receive emails in the HTML format.Optional
EnablePresenceTrackingBooleanAllow presence tracking and reporting.Optional
EnableUserSignaturesBooleanEnable User SignaturesOptional
ExtendedAttributesStringExtended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue".Optional
ForceLoginBooleanForce LoginOptional
GenderStringGenderOptionalFemale, Male, NotSet
IdInt32Either Id or Username is required.Optional
IsBirthdaySetBooleanIs Birthday SetOptional
IsIgnoredBooleanIs IgnoredOptional
LanguageStringLanguageOptional
LocationStringLocationOptional
ModerationLevelStringModeration LevelOptionalModerated, Unmoderated
NewPasswordStringNew PasswordOptional
OldPasswordStringRequired if changing the password.Optional
PrivateEmailStringPrivate EmailOptional
PublicEmailStringPublic EmailOptional
RssFeedsIList of StringRss FeedsOptional
TimeZoneDoubleTime ZoneOptional
TimeZoneIdStringTime Zone IdOptional
UsernameStringEither Id or Username is required.Optional
WebUrlStringWeb UrlOptional

Returns

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

NameTypeDescriptionRequiredDefaultOptions
keyStringKeyRequired

Returns

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

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
emailAddressStringEmail AddressRequired

Returns

String


  • Share
  • History
  • More
  • Cancel
Related
Recommended
  • Telligent
  • Professional Services
  • Submit a Support Ticket
  • Become a Partner
  • Request a Demo
  • Contact Us

About
Privacy Policy
Terms of use
Copyright 2024 Verint, Inc.
Powered by Verint Community