com.okta.authn.sdk.impl.client

Class DefaultAuthenticationClient

java.lang.Object

com.okta.sdk.impl.client.BaseClient

com.okta.authn.sdk.impl.client.DefaultAuthenticationClient

All Implemented Interfaces:

AuthenticationClient, com.okta.sdk.ds.DataStore

public class DefaultAuthenticationClient
extends com.okta.sdk.impl.client.BaseClient
implements AuthenticationClient

Constructor Summary

Constructors

Constructor and Description
DefaultAuthenticationClient(com.okta.sdk.impl.config.ClientConfiguration clientConfiguration) Instantiates a new AuthenticationClient instance that will communicate with the Okta REST API.

Method Summary

Modifier and Type	Method and Description
AuthenticationResponse	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.
AuthenticationResponse	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	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.
AuthenticationResponse	authenticate(AuthenticationRequest request, RequestContext requestContext, AuthenticationStateHandler stateHandler) Initiates a username and password login against Okta's Authentication API.
AuthenticationResponse	authenticate(String username, char[] password, String relayState, AuthenticationStateHandler stateHandler) Initiates a username and password login against Okta's Authentication API.
AuthenticationResponse	cancel(String stateToken, RequestContext requestContext) Cancels the current transaction and revokes the state token.
AuthenticationResponse	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	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.
AuthenticationResponse	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.
AuthenticationResponse	enrollFactor(FactorEnrollRequest request, RequestContext requestContext, AuthenticationStateHandler stateHandler) Enrolls a user with a factor assigned by their MFA Policy.
AuthenticationResponse	enrollFactor(FactorType type, FactorProvider provider, FactorProfile factorProfile, String stateToken, AuthenticationStateHandler stateHandler) Enrolls a user with a factor assigned by their MFA Policy.
AuthenticationResponse	previous(String stateToken, RequestContext requestContext, AuthenticationStateHandler stateHandler) Moves the current transaction state back to the previous state.
AuthenticationResponse	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	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.
AuthenticationResponse	resendActivateFactor(String factorId, String stateToken, RequestContext requestContext, AuthenticationStateHandler stateHandler) Resend an activation factor challenge to a user.
AuthenticationResponse	resendVerifyFactor(String factorId, String stateToken, RequestContext requestContext, AuthenticationStateHandler stateHandler) Resend a factor verification challenge to a user.
AuthenticationResponse	resetPassword(ChangePasswordRequest request, RequestContext requestContext, AuthenticationStateHandler stateHandler) Resets a user’s password to complete a recovery transaction with a PASSWORD_RESET state.
AuthenticationResponse	resetPassword(char[] newPassword, String stateToken, AuthenticationStateHandler stateHandler) Resets a user’s password to complete a recovery transaction with a PASSWORD_RESET state.
AuthenticationResponse	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.
AuthenticationResponse	skip(String stateToken, RequestContext requestContext, AuthenticationStateHandler stateHandler) Skip the current transaction state and advance to the next state.
AuthenticationResponse	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.
AuthenticationResponse	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	verifyActivation(String factorId, String stateToken, RequestContext requestContext, AuthenticationStateHandler stateHandler) Returns the state of factor's activation.
AuthenticationResponse	verifyFactor(String factorId, String stateToken, RequestContext requestContext, AuthenticationStateHandler stateHandler) Verifies the state of a factor.
AuthenticationResponse	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
AuthenticationResponse	verifyRecoveryToken(String recoveryToken, RequestContext requestContext, AuthenticationStateHandler stateHandler) Validates a recovery token that was distributed to the end user to continue the recovery transaction.
AuthenticationResponse	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.

Methods inherited from class com.okta.sdk.impl.client.BaseClient

create, createDataStore, createRequestExecutor, delete, getCacheManager, getClientCredentials, getDataStore, getResource, http, instantiate, isReady, save

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.okta.authn.sdk.client.AuthenticationClient

activateFactor, answerRecoveryQuestion, authenticate, cancel, challengeFactor, changePassword, enrollFactor, getDataStore, instantiate, previous, recoverPassword, resendActivateFactor, resendVerifyFactor, resetPassword, sendActivationEmail, skip, unlockAccount, verifyActivation, verifyFactor, verifyFactor, verifyRecoveryToken, verifyUnlockAccount

