Telligent Community
Telligent Community
  • Site
  • User
  • Site
  • Search
  • User
Telligent Community 10.x
  • Verint Community
  • More
Telligent Community 10.x
API Documentation $core_v2_user Widget Extension
  • Ask the Community
  • User Documentation
  • API Documentation
  • Manager Training
  • Developer Training
  • Tags
  • More
  • Cancel
  • New
  • API Documentation
  • +In-Process API Documentation
  • +Plugin API Documentation
  • +REST API Documentation
  • -Widget API Documentation
    • +JavaScript API Documentation
    • +Widget Associated Types
    • -Widget Extensions
      • $calendar_v1_calendars Widget Extension
      • $calendar_v1_events Widget Extension
      • $calendar_v1_permissions Widget Extension
      • $calendar_v1_registrations Widget Extension
      • $calendar_v1_resources Widget Extension
      • $calendar_v1_UI Widget Extension
      • $calendar_v1_urls Widget Extension
      • $context_v2_propertyTemplate Widget Extension
      • $context_v2_themeBody Widget Extension
      • $context_v2_themeHeader Widget Extension
      • $core_v2_abuseAppeal Widget Extension
      • $core_v2_abuseReport Widget Extension
      • $core_v2_abusiveContent Widget Extension
      • $core_v2_achievement Widget Extension
      • $core_v2_achievementSummary Widget Extension
      • $core_v2_activityStory Widget Extension
      • $core_v2_activityStorySitePreference Widget Extension
      • $core_v2_activityStoryUserPreference Widget Extension
      • $core_v2_apiKey Widget Extension
      • $core_v2_application Widget Extension
      • $core_v2_applicationMerge Widget Extension
      • $core_v2_applicationSubscription Widget Extension
      • $core_v2_applicationType Widget Extension
      • $core_v2_authentication Widget Extension
      • $core_v2_authorQualityScore Widget Extension
      • $core_v2_blog Widget Extension
      • $core_v2_blogConfiguration Widget Extension
      • $core_v2_blogPermissions Widget Extension
      • $core_v2_blogPost Widget Extension
      • $core_v2_blogPostSummary Widget Extension
      • $core_v2_blogUrls Widget Extension
      • $core_v2_bookmark Widget Extension
      • $core_v2_calculatedScores Widget Extension
      • $core_v2_cfs Widget Extension
      • $core_v2_comments Widget Extension
      • $core_v2_commentVotes Widget Extension
      • $core_v2_configuration Widget Extension
      • $core_v2_container Widget Extension
      • $core_v2_containerType Widget Extension
      • $core_v2_content Widget Extension
      • $core_v2_contentConversion Widget Extension
      • $core_v2_contentPresence Widget Extension
      • $core_v2_contentQualityScore Widget Extension
      • $core_v2_contentRecommendation Widget Extension
      • $core_v2_contentSubscribers Widget Extension
      • $core_v2_contentSubscription Widget Extension
      • $core_v2_contentType Widget Extension
      • $core_v2_contentViews Widget Extension
      • $core_v2_conversation Widget Extension
      • $core_v2_conversationMessage Widget Extension
      • $core_v2_customNavigation Widget Extension
      • $core_v2_customPage Widget Extension
      • $core_v2_dynamicForm Widget Extension
      • $core_v2_editableGroup Widget Extension
      • $core_v2_editor Widget Extension
      • $core_v2_emailDigest Widget Extension
      • $core_v2_emoticon Widget Extension
      • $core_v2_encoding Widget Extension
      • $core_v2_eventLog Widget Extension
      • $core_v2_follower Widget Extension
      • $core_v2_following Widget Extension
      • $core_v2_forum Widget Extension
      • $core_v2_forumConfiguration Widget Extension
      • $core_v2_forumPermissions Widget Extension
      • $core_v2_forumReply Widget Extension
      • $core_v2_forumReplyVote Widget Extension
      • $core_v2_forumThread Widget Extension
      • $core_v2_forumThreadVote Widget Extension
      • $core_v2_forumUrls Widget Extension
      • $core_v2_friendship Widget Extension
      • $core_v2_gallery Widget Extension
      • $core_v2_group Widget Extension
      • $core_v2_groupAuthorQualityScore Widget Extension
      • $core_v2_groupContactRequest Widget Extension
      • $core_v2_groupPermissions Widget Extension
      • $core_v2_groupRoleMember Widget Extension
      • $core_v2_groupUrls Widget Extension
      • $core_v2_groupUserMember Widget Extension
      • $core_v2_hashTag Widget Extension
      • $core_v2_infoResult Widget Extension
      • $core_v2_language Widget Extension
      • $core_v2_ldapGroups Widget Extension
      • $core_v2_ldapUsers Widget Extension
      • $core_v2_leader Widget Extension
      • $core_v2_leaderboard Widget Extension
      • $core_v2_leaderboardUrls Widget Extension
      • $core_v2_like Widget Extension
      • $core_v2_likedItem Widget Extension
      • $core_v2_media Widget Extension
      • $core_v2_mediaConfiguration Widget Extension
      • $core_v2_mediaPermissions Widget Extension
      • $core_v2_mediaUrls Widget Extension
      • $core_v2_mention Widget Extension
      • $core_v2_mentionable Widget Extension
      • $core_v2_message Widget Extension
      • $core_v2_moderationTemplates Widget Extension
      • $core_v2_nodePermission Widget Extension
      • $core_v2_notification Widget Extension
      • $core_v2_notificationCategory Widget Extension
      • $core_v2_notificationDistributionType Widget Extension
      • $core_v2_notificationType Widget Extension
      • $core_v2_notificationUserPreference Widget Extension
      • $core_v2_oauthClient Widget Extension
      • $core_v2_page Widget Extension
      • $core_v2_permission Widget Extension
      • $core_v2_pointTransaction Widget Extension
      • $core_v2_poll Widget Extension
      • $core_v2_ratedItem Widget Extension
      • $core_v2_rating Widget Extension
      • $core_v2_recaptcha Widget Extension
      • $core_v2_role Widget Extension
      • $core_v2_roleUsers Widget Extension
      • $core_v2_rssFeedItem Widget Extension
      • $core_v2_search Widget Extension
      • $core_v2_searchCategory Widget Extension
      • $core_v2_searchResult Widget Extension
      • $core_v2_servicePresence Widget Extension
      • $core_v2_sitePermissions Widget Extension
      • $core_v2_statusMessage Widget Extension
      • $core_v2_submittableEditor Widget Extension
      • $core_v2_systemNotification Widget Extension
      • $core_v2_taggedContent Widget Extension
      • $core_v2_tags Widget Extension
      • $core_v2_theme Widget Extension
      • $core_v2_themeFooter Widget Extension
      • $core_v2_themeHeader Widget Extension
      • $core_v2_themePage Widget Extension
      • $core_v2_tourTip Widget Extension
      • $core_v2_ui Widget Extension
      • $core_v2_uploadedFile Widget Extension
      • $core_v2_urls Widget Extension
      • $core_v2_user Widget Extension
      • $core_v2_userAchievement Widget Extension
      • $core_v2_userFile Widget Extension
      • $core_v2_userFolder Widget Extension
      • $core_v2_userInvitation Widget Extension
      • $core_v2_userPermission Widget Extension
      • $core_v2_userPresence Widget Extension
      • $core_v2_userProfileField Widget Extension
      • $core_v2_userProfileFieldGroup Widget Extension
      • $core_v2_userRecommendation Widget Extension
      • $core_v2_userValidation Widget Extension
      • $core_v2_utility Widget Extension
      • $core_v2_webhook Widget Extension
      • $core_v2_webhookEvent Widget Extension
      • $core_v2_widget Widget Extension
      • $core_v2_wiki Widget Extension
      • $core_v2_wikiConfiguration Widget Extension
      • $core_v2_wikiFiles Widget Extension
      • $core_v2_wikiPage Widget Extension
      • $core_v2_wikiPageCommentSubscriptions Widget Extension
      • $core_v2_wikiPageRevision Widget Extension
      • $core_v2_wikiPermissions Widget Extension
      • $core_v2_wikiToc Widget Extension
      • $core_v2_wikiUrls Widget Extension
      • $core_v3_feature Widget Extension
      • $geocoding_v1_core Widget Extension
      • $km_v1_categories Widget Extension
      • $km_v1_documents Widget Extension
      • $km_v1_knowledgeCollections Widget Extension
      • $km_v1_permissions Widget Extension
      • $km_v1_tags Widget Extension
      • $km_v1_urls Widget Extension
      • $telligentIdeas_v1_challenges Widget Extension
      • $telligentIdeas_v1_ideaCategories Widget Extension
      • $telligentIdeas_v1_ideaPermissions Widget Extension
      • $telligentIdeas_v1_ideas Widget Extension
      • $telligentIdeas_v1_ideaStatuses Widget Extension
      • $telligentIdeas_v1_statuses Widget Extension
      • $telligentIdeas_v1_urls Widget Extension
      • $telligentIdeas_v1_userVoteSummaries Widget Extension
      • $telligentIdeas_v1_votes Widget Extension

