---
url: "https://vueda.dev/v3/reference/api/js/use/useAuthFlow/types/AuthFlowOptions.md"
title: "AuthFlowOptions"
---

# AuthFlowOptions

## Properties

### formProps {#formProps}

Props forwarded to `useForm`.

Type: `object`

Source: `client/lib/use/useAuthFlow.js:16`

### onSubmissionErrorHandler {#onSubmissionErrorHandler}

Handles every error that the returned `onSubmissionErrorHandler` does not redirect for, in place of
 `defaultOnSubmissionError`. Its return value is the handled result, so `false` lets `useActionForm` record
 the error and show its error toast.

Type: `(args: object) => boolean | Promise`

Source: `client/lib/use/useAuthFlow.js:22`

### redirect {#redirect}

Route path to push after success when the route has no `returnPath` query.

Type: `string`

Source: `client/lib/use/useAuthFlow.js:17`

### requireRecentAuth {#requireRecentAuth}

Whether the server requires a recent session for the form's
 action. When `true`, a pending reauthentication flow sends the user to the reauthenticate route, including when
 the form is set up. Set it to `false` for a form whose action the server accepts without a recent session, such
 as change-password. The user then stays on the form while the flow is pending.

Type: `boolean`

Source: `client/lib/use/useAuthFlow.js:18`

## Source

`client/lib/use/useAuthFlow.js:15`