on_custom_auth_start Event
Reports the beginning of a custom authentication method.
Syntax
class AuthenticatorCustomAuthStartEventParams(object): @property def user_id() -> str: ... @property def auth_method() -> str: ... @property def auth_method_pars() -> str: ... @auth_method_pars.setter def auth_method_pars(value) -> None: ... @property def auth_method_data() -> str: ... @auth_method_data.setter def auth_method_data(value) -> None: ... # In class Authenticator: @property def on_custom_auth_start() -> Callable[[AuthenticatorCustomAuthStartEventParams], None]: ... @on_custom_auth_start.setter def on_custom_auth_start(event_hook: Callable[[AuthenticatorCustomAuthStartEventParams], None]) -> None: ...
Remarks
This event marks the start of an authentication method not supported by class internally and requests authentication parameters from the application.
Class 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 default_auth_methods property, or provide on the fly via on_auth_start event.
The event handler may return authentication parameters and application-specific data to be associated with the authentication attempt via AuthMethodPars and AuthMethodData parameters.