Class IdentifierRequired
- java.lang.Object
-
- com.pingidentity.sdk.api.authn.model.state.IdentifierRequired
-
- All Implemented Interfaces:
CaptchaProviderEnabledState
public class IdentifierRequired extends Object implements CaptchaProviderEnabledState
An API state model containing additional details for states in which an identifier is required for authentication to proceed.- Since:
- 10.0
-
-
Constructor Summary
Constructors Constructor Description IdentifierRequired()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Map<String,Object>getCaptchaAttributes()Get the CAPTCHA attributes as provided by the CAPTCHA provider plugin.StringgetCaptchaProviderType()Get the CAPTCHA provider plugin type.List<String>getPreviouslySubmittedIdentifiers()Get the list of previously submitted identifiers.booleangetShowCaptcha()Return true when the 'CAPTCHA' for authentication feature is available.voidsetCaptchaAttributes(Map<String,Object> captchaAttributes)Set the CAPTCHA attributes as provided by the CAPTCHA provider plugin.voidsetCaptchaProviderType(String captchaProviderType)Set the CAPTCHA provider plugin type.voidsetPreviouslySubmittedIdentifiers(List<String> previouslySubmittedIdentifiers)Set the list of previously submitted identifiers.voidsetShowCaptcha(boolean showCaptcha)Set the 'CAPTCHA' for authentication feature availability.
-
-
-
Method Detail
-
getPreviouslySubmittedIdentifiers
public List<String> getPreviouslySubmittedIdentifiers()
Get the list of previously submitted identifiers.
-
setPreviouslySubmittedIdentifiers
public void setPreviouslySubmittedIdentifiers(List<String> previouslySubmittedIdentifiers)
Set the list of previously submitted identifiers.
-
getShowCaptcha
public boolean getShowCaptcha()
Description copied from interface:CaptchaProviderEnabledStateReturn true when the 'CAPTCHA' for authentication feature is available.- Specified by:
getShowCaptchain interfaceCaptchaProviderEnabledState
-
setShowCaptcha
public void setShowCaptcha(boolean showCaptcha)
Description copied from interface:CaptchaProviderEnabledStateSet the 'CAPTCHA' for authentication feature availability.- Specified by:
setShowCaptchain interfaceCaptchaProviderEnabledState
-
getCaptchaProviderType
public String getCaptchaProviderType()
Description copied from interface:CaptchaProviderEnabledStateGet the CAPTCHA provider plugin type.- Specified by:
getCaptchaProviderTypein interfaceCaptchaProviderEnabledState
-
setCaptchaProviderType
public void setCaptchaProviderType(String captchaProviderType)
Description copied from interface:CaptchaProviderEnabledStateSet the CAPTCHA provider plugin type.- Specified by:
setCaptchaProviderTypein interfaceCaptchaProviderEnabledState
-
getCaptchaAttributes
public Map<String,Object> getCaptchaAttributes()
Description copied from interface:CaptchaProviderEnabledStateGet 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.- Specified by:
getCaptchaAttributesin interfaceCaptchaProviderEnabledState
-
setCaptchaAttributes
public void setCaptchaAttributes(Map<String,Object> captchaAttributes)
Description copied from interface:CaptchaProviderEnabledStateSet the CAPTCHA attributes as provided by the CAPTCHA provider plugin.- Specified by:
setCaptchaAttributesin interfaceCaptchaProviderEnabledState
-
-