Edit

Share via

AuthMethodVerificationRequiredState class

Package:
@azure/msal-browser

State indicating that verification is required for the challenged authentication method.

Extends

AuthMethodRegistrationState<AuthMethodVerificationRequiredStateParameters>

Constructors

AuthMethodVerificationRequiredState(AuthMethodVerificationRequiredStateParameters)

Creates a new instance of AuthFlowActionRequiredStateBase.

Methods

challengeAuthMethod(AuthMethodDetails)

Challenges a different authentication method for registration.
getChannel()

Gets the channel through which the challenge was sent.
getCodeLength()

Gets the length of the expected verification code.
getSentTo()

Gets the target label indicating where the challenge was sent.
submitChallenge(string)

Submits the verification challenge to complete the authentication method registration.

Constructor Details

AuthMethodVerificationRequiredState(AuthMethodVerificationRequiredStateParameters)

Creates a new instance of AuthFlowActionRequiredStateBase.

new AuthMethodVerificationRequiredState(stateParameters: AuthMethodVerificationRequiredStateParameters)

Parameters

stateParameters

AuthMethodVerificationRequiredStateParameters

The parameters for the auth state.

Method Details

challengeAuthMethod(AuthMethodDetails)

Challenges a different authentication method for registration.

function challengeAuthMethod(authMethodDetails: AuthMethodDetails): Promise<AuthMethodRegistrationChallengeMethodResult>

Parameters

authMethodDetails
AuthMethodDetails

The authentication method details to challenge.

Returns

Promise<AuthMethodRegistrationChallengeMethodResult>

Promise that resolves to AuthMethodRegistrationChallengeMethodResult.

getChannel()

Gets the channel through which the challenge was sent.

function getChannel(): string

Returns

string

The challenge channel (e.g., "email").

getCodeLength()

Gets the length of the expected verification code.

function getCodeLength(): number

Returns

number

The code length.

getSentTo()

Gets the target label indicating where the challenge was sent.

function getSentTo(): string

Returns

string

The challenge target label (e.g., masked email address).

submitChallenge(string)

Submits the verification challenge to complete the authentication method registration.

function submitChallenge(code: string): Promise<AuthMethodRegistrationSubmitChallengeResult>

Parameters

code

string

The verification code entered by the user.

Returns

Promise<AuthMethodRegistrationSubmitChallengeResult>

Promise that resolves to AuthMethodRegistrationSubmitChallengeResult.