Uses of Annotation Type
com.okta.authn.sdk.doc.ApiReference

Packages that use ApiReference

Package	Description
com.okta.authn.sdk.client

Uses of ApiReference in com.okta.authn.sdk.client

Methods in com.okta.authn.sdk.client with annotations of type ApiReference

Modifier and Type	Method	Description
default AuthenticationResponse	AuthenticationClient.activateFactor(String factorId, ActivateFactorRequest request, AuthenticationStateHandler stateHandler)	The sms, call and token:software:totp factor types require activation to complete the enrollment process.
AuthenticationResponse	AuthenticationClient.activateFactor(String factorId, ActivateFactorRequest request, RequestContext requestContext, AuthenticationStateHandler stateHandler)	The sms, call and token:software:totp factor types require activation to complete the enrollment process.
default AuthenticationResponse	AuthenticationClient.answerRecoveryQuestion(RecoveryQuestionAnswerRequest request, AuthenticationStateHandler stateHandler)	Answers the user’s recovery question to ensure only the end user redeemed the recovery token for recovery transaction with a RECOVERY status.
AuthenticationResponse	AuthenticationClient.answerRecoveryQuestion(RecoveryQuestionAnswerRequest request, RequestContext requestContext, AuthenticationStateHandler stateHandler)	Answers the user’s recovery question to ensure only the end user redeemed the recovery token for recovery transaction with a RECOVERY status.
AuthenticationResponse	AuthenticationClient.answerRecoveryQuestion(String answer, String stateToken, AuthenticationStateHandler stateHandler)	Answers the user’s recovery question to ensure only the end user redeemed the recovery token for recovery transaction with a RECOVERY status.
default AuthenticationResponse	AuthenticationClient.authenticate(AuthenticationRequest request, AuthenticationStateHandler stateHandler)	Initiates a username and password login against Okta's Authentication API.
AuthenticationResponse	AuthenticationClient.authenticate(AuthenticationRequest request, RequestContext requestContext, AuthenticationStateHandler stateHandler)	Initiates a username and password login against Okta's Authentication API.
AuthenticationResponse	AuthenticationClient.authenticate(String username, char[] password, String relayState, AuthenticationStateHandler stateHandler)	Initiates a username and password login against Okta's Authentication API.
default AuthenticationResponse	AuthenticationClient.cancel(String stateToken)	Cancels the current transaction and revokes the state token.
AuthenticationResponse	AuthenticationClient.cancel(String stateToken, RequestContext requestContext)	Cancels the current transaction and revokes the state token.
default AuthenticationResponse	AuthenticationClient.challengeFactor(String factorId, String stateToken, AuthenticationStateHandler stateHandler)	Requests a challenge factor be sent to the user via the corresponding {code}factorId{code}.
AuthenticationResponse	AuthenticationClient.challengeFactor(String factorId, String stateToken, RequestContext requestContext, AuthenticationStateHandler stateHandler)	Requests a challenge factor be sent to the user via the corresponding {code}factorId{code}.
AuthenticationResponse	AuthenticationClient.changePassword(char[] oldPassword, char[] newPassword, String stateToken, AuthenticationStateHandler stateHandler)	This operation changes a user’s password by providing the existing password and the new password password for authentication transactions with either the PASSWORD_EXPIRED or PASSWORD_WARN state.
default AuthenticationResponse	AuthenticationClient.changePassword(ChangePasswordRequest changePasswordRequest, AuthenticationStateHandler stateHandler)	This operation changes a user’s password by providing the existing password and the new password password for authentication transactions with either the PASSWORD_EXPIRED or PASSWORD_WARN state.
AuthenticationResponse	AuthenticationClient.changePassword(ChangePasswordRequest changePasswordRequest, RequestContext requestContext, AuthenticationStateHandler stateHandler)	This operation changes a user’s password by providing the existing password and the new password password for authentication transactions with either the PASSWORD_EXPIRED or PASSWORD_WARN state.
default AuthenticationResponse	AuthenticationClient.enrollFactor(FactorEnrollRequest factorEnrollRequest, AuthenticationStateHandler stateHandler)	Enrolls a user with a factor assigned by their MFA Policy.
AuthenticationResponse	AuthenticationClient.enrollFactor(FactorEnrollRequest factorEnrollRequest, RequestContext requestContext, AuthenticationStateHandler stateHandler)	Enrolls a user with a factor assigned by their MFA Policy.
AuthenticationResponse	AuthenticationClient.enrollFactor(FactorType factorType, FactorProvider factorProvider, FactorProfile factorProfile, String stateToken, AuthenticationStateHandler stateHandler)	Enrolls a user with a factor assigned by their MFA Policy.
default AuthenticationResponse	AuthenticationClient.previous(String stateToken, AuthenticationStateHandler stateHandler)	Moves the current transaction state back to the previous state.
AuthenticationResponse	AuthenticationClient.previous(String stateToken, RequestContext requestContext, AuthenticationStateHandler stateHandler)	Moves the current transaction state back to the previous state.
default AuthenticationResponse	AuthenticationClient.recoverPassword(RecoverPasswordRequest request, AuthenticationStateHandler stateHandler)	Starts a new password recovery transaction for a given user and issues a recovery token that can be used to reset a user’s password.
AuthenticationResponse	AuthenticationClient.recoverPassword(RecoverPasswordRequest request, RequestContext requestContext, AuthenticationStateHandler stateHandler)	Starts a new password recovery transaction for a given user and issues a recovery token that can be used to reset a user’s password.
AuthenticationResponse	AuthenticationClient.recoverPassword(String username, FactorType factorType, String relayState, AuthenticationStateHandler stateHandler)	Starts a new password recovery transaction for a given user and issues a recovery token that can be used to reset a user’s password.
default AuthenticationResponse	AuthenticationClient.resendActivateFactor(String factorId, String stateToken, AuthenticationStateHandler stateHandler)	Resend an activation factor challenge to a user.
AuthenticationResponse	AuthenticationClient.resendActivateFactor(String factorId, String stateToken, RequestContext requestContext, AuthenticationStateHandler stateHandler)	Resend an activation factor challenge to a user.
default AuthenticationResponse	AuthenticationClient.resendVerifyFactor(String factorId, String stateToken, AuthenticationStateHandler stateHandler)	Resend a factor verification challenge to a user.
AuthenticationResponse	AuthenticationClient.resendVerifyFactor(String factorId, String stateToken, RequestContext requestContext, AuthenticationStateHandler stateHandler)	Resend a factor verification challenge to a user.
AuthenticationResponse	AuthenticationClient.resetPassword(char[] newPassword, String stateToken, AuthenticationStateHandler stateHandler)	Resets a user’s password to complete a recovery transaction with a PASSWORD_RESET state.
default AuthenticationResponse	AuthenticationClient.resetPassword(ChangePasswordRequest changePasswordRequest, AuthenticationStateHandler stateHandler)	Resets a user’s password to complete a recovery transaction with a PASSWORD_RESET state.
AuthenticationResponse	AuthenticationClient.resetPassword(ChangePasswordRequest changePasswordRequest, RequestContext requestContext, AuthenticationStateHandler stateHandler)	Resets a user’s password to complete a recovery transaction with a PASSWORD_RESET state.
default AuthenticationResponse	AuthenticationClient.sendActivationEmail(String factorId, String stateToken, AuthenticationStateHandler stateHandler)	Sends an activation email when the user is unable to scan the QR code provided as part of an Okta Verify transaction.
AuthenticationResponse	AuthenticationClient.sendActivationEmail(String factorId, String stateToken, RequestContext requestContext, AuthenticationStateHandler stateHandler)	Sends an activation email when the user is unable to scan the QR code provided as part of an Okta Verify transaction.
default AuthenticationResponse	AuthenticationClient.skip(String stateToken, AuthenticationStateHandler stateHandler)	Skip the current transaction state and advance to the next state.
AuthenticationResponse	AuthenticationClient.skip(String stateToken, RequestContext requestContext, AuthenticationStateHandler stateHandler)	Skip the current transaction state and advance to the next state.
default AuthenticationResponse	AuthenticationClient.unlockAccount(UnlockAccountRequest request, AuthenticationStateHandler stateHandler)	Starts a new unlock recovery transaction for a given user and issues a recovery token that can be used to unlock a user’s account.
AuthenticationResponse	AuthenticationClient.unlockAccount(UnlockAccountRequest request, RequestContext requestContext, AuthenticationStateHandler stateHandler)	Starts a new unlock recovery transaction for a given user and issues a recovery token that can be used to unlock a user’s account.
AuthenticationResponse	AuthenticationClient.unlockAccount(String username, FactorType factorType, String relayState, AuthenticationStateHandler stateHandler)	Starts a new unlock recovery transaction for a given user and issues a recovery token that can be used to unlock a user’s account.
default AuthenticationResponse	AuthenticationClient.verifyActivation(String factorId, String stateToken, AuthenticationStateHandler stateHandler)	Returns the state of factor's activation.
AuthenticationResponse	AuthenticationClient.verifyActivation(String factorId, String stateToken, RequestContext requestContext, AuthenticationStateHandler stateHandler)	Returns the state of factor's activation.
default AuthenticationResponse	AuthenticationClient.verifyFactor(String factorId, VerifyFactorRequest request, AuthenticationStateHandler stateHandler)	Verifies an enrolled factor for an authentication transaction with the MFA_REQUIRED or MFA_CHALLENGE state
AuthenticationResponse	AuthenticationClient.verifyFactor(String factorId, VerifyFactorRequest request, RequestContext requestContext, AuthenticationStateHandler stateHandler)	Verifies an enrolled factor for an authentication transaction with the MFA_REQUIRED or MFA_CHALLENGE state
default AuthenticationResponse	AuthenticationClient.verifyFactor(String factorId, String stateToken, AuthenticationStateHandler stateHandler)	Verifies the state of a factor.
AuthenticationResponse	AuthenticationClient.verifyFactor(String factorId, String stateToken, RequestContext requestContext, AuthenticationStateHandler stateHandler)	Verifies the state of a factor.
default AuthenticationResponse	AuthenticationClient.verifyRecoveryToken(String recoveryToken, AuthenticationStateHandler stateHandler)	Validates a recovery token that was distributed to the end user to continue the recovery transaction.
AuthenticationResponse	AuthenticationClient.verifyRecoveryToken(String recoveryToken, RequestContext requestContext, AuthenticationStateHandler stateHandler)	Validates a recovery token that was distributed to the end user to continue the recovery transaction.
default AuthenticationResponse	AuthenticationClient.verifyUnlockAccount(FactorType factorType, VerifyRecoveryRequest request, AuthenticationStateHandler stateHandler)	Verifies a recovery challenge sent to the user for primary authentication for a recovery transaction with RECOVERY_CHALLENGE status.
AuthenticationResponse	AuthenticationClient.verifyUnlockAccount(FactorType factorType, VerifyRecoveryRequest request, RequestContext requestContext, AuthenticationStateHandler stateHandler)	Verifies a recovery challenge sent to the user for primary authentication for a recovery transaction with RECOVERY_CHALLENGE status.