Constructor Detail

DefaultAuthenticationClient

public DefaultAuthenticationClient(com.okta.sdk.impl.config.ClientConfiguration clientConfiguration)

Instantiates a new AuthenticationClient instance that will communicate with the Okta REST API. See the class-level JavaDoc for a usage example.

Parameters:

clientConfiguration - the ClientConfiguration containing the connection information

Method Detail

authenticate

public AuthenticationResponse authenticate(String username,
                                           char[] password,
                                           String relayState,
                                           AuthenticationStateHandler stateHandler)
                                    throws AuthenticationException

Description copied from interface: AuthenticationClient

Initiates a username and password login against Okta's Authentication API. A user should not be considered logged in until both the response status is {code SUCCESS} and the sessionToken is non null.

Specified by:

authenticate in interface AuthenticationClient

Parameters:

username - User’s non-qualified short-name (e.g. dade.murphy) or unique fully-qualified login (e.g dade.murphy@example.com)

password - User’s password credential

relayState - Optional state value that is persisted for the lifetime of the authentication transaction

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

AuthenticationFailureException - when username or password are invalid

AuthenticationException - any other authentication related error

authenticate

public AuthenticationResponse authenticate(AuthenticationRequest request,
                                           RequestContext requestContext,
                                           AuthenticationStateHandler stateHandler)
                                    throws AuthenticationException

Description copied from interface: AuthenticationClient

Initiates a username and password login against Okta's Authentication API. A user should not be considered logged in until both the response status is {code SUCCESS} and the sessionToken is non null.

Specified by:

authenticate in interface AuthenticationClient

Parameters:

request - a request object holds all attributes sent to the remote API.

requestContext - additional request headers and query parameters used for this request

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

AuthenticationFailureException - when username or password are invalid

AuthenticationException - any other authentication related error

changePassword

public AuthenticationResponse changePassword(char[] oldPassword,
                                             char[] newPassword,
                                             String stateToken,
                                             AuthenticationStateHandler stateHandler)
                                      throws AuthenticationException

Description copied from interface: AuthenticationClient

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.

Specified by:

changePassword in interface AuthenticationClient

Parameters:

oldPassword - User’s current password that is expired or about to expire

newPassword - New password for user

stateToken - state token for current transaction

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

CredentialsException - thrown if old password is invalid, or the new password fails to meet the requirements of the password policy

AuthenticationException - any other authentication related error

changePassword

public AuthenticationResponse changePassword(ChangePasswordRequest changePasswordRequest,
                                             RequestContext requestContext,
                                             AuthenticationStateHandler stateHandler)
                                      throws AuthenticationException

Description copied from interface: AuthenticationClient

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.

Specified by:

changePassword in interface AuthenticationClient

Parameters:

changePasswordRequest - a request object holds all attributes sent to the remote API.

requestContext - additional request headers and query parameters used for this request

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

CredentialsException - thrown if old password is invalid, or the new password fails to meet the requirements of the password policy

AuthenticationException - any other authentication related error

resetPassword

public AuthenticationResponse resetPassword(char[] newPassword,
                                            String stateToken,
                                            AuthenticationStateHandler stateHandler)
                                     throws AuthenticationException

Description copied from interface: AuthenticationClient

Resets a user’s password to complete a recovery transaction with a PASSWORD_RESET state.

Specified by:

resetPassword in interface AuthenticationClient

Parameters:

newPassword - User’s new password

stateToken - state token for current transaction

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

CredentialsException - thrown if old password is invalid, or the new password fails to meet the requirements of the password policy

AuthenticationException - any other authentication related error

resetPassword

public AuthenticationResponse resetPassword(ChangePasswordRequest request,
                                            RequestContext requestContext,
                                            AuthenticationStateHandler stateHandler)
                                     throws AuthenticationException

Description copied from interface: AuthenticationClient

Resets a user’s password to complete a recovery transaction with a PASSWORD_RESET state.

Specified by:

resetPassword in interface AuthenticationClient

Parameters:

request - a request object holds all attributes sent to the remote API

requestContext - additional request headers and query parameters used for this request

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

CredentialsException - thrown if old password is invalid, or the new password fails to meet the requirements of the password policy

AuthenticationException - any other authentication related error

