Package com.pingidentity.sdk.api.authn.common

Class CommonActionSpec

java.lang.Object
com.pingidentity.sdk.api.authn.common.CommonActionSpec
public class CommonActionSpec extends Object
This class defines a set of common AuthnErrorDetailSpec specs for use across API-capable PingFederate plugins.
Since:
9.3

  • Field Details

    • CHECK_USERNAME_PASSWORD

      public static final AuthnActionSpec<CheckUsernamePassword> CHECK_USERNAME_PASSWORD
      The action used when the end user submits their credentials.
      Since:
      9.3

    • ALTERNATIVE_AUTHENTICATION

      public static final AuthnActionSpec<AuthenticationSourceSelection> ALTERNATIVE_AUTHENTICATION
      The action used when the end user opts to use an alternative authentication source.
      Since:
      9.3

    • CHECK_CHALLENGE_RESPONSE

      public static final AuthnActionSpec<CheckChallengeResponse> CHECK_CHALLENGE_RESPONSE
      The action used when the end user submits their one-time challenge response.
      Since:
      9.3

    • CANCEL_AUTHENTICATION

      public static final AuthnActionSpec<Void> CANCEL_AUTHENTICATION
      Deprecated.
      Use CANCEL instead.
      The action used when the end user cancels the current step in the authentication flow.
      Since:
      9.3

    • CANCEL

      public static final AuthnActionSpec<Void> CANCEL
      The action used to cancel the current operation.
      Since:
      10.1

    • CONTINUE

      public static final AuthnActionSpec<Void> CONTINUE
      The action used to continue the current operation.
      Since:
      10.3

    • RESTART

      public static final AuthnActionSpec<Void> RESTART
      The action used when the user restarts the authentication process.
      Since:
      10.3

    • INITIATE_PASSWORD_CHANGE

      public static final AuthnActionSpec<Void> INITIATE_PASSWORD_CHANGE
      The action used when the end user initiates a password change.
      Since:
      9.3

    • CANCEL_PASSWORD_CHANGE

      public static final AuthnActionSpec<Void> CANCEL_PASSWORD_CHANGE
      The action used when the end user cancels a password change.
      Since:
      9.3

    • CHECK_NEW_PASSWORD

      public static final AuthnActionSpec<CheckNewPassword> CHECK_NEW_PASSWORD
      The action used when the end user submits a new password for validation.
      Since:
      9.3

    • CONTINUE_AUTHENTICATION

      public static final AuthnActionSpec<Void> CONTINUE_AUTHENTICATION
      Deprecated.
      Use CONTINUE instead.
      The action used when the end user wishes to continue authentication after an action.
      Since:
      9.3

    • INITIATE_ACCOUNT_RECOVERY

      public static final AuthnActionSpec<Void> INITIATE_ACCOUNT_RECOVERY
      The action used when the end user initiates an account recovery process.
      Since:
      9.3

    • CANCEL_ACCOUNT_RECOVERY

      public static final AuthnActionSpec<Void> CANCEL_ACCOUNT_RECOVERY
      The action used when the end user cancels the current account recovery process.
      Since:
      9.3

    • CHECK_ACCOUNT_RECOVERY_USERNAME

      public static final AuthnActionSpec<CheckAccountRecoveryUsername> CHECK_ACCOUNT_RECOVERY_USERNAME
      The action used when the end user submits the username of an existing account selected for account recovery.
      Since:
      9.3

    • CHECK_RECOVERY_CODE

      public static final AuthnActionSpec<CheckRecoveryCode> CHECK_RECOVERY_CODE
      The action used when the end user submits the recovery pass code for user verification during account recovery.
      Since:
      9.3

    • CHECK_PASSWORD_RESET

      public static final AuthnActionSpec<CheckPasswordReset> CHECK_PASSWORD_RESET
      The action used when the end user submits a new password for password reset.
      Since:
      9.3

    • CONTINUE_ACCOUNT_RECOVERY

      public static final AuthnActionSpec<Void> CONTINUE_ACCOUNT_RECOVERY
      The action used when the end user wishes to continue account recovery after an account unlock.
      Since:
      9.3

    • RECOVER_USERNAME

      public static final AuthnActionSpec<Void> RECOVER_USERNAME
      The action used when the end user initiates a username recovery.
      Since:
      9.3

    • CHECK_USERNAME_RECOVERY_EMAIL

      public static final AuthnActionSpec<CheckUsernameRecoveryEmail> CHECK_USERNAME_RECOVERY_EMAIL
      The action used when the end user submits the email address associated with the username to be recovered.
      Since:
      9.3

    • CANCEL_USERNAME_RECOVERY

      public static final AuthnActionSpec<Void> CANCEL_USERNAME_RECOVERY
      The action used when the end user cancels the current username recovery flow.
      Since:
      9.3

    • SUBMIT_IDENTIFIER

      public static final AuthnActionSpec<SubmitIdentifier> SUBMIT_IDENTIFIER
      The action used when the end user submits an identifier.
      Since:
      10.0

    • CLEAR_IDENTIFIER

      public static final AuthnActionSpec<ClearIdentifier> CLEAR_IDENTIFIER
      The action used when the end user opts to clear a previously submitted identifier.
      Since:
      10.0

    • CANCEL_IDENTIFIER_SUBMISSION

      public static final AuthnActionSpec<Void> CANCEL_IDENTIFIER_SUBMISSION
      The action used when the end user opts to cancel identifier submission.
      Since:
      10.0

    • INITIATE_REGISTRATION

      public static final AuthnActionSpec<Void> INITIATE_REGISTRATION
      The action used when the end user initiates registration.
      Since:
      10.1

    • REGISTER_USER

      public static final AuthnActionSpec<RegisterUser> REGISTER_USER
      The action used when registering a new user.
      Since:
      10.1

    • SELECT_DEVICE

      public static final AuthnActionSpec<SelectDevice> SELECT_DEVICE
      The action used to select a device.
      Since:
      10.1

    • CHECK_OTP

      public static final AuthnActionSpec<CheckOtp> CHECK_OTP
      The action used to check if an OTP is valid.
      Since:
      10.1

    • RESEND_OTP

      public static final AuthnActionSpec<Void> RESEND_OTP
      The action used to resend an OTP to the user's selected device.
      Since:
      10.1

    • AUTHENTICATE

      public static final AuthnActionSpec<Authenticate> AUTHENTICATE
      The action used to start a multi-factor authentication.
      Since:
      10.1

    • POLL

      public static final AuthnActionSpec<Void> POLL
      The action used to get the current operation's status.
      Since:
      10.1

    • SUBMIT_DEVICE_PROFILE

      public static final AuthnActionSpec<SubmitDeviceProfile<? extends DeviceProfile>> SUBMIT_DEVICE_PROFILE
      The action used for submitting a user's device profile.
      Since:
      10.2

    • CHECK_CURRENT_CREDENTIALS

      public static final AuthnActionSpec<CheckCurrentCredentials> CHECK_CURRENT_CREDENTIALS
      The action used to validate current credential when an end user initiates change password configured with multi-factor authentication.
      Since:
      10.2

    • SUBMIT_DEVICE_PROFILE_SESSION_ID

      public static final AuthnActionSpec<SubmitDeviceProfileSessionId> SUBMIT_DEVICE_PROFILE_SESSION_ID
      The action used to submit a session identifier when a device is profiled.
      Since:
      10.3

    • SEND_EMAIL_VERIFICATION_OTL

      public static final AuthnActionSpec<Void> SEND_EMAIL_VERIFICATION_OTL
      The action used to send an OTL to the user for email verification.
      Since:
      10.3

    • SKIP_OTP

      public static final AuthnActionSpec<Void> SKIP_OTP
      The action used to skip an OTP check.
      Since:
      11.0

    • SUBMIT_USER_CODE

      public static final AuthnActionSpec<SubmitUserCode> SUBMIT_USER_CODE
      The action used to submit the user code in the OAuth device authorization flow.
      Since:
      11.1

    • CONFIRM_USER_CODE

      public static final AuthnActionSpec<ConfirmUserCode> CONFIRM_USER_CODE
      The action used to confirm the user code in the OAuth device authorization flow.
      Since:
      11.1

    • CLIENT_SIDE_AUTHENTICATOR_ACTION

      public static final AuthnActionSpec<ClientSideAuthenticationAction> CLIENT_SIDE_AUTHENTICATOR_ACTION
      The action used to authenticate with a client side authenticator. This model should extended by the client side authenticator to specify the attributes it expects to receive.
      Since:
      13.0

  • Constructor Details

    • CommonActionSpec

      public CommonActionSpec()