CustomAuthStart Event

Reports the beginning of a custom authentication method.

Syntax

• C#
• VB.NET

public event OnCustomAuthStartHandler OnCustomAuthStart;

public delegate void OnCustomAuthStartHandler(object sender, AuthenticatorCustomAuthStartEventArgs e);

public class AuthenticatorCustomAuthStartEventArgs : EventArgs {
  public string UserID { get; }
  public string AuthMethod { get; }
  public string AuthMethodPars { get; set; }
  public string AuthMethodData { get; set; }
}

Public Event OnCustomAuthStart As OnCustomAuthStartHandler

Public Delegate Sub OnCustomAuthStartHandler(sender As Object, e As AuthenticatorCustomAuthStartEventArgs)

Public Class AuthenticatorCustomAuthStartEventArgs Inherits EventArgs
  Public ReadOnly Property UserID As String
  Public ReadOnly Property AuthMethod As String
  Public Property AuthMethodPars As String
  Public Property AuthMethodData As String
End Class

Remarks

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

Component 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.