อินเทอร์เฟซที่แสดงผู้ใช้ที่จะนำเข้าไปยัง Firebase Auth ผ่านเมธอด BaseAuth.importUsers()
ลายเซ็น:
export interface UserImportRecord
คุณสมบัติ
| คุณสมบัติ | พิมพ์ | คำอธิบาย |
|---|---|---|
| การเรียกร้องแบบกำหนดเอง | { [คีย์: สตริง]: ใด ๆ; } | ออบเจ็กต์การอ้างสิทธิ์แบบกำหนดเองของผู้ใช้ หากมี โดยทั่วไปจะใช้เพื่อกำหนดบทบาทของผู้ใช้และเผยแพร่ไปยังโทเค็น ID ของผู้ใช้ที่ผ่านการรับรองความถูกต้อง |
| พิการ | บูลีน | ผู้ใช้ถูกปิดการใช้งานหรือไม่: true สำหรับการปิดการใช้งาน; false สำหรับการเปิดใช้งาน |
| ชื่อที่แสดง | เชือก | ชื่อที่แสดงของผู้ใช้ |
| อีเมล | เชือก | อีเมลหลักของผู้ใช้ หากตั้งค่าไว้ |
| อีเมลยืนยันแล้ว | บูลีน | อีเมลหลักของผู้ใช้จะได้รับการยืนยันหรือไม่ |
| ข้อมูลเมตา | UserMetadataRequest | ข้อมูลเมตาเพิ่มเติมเกี่ยวกับผู้ใช้ |
| หลายปัจจัย | การตั้งค่าการอัปเดตหลายปัจจัย | คุณสมบัติที่เกี่ยวข้องกับหลายปัจจัยของผู้ใช้ |
| รหัสผ่านHash | กันชน | บัฟเฟอร์ไบต์ที่แสดงถึงรหัสผ่านที่แฮชของผู้ใช้ เมื่อนำเข้าผู้ใช้ด้วยแฮชรหัสผ่าน จำเป็นต้องระบุ UserImportOptions เพื่อระบุอัลกอริทึมแฮชที่ใช้ในการสร้างแฮชนี้ |
| รหัสผ่านSalt | กันชน | บัฟเฟอร์ไบต์ที่แสดงถึงเกลือรหัสผ่านของผู้ใช้ |
| หมายเลขโทรศัพท์ | เชือก | หมายเลขโทรศัพท์หลักของผู้ใช้ หากตั้งค่าไว้ |
| URL รูปภาพ | เชือก | URL รูปภาพของผู้ใช้ |
| ผู้ให้บริการข้อมูล | UserProviderRequest [] | อาร์เรย์ของผู้ให้บริการ (เช่น Google, Facebook) ที่เชื่อมโยงกับผู้ใช้ |
| รหัสผู้เช่า | เชือก | ตัวระบุของผู้เช่าที่จะนำเข้าผู้ใช้ไป เมื่อไม่ได้ระบุไว้ในบริบท admin.auth.Auth ผู้ใช้จะถูกอัปโหลดไปยังโปรเจ็กต์หลักเริ่มต้น เมื่อไม่ได้ระบุไว้ในบริบท admin.auth.TenantAwareAuth ผู้ใช้จะถูกอัปโหลดไปยังผู้เช่าที่สอดคล้องกับ ID ผู้เช่าของอินสแตนซ์ TenantAwareAuth นั้น |
| uid | เชือก | uid ของผู้ใช้ |
UserImportRecord.customClaims
ออบเจ็กต์การอ้างสิทธิ์แบบกำหนดเองของผู้ใช้ หากมี โดยทั่วไปจะใช้เพื่อกำหนดบทบาทของผู้ใช้และเผยแพร่ไปยังโทเค็น ID ของผู้ใช้ที่ผ่านการรับรองความถูกต้อง
ลายเซ็น:
customClaims?: {
[key: string]: any;
};
UserImportRecord.disabled
ผู้ใช้ถูกปิดการใช้งานหรือไม่: true สำหรับการปิดการใช้งาน; false สำหรับการเปิดใช้งาน
ลายเซ็น:
disabled?: boolean;
UserImportRecord.displayName
ชื่อที่แสดงของผู้ใช้
ลายเซ็น:
displayName?: string;
UserImportRecord.email
อีเมลหลักของผู้ใช้ หากตั้งค่าไว้
ลายเซ็น:
email?: string;
UserImportRecord.email ยืนยันแล้ว
อีเมลหลักของผู้ใช้จะได้รับการยืนยันหรือไม่
ลายเซ็น:
emailVerified?: boolean;
UserImportRecord.metadata
ข้อมูลเมตาเพิ่มเติมเกี่ยวกับผู้ใช้
ลายเซ็น:
metadata?: UserMetadataRequest;
UserImportRecord.multiFactor
คุณสมบัติที่เกี่ยวข้องกับหลายปัจจัยของผู้ใช้
ลายเซ็น:
multiFactor?: MultiFactorUpdateSettings;
UserImportRecord.passwordHash
บัฟเฟอร์ไบต์ที่แสดงถึงรหัสผ่านที่แฮชของผู้ใช้ เมื่อนำเข้าผู้ใช้ด้วยแฮชรหัสผ่าน จำเป็นต้องระบุ UserImportOptions เพื่อระบุอัลกอริทึมแฮชที่ใช้ในการสร้างแฮชนี้
ลายเซ็น:
passwordHash?: Buffer;
UserImportRecord.passwordSalt
บัฟเฟอร์ไบต์ที่แสดงถึงเกลือรหัสผ่านของผู้ใช้
ลายเซ็น:
passwordSalt?: Buffer;
UserImportRecord.phoneNumber
หมายเลขโทรศัพท์หลักของผู้ใช้ หากตั้งค่าไว้
ลายเซ็น:
phoneNumber?: string;
UserImportRecord.photoURL
URL รูปภาพของผู้ใช้
ลายเซ็น:
photoURL?: string;
UserImportRecord.providerData
อาร์เรย์ของผู้ให้บริการ (เช่น Google, Facebook) ที่เชื่อมโยงกับผู้ใช้
ลายเซ็น:
providerData?: UserProviderRequest[];
UserImportRecord.tenantId
ตัวระบุของผู้เช่าที่จะนำเข้าผู้ใช้ไป เมื่อไม่ได้ระบุไว้ในบริบท admin.auth.Auth ผู้ใช้จะถูกอัปโหลดไปยังโปรเจ็กต์หลักเริ่มต้น เมื่อไม่ได้ระบุไว้ในบริบท admin.auth.TenantAwareAuth ผู้ใช้จะถูกอัปโหลดไปยังผู้เช่าที่สอดคล้องกับ ID ผู้เช่าของอินสแตนซ์ TenantAwareAuth นั้น
ลายเซ็น:
tenantId?: string;
UserImportRecord.uid
uid ของผู้ใช้ .
ลายเซ็น:
uid: string;