Account Link Extension

The Account Link extension prompts users that may have created a second account by mistake to link the new account with their old one upon their first login. The user may choose to either link the two accounts or keep them separate if creating the second account was intentional.

How does the extension work?

The extension triggers after authentication when the email address of the user who authenticated matches the email address of an existing user account attached to a different identity provider.

For example, if a user logs in with their Facebook account using the email john@acme.com and then later authenticates with Google using the same email address, they will be prompted with a page similar to the following:

Dashboard - Extensions - Account Link - Extension Example

The extension does not automatically link users with the same email, even if emails are verified, because verified emails are not enough evidence to prove that the user can currently authenticate to both accounts.

If the user selects Continue, they will be redirected to Facebook to authenticate. If the user is already logged in, Facebook will redirect back to the application, and the user will be automatically linked. If they are not logged in, they will be prompted to authenticate with their Facebook credentials. After Facebook redirects back to Auth0, the Facebook account will be linked with the Google account. This process ensures that the user has the credentials to authenticate to both accounts, which allows the accounts to be linked safely and correctly.

Note that the extension does not support passwordless connections. For connections not supported by the Account Link extension, see Account Linking – Server-Side Implementation and User Initiated Account Linking – Client-Side Implementation as alternative options.

Install and configure extension

Go to Auth0 Dashboard > Extensions, and select Auth0 Account Link. The Install Extension window opens.

The extension will create a new application named auth0-account-link to use internally and a new rule to redirect users to the extension if they login with a new account that has an email matching an existing account. This application needs to have enabled all the connections that you want to perform account linking with.

Set up extension

Change application name

We recommend changing the name of the default application used for the extension to something descriptive and easy to read for your customers, like Account Linking, since it will appear on the Login Page when they authenticate their primary account.

Update the login page

By default, Auth0's Universal Login allows a user to both log in and sign up, as one may expect. However, when the account linking asks you to authenticate your primary account in order to link it with the new account, providing a signup option can be confusing for users.

To learn more about what you can do with Universal Login, see Auth0 Universal Login.

To prevent this, we send a query parameter to let the login page know that it should hide the Sign Up option. For this query parameter to take effect, however, you must customize the login page.

  1. Go to Auth0 Dashboard > Branding > Universal Login, and select the Login view.

  2. Enable the Customize Login Page switch to enable the custom editor below. In the editor, we're going to add a new line to the Lock config.

  3. Toward the bottom of the object configuring the Lock widget, add the following line (after the closable setting): allowSignUp: !config.extraParams.prevent_sign_up,

    Dashboard - Branding - Universal Login - Login Setting - Account Link Hosted Page Code Example
  4. Save your changes and attempt to link an account. You'll notice that the Sign Up option is no longer present and your users are safe from an extra level of confusion.

    Account Link Hosted Page Example

Hiding the Signup link is not supported in the New Universal Login Experience.

Customize theme

At installation (or any time after by clicking the Settings icon for the Account Link Extension), you can add a URL to a custom stylesheet if you would like to customize the extension page to look a bit different from the default theme.

Account Link Customize Theme

Administration Panel

You can customize your account linking login page and widget using the extension administration panel.

  1. Go to Dashboard > Extensions > Installed Extensions > Auth0 Account Link.

    Dashboard - Extensions - Installed Extensions - Account Link
  2. You will be redirected to the admin site. There you can edit the HTML code of your hosted page and change some settings of the account linking widget such as title, logo, color, and language.

    Dashboard - Extensions - Account Link - HTML Editor

Do not remove {{ ExtensionCSS }}, {{ CustomCSS }}, {{ Auth0Widget }}, or {{ ExtensionScripts }} from the HTML code of the site. This will cause the extension to not display the account linking widget.

Dashboard - Extensions - Account Link - Widget Settings

Custom domains

If you're using a custom domain, you'll need to set the configs rule customDomain with the custom domain (for example, auth.custom.com).

  1. Go to Auth0 Dashboard > Auth Pipeline > Rules.

  2. By default, line 27 of the rule is: issuer: auth0.domain You will need to change this to: issuer: "myCustomDomain.com" Make sure to omit the protocol portion of the URL.

Learn more