MfaVerificationRequiredState class
Indique que a verificação MFA é necessária. O desafio foi enviado e o utilizador precisa de fornecer o código.
- Extends
-
MfaState<MfaVerificationRequiredStateParameters>
Construtores
| Mfa |
Cria uma nova instância de AuthFlowActionRequiredStateBase. |
Propriedades
| state |
O tipo de estado. |
Métodos
| get |
Obtém o canal pelo qual o desafio foi enviado. |
| get |
Obtém o comprimento do código que o utilizador precisa de fornecer. |
| get |
Recebe a etiqueta do alvo a indicar para onde o desafio foi enviado. |
| submit |
Submete o desafio MFA (por exemplo, código OTP) para completar a autenticação. |
Métodos Herdados
| request |
Solicita um desafio 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 de Propriedade
stateType
O tipo de estado.
stateType: string
Valor de Propriedade
string
Detalhes de Método
getChannel()
Obtém o canal pelo qual o desafio foi enviado.
function getChannel(): string
Devoluções
string
O canal do desafio (por exemplo, "email").
getCodeLength()
Obtém o comprimento do código que o utilizador precisa de fornecer.
function getCodeLength(): number
Devoluções
number
O comprimento esperado do código.
getSentTo()
Recebe a etiqueta do alvo a indicar para onde o desafio foi enviado.
function getSentTo(): string
Devoluções
string
A etiqueta do alvo do desafio (por exemplo, endereço de email mascarado).
submitChallenge(string)
Submete o desafio MFA (por exemplo, código OTP) para completar a autenticação.
function submitChallenge(challenge: string): Promise<MfaSubmitChallengeResult>
Parâmetros
- challenge
-
string
O código de desafio (por exemplo, código OTP) introduzido pelo utilizador.
Devoluções
Promise<MfaSubmitChallengeResult>
Promessa que se resolve para MfaSubmitChallengeResult.
Detalhes do Método Herdado
requestChallenge(string)
Solicita um desafio MFA para um método de autenticação específico.
function requestChallenge(authMethodId: string): Promise<MfaRequestChallengeResult>
Parâmetros
- authMethodId
-
string
O ID do método de autenticação a usar para o desafio.
Devoluções
Promise<MfaRequestChallengeResult>
Promessa que resolve para MfaRequestChallengeResult.
Herdado de MfaState.requestChallenge