@auth0/auth0-react
    Preparing search index...

    Interface RedirectConnectAccountOptions<TAppState>

    interface RedirectConnectAccountOptions<TAppState = any> {
        appState?: TAppState;
        authorization_params?: AuthorizationParams;
        connection: string;
        openUrl?: (url: string) => Promise<void>;
        redirectUri?: string;
        scopes?: string[];
    }

    Type Parameters

    • TAppState = any
    Index

    Properties

    appState? authorization_params? connection openUrl? redirectUri? scopes?

    Properties

    appState?: TAppState

    Optional application state to persist through the transaction.

    await auth0.connectAccountWithRedirect({
      connection: 'google-oauth2',
      appState: { returnTo: '/settings' }
    });
    authorization_params?: AuthorizationParams

    Additional authorization parameters for the request.

    await auth0.connectAccountWithRedirect({
      connection: 'github',
      authorization_params: {
        audience: 'https://api.github.com'
      }
    });
    connection: string

    The name of the connection to link (e.g. 'google-oauth2').

    openUrl?: (url: string) => Promise<void>

    Optional function to handle the redirect URL.

    await auth0.connectAccountWithRedirect({
      connection: 'google-oauth2',
      openUrl: async (url) => { myBrowserApi.open(url); }
    });
    redirectUri?: string

    The URI to redirect back to after connecting the account.

    scopes?: string[]

    Array of scopes to request from the Identity Provider during the connect account flow.

    await auth0.connectAccountWithRedirect({
      connection: 'google-oauth2',
      scopes: ['https://www.googleapis.com/auth/calendar']
    });

    Settings

    Member Visibility

    On This Page

    Properties