UserImportRecord interface

Interface que representa um usuário a ser importado para o Firebase Auth por meio do método BaseAuth.importUsers() .

Assinatura:

export interface UserImportRecord

Propriedades

Propriedade 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.
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 UserMetadataRequest Metadados adicionais sobre o usuário.
multifator Configurações de atualização do MultiFactor As propriedades relacionadas a vários fatores do usuário.
senhaHash Amortecedor O buffer de bytes que representa a senha com hash do usuário. Quando um usuário deve ser importado com um hash de senha, UserImportOptions deve ser especificado para identificar o algoritmo de hash usado para gerar esse hash.
senhaSalt Amortecedor O buffer de bytes que representa o salt da senha do usuário.
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 UserProviderRequest [] Uma série de provedores (por exemplo, Google, Facebook) vinculados ao usuário.
inquilinoId corda O identificador do locatário para o qual o usuário será importado. Quando não fornecido em um contexto admin.auth.Auth , o usuário é carregado no projeto pai padrão. Quando não fornecido em um contexto admin.auth.TenantAwareAuth , o usuário é carregado no locatário correspondente ao ID do locatário dessa instância TenantAwareAuth .
UID corda O uid do usuário.

UserImportRecord.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?: {
        [key: string]: any;
    };

UserImportRecord.disabled

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

Assinatura:

disabled?: boolean;

UserImportRecord.displayName

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

Assinatura:

displayName?: string;

UserImportRecord.email

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

Assinatura:

email?: string;

UserImportRecord.emailVerificado

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

Assinatura:

emailVerified?: boolean;

UserImportRecord.metadata

Metadados adicionais sobre o usuário.

Assinatura:

metadata?: UserMetadataRequest;

UserImportRecord.multiFactor

As propriedades relacionadas a vários fatores do usuário.

Assinatura:

multiFactor?: MultiFactorUpdateSettings;

UserImportRecord.passwordHash

O buffer de bytes que representa a senha com hash do usuário. Quando um usuário deve ser importado com um hash de senha, UserImportOptions deve ser especificado para identificar o algoritmo de hash usado para gerar esse hash.

Assinatura:

passwordHash?: Buffer;

UserImportRecord.passwordSalt

O buffer de bytes que representa o salt da senha do usuário.

Assinatura:

passwordSalt?: Buffer;

UserImportRecord.phoneNumber

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

Assinatura:

phoneNumber?: string;

UserImportRecord.photoURL

O URL da foto do usuário.

Assinatura:

photoURL?: string;

UserImportRecord.providerData

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

Assinatura:

providerData?: UserProviderRequest[];

UserImportRecord.tenantId

O identificador do locatário para o qual o usuário será importado. Quando não fornecido em um contexto admin.auth.Auth , o usuário é carregado no projeto pai padrão. Quando não fornecido em um contexto admin.auth.TenantAwareAuth , o usuário é carregado no locatário correspondente ao ID do locatário dessa instância TenantAwareAuth .

Assinatura:

tenantId?: string;

UserImportRecord.uid

O uid do usuário .

Assinatura:

uid: string;