Class RegistrationRequired
- java.lang.Object
-
- com.pingidentity.sdk.api.authn.model.state.RegistrationRequired
-
- All Implemented Interfaces:
CaptchaEnabledState,CaptchaProviderEnabledState,ThisIsMyDeviceState,Serializable
public class RegistrationRequired extends Object implements Serializable, CaptchaEnabledState, ThisIsMyDeviceState, CaptchaProviderEnabledState
An API state model for when user registration is required.- Since:
- 10.1
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description RegistrationRequired()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<AlternativeAuthenticationSource>getAlternativeAuthenticationSources()StringgetAuthenticationSource()Map<String,Object>getCaptchaAttributes()Get the CAPTCHA attributes as provided by the CAPTCHA provider plugin.StringgetCaptchaProviderType()Get the CAPTCHA provider plugin type.StringgetCaptchaSiteKey()Get the CAPTCHA site key assigned to your application by Google.List<Field>getFields()booleangetShowCaptcha()Return true when the 'CAPTCHA' for authentication feature is available.booleangetShowThisIsMyDevice()Return true when the 'This Is My Device' option is available.voidsetAlternativeAuthenticationSources(List<AlternativeAuthenticationSource> alternativeAuthenticationSources)voidsetAuthenticationSource(String authenticationSource)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.voidsetCaptchaSiteKey(String captchaSiteKey)Set the CAPTCHA site key assigned to your application by Google.voidsetFields(List<Field> fields)voidsetShowCaptcha(boolean showCaptcha)Set the 'CAPTCHA' for authentication feature availabilityvoidsetShowThisIsMyDevice(boolean showThisIsMyDevice)Set the 'This Is My Device' option availability
-
-
-
Method Detail
-
getAlternativeAuthenticationSources
public List<AlternativeAuthenticationSource> getAlternativeAuthenticationSources()
-
setAlternativeAuthenticationSources
public void setAlternativeAuthenticationSources(List<AlternativeAuthenticationSource> alternativeAuthenticationSources)
-
getShowCaptcha
public boolean getShowCaptcha()
Description copied from interface:CaptchaEnabledStateReturn true when the 'CAPTCHA' for authentication feature is available.- Specified by:
getShowCaptchain interfaceCaptchaEnabledState- Specified by:
getShowCaptchain interfaceCaptchaProviderEnabledState
-
setShowCaptcha
public void setShowCaptcha(boolean showCaptcha)
Description copied from interface:CaptchaEnabledStateSet the 'CAPTCHA' for authentication feature availability- Specified by:
setShowCaptchain interfaceCaptchaEnabledState- Specified by:
setShowCaptchain interfaceCaptchaProviderEnabledState
-
getCaptchaSiteKey
public String getCaptchaSiteKey()
Description copied from interface:CaptchaEnabledStateGet the CAPTCHA site key assigned to your application by Google. This field will only be populated if the CAPTCHA provider is reCAPTCHA v2, v3, or Enterprise.- Specified by:
getCaptchaSiteKeyin interfaceCaptchaEnabledState
-
setCaptchaSiteKey
public void setCaptchaSiteKey(String captchaSiteKey)
Description copied from interface:CaptchaEnabledStateSet the CAPTCHA site key assigned to your application by Google.- Specified by:
setCaptchaSiteKeyin interfaceCaptchaEnabledState
-
getShowThisIsMyDevice
public boolean getShowThisIsMyDevice()
Description copied from interface:ThisIsMyDeviceStateReturn true when the 'This Is My Device' option is available.- Specified by:
getShowThisIsMyDevicein interfaceThisIsMyDeviceState
-
setShowThisIsMyDevice
public void setShowThisIsMyDevice(boolean showThisIsMyDevice)
Description copied from interface:ThisIsMyDeviceStateSet the 'This Is My Device' option availability- Specified by:
setShowThisIsMyDevicein interfaceThisIsMyDeviceState
-
getAuthenticationSource
public String getAuthenticationSource()
-
setAuthenticationSource
public void setAuthenticationSource(String authenticationSource)
-
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
-
-