on_auth_password Event

This event is fired on password authentication attempt from a client.

Syntax

class SFTPServerAuthPasswordEventParams(object):
  @property
  def connection_id() -> int: ...
  @property
  def username() -> str: ...
  @property
  def password() -> str: ...
  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...
  @property
  def force_change_password() -> bool: ...
  @force_change_password.setter
  def force_change_password(value) -> None: ...

# In class SFTPServer:
@property
def on_auth_password() -> Callable[[SFTPServerAuthPasswordEventParams], None]: ...
@on_auth_password.setter
def on_auth_password(event_hook: Callable[[SFTPServerAuthPasswordEventParams], None]) -> None: ...

Remarks

Parameters Username and Password contain user credentials. If they are correct, set Accept to true. You can request password change by setting ForceChangePassword to true.