Manage Email/Password Users - Node.js 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, pass a valid token and tokenId to EmailPasswordAuth.confirmUser().

const token = "someToken";
const tokenId = "someTokenId";
try {
  await app.emailPasswordAuth.confirmUser({ token, tokenId });
  // User email address confirmed.
  console.log("Successfully confirmed user.");
} catch (err) {
  console.log(`User confirmation failed: ${err}`);
}

Resend a Confirmation Email

If the provider is configured to send a confirmation email, Atlas App Services automatically sends a confirmation email when a user registers. The email contains a link to the configured Email Confirmation URL with a token that is valid for 30 minutes. If a user does not follow the link and confirm within that period, they must request a new confirmation email.

To send a new confirmation email to a user, pass their email address to EmailPasswordAuth.resendConfirmationEmail().

const email = "someone@example.com";
await app.emailPasswordAuth.resendConfirmation({ 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";
await app.emailPasswordAuth.retryCustomConfirmation({ email });

Send a Password Reset Email

To send password reset emails to confirm the user's identity, you must configure your App to send a password reset email.

To begin the password reset process, call EmailPasswordAuth.sendResetPasswordEmail() with the user's email. The email contains a link to the configured Password Reset URL. The user must visit this URL within 30 minutes to confirm the reset.

const email = "someone@example.com";
await app.emailPasswordAuth.sendResetPasswordEmail({ email });

After the user has visited the URL from the password reset email, call EmailPasswordAuth.resetPassword() with the user's email, the new password, and the token and tokenId provided in the unique URL.

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

If the user does not visit the URL from the password reset email within 30 minutes, the token and tokenId expire. You must begin the password reset process again.

Call a Password Reset Function

When you configure your app to run a password reset function, you define the function that should run when you call EmailPasswordAuth.callResetPasswordFunction().

This function can take a username, a password, and any number of additional arguments. You can use these arguments to specify details like security question answers or other challenges that the user should pass to successfully complete a password reset.

You might prefer to use a custom password reset function when you want to define your own password reset flows. For example, you might send a custom password reset email from a specific domain. Or you might use a service other than email to confirm the user's identity.

On the App Services side, you define the custom password reset function that runs when you call this method. That function can return one of three possible statuses:

• fail

• pending

• success

A fail status is treated as an error by the SDK. The SDK callResetPasswordFunction() does not take return values, so it does not return a pending or success status to the client.

const email = "someone@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
);

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

const email = "someone@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
);