$core_v2_user Widget Extension


Enables scripted content fragments to use Users

Properties

NameTypeDescriptionDefaultOptions
AccessingUserAccessing user
ApplicationTypeIdGuidUsers application type identifier
ContainerTypeIdGuidUsers container type identifier
ContentTypeIdGuidUsers content type identifier
CurrentUserContextual user
FormerMemberNamestringThe username of the Former Member system account.
ThemeTypeIdGuidUsers theme type identifier
TotalLicensedintTotal number licensed users
UserContentViewTypeIdGuidId used to track a view to the a user

Methods

ChangePassword

Changes a user password

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintIdRequired
oldPasswordstringOld PasswordRequired
newPasswordstringNew PasswordRequired

Return Type

AdditionalInfo

Create

Creates a new user

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
usernamestringUsernameRequired
passwordstringPasswordRequired
privateEmailstringPrivate EmailRequired

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, "%{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
AcceptTermsOfServiceboolRegisters that a user has accepted the terms of service for this community when applicable. The default is false.Optional
AllowSitePartnersToContactboolAllow Site Partners To ContactOptional
AllowSiteToContactboolAllow Site To ContactOptional
BiostringBioOptional
BirthdayDateTimeBirthdayOptional
DisplayNamestringDisplay NameOptional
EnableEmailboolAllow user to receive emails.Optional
EnableFavoriteSharingboolAllow user's bookmarks to be viewed by others..Optional
EnableHtmlEmailboolAllow 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
ImportFromLdapboolImport From LdapOptional
JoinDateDateTimeJoin DateOptional
LanguagestringLanguageOptional
LocationstringLocationOptional
PublicEmailstringPublic EmailOptional
RssFeedsIList<string>Rss FeedsOptional
TimeZonedoubleTime ZoneOptional
TimeZoneIdstringTime Zone IdOptional
WebUrlstringWeb UrlOptional

