on_auth_verify Event

Requests the application to validate an authentication token.

Syntax

class AuthenticatorAuthVerifyEventParams(object):
  @property
  def user_id() -> str: ...
  @property
  def auth_method() -> str: ...
  @property
  def auth_token() -> str: ...
  @property
  def auth_method_data() -> str: ...
  @property
  def valid() -> bool: ...
  @valid.setter
  def valid(value) -> None: ...

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

Remarks

Class fires this event to ask the application to validate an authentication token that it can't validate automatically. This can happen if UserID was not found in the user database or a custom authentication method is used.

AuthMethod and AuthToken specify the authentication method being used and the authentication token provided by the user. AuthMethodData contains an application-specific data provided by the application at the beginning of the authentication step.

An event handler subscribed to this event should validate the authentication token provided by the user and set the Valid parameter accordingly.