MfaVerificationRequiredState class

Stan wskazujący, że wymagana jest weryfikacja uwierzytelniania wieloskładnikowego. Zadanie zostało wysłane i użytkownik musi podać kod.

Rozszerzenie

MfaState<MfaVerificationRequiredStateParameters>

Konstruktory

MfaVerificationRequiredState(MfaVerificationRequiredStateParameters)

Tworzy nowe wystąpienie AuthFlowActionRequiredStateBase.

Właściwości

stateType

Typ stanu.

Metody

getChannel()

Pobiera kanał, za pośrednictwem którego wysłano wyzwanie.

getCodeLength()

Pobiera długość kodu, który użytkownik musi podać.

getSentTo()

Pobiera etykietę docelową wskazującą miejsce wysłania wyzwania.

submitChallenge(string)

Przesyła żądanie uwierzytelniania wieloskładnikowego (np. kod OTP), aby ukończyć uwierzytelnianie.

Metody dziedziczone

requestChallenge(string)

Żąda żądania żądania uwierzytelniania wieloskładnikowego dla określonej metody uwierzytelniania.

Szczegóły konstruktora

MfaVerificationRequiredState(MfaVerificationRequiredStateParameters)

Tworzy nowe wystąpienie AuthFlowActionRequiredStateBase.

new MfaVerificationRequiredState(stateParameters: MfaVerificationRequiredStateParameters)

Parametry

stateParameters

MfaVerificationRequiredStateParameters

Parametry stanu uwierzytelniania.

Szczegóły właściwości

stateType

Typ stanu.

stateType: string

Wartość właściwości

string

Szczegóły metody

getChannel()

Pobiera kanał, za pośrednictwem którego wysłano wyzwanie.

function getChannel(): string

Zwraca

string

Kanał wyzwania (np. "e-mail").

getCodeLength()

Pobiera długość kodu, który użytkownik musi podać.

function getCodeLength(): number

Zwraca

number

Oczekiwana długość kodu.

getSentTo()

Pobiera etykietę docelową wskazującą miejsce wysłania wyzwania.

function getSentTo(): string

Zwraca

string

Etykieta docelowa wyzwania (np. zamaskowany adres e-mail).

submitChallenge(string)

Przesyła żądanie uwierzytelniania wieloskładnikowego (np. kod OTP), aby ukończyć uwierzytelnianie.

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

Parametry

challenge

string

Kod wyzwania (np. kod OTP) wprowadzony przez użytkownika.

Zwraca

Obietnica, która rozwiązuje się z MfaSubmitChallengeResult.

Szczegóły metody dziedziczonej

requestChallenge(string)

Żąda żądania żądania uwierzytelniania wieloskładnikowego dla określonej metody uwierzytelniania.

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

Parametry

authMethodId

string

Identyfikator metody uwierzytelniania, który ma być używany w ramach wyzwania.

Zwraca

Obietnica, która rozwiązuje się z MfaRequestChallengeResult.

Dziedziczone z MfaState.requestChallenge