on_auth_attempt_result Event

Reports the outcome of an authentication attempt.

Syntax

class AuthenticatorAuthAttemptResultEventParams(object):
  @property
  def user_id() -> str: ...
  @property
  def auth_method() -> str: ...
  @property
  def auth_res() -> int: ...
  @auth_res.setter
  def auth_res(value) -> None: ...
  @property
  def remaining_auth_methods() -> str: ...
  @remaining_auth_methods.setter
  def remaining_auth_methods(value) -> None: ...

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

Remarks

This event follows a call to continue_auth method and reports the user's updated authentication status following the token verification.

The updated status is reported via the AuthRes parameter, and can take one of the following values:

The RemainingAuthMethods parameter lists the authentication methods that the user is yet to go through. The application can change either of AuthRes and RemainingAuthMethods in the event handler to alter the authentication flow.