Uses of Class
com.pingidentity.sdk.api.authn.spec.AuthnStateSpec

Packages that use AuthnStateSpec

Package	Description
com.pingidentity.sdk.api.authn.common	Contains "spec" classes for states, actions, and errors that are shared across multiple API-capable plugins.
com.pingidentity.sdk.api.authn.spec	Defines various "spec" classes for the Authentication API.
com.pingidentity.sdk.api.authn.util	Defines various utility classes for handling Authentication API requests and generating responses.

Uses of AuthnStateSpec in com.pingidentity.sdk.api.authn.common

Fields in com.pingidentity.sdk.api.authn.common declared as AuthnStateSpec

Modifier and Type	Field	Description
static final AuthnStateSpec<AccountLinkingFailed>	CommonStateSpec.ACCOUNT_LINKING_FAILED	A state where account linking has failed.
static final AuthnStateSpec<OneTimeLinkVerificationRequired>	CommonStateSpec.ACCOUNT_RECOVERY_OTL_VERIFICATION_REQUIRED	A state where one-time link user verification is required for account recovery to proceed.
static final AuthnStateSpec<AccountRecoveryUsernameRequired>	CommonStateSpec.ACCOUNT_RECOVERY_USERNAME_REQUIRED	A state where a username is required for account recovery to proceed.
static final AuthnStateSpec<AuthenticationRequired<Device,User>>	CommonStateSpec.AUTHENTICATION_REQUIRED	A state where user must start the multi-factor authentication.
static final AuthnStateSpec<Canceled>	CommonStateSpec.CANCELED	The state where an authentication API action is canceled.
static final AuthnStateSpec<ChallengeResponseRequired>	CommonStateSpec.CHALLENGE_RESPONSE_REQUIRED	A state where the user must enter a challenge response to proceed.
static final AuthnStateSpec<ChangePasswordExternal>	CommonStateSpec.CHANGE_PASSWORD_EXTERNAL	A state where the user must change their password at an external password management system.
static final AuthnStateSpec<Completed>	CommonStateSpec.COMPLETED	The state where an authentication API action is complete.
static final AuthnStateSpec<CurrentCredentialsRequired>	CommonStateSpec.CURRENT_CREDENTIALS_REQUIRED	A state where the user must enter their current credentials to proceed with change password.
static final AuthnStateSpec<DeviceProfileRequired>	CommonStateSpec.DEVICE_PROFILE_REQUIRED	A state where user's device profile is required.
static final AuthnStateSpec<DeviceProfileSessionIdRequired>	CommonStateSpec.DEVICE_PROFILE_SESSION_ID_REQUIRED	A state where a session identifier from device profiling is required.
static final AuthnStateSpec<DeviceSelectionRequired<Device,User>>	CommonStateSpec.DEVICE_SELECTION_REQUIRED	A state where the user must select a device to proceed.
static final AuthnStateSpec<EmailVerificationRequired>	CommonStateSpec.EMAIL_VERIFICATION_OTP_REQUIRED	A state where the user is required to verify their email via OTP.
static final AuthnStateSpec<EmailVerificationRequired>	CommonStateSpec.EMAIL_VERIFICATION_REQUIRED	A state where the user is required to verify their email.
static final AuthnStateSpec<Void>	CommonStateSpec.EXTERNAL_AUTHENTICATION_COMPLETED	A state where external authentication has completed.
static final AuthnStateSpec<ExternalAuthenticationFailed>	CommonStateSpec.EXTERNAL_AUTHENTICATION_FAILED	A state where external authentication has failed.
static final AuthnStateSpec<ExternalAuthenticationRequired>	CommonStateSpec.EXTERNAL_AUTHENTICATION_REQUIRED	A state where external authentication is required.
static final AuthnStateSpec<AuthenticationFailed>	CommonStateSpec.FAILED	A state indicating that an error occurred that terminated the authentication flow.
static final AuthnStateSpec<IdentifierRequired>	CommonStateSpec.IDENTIFIER_REQUIRED	A state where an identifier is required for authentication to proceed.
static final AuthnStateSpec<MfaCompleted>	CommonStateSpec.MFA_COMPLETED	A state where the user has passed multi-factor authentication.
static final AuthnStateSpec<MfaFailed>	CommonStateSpec.MFA_FAILED	A state where the user has failed multi-factor authentication.
static final AuthnStateSpec<MobilePairingRequired>	CommonStateSpec.MOBILE_PAIRING_REQUIRED	A state where mobile pairing is required.
static final AuthnStateSpec<NewPasswordRequired>	CommonStateSpec.MUST_CHANGE_PASSWORD	A state where the user's existing password is expired and must be changed.
static final AuthnStateSpec<NewPasswordRecommended>	CommonStateSpec.NEW_PASSWORD_RECOMMENDED	A state where the user's existing password is about to expire, and password change is recommended.
static final AuthnStateSpec<NewPasswordRequired>	CommonStateSpec.NEW_PASSWORD_REQUIRED	A state where a new password is required to proceed.
static final AuthnStateSpec<OAuthDeviceCompleted>	CommonStateSpec.OAUTH_DEVICE_COMPLETED
static final AuthnStateSpec<OAuthDeviceUserCodeConfirmationRequired>	CommonStateSpec.OAUTH_DEVICE_USER_CODE_CONFIRMATION_REQUIRED
static final AuthnStateSpec<OAuthDeviceUserCodeRequired>	CommonStateSpec.OAUTH_DEVICE_USER_CODE_REQUIRED
static final AuthnStateSpec<OtpRequired<Device,User>>	CommonStateSpec.OTP_REQUIRED	A state where the user must enter an OTP to proceed.
static final AuthnStateSpec<OtpVerified>	CommonStateSpec.OTP_VERIFIED	A state where the user has completed multi-factor authentication via an OTP.
static final AuthnStateSpec<PasswordResetRequired>	CommonStateSpec.PASSWORD_RESET_REQUIRED	A state where a new password is required to complete password reset.
static final AuthnStateSpec<PushConfirmationRejected<Device,User>>	CommonStateSpec.PUSH_CONFIRMATION_REJECTED	A state where the push confirmation was rejected.
static final AuthnStateSpec<PushConfirmationTimedOut<Device,User>>	CommonStateSpec.PUSH_CONFIRMATION_TIMED_OUT	A state where the push confirmation is timed out.
static final AuthnStateSpec<PushConfirmationWaiting<Device,User>>	CommonStateSpec.PUSH_CONFIRMATION_WAITING	A state where waiting for the user to confirm the push multi-factor authentication request.
static final AuthnStateSpec<RecoveryCodeRequired>	CommonStateSpec.RECOVERY_CODE_REQUIRED	A state where a recovery pass code is required for account recovery to proceed.
static final AuthnStateSpec<RegistrationRequired>	CommonStateSpec.REGISTRATION_REQUIRED_AUTHN_STATE_SPEC	The state where user registration is required.
static final AuthnStateSpec<Resume>	CommonStateSpec.RESUME	The state where the API client must redirect to PingFederate for processing to continue.
static final AuthnStateSpec<SuccessfulAccountUnlock>	CommonStateSpec.SUCCESSFUL_ACCOUNT_UNLOCK	A state where the user has successfully complete an account unlock.
static final AuthnStateSpec<SuccessfulPasswordChange>	CommonStateSpec.SUCCESSFUL_PASSWORD_CHANGE	A state where the user has successfully completed a password change.
static final AuthnStateSpec<SuccessfulPasswordReset>	CommonStateSpec.SUCCESSFUL_PASSWORD_RESET	A state where the user has successfully completed a password reset.
static final AuthnStateSpec<UsernamePasswordRequired>	CommonStateSpec.USERNAME_PASSWORD_REQUIRED	A state where the user must enter their username and password to proceed.
static final AuthnStateSpec<UsernameRecoveryEmailRequired>	CommonStateSpec.USERNAME_RECOVERY_EMAIL_REQUIRED	The status indicating that the user must enter their email to proceed.
static final AuthnStateSpec<UsernameRecoveryEmailSent>	CommonStateSpec.USERNAME_RECOVERY_EMAIL_SENT	The status indicating that an email containing the user's username has be sent.

