Class EmailPasswordAuth

Authentication provider where users identify using email and password.

See

https://www.mongodb.com/docs/atlas/app-services/authentication/email-password/

Methods

callResetPasswordFunction confirmUser registerUser resendConfirmationEmail resetPassword retryCustomConfirmation sendResetPasswordEmail

Methods

callResetPasswordFunction

  • callResetPasswordFunction(details, ...args): Promise<void>

  • Call the custom function to reset the password.

    Parameters

    • details: {
          email: string;
          password: string;
      }

      The new user's email and password details.

      • email: string

        The email address of the user to register.

      • password: string

        The password that the user created for the new username/password identity.

    • Rest ...args: unknown[]

      One or more arguments to pass to the function.

    Returns Promise<void>

    Since

    v10.10.0

confirmUser

  • confirmUser(details): Promise<void>

  • Confirms an email identity with the email/password provider.

    Parameters

    • details: {
          token: string;
          tokenId: string;
      }

      The received token and ID details

      • token: string

        The confirmation token that was emailed to the user.

      • tokenId: string

        The confirmation token id that was emailed to the user.

    Returns Promise<void>

    Since

    v10.10.0

registerUser

  • registerUser(details): Promise<void>

  • Registers a new email identity with the email/password provider, and sends a confirmation email to the provided address.

    Parameters

    • details: {
          email: string;
          password: string;
      }

      The new user's email and password details.

      • email: string

        The email address of the user to register.

      • password: string

        The password that the user created for the new username/password identity.

    Returns Promise<void>

    Since

    v10.10.0

resendConfirmationEmail

  • resendConfirmationEmail(details): Promise<void>

  • Re-sends a confirmation email to a user that has registered but not yet confirmed their email address.

    Parameters

    • details: {
          email: string;
      }

      The associated email details.

      • email: string

        The email address of the user to re-send a confirmation for.

    Returns Promise<void>

    Since

    v10.10.0

resetPassword

  • resetPassword(details): Promise<void>

  • Resets the password of an email identity using the password reset token emailed to a user.

    Parameters

    • details: {
          password: string;
          token: string;
          tokenId: string;
      }

      The token and password details for the reset.

      • password: string

        The desired new password.

      • token: string

        The password reset token that was emailed to the user.

      • tokenId: string

        The password reset token id that was emailed to the user.

    Returns Promise<void>

    Since

    v10.10.0

retryCustomConfirmation

  • retryCustomConfirmation(details): Promise<void>

  • Re-run the custom confirmation function for user that has registered but not yet confirmed their email address.

    Parameters

    • details: {
          email: string;
      }

      The associated email details.

      • email: string

        The email address of the user to re-run the confirmation for.

    Returns Promise<void>

    Since

    v10.10.0

sendResetPasswordEmail

  • sendResetPasswordEmail(details): Promise<void>

  • Sends an email to the user for resetting the password.

    Parameters

    • details: {
          email: string;
      }

      The email details to send the reset to.

      • email: string

        The email address of the user to re-send a confirmation for.

    Returns Promise<void>

    Since

    v10.10.0

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc