Skip to main content

HandleOAuthCallbackParams

A type representing the parameters for a callback that handles an OAuth-related callback.

  • Name
    continueSignUpUrl?
    Type
    string | null
    Description

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

  • Name
    firstFactorUrl?
    Type
    string
    Description

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

  • Name
    reloadResource?
    Type
    "signIn" | "signUp"
    Description

    The underlying resource to optionally reload before processing an OAuth callback.

  • 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
    secondFactorUrl?
    Type
    string
    Description

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

  • Name
    signInFallbackRedirectUrl?
    Type
    string | null
    Description

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

  • Name
    signInForceRedirectUrl?
    Type
    string | null
    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
    signInUrl?
    Type
    string
    Description

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

  • Name
    signUpFallbackRedirectUrl?
    Type
    string | null
    Description

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

  • Name
    signUpForceRedirectUrl?
    Type
    string | null
    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
    signUpUrl?
    Type
    string
    Description

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

  • Name
    transferable?
    Type
    boolean
    Description

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

  • Name
    unsafeMetadata?
    Type
    SignUpUnsafeMetadata
    Description

    Metadata that can be read and set from the frontend. Once the sign-up is complete, the value of this field will be automatically copied to the newly created user's unsafe metadata. One common use case for this attribute is to use it to implement custom fields that can be collected during sign-up and will automatically be attached to the created User object.

  • Name
    verifyEmailAddressUrl?
    Type
    string | null
    Description

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

  • Name
    verifyPhoneNumberUrl?
    Type
    string | null
    Description

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

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub