Variable requestReset

Type Declaration

• • (
        identifier: string,
        via: string,
        extra?: { address?: string; code?: string },
    ): Promise<any>

  • Handles a person asking for a reset link: mails a single-use link to the address on the entry when everything checks out, and fires RISC recovery-activated.

    With a recovery code required, all three of username, address and code must be right, and the code is spent. The answer is the same sentence whatever happened; outcome must never be shown.

    Parameters

    • identifier: string

      the username, or the address on the entry when no recovery code is required

    • via: string

      the surface it came through

    • Optionalextra: { address?: string; code?: string }

      address and code when a recovery code is required

    Returns Promise<any>

    a promise of { ok: true, message, outcome }