Twitter Identity Provider APIs

Overview

This API has been available since 1.1.0

The Twitter identity provider type will use the Twitter OAuth v1.0 login API. it will provide a Login with Twitter button on FusionAuth’s login page that will leverage the Twitter login page directly. Additionally, this identity provider will call Twitter’s /1.1/account/verify_credentials.json API to load additional details about the user and store them in FusionAuth.

The email address returned by Twitter will be used to create or lookup the existing user. Additional claims returned by Twitter can be used to reconcile the User to FusionAuth by using a Twitter Reconcile Lambda. Unless you assign a reconcile lambda to this provider, on the email address will be used from the available claims returned by Twitter.

Twitter does not require a user to have an email address. However, to prevent account hijacking and take-over, FusionAuth prevents users from logging in with Twitter unless they have setup an email address in their Twitter account. Keep this in mind as you enable this identity provider.

FusionAuth will also store the Twitter access token returned from the OAuth v1.0 login workflow in the identityProviderLink object. This object is accessible using the Link API.

The identityProviderLink object stores the token so that you can use it in your application to call Twitter APIs on behalf of the user if desired.

Prior to version 1.28.0, the token was stored in the UserRegistration object, in the tokens Map.

Complete the Twitter Login

Create the Twitter Identity Provider

Request

Create the Twitter Identity Provider

URI

POST /api/identity-provider

The type property in the request JSON is used to determine that you are managing the TWitter identity provider.

Request Body

identityProvider.applicationConfiguration [Map<UUID, Object>] Optional

The configuration for each Application that the identity provider is enabled for.

identityProvider.applicationConfiguration[applicationId].buttonText [String] Optional

This is an optional Application specific override for the top level buttonText.

identityProvider.applicationConfiguration[applicationId].consumerKey [String] Optional

This is an optional Application specific override for the top level consumerKey.

identityProvider.applicationConfiguration[applicationId].consumerSecret [String] Optional

This is an optional Application specific override for the top level consumerSecret.

identityProvider.applicationConfiguration[applicationId].createRegistration [Boolean] Optional defaults to true

Determines if a UserRegistration is created for the User automatically or not. If a user doesn’t exist in FusionAuth and logs in through an identity provider, this boolean controls whether or not FusionAuth creates a registration for the User in the Application they are logging into.

identityProvider.applicationConfiguration[applicationId].enabled [Boolean] Optional defaults to false

Determines if this identity provider is enabled for the Application specified by the applicationId key.

identityProvider.buttonText [String] Required

The top-level button text to use on the FusionAuth login page for this Identity Provider.

identityProvider.consumerKey [String] Required

The top-level consumer key to use with the Twitter Identity Provider. This value is retrieved from the Twitter developer website when you setup your Twitter developer account.

identityProvider.consumerSecret [String] Required

The top-level consumer secret to use with the Twitter Identity Provider. This value is retrieved from the Twitter developer website when you setup your Twitter developer account.

identityProvider.debug [Boolean] Optional defaults to false Available since 1.7.3

Determines if debug is enabled for this provider. When enabled, an Event Log is created each time this provider is invoked to reconcile a login.

This is useful for debugging purposes, but is not intended to be left on during production. It should be enabled during integration or if you are experiencing an issue with this identity provider.

identityProvider.enabled [Boolean] Optional defaults to false

Determines if this provider is enabled. If it is false then it will be disabled globally.

identityProvider.lambdaConfiguration.reconcileId [UUID] Optional Available since 1.17.0

The unique Id of the lambda to used during the user reconcile process to map custom claims from the external identity provider to the FusionAuth user.

The specified Lambda Id must be of type TwitterReconcile

identityProvider.linkingStrategy [String] Optional defaults to LinkByEmail Available since 1.28.0

The linking strategy to use when creating the link between the Twitter Identity Provider and the user.

The possible values are:

CreatePendingLink - Do not automatically link, instead return a pending link identifier that can be used to link to an existing user.
LinkAnonymously - Always create a link based upon the unique Id returned by the identify provider. A username or email is not required and will not be used to link the user. A reconcile lambda will not be used in this configuration.
LinkByEmail - Link to an existing user based upon email. A user will be created with the email returned by the identity provider if one does not already exist.
LinkByEmailForExistingUser - Only link to an existing user based upon email. A user will not be created if one does not already exist with email returned by the identity provider.
LinkByUsername - Link to an existing user based upon username. A user will be created with the username returned by the identity provider if one does not already exist.
LinkByUsernameForExistingUser - Only link to an existing user based upon username. A user will not be created if one does not already exist with username returned by the identity provider.

identityProvider.tenantConfiguration [Map<UUID, Object>] Optional Available since 1.32.0

The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount [Object] Optional Available since 1.32.0

The policy that governs identity provider links on a Tenant.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled [Boolean] Optional defaults to false Available since 1.32.0

When enabled, the number of identity provider links a user may create is enforced by maximumLinks.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinks [Integer] Optional defaults to 42 Available since 1.32.0

The maximum number of links that a user can have for a particular identity provider. This configuration is specific to this IdP. So a user can have more links than this number, but for this particular IdP, the number of links will be limited and enforced.

identityProvider.type [String] Required

This field must be set to Twitter.

Example Twitter Request JSON


