CustomAuthStart Event

Reports the beginning of a custom authentication method.

Syntax

public open class DefaultAuthenticatorEventListener : AuthenticatorEventListener {
  ...
  public override fun customAuthStart(e: AuthenticatorCustomAuthStartEvent) {}
  ...
}

public class AuthenticatorCustomAuthStartEvent {
  val userID: String?
  val authMethod: String?
  var authMethodPars: String?
  var authMethodData: String?
}

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.