MfaVerificationRequiredState class
Estado que indica que se requiere la comprobación de MFA. Se ha enviado el desafío y el usuario debe proporcionar el código.
- Extends
-
MfaState<MfaVerificationRequiredStateParameters>
Constructores
| Mfa |
Crea una nueva instancia de AuthFlowActionRequiredStateBase. |
Propiedades
| state |
Tipo del estado. |
Métodos
| get |
Obtiene el canal a través del cual se envió el desafío. |
| get |
Obtiene la longitud del código que el usuario necesita proporcionar. |
| get |
Obtiene la etiqueta de destino que indica dónde se envió el desafío. |
| submit |
Envía el desafío de MFA (por ejemplo, código OTP) para completar la autenticación. |
Métodos heredados
| request |
Solicita un desafío de MFA para un método de autenticación específico. |
Detalles del constructor
MfaVerificationRequiredState(MfaVerificationRequiredStateParameters)
Crea una nueva instancia de AuthFlowActionRequiredStateBase.
new MfaVerificationRequiredState(stateParameters: MfaVerificationRequiredStateParameters)
Parámetros
- stateParameters
-
MfaVerificationRequiredStateParameters
Parámetros para el estado de autenticación.
Detalles de las propiedades
stateType
Tipo del estado.
stateType: string
Valor de propiedad
string
Detalles del método
getChannel()
Obtiene el canal a través del cual se envió el desafío.
function getChannel(): string
Devoluciones
string
El canal de desafío (por ejemplo, "correo electrónico").
getCodeLength()
Obtiene la longitud del código que el usuario necesita proporcionar.
function getCodeLength(): number
Devoluciones
number
Longitud esperada del código.
getSentTo()
Obtiene la etiqueta de destino que indica dónde se envió el desafío.
function getSentTo(): string
Devoluciones
string
Etiqueta de destino de desafío (por ejemplo, dirección de correo electrónico enmascarada).
submitChallenge(string)
Envía el desafío de MFA (por ejemplo, código OTP) para completar la autenticación.
function submitChallenge(challenge: string): Promise<MfaSubmitChallengeResult>
Parámetros
- challenge
-
string
El código de desafío (por ejemplo, código OTP) escrito por el usuario.
Devoluciones
Promise<MfaSubmitChallengeResult>
Promesa que se resuelve en MfaSubmitChallengeResult.
Detalles de los métodos heredados
requestChallenge(string)
Solicita un desafío de MFA para un método de autenticación específico.
function requestChallenge(authMethodId: string): Promise<MfaRequestChallengeResult>
Parámetros
- authMethodId
-
string
Identificador del método de autenticación que se va a usar para el desafío.
Devoluciones
Promise<MfaRequestChallengeResult>
Promesa que se resuelve en MfaRequestChallengeResult.
Heredado de MfaState.requestChallenge