Package com.pingidentity.sdk.captchaprovider

Interface CaptchaProvider

All Superinterfaces:
ConfigurablePlugin, DescribablePlugin, Plugin
public interface CaptchaProvider extends Plugin
This interface defines the methods that the PingFederate server calls to complete CAPTCHA from external CAPTCHA services.

The 'actions' defined below help characterize the request triggering CAPTCHA.

Since:
11.2

  • Field Details

    • IDENTIFY_ACTION

      static final String IDENTIFY_ACTION
      The action associated with getting an identifier such as a username. the value is a String.
      Since:
      12.0
      See Also:

    • LOGIN_ACTION

      static final String LOGIN_ACTION
      The login 'action'. The value is a String.
      See Also:

    • USERNAME_RECOVERY_ACTION

      static final String USERNAME_RECOVERY_ACTION
      The username recovery 'action'. The value is a String.
      See Also:

    • PASSWORD_RESET_ACTION

      static final String PASSWORD_RESET_ACTION
      The password reset 'action'. The value is a String.
      See Also:

    • PASSWORD_CHANGE_ACTION

      static final String PASSWORD_CHANGE_ACTION
      The password change 'action'. The value is a String.
      See Also:

    • REGISTRATION_ACTION

      static final String REGISTRATION_ACTION
      The registration 'action'. The value is a String.
      See Also:

  • Method Details

    • getJavaScriptFileName

      String getJavaScriptFileName()
      The JavaScript file name to execute to prepare the page for CAPTCHA.
      Returns:
      The JavaScript file name.
      Since:
      11.2

    • getCaptchaAttributes

      Map<String,Object> getCaptchaAttributes(CaptchaContext captchaContext)
      Provides additional attributes to the JavaScript File executing to prepare the page for CAPTCHA.
      Parameters:
      captchaContext - CaptchaContext containing contextual information of the request.
      Returns:
      CAPTCHA attributes to be used by the JavaScript File.
      Since:
      11.2

    • validateCaptcha

      CaptchaResult validateCaptcha(CaptchaContext captchaContext)
      Validate CAPTCHA to determine whether the request succeeds or fails.
      Parameters:
      captchaContext - CaptchaContext containing contextual information of the request.
      Returns:
      CaptchaResult the result of the CAPTCHA.
      Since:
      11.2

    • postAuthenticationCallback

      default void postAuthenticationCallback(CaptchaProvider.AuthenticationStatus authenticationStatus, CaptchaContext captchaContext)
      This method provides a way for the authentication flow to provide more information about the ongoing authentication transaction to the captcha/risk provider before returning the control back to PingFederate.
      Parameters:
      authenticationStatus - the CaptchaProvider.AuthenticationStatus representing the authentication status.
      captchaContext - the CaptchaContext containing contextual information of the request.
      Since:
      11.3