Return Type

User

CreateFromLdap

Creates a new user from LDAP

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
usernamestringUsernameRequired

Return Type

User

CreateFromLdap

Creates a new user from LDAP

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
usernamestringUsernameRequired
privateEmailstringPrivate EmailRequired

Return Type

User

Delete

Deletes a user

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
DeleteAllContentboolIf 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
IdintEither Id or Username is required.Optional
ReassignedUserIdintReassign 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 accountr.Optional
UsernamestringEither Id or Username is required.Optional

Return Type

AdditionalInfo

Get

Gets a user

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
ContentIdGuidEither Id, ContentId, Email or Username is required.Optional
EmailstringEither Id, ContentId, Email or Username is required.Optional
IdintEither Id, ContentId, Email or Username is required.Optional
UsernamestringEither Id, ContentId, Email or Username is required.Optional

Return Type

User

HasActionLinks

Returns whether a user has action links

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintUser IdRequired

Return Type

bool

IsRegistered

Determines whether a user is registered

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintIdRequired

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
ContentIdsstringComma separated list of ContentIds. Used to limit to a specific set of users as well as sort order if SoryBy is set to ContentIdsOrder.Optional
EmailAddressstringUsed to limit to a specific user based on email address.Optional
IncludeHiddenboolBy 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
PageIndexintSpecify the page number of paged results to return. Zero-based index.Optional0
PageSizeintSpecify the number of results to return per page.Optional20
RoleIdintRole IdOptional
SortBystringSort ByOptionalContentIdsOrder, DisplayName, Email, JoinedDate, LastActiveDate, Posts, RecentPosts, Score:SCORE_ID, Username, Website
SortOrderstringSort OrderOptionalAscending, Descending
UsernamesstringUsed to limit to a specific set of users.Optional

