表示透過BaseAuth.importUsers()方法匯入 Firebase Auth 的使用者的介面。
簽名:
export interface UserImportRecord
特性
財產 | 類型 | 描述 |
---|---|---|
客製化索賠 | { [鍵:字串]:任意; } | 使用者的自訂聲明物件(如果可用)通常用於定義使用者角色並傳播到經過驗證的使用者的 ID 令牌。 |
殘障人士 | 布林值 | 使用者是否停用: true 為停用; false 表示已啟用。 |
顯示名稱 | 細繩 | 使用者的顯示名稱。 |
電子郵件 | 細繩 | 用戶的主要電子郵件(如果已設定)。 |
電子郵件已驗證 | 布林值 | 用戶的主要電子郵件是否經過驗證。 |
元數據 | 用戶元資料請求 | 有關用戶的其他元資料。 |
多因素 | 多因素更新設置 | 使用者的多因素相關屬性。 |
密碼雜湊值 | 緩衝 | 表示用戶雜湊密碼的位元組緩衝區。當要使用密碼雜湊匯入使用者時,需要指定UserImportOptions來識別用於產生此雜湊的雜湊演算法。 |
密碼鹽 | 緩衝 | 表示使用者密碼鹽的位元組緩衝區。 |
電話號碼 | 細繩 | 用戶的主要電話號碼(如果已設定)。 |
照片網址 | 細繩 | 使用者的照片 URL。 |
提供者數據 | 用戶提供者請求[] | 連結到用戶的一系列提供者(例如 Google、Facebook)。 |
租戶ID | 細繩 | 若要將使用者匯入的租戶的識別碼。如果未在admin.auth.Auth 上下文中提供,則使用者將上傳到預設父項目。如果未在admin.auth.TenantAwareAuth 上下文中提供,則使用者將上傳至與該TenantAwareAuth 實例的租用戶 ID 對應的租用戶。 |
uid | 細繩 | 用戶的uid 。 |
UserImportRecord.customClaims
使用者的自訂聲明物件(如果可用)通常用於定義使用者角色並傳播到經過驗證的使用者的 ID 令牌。
簽名:
customClaims?: {
[key: string]: any;
};
UserImportRecord.disabled
使用者是否停用: true
為停用; false
表示已啟用。
簽名:
disabled?: boolean;
使用者匯入記錄.顯示名稱
使用者的顯示名稱。
簽名:
displayName?: string;
使用者匯入記錄.email
用戶的主要電子郵件(如果已設定)。
簽名:
email?: string;
使用者匯入記錄.emailVerified
用戶的主要電子郵件是否經過驗證。
簽名:
emailVerified?: boolean;
用戶導入記錄.元數據
有關用戶的其他元資料。
簽名:
metadata?: UserMetadataRequest;
用戶導入記錄.multiFactor
使用者的多因素相關屬性。
簽名:
multiFactor?: MultiFactorUpdateSettings;
使用者導入記錄.passwordHash
表示用戶雜湊密碼的位元組緩衝區。當要使用密碼雜湊匯入使用者時,需要指定UserImportOptions來識別用於產生此雜湊的雜湊演算法。
簽名:
passwordHash?: Buffer;
UserImportRecord.passwordSalt
表示使用者密碼鹽的位元組緩衝區。
簽名:
passwordSalt?: Buffer;
用戶導入記錄.電話號碼
用戶的主要電話號碼(如果已設定)。
簽名:
phoneNumber?: string;
使用者導入記錄.photoURL
使用者的照片 URL。
簽名:
photoURL?: string;
使用者導入記錄.providerData
連結到用戶的一系列提供者(例如 Google、Facebook)。
簽名:
providerData?: UserProviderRequest[];
使用者導入記錄.tenantId
若要將使用者匯入的租戶的識別碼。如果未在admin.auth.Auth
上下文中提供,則使用者將上傳到預設父項目。如果未在admin.auth.TenantAwareAuth
上下文中提供,則使用者將上傳至與該TenantAwareAuth
實例的租用戶 ID 對應的租用戶。
簽名:
tenantId?: string;
使用者導入記錄.uid
用戶的uid
。
簽名:
uid: string;