這個介面代表要透過 BaseAuth.importUsers() 方法匯入 Firebase 驗證的使用者。
簽名:
export interface UserImportRecord
屬性
屬性 | 類型 | 說明 |
---|---|---|
customClaims | { [key: string]: any;} | 使用者的自訂憑證附加資訊物件 (如有),通常用於定義使用者角色,並套用至已驗證使用者的 ID 權杖。 |
已停用 | 布林值 | 使用者是否停用:true 代表已停用;false 已啟用。 |
「displayName」 | 字串 | 使用者的顯示名稱。 |
字串 | 使用者的主要電子郵件地址 (如有設定)。 | |
電子郵件已驗證 | 布林值 | 使用者的主要電子郵件地址是否已通過驗證。 |
中繼資料 | 使用者中繼資料要求 | 使用者的其他中繼資料。 |
乘法 | MultiFactorUpdateSettings | 使用者的多重要素相關屬性。 |
passwordHash | Buffer | 代表使用者雜湊密碼的位元組緩衝區。當使用者要使用密碼雜湊匯入時,必須指定 UserImportOptions,以識別用於產生此雜湊的雜湊演算法。 |
passwordSalt | Buffer | 代表使用者密碼鹽的位元組緩衝區。 |
電話號碼 | 字串 | 使用者的主要電話號碼 (如有設定)。 |
photoURL | 字串 | 使用者的相片網址。 |
providerData | UserProviderRequest[] | 連結至使用者的提供者陣列 (例如 Google、Facebook)。 |
用戶群 ID | 字串 | 要匯入使用者的目標用戶群 ID。如果 admin.auth.Auth 結構定義中沒有提供資源,系統會將使用者上傳至預設的父項專案。如果 admin.auth.TenantAwareAuth 結構定義中沒有提供資源,系統會將使用者上傳至與該 TenantAwareAuth 執行個體用戶群 ID 相對應的用戶群。 |
uid | 字串 | 使用者的 uid 。 |
使用者匯入記錄.customClaims
使用者的自訂憑證附加資訊物件 (如有),通常用於定義使用者角色,並套用至已驗證使用者的 ID 權杖。
簽名:
customClaims?: {
[key: string]: any;
};
使用者匯入記錄.已停用
使用者是否停用:true
代表已停用;false
已啟用。
簽名:
disabled?: boolean;
使用者匯入記錄.displayName
使用者的顯示名稱。
簽名:
displayName?: string;
使用者匯入記錄.email
使用者的主要電子郵件地址 (如有設定)。
簽名:
email?: string;
使用者匯入記錄.email 已驗證
使用者的主要電子郵件地址是否已通過驗證。
簽名:
emailVerified?: boolean;
使用者匯入記錄.metadata
使用者的其他中繼資料。
簽名:
metadata?: UserMetadataRequest;
使用者匯入記錄.multiFactor
使用者的多重要素相關屬性。
簽名:
multiFactor?: MultiFactorUpdateSettings;
使用者匯入記錄.passwordHash
代表使用者雜湊密碼的位元組緩衝區。當使用者要使用密碼雜湊匯入時,必須指定 UserImportOptions,以識別用於產生此雜湊的雜湊演算法。
簽名:
passwordHash?: Buffer;
使用者匯入記錄.passwordSalt
代表使用者密碼鹽的位元組緩衝區。
簽名:
passwordSalt?: Buffer;
使用者匯入記錄.phoneNumber
使用者的主要電話號碼 (如有設定)。
簽名:
phoneNumber?: string;
使用者匯入記錄.photoURL
使用者的相片網址。
簽名:
photoURL?: string;
使用者匯入記錄.providerData
連結至使用者的提供者陣列 (例如 Google、Facebook)。
簽名:
providerData?: UserProviderRequest[];
使用者匯入記錄.用戶群 ID
要匯入使用者的目標用戶群 ID。如果 admin.auth.Auth
結構定義中沒有提供資源,系統會將使用者上傳至預設的父項專案。如果 admin.auth.TenantAwareAuth
結構定義中沒有提供資源,系統會將使用者上傳至與該 TenantAwareAuth
執行個體用戶群 ID 相對應的用戶群。
簽名:
tenantId?: string;
使用者匯入記錄.uid
使用者的 uid
。
簽名:
uid: string;