Passwords

interface Passwords

The Passwords interface provides methods for authenticating, creating, resetting, and performing strength checks of passwords.

Stytch supports creating, storing, and authenticating passwords, as well as support for account recovery (password reset) and account deduplication with passwordless login methods.

Our implementation of passwords has built-in breach detection powered by HaveIBeenPwned on both sign-up and login, to prevent the use of compromised credentials and uses configurable strength requirements (either Dropbox’s zxcvbn or adjustable LUDS) to guide members towards creating passwords that are easy for humans to remember but difficult for computers to crack.

Types

Link copied to clipboard
data class AuthParameters(val email: String, val password: String, val sessionDurationMinutes: UInt = DEFAULT_SESSION_TIME_MINUTES)

Data class used for wrapping parameters used with Passwords authentication

Link copied to clipboard
data class CreateParameters(val email: String, val password: String, val sessionDurationMinutes: UInt = DEFAULT_SESSION_TIME_MINUTES)

Data class used for wrapping parameters used with Passwords create endpoint

Link copied to clipboard
data class ResetByEmailParameters(val token: String, val password: String, val sessionDurationMinutes: UInt = DEFAULT_SESSION_TIME_MINUTES)

Data class used for wrapping parameters used with Passwords ResetByEmail endpoint

Link copied to clipboard
data class ResetByEmailStartParameters(val email: String, val loginRedirectUrl: String? = null, val loginExpirationMinutes: UInt? = null, val resetPasswordRedirectUrl: String? = null, val resetPasswordExpirationMinutes: UInt? = null, val resetPasswordTemplateId: String? = null) : Parcelable

Data class used for wrapping parameters used with Passwords ResetByEmailStart endpoint

Link copied to clipboard
data class ResetByExistingPasswordParameters(val email: String, val existingPassword: String, val newPassword: String, val sessionDurationMinutes: UInt = DEFAULT_SESSION_TIME_MINUTES)

Data class used for wrapping parameters used with Passwords StrengthCheck endpoint

Link copied to clipboard
data class ResetBySessionParameters(val password: String, val sessionDurationMinutes: UInt = DEFAULT_SESSION_TIME_MINUTES)

Data class used for wrapping parameters used with Passwords StrengthCheck endpoint

Link copied to clipboard
data class StrengthCheckParameters(val email: String?, val password: String)

Data class used for wrapping parameters used with Passwords StrengthCheck endpoint

Functions

Link copied to clipboard
abstract suspend fun authenticate(parameters: Passwords.AuthParameters): AuthResponse
abstract fun authenticate(parameters: Passwords.AuthParameters, callback: (AuthResponse) -> Unit)

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

Link copied to clipboard
abstract suspend fun create(parameters: Passwords.CreateParameters): PasswordsCreateResponse
abstract fun create(parameters: Passwords.CreateParameters, callback: (PasswordsCreateResponse) -> Unit)

Create a new user with a password and an authenticated session for the user if requested. If a user with this email already exists in the project, this method will return an error.

Link copied to clipboard
abstract fun resetByEmail(parameters: Passwords.ResetByEmailParameters, callback: (AuthResponse) -> Unit)

Reset the user’s password and authenticate them. This endpoint checks that the magic link token is valid, hasn’t expired, or already been used. The provided password needs to meet our password strength requirements, which can be checked in advance with the strengthCheck method. If the token and password are accepted, the password is securely stored for future authentication and the user is authenticated.

Link copied to clipboard

Initiates a password reset for the email address provided. This will trigger an email to be sent to the address, containing a magic link that will allow them to set a new password and authenticate.

Link copied to clipboard

Reset a user's password and authenticate them

Link copied to clipboard
abstract fun resetBySession(parameters: Passwords.ResetBySessionParameters, callback: (AuthResponse) -> Unit)

Reset the user’s password and authenticate them. This endpoint checks that the session is valid and hasn’t expired or been revoked. The provided password needs to meet our password strength requirements, which can be checked in advance with the password strength endpoint. If the password and accompanying parameters are accepted, the password is securely stored for future authentication and the user is authenticated.

Link copied to clipboard

This method allows you to check whether or not the user’s provided password is valid, and to provide feedback to the user on how to increase the strength of their password.