Class CommonStateSpec
- java.lang.Object
-
- com.pingidentity.sdk.api.authn.common.CommonStateSpec
-
public class CommonStateSpec extends Object
This class defines a set of commonAuthnStateSpecspecs for use across API-capable PingFederate plugins.- Since:
- 9.3
-
-
Field Summary
Fields Modifier and Type Field Description static AuthnStateSpec<AccountLinkingFailed>ACCOUNT_LINKING_FAILEDA state where account linking has failed.static AuthnStateSpec<OneTimeLinkVerificationRequired>ACCOUNT_RECOVERY_OTL_VERIFICATION_REQUIREDA state where one-time link user verification is required for account recovery to proceed.static AuthnStateSpec<AccountRecoveryUsernameRequired>ACCOUNT_RECOVERY_USERNAME_REQUIREDA state where a username is required for account recovery to proceed.static AuthnStateSpec<AuthenticationRequired<Device,User>>AUTHENTICATION_REQUIREDA state where user must start the multi-factor authentication.static AuthnStateSpec<Canceled>CANCELEDThe state where an authentication API action is canceled.static AuthnStateSpec<ChallengeResponseRequired>CHALLENGE_RESPONSE_REQUIREDA state where the user must enter a challenge response to proceed.static AuthnStateSpec<ChangePasswordExternal>CHANGE_PASSWORD_EXTERNALA state where the user must change their password at an external password management system.static AuthnStateSpec<Completed>COMPLETEDThe state where an authentication API action is complete.static AuthnStateSpec<CurrentCredentialsRequired>CURRENT_CREDENTIALS_REQUIREDA state where the user must enter their current credentials to proceed with change password.static AuthnStateSpec<DeviceProfileRequired>DEVICE_PROFILE_REQUIREDA state where user's device profile is required.static AuthnStateSpec<DeviceProfileSessionIdRequired>DEVICE_PROFILE_SESSION_ID_REQUIREDA state where a session identifier from device profiling is required.static AuthnStateSpec<DeviceSelectionRequired<Device,User>>DEVICE_SELECTION_REQUIREDA state where the user must select a device to proceed.static AuthnStateSpec<EmailVerificationRequired>EMAIL_VERIFICATION_OTP_REQUIREDA state where the user is required to verify their email via OTP.static AuthnStateSpec<EmailVerificationRequired>EMAIL_VERIFICATION_REQUIREDA state where the user is required to verify their email.static AuthnStateSpec<Void>EXTERNAL_AUTHENTICATION_COMPLETEDA state where external authentication has completed.static AuthnStateSpec<ExternalAuthenticationFailed>EXTERNAL_AUTHENTICATION_FAILEDA state where external authentication has failed.static AuthnStateSpec<ExternalAuthenticationRequired>EXTERNAL_AUTHENTICATION_REQUIREDA state where external authentication is required.static AuthnStateSpec<AuthenticationFailed>FAILEDA state indicating that an error occurred that terminated the authentication flow.static AuthnStateSpec<IdentifierRequired>IDENTIFIER_REQUIREDA state where an identifier is required for authentication to proceed.static AuthnStateSpec<MfaCompleted>MFA_COMPLETEDA state where the user has passed multi-factor authentication.static AuthnStateSpec<MfaFailed>MFA_FAILEDA state where the user has failed multi-factor authentication.static AuthnStateSpec<MobilePairingRequired>MOBILE_PAIRING_REQUIREDA state where mobile pairing is required.static AuthnStateSpec<NewPasswordRequired>MUST_CHANGE_PASSWORDA state where the user's existing password is expired and must be changed.static AuthnStateSpec<NewPasswordRecommended>NEW_PASSWORD_RECOMMENDEDA state where the user's existing password is about to expire, and password change is recommended.static AuthnStateSpec<NewPasswordRequired>NEW_PASSWORD_REQUIREDA state where a new password is required to proceed.static AuthnStateSpec<OAuthDeviceCompleted>OAUTH_DEVICE_COMPLETEDstatic AuthnStateSpec<OAuthDeviceUserCodeConfirmationRequired>OAUTH_DEVICE_USER_CODE_CONFIRMATION_REQUIREDstatic AuthnStateSpec<OAuthDeviceUserCodeRequired>OAUTH_DEVICE_USER_CODE_REQUIREDstatic AuthnStateSpec<OtpRequired<Device,User>>OTP_REQUIREDA state where the user must enter an OTP to proceed.static AuthnStateSpec<OtpVerified>OTP_VERIFIEDA state where the user has completed multi-factor authentication via an OTP.static AuthnStateSpec<PasswordResetRequired>PASSWORD_RESET_REQUIREDA state where a new password is required to complete password reset.static AuthnStateSpec<PushConfirmationRejected<Device,User>>PUSH_CONFIRMATION_REJECTEDA state where the push confirmation was rejected.static AuthnStateSpec<PushConfirmationTimedOut<Device,User>>PUSH_CONFIRMATION_TIMED_OUTA state where the push confirmation is timed out.static AuthnStateSpec<PushConfirmationWaiting<Device,User>>PUSH_CONFIRMATION_WAITINGA state where waiting for the user to confirm the push multi-factor authentication request.static AuthnStateSpec<RecoveryCodeRequired>RECOVERY_CODE_REQUIREDA state where a recovery pass code is required for account recovery to proceed.static AuthnStateSpec<RegistrationRequired>REGISTRATION_REQUIRED_AUTHN_STATE_SPECThe state where user registration is required.static AuthnStateSpec<Resume>RESUMEThe state where the API client must redirect to PingFederate for processing to continue.static AuthnStateSpec<SuccessfulAccountUnlock>SUCCESSFUL_ACCOUNT_UNLOCKA state where the user has successfully complete an account unlock.static AuthnStateSpec<SuccessfulPasswordChange>SUCCESSFUL_PASSWORD_CHANGEA state where the user has successfully completed a password change.static AuthnStateSpec<SuccessfulPasswordReset>SUCCESSFUL_PASSWORD_RESETA state where the user has successfully completed a password reset.static AuthnStateSpec<UsernamePasswordRequired>USERNAME_PASSWORD_REQUIREDA state where the user must enter their username and password to proceed.static AuthnStateSpec<UsernameRecoveryEmailRequired>USERNAME_RECOVERY_EMAIL_REQUIREDThe status indicating that the user must enter their email to proceed.static AuthnStateSpec<UsernameRecoveryEmailSent>USERNAME_RECOVERY_EMAIL_SENTThe status indicating that an email containing the user's username has be sent.
-
Constructor Summary
Constructors Constructor Description CommonStateSpec()
-
-
-
Field Detail
-
RESUME
public static final AuthnStateSpec<Resume> RESUME
The state where the API client must redirect to PingFederate for processing to continue.- Since:
- 9.3
-
FAILED
public static final AuthnStateSpec<AuthenticationFailed> FAILED
A state indicating that an error occurred that terminated the authentication flow.- Since:
- 9.3
-
USERNAME_PASSWORD_REQUIRED
public static final AuthnStateSpec<UsernamePasswordRequired> USERNAME_PASSWORD_REQUIRED
A state where the user must enter their username and password to proceed.- Since:
- 9.3
-
CHALLENGE_RESPONSE_REQUIRED
public static final AuthnStateSpec<ChallengeResponseRequired> CHALLENGE_RESPONSE_REQUIRED
A state where the user must enter a challenge response to proceed.- Since:
- 9.3
-
MUST_CHANGE_PASSWORD
public static final AuthnStateSpec<NewPasswordRequired> MUST_CHANGE_PASSWORD
A state where the user's existing password is expired and must be changed.- Since:
- 9.3
-
CHANGE_PASSWORD_EXTERNAL
public static final AuthnStateSpec<ChangePasswordExternal> CHANGE_PASSWORD_EXTERNAL
A state where the user must change their password at an external password management system.- Since:
- 10.3
-
NEW_PASSWORD_RECOMMENDED
public static final AuthnStateSpec<NewPasswordRecommended> NEW_PASSWORD_RECOMMENDED
A state where the user's existing password is about to expire, and password change is recommended.
-
NEW_PASSWORD_REQUIRED
public static final AuthnStateSpec<NewPasswordRequired> NEW_PASSWORD_REQUIRED
A state where a new password is required to proceed.- Since:
- 9.3
-
SUCCESSFUL_PASSWORD_CHANGE
public static final AuthnStateSpec<SuccessfulPasswordChange> SUCCESSFUL_PASSWORD_CHANGE
A state where the user has successfully completed a password change.- Since:
- 9.3
-
ACCOUNT_RECOVERY_USERNAME_REQUIRED
public static final AuthnStateSpec<AccountRecoveryUsernameRequired> ACCOUNT_RECOVERY_USERNAME_REQUIRED
A state where a username is required for account recovery to proceed.- Since:
- 9.3
-
ACCOUNT_RECOVERY_OTL_VERIFICATION_REQUIRED
public static final AuthnStateSpec<OneTimeLinkVerificationRequired> ACCOUNT_RECOVERY_OTL_VERIFICATION_REQUIRED
A state where one-time link user verification is required for account recovery to proceed.- Since:
- 9.3
-
RECOVERY_CODE_REQUIRED
public static final AuthnStateSpec<RecoveryCodeRequired> RECOVERY_CODE_REQUIRED
A state where a recovery pass code is required for account recovery to proceed.- Since:
- 9.3
-
USERNAME_RECOVERY_EMAIL_REQUIRED
public static final AuthnStateSpec<UsernameRecoveryEmailRequired> USERNAME_RECOVERY_EMAIL_REQUIRED
The status indicating that the user must enter their email to proceed.- Since:
- 9.3
-
USERNAME_RECOVERY_EMAIL_SENT
public static final AuthnStateSpec<UsernameRecoveryEmailSent> USERNAME_RECOVERY_EMAIL_SENT
The status indicating that an email containing the user's username has be sent.- Since:
- 9.3
-
PASSWORD_RESET_REQUIRED
public static final AuthnStateSpec<PasswordResetRequired> PASSWORD_RESET_REQUIRED
A state where a new password is required to complete password reset.- Since:
- 9.3
-
SUCCESSFUL_PASSWORD_RESET
public static final AuthnStateSpec<SuccessfulPasswordReset> SUCCESSFUL_PASSWORD_RESET
A state where the user has successfully completed a password reset.- Since:
- 9.3
-
SUCCESSFUL_ACCOUNT_UNLOCK
public static final AuthnStateSpec<SuccessfulAccountUnlock> SUCCESSFUL_ACCOUNT_UNLOCK
A state where the user has successfully complete an account unlock.- Since:
- 9.3
-
IDENTIFIER_REQUIRED
public static final AuthnStateSpec<IdentifierRequired> IDENTIFIER_REQUIRED
A state where an identifier is required for authentication to proceed.- Since:
- 10.0
-
COMPLETED
public static final AuthnStateSpec<Completed> COMPLETED
The state where an authentication API action is complete.- Since:
- 9.3
-
CANCELED
public static final AuthnStateSpec<Canceled> CANCELED
The state where an authentication API action is canceled.- Since:
- 9.3
-
REGISTRATION_REQUIRED_AUTHN_STATE_SPEC
public static final AuthnStateSpec<RegistrationRequired> REGISTRATION_REQUIRED_AUTHN_STATE_SPEC
The state where user registration is required.- Since:
- 10.1
-
DEVICE_SELECTION_REQUIRED
public static final AuthnStateSpec<DeviceSelectionRequired<Device,User>> DEVICE_SELECTION_REQUIRED
A state where the user must select a device to proceed.- Since:
- 10.1
-
OTP_REQUIRED
public static final AuthnStateSpec<OtpRequired<Device,User>> OTP_REQUIRED
A state where the user must enter an OTP to proceed.- Since:
- 10.1
-
OTP_VERIFIED
public static final AuthnStateSpec<OtpVerified> OTP_VERIFIED
A state where the user has completed multi-factor authentication via an OTP.- Since:
- 10.1
-
MFA_FAILED
public static final AuthnStateSpec<MfaFailed> MFA_FAILED
A state where the user has failed multi-factor authentication.- Since:
- 10.1
-
AUTHENTICATION_REQUIRED
public static final AuthnStateSpec<AuthenticationRequired<Device,User>> AUTHENTICATION_REQUIRED
A state where user must start the multi-factor authentication.- Since:
- 10.1
-
PUSH_CONFIRMATION_WAITING
public static final AuthnStateSpec<PushConfirmationWaiting<Device,User>> PUSH_CONFIRMATION_WAITING
A state where waiting for the user to confirm the push multi-factor authentication request.- Since:
- 10.1
-
PUSH_CONFIRMATION_TIMED_OUT
public static final AuthnStateSpec<PushConfirmationTimedOut<Device,User>> PUSH_CONFIRMATION_TIMED_OUT
A state where the push confirmation is timed out.- Since:
- 10.1
-
PUSH_CONFIRMATION_REJECTED
public static final AuthnStateSpec<PushConfirmationRejected<Device,User>> PUSH_CONFIRMATION_REJECTED
A state where the push confirmation was rejected.- Since:
- 10.1
-
MFA_COMPLETED
public static final AuthnStateSpec<MfaCompleted> MFA_COMPLETED
A state where the user has passed multi-factor authentication.- Since:
- 10.1
-
DEVICE_PROFILE_REQUIRED
public static final AuthnStateSpec<DeviceProfileRequired> DEVICE_PROFILE_REQUIRED
A state where user's device profile is required.- Since:
- 10.1
-
MOBILE_PAIRING_REQUIRED
public static final AuthnStateSpec<MobilePairingRequired> MOBILE_PAIRING_REQUIRED
A state where mobile pairing is required.- Since:
- 10.2
-
EXTERNAL_AUTHENTICATION_REQUIRED
public static final AuthnStateSpec<ExternalAuthenticationRequired> EXTERNAL_AUTHENTICATION_REQUIRED
A state where external authentication is required.- Since:
- 10.2
-
EXTERNAL_AUTHENTICATION_COMPLETED
public static final AuthnStateSpec<Void> EXTERNAL_AUTHENTICATION_COMPLETED
A state where external authentication has completed.- Since:
- 10.2
-
EXTERNAL_AUTHENTICATION_FAILED
public static final AuthnStateSpec<ExternalAuthenticationFailed> EXTERNAL_AUTHENTICATION_FAILED
A state where external authentication has failed.- Since:
- 10.2
-
CURRENT_CREDENTIALS_REQUIRED
public static final AuthnStateSpec<CurrentCredentialsRequired> CURRENT_CREDENTIALS_REQUIRED
A state where the user must enter their current credentials to proceed with change password.- Since:
- 10.2
-
ACCOUNT_LINKING_FAILED
public static final AuthnStateSpec<AccountLinkingFailed> ACCOUNT_LINKING_FAILED
A state where account linking has failed.- Since:
- 10.3
-
DEVICE_PROFILE_SESSION_ID_REQUIRED
public static final AuthnStateSpec<DeviceProfileSessionIdRequired> DEVICE_PROFILE_SESSION_ID_REQUIRED
A state where a session identifier from device profiling is required.- Since:
- 10.3
-
EMAIL_VERIFICATION_REQUIRED
public static final AuthnStateSpec<EmailVerificationRequired> EMAIL_VERIFICATION_REQUIRED
A state where the user is required to verify their email.- Since:
- 10.3
-
EMAIL_VERIFICATION_OTP_REQUIRED
public static final AuthnStateSpec<EmailVerificationRequired> EMAIL_VERIFICATION_OTP_REQUIRED
A state where the user is required to verify their email via OTP.- Since:
- 11.0
-
OAUTH_DEVICE_USER_CODE_REQUIRED
public static final AuthnStateSpec<OAuthDeviceUserCodeRequired> OAUTH_DEVICE_USER_CODE_REQUIRED
-
OAUTH_DEVICE_USER_CODE_CONFIRMATION_REQUIRED
public static final AuthnStateSpec<OAuthDeviceUserCodeConfirmationRequired> OAUTH_DEVICE_USER_CODE_CONFIRMATION_REQUIRED
-
OAUTH_DEVICE_COMPLETED
public static final AuthnStateSpec<OAuthDeviceCompleted> OAUTH_DEVICE_COMPLETED
-
-