Manage Email/Password Users - Web SDK

Complete a User Confirmation

You need a valid token and tokenId for a registered user in order to confirm them and allow them to log in. These values are available in different places depending on the provider configuration:

• If the provider is set to send a confirmation email, the token and tokenId values are included as query parameters in the Email Confirmation URL.

• If the provider is set to run a confirmation function, the token and tokenId values are passed to the function as arguments.

To confirm a registered user, call the confirmUser() method with the user's valid token and tokenId:

await app.emailPasswordAuth.confirmUser({ token, tokenId });

Resend a Confirmation Email

To resend the confirmation email to a user, call the resendConfirmationEmail() method with the user's email address:

const email = "someone@example.com"; // The user's email address
await app.emailPasswordAuth.resendConfirmationEmail({ email });

Retry a User Confirmation Function

To re-run your custom confirmation function, call the retryCustomConfirmation() method with the user's email address:

const email = "someone@example.com"; // The user's email address
await app.emailPasswordAuth.retryCustomConfirmation({ email });

Send a Password Reset Email

If the provider is configured to send a password reset email, you can use the SDK to send a password reset email to a user. The email contains a link to the configured Password Reset URL.

// The user's email address
const email = "joe.jasper@example.com";
await app.emailPasswordAuth.sendResetPasswordEmail({ email });

Call a Password Reset Function

If the provider is configured to run a password reset function, you can use the SDK to run the function. Pass an object with the user's email and new password. You can also include additional arguments to use in the password reset function in the App Services backend.

// The user's email address
const email = "joe.jasper@example.com";
// The new password to use
const password = "newPassw0rd";
// Additional arguments for the reset function
const args = [];
await app.emailPasswordAuth.callResetPasswordFunction(
  { email, password },
  ...args
);

Complete a Password Reset

Once a user requests a password reset, either by sending a password reset email or calling a password reset function, Realm generates a pair of unique token and tokenId values that they can use to complete the password reset within 30 minutes of the initial request.

await app.emailPasswordAuth.resetPassword({
  password: "newPassw0rd",
  token,
  tokenId,
});

const params = new URLSearchParams(window.location.search);
const token = params.get("token");
const tokenId = params.get("tokenId");
if (!token || !tokenId) {
  throw new Error(
    "You can only call resetPassword() if the user followed a confirmation email link"
  );
}