recoverPassword

public AuthenticationResponse recoverPassword(String username,
                                              FactorType factorType,
                                              String relayState,
                                              AuthenticationStateHandler stateHandler)
                                       throws AuthenticationException

Description copied from interface: AuthenticationClient

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.

Specified by:

recoverPassword in interface AuthenticationClient

Parameters:

username - User’s non-qualified short-name (e.g. dade.murphy) or unique fully-qualified login (dade.murphy@example.com)

factorType - Recovery factor to use for primary authentication

relayState - Optional state value that is persisted for the lifetime of the recovery transaction

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

AuthenticationException - any other authentication related error

recoverPassword

public AuthenticationResponse recoverPassword(RecoverPasswordRequest request,
                                              RequestContext requestContext,
                                              AuthenticationStateHandler stateHandler)
                                       throws AuthenticationException

Description copied from interface: AuthenticationClient

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.

Specified by:

recoverPassword in interface AuthenticationClient

Parameters:

request - a request object holds all attributes sent to the remote API.

requestContext - additional request headers and query parameters used for this request

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

AuthenticationException - any other authentication related error

challengeFactor

public AuthenticationResponse challengeFactor(String factorId,
                                              String stateToken,
                                              RequestContext requestContext,
                                              AuthenticationStateHandler stateHandler)
                                       throws AuthenticationException

Description copied from interface: AuthenticationClient

Requests a challenge factor be sent to the user via the corresponding {code}factorId{code}.

Specified by:

challengeFactor in interface AuthenticationClient

Parameters:

factorId - id of factor returned from enrollment

stateToken - state token for current transaction

requestContext - additional request headers and query parameters used for this request

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

AuthenticationException - any other authentication related error

verifyFactor

public AuthenticationResponse verifyFactor(String factorId,
                                           String stateToken,
                                           RequestContext requestContext,
                                           AuthenticationStateHandler stateHandler)
                                    throws AuthenticationException

Description copied from interface: AuthenticationClient

Verifies the state of a factor. Some factors (Push, Duo, etc) depend on a user action, this method can be used to poll the state of the a factor and transition to the next state when completed.

Specified by:

verifyFactor in interface AuthenticationClient

Parameters:

factorId - id of factor returned from enrollment

stateToken - state token for current transaction

requestContext - additional request headers and query parameters used for this request

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

AuthenticationException - any other authentication related error

verifyFactor

public AuthenticationResponse verifyFactor(String factorId,
                                           VerifyFactorRequest request,
                                           RequestContext requestContext,
                                           AuthenticationStateHandler stateHandler)
                                    throws AuthenticationException

Description copied from interface: AuthenticationClient

Verifies an enrolled factor for an authentication transaction with the MFA_REQUIRED or MFA_CHALLENGE state

Specified by:

verifyFactor in interface AuthenticationClient

Parameters:

factorId - id of factor returned from enrollment

request - the request object containing the required attributes to fulfill the verification

requestContext - additional request headers and query parameters used for this request

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

AuthenticationException - any other authentication related error

activateFactor

public AuthenticationResponse activateFactor(String factorId,
                                             ActivateFactorRequest request,
                                             RequestContext requestContext,
                                             AuthenticationStateHandler stateHandler)
                                      throws AuthenticationException

Description copied from interface: AuthenticationClient

The sms, call and token:software:totp factor types require activation to complete the enrollment process.

Specified by:

activateFactor in interface AuthenticationClient

Parameters:

factorId - id of factor returned from enrollment

request - the request object containing the required attributes to fulfill the activation

requestContext - additional request headers and query parameters used for this request

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

AuthenticationException - any other authentication related error

verifyUnlockAccount

public AuthenticationResponse verifyUnlockAccount(FactorType factorType,
                                                  VerifyRecoveryRequest request,
                                                  RequestContext requestContext,
                                                  AuthenticationStateHandler stateHandler)
                                           throws AuthenticationException

Description copied from interface: AuthenticationClient

Verifies a recovery challenge sent to the user for primary authentication for a recovery transaction with RECOVERY_CHALLENGE status.

Specified by:

verifyUnlockAccount in interface AuthenticationClient

Parameters:

factorType - type of factor

request - the request object containing the required attributes to fulfill this challenge

