Class: TSAccountProtection

Constructors

constructor

new TSAccountProtection(clientId, options?)

Creates a new Account Protection SDK instance with your client context

Parameters

Name Type Description
clientId string Your AccountProtection client identifier
options? ConstructorOptions SDK configuration options

Methods

init

init(options?): Promise<boolean>

Initializes the AccountProtection SDK, which starts automatically tracking and submitting info of the user journey

Parameters

Name Type Description
options? string | InitOptions Init options

Returns

Promise<boolean>

Indicates if the call succeeded


triggerActionEvent

triggerActionEvent(actionType, options?): Promise<ActionResponse>

Reports a user action event to the SDK

Parameters

Name Type Description
actionType string Type of user action event that was predefined in the Mosaic server
options ActionEventOptions -

Returns

Promise<ActionResponse>

Indicates if the call succeeded


setAuthenticatedUser

setAuthenticatedUser(userId, options?): Promise<boolean>

Sets the user context for all subsequent events in the browser session (or until the user is explicitly cleared) It should be set only after you've fully authenticated the user (including, for example, any 2FA that was required)

Parameters

Name Type Description
userId string Opaque identifier of the user in your system
options Object Reserved for future use

Returns

Promise<boolean>

Indicates if the call succeeded


clearUser

clearUser(options?): Promise<boolean>

Clears the user context for all subsequent events in the browser session

Parameters

Name Type Description
options Object Reserved for future use

Returns

Promise<boolean>

Indicates if the call succeeded