java.lang.Object
- com.pingidentity.sdk.api.authn.common.CommonStatus

```
public class CommonStatus
extends Object
```
This class defines a set of common statuses for use across API-capable PingFederate plugins.

Since:

9.3

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ACCOUNT_LINKING_FAILED`	The status indicating that user account linking has failed.
`static String`	`ACCOUNT_RECOVERY_OTL_VERIFICATION_REQUIRED`	The status indicating that an user verification action is required for account recovery to proceed.
`static String`	`ACCOUNT_RECOVERY_USERNAME_REQUIRED`	The status indicating that an username is required for account recovery to proceed.
`static String`	`AUTHENTICATION_REQUIRED`	The status indicating that multi-factor authentication is required.
`static String`	`CANCELED`	The status indicating that an authentication API action is canceled.
`static String`	`CHALLENGE_RESPONSE_REQUIRED`	The status indicating that the user must enter their one-time challenge response to proceed.
`static String`	`CHANGE_PASSWORD_EXTERNAL`	The status indicating that the user's password must be changed at an external password management system.
`static String`	`COMPLETED`	The status indicating that an authentication API action is complete.
`static String`	`CURRENT_CREDENTIALS_REQUIRED`	The status indicating that the current credentials are required during password change configured with multi-factor authentication.
`static String`	`DEVICE_PROFILE_REQUIRED`	The status indicating that the user's device profile is required.
`static String`	`DEVICE_PROFILE_SESSION_ID_REQUIRED`	The status indicating that a session id from device profiling is required.
`static String`	`DEVICE_SELECTION_REQUIRED`	The status indicating that device selection is required.
`static String`	`EMAIL_VERIFICATION_OTP_REQUIRED`	The status indicating that the user is required to verify their email via OTP.
`static String`	`EMAIL_VERIFICATION_REQUIRED`	The status indicating that the user is required to verify their email.
`static String`	`FAILED`	The status indicating that an error occurred that terminated the authentication flow.
`static String`	`IDENTIFIER_REQUIRED`	The status indicating that an identifier is required for authentication to proceed.
`static String`	`MFA_COMPLETED`	The status indicating that the user has completed multi-factor authentication.
`static String`	`MFA_FAILED`	The status indicating that the user has failed multi-factor authentication.
`static String`	`MOBILE_PAIRING_REQUIRED`	The status indicating that mobile pairing is required.
`static String`	`MUST_CHANGE_PASSWORD`	The status indicating that the user's password has expired and must be changed.
`static String`	`NEW_PASSWORD_RECOMMENDED`	The status indicating that the user's password is about to expire, and a password change is recommended.
`static String`	`NEW_PASSWORD_REQUIRED`	The status indicating that a new password is required.
`static String`	`OAUTH_DEVICE_COMPLETED`	The status in the OAuth device authorization flow where device authorization has completed successfully.
`static String`	`OAUTH_DEVICE_USER_CODE_CONFIRMATION_REQUIRED`	The status in the OAuth device authorization flow where the user must confirm that the code presented matches the one on the device.
`static String`	`OAUTH_DEVICE_USER_CODE_REQUIRED`	The status in the OAuth device authorization flow where the user must provide a code to authorize the device.
`static String`	`OTP_REQUIRED`	The status indicating that the user must enter an OTP to proceed.
`static String`	`OTP_VERIFIED`	The status indicating that the user has completed multi-factor authentication via an OTP.
`static String`	`PASSWORD_RESET_REQUIRED`	The status indicating that a new password is required to complete password reset.
`static String`	`PUSH_CONFIRMATION_REJECTED`	The status indicating that the push confirmation is rejected.
`static String`	`PUSH_CONFIRMATION_TIMED_OUT`	The status indicating that the push confirmation is timed out.
`static String`	`PUSH_CONFIRMATION_WAITING`	The status indicating waiting for the user to confirm the push multi-factor authentication request.
`static String`	`RECOVERY_CODE_REQUIRED`	The status indicating that a recovery pass code is required for account recovery to proceed.
`static String`	`REGISTRATION_REQUIRED`
`static String`	`RESUME`	The status indicating that the API client must redirect to PingFederate for processing to continue.
`static String`	`SUCCESSFUL_ACCOUNT_UNLOCK`	The status indicating that the user has successfully completed an account unlock.
`static String`	`SUCCESSFUL_PASSWORD_CHANGE`	The status indicating that the user has successfully completed a password change.
`static String`	`SUCCESSFUL_PASSWORD_RESET`	The status indicating that the user has successfully completed a password reset.
`static String`	`USERNAME_PASSWORD_REQUIRED`	The status indicating that the user must enter their username and password to proceed.
`static String`	`USERNAME_RECOVERY_EMAIL_REQUIRED`	The status indicating that the email address associated with the username to be recovered is required.
`static String`	`USERNAME_RECOVERY_EMAIL_SENT`	The status indicating that the username to be recovered is sent to the associated email.

Constructor Summary

Constructors
Constructor Description

CommonStatus()

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

- Field Detail
  - RESUME
```
public static final String RESUME
```
    The status indicating that the API client must redirect to PingFederate for processing to continue.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - FAILED
```
public static final String FAILED
```
    The status indicating that an error occurred that terminated the authentication flow.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - USERNAME_PASSWORD_REQUIRED
```
public static final String USERNAME_PASSWORD_REQUIRED
```
    The status indicating that the user must enter their username and password to proceed.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - CHALLENGE_RESPONSE_REQUIRED
```
public static final String CHALLENGE_RESPONSE_REQUIRED
```
    The status indicating that the user must enter their one-time challenge response to proceed.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - MUST_CHANGE_PASSWORD
```
public static final String MUST_CHANGE_PASSWORD
```
    The status indicating that the user's password has expired and must be changed.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - CHANGE_PASSWORD_EXTERNAL
```
public static final String CHANGE_PASSWORD_EXTERNAL
```
    The status indicating that the user's password must be changed at an external password management system.
    
    Since:
    
    10.3
    
    See Also:
    
    Constant Field Values
  - SUCCESSFUL_PASSWORD_CHANGE
```
public static final String SUCCESSFUL_PASSWORD_CHANGE
```
    The status indicating that the user has successfully completed a password change.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - NEW_PASSWORD_RECOMMENDED
```
public static final String NEW_PASSWORD_RECOMMENDED
```
    The status indicating that the user's password is about to expire, and a password change is recommended.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - NEW_PASSWORD_REQUIRED
```
public static final String NEW_PASSWORD_REQUIRED
```
    The status indicating that a new password is required.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - ACCOUNT_RECOVERY_USERNAME_REQUIRED
```
public static final String ACCOUNT_RECOVERY_USERNAME_REQUIRED
```
    The status indicating that an username is required for account recovery to proceed.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - ACCOUNT_RECOVERY_OTL_VERIFICATION_REQUIRED
```
public static final String ACCOUNT_RECOVERY_OTL_VERIFICATION_REQUIRED
```
    The status indicating that an user verification action is required for account recovery to proceed.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - RECOVERY_CODE_REQUIRED
```
public static final String RECOVERY_CODE_REQUIRED
```
    The status indicating that a recovery pass code is required for account recovery to proceed.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - PASSWORD_RESET_REQUIRED
```
public static final String PASSWORD_RESET_REQUIRED
```
    The status indicating that a new password is required to complete password reset.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - SUCCESSFUL_PASSWORD_RESET
```
public static final String SUCCESSFUL_PASSWORD_RESET
```
    The status indicating that the user has successfully completed a password reset.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - SUCCESSFUL_ACCOUNT_UNLOCK
```
public static final String SUCCESSFUL_ACCOUNT_UNLOCK
```
    The status indicating that the user has successfully completed an account unlock.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - USERNAME_RECOVERY_EMAIL_REQUIRED
```
public static final String USERNAME_RECOVERY_EMAIL_REQUIRED
```
    The status indicating that the email address associated with the username to be recovered is required.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - USERNAME_RECOVERY_EMAIL_SENT
```
public static final String USERNAME_RECOVERY_EMAIL_SENT
```
    The status indicating that the username to be recovered is sent to the associated email.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER_REQUIRED
```
public static final String IDENTIFIER_REQUIRED
```
    The status indicating that an identifier is required for authentication to proceed.
    
    Since:
    
    10.0
    
    See Also:
    
    Constant Field Values
  - COMPLETED
```
public static final String COMPLETED
```
    The status indicating that an authentication API action is complete.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - CANCELED
```
public static final String CANCELED
```
    The status indicating that an authentication API action is canceled.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - REGISTRATION_REQUIRED
```
public static final String REGISTRATION_REQUIRED
```
    See Also:
    
    Constant Field Values
  - DEVICE_SELECTION_REQUIRED
```
public static final String DEVICE_SELECTION_REQUIRED
```
    The status indicating that device selection is required.
    
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
  - OTP_REQUIRED
```
public static final String OTP_REQUIRED
```
    The status indicating that the user must enter an OTP to proceed.
    
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
  - OTP_VERIFIED
```
public static final String OTP_VERIFIED
```
    The status indicating that the user has completed multi-factor authentication via an OTP.
    
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
  - MFA_FAILED
```
public static final String MFA_FAILED
```
    The status indicating that the user has failed multi-factor authentication.
    
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
  - AUTHENTICATION_REQUIRED
```
public static final String AUTHENTICATION_REQUIRED
```
    The status indicating that multi-factor authentication is required.
    
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
  - PUSH_CONFIRMATION_WAITING
```
public static final String PUSH_CONFIRMATION_WAITING
```
    The status indicating waiting for the user to confirm the push multi-factor authentication request.
    
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
  - PUSH_CONFIRMATION_TIMED_OUT
```
public static final String PUSH_CONFIRMATION_TIMED_OUT
```
    The status indicating that the push confirmation is timed out.
    
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
  - PUSH_CONFIRMATION_REJECTED
```
public static final String PUSH_CONFIRMATION_REJECTED
```
    The status indicating that the push confirmation is rejected.
    
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
  - MFA_COMPLETED
```
public static final String MFA_COMPLETED
```
    The status indicating that the user has completed multi-factor authentication.
    
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
  - DEVICE_PROFILE_REQUIRED
```
public static final String DEVICE_PROFILE_REQUIRED
```
    The status indicating that the user's device profile is required.
    
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
  - MOBILE_PAIRING_REQUIRED
```
public static final String MOBILE_PAIRING_REQUIRED
```
    The status indicating that mobile pairing is required.
    
    Since:
    
    10.2
    
    See Also:
    
    Constant Field Values
  - CURRENT_CREDENTIALS_REQUIRED
```
public static final String CURRENT_CREDENTIALS_REQUIRED
```
    The status indicating that the current credentials are required during password change configured with multi-factor authentication.
    
    Since:
    
    10.2
    
    See Also:
    
    Constant Field Values
  - ACCOUNT_LINKING_FAILED
```
public static final String ACCOUNT_LINKING_FAILED
```
    The status indicating that user account linking has failed.
    
    Since:
    
    10.3
    
    See Also:
    
    Constant Field Values
  - DEVICE_PROFILE_SESSION_ID_REQUIRED
```
public static final String DEVICE_PROFILE_SESSION_ID_REQUIRED
```
    The status indicating that a session id from device profiling is required.
    
    Since:
    
    10.3
    
    See Also:
    
    Constant Field Values
  - EMAIL_VERIFICATION_REQUIRED
```
public static final String EMAIL_VERIFICATION_REQUIRED
```
    The status indicating that the user is required to verify their email.
    
    Since:
    
    10.3
    
    See Also:
    
    Constant Field Values
  - EMAIL_VERIFICATION_OTP_REQUIRED
```
public static final String EMAIL_VERIFICATION_OTP_REQUIRED
```
    The status indicating that the user is required to verify their email via OTP.
    
    Since:
    
    11.0
    
    See Also:
    
    Constant Field Values
  - OAUTH_DEVICE_USER_CODE_REQUIRED
```
public static final String OAUTH_DEVICE_USER_CODE_REQUIRED
```
    The status in the OAuth device authorization flow where the user must provide a code to authorize the device.
    
    Since:
    
    11.1
    
    See Also:
    
    Constant Field Values
  - OAUTH_DEVICE_USER_CODE_CONFIRMATION_REQUIRED
```
public static final String OAUTH_DEVICE_USER_CODE_CONFIRMATION_REQUIRED
```
    The status in the OAuth device authorization flow where the user must confirm that the code presented matches the one on the device.
    
    Since:
    
    11.1
    
    See Also:
    
    Constant Field Values
  - OAUTH_DEVICE_COMPLETED
```
public static final String OAUTH_DEVICE_COMPLETED
```
    The status in the OAuth device authorization flow where device authorization has completed successfully.
    
    Since:
    
    11.1
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CommonStatus
```
public CommonStatus()
```

Class CommonStatus

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RESUME

FAILED

USERNAME_PASSWORD_REQUIRED

CHALLENGE_RESPONSE_REQUIRED

MUST_CHANGE_PASSWORD

CHANGE_PASSWORD_EXTERNAL

SUCCESSFUL_PASSWORD_CHANGE

NEW_PASSWORD_RECOMMENDED

NEW_PASSWORD_REQUIRED

ACCOUNT_RECOVERY_USERNAME_REQUIRED

ACCOUNT_RECOVERY_OTL_VERIFICATION_REQUIRED

RECOVERY_CODE_REQUIRED

PASSWORD_RESET_REQUIRED

SUCCESSFUL_PASSWORD_RESET

SUCCESSFUL_ACCOUNT_UNLOCK

USERNAME_RECOVERY_EMAIL_REQUIRED

USERNAME_RECOVERY_EMAIL_SENT

IDENTIFIER_REQUIRED

COMPLETED

CANCELED

REGISTRATION_REQUIRED

DEVICE_SELECTION_REQUIRED

OTP_REQUIRED

OTP_VERIFIED

MFA_FAILED

AUTHENTICATION_REQUIRED

PUSH_CONFIRMATION_WAITING

PUSH_CONFIRMATION_TIMED_OUT

PUSH_CONFIRMATION_REJECTED

MFA_COMPLETED

DEVICE_PROFILE_REQUIRED

MOBILE_PAIRING_REQUIRED

CURRENT_CREDENTIALS_REQUIRED

ACCOUNT_LINKING_FAILED

DEVICE_PROFILE_SESSION_ID_REQUIRED

EMAIL_VERIFICATION_REQUIRED

EMAIL_VERIFICATION_OTP_REQUIRED

OAUTH_DEVICE_USER_CODE_REQUIRED

OAUTH_DEVICE_USER_CODE_CONFIRMATION_REQUIRED

OAUTH_DEVICE_COMPLETED

Constructor Detail

CommonStatus