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 Summary

Fields
Modifier and Type	Field	Description
`static String`	`authenticate`	The action ID used when the user starts an authentication.
`static String`	`cancel`	The action ID used when canceling the current state.
`static String`	`cancelAccountRecovery`	The action ID used when canceling an account recovery process.
`static String`	`cancelAuthentication`	The action ID used when cancelling the current authentication flow.
`static String`	`cancelIdentifierSubmission`	The action ID used when cancelling the current identifier selection.
`static String`	`cancelPasswordChange`	The action ID used when canceling a password change.
`static String`	`cancelUsernameRecovery`	The action ID used when cancelling the current username recovery flow.
`static String`	`checkAccountRecoveryUsername`	The action ID used when submitting the username of an existing account selected for account recovery.
`static String`	`checkChallengeResponse`	The action ID used when submitting the user's one-time challenge response.
`static String`	`checkCurrentCredentials`	The action ID used for submitting the current credential of a user before authenticating with other factors to change password.
`static String`	`checkNewPassword`	The action ID used when submitting a new password for validation.
`static String`	`checkOtp`	The action ID used to check if an OTP is valid.
`static String`	`checkPasswordReset`	The action ID used when submitting a new password for password reset.
`static String`	`checkRecoveryCode`	The action ID used when submitting the recovery pass code for user verification during a password reset.
`static String`	`checkUsernamePassword`	The action ID used when submitting the user's credentials.
`static String`	`checkUsernameRecoveryEmail`	The action ID used when submitting the email address associated with the username to be recovered.
`static String`	`clearIdentifier`	The action ID used when the user opts to clear a previously selected identifier.
`static String`	`confirmUserCode`	The action ID used to confirm the user code in the OAuth device authorization flow.
`static String`	`continueAccountRecovery`	The action ID used to continue account recovery after an account unlock.
`static String`	`continueAction`	The action ID used to continue the operation.
`static String`	`continueAuthentication`	The action ID used to continue authentication after an action.
`static String`	`initiateAccountRecovery`	The action ID used when initiating an account recovery process.
`static String`	`initiatePasswordChange`	The action ID used when initiating a password change.
`static String`	`initiateRegistration`	The action ID used when initiating registration for a new user.
`static String`	`poll`	The action ID used to get the current operation's status.
`static String`	`recoverUsername`	The action ID used when initiating a username recovery.
`static String`	`registerUser`	The action ID used when creating a new user through registration.
`static String`	`resendOtp`	The action ID used to resend an OTP.
`static String`	`restart`	The action ID used to restart the authentication process.
`static String`	`selectDevice`	The action ID used to select a device.
`static String`	`sendEmailVerificationOtl`	The action ID used to send an OTL to the user for email verification.
`static String`	`skipOtp`	The action ID used to skip an OTP verification.
`static String`	`submitDeviceProfile`	The action ID used to submit a user's device profile.
`static String`	`submitDeviceProfileSessionId`	The action ID used for submitting the session identifier associated with device profiling.
`static String`	`submitIdentifier`	The action ID used when submitting an identifier to proceed authentication.
`static String`	`submitUserCode`	The action ID used to submit the user code in the OAuth device authorization flow.
`static String`	`useAlternativeAuthenticationSource`	The action ID used when the user opts to use an alternative authentication source.

Constructor Summary

Constructors
Constructor Description

CommonActionId()

Method Summary
- Methods inherited from class java.lang.Object
  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - checkUsernamePassword
```
public static final String checkUsernamePassword
```
    The action ID used when submitting the user's credentials.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - checkChallengeResponse
```
public static final String checkChallengeResponse
```
    The action ID used when submitting the user's one-time challenge response.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - cancelAuthentication
```
public static final String cancelAuthentication
```
    The action ID used when cancelling the current authentication flow.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - initiatePasswordChange
```
public static final String initiatePasswordChange
```
    The action ID used when initiating a password change.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - cancelPasswordChange
```
public static final String cancelPasswordChange
```
    The action ID used when canceling a password change.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - checkNewPassword
