on_auth_start Event

Signifies the start of an authentication process.

Syntax

class AuthenticatorAuthStartEventParams(object):
  @property
  def user_id() -> str: ...
  @property
  def auth_methods() -> str: ...
  @auth_methods.setter
  def auth_methods(value) -> None: ...

# In class Authenticator:
@property
def on_auth_start() -> Callable[[AuthenticatorAuthStartEventParams], None]: ...
@on_auth_start.setter
def on_auth_start(event_hook: Callable[[AuthenticatorAuthStartEventParams], None]) -> None: ...

Remarks

This event is fired in response to a start_auth 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 on_auth_attempt_start for per-step notification.