Package com.pingidentity.sdk.api.authn.model.state.interfaces

Interface CaptchaProviderEnabledState

All Known Implementing Classes:
AccountRecoveryUsernameRequired, CurrentCredentialsRequired, IdentifierRequired, NewPasswordRequired, PasswordResetRequired, RegistrationRequired, UsernamePasswordRequired, UsernameRecoveryEmailRequired
public interface CaptchaProviderEnabledState
A state that can have CAPTCHA enabled with a CAPTCHA provider.
Since:
11.2

  • Method Details

    • getShowCaptcha

      boolean getShowCaptcha()
      Return true when the 'CAPTCHA' for authentication feature is available.
      Since:
      11.2

    • setShowCaptcha

      void setShowCaptcha(boolean showCaptcha)
      Set the 'CAPTCHA' for authentication feature availability.
      Since:
      11.2

    • getCaptchaProviderType

      String getCaptchaProviderType()
      Get the CAPTCHA provider plugin type.
      Since:
      11.2

    • setCaptchaProviderType

      void setCaptchaProviderType(String captchaProviderType)
      Set the CAPTCHA provider plugin type.
      Since:
      11.2

    • getCaptchaAttributes

      Map<String,Object> getCaptchaAttributes()
      Get the CAPTCHA attributes as provided by the CAPTCHA provider plugin. The CAPTCHA provider plugin CAPTCHA attributes. Google's reCAPTCHA v2 CAPTCHA provider will provide 'siteKey', Google's reCAPTCHA v3 and reCAPTCHA Enterprise CAPTCHA provider will provide 'siteKey' and 'action' to be able to invoke the challenge.
      Since:
      11.2

    • setCaptchaAttributes

      void setCaptchaAttributes(Map<String,Object> captchaAttributes)
      Set the CAPTCHA attributes as provided by the CAPTCHA provider plugin.
      Since:
      11.2