requestContext - additional request headers and query parameters used for this request

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

AuthenticationException - any other authentication related error

unlockAccount

public AuthenticationResponse unlockAccount(String username,
                                            FactorType factorType,
                                            String relayState,
                                            AuthenticationStateHandler stateHandler)
                                     throws AuthenticationException

Description copied from interface: AuthenticationClient

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.

Specified by:

unlockAccount in interface AuthenticationClient

Parameters:

username - User’s non-qualified short-name (dade.murphy) or unique fully-qualified login (dade.murphy@example.com)

factorType - Recovery factor to use for primary authentication

relayState - Optional state value that is persisted for the lifetime of the recovery transaction

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

AuthenticationException - any other authentication related error

unlockAccount

public AuthenticationResponse unlockAccount(UnlockAccountRequest request,
                                            RequestContext requestContext,
                                            AuthenticationStateHandler stateHandler)
                                     throws AuthenticationException

Description copied from interface: AuthenticationClient

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.

Specified by:

unlockAccount in interface AuthenticationClient

Parameters:

request - a request object holds all attributes sent to the remote API.

requestContext - additional request headers and query parameters used for this request

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

AuthenticationException - any other authentication related error

answerRecoveryQuestion

public AuthenticationResponse answerRecoveryQuestion(String answer,
                                                     String stateToken,
                                                     AuthenticationStateHandler stateHandler)
                                              throws AuthenticationException

Description copied from interface: AuthenticationClient

Answers the user’s recovery question to ensure only the end user redeemed the recovery token for recovery transaction with a RECOVERY status.

Specified by:

answerRecoveryQuestion in interface AuthenticationClient

Parameters:

answer - answer to user’s recovery question

stateToken - state token for current transaction

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

InvalidRecoveryAnswerException - thrown when the answer is invalid

AuthenticationException - any other authentication related error

answerRecoveryQuestion

public AuthenticationResponse answerRecoveryQuestion(RecoveryQuestionAnswerRequest request,
                                                     RequestContext requestContext,
                                                     AuthenticationStateHandler stateHandler)
                                              throws AuthenticationException

Description copied from interface: AuthenticationClient

Answers the user’s recovery question to ensure only the end user redeemed the recovery token for recovery transaction with a RECOVERY status.

Specified by:

answerRecoveryQuestion in interface AuthenticationClient

Parameters:

request - a request object holds all attributes sent to the remote API.

requestContext - additional request headers and query parameters used for this request

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

InvalidRecoveryAnswerException - thrown when the answer is invalid

AuthenticationException - any other authentication related error

enrollFactor

public AuthenticationResponse enrollFactor(FactorType type,
                                           FactorProvider provider,
                                           FactorProfile factorProfile,
                                           String stateToken,
                                           AuthenticationStateHandler stateHandler)
                                    throws AuthenticationException

Description copied from interface: AuthenticationClient

Enrolls a user with a factor assigned by their MFA Policy.

Specified by:

enrollFactor in interface AuthenticationClient

Parameters:

type - type of factor

provider - factor provider

factorProfile - profile of a supported factor

stateToken - state token for current transaction

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

AuthenticationException - any other authentication related error

See Also:

supported factor profiles

enrollFactor

public AuthenticationResponse enrollFactor(FactorEnrollRequest request,
                                           RequestContext requestContext,
                                           AuthenticationStateHandler stateHandler)
                                    throws AuthenticationException

Description copied from interface: AuthenticationClient

Enrolls a user with a factor assigned by their MFA Policy.

Specified by:

enrollFactor in interface AuthenticationClient

Parameters:

request - a request object holds all attributes sent to the remote API.

requestContext - additional request headers and query parameters used for this request

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

AuthenticationException - any other authentication related error

See Also:

supported factor profiles

previous

public AuthenticationResponse previous(String stateToken,
                                       RequestContext requestContext,
                                       AuthenticationStateHandler stateHandler)
                                throws AuthenticationException

Description copied from interface: AuthenticationClient

Moves the current transaction state back to the previous state.

Specified by:

previous in interface AuthenticationClient

Parameters:

stateToken - state token for current transaction

requestContext - additional request headers and query parameters used for this request

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

AuthenticationException - any other authentication related error

skip

