Package com.mongodb.stitch.server.core.auth.providers.userpassword

Interface UserPasswordAuthProviderClient

All Known Implementing Classes:

UserPasswordAuthProviderClientImpl

public interface UserPasswordAuthProviderClient

The User/Password authentication provider client used to register users.

Field Summary

Fields

Modifier and Type	Field	Description
static AuthProviderClientFactory<UserPasswordAuthProviderClient>	factory

Method Summary

Modifier and Type	Method	Description
void	callResetPasswordFunction(String email, String password, List<?> args)	Call a reset password function configured to the provider.
void	confirmUser(String token, String tokenId)	Confirms a user with the given token and token id.
void	registerWithEmail(String email, String password)	Registers a new user with the given email and password.
void	resendConfirmationEmail(String email)	Resend the confirmation for a user to the given email.
void	resetPassword(String token, String tokenId, String password)	Resets the password of a user with the given token, token id, and new password.
void	sendResetPasswordEmail(String email)	Sends a user a password reset email for the given email.

Field Detail

factory

static final AuthProviderClientFactory<UserPasswordAuthProviderClient> factory

Method Detail

registerWithEmail

void registerWithEmail(String email,
                       String password)

Registers a new user with the given email and password.

Parameters:

email - the email to register with. This will be the username used during log in.

password - the password to associated with the email. The password must be between 6 and 128 characters long.

confirmUser

void confirmUser(String token,
                 String tokenId)

Confirms a user with the given token and token id.

Parameters:

token - the confirmation token.

tokenId - the id of the confirmation token.

resendConfirmationEmail

void resendConfirmationEmail(String email)

Resend the confirmation for a user to the given email.

Parameters:

email - the email of the user.

resetPassword

void resetPassword(String token,
                   String tokenId,
                   String password)

Resets the password of a user with the given token, token id, and new password.

Parameters:

token - the reset password token.

tokenId - the id of the reset password token.

password - the new password for the user. The password must be between 6 and 128 characters long.

sendResetPasswordEmail

void sendResetPasswordEmail(String email)

Sends a user a password reset email for the given email.

Parameters:

email - the email of the user.

callResetPasswordFunction

void callResetPasswordFunction(String email,
                               String password,
                               List<?> args)

Call a reset password function configured to the provider.

Parameters:

email - the email of the user

password - the new password to set

args - arguments to be provided to the reset function