authenticate

abstract suspend fun authenticate(parameters: Passwords.AuthParameters): AuthResponse

Authenticate a member with their email address and password. This endpoint verifies that the member has a password currently set, and that the entered password is correct.

There are two instances where the endpoint will return a reset_password error even if they enter their previous password:

  1. The member's credentials appeared in the HaveIBeenPwned dataset. We force a password reset to ensure that the member is the legitimate owner of the email address, and not a malicious actor abusing the compromised credentials.

  2. The member used email based authentication (e.g. Magic Links, Google OAuth) for the first time, and had not previously verified their email address for password based login. We force a password reset in this instance in order to safely deduplicate the account by email address, without introducing the risk of a pre-hijack account-takeover attack.

Return

AuthResponse

Parameters

parameters

required to authenticate


abstract fun authenticate(parameters: Passwords.AuthParameters, callback: (AuthResponse) -> Unit)

Authenticate a member with their email address and password. This endpoint verifies that the member has a password currently set, and that the entered password is correct.

There are two instances where the endpoint will return a reset_password error even if they enter their previous password:

  1. The member's credentials appeared in the HaveIBeenPwned dataset. We force a password reset to ensure that the member is the legitimate owner of the email address, and not a malicious actor abusing the compromised credentials.

  2. The member used email based authentication (e.g. Magic Links, Google OAuth) for the first time, and had not previously verified their email address for password based login. We force a password reset in this instance in order to safely deduplicate the account by email address, without introducing the risk of a pre-hijack account-takeover attack.

Parameters

parameters

required to authenticate

callback

a callback that receives an AuthResponse