identity.AuthUserRecord interface

O UserRecord transmitido para autenticação de funções de bloqueio da plataforma de identidade.

Assinatura:

export interface AuthUserRecord

Propriedades

Propriedade Tipo Descrição
customClaims (link em inglês) Record<string, any> 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.
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 AuthUserMetadata Metadados adicionais sobre o usuário.
multifator AuthMultiFactorSettings 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).
passwordSalt (link em inglês) string O sal da senha do usuário (codificado em base64).
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) AuthUserInfo[] 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.
uid string O uid do usuário.

Identity.AuthUserRecord.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.

Assinatura:

customClaims?: Record<string, any>;

Identity.AuthUserRecord.Disabled

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

Assinatura:

disabled: boolean;

Identity.AuthUserRecord.displayName

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

Assinatura:

displayName?: string;

Identity.AuthUserRecord.email

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

Assinatura:

email?: string;

Identity.AuthUserRecord.emailVerified

Indica se o e-mail principal do usuário foi verificado ou não.

Assinatura:

emailVerified: boolean;

Identity.AuthUserRecord.metadata

Metadados adicionais sobre o usuário.

Assinatura:

metadata: AuthUserMetadata;

Identity.AuthUserRecord.multiFactor

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

Assinatura:

multiFactor?: AuthMultiFactorSettings;

Identity.AuthUserRecord.passwordHash

A senha com hash do usuário (codificada em base64).

Assinatura:

passwordHash?: string;

Identity.AuthUserRecord.passwordSalt

O sal da senha do usuário (codificado em base64).

Assinatura:

passwordSalt?: string;

Identity.AuthUserRecord.phoneNumber

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

Assinatura:

phoneNumber?: string;

Identity.AuthUserRecord.photoURL

O URL da foto do usuário.

Assinatura:

photoURL?: string;

Identity.AuthUserRecord.providerData

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

Assinatura:

providerData: AuthUserInfo[];

Identity.AuthUserRecord.tenantId

O ID do locatário a que o usuário pertence, se disponível.

Assinatura:

tenantId?: string | null;

Identity.AuthUserRecord.tokensValidAfterTime

É a data em que os tokens do usuário são válidos, formatados como uma string UTC.

Assinatura:

tokensValidAfterTime?: string;

Identity.AuthUserRecord.uid

O uid do usuário.

Assinatura:

uid: string;