Interface que representa um usuário para importar para o Firebase Auth pelo método BaseAuth.importUsers().
Assinatura:
export interface UserImportRecord
Propriedades
| Propriedade | 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. |
| 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. |
| 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 | UserMetadataRequest (em inglês) | Metadados adicionais sobre o usuário. |
| multifator | MultiFactorUpdateSettings | As propriedades relacionadas a vários fatores do usuário. |
| passwordHash. | Buffer | O buffer de bytes que representa a senha com hash do usuário. Quando um usuário precisa ser importado com um hash de senha, é necessário especificar UserImportOptions para identificar o algoritmo de hash usado para gerar esse hash. |
| passwordSalt (link em inglês) | Buffer | O buffer de bytes que representa o sal da senha do usuário. |
| 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) | UserProviderRequest[] | Uma matriz de provedores (por exemplo, Google, Facebook) vinculados ao usuário. |
| tenantId (em inglês) | string | O identificador do locatário para onde o usuário será importado. Quando não é fornecido em um contexto admin.auth.Auth, o usuário é enviado para o projeto pai padrão. Quando não é fornecido em um contexto admin.auth.TenantAwareAuth, o usuário é enviado para o locatário correspondente ao ID de locatário dessa instância TenantAwareAuth. |
| uid | string | O uid do usuário. |
UserImportRecord.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?: {
[key: string]: any;
};
UserImportRecord.enabled
Se o usuário está desativado ou não: true para desativado. false para ativado.
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
Indica 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 precisa 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 sal 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 matriz de provedores (por exemplo, Google, Facebook) vinculados ao usuário.
Assinatura:
providerData?: UserProviderRequest[];
UserImportRecord.tenantId
O identificador do locatário para onde o usuário será importado. Quando não é fornecido em um contexto admin.auth.Auth, o usuário é enviado para o projeto pai padrão. Quando não é fornecido em um contexto admin.auth.TenantAwareAuth, o usuário é enviado para o locatário correspondente ao ID de locatário dessa instância TenantAwareAuth.
Assinatura:
tenantId?: string;
UserImportRecord.uid
O uid do usuário.
Assinatura:
uid: string;