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

Class CommonActionId

java.lang.Object
com.pingidentity.sdk.api.authn.common.CommonActionId
public class CommonActionId extends Object
This class defines a set of common action ID's for use across API-capable PingFederate plugins.
Since:
9.3

  • Field Details

    • checkUsernamePassword

      public static final String checkUsernamePassword
      The action ID used when submitting the user's credentials.
      Since:
      9.3
      See Also:

    • useAlternativeAuthenticationSource

      public static final String useAlternativeAuthenticationSource
      The action ID used when the user opts to use an alternative authentication source.
      Since:
      9.3
      See Also:

    • checkChallengeResponse

      public static final String checkChallengeResponse
      The action ID used when submitting the user's one-time challenge response.
      Since:
      9.3
      See Also:

    • cancelAuthentication

      public static final String cancelAuthentication
      The action ID used when cancelling the current authentication flow.
      Since:
      9.3
      See Also:

    • initiatePasswordChange

      public static final String initiatePasswordChange
      The action ID used when initiating a password change.
      Since:
      9.3
      See Also:

    • cancelPasswordChange

      public static final String cancelPasswordChange
      The action ID used when canceling a password change.
      Since:
      9.3
      See Also:

    • checkNewPassword

      public static final String checkNewPassword
      The action ID used when submitting a new password for validation.
      Since:
      9.3
      See Also:

    • initiateAccountRecovery

      public static final String initiateAccountRecovery
      The action ID used when initiating an account recovery process.
      Since:
      9.3
      See Also:

    • cancelAccountRecovery

      public static final String cancelAccountRecovery
      The action ID used when canceling an account recovery process.
      Since:
      9.3
      See Also:

    • checkAccountRecoveryUsername

      public static final String checkAccountRecoveryUsername
      The action ID used when submitting the username of an existing account selected for account recovery.
      Since:
      9.3
      See Also:

    • recoverUsername

      public static final String recoverUsername
      The action ID used when initiating a username recovery.
      Since:
      9.3
      See Also:

    • checkUsernameRecoveryEmail

      public static final String checkUsernameRecoveryEmail
      The action ID used when submitting the email address associated with the username to be recovered.
      Since:
      9.3
      See Also:

    • cancelUsernameRecovery

      public static final String cancelUsernameRecovery
      The action ID used when cancelling the current username recovery flow.
      Since:
      9.3
      See Also:

    • checkRecoveryCode

      public static final String checkRecoveryCode
      The action ID used when submitting the recovery pass code for user verification during a password reset.
      Since:
      9.3
      See Also:

    • checkPasswordReset

      public static final String checkPasswordReset
      The action ID used when submitting a new password for password reset.
      Since:
      9.3
      See Also:

    • continueAccountRecovery

      public static final String continueAccountRecovery
      The action ID used to continue account recovery after an account unlock.
      Since:
      9.3
      See Also:

    • continueAuthentication

      public static final String continueAuthentication
      The action ID used to continue authentication after an action.
      Since:
      9.3
      See Also:

    • submitIdentifier

      public static final String submitIdentifier
      The action ID used when submitting an identifier to proceed authentication.
      Since:
      10.0
      See Also:

    • clearIdentifier

      public static final String clearIdentifier
      The action ID used when the user opts to clear a previously selected identifier.
      Since:
      10.0
      See Also:

    • cancelIdentifierSubmission

      public static final String cancelIdentifierSubmission
      The action ID used when cancelling the current identifier selection.
      Since:
      10.0
      See Also:

    • initiateRegistration

      public static final String initiateRegistration
      The action ID used when initiating registration for a new user.
      Since:
      10.1
      See Also:

    • registerUser

      public static final String registerUser
      The action ID used when creating a new user through registration.
      Since:
      10.1
      See Also:

    • cancel

      public static final String cancel
      The action ID used when canceling the current state.
      Since:
      10.1
      See Also:

    • continueAction

      public static final String continueAction
      The action ID used to continue the operation.
      Since:
      10.3
      See Also:

    • restart

      public static final String restart
      The action ID used to restart the authentication process.
      Since:
      10.3
      See Also:

    • selectDevice

      public static final String selectDevice
      The action ID used to select a device.
      Since:
      10.1
      See Also:

    • checkOtp

      public static final String checkOtp
      The action ID used to check if an OTP is valid.
      Since:
      10.1
      See Also:

    • resendOtp

      public static final String resendOtp
      The action ID used to resend an OTP.
      Since:
      10.1
      See Also:

    • authenticate

      public static final String authenticate
      The action ID used when the user starts an authentication.
      Since:
      10.1
      See Also:

    • poll

      public static final String poll
      The action ID used to get the current operation's status.
      Since:
      10.1
      See Also:

    • submitDeviceProfile

      public static final String submitDeviceProfile
      The action ID used to submit a user's device profile.
      Since:
      10.2
      See Also:

    • checkCurrentCredentials

      public static final String checkCurrentCredentials
      The action ID used for submitting the current credential of a user before authenticating with other factors to change password.
      Since:
      10.2
      See Also:

    • submitDeviceProfileSessionId

      public static final String submitDeviceProfileSessionId
      The action ID used for submitting the session identifier associated with device profiling.
      Since:
      10.3
      See Also:

    • sendEmailVerificationOtl

      public static final String sendEmailVerificationOtl
      The action ID used to send an OTL to the user for email verification.
      Since:
      10.3
      See Also:

    • skipOtp

      public static final String skipOtp
      The action ID used to skip an OTP verification.
      Since:
      11.0
      See Also:

    • submitUserCode

      public static final String submitUserCode
      The action ID used to submit the user code in the OAuth device authorization flow.
      Since:
      11.1
      See Also:

    • confirmUserCode

      public static final String confirmUserCode
      The action ID used to confirm the user code in the OAuth device authorization flow.
      Since:
      11.1
      See Also:

    • useClientSideAuthenticator

      public static final String useClientSideAuthenticator
      The action ID used to invoke a configured Client Side Authenticator for a given adapter.
      Since:
      13.0
      See Also:

  • Constructor Details

    • CommonActionId

      public CommonActionId()