Uses of AuthnStateSpec in com.pingidentity.sdk.api.authn.spec

Methods in com.pingidentity.sdk.api.authn.spec that return AuthnStateSpec

Modifier and Type	Method	Description
AuthnStateSpec<ModelType>	AuthnStateSpec.Builder.build()	Build the spec.

Methods in com.pingidentity.sdk.api.authn.spec that return types with arguments of type AuthnStateSpec

Modifier and Type	Method	Description
List<AuthnStateSpec<?>>	PluginApiSpec.getStates()	Get the states available in the plugin's API.

Methods in com.pingidentity.sdk.api.authn.spec with parameters of type AuthnStateSpec

Modifier and Type	Method	Description
AuthnStateSpec.Builder<ModelType>	AuthnStateSpec.Builder.template(AuthnStateSpec<?> template, Class<ModelType> overrideModelClass)	Initialize the builder with the values from an existing spec, overriding the model class.
AuthnStateSpec.Builder<ModelType>	AuthnStateSpec.Builder.template(AuthnStateSpec<ModelType> template)	Initialize the builder with the values from an existing spec.

Method parameters in com.pingidentity.sdk.api.authn.spec with type arguments of type AuthnStateSpec

Modifier and Type	Method	Description
void	PluginApiSpec.setStates(List<AuthnStateSpec<?>> states)	Set the states available in the plugin's API.

Constructor parameters in com.pingidentity.sdk.api.authn.spec with type arguments of type AuthnStateSpec

Modifier	Constructor	Description
	PluginApiSpec(List<AuthnStateSpec<?>> states)	Create an instance based on the specified parameters.

Uses of AuthnStateSpec in com.pingidentity.sdk.api.authn.util

Methods in com.pingidentity.sdk.api.authn.util with parameters of type AuthnStateSpec

Modifier and Type	Method	Description
<ModelType> AuthnState<ModelType>	AuthnApiSupport.makeAuthnState(javax.servlet.http.HttpServletRequest request, AuthnStateSpec<ModelType> stateSpec, ModelType stateModel)	Create an AuthnState instance based on an AuthnStateSpec instance.