@auth0/auth0-acul-react - v1.10.0
    Preparing search index...

    Interface ResetPasswordEmailMembers

    interface ResetPasswordEmailMembers {
        branding: BrandingMembers;
        client: ClientMembers;
        countryCodes?: CountryCodesMembers;
        experiment?: ExperimentMembers | null;
        organization: OrganizationMembers;
        prompt: PromptMembers;
        tenant: TenantMembers;
        transaction: TransactionMembers;
        user: UserMembers;
        untrustedData: UntrustedDataMembers;
        getErrors(): Error[];
        changeLanguage(options: LanguageChangeOptions): Promise<void>;
        screen: ScreenMembersOnResetPasswordEmail;
        resendEmail(payload?: CustomOptions): Promise<void>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    branding: BrandingMembers
    countryCodes?: CountryCodesMembers

    Optional on the interface so existing implementors of BaseMembers (e.g. test mocks) keep compiling. Always populated at runtime by the BaseContext constructor.

    experiment?: ExperimentMembers | null

    The active Experiment Center experiment for the current screen, or null when none is active (or the screen has not opted in via context_configuration).

    Optional on the interface so existing implementors of BaseMembers (e.g. test mocks) keep compiling. Always populated at runtime by the BaseContext constructor.

    organization: OrganizationMembers
    transaction: TransactionMembers
    untrustedData: UntrustedDataMembers

    Methods

    • Returns Error[]

    • Returns the user to the reset password request screen to request a new email.

      Parameters

      • Optionalpayload: CustomOptions

        Optional custom parameters to send with the request.

      Returns Promise<void>

      A promise that resolves once the form is submitted, before the new page loads. It doesn't confirm that an email was sent.

      Submits a form POST with action: "resend-email-action". Auth0 doesn't send a new email at this step. It renders the reset-password-request screen, where the user submits their email or username again to receive a new email. The browser loads a new page, and the current JavaScript context, including component state and timers, is lost.