UserRecord class

Representa um usuário.

Assinatura:

export declare class UserRecord

Propriedades

Propriedade Modificadores Tipo Descrição
reivindicações personalizadas { [chave: string]: qualquer; } O objeto de declarações personalizado do usuário, se disponível, normalmente usado para definir funções de usuário e propagado para um token de ID de usuário autenticado. Isso é definido por meio de BaseAuth.setCustomUserClaims()
desabilitado boleano Se o usuário está desabilitado ou não: true para desabilitado; false para habilitado.
nome de exibição corda O nome de exibição do usuário.
e-mail corda O e-mail principal do usuário, se definido.
email verificado boleano Se o e-mail principal do usuário foi verificado ou não.
metadados UserMetadados Metadados adicionais sobre o usuário.
multifator Configurações MultiFactor 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 este usuário, como é típico ao migrar de outro sistema Auth, esta será uma string vazia. Se nenhuma senha for definida, será nulo. Isto só está disponível quando o usuário é obtido de BaseAuth.listUsers() .
senhaSalt corda A senha salt do usuário (codificada em base64), somente se o algoritmo de hashing Firebase Auth (SCRYPT) for usado. Se um algoritmo de hash diferente tiver sido usado para fazer upload deste usuário, normalmente ao migrar de outro sistema Auth, esta será uma string vazia. Se nenhuma senha for definida, será nulo. Isto 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 O URL da foto do usuário.
provedorData Informação de usuário [] Uma série de provedores (por exemplo, Google, Facebook) vinculados ao usuário.
inquilinoId corda | nulo O ID do locatário ao qual o usuário pertence, se disponível.
tokensValidAfterTime corda A data a partir da qual 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 da API BaseAuth.revokeRefreshTokens() ou do back-end do Firebase Auth em grandes alterações na conta (redefinições de senha, atualizações de senha ou e-mail, etc.).
UID corda O uid do usuário.

Métodos

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

UserRecord.customClaims

O objeto de declarações personalizado do usuário, se disponível, normalmente usado para definir funções de usuário e propagado para um token de ID de usuário autenticado. Isso é definido por meio de 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.e-mail

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

Assinatura:

readonly email?: string;

UserRecord.emailVerificado

Se o e-mail principal do usuário foi 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 este usuário, como é típico ao migrar de outro sistema Auth, esta será uma string vazia. Se nenhuma senha for definida, será nulo. Isto só está disponível quando o usuário é obtido de BaseAuth.listUsers() .

Assinatura:

readonly passwordHash?: string;

UserRecord.passwordSalt

A senha salt do usuário (codificada em base64), somente se o algoritmo de hashing Firebase Auth (SCRYPT) for usado. Se um algoritmo de hash diferente tiver sido usado para fazer upload deste usuário, normalmente ao migrar de outro sistema Auth, esta será uma string vazia. Se nenhuma senha for definida, será nulo. Isto 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

O URL da foto do usuário.

Assinatura:

readonly photoURL?: string;

UserRecord.providerData

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

Assinatura:

readonly providerData: UserInfo[];

UserRecord.tenantId

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

Assinatura:

readonly tenantId?: string | null;

UserRecord.tokensValidAfterTime

A data a partir da qual 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 da API BaseAuth.revokeRefreshTokens() ou do back-end do Firebase Auth em grandes alterações na 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 JSON deste objeto.

Assinatura:

toJSON(): object;

Retorna:

objeto

Uma representação serializável JSON deste objeto.