AuthStart Event

Signifies the start of an authentication process.

Syntax

• C#
• VB.NET

public event OnAuthStartHandler OnAuthStart;

public delegate void OnAuthStartHandler(object sender, AuthenticatorAuthStartEventArgs e);

public class AuthenticatorAuthStartEventArgs : EventArgs {
  public string UserID { get; }
  public string AuthMethods { get; set; }
}

Public Event OnAuthStart As OnAuthStartHandler

Public Delegate Sub OnAuthStartHandler(sender As Object, e As AuthenticatorAuthStartEventArgs)

Public Class AuthenticatorAuthStartEventArgs Inherits EventArgs
  Public ReadOnly Property UserID As String
  Public Property AuthMethods As String
End Class

Remarks

This event is fired in response to a StartAuth call, and signifies the start of a (potentially, multi-step) authentication process for UserID. The AuthMethods parameter list the methods to be performed for the user. The application may customize them as needed.

The following default authentication methods are supported:

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

The application can define its own authentication methods if needed.

This event is only fired once per user authentication process, at the very start of it. See AuthAttemptStart for per-step notification.