Class AuthenticationClient

This class represents the authentication client

Inheritance

System.Object

AuthenticationClient

Implements

IAuthenticationClient

IOktaClient

Namespace: Okta.Auth.Sdk

Assembly: Okta.Auth.Sdk.dll

Syntax

public class AuthenticationClient : BaseOktaClient, IAuthenticationClient, IOktaClient

Constructors

AuthenticationClient(IDataStore, OktaClientConfiguration, RequestContext)

Initializes a new instance of the AuthenticationClient class.

Declaration

protected AuthenticationClient(IDataStore dataStore, OktaClientConfiguration configuration, RequestContext requestContext)

Parameters

Type	Name	Description
IDataStore	dataStore	The DataStore to use.
OktaClientConfiguration	configuration	The client configuration.
RequestContext	requestContext	The request context, if any.

Remarks

This overload is used internally to create cheap copies of an existing client.

AuthenticationClient(OktaClientConfiguration, HttpClient, ILogger)

Initializes a new instance of the AuthenticationClient class using the specified System.Net.Http.HttpClient.

Declaration

public AuthenticationClient(OktaClientConfiguration apiClientConfiguration = null, HttpClient httpClient = null, ILogger logger = null)

Parameters

Type	Name	Description
OktaClientConfiguration	apiClientConfiguration	The client configuration. If null, the library will attempt to load configuration from an okta.yaml file or environment variables.
System.Net.Http.HttpClient	httpClient	The HTTP client to use for requests to the Okta API.
ILogger	logger	The logging interface to use, if any.

Methods

ActivateFactorAsync(ActivateFactorOptions, CancellationToken)

Activates a factor https://developer.okta.com/docs/api/resources/authn#activate-factor

Declaration

