MfaVerificationRequiredState class
Состояние, указывающее, что требуется проверка MFA. Задача была отправлена, и пользователю необходимо предоставить код.
- Extends
-
MfaState<MfaVerificationRequiredStateParameters>
Конструкторы
| Mfa |
Создает новый экземпляр AuthFlowActionRequiredStateBase. |
Свойства
| state |
Тип состояния. |
Методы
| get |
Получает канал, через который был отправлен вызов. |
| get |
Возвращает длину кода, который должен предоставить пользователь. |
| get |
Возвращает целевую метку, указывающую, где была отправлена задача. |
| submit |
Отправляет вызов MFA (например, код OTP), чтобы завершить проверку подлинности. |
Наследуемые методы
| request |
Запрашивает вызов 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), введенный пользователем.
Возвращаемое значение
Promise<MfaSubmitChallengeResult>
Обещание, разрешающее MfaSubmitChallengeResult.
Сведения о наследуемом методе
requestChallenge(string)
Запрашивает вызов MFA для определенного метода проверки подлинности.
function requestChallenge(authMethodId: string): Promise<MfaRequestChallengeResult>
Параметры
- authMethodId
-
string
Идентификатор метода проверки подлинности, используемый для задачи.
Возвращаемое значение
Promise<MfaRequestChallengeResult>
Обещание, разрешающее MfaRequestChallengeResult.
Наследуется от MfaState.requestChallenge