core_v2_authentication Script API

Verint | Telligent Community — Wed, 14 May 2025 17:07:33 GMT

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

Enables scripted content fragments to perform authorization tasks and retrieve OAuth data.

Properties

Name	Access	Type	Description
Current	Read	`[[AuthenticationDetails Script API Type\|AuthenticationDetails]]`	Provides information regarding the currently authenticated user.

Methods

ChangePassword

Changes the password of the accessing user

Velocity

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

JavaScript

var additionalInfoResponse = core_v2_authentication.ChangePassword(oldPassword, newPassword);

Parameters

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

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

ChangePasswordUsingToken

Changes the password of the token-verified user

Velocity

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

JavaScript

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

Parameters

Name	Type	Description	Required	Default	Options
token	`[[String Script API Type\|String]]`	Context token for verifying user identity	Required
newPassword	`[[String Script API Type\|String]]`	New Password	Required

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

CreateLoginAndRedirect

CreateLoginAndRedirect Overload 1

Creates a new user from explicit credentials, logs the user in, and redirects to a redirectUrl

Velocity

#set($booleanResponse = $core_v2_authentication.CreateLoginAndRedirect($username, $password, $privateEmail, $rememberUser, $redirectUrl, "%{ AcceptTermsOfService = $acceptTermsOfServiceArg, AllowSitePartnersToContact = $allowSitePartnersToContactArg, AllowSiteToContact = $allowSiteToContactArg, Bio = $bioArg, Birthday = $birthdayArg, DisplayName = $displayNameArg, EnableEmail = $enableEmailArg, EnableHtmlEmail = $enableHtmlEmailArg, Gender = $genderArg, Language = $languageArg, Location = $locationArg, PublicEmail = $publicEmailArg, RssFeeds = $rssFeedsArg, TimeZone = $timeZoneArg, WebUrl = $webUrlArg }"))

JavaScript

var booleanResponse = core_v2_authentication.CreateLoginAndRedirect(username, password, privateEmail, rememberUser, redirectUrl, { AcceptTermsOfService: acceptTermsOfServiceArg, AllowSitePartnersToContact: allowSitePartnersToContactArg, AllowSiteToContact: allowSiteToContactArg, Bio: bioArg, Birthday: birthdayArg, DisplayName: displayNameArg, EnableEmail: enableEmailArg, EnableHtmlEmail: enableHtmlEmailArg, Gender: genderArg, Language: languageArg, Location: locationArg, PublicEmail: publicEmailArg, RssFeeds: rssFeedsArg, TimeZone: timeZoneArg, WebUrl: webUrlArg });

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
rememberUser	`[[Boolean Script API Type\|Boolean]]`	Remember User	Required
redirectUrl	`[[String Script API Type\|String]]`	Redirect Url	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]]`	Bio	Optional
Birthday	`[[DateTime Script API Type\|DateTime]]`	Birthday	Optional
DisplayName	`[[String Script API Type\|String]]`	Display Name	Optional
EnableEmail	`[[Boolean Script API Type\|Boolean]]`	Allow user to receive emails.	Optional
EnableHtmlEmail	`[[Boolean Script API Type\|Boolean]]`	Allow user to receive emails in the HTML format.	Optional
Gender	`[[String Script API Type\|String]]`	Gender	Optional
Language	`[[String Script API Type\|String]]`	Language	Optional
Location	`[[String Script API Type\|String]]`	Location	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]]`	Time Zone	Optional
WebUrl	`[[String Script API Type\|String]]`	Web Url	Optional

CreateLoginAndRedirect Overload 2

Creates a new user from an external authentication data token, logs the user in, and redirects to a redirectUrl

Velocity

#set($booleanResponse = $core_v2_authentication.CreateLoginAndRedirect($externalUserDataToken, $rememberUser, $redirectUrl, "%{ AcceptTermsOfService = $acceptTermsOfServiceArg, AllowSitePartnersToContact = $allowSitePartnersToContactArg, AllowSiteToContact = $allowSiteToContactArg, Bio = $bioArg, Birthday = $birthdayArg, DisplayName = $displayNameArg, Email = $emailArg, Gender = $genderArg, Language = $languageArg, Location = $locationArg, PublicEmail = $publicEmailArg, RssFeeds = $rssFeedsArg, TimeZone = $timeZoneArg, WebUrl = $webUrlArg }"))

JavaScript

var booleanResponse = core_v2_authentication.CreateLoginAndRedirect(externalUserDataToken, rememberUser, redirectUrl, { AcceptTermsOfService: acceptTermsOfServiceArg, AllowSitePartnersToContact: allowSitePartnersToContactArg, AllowSiteToContact: allowSiteToContactArg, Bio: bioArg, Birthday: birthdayArg, DisplayName: displayNameArg, Email: emailArg, Gender: genderArg, Language: languageArg, Location: locationArg, PublicEmail: publicEmailArg, RssFeeds: rssFeedsArg, TimeZone: timeZoneArg, WebUrl: webUrlArg });

