PingFederate Server

Managing CAPTCHA providers

PingFederate lets you add and configure CAPTCHA service provider instances. PingFederate includes plugins that support Google’s reCAPTCHA v2 Invisible and v3 services.

Before you begin

Before you can add an instance of a Google reCAPTCHA service provider, get an API key pair from Google. The key pair consists of a site key and secret key. For more information, see Google’s reCAPTCHA Developer’s Guide.

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.

About this task

The following procedure explains how to add and configure an instance of a reCAPTCHA service provider.

Steps

  1. Go to System → External Systems → CAPTCHA Providers. Screenshot of the Captcha Providers window

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

  3. On the Type tab, enter a provider Instance Name and Instance ID, and select a Type.

  4. On the Instance Configuration tab:

    1. Enter the Site Key and Secret Key from Google.

    2. If you’re adding a reCAPTCHA v3 instance, enter the Pass Score Threshold.

    3. Optional: To replace the default JavaScript file to be loaded for reCAPTCHA, click Show Advanced Fields and enter the new JavaScript File Name.

    Screenshot of the Create Captcha Provider Instance window’s Instance Configuration tab

  5. On the Summary tab, review the configuration.

  6. Click Save.