Facebook

Facebook IdP Adapter settings reference

Field descriptions for the Facebook IdP Adapter configuration screen.

Standard fields
Field Description

Application ID

The App ID that you noted in Creating an app in Facebook.

Application Secret

The App Secret that you noted in Creating an app in Facebook.

Site URL

The PingFederate Facebook authentication endpoint that you entered as the Site URL in Creating an app in Facebook: https://pf_host

:pf_port/ext/facebook-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.

Logout URL

The Facebook logout URL. The adapter redirects users to this address to sign them out.

The default value is https://www.facebook.com/logout.php.

Unauthorized redirect URL

When the user does not authorize Facebook to share their user information, PingFederate redirects the browser to this URL instead of the default error page.

This field is blank by default.

Advanced fields
Field Description

Facebook Authentication URL

The Facebook endpoint used for authentication.

If Facebook changes this endpoint, enter the new URL.

The default value is https://www.facebook.com/dialog/oauth.

Facebook Access Token URL

The Facebook endpoint used to retrieve an OAuth access token.

If Facebook changes this endpoint, enter the new URL.

The default value is https://graph.facebook.com/oauth/access_token.

Facebook User Data URL

The Facebook endpoint used to retrieve user data.

If Facebook changes this endpoint, enter the new URL.

The default value is https://graph.facebook.com/me.

Facebook Sign-On Presentation

Determines how the user is directed to Facebook for authentication. If automatic redirects are blocked in your environment, select Pop-up window. If you are not using PingFederate in authentication API mode, this alternative presents a template file that requires user interaction.

The default value is Redirect.

Facebook Template

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

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

Facebook Post Auth Template

The template that adapter presents after the user signs on. This template signals to the main template or authentication widget to continue the authentication flow. Applies only when Facebook sign-on presentation is set to Pop-up window.

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

Retry Request

Determines whether the adapter retries requests when the Facebook API responds with an error code listed in the Retry Error Codes field.

This check box is cleared by default.

Maximum Retries Limit

Determines the number of times the adapter retries a request.

The default value is 5.

Retry Error Codes

The list of error codes that cause the adapter to retry a request. Separate multiple error codes with a comma.

For a list of error codes, see Handling Errors in the Facebook documentation.

The default value is 4, 7, 341.

API Request Timeout

The amount of time in milliseconds that PingFederate waits for the Facebook API to respond to requests. A value of 0 disables the timeout.

The default value is 5000.

Connection Timeout

The amount of time in milliseconds that PingFederate allows to establish a connection with the Facebook API. A value of 0 disables the timeout.

The default value is 5000.

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.