Twitter/X API
1.1.0
The Twitter/X 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, in the identityProviderLink.token field. 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.
Create a Twitter Identity Provider#
Request#
OpenAPI Spec
OpenAPI Spec
The type property in the request JSON indicates this is a Twitter Identity Provider.
Request Parameters#
identityProviderId UUID optional Defaults to secure random UUID Available since 1.61.0Immutable The Id to use for the new Identity Provider. If an Id is not provided, a secure random UUID is generated. If neither an Id nor identityProvider.name are provided, the legacy fixed Twitter IdP Id 45bb233c-0901-4236-b5ca-ac46e2e0a5a5 will be used.
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.attributeMappings Map<String, String> optional Available since 1.65.0A map of attribute mappings applied during user reconciliation when a reconcile Lambda is not configured.
Each key is the FusionAuth target field path and must begin with user. or registration.. Each value is the source expression in the identity provider response payload. A dot-notated value such as email or id_token.given_name is converted to a JSON Pointer. A value that starts with / is treated as a JSON Pointer as-is.
This property cannot be used with identityProvider.lambdaConfiguration.reconcileId.
This property is ignored when identityProvider.linkingStrategy is LinkAnonymously.
This property defaults to an empty map.
Mappings that resolve to null, cannot be extracted, or cannot be written to the target field are ignored. Mappings to user.password do not set a password.
identityProvider.debug Boolean optional Defaults to false Available since 1.7.3Determines 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.0The 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.0The linking strategy to use when creating the link between the Twitter Identity Provider and the user.
Available since 1.65.0 You can only change this value when the identity provider is disabled. To change the linking strategy for an identity provider that is already enabled, disable the provider, change the value, and then re-enable the provider.
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.Disabled- Disables linking automatically. You must use the API to create links. Available since1.37.0LinkAnonymously- 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.name String optional Available since 1.61.0The display name of this provider instance. Required when using a provided identityProviderId or identityProvider.tenantId.
identityProvider.source String optional Defaults to System Available since 1.65.0The source of this Identity Provider.
The maximum length is 191 characters.
This value is only used on create. If provided on update, it is ignored and the existing value is preserved.
identityProvider.tenantConfiguration Map<UUID, Object> Available since 1.32.0The 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.0The policy that governs identity provider links on a Tenant.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled Boolean Defaults to false Available since 1.32.0When 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.0The 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.tenantId UUID optional Available since 1.62.0The unique Id of the Tenant.
Providing a value creates an identity provider scoped to the specified tenant, otherwise a global identity provider is created. Tenant-scoped identity providers can only be used to authenticate in the context of the specified tenant. Global identity providers can be used with any tenant.
This value is read-only once the identity provider is created.
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",
"name": "Twitter Provider",
"debug": false,
"enabled": true,
"tenantConfiguration": {
"e872a880-b14f-6d62-c312-cb40f22af465": {
"limitUserLinkCount": {
"enabled": false,
"maximumLinks": 42
}
}
},
"type": "Twitter"
}
}Response#
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. |
| 409 | A conflict was encountered processing this request. |
| 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 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 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.attributeMappings Map<String, String> Available since 1.65.0A map of attribute mappings applied during user reconciliation when a reconcile Lambda is not configured.
Each key is the FusionAuth target field path and begins with user. or registration.. Each value is the source expression from the identity provider response payload.
This configuration is ignored when identityProvider.linkingStrategy is LinkAnonymously.
Mappings that resolve to null, cannot be extracted, or cannot be written to the target field are ignored at runtime. Mappings to user.password do not set a password.
identityProvider.debug Boolean Available since 1.7.3Determines 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 provider.
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.0The 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.0The 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 since1.37.0LinkAnonymously- 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 this Twitter identity provider. This is only used for display purposes.
identityProvider.source String Available since 1.65.0The source for this Identity Provider.
identityProvider.tenantConfiguration Map<UUID, Object> Available since 1.32.0The 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.0The policy that governs identity provider links on a Tenant.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled Boolean Defaults to false Available since 1.32.0When 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.0The 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.tenantId UUID Available since 1.62.0The unique Id of the Tenant. This value is present if the identity provider is tenant-scoped. Tenant-scoped identity providers can only be used to authenticate in the context of the specified tenant. This value is read-only once the key is created.
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": "c2e7f5d4-9a31-46b8-80c2-5d1a7b3f6e94",
"insertInstant": 1595361142909,
"lastUpdateInstant": 1595361143101,
"name": "Twitter Provider",
"tenantConfiguration": {
"e872a880-b14f-6d62-c312-cb40f22af465": {
"limitUserLinkCount": {
"enabled": false,
"maximumLinks": 42
}
}
},
"type": "Twitter"
}
}Retrieve a Twitter Identity Provider#
Request#
OpenAPI Spec
OpenAPI Spec
Request Parameters#
identityProviderId UUID required The unique Id of the Twitter Identity Provider to retrieve.
Response#
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. |
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 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 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.attributeMappings Map<String, String> Available since 1.65.0A map of attribute mappings applied during user reconciliation when a reconcile Lambda is not configured.
Each key is the FusionAuth target field path and begins with user. or registration.. Each value is the source expression from the identity provider response payload.
This configuration is ignored when identityProvider.linkingStrategy is LinkAnonymously.
Mappings that resolve to null, cannot be extracted, or cannot be written to the target field are ignored at runtime. Mappings to user.password do not set a password.
identityProvider.debug Boolean Available since 1.7.3Determines 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 provider.
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.0The 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 The linking strategy to use when creating the link between the Identity Provider and the user.
The possible values are:
CreatePendingLink- Create pending link.Disabled- Disables linking automatically. Available since1.37.0LinkAnonymously- 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 this Twitter identity provider. This is only used for display purposes.
identityProvider.source String Available since 1.65.0The source for this Identity Provider.
identityProvider.tenantConfiguration Map<UUID, Object> Available since 1.32.0The 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.0The policy that governs identity provider links on a Tenant.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled Boolean Defaults to false Available since 1.32.0When 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.0The 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.tenantId UUID Available since 1.62.0The unique Id of the Tenant. This value is present if the identity provider is tenant-scoped. Tenant-scoped identity providers can only be used to authenticate in the context of the specified tenant. This value is read-only once the key is created.
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": "c2e7f5d4-9a31-46b8-80c2-5d1a7b3f6e94",
"insertInstant": 1595361142909,
"lastUpdateInstant": 1595361143101,
"name": "Twitter Provider",
"tenantConfiguration": {
"e872a880-b14f-6d62-c312-cb40f22af465": {
"limitUserLinkCount": {
"enabled": false,
"maximumLinks": 42
}
}
},
"type": "Twitter"
}
}Update a Twitter Identity Provider#
This API is used to update an existing Twitter Identity Provider.
You must specify all of the properties of the Twitter Identity Provider when calling this API with the PUT HTTP method. When used with PUT, this API doesn't merge the existing Twitter Identity Provider and your new data. It replaces the existing Twitter Identity Provider with your new data.
Utilize the PATCH HTTP method to send specific changes to merge into an existing Twitter Identity Provider.
Request#
OpenAPI Spec
OpenAPI Spec
For backward compatibility, the PATCH method accepts the same media type (specified by a Content-Type of application/json) and body as the PUT request. You can also use the following media types for different behavior:
- JSON Patch/RFC 6902:
application/json-patch+json - JSON Merge Patch/RFC 7396:
merge-patch+json
For details, see the PATCH documentation.
Using a media type of application/json merges the provided request parameters into the existing object. As a result, all parameters are optional with PATCH: only provide the values you want to change. To remove a value, provide a null value. Patching an Array appends all values in the new list to the old list.
For backward compatibility, the PATCH method accepts the same media type (specified by a Content-Type of application/json) and body as the PUT request. You can also use the following media types for different behavior:
- JSON Patch/RFC 6902:
application/json-patch+json - JSON Merge Patch/RFC 7396:
merge-patch+json
For details, see the PATCH documentation.
Using a media type of application/json merges the provided request parameters into the existing object. As a result, all parameters are optional with PATCH: only provide the values you want to change. To remove a value, provide a null value. Patching an Array appends all values in the new list to the old list.
1.61.045bb233c-0901-4236-b5ca-ac46e2e0a5a5.Request Parameters#
identityProviderId UUID required Immutable The unique Id of the Twitter Identity Provider to update.
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.attributeMappings Map<String, String> optional Available since 1.65.0A map of attribute mappings applied during user reconciliation when a reconcile Lambda is not configured.
Each key is the FusionAuth target field path and must begin with user. or registration.. Each value is the source expression in the identity provider response payload. A dot-notated value such as email or id_token.given_name is converted to a JSON Pointer. A value that starts with / is treated as a JSON Pointer as-is.
This property cannot be used with identityProvider.lambdaConfiguration.reconcileId.
This property is ignored when identityProvider.linkingStrategy is LinkAnonymously.
This property defaults to an empty map.
Mappings that resolve to null, cannot be extracted, or cannot be written to the target field are ignored. Mappings to user.password do not set a password.
identityProvider.debug Boolean optional Defaults to false 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.0The 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 The linking strategy to use when creating the link between the Identity Provider and the user.
Available since 1.65.0 You can only change this value when the identity provider is disabled. To change the linking strategy for an identity provider that is already enabled, disable the provider, change the value, and then re-enable the provider.
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.Disabled- Disables linking automatically. You must use the API to create links. Available since1.37.0LinkAnonymously- 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.name String optional Available since 1.61.0The display name of this provider instance. Required when using a provided identityProviderId or identityProvider.tenantId.
identityProvider.source String optional Defaults to System Available since 1.65.0The source of this Identity Provider.
The maximum length is 191 characters.
This value is only used on create. If provided on update, it is ignored and the existing value is preserved.
identityProvider.tenantConfiguration Map<UUID, Object> Available since 1.32.0The 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.0The policy that governs identity provider links on a Tenant.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled Boolean Defaults to false Available since 1.32.0When 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.0The 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.tenantId UUID optional Available since 1.62.0The unique Id of the Tenant.
Providing a value creates an identity provider scoped to the specified tenant, otherwise a global identity provider is created. Tenant-scoped identity providers can only be used to authenticate in the context of the specified tenant. Global identity providers can be used with any tenant.
This value is read-only once the identity provider is created.
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",
"name": "Twitter Provider",
"debug": false,
"enabled": true,
"tenantConfiguration": {
"e872a880-b14f-6d62-c312-cb40f22af465": {
"limitUserLinkCount": {
"enabled": false,
"maximumLinks": 42
}
}
},
"type": "Twitter"
}
}Response#
The response for this API contains a Twitter Identity Provider.
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 are trying to update doesn't exist. The response will be empty. |
| 409 | A conflict was encountered processing this request. If the response has a general error code of [retryableConflict], then the client should exponentially backoff and retry the request. |
| 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 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 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.attributeMappings Map<String, String> Available since 1.65.0A map of attribute mappings applied during user reconciliation when a reconcile Lambda is not configured.
Each key is the FusionAuth target field path and begins with user. or registration.. Each value is the source expression from the identity provider response payload.
This configuration is ignored when identityProvider.linkingStrategy is LinkAnonymously.
Mappings that resolve to null, cannot be extracted, or cannot be written to the target field are ignored at runtime. Mappings to user.password do not set a password.
identityProvider.debug Boolean Available since 1.7.3Determines 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 provider.
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.0The 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.0The 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 since1.37.0LinkAnonymously- 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 this Twitter identity provider. This is only used for display purposes.
identityProvider.source String Available since 1.65.0The source for this Identity Provider.
identityProvider.tenantConfiguration Map<UUID, Object> Available since 1.32.0The 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.0The policy that governs identity provider links on a Tenant.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled Boolean Defaults to false Available since 1.32.0When 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.0The 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.tenantId UUID Available since 1.62.0The unique Id of the Tenant. This value is present if the identity provider is tenant-scoped. Tenant-scoped identity providers can only be used to authenticate in the context of the specified tenant. This value is read-only once the key is created.
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": "c2e7f5d4-9a31-46b8-80c2-5d1a7b3f6e94",
"insertInstant": 1595361142909,
"lastUpdateInstant": 1595361143101,
"name": "Twitter Provider",
"tenantConfiguration": {
"e872a880-b14f-6d62-c312-cb40f22af465": {
"limitUserLinkCount": {
"enabled": false,
"maximumLinks": 42
}
}
},
"type": "Twitter"
}
}Delete a Twitter Identity Provider#
Request#
OpenAPI Spec
1.61.045bb233c-0901-4236-b5ca-ac46e2e0a5a5.Response#
This API does not return a JSON response body.
Response Codes| Code | Description |
|---|---|
| 200 | The request was successful. |
| 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. |
Complete the Twitter Login#
This API allows you to complete a Twitter login after authenticating a user using the Twitter API. If you are using the FusionAuth login UI with the Twitter button you will not utilize this API directly.
This API is intended to be used if you want to build your own login page and you have added the Twitter login button to your own login page and you then need to complete the login with FusionAuth.
For example, if you built your own login page, you could add a "Login with Twitter" button and complete the Twitter authentication. When you complete the Twitter authentication you will have been returned tokens from Twitter. Using this API you can pass that set of tokens to FusionAuth and we will complete the login workflow and reconcile the user to FusionAuth.
The user does not need to exist yet in FusionAuth to utilize this API, depending on the configured linking strategy. The set of tokens returned from Twitter will be used to retrieve the user's email address or username and if that user does not yet exist in FusionAuth the user may be created.
If createRegistration has been enabled for this identity provider and the user does not yet have a registration for this application, a registration will be automatically created for the user. The user will be assigned any default roles configured for the application.
If createRegistration has not been enabled, a registration will not be created if one does not yet exist. This is useful if you wish to manually provision users and then subsequently allow them to login with Twitter.
Request#
OpenAPI Spec
Request Headers#
X-Forwarded-For String optional The IP address of a client requesting authentication. If the IP address is provided it will be stored in the user's login record. It is generally preferred to specify the IP address in the request body. If it is not provided in the request body this header value will be used if available. However, the request body value takes precedence.
X-FusionAuth-TenantId String optional The unique Id of the tenant used to scope this API request.
The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.
Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.
See Making an API request using a Tenant Id for additional information.
Request Body
applicationId UUID required The Id of the Application the user is to be logged into. This application must have Twitter login enabled for this request to succeed.
data.oauth_token String required The Twitter OAuth token returned from their login API. This token will be sent to the Twitter OAuth Access Token API as the oauth_token parameter.
Available since 1.25.0
If this value is an access token then it will not be sent to the Twitter OAuth Access Token API, and instead be directly used to call the Twitter Verify Credentials API to obtain user details. See notes in oauth_verifier.
data.oauth_token_secret String required The Twitter OAuth token secret returned from their login API. This token will be used to sign the request to the OAuth Access Token API.
Available since 1.25.0
If this value is an access token then it will not be sent to the Twitter OAuth Access Token API, and instead be directly used to call the Twitter Verify Credentials API to obtain user details. See notes in oauth_verifier.
data.oauth_verifier String required The Twitter OAuth verifier returned from their login API. This token will be sent to the Twitter OAuth Access Token API in the request body as the oauth_verifier parameter.
Available since 1.25.0
You may optionally omit the oauth_verifier field if the values for oauth_token and oauth_token_secret are an access token. This allows for a use case where you are not using the FusionAuth themed login pages and you have integrated the Twitter login using this API and prior to calling FusionAuth you have already exchanged these values for a Twitter access token. In this scenario, you may take these two parameters representing the access token and FusionAuth will still complete the login for you by skipping the request to exchange the request token for an access token.
identityProviderId UUID required The unique Id of the identity provider to process this login request.
connectionTestId String optional Available since 1.65.0The Id of an identity provider connection test returned by the Start an Identity Provider Connection Test API.
ipAddress String optional The IP address of the end-user that is logging into FusionAuth. If this value is omitted FusionAuth will attempt to obtain the IP address of the client, the value will be that of the X-Forwarded-For header if provided or the last proxy that sent the request. The IP address will be stored in the User login history.
metaData.device.description String optional A human readable description of the device represented by the device parameter.
metaData.device.lastAccessedAddress String optional The IP address of this login request.
metaData.device.name String optional A human readable name of the device represented by the device parameter.
metaData.device.type String optional The type of device represented by the device parameter. Prior to version 1.46.0, this value was restricted to the following types:
BROWSERDESKTOPLAPTOPMOBILEOTHERSERVERTABLETTVUNKNOWN
1.46.0 and beyond, this value can be any string value you'd like, have fun with it!newDevice Boolean optional Defaults to false Indicates that this device has never been used by this user to log in before. One of many signals used to decide whether to issue an MFA challenge as part of Intelligent MFA or the MFA Requirement Lambda. When true, triggers the New Device Webhook.
noJWT Boolean optional Defaults to false When this value is set to true a JWT will not be issued as part of this request. The response body will not contain the token field, and the access_token and refresh_token cookies will not be written to the HTTP response. This optional parameter may be helpful when performing high volume authentication requests and the JWT is not being used, in this scenario removing the additional latency required to issue and sign the JWT may have a measurable cumulative effect on performance.
noLink Boolean optional Defaults to false Available since 1.29.0When this value is set to true, if a link does not yet exist to a FusionAuth user, a 404 status code will be returned instead of using the requested linking strategy. This may be useful if you want to identify if a link exists before starting a full interactive workflow with the user to complete a link.
Example Request JSON
{
"applicationId": "10000000-0000-0002-0000-000000000001",
"data": {
"oauth_token": "1179659262-VUvqmPjPcGC9BxwHdVxMGs0ka5Gmz91G0svPp2Z",
"oauth_token_secret": "9oWLhYVg2fQ4ZmAWPEB0gSnE6tWSVpLRfGlFA6IUwB2Jh",
"oauth_verifier": "uw7NjWHT6OJ1MpJOXsHfNxoAhPKpgI8BlYDhxEjIBY"
},
"identityProviderId": "45bb233c-0901-4236-b5ca-ac46e2e0a5a5",
"ipAddress": "192.168.1.42"
}Response#
The response for this API contains the User object.
Response Cookies#
Response Codes
| Code | Description |
|---|---|
| 200 | The authentication was successful. The response will contain the User object that was authenticated. |
| 202 | The user was authenticated successfully. The user is not registered for the application specified by applicationId on the request.The response will contain the User object that was authenticated. |
| 203 | The user was authenticated successfully. The user is required to change their password, the response will contain the changePasswordId to be used on the Change Password API.Example Response JSON |
| 204 | The login is pending action by the end user. Wait and try the request again. |
| 212 | The user's email address has not yet been verified. The response will contain the User object that was authenticated. If the verification strategy has been set to FormField, the response will contain the emailVerificationId that was generated for the user. |
| 213 | The user's registration has not yet been verified. The response will contain the User object that was authenticated. If the verification strategy has been set to FormField, the response will contain the registrationVerificationId that was generated for the user.Prior to version 1.27.0, this status code was not returned, and you will see a 200 instead. |
| 232 | The user is completing a login with an Identity Provider configured to use the Create a pending link linking strategy and this user does not have a link established. The API response will only contain the pendingIdPLinkId and, possibly, threatsDetected. A call to the Link API's Complete a Pending Link endpoint is required. Once the user is linked, calling this API again will allow login to succeed. Example Response JSON |
| 242 | The user was authenticated successfully. The user has two-factor authentication enabled. Since version 1.42.0, this status code is also returned when two-factor authentication is required. The response will contain the twoFactorId to be used on the Complete Two-Factor Authentication.Example Response JSON |
| 400 | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. |
| 401 | Unable to complete the login request. The user cannot be reconciled or logged in using the external identity provider. |
| 404 | The user was not found, the password was incorrect, the linking strategy is set to disabled, or the value noLink: true is passed on the linking request. The response will be empty. |
| 409 | The user is currently in an action that has prevented login. The response will contain the actions that prevented login. Example Response JSON |
| 410 | The user has expired. 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. |
| 503 | The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body. |
| 504 | One or more Webhook endpoints returned an invalid response or were unreachable. Based on the transaction configuration for this event your action cannot be completed. A stack trace is provided and logged in the FusionAuth log files. |
Response Body#
Response Cookies#
access_token String The access token, this string is an encoded JSON Web Token (JWT). This cookie is written in the response as an HTTP Only session cookie.
refresh_token String The refresh token. This cookie is written in the response as an HTTP only persistent cookie. The cookie expiration is configured in the JWT configuration for the application or the global JWT configuration.