public AuthenticationResponse skip(String stateToken,
                                   RequestContext requestContext,
                                   AuthenticationStateHandler stateHandler)
                            throws AuthenticationException

Description copied from interface: AuthenticationClient

Skip the current transaction state and advance to the next state.

Specified by:

skip in interface AuthenticationClient

Parameters:

stateToken - state token for current transaction

requestContext - additional request headers and query parameters used for this request

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

AuthenticationException - any other authentication related error

cancel

public AuthenticationResponse cancel(String stateToken,
                                     RequestContext requestContext)
                              throws AuthenticationException

Description copied from interface: AuthenticationClient

Cancels the current transaction and revokes the state token.

Specified by:

cancel in interface AuthenticationClient

Parameters:

stateToken - state token for current transaction

requestContext - additional request headers and query parameters used for this request

Returns:

An authentication response

Throws:

AuthenticationException - any other authentication related error

resendActivateFactor

public AuthenticationResponse resendActivateFactor(String factorId,
                                                   String stateToken,
                                                   RequestContext requestContext,
                                                   AuthenticationStateHandler stateHandler)
                                            throws AuthenticationException

Description copied from interface: AuthenticationClient

Resend an activation factor challenge to a user. Factors that require the challenge sent to the user (push, call, sms, etc) may need to be resent to ensure delivery.

Specified by:

resendActivateFactor in interface AuthenticationClient

Parameters:

factorId - id of factor returned from enrollment

stateToken - state token for current transaction

requestContext - additional request headers and query parameters used for this request

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

AuthenticationException - any other authentication related error

resendVerifyFactor

public AuthenticationResponse resendVerifyFactor(String factorId,
                                                 String stateToken,
                                                 RequestContext requestContext,
                                                 AuthenticationStateHandler stateHandler)
                                          throws AuthenticationException

Description copied from interface: AuthenticationClient

Resend a factor verification challenge to a user. Factors that require the challenge sent to the user (push, call, sms, etc) may need to be resent to ensure delivery.

Specified by:

resendVerifyFactor in interface AuthenticationClient

Parameters:

factorId - id of factor returned from enrollment

stateToken - state token for current transaction

requestContext - additional request headers and query parameters used for this request

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

AuthenticationException - any other authentication related error

sendActivationEmail

public AuthenticationResponse sendActivationEmail(String factorId,
                                                  String stateToken,
                                                  RequestContext requestContext,
                                                  AuthenticationStateHandler stateHandler)
                                           throws AuthenticationException

Description copied from interface: AuthenticationClient

Sends an activation email when the user is unable to scan the QR code provided as part of an Okta Verify transaction. If for any reason the user can't scan the QR code, they can use the link provided in email or SMS to complete the transaction.

Specified by:

sendActivationEmail in interface AuthenticationClient

Parameters:

factorId - id of factor returned from enrollment

stateToken - state token for current transaction

requestContext - additional request headers and query parameters used for this request

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

AuthenticationException - any other authentication related error

verifyActivation

public AuthenticationResponse verifyActivation(String factorId,
                                               String stateToken,
                                               RequestContext requestContext,
                                               AuthenticationStateHandler stateHandler)
                                        throws AuthenticationException

Description copied from interface: AuthenticationClient

Returns the state of factor's activation. Some factors (Push, Duo, etc) depend on a user action, this method can be used to poll the state of the a factor's activation and transition to the next state when completed.

Specified by:

verifyActivation in interface AuthenticationClient

stateToken - state token for current transaction

requestContext - additional request headers and query parameters used for this request

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

AuthenticationException - any other authentication related error

verifyRecoveryToken

public AuthenticationResponse verifyRecoveryToken(String recoveryToken,
                                                  RequestContext requestContext,
                                                  AuthenticationStateHandler stateHandler)
                                           throws AuthenticationException

Description copied from interface: AuthenticationClient

Validates a recovery token that was distributed to the end user to continue the recovery transaction.

Specified by:

verifyRecoveryToken in interface AuthenticationClient

Parameters:

recoveryToken - Recovery token that was distributed to the end user via out-of-band mechanism such as email

requestContext - additional request headers and query parameters used for this request

stateHandler - State handler that handles the resulting status change corresponding to the Okta authentication state machine

Returns:

An authentication response

Throws:

AuthenticationException - any other authentication related error