public Task<IAuthenticationResponse> ActivateFactorAsync(ActivateFactorOptions activateFactorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
ActivateFactorOptions	activateFactorOptions	The activate factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

ActivateFactorAsync(ActivatePushFactorOptions, CancellationToken)

Activates a push factor https://developer.okta.com/docs/api/resources/authn#activate-push-factor

Declaration

public Task<IAuthenticationResponse> ActivateFactorAsync(ActivatePushFactorOptions activatePushFactorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
ActivatePushFactorOptions	activatePushFactorOptions	The activate push factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

ActivateFactorAsync(ActivateU2fFactorOptions, CancellationToken)

Activates a U2F factor https://developer.okta.com/docs/api/resources/authn#activate-u2f-factor

Declaration

public Task<IAuthenticationResponse> ActivateFactorAsync(ActivateU2fFactorOptions activateFactorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
ActivateU2fFactorOptions	activateFactorOptions	The activate U2F factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

ActivateFactorAsync(ActivateWebAuthnFactorOptions, CancellationToken)

Activates a WebAuthn factor https://developer.okta.com/docs/api/resources/authn#activate-webauthn-factor

Declaration

public Task<IAuthenticationResponse> ActivateFactorAsync(ActivateWebAuthnFactorOptions activateFactorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
ActivateWebAuthnFactorOptions	activateFactorOptions	The activate WebAuthn factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

AnswerRecoveryQuestionAsync(AnswerRecoveryQuestionOptions, CancellationToken)

Answers the user’s recovery question https://developer.okta.com/docs/api/resources/authn#answer-recovery-question

Declaration

public Task<IAuthenticationResponse> AnswerRecoveryQuestionAsync(AnswerRecoveryQuestionOptions answerOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
AnswerRecoveryQuestionOptions	answerOptions	The answer recovery question options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

AuthenticateAsync(AuthenticateOptions, CancellationToken)

Authenticates a user with username/password credentials https://developer.okta.com/docs/api/resources/authn#primary-authentication

Declaration

public Task<IAuthenticationResponse> AuthenticateAsync(AuthenticateOptions authenticateOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
AuthenticateOptions	authenticateOptions	The authentication options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

AuthenticateAsync(AuthenticateWithActivationTokenOptions, CancellationToken)

Authenticates a user with activation token https://developer.okta.com/docs/api/resources/authn#primary-authentication-with-activation-token

Declaration

public Task<IAuthenticationResponse> AuthenticateAsync(AuthenticateWithActivationTokenOptions authenticateOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
AuthenticateWithActivationTokenOptions	authenticateOptions	The authentication options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

CancelTransactionStateAsync(TransactionStateOptions, CancellationToken)

Cancels the current transaction and revokes the state token. https://developer.okta.com/docs/api/resources/authn#cancel-transaction

Declaration

public Task<IAuthenticationResponse> CancelTransactionStateAsync(TransactionStateOptions transactionStateOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
TransactionStateOptions	transactionStateOptions	The transaction state options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

ChangePasswordAsync(ChangePasswordOptions, CancellationToken)

Changes the user password https://developer.okta.com/docs/api/resources/authn#change-password

Declaration

public Task<IAuthenticationResponse> ChangePasswordAsync(ChangePasswordOptions passwordOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
ChangePasswordOptions	passwordOptions	The Change Password options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

EnrollFactorAsync(EnrollCallFactorOptions, CancellationToken)

Enrolls a user with a call factor https://developer.okta.com/docs/api/resources/authn#enroll-okta-call-factor

Declaration

public Task<IAuthenticationResponse> EnrollFactorAsync(EnrollCallFactorOptions factorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
EnrollCallFactorOptions	factorOptions	The enroll call factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

EnrollFactorAsync(EnrollDuoFactorOptions, CancellationToken)

Enrolls a user with a Duo factor https://developer.okta.com/docs/api/resources/authn#enroll-duo-factor

Declaration

public Task<IAuthenticationResponse> EnrollFactorAsync(EnrollDuoFactorOptions factorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
EnrollDuoFactorOptions	factorOptions	The enroll Duo factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

EnrollFactorAsync(EnrollPushFactorOptions, CancellationToken)

Enrolls a user with a push factor https://developer.okta.com/docs/api/resources/authn#enroll-okta-verify-push-factor

Declaration

public Task<IAuthenticationResponse> EnrollFactorAsync(EnrollPushFactorOptions factorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
EnrollPushFactorOptions	factorOptions	The enroll push factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

EnrollFactorAsync(EnrollRsaFactorOptions, CancellationToken)

Enrolls a user with a RSA factor https://developer.okta.com/docs/api/resources/authn#enroll-rsa-securid-factor

Declaration

public Task<IAuthenticationResponse> EnrollFactorAsync(EnrollRsaFactorOptions factorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
EnrollRsaFactorOptions	factorOptions	The enroll RSA factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

EnrollFactorAsync(EnrollSecurityQuestionFactorOptions, CancellationToken)

Enrolls a user with a security question factor https://developer.okta.com/docs/api/resources/authn#enroll-okta-security-question-factor

Declaration

public Task<IAuthenticationResponse> EnrollFactorAsync(EnrollSecurityQuestionFactorOptions factorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
EnrollSecurityQuestionFactorOptions	factorOptions	The enroll security question factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

EnrollFactorAsync(EnrollSmsFactorOptions, CancellationToken)

Enrolls a user with a SMS factor https://developer.okta.com/docs/api/resources/authn#enroll-okta-sms-factor

Declaration

public Task<IAuthenticationResponse> EnrollFactorAsync(EnrollSmsFactorOptions factorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
EnrollSmsFactorOptions	factorOptions	The enroll SMS factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

EnrollFactorAsync(EnrollSymantecFactorOptions, CancellationToken)

Enrolls a user with a Symantec factor https://developer.okta.com/docs/api/resources/authn#enroll-symantec-vip-factor

Declaration

public Task<IAuthenticationResponse> EnrollFactorAsync(EnrollSymantecFactorOptions factorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
EnrollSymantecFactorOptions	factorOptions	The enroll Symantec factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

EnrollFactorAsync(EnrollTotpFactorOptions, CancellationToken)

Enrolls a user with a TOTP factor https://developer.okta.com/docs/api/resources/authn#enroll-okta-verify-totp-factor

Declaration

public Task<IAuthenticationResponse> EnrollFactorAsync(EnrollTotpFactorOptions factorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
EnrollTotpFactorOptions	factorOptions	The enroll TOTP factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

EnrollFactorAsync(EnrollU2FFactorOptions, CancellationToken)

Enrolls a user with a U2F factor https://developer.okta.com/docs/api/resources/authn#enroll-u2f-factor

Declaration

public Task<IAuthenticationResponse> EnrollFactorAsync(EnrollU2FFactorOptions factorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
EnrollU2FFactorOptions	factorOptions	The enroll U2F factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

EnrollFactorAsync(EnrollWebAuthnFactorOptions, CancellationToken)

Enrolls a user with a WebAuthn factor https://developer.okta.com/docs/api/resources/authn/#enroll-webauthn-factor

Declaration

public Task<IAuthenticationResponse> EnrollFactorAsync(EnrollWebAuthnFactorOptions factorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
EnrollWebAuthnFactorOptions	factorOptions	The enroll U2F factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

EnrollFactorAsync(EnrollYubiKeyFactorOptions, CancellationToken)

Enrolls a user with a YubiKey factor https://developer.okta.com/docs/api/resources/authn#enroll-yubikey-factor

Declaration

public Task<IAuthenticationResponse> EnrollFactorAsync(EnrollYubiKeyFactorOptions factorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
EnrollYubiKeyFactorOptions	factorOptions	The enroll YubiKey factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

ForgotPasswordAsync(ForgotPasswordOptions, CancellationToken)

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. https://developer.okta.com/docs/api/resources/authn#forgot-password

Declaration

public Task<IAuthenticationResponse> ForgotPasswordAsync(ForgotPasswordOptions forgotPasswordOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
ForgotPasswordOptions	forgotPasswordOptions	The forgot password options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

GetPreviousTransactionStateAsync(TransactionStateOptions, CancellationToken)

Moves the current transaction state back to the previous state. https://developer.okta.com/docs/api/resources/authn#previous-transaction-state

Declaration

public Task<IAuthenticationResponse> GetPreviousTransactionStateAsync(TransactionStateOptions transactionStateOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
TransactionStateOptions	transactionStateOptions	The transaction state options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

GetTransactionStateAsync(TransactionStateOptions, CancellationToken)

Retrieves the current transaction state for a state token. https://developer.okta.com/docs/api/resources/authn#get-transaction-state

Declaration

public Task<IAuthenticationResponse> GetTransactionStateAsync(TransactionStateOptions transactionStateOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
TransactionStateOptions	transactionStateOptions	The transaction state options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

ResendCallEnrollFactorAsync(EnrollCallFactorOptions, CancellationToken)

Resend a Call challenge. https://developer.okta.com/docs/api/resources/authn#request-example-for-resend-voice-call

Declaration

public Task<IAuthenticationResponse> ResendCallEnrollFactorAsync(EnrollCallFactorOptions factorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
EnrollCallFactorOptions	factorOptions	The enroll call factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

ResendRecoveryChallengeAsync(ResendRecoveryChallengeOptions, CancellationToken)

Resend a recovery challenge for a factor (SMS/Call) https://developer.okta.com/docs/api/resources/authn#resend-sms-recovery-challenge https://developer.okta.com/docs/api/resources/authn#resend-call-recovery-challenge

Declaration

public Task<IAuthenticationResponse> ResendRecoveryChallengeAsync(ResendRecoveryChallengeOptions resendRecoveryChallengeOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
ResendRecoveryChallengeOptions	resendRecoveryChallengeOptions	The resend recovery challenge options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

ResendSmsEnrollFactorAsync(EnrollSmsFactorOptions, CancellationToken)

Resend a SMS challenge. https://developer.okta.com/docs/api/resources/authn#resend-sms-as-part-of-enrollment

Declaration

public Task<IAuthenticationResponse> ResendSmsEnrollFactorAsync(EnrollSmsFactorOptions factorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
EnrollSmsFactorOptions	factorOptions	The enroll SMS factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

ResendVerifyChallengeAsync(ResendChallengeOptions, CancellationToken)

Resend a verify challenge

Declaration

public Task<IAuthenticationResponse> ResendVerifyChallengeAsync(ResendChallengeOptions resendChallengeOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
ResendChallengeOptions	resendChallengeOptions	The resend challenge options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

ResetPasswordAsync(ResetPasswordOptions, CancellationToken)

Resets user password https://developer.okta.com/docs/api/resources/authn#reset-password

Declaration

public Task<IAuthenticationResponse> ResetPasswordAsync(ResetPasswordOptions resetPasswordOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
ResetPasswordOptions	resetPasswordOptions	The reset password options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

SkipTransactionStateAsync(TransactionStateOptions, CancellationToken)

Sends a skip link to skip the current transaction state and advance to the next state. https://developer.okta.com/docs/api/resources/authn#skip-transaction-state

Declaration

public Task<IAuthenticationResponse> SkipTransactionStateAsync(TransactionStateOptions transactionStateOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
TransactionStateOptions	transactionStateOptions	The transaction state options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

UnlockAccountAsync(UnlockAccountOptions, CancellationToken)

Unlocks an account https://developer.okta.com/docs/api/resources/authn#unlock-account

Declaration

public Task<IAuthenticationResponse> UnlockAccountAsync(UnlockAccountOptions unlockAccountOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
UnlockAccountOptions	unlockAccountOptions	The unlock account options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

VerifyFactorAsync(VerifyCallFactorOptions, CancellationToken)

Verifies a call factor https://developer.okta.com/docs/api/resources/authn#verify-call-factor

Declaration

public Task<IAuthenticationResponse> VerifyFactorAsync(VerifyCallFactorOptions verifyCallFactorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
VerifyCallFactorOptions	verifyCallFactorOptions	The verify call factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

VerifyFactorAsync(VerifyDuoFactorOptions, CancellationToken)

Verifies a Duo factor https://developer.okta.com/docs/api/resources/authn#verify-duo-factor

Declaration

public Task<IAuthenticationResponse> VerifyFactorAsync(VerifyDuoFactorOptions verifyDuoFactorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
VerifyDuoFactorOptions	verifyDuoFactorOptions	The verify Duo factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

VerifyFactorAsync(VerifyPushFactorOptions, CancellationToken)

Verifies a push factor https://developer.okta.com/docs/api/resources/authn#verify-push-factor

Declaration

public Task<IAuthenticationResponse> VerifyFactorAsync(VerifyPushFactorOptions verifyPushFactorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
VerifyPushFactorOptions	verifyPushFactorOptions	The verify push factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

VerifyFactorAsync(VerifySecurityQuestionFactorOptions, CancellationToken)

Verifies an answer to a question factor. https://developer.okta.com/docs/api/resources/authn#verify-security-question-factor

Declaration

public Task<IAuthenticationResponse> VerifyFactorAsync(VerifySecurityQuestionFactorOptions verifySecurityQuestionFactorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
VerifySecurityQuestionFactorOptions	verifySecurityQuestionFactorOptions	The verify security question factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

VerifyFactorAsync(VerifySmsFactorOptions, CancellationToken)

Verifies a sms factor. https://developer.okta.com/docs/api/resources/authn#verify-sms-factor

Declaration

public Task<IAuthenticationResponse> VerifyFactorAsync(VerifySmsFactorOptions verifySmsFactorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
VerifySmsFactorOptions	verifySmsFactorOptions	The verify SMS factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

VerifyFactorAsync(VerifyTotpFactorOptions, CancellationToken)

Verifies a TOTP factor https://developer.okta.com/docs/api/resources/authn#verify-totp-factor

Declaration

public Task<IAuthenticationResponse> VerifyFactorAsync(VerifyTotpFactorOptions verifyTotpFactorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
VerifyTotpFactorOptions	verifyTotpFactorOptions	The verify TOTP factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

VerifyFactorAsync(VerifyU2FFactorOptions, CancellationToken)

Verifies a U2F factor https://developer.okta.com/docs/api/resources/authn#verify-u2f-factor

Declaration

public Task<IAuthenticationResponse> VerifyFactorAsync(VerifyU2FFactorOptions verifyU2FFactorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
VerifyU2FFactorOptions	verifyU2FFactorOptions	The verify U2F factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

VerifyFactorAsync(VerifyWebAuthnFactorOptions, CancellationToken)

Verifies Recovery for a factor (WebAuthn). https://developer.okta.com/docs/reference/api/authn/#verify-webauthn-factor

Declaration

public Task<IAuthenticationResponse> VerifyFactorAsync(VerifyWebAuthnFactorOptions verifyWebAuthnFactorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
VerifyWebAuthnFactorOptions	verifyWebAuthnFactorOptions	The verify recovery factor options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

VerifyRecoveryFactorAsync(VerifyRecoveryFactorOptions, CancellationToken)

Verifies Recovery for a factor (SMS/Call). https://developer.okta.com/docs/api/resources/authn#verify-recovery-factor

Declaration

public Task<IAuthenticationResponse> VerifyRecoveryFactorAsync(VerifyRecoveryFactorOptions verifyRecoveryFactorOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
VerifyRecoveryFactorOptions	verifyRecoveryFactorOptions
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

VerifyRecoveryTokenAsync(VerifyRecoveryTokenOptions, CancellationToken)

Validates a recovery token that was distributed to the end user to continue the recovery transaction. https://developer.okta.com/docs/api/resources/authn#verify-recovery-token

Declaration

public Task<IAuthenticationResponse> VerifyRecoveryTokenAsync(VerifyRecoveryTokenOptions verifyRecoveryTokenOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
VerifyRecoveryTokenOptions	verifyRecoveryTokenOptions	The verify recovery token options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAuthenticationResponse>	The IAuthenticationResponse response

Implements

IAuthenticationClient

IOktaClient