Return Type

PagedList<User>

ListActionLinks

Returns action links for a user

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintUser IdRequired

Return Type

IList<UserActionLink>

Lookup

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
queryTextstringQuery TextRequired
PageSizeintSpecify the number of results to return per page.Optional20

Return Type

ApiList<User>

RequestExport

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.

Usage

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

Return Type

AdditionalInfo

RequestExport

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.

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
UserIdintThe user to export.Optional

Return Type

AdditionalInfo

Update

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

Usage

#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, EnableEmail = $enableEmailArg, EnableFavoriteSharing = $enableFavoriteSharingArg, EnableHtmlEmail = $enableHtmlEmailArg, EnablePresenceTracking = $enablePresenceTrackingArg, EnableUserSignatures = $enableUserSignaturesArg, ExtendedAttributes = $extendedAttributesArg, ForceLogin = $forceLoginArg, Gender = $genderArg, Id = $idArg, IsIgnored = $isIgnoredArg, Language = $languageArg, Location = $locationArg, ModerationLevel = $moderationLevelArg, NewPassword = $newPasswordArg, OldPassword = $oldPasswordArg, PrivateEmail = $privateEmailArg, PublicEmail = $publicEmailArg, RssFeeds = $rssFeedsArg, TimeZone = $timeZoneArg, Username = $usernameArg, WebUrl = $webUrlArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
AcceptTermsOfServiceboolRegisters 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
AllowSitePartnersToContactboolAllow Site Partners To ContactOptional
AllowSiteToContactboolAllow 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
EnableEmailboolAllow user to receive emails.Optional
EnableFavoriteSharingboolAllow user's bookmarks to be viewed by others.Optional
EnableHtmlEmailboolAllow user to receive emails in the HTML format.Optional
EnablePresenceTrackingboolAllow presence tracking and reporting.Optional
EnableUserSignaturesboolEnable 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
ForceLoginboolForce LoginOptional
GenderstringGenderOptionalFemale, Male, NotSet
IdintEither Id or Username is required.Optional
IsIgnoredboolIs IgnoredOptional
LanguagestringLanguageOptional
LocationstringLocationOptional
ModerationLevelstringModeration LevelOptionalModerated, Unmoderated
NewPasswordstringNew PasswordOptional
OldPasswordstringRequired if changing the password.Optional
PrivateEmailstringPrivate EmailOptional
PublicEmailstringPublic EmailOptional
RssFeedsIList<string>Rss FeedsOptional
TimeZonedoubleTime ZoneOptional
UsernamestringEither Id or Username is required.Optional
WebUrlstringWeb UrlOptional

Return Type

User


  • 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 2021 Verint, Inc.
Powered by Verint Community