UserRecord class

Representa um usuário.

Assinatura:

export declare class UserRecord

Propriedades

Propriedade Modificadores Tipo Descrição
customClaims (link em inglês) { [chave: string]: qualquer; } O objeto de declarações personalizadas do usuário, se disponível, normalmente usado para definir papéis do usuário e propagado para o token de ID de um usuário autenticado. Isso é definido por meio de BaseAuth.setCustomUserClaims()
desativado booleano Se o usuário está desativado ou não: true para desativado. false para ativado.
displayName string O nome de exibição do usuário.
email string O e-mail principal do usuário, se definido.
emailVerified (em inglês) booleano Indica se o e-mail principal do usuário foi verificado ou não.
metadata UserMetadata (em inglês) Metadados adicionais sobre o usuário.
multifator MultiFactorSettings (em inglês) As propriedades relacionadas a vários fatores para o usuário atual, se disponíveis.
passwordHash. string 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 fazer upload desse usuário, como é comum ao migrar de outro sistema do Auth, essa será uma string vazia. Se nenhuma senha for definida, esse valor será nulo. Só está disponível quando o usuário é recebido de BaseAuth.listUsers().
passwordSalt (link em inglês) string O sal 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 fazer upload desse usuário, o que é comum para migrar de outro sistema do Auth, essa será uma string vazia. Se nenhuma senha for definida, esse valor será nulo. Só está disponível quando o usuário é recebido de BaseAuth.listUsers().
phoneNumber (em inglês) string O número de telefone principal do usuário, se definido.
photoURL string O URL da foto do usuário.
providerData (em inglês) UserInfo[] Uma matriz de provedores (por exemplo, Google, Facebook) vinculados ao usuário.
tenantId (em inglês) string | nulo O ID do locatário a que o usuário pertence, se disponível.
tokensValidAfterTime string É a data em que os tokens do usuário são válidos, formatados como uma string UTC. Ela é atualizada sempre que o token de atualização do usuário é revogado na API BaseAuth.revokeRefreshTokens() ou no back-end do Firebase Auth em mudanças de grandes contas (redefinições de senha, senha ou atualizações de e-mail etc.).
uid string O uid do usuário.

Métodos

Método Modificadores Descrição
toJSON() (link em inglês) Retorna uma representação serializável do JSON desse objeto.

UserRecord.customClaims

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

Assinatura:

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

UserRecord.desativado

Se o usuário está desativado ou não: true para desativado. false para ativado.

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

Indica 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 fazer upload desse usuário, como é comum ao migrar de outro sistema do Auth, essa será uma string vazia. Se nenhuma senha for definida, esse valor será nulo. Só está disponível quando o usuário é recebido de BaseAuth.listUsers().

Assinatura:

readonly passwordHash?: string;

UserRecord.passwordSalt

O sal 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 fazer upload desse usuário, como é comum na migração de outro sistema do Auth, essa será uma string vazia. Se nenhuma senha for definida, esse valor será nulo. Só está disponível quando o usuário é recebido 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 matriz de provedores (por exemplo, Google, Facebook) vinculados ao usuário.

Assinatura:

readonly providerData: UserInfo[];

UserRecord.tenantId

O ID do locatário a que 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, formatados como uma string UTC. Ela é atualizada sempre que o token de atualização do usuário é revogado na API BaseAuth.revokeRefreshTokens() ou no back-end do Firebase Auth em mudanças de grandes contas (redefinições de senha, senha ou atualizações de 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 do JSON desse objeto.

Assinatura:

toJSON(): object;

Retorna:

objeto

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