Interface que representa um usuário para importar para o Firebase Auth por meio do método BaseAuth.importUsers() .
Assinatura:
export interface UserImportRecord
Propriedades
Propriedade | Modelo | Descrição |
---|---|---|
Reivindicações personalizadas | { [chave: string]: qualquer; } | O objeto de declarações personalizadas do usuário, se disponível, normalmente usado para definir funções de usuário e propagado para o token de ID de um usuário autenticado. |
Desativado | boleano | Se o usuário está desabilitado ou não: true para desabilitado; false para habilitado. |
Nome em Exibição | corda | O nome de exibição do usuário. |
o email | corda | O e-mail principal do usuário, se definido. |
email verificado | boleano | Se o e-mail principal do usuário é verificado ou não. |
metadados | Solicitação de metadados do usuário | Metadados adicionais sobre o usuário. |
multifator | Configurações de atualização do multifator | 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, é necessário especificar UserImportOptions para identificar o algoritmo de hash usado para gerar esse hash. |
senhaSal | 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 | URL da foto do usuário. |
ProviderData | Solicitação de provedor de usuário [] | Uma matriz de provedores (por exemplo, Google, Facebook) vinculados ao usuário. |
ID do locatário | corda | O identificador do locatário para o qual o usuário deve 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 para o locatário correspondente à ID do locatário dessa instância de TenantAwareAuth . |
fluido | corda | O uid do usuário. |
UserImportRecord.customClaims
O objeto de declarações personalizadas do usuário, se disponível, normalmente usado para definir funções de usuário e propagado para o token de ID de um 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.emailVerified
Se o e-mail principal do usuário é 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, é necessário especificar UserImportOptions 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
URL da foto do usuário.
Assinatura:
photoURL?: string;
UserImportRecord.providerData
Uma matriz 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 deve 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 para o locatário correspondente à ID do locatário dessa instância de TenantAwareAuth
.
Assinatura:
tenantId?: string;
UserImportRecord.uid
O uid
do usuário .
Assinatura:
uid: string;