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