Parameters

Name	Type	Description	Required
externalUserDataToken	`[[String Script API Type\|String]]`	External User Data Token	Required
rememberUser	`[[Boolean Script API Type\|Boolean]]`	Remember User	Required
redirectUrl	`[[String Script API Type\|String]]`	Redirect Url	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]]`	Bio	Optional
Birthday	`[[DateTime Script API Type\|DateTime]]`	Birthday	Optional
DisplayName	`[[String Script API Type\|String]]`	Display Name	Optional
Email	`[[String Script API Type\|String]]`	Email	Optional
Gender	`[[String Script API Type\|String]]`	Gender	Optional
Language	`[[String Script API Type\|String]]`	Language	Optional
Location	`[[String Script API Type\|String]]`	Location	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]]`	Time Zone	Optional
WebUrl	`[[String Script API Type\|String]]`	Web Url	Optional

Returns

[[Boolean Script API Type|Boolean]]

GetExternalLinkedAuthenticationProvider

Velocity

#set($externalLinkedAuthenticationProviderResponse = $core_v2_authentication.GetExternalLinkedAuthenticationProvider($id))

JavaScript

var externalLinkedAuthenticationProviderResponse = core_v2_authentication.GetExternalLinkedAuthenticationProvider(id);

Parameters

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

Returns

[[ExternalLinkedAuthenticationProvider Script API Type|ExternalLinkedAuthenticationProvider]]

GetExternalLinkedAuthenticationUserData

Velocity

#set($externalLinkedAuthenticationUserDataResponse = $core_v2_authentication.GetExternalLinkedAuthenticationUserData($externalUserDataToken))

JavaScript

var externalLinkedAuthenticationUserDataResponse = core_v2_authentication.GetExternalLinkedAuthenticationUserData(externalUserDataToken);

Parameters

Name	Type	Description	Required	Default	Options
externalUserDataToken	`[[String Script API Type\|String]]`	External User Data Token	Required

Returns

[[ExternalLinkedAuthenticationUserData Script API Type|ExternalLinkedAuthenticationUserData]]

GetLastLoginType

Returns the last login type for the accessing user

Velocity

#set($stringResponse = $core_v2_authentication.GetLastLoginType())

JavaScript

var stringResponse = core_v2_authentication.GetLastLoginType();

Returns

[[String Script API Type|String]]

Impersonator

Returns the user performing impersonation of the accessing user

Velocity

#set($userResponse = $core_v2_authentication.Impersonator())

JavaScript

var userResponse = core_v2_authentication.Impersonator();

Returns

[[User Script API Type|User]]

IsAuthorizationRequest

Returns whether the current request is an authorization request by an OAuth client

Velocity

#set($booleanResponse = $core_v2_authentication.IsAuthorizationRequest())

JavaScript

var booleanResponse = core_v2_authentication.IsAuthorizationRequest();

Returns

[[Boolean Script API Type|Boolean]]

IsImpersonated

Returns whether the accessing user is impersonated

Velocity

#set($booleanResponse = $core_v2_authentication.IsImpersonated())

JavaScript

var booleanResponse = core_v2_authentication.IsImpersonated();

Returns

[[Boolean Script API Type|Boolean]]

LinkLoginAndRedirect

Authenticates an existing user, links the user to an external account, and redirects to a redirectUrl

Velocity

#set($booleanResponse = $core_v2_authentication.LinkLoginAndRedirect($externalUserDataToken, $userName, $password, $rememberUser, $redirectUrl))

JavaScript

var booleanResponse = core_v2_authentication.LinkLoginAndRedirect(externalUserDataToken, userName, password, rememberUser, redirectUrl);

Parameters

Name	Type	Description	Required
externalUserDataToken	`[[String Script API Type\|String]]`	External User Data Token	Required
userName	`[[String Script API Type\|String]]`	User Name	Required
password	`[[String Script API Type\|String]]`	Password	Required
rememberUser	`[[Boolean Script API Type\|Boolean]]`	Remember User	Required
redirectUrl	`[[String Script API Type\|String]]`	Redirect Url	Required

Returns

[[Boolean Script API Type|Boolean]]

ListExternalLinkedAuthenticationProviders

Velocity

#set($listResponse = $core_v2_authentication.ListExternalLinkedAuthenticationProviders())

JavaScript

var listResponse = core_v2_authentication.ListExternalLinkedAuthenticationProviders();

