Twitter Login Integration Kit

Twitter IdP Adapter settings reference

Field descriptions for the Twitter IdP Adapter configuration screen.

Standard fields
Field Description

Consumer Key

The consumer key that you noted in Registering PingFederate in Twitter.

Consumer Secret

The consumer secret that you noted in Registering PingFederate in Twitter.

Callback Endpoint

The PingFederate endpoint that Twitter uses to respond to authorization requests. If you set a custom endpoint in the Authorization callback URL field in Registering PingFederate in Twitter, change this field to match.

This default value is /twitter-authn.

Error Redirect URL

When an error occurs in the adapter, PingFederate redirects the browser to this URL instead of the default error page.

This field is blank by default.

Unauthorized Redirect URL

When a user denies the requested Twitter permissions, PingFederate redirects the browser to this URL instead of the default error page.

This field is blank by default.

Advanced fields
Field Description

PingFederate Base URL

The fully-qualified host name, port, and path of the PingFederate server. This URL is used to construct the callback URL sent to Twitter.

This field is blank by default.

Twitter Authentication URL

The URL that PingFederate uses to send authentication requests to Twitter. If Twitter changes this endpoint, enter the new URL.

The default value is https://api.twitter.com/oauth/authenticate?oauth_token=.

Twitter User Data URL

The URL that PingFederate uses to retrieve user data from Twitter.

The default value is https://api.twitter.com/1.1/account/verify_credentials.json.

Twitter Access Token Invalidation URL

The URL that PingFederate uses to signal Twitter to invalidate an access token.

The default value is https://api.twitter.com/1.1/oauth/invalidate_token.

Twitter Login Presentation

Determines how the adapter presents the Twitter sign-on form.

Redirect (default)

The adapter redirects the browser to the Twitter sign-on form.

Pop-up window

The adapter opens a new window with the Twitter sign-on form on a PingFederate template. Use this option if automatic redirects are blocked by your users' browsers.

This setting has no effect when using the adapter through the PingFederate authentication API.

Twitter Pop-Up Template

The template file that presents the Twitter sign-on form. Applies only when Twitter Login Presentation is set to Pop-up window.

The default value is twitter-pop-up-template.html.

Twitter Post-Auth Template

The template file that the adapter presents after the user signs on. Applies only when Twitter Login Presentation is set to Pop-up window.

The default value is twitter-post-auth-template.html.

Twitter Messages File

The language-pack file associated with the Twitter pop-up template.

The default value is pingfederate-twitter-adapter-messages.

Retry Request

Determines whether PingFederate will retry requests after it receives a response with a failure code.

This check box is selected by default.

Maximum Retries Limit

Determines how many times PingFederate retries a request.

The default value is 5.

Retry Error Codes

A list of response codes that you want to trigger a retry. Separate response codes with a comma.

The default value is 429.

API Request Timeout

The amount of time in milliseconds that PingFederate allows when establishing a connection with Twitter or waiting for a response to a request. A value of 0 disables the timeout.

The default value is 2000.

Proxy Settings

Defines proxy settings for outbound HTTP requests.

The default value is System Defaults.

Custom Proxy Host

The proxy server host name to use when Proxy Settings is set to Custom.

This field is blank by default.

Custom Proxy Port

The proxy server port to use when Proxy Settings is set to Custom.

This field is blank by default.