Twitter Identity Provider

Overview

Adding a Login with Twitter button to FusionAuth is simple, and this guide will walk you through the steps necessary to collect the credentials from Twitter in order to enable this Social login.

• Create a Twitter Account

• Create a Twitter App

• Create a Twitter Identity Provider

• Building Your Own Integration

Once you have completed this configuration you will be able to enable the Twitter login button for one or more FusionAuth Applications. Below is an example login page with the Twitter Identity Provider enabled.

Create a Twitter Account

Ensure you have a Twitter account, and then navigate to the Twitter Developer dashboard.

https://developer.twitter.com

If you do not yet have a developer account, you will need to apply for access to the Twitter API.

https://developer.twitter.com/en/apply-for-access.html

Once you have logged into Twitter and have obtained access to a Twitter developer account, continue to the next step.

Create a Twitter App

If you do not yet have a Twitter app you will need to create an app in this step. If you already have a Twitter app that you plan to use for FusionAuth please review this section anyway to ensure your configuration is correct to support the Twitter login.

https://developer.twitter.com/en/portal/projects-and-apps

In the following sections you will find an example of the Create an App process. Review the following sections to ensure your configuration is correct.

Authentication Settings

You will need to modify a few setting here to enable Twitter to connect with FusionAuth.

Add the Callback URL 1 & 2

In this example I have registered https://login.piedpiper.com/oauth2/callback as the callback URL. The redirect URL must be set to an absolute URL in the twitter console for your application. If your hostname is login.piedpiper.com, the redirect URL would be https://login.piedpiper.com/oauth2/callback/.

Enable 3-legged OAuth and complete all required fields.

Request Email 3

Finally, you will want to ensure you have checked Request email address from users. Please note, for some Twitter users, it is possible to create an account without an email address. If this is the case for your Twitter users, you will want to configure the IdP below to link on a username, or create a pending link. See Linking Strategies which discusses workaround options.

Keys and Tokens

Now click on the Keys and tokens tab. In this section you will find the Consumer API keys. These two values will be used to configure the FusionAuth Identity Provider.

Create a Twitter Identity Provider

The last step will be to create a Twitter Identity Provider in FusionAuth. To create an Identity Provider navigate to Settings → Identity Providers and click Add provider and select Twitter from the dialog.

This will take you to the Add Twitter panel, and you’ll fill out the Consumer key and Consumer secret required fields using the values found in the Twitter App Keys and tokens tab from the previous step. The button text is also required but it will be defaulted to Login with Twitter, you may optionally modify this default value.

To enable this identity provider for an application, find your application name in the Applications configuration section at the bottom of this panel. You will always see the FusionAuth application, this application represents the FusionAuth administrative user interface. If you wish to be able to log into FusionAuth with this provider, you may enable this application.

In the following screenshot you will see that we have enabled this login provider for the Pied Piper application and enabled Create registration. Enabling create registration means that a user does not need to be manually registered for the application prior to using this login provider.

For example, when a new user attempts to log into Pied Piper using Twitter, if their user does not exist in FusionAuth it will be created dynamically, and if the Create registration toggle has been enabled, the user will also be registered for Pied Piper and assigned any default roles assigned by the application.

If you do not wish to automatically provision a user for this Application when logging in with Twitter, leave Create registration off. You will need to manually register a user for this application before they may Sign in with Twitter.

That’s it, now the Sign in with Twitter button will show up on the login page for the Pied Piper application.

Proxy details

If you are running FusionAuth behind a proxy of some sort, please review the following information.

FusionAuth will detect the public URL of your instance at runtime to send to Twitter as the callback URL. If you are behind a proxy, ensure that the X-Forwarded-Host and the X-Forwarded-Proto headers are added by your proxy if the host or protocol do not match what is behind the proxy. For example, if your public URL is using https and your proxy is performing SSL acceleration the URL behind the proxy may be http. In this scenario, most proxies will have added the X-Forwarded-Proto header to the request which will allow FusionAuth to send the correct URL to Twitter.

Building Your Own Integration

If you are building your own login experience, you’ll want to start the identity provider flow yourself and then complete the login.

You might do this if you are using the Login API rather than using the hosted FusionAuth login pages.

Completing the login is documented further in the API.

If you require a refresh token after completing the login, ensure Enable JWT Refresh is true in the application configuration. This is found in the administrative user interface by navigating to Applications → Your Application → Security → Login API settings.