MultiFactorUser interface

Uma interface que define as propriedades e operações relacionadas a vários fatores pertencentes a um User.

Assinatura:

export interface MultiFactorUser 

Propriedades

Propriedade	Tipo	Descrição
enrolledFactors (em inglês)	MultiFactorInfo[]	Retorna uma lista dos segundos fatores registrados do usuário.

Métodos

Método	Descrição
enroll(assertion, displayName)	Registra um segundo fator, conforme identificado por MultiFactorAssertion para o usuário.
getSession(),	Retorna o identificador de sessão de uma operação de registro de segundo fator. Isso é usado para identificar o usuário que está tentando registrar um segundo fator.
unenroll(opção)	Cancela a inscrição do segundo fator especificado.

MultiFactorUser.enrolledFactors

Retorna uma lista dos segundos fatores registrados do usuário.

Assinatura:

readonly enrolledFactors: MultiFactorInfo[];

MultiFactorUser.enroll()

Registra um segundo fator, conforme identificado por MultiFactorAssertion para o usuário.

Na resolução, os tokens de usuário são atualizados para refletir a alteração no payload do JWT. Aceita um parâmetro de nome de exibição adicional usado para identificar o segundo fator para o usuário final. É necessária uma nova autenticação recente para que esta operação tenha êxito. Após o registro, as sessões do Firebase (tokens de atualização) atuais são revogadas. Quando um novo fator é registrado, uma notificação é enviada para o e-mail do usuário.

Assinatura:

enroll(assertion: MultiFactorAssertion, displayName?: string | null): Promise<void>;

Parâmetros

Parâmetro	Tipo	Descrição
declaração	MultiFactorAssertion (link em inglês)	A declaração de vários fatores para registrar.
displayName	string | nulo	O nome de exibição do segundo fator.

Retorna:

Promessa<void>

Exemplo

const multiFactorUser = multiFactor(auth.currentUser);
const multiFactorSession = await multiFactorUser.getSession();

// Send verification code.
const phoneAuthProvider = new PhoneAuthProvider(auth);
const phoneInfoOptions = {
  phoneNumber: phoneNumber,
  session: multiFactorSession
};
const verificationId = await phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, appVerifier);

// Obtain verification code from user.
const phoneAuthCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(phoneAuthCredential);
await multiFactorUser.enroll(multiFactorAssertion);
// Second factor enrolled.

MultiFactorUser.getSession()

Retorna o identificador de sessão de uma operação de registro de segundo fator. Isso é usado para identificar o usuário que está tentando registrar um segundo fator.

Assinatura:

getSession(): Promise<MultiFactorSession>;

Retorna:

Promessa<MultiFactorSession>

A promessa que se resolve com a MultiFactorSession.

Exemplo

const multiFactorUser = multiFactor(auth.currentUser);
const multiFactorSession = await multiFactorUser.getSession();

// Send verification code.
const phoneAuthProvider = new PhoneAuthProvider(auth);
const phoneInfoOptions = {
  phoneNumber: phoneNumber,
  session: multiFactorSession
};
const verificationId = await phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, appVerifier);

// Obtain verification code from user.
const phoneAuthCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(phoneAuthCredential);
await multiFactorUser.enroll(multiFactorAssertion);

MultiFactorUser.unenroll()

Cancela a inscrição do segundo fator especificado.

Para especificar o fator a ser removido, transmita um objeto MultiFactorInfo (recuperado de MultiFactorUser.enrolledFactors) ou a string UID do fator. As sessões não são revogadas quando a inscrição da conta é cancelada. Uma notificação por e-mail provavelmente será enviada ao usuário notificando-o sobre a alteração. É necessária uma nova autenticação recente para que esta operação tenha êxito. Quando a inscrição de um fator existente é cancelada, uma notificação é enviada para o e-mail do usuário.

Assinatura:

unenroll(option: MultiFactorInfo | string): Promise<void>;

Parâmetros

Parâmetro	Tipo	Descrição
option	MultiFactorInfo | corda	A opção de vários fatores para cancelar a inscrição.

Retorna:

Promessa<void>

• Uma Promise que é resolvida quando a operação de cancelamento da inscrição é concluída.

Exemplo

const multiFactorUser = multiFactor(auth.currentUser);
// Present user the option to choose which factor to unenroll.
await multiFactorUser.unenroll(multiFactorUser.enrolledFactors[i])