MfaVerificationRequiredState class
Estado que indica que a verificação de MFA é necessária. O desafio foi enviado e o usuário precisa fornecer o código.
- Extends
-
MfaState<MfaVerificationRequiredStateParameters>
Construtores
| Mfa |
Cria uma nova instância de AuthFlowActionRequiredStateBase. |
Propriedades
| state |
O tipo do estado. |
Métodos
| get |
Obtém o canal pelo qual o desafio foi enviado. |
| get |
Obtém o comprimento do código que o usuário precisa fornecer. |
| get |
Obtém o rótulo de destino que indica para onde o desafio foi enviado. |
| submit |
Envia o desafio de MFA (por exemplo, código OTP) para concluir a autenticação. |
Métodos herdados
| request |
Solicita um desafio de MFA para um método de autenticação específico. |
Detalhes do construtor
MfaVerificationRequiredState(MfaVerificationRequiredStateParameters)
Cria uma nova instância de AuthFlowActionRequiredStateBase.
new MfaVerificationRequiredState(stateParameters: MfaVerificationRequiredStateParameters)
Parâmetros
- stateParameters
-
MfaVerificationRequiredStateParameters
Os parâmetros para o estado de autenticação.
Detalhes da propriedade
stateType
O tipo do estado.
stateType: string
Valor da propriedade
string
Detalhes do método
getChannel()
Obtém o canal pelo qual o desafio foi enviado.
function getChannel(): string
Retornos
string
O canal de desafio (por exemplo, "email").
getCodeLength()
Obtém o comprimento do código que o usuário precisa fornecer.
function getCodeLength(): number
Retornos
number
O comprimento de código esperado.
getSentTo()
Obtém o rótulo de destino que indica para onde o desafio foi enviado.
function getSentTo(): string
Retornos
string
O rótulo de destino do desafio (por exemplo, endereço de email mascarado).
submitChallenge(string)
Envia o desafio de MFA (por exemplo, código OTP) para concluir a autenticação.
function submitChallenge(challenge: string): Promise<MfaSubmitChallengeResult>
Parâmetros
- challenge
-
string
O código de desafio (por exemplo, código OTP) inserido pelo usuário.
Retornos
Promise<MfaSubmitChallengeResult>
Promessa que resolve para MfaSubmitChallengeResult.
Detalhes do método herdado
requestChallenge(string)
Solicita um desafio de MFA para um método de autenticação específico.
function requestChallenge(authMethodId: string): Promise<MfaRequestChallengeResult>
Parâmetros
- authMethodId
-
string
A ID do método de autenticação a ser usada para o desafio.
Retornos
Promise<MfaRequestChallengeResult>
Promessa que resolve para MfaRequestChallengeResult.
Herdado de MfaState.requestChallenge