java.lang.Object
- com.pingidentity.sdk.api.authn.model.state.NewPasswordRequired

All Implemented Interfaces:

CaptchaEnabledState, CaptchaProviderEnabledState, Serializable
```
public class NewPasswordRequired
extends Object
implements Serializable, CaptchaEnabledState, CaptchaProviderEnabledState
```
An API state model containing additional details for states in which a new user password is required.

Since:

9.3

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

NewPasswordRequired()

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.
`String`	`getCaptchaProviderType()`	Get the CAPTCHA provider plugin type.
`String`	`getCaptchaSiteKey()`	Get the CAPTCHA site key assigned to your application by Google.
`boolean`	`getShowCaptcha()`	Return true when the 'CAPTCHA' for authentication feature is available.
`String`	`getUserMessage()`	Get the user-facing error message.
`String`	`getUsername()`	Get the username hint to be presented to the user.
`boolean`	`isExistingPasswordRequired()`	Return true when the user's existing password is required.
`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`	`setExistingPasswordRequired(boolean existingPasswordRequired)`	Set to true when the user's existing password is required.
`void`	`setShowCaptcha(boolean showCaptcha)`	Set the 'CAPTCHA' for authentication feature availability
`void`	`setUserMessage(String userMessage)`	Directly set the localized user-facing error message.
`void`	`setUserMessageKey(String userMessageKey)`	Set the user-facing error message key.
`void`	`setUsername(String username)`	Set the username hint to be presented to the user.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - NewPasswordRequired
```
public NewPasswordRequired()
```
- Method Detail
  - getUsername
```
public String getUsername()
```
    Get the username hint to be presented to the user. This hint may be specified through a parameter on a protocol request or through an authentication policy mapping.
  - setUsername
```
public void setUsername(String username)
```
    Set the username hint to be presented to the user.
  - 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
  - getUserMessage
```
public String getUserMessage()
```
    Get the user-facing error message. A user-facing error message should be provided for any error likely to be displayed to the end user. A localizable message key can be provided with setUserMessageKey() or the localized error message can be directly set with setUserMessage().
  - setUserMessageKey
```
public void setUserMessageKey(String userMessageKey)
```
    Set the user-facing error message key. In the JSON serialization this key will automatically be converted to a localized string if a corresponding message is defined in the authn-api-messages or pingfederate-messages properties file for the user's locale.
  - setUserMessage
```
public void setUserMessage(String userMessage)
```
    Directly set the localized user-facing error message.
  - isExistingPasswordRequired
```
public boolean isExistingPasswordRequired()
```
    Return true when the user's existing password is required.
    
    Since:
    
    10.2
  - setExistingPasswordRequired
```
public void setExistingPasswordRequired(boolean existingPasswordRequired)
```
    Set to true when the user's existing password is required.
    
    Since:
    
    10.2
  - 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

Class NewPasswordRequired

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NewPasswordRequired

Method Detail

getUsername

setUsername

getShowCaptcha

setShowCaptcha

getCaptchaSiteKey

setCaptchaSiteKey

getUserMessage

setUserMessageKey

setUserMessage

isExistingPasswordRequired

setExistingPasswordRequired

getCaptchaProviderType

setCaptchaProviderType

getCaptchaAttributes

setCaptchaAttributes