UserRecord class

Representa um usuário.

Assinatura:

export declare class UserRecord 

Propriedades

Propriedade	Modificadores	Modelo	Descrição
Reivindicações personalizadas		{ [chave: string]: qualquer; }	O objeto de declarações personalizadas do usuário, se disponível, normalmente usado para definir funções de usuário e propagado para o token de ID de um usuário autenticado. Isso é definido via BaseAuth.setCustomUserClaims()
Desativado		boleano	Se o usuário está desabilitado ou não: true para desabilitado; false para habilitado.
Nome em Exibição		corda	O nome de exibição do usuário.
o email		corda	O e-mail principal do usuário, se definido.
email verificado		boleano	Se o e-mail principal do usuário é verificado ou não.
metadados		UserMetadata	Metadados adicionais sobre o usuário.
multifator		Configurações de vários fatores	As propriedades relacionadas a vários fatores para o usuário atual, se disponíveis.
senhaHash		corda	A senha com hash do usuário (codificada em base64), somente se o algoritmo de hash do Firebase Auth (SCRYPT) for usado. Se um algoritmo de hash diferente tiver sido usado ao carregar esse usuário, como é típico ao migrar de outro sistema de autenticação, essa será uma string vazia. Se nenhuma senha for definida, ela será nula. Isso só está disponível quando o usuário é obtido de BaseAuth.listUsers() .
senhaSal		corda	O salt da senha do usuário (codificado em base64), somente se o algoritmo de hash do Firebase Auth (SCRYPT) for usado. Se um algoritmo de hash diferente tiver sido usado para carregar esse usuário, típico ao migrar de outro sistema de autenticação, essa será uma string vazia. Se nenhuma senha for definida, ela será nula. Isso só está disponível quando o usuário é obtido de BaseAuth.listUsers() .
número de telefone		corda	O número de telefone principal do usuário, se definido.
fotoURL		corda	URL da foto do usuário.
ProviderData		Informação de usuário []	Uma matriz de provedores (por exemplo, Google, Facebook) vinculados ao usuário.
ID do locatário		seqüência | nulo	A ID do locatário ao qual o usuário pertence, se disponível.
tokensValidAfterTime		corda	A data em que os tokens do usuário são válidos, formatada como uma string UTC. Isso é atualizado sempre que o token de atualização do usuário é revogado na API BaseAuth.revokeRefreshTokens() ou no back-end do Firebase Auth em grandes alterações de conta (redefinições de senha, atualizações de senha ou e-mail etc.).
fluido		corda	O uid do usuário.

Métodos

Método	Modificadores	Descrição
toJSON()		Retorna uma representação serializável em JSON deste objeto.

UserRecord.customClaims

O objeto de declarações personalizadas do usuário, se disponível, normalmente usado para definir funções de usuário e propagado para o token de ID de um usuário autenticado. Isso é definido via BaseAuth.setCustomUserClaims()

Assinatura:

readonly customClaims?: {
        [key: string]: any;
    };

UserRecord.disabled

Se o usuário está desabilitado ou não: true para desabilitado; false para habilitado.

Assinatura:

readonly disabled: boolean;

UserRecord.displayName

O nome de exibição do usuário.

Assinatura:

readonly displayName?: string;

UserRecord.email

O e-mail principal do usuário, se definido.

Assinatura:

readonly email?: string;

UserRecord.emailVerified

Se o e-mail principal do usuário é verificado ou não.

Assinatura:

readonly emailVerified: boolean;

UserRecord.metadata

Metadados adicionais sobre o usuário.

Assinatura:

readonly metadata: UserMetadata;

UserRecord.multiFactor

As propriedades relacionadas a vários fatores para o usuário atual, se disponíveis.

Assinatura:

readonly multiFactor?: MultiFactorSettings;

UserRecord.passwordHash

A senha com hash do usuário (codificada em base64), somente se o algoritmo de hash do Firebase Auth (SCRYPT) for usado. Se um algoritmo de hash diferente tiver sido usado ao carregar esse usuário, como é típico ao migrar de outro sistema de autenticação, essa será uma string vazia. Se nenhuma senha for definida, ela será nula. Isso só está disponível quando o usuário é obtido de BaseAuth.listUsers() .

Assinatura:

readonly passwordHash?: string;

UserRecord.passwordSalt

O salt da senha do usuário (codificado em base64), somente se o algoritmo de hash do Firebase Auth (SCRYPT) for usado. Se um algoritmo de hash diferente tiver sido usado para carregar esse usuário, típico ao migrar de outro sistema de autenticação, essa será uma string vazia. Se nenhuma senha for definida, ela será nula. Isso só está disponível quando o usuário é obtido de BaseAuth.listUsers() .

Assinatura:

readonly passwordSalt?: string;

UserRecord.phoneNumber

O número de telefone principal do usuário, se definido.

Assinatura:

readonly phoneNumber?: string;

UserRecord.photoURL

URL da foto do usuário.

Assinatura:

readonly photoURL?: string;

UserRecord.providerData

Uma matriz de provedores (por exemplo, Google, Facebook) vinculados ao usuário.

Assinatura:

readonly providerData: UserInfo[];

UserRecord.tenantId

A ID do locatário ao qual o usuário pertence, se disponível.

Assinatura:

readonly tenantId?: string | null;

UserRecord.tokensValidAfterTime

A data em que os tokens do usuário são válidos, formatada como uma string UTC. Isso é atualizado sempre que o token de atualização do usuário é revogado na API BaseAuth.revokeRefreshTokens() ou no back-end do Firebase Auth em grandes alterações de conta (redefinições de senha, atualizações de senha ou e-mail etc.).

Assinatura:

readonly tokensValidAfterTime?: string;

UserRecord.uid

O uid do usuário .

Assinatura:

readonly uid: string;

UserRecord.toJSON()

Retorna uma representação serializável em JSON deste objeto.

Assinatura:

toJSON(): object;

Devoluções:

objeto

Uma representação serializável em JSON desse objeto.