{
  "identityProvider": {
    "applicationConfiguration": {
      "1c212e59-0d0e-6b1a-ad48-f4f92793be32": {
        "createRegistration": true,
        "enabled": true
      }
    },
    "buttonText": "Login with Twitter",
    "consumerKey": "24iuleLRKIZUNhxuuUK6yDZwb",
    "consumerSecret": "e2ZpAaAfxv2j9eeh6JTeNcXMWdVLjRNriXm4wSZt1f1Ss3Syp4",
    "debug": false,
    "enabled": true,
    "tenantConfiguration": {
      "e872a880-b14f-6d62-c312-cb40f22af465": {
        "limitUserLinkCount": {
          "enabled": false,
          "maximumLinks": 42
        }
      }
    },
    "type": "Twitter"
  }
}

Response

Table 1. Response Codes
Code	Description
200	The request was successful. The response will contain a JSON body.
400	The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401	You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body

identityProvider.applicationConfiguration [Map<UUID, Object>]

The configuration for each Application that the identity provider is enabled for.

identityProvider.applicationConfiguration[applicationId].buttonText [String]

This is an optional Application specific override for the top level buttonText.

identityProvider.applicationConfiguration[applicationId].consumerKey [String]

This is an optional Application specific override for the top level consumerKey.

identityProvider.applicationConfiguration[applicationId].consumerSecret [String]

This is an optional Application specific override for the top level consumerSecret.

identityProvider.applicationConfiguration[applicationId].createRegistration [Boolean]

identityProvider.applicationConfiguration[applicationId].enabled [Boolean]

Determines if this identity provider is enabled for the Application specified by the applicationId key.

identityProvider.buttonText [String]

The top-level button text to use on the FusionAuth login page for this Identity Provider.

identityProvider.consumerKey [String]

The top-level consumer key to use with the Twitter Identity Provider. This value is retrieved from the Twitter developer website when you setup your Twitter developer account.

identityProvider.consumerSecret [String]

The top-level consumer secret to use with the Twitter Identity Provider. This value is retrieved from the Twitter developer website when you setup your Twitter developer account.

identityProvider.debug [Boolean] Available since 1.7.3

Determines if debug is enabled for this provider. When enabled, each time this provider is invoked to reconcile a login an Event Log will be created.

identityProvider.enabled [Boolean]

Determines if this provider is enabled. If it is false then it will be disabled globally.

identityProvider.id [UUID]

The Id of the Twitter identity provider, which will always be 45bb233c-0901-4236-b5ca-ac46e2e0a5a5.

identityProvider.insertInstant [Long]

The instant that the provider was added to the FusionAuth database.

identityProvider.lastUpdateInstant [Long]

The instant that the provider was updated in the FusionAuth database.

identityProvider.lambdaConfiguration.reconcileId [UUID] Available since 1.17.0

The unique Id of the lambda to used during the user reconcile process to map custom claims from the external identity provider to the FusionAuth user.

identityProvider.linkingStrategy [String] Optional defaults to LinkByEmail Available since 1.28.0

The linking strategy to use when creating the link between the Twitter Identity Provider and the user.

The possible values are:

CreatePendingLink - Create pending link.
Disabled - Disables linking automatically. Available since 1.37.0.
LinkAnonymously - Anonymous Link.
LinkByEmail - Link on email. Create the user if they do not exist.
LinkByEmailForExistingUser - Link on email. Do not create the user if they do not exist.
LinkByUsername - Link on username. Create the user if they do not exist.
LinkByUsernameForExistingUser - Link on username. Do not create the user if they do not exist.

identityProvider.name [String]

The name of the provider, this field will always be set to Twitter.

identityProvider.tenantConfiguration [Map<UUID, Object>] Available since 1.32.0

The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount [Object] Available since 1.32.0

The policy that governs identity provider links on a Tenant.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled [Boolean] defaults to false Available since 1.32.0

When enabled, the number of identity provider links a user may create is enforced by maximumLinks.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinks [Integer] defaults to 42 Available since 1.32.0

identityProvider.type [String]

The type of this provider, this field will always be set to Twitter.

Example Twitter Response JSON


{
  "identityProvider": {
    "applicationConfiguration": {
      "1c212e59-0d0e-6b1a-ad48-f4f92793be32": {
        "createRegistration": true,
        "enabled": true
      }
    },
    "buttonText": "Login with Twitter",
    "consumerKey": "24iuleLRKIZUNhxuuUK6yDZwb",
    "consumerSecret": "e2ZpAaAfxv2j9eeh6JTeNcXMWdVLjRNriXm4wSZt1f1Ss3Syp4",
    "debug": false,
    "enabled": true,
    "id": "45bb233c-0901-4236-b5ca-ac46e2e0a5a5",
    "insertInstant": 1595361142909,
    "lastUpdateInstant": 1595361143101,
    "name": "Twitter",
    "tenantConfiguration": {
      "e872a880-b14f-6d62-c312-cb40f22af465": {
        "limitUserLinkCount": {
          "enabled": false,
          "maximumLinks": 42
        }
      }
    },
    "type": "Twitter"
  }
}

Retrieve the Twitter Identity Provider

There is only one Twitter Identity Provider, so this Identity Provider may be retrieved by type or Id.

Request

Retrieve the Twitter Identity Provider by type

URI

GET /api/identity-provider?type=Twitter

Retrieve the Twitter Identity Provider by Id

URI

GET /api/identity-provider/45bb233c-0901-4236-b5ca-ac46e2e0a5a5

Response

Table 2. Response Codes
Code	Description
200	The request was successful. The response will contain a JSON body.
400	The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401	You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404	The object you requested doesn’t exist. The response will be empty.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.