PingFederate Server

Configuring Google reCAPTCHA Enterprise

PingFederate includes plugins that support Google’s reCAPTCHA Enterprise service.

Before you begin

Before you can add an instance of Google reCAPTCHA Enterprise, get a project ID and key pair from Google. The key pair consists of a site key and API secret key. Learn more in Google’s reCAPTCHA documentation.

If you’re replacing the default JavaScript file to be loaded for reCAPTCHA, ensure the replacement file is in the <pf_install>/pingfederate/server/default/conf/template/assets/scripts/captcha directory.

Steps

  1. Go to System > External Systems → CAPTCHA Providers.

  2. Click the Create New Instance button. The Create CAPTCHA Provider Instance window opens.

  3. On the Type tab:

    1. Enter a provider Instance Name. This is a friendly name for the instance.

    2. Enter a Instance ID. This is the ID that PingFederate uses to identify the instance.

    3. In the Type list, select reCAPTCHA Enterprise.

  4. On the Instance Configuration tab:

    1. Enter the Project ID. You can find this value in the Google Cloud Admin console by clicking the project name at the top of the window.

    2. Enter the Site Key. You can copy this value from the reCAPTCHA key on the reCAPTCHA page in the Google Cloud Admin console.

    3. Enter the API Key Secret. You can find this value in the Google Cloud Admin console at APIs & Services → Credentials.

  5. (Optional) Click Show Advanced Fields.

  6. (Optional) Enter the Pass Score Threshold.

  7. (Optional) To replace the default JavaScript file to be loaded for reCAPTCHA, enter the new JavaScript File Name.

  8. Select a failure mode for when Enterprise reCAPTCHA is unavailable or when an error occurs.

  9. If you selected Continue with fallback policy decision as the failure mode, enter a value for a score result to use in the fallback authentication policy.

  10. Click Next.

  11. On the Summary tab, review the configuration.

  12. Click Save.