Skip to content Skip to footer navigation
Light theme Dark theme

User-reset_two_factor_recovery_codes_form Tag

If a user has used some of their recovery codes or suspects they've been compromised, they can generate a fresh set. This invalidates all existing codes.

Overview#

The user:reset_two_factor_recovery_codes_form tag renders a form that allows authenticated users to generate a new set of recovery codes. When submitted, all existing recovery codes are invalidated and replaced with new ones.

The tag will render the opening and closing <form> HTML elements for you. No input fields are required—just a submit button.

Hot Tip!

This form requires the user to be authenticated with 2FA enabled and an elevated session. If the session isn't elevated, the user will be redirected to confirm their identity first.

A troll pointing a teaching stick

Example#

{{ user:reset_two_factor_recovery_codes_form redirect="/account/recovery-codes" }}



    {{ if success }}

        <div class="bg-green-300 text-white p-2">

            {{ success }}

        </div>

    {{ /if }}



    <p>Generate new recovery codes? Your current codes will be invalidated.</p>

    <button type="submit">Generate New Codes</button>



{{ /user:reset_two_factor_recovery_codes_form }}

<s:user:reset_two_factor_recovery_codes_form redirect="/account/recovery-codes">

    @if ($success)

        <div class="bg-green-300 text-white p-2">

            {{ $success }}

        </div>

    @endif



    <p>Generate new recovery codes? Your current codes will be invalidated.</p>

    <button type="submit">Generate New Codes</button>

</s:user:reset_two_factor_recovery_codes_form>

Parameters

redirect

string

Where the user should be taken after generating new codes.

HTML Attributes

Set HTML attributes as if you were in an HTML element. For example, class="reset-form".

Variables

Variable Type Description

success

 string

A success message.