identity.AuthUserRecord interface

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

Assinatura:

export interface AuthUserRecord 

Propriedades

Propriedade Tipo Descrição
reivindicações personalizadas Registro<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.
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 AuthUserMetadata Metadados adicionais sobre o usuário.
multifator Configurações AuthMultiFactor 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).
senhaSalt corda A senha salt do usuário (codificada em base64).
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 AuthUserInfo[] 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.
UID corda O uid do usuário.

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

Assinatura:

customClaims?: Record<string, any>;

identidade.AuthUserRecord.disabled

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

Assinatura:

disabled: boolean;

identidade.AuthUserRecord.displayName

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

Assinatura:

displayName?: string;

identidade.AuthUserRecord.email

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

Assinatura:

email?: string;

identidade.AuthUserRecord.emailVerified

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

Assinatura:

emailVerified: boolean;

identidade.AuthUserRecord.metadata

Metadados adicionais sobre o usuário.

Assinatura:

metadata: AuthUserMetadata;

identidade.AuthUserRecord.multiFactor

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

Assinatura:

multiFactor?: AuthMultiFactorSettings;

identidade.AuthUserRecord.passwordHash

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

Assinatura:

passwordHash?: string;

identidade.AuthUserRecord.passwordSalt

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

Assinatura:

passwordSalt?: string;

identidade.AuthUserRecord.phoneNumber

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

Assinatura:

phoneNumber?: string;

identidade.AuthUserRecord.photoURL

O URL da foto do usuário.

Assinatura:

photoURL?: string;

identidade.AuthUserRecord.providerData

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

Assinatura:

providerData: AuthUserInfo[];

identidade.AuthUserRecord.tenantId

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

Assinatura:

tenantId?: string | null;

identidade.AuthUserRecord.tokensValidAfterTime

A data a partir da qual os tokens do usuário são válidos, formatada como uma string UTC.

Assinatura:

tokensValidAfterTime?: string;

identidade.AuthUserRecord.uid

O uid do usuário .

Assinatura:

uid: string;