AuthAttemptStart Event

Signifies the start of an authentication attempt.

Syntax

• C#
• VB.NET

public event OnAuthAttemptStartHandler OnAuthAttemptStart;

public delegate void OnAuthAttemptStartHandler(object sender, AuthenticatorAuthAttemptStartEventArgs e);

public class AuthenticatorAuthAttemptStartEventArgs : EventArgs {
  public string UserID { get; }
  public string AuthMethod { get; }
  public string RemainingAuthMethods { get; }
}

Public Event OnAuthAttemptStart As OnAuthAttemptStartHandler

Public Delegate Sub OnAuthAttemptStartHandler(sender As Object, e As AuthenticatorAuthAttemptStartEventArgs)

Public Class AuthenticatorAuthAttemptStartEventArgs Inherits EventArgs
  Public ReadOnly Property UserID As String
  Public ReadOnly Property AuthMethod As String
  Public ReadOnly Property RemainingAuthMethods As String
End Class

Remarks

This event reports the start of an atomic authentication step. The AuthMethod parameter contains the authentication method that has started. The following authentication methods are currently supported, but the application may define its own methods in AuthStart, and tune them up in CustomAuthStart:

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

This event is thrown from StartAuth and ContinueAuth methods.