Skip to main content
Docs

<AuthenticateWithRedirectCallback />

The <AuthenticateWithRedirectCallback /> component is a crucial part of implementing custom OAuth flows in your application. It serves as the callback handler for the authentication process initiated by the authenticateWithRedirect() method. Render it on the route specified as the redirectUrl in your authenticateWithRedirect() call.

This component automatically handles the OAuth callback, completing the authentication process and managing the user's session. It uses the handleRedirectCallback()JavaScript Icon method under the hood.

Example

For an example of how to use the <AuthenticateWithRedirectCallback /> component, see the custom flow guide.

Properties

All props are optional.

  • Name
    continueSignUpUrl?
    Type
    string | undefined | null
    Description

    The full URL or path to navigate to if the sign up requires additional information.

  • Name
    signInUrl?
    Type
    string
    Description

    The full URL or path where the <SignIn /> component is mounted.

  • Name
    signUpUrl?
    Type
    string
    Description

    The full URL or path where the <SignUp /> component is mounted.

  • Name
    signInFallbackRedirectUrl?
    Type
    string
    Description

    The fallback URL to redirect to after the user signs in, if there's no redirect_url in the path already. Defaults to /. It's recommended to use the environment variable instead.

  • Name
    signUpFallbackRedirectUrl?
    Type
    string
    Description

    The fallback URL to redirect to after the user signs up, if there's no redirect_url in the path already. Defaults to /. It's recommended to use the environment variable instead.

  • Name
    signInForceRedirectUrl?
    Type
    string
    Description

    If provided, this URL will always be redirected to after the user signs in. It's recommended to use the environment variable instead.

  • Name
    signUpForceRedirectUrl?
    Type
    string
    Description

    If provided, this URL will always be redirected to after the user signs up. It's recommended to use the environment variable instead.

  • Name
    firstFactorUrl?
    Type
    string | undefined
    Description

    The full URL or path to navigate to during sign in, if first factor verification is required.

  • Name
    secondFactorUrl?
    Type
    string | undefined
    Description

    The full URL or path to navigate to during sign in, if multi-factor authentication is enabled.

  • Name
    resetPasswordUrl?
    Type
    string
    Description

    The full URL or path to navigate to during sign in, if the user is required to reset their password.

  • Name
    transferable?
    Type
    boolean
    Description

    A boolean that indicates whether or not sign in attempts are transferable to the sign up flow. Defaults to true. When set to false, prevents opaque sign ups when a user attempts to sign in via OAuth with an email that doesn't exist.

  • Name
    verifyEmailAddressUrl?
    Type
    string | undefined | null
    Description

    The full URL or path to navigate to after requesting email verification.

  • Name
    verifyPhoneNumberUrl?
    Type
    string | undefined | null
    Description

    The full URL or path to navigate to after requesting phone verification.

Feedback

What did you think of this content?
GitHubEdit on GitHub

Last updated on