client.auth.resetPassword

Send a password reset email.

Signature

class Client {
  auth: {
    resetPassword(email: string): Promise<void>
  }
}

Parameters

email

Examples

await bf.auth.resetPassword('alice@example.com')

Throws

ApiError

NetworkError

Pitfalls

• No error on unknown email — returns successfully even if the email is not registered (to prevent enumeration), though no email is sent
• Rate limited — one reset email per 60 seconds per address

See also

{auto-injected}

Tested against

{auto-injected}