Stytch Kotlin/com.stytch.sdk.consumer.passwords/Passwords

Passwords

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

Types

AuthParameters

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

CreateParameters

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

ResetByEmailParameters

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

ResetByEmailStartParameters

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)

Data class used for wrapping parameters used with Passwords ResetByEmailStart endpoint

StrengthCheckParameters

data class StrengthCheckParameters(val email: String?, val password: String)

Data class used for wrapping parameters used with Passwords StrengthCheck endpoint

Functions

authenticate

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.

create

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.

resetByEmail

abstract suspend fun resetByEmail(parameters: Passwords.ResetByEmailParameters): AuthResponse

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.

resetByEmailStart

abstract suspend fun resetByEmailStart(parameters: Passwords.ResetByEmailStartParameters): BaseResponse

abstract fun resetByEmailStart(parameters: Passwords.ResetByEmailStartParameters, callback: (BaseResponse) -> Unit)

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.

strengthCheck

abstract suspend fun strengthCheck(parameters: Passwords.StrengthCheckParameters): PasswordsStrengthCheckResponse

abstract fun strengthCheck(parameters: Passwords.StrengthCheckParameters, callback: (PasswordsStrengthCheckResponse) -> Unit)

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.