Returns

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

LoginAndRedirect

LoginAndRedirect Overload 1

Logs a user in via credentials and redirects to a redirect URL

Velocity

#set($booleanResponse = $core_v2_authentication.LoginAndRedirect($userName, $password, $rememberUser, $redirectUrl))

JavaScript

var booleanResponse = core_v2_authentication.LoginAndRedirect(userName, password, rememberUser, redirectUrl);

Parameters

Name	Type	Description	Required
userName	`[[String Script API Type\|String]]`	User Name	Required
password	`[[String Script API Type\|String]]`	Password	Required
rememberUser	`[[Boolean Script API Type\|Boolean]]`	Remember User	Required
redirectUrl	`[[String Script API Type\|String]]`	Redirect Url	Required

LoginAndRedirect Overload 2

Logs a user in via an external authentication provider token and redirects a redirect URL

Velocity

#set($booleanResponse = $core_v2_authentication.LoginAndRedirect($externalUserDataToken, $rememberUser, $redirectUrl))

JavaScript

var booleanResponse = core_v2_authentication.LoginAndRedirect(externalUserDataToken, rememberUser, redirectUrl);

Parameters

Name	Type	Description	Required
externalUserDataToken	`[[String Script API Type\|String]]`	External User Data Token	Required
rememberUser	`[[Boolean Script API Type\|Boolean]]`	Remember User	Required
redirectUrl	`[[String Script API Type\|String]]`	Redirect Url	Required

Returns

[[Boolean Script API Type|Boolean]]

Logout

Unauthenticates the accessing user

Velocity

#set($stringResponse = $core_v2_authentication.Logout())

JavaScript

var stringResponse = core_v2_authentication.Logout();

Returns

[[String Script API Type|String]]

RedirectToAuthenticationLink

Redirects the accessing user to an external authentication provider's authentication form

Velocity

#set($booleanResponse = $core_v2_authentication.RedirectToAuthenticationLink($providerId, $callbackUrl, $userDataTokenName))

JavaScript

var booleanResponse = core_v2_authentication.RedirectToAuthenticationLink(providerId, callbackUrl, userDataTokenName);

Parameters

Name	Type	Description	Required
providerId	`[[String Script API Type\|String]]`	External authentication type/id	Required
callbackUrl	`[[String Script API Type\|String]]`	URL to return to after the OAuth process completes	Required
userDataTokenName	`[[String Script API Type\|String]]`	User data token key name. Data about the user and their external authentication provider will be available via this parameter after the authentication process completes	Required

Returns

[[Boolean Script API Type|Boolean]]

RedirectToLogin

Redirects to the Login Form

Velocity

$core_v2_authentication.RedirectToLogin()

JavaScript

core_v2_authentication.RedirectToLogin();

Returns

Nothing

RequireOriginalPasswordWhenChangingPassword

Returns whether an original password is required to change a password based on the presence of a password reset token

Velocity

#set($booleanResponse = $core_v2_authentication.RequireOriginalPasswordWhenChangingPassword())

JavaScript

var booleanResponse = core_v2_authentication.RequireOriginalPasswordWhenChangingPassword();

Returns

[[Boolean Script API Type|Boolean]]

ResetPassword

ResetPassword Overload 1

Resets the password for a user

Velocity

#set($additionalInfoResponse = $core_v2_authentication.ResetPassword($userId))

JavaScript

var additionalInfoResponse = core_v2_authentication.ResetPassword(userId);

Parameters

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

ResetPassword Overload 2

Resets the password for a user by email address

Velocity

#set($additionalInfoResponse = $core_v2_authentication.ResetPassword($email))

JavaScript

var additionalInfoResponse = core_v2_authentication.ResetPassword(email);

Parameters

Name	Type	Description	Required	Default	Options
email	`[[String Script API Type\|String]]`	Email	Required

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

SendChangePasswordEmail

SendChangePasswordEmail Overload 1

Sends a password change email

Velocity

#set($additionalInfoResponse = $core_v2_authentication.SendChangePasswordEmail($userId))

JavaScript

var additionalInfoResponse = core_v2_authentication.SendChangePasswordEmail(userId);

Parameters

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

SendChangePasswordEmail Overload 2

Sends a password change email for a given email address

Velocity

#set($additionalInfoResponse = $core_v2_authentication.SendChangePasswordEmail($email))

JavaScript

var additionalInfoResponse = core_v2_authentication.SendChangePasswordEmail(email);

Parameters

Name	Type	Description	Required	Default	Options
email	`[[String Script API Type\|String]]`	Email	Required

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

ToString

Velocity

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

JavaScript

var stringResponse = core_v2_authentication.ToString();

Returns

[[String Script API Type|String]]