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

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

Modifier and Type	Method	Description
List<AlternativeAuthenticationSource>	getAlternativeAuthenticationSources()
String	getAuthenticationSource()
Map<String,Object>	getCaptchaAttributes()	Get the CAPTCHA attributes as provided by the CAPTCHA provider plugin.
String	getCaptchaProviderType()	Get the CAPTCHA provider plugin type.
String	getCaptchaSiteKey()	Get the CAPTCHA site key assigned to your application by Google.
List<Field>	getFields()
boolean	getShowCaptcha()	Return true when the 'CAPTCHA' for authentication feature is available.
boolean	getShowThisIsMyDevice()	Return true when the 'This Is My Device' option is available.
void	setAlternativeAuthenticationSources(List<AlternativeAuthenticationSource> alternativeAuthenticationSources)
void	setAuthenticationSource(String authenticationSource)
void	setCaptchaAttributes(Map<String,Object> captchaAttributes)	Set the CAPTCHA attributes as provided by the CAPTCHA provider plugin.
void	setCaptchaProviderType(String captchaProviderType)	Set the CAPTCHA provider plugin type.
void	setCaptchaSiteKey(String captchaSiteKey)	Set the CAPTCHA site key assigned to your application by Google.
void	setFields(List<Field> fields)
void	setShowCaptcha(boolean showCaptcha)	Set the 'CAPTCHA' for authentication feature availability
void	setShowThisIsMyDevice(boolean showThisIsMyDevice)	Set the 'This Is My Device' option availability

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RegistrationRequired

public RegistrationRequired()

Method Details

getFields

public List<Field> getFields()

setFields

public void setFields(List<Field> fields)

getAlternativeAuthenticationSources

public List<AlternativeAuthenticationSource> getAlternativeAuthenticationSources()

setAlternativeAuthenticationSources

public void setAlternativeAuthenticationSources(List<AlternativeAuthenticationSource> alternativeAuthenticationSources)

getShowCaptcha

public boolean getShowCaptcha()

Description copied from interface: CaptchaEnabledState

Return true when the 'CAPTCHA' for authentication feature is available.

Specified by:

getShowCaptcha in interface CaptchaEnabledState

Specified by:

getShowCaptcha in interface CaptchaProviderEnabledState

setShowCaptcha

public void setShowCaptcha(boolean showCaptcha)

Description copied from interface: CaptchaEnabledState

Set the 'CAPTCHA' for authentication feature availability

Specified by:

setShowCaptcha in interface CaptchaEnabledState

Specified by:

setShowCaptcha in interface CaptchaProviderEnabledState

getCaptchaSiteKey

public String getCaptchaSiteKey()

Description copied from interface: CaptchaEnabledState

Get 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:

getCaptchaSiteKey in interface CaptchaEnabledState

setCaptchaSiteKey

public void setCaptchaSiteKey(String captchaSiteKey)

Description copied from interface: CaptchaEnabledState

Set the CAPTCHA site key assigned to your application by Google.

Specified by:

setCaptchaSiteKey in interface CaptchaEnabledState

getShowThisIsMyDevice

public boolean getShowThisIsMyDevice()

Description copied from interface: ThisIsMyDeviceState

Return true when the 'This Is My Device' option is available.

Specified by:

getShowThisIsMyDevice in interface ThisIsMyDeviceState

setShowThisIsMyDevice

public void setShowThisIsMyDevice(boolean showThisIsMyDevice)

Description copied from interface: ThisIsMyDeviceState

Set the 'This Is My Device' option availability

Specified by:

setShowThisIsMyDevice in interface ThisIsMyDeviceState

getAuthenticationSource

public String getAuthenticationSource()

setAuthenticationSource

public void setAuthenticationSource(String authenticationSource)

getCaptchaProviderType

public String getCaptchaProviderType()

Description copied from interface: CaptchaProviderEnabledState

Get the CAPTCHA provider plugin type.

Specified by:

getCaptchaProviderType in interface CaptchaProviderEnabledState

setCaptchaProviderType

public void setCaptchaProviderType(String captchaProviderType)

Description copied from interface: CaptchaProviderEnabledState

Set the CAPTCHA provider plugin type.

Specified by:

setCaptchaProviderType in interface CaptchaProviderEnabledState

getCaptchaAttributes

public Map<String,Object> getCaptchaAttributes()

Description copied from interface: CaptchaProviderEnabledState

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.

Specified by:

getCaptchaAttributes in interface CaptchaProviderEnabledState

setCaptchaAttributes

public void setCaptchaAttributes(Map<String,Object> captchaAttributes)

Description copied from interface: CaptchaProviderEnabledState

Set the CAPTCHA attributes as provided by the CAPTCHA provider plugin.

Specified by:

setCaptchaAttributes in interface CaptchaProviderEnabledState