MfaVerificationRequiredState class
État indiquant que la vérification MFA est requise. Le défi a été envoyé et l’utilisateur doit fournir le code.
- Extends
-
MfaState<MfaVerificationRequiredStateParameters>
Constructeurs
| Mfa |
Crée une instance d’AuthFlowActionRequiredStateBase. |
Propriétés
| state |
Type de l’état. |
Méthodes
| get |
Obtient le canal par lequel le défi a été envoyé. |
| get |
Obtient la longueur du code que l’utilisateur doit fournir. |
| get |
Obtient l’étiquette cible indiquant où le défi a été envoyé. |
| submit |
Soumet le défi MFA (par exemple, le code OTP) pour terminer l’authentification. |
Méthodes héritées
| request |
Demande un défi MFA pour une méthode d’authentification spécifique. |
Détails du constructeur
MfaVerificationRequiredState(MfaVerificationRequiredStateParameters)
Crée une instance d’AuthFlowActionRequiredStateBase.
new MfaVerificationRequiredState(stateParameters: MfaVerificationRequiredStateParameters)
Paramètres
- stateParameters
-
MfaVerificationRequiredStateParameters
Paramètres de l’état d’authentification.
Détails de la propriété
stateType
Type de l’état.
stateType: string
Valeur de propriété
string
Détails de la méthode
getChannel()
Obtient le canal par lequel le défi a été envoyé.
function getChannel(): string
Retours
string
Canal de défi (par exemple, « e-mail »).
getCodeLength()
Obtient la longueur du code que l’utilisateur doit fournir.
function getCodeLength(): number
Retours
number
Longueur de code attendue.
getSentTo()
Obtient l’étiquette cible indiquant où le défi a été envoyé.
function getSentTo(): string
Retours
string
Étiquette cible du défi (par exemple, adresse e-mail masquée).
submitChallenge(string)
Soumet le défi MFA (par exemple, le code OTP) pour terminer l’authentification.
function submitChallenge(challenge: string): Promise<MfaSubmitChallengeResult>
Paramètres
- challenge
-
string
Code de défi (par exemple, code OTP) entré par l’utilisateur.
Retours
Promise<MfaSubmitChallengeResult>
Promesse qui se résout à MfaSubmitChallengeResult.
Détails de la méthode héritée
requestChallenge(string)
Demande un défi MFA pour une méthode d’authentification spécifique.
function requestChallenge(authMethodId: string): Promise<MfaRequestChallengeResult>
Paramètres
- authMethodId
-
string
ID de méthode d’authentification à utiliser pour le défi.
Retours
Promise<MfaRequestChallengeResult>
Promesse qui se résout à MfaRequestChallengeResult.
Hérité de MfaState.requestChallenge