RedirectConnectAccountOptions

Properties

TAppState

Optional application state to persist through the transaction.

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

AuthorizationParams

Additional authorization parameters for the request.Type: AuthorizationParams

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

string

required

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

(url: string) => Promise<void>

Optional function to handle the redirect URL.

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

string

The URI to redirect back to after connecting the account.

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']
});