Package com.pingidentity.sdk.api.authn.model.state
Contains the models for various shared Authentication API states. The model defines the fields that can be included
in a GET response for a given state.
-
Class Summary Class Description AccountLinkingFailed An API state model containing additional details for states in which the user has failed linking their account.AccountRecoveryUsernameRequired An API state model containing additional details for states in which a user's username is required for account recovery to proceed.AlternativeAuthenticationSource An API state model containing details for an alternative authentication source.AuthenticationFailed The model for theFAILEDstate.AuthenticationRequired<D extends Device,U extends User> An API state model containing details for states in which multi-factor authentication is required.Canceled The model for theCANCELEDstate.ChallengeResponseRequired An API state model containing additional details for states in which the user's challenge response is required.ChangePasswordExternal An API state model containing additional details for states in which a user must change their password at an external password management system.Completed The model for theCOMPLETEDstate.CurrentCredentialsRequired DeviceProfileRequired An API state model indicating the user's device profile is required.DeviceProfileSessionIdRequired An API state model indicating the session identifier from device profiling is required.DeviceSelectionRequired<D extends Device,U extends User> An API state model containing additional details for states in which the user must select a device.EmailVerificationRequired The model for theEMAIL_VERIFICATION_REQUIREDstate.ExternalAuthenticationFailed An API state model containing additional details for states in which a external authentication has failed.ExternalAuthenticationRequired An API state model containing additional details for states in which a external authentication is required.Field An API state model containing the configuration for fields to display in the application.Field.FieldBuilder IdentifierRequired An API state model containing additional details for states in which an identifier is required for authentication to proceed.MfaCompleted An API state model containing additional details for states in which the user has passed multi-factor authentication.MfaFailed An API state model containing additional details for states in which the user has failed multi-factor authentication.MobilePairingRequired An API state model containing additional details for states in which mobile pairing is required.MultiFactorAuthenticationState<D extends Device,U extends User> A base API state model containing additional details for multi-factor authentication states.NewPasswordRecommended An API state model containing additional details for states in which a user's password is expiring and a password change is recommended.NewPasswordRequired An API state model containing additional details for states in which a new user password is required.OAuthDeviceCompleted The API model for the state in the OAuth device authorization flow where device authorization has completed successfully.OAuthDeviceUserCodeConfirmationRequired The API model for the state in the OAuth device authorization flow where the user must confirm that the code presented matches the one displayed on the device.OAuthDeviceUserCodeRequired The API model for the state in the OAuth device authorization flow where the user code is required.OneTimeLinkVerificationRequired An API state model for states in which a One Time Link verification is required.OtpRequired<D extends Device,U extends User> An API state model containing additional details for states in which the user must enter an OTP.OtpVerified An API state model containing additional details for states in which the user has successfully completed multi-factor authentication via an OTP.PasswordResetRequired An API state model containing additional details for states in which a new user password is required for password reset.PushConfirmationRejected<D extends Device,U extends User> An API state model for push confirmation cancellation.PushConfirmationTimedOut<D extends Device,U extends User> An API state model for push confirmation timeout.PushConfirmationWaiting<D extends Device,U extends User> An API state model for push confirmation waiting.RecoveryCodeRequired An API state model containing additional details for states in which a recovery code is required.RegistrationRequired An API state model for when user registration is required.Resume An API state model containing additional details for the RESUME state, where the API client is supposed to redirect to PingFederate to continue processing.SuccessfulAccountUnlock An API state model containing additional details for states in which the user has successfully completed an account unlock.SuccessfulPasswordChange An API state model containing additional details for states in which the user has successfully completed a password change.SuccessfulPasswordReset An API state model containing additional details for states in which the user has successfully completed a password reset.UsernamePasswordRequired An API state model containing additional details for states in which the user's credentials are required.UsernameRecoveryEmailRequired An API state model indicating the email address of an associated user account is required for username recovery to proceed.UsernameRecoveryEmailSent An API state model indicating an email with the associated username was sent. -
Enum Summary Enum Description ExternalAuthenticationRequired.PresentationMode Presentation modes for external authentication.RecoveryCodeRequired.RecoveryCodeDestination