SignInCodeRequiredState class

Package:

@azure/msal-browser

Base class for the action requried state in an authentication flow.

Extends

SignInState<SignInCodeRequiredStateParameters>

Constructors

SignInCodeRequiredState(SignInCodeRequiredStateParameters)

Methods

getCodeLength()	Gets the sent code length.
getScopes()	Gets the scopes to request.
resendCode()	Resends the another one-time passcode for sign-in flow if the previous one hasn't been verified.
submitCode(string)	Once user configures email one-time passcode as a authentication method in Microsoft Entra, a one-time passcode will be sent to the user’s email. Submit this one-time passcode to continue sign-in flow.

Constructor Details

SignInCodeRequiredState(SignInCodeRequiredStateParameters)

new SignInCodeRequiredState(stateParameters: SignInCodeRequiredStateParameters)

Parameters

stateParameters

SignInCodeRequiredStateParameters

Method Details

getCodeLength()

Gets the sent code length.

function getCodeLength(): number

Returns

number

The length of the code.

getScopes()

Gets the scopes to request.

function getScopes(): undefined | string[]

Returns

undefined | string[]

The scopes to request.

resendCode()

Resends the another one-time passcode for sign-in flow if the previous one hasn't been verified.

function resendCode(): Promise<SignInResendCodeResult>

Returns

Promise<SignInResendCodeResult>

The result of the operation.

submitCode(string)

Once user configures email one-time passcode as a authentication method in Microsoft Entra, a one-time passcode will be sent to the user’s email. Submit this one-time passcode to continue sign-in flow.

function submitCode(code: string): Promise<SignInSubmitCodeResult>

Parameters

code

string

The code to submit.

Returns

Promise<SignInSubmitCodeResult>

The result of the operation.