```
public static final String checkNewPassword
```
    The action ID used when submitting a new password for validation.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - initiateAccountRecovery
```
public static final String initiateAccountRecovery
```
    The action ID used when initiating an account recovery process.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - cancelAccountRecovery
```
public static final String cancelAccountRecovery
```
    The action ID used when canceling an account recovery process.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - recoverUsername
```
public static final String recoverUsername
```
    The action ID used when initiating a username recovery.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - cancelUsernameRecovery
```
public static final String cancelUsernameRecovery
```
    The action ID used when cancelling the current username recovery flow.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - checkPasswordReset
```
public static final String checkPasswordReset
```
    The action ID used when submitting a new password for password reset.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - continueAccountRecovery
```
public static final String continueAccountRecovery
```
    The action ID used to continue account recovery after an account unlock.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - continueAuthentication
```
public static final String continueAuthentication
```
    The action ID used to continue authentication after an action.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - submitIdentifier
```
public static final String submitIdentifier
```
    The action ID used when submitting an identifier to proceed authentication.
    
    Since:
    
    10.0
    
    See Also:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - cancelIdentifierSubmission
```
public static final String cancelIdentifierSubmission
```
    The action ID used when cancelling the current identifier selection.
    
    Since:
    
    10.0
    
    See Also:
    
    Constant Field Values
  - initiateRegistration
```
public static final String initiateRegistration
```
    The action ID used when initiating registration for a new user.
    
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
  - registerUser
```
public static final String registerUser
```
    The action ID used when creating a new user through registration.
    
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
  - cancel
```
public static final String cancel
```
    The action ID used when canceling the current state.
    
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
  - continueAction
```
public static final String continueAction
```
    The action ID used to continue the operation.
    
    Since:
    
    10.3
    
    See Also:
    
    Constant Field Values
  - restart
```
public static final String restart
```
    The action ID used to restart the authentication process.
    
    Since:
    
    10.3
    
    See Also:
    
    Constant Field Values
  - selectDevice
```
public static final String selectDevice
```
    The action ID used to select a device.
    
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
  - checkOtp
```
public static final String checkOtp
```
    The action ID used to check if an OTP is valid.
    
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
  - resendOtp
```
public static final String resendOtp
```
    The action ID used to resend an OTP.
    
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
  - authenticate
```
public static final String authenticate
```
    The action ID used when the user starts an authentication.
    
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
  - poll
```
public static final String poll
```
    The action ID used to get the current operation's status.
    
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
  - submitDeviceProfile
```
public static final String submitDeviceProfile
```
    The action ID used to submit a user's device profile.
    
    Since:
    
    10.2
    
    See Also:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - submitDeviceProfileSessionId
```
public static final String submitDeviceProfileSessionId
```
    The action ID used for submitting the session identifier associated with device profiling.
    
    Since:
    
    10.3
    
    See Also:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - skipOtp
```
public static final String skipOtp
```
    The action ID used to skip an OTP verification.
    
    Since:
    
    11.0
    
    See Also:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
- Constructor Detail
  - CommonActionId
```
public CommonActionId()
```

Class CommonActionId

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

checkUsernamePassword

useAlternativeAuthenticationSource

checkChallengeResponse

cancelAuthentication

initiatePasswordChange

cancelPasswordChange

checkNewPassword

initiateAccountRecovery

cancelAccountRecovery

checkAccountRecoveryUsername

recoverUsername

checkUsernameRecoveryEmail

cancelUsernameRecovery

checkRecoveryCode

checkPasswordReset

continueAccountRecovery

continueAuthentication

submitIdentifier

clearIdentifier

cancelIdentifierSubmission

initiateRegistration

registerUser

cancel

continueAction

restart

selectDevice

checkOtp

resendOtp

authenticate

poll

submitDeviceProfile

checkCurrentCredentials

submitDeviceProfileSessionId

sendEmailVerificationOtl

skipOtp

submitUserCode

confirmUserCode

Constructor Detail

CommonActionId