CustomAuthStart Event

Reports the beginning of a custom authentication method.

Syntax

authenticator.on('CustomAuthStart', [callback])

Callback

The 'callback' is called when the 'CustomAuthStart' event is emited.

function(e){ }

The argument 'e' has the following properties:

e.userID
e.authMethod
e.authMethodPars
e.authMethodData

Remarks

This event marks the start of an authentication method not supported by class internally and requests authentication parameters from the application.

Class currently supports the following authentication methods:

• password
• otp-h
• otp-t
• dcauth

The application may also use any number of custom authentication method it wants. Each such method is identified by a unique string name (such as 'pin', 'fingerprint', or 'fingerprint-v2'). It may specify them in DefaultAuthMethods property, or provide on the fly via AuthStart event.

The event handler may return authentication parameters and application-specific data to be associated with the authentication attempt via AuthMethodPars and AuthMethodData parameters.