Interface RedirectConnectAccountOptions<TAppState>

Optional application state to persist through the transaction.

Example

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

Additional authorization parameters for the request.

Example

await auth0.connectAccountWithRedirect({
  connection: 'google-oauth2',
  authorization_params: {
    scope: 'https://www.googleapis.com/auth/calendar'
    access_type: 'offline'
  }
});
Copy

Example

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

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

Optional function to handle the redirect URL.

Example

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

The URI to redirect back to after connecting the account.