MfaVerificationRequiredState class
Status yang menunjukkan bahwa verifikasi MFA diperlukan. Tantangan telah dikirim dan pengguna perlu memberikan kode.
- Memperluas
-
MfaState<MfaVerificationRequiredStateParameters>
Konstruktor
| Mfa |
Membuat instans baru AuthFlowActionRequiredStateBase. |
Properti
| state |
Jenis status. |
Metode
| get |
Mendapatkan saluran tempat tantangan dikirim. |
| get |
Mendapatkan panjang kode yang perlu disediakan pengguna. |
| get |
Mendapatkan label target yang menunjukkan di mana tantangan dikirim. |
| submit |
Mengirimkan tantangan MFA (misalnya, kode OTP) untuk menyelesaikan autentikasi. |
Metode yang Diwarisi
| request |
Meminta tantangan MFA untuk metode autentikasi tertentu. |
Detail Konstruktor
MfaVerificationRequiredState(MfaVerificationRequiredStateParameters)
Membuat instans baru AuthFlowActionRequiredStateBase.
new MfaVerificationRequiredState(stateParameters: MfaVerificationRequiredStateParameters)
Parameter
- stateParameters
-
MfaVerificationRequiredStateParameters
Parameter untuk status autentikasi.
Detail Properti
stateType
Jenis status.
stateType: string
Nilai Properti
string
Detail Metode
getChannel()
Mendapatkan saluran tempat tantangan dikirim.
function getChannel(): string
Mengembalikan
string
Saluran tantangan (misalnya, "email").
getCodeLength()
Mendapatkan panjang kode yang perlu disediakan pengguna.
function getCodeLength(): number
Mengembalikan
number
Panjang kode yang diharapkan.
getSentTo()
Mendapatkan label target yang menunjukkan di mana tantangan dikirim.
function getSentTo(): string
Mengembalikan
string
Label target tantangan (misalnya, alamat email bertopeng).
submitChallenge(string)
Mengirimkan tantangan MFA (misalnya, kode OTP) untuk menyelesaikan autentikasi.
function submitChallenge(challenge: string): Promise<MfaSubmitChallengeResult>
Parameter
- challenge
-
string
Kode tantangan (misalnya, kode OTP) yang dimasukkan oleh pengguna.
Mengembalikan
Promise<MfaSubmitChallengeResult>
Janji yang diselesaikan ke MfaSubmitChallengeResult.
Detail Metode yang Diwarisi
requestChallenge(string)
Meminta tantangan MFA untuk metode autentikasi tertentu.
function requestChallenge(authMethodId: string): Promise<MfaRequestChallengeResult>
Parameter
- authMethodId
-
string
ID metode autentikasi yang digunakan untuk tantangan.
Mengembalikan
Promise<MfaRequestChallengeResult>
Janji yang diselesaikan ke MfaRequestChallengeResult.
Diwariskan Dari MfaState.requestChallenge