MfaVerificationRequiredState class

指示需要 MFA 验证的状态。 已发送质询,用户需要提供代码。

扩展

MfaState<MfaVerificationRequiredStateParameters>

构造函数

MfaVerificationRequiredState(MfaVerificationRequiredStateParameters)

创建 AuthFlowActionRequiredStateBase 的新实例。

属性

stateType

状态的类型。

方法

getChannel()

获取发送质询的通道。

getCodeLength()

获取用户需要提供的代码的长度。

getSentTo()

获取指示发送质询的位置的目标标签。

submitChallenge(string)

提交 MFA 质询(例如 OTP 代码)以完成身份验证。

继承的方法

requestChallenge(string)

请求特定身份验证方法的 MFA 质询。

构造函数详细信息

MfaVerificationRequiredState(MfaVerificationRequiredStateParameters)

创建 AuthFlowActionRequiredStateBase 的新实例。

new MfaVerificationRequiredState(stateParameters: MfaVerificationRequiredStateParameters)

参数

stateParameters

MfaVerificationRequiredStateParameters

身份验证状态的参数。

属性详细信息

stateType

状态的类型。

stateType: string

属性值

string

方法详细信息

getChannel()

获取发送质询的通道。

function getChannel(): string

返回

string

挑战频道(例如,“电子邮件”)。

getCodeLength()

获取用户需要提供的代码的长度。

function getCodeLength(): number

返回

number

预期的代码长度。

getSentTo()

获取指示发送质询的位置的目标标签。

function getSentTo(): string

返回

string

质询目标标签(例如掩码电子邮件地址)。

submitChallenge(string)

提交 MFA 质询(例如 OTP 代码)以完成身份验证。

function submitChallenge(challenge: string): Promise<MfaSubmitChallengeResult>

参数

challenge

string

用户输入的挑战代码(例如 OTP 代码)。

返回

解析为 MfaSubmitChallengeResult 的承诺。

继承的方法详细信息

requestChallenge(string)

请求特定身份验证方法的 MFA 质询。

function requestChallenge(authMethodId: string): Promise<MfaRequestChallengeResult>

参数

authMethodId

string

要用于质询的身份验证方法 ID。

返回

解析为 MfaRequestChallengeResult 的承诺。

继承自 MfaState.requestChallenge