Firebase is back at Google I/O on May 14! Register now.

หน้านี้ได้รับการแปลโดย Cloud Translation API

BaseAuth class

อินเทอร์เฟซหลักทั่วไปสำหรับทั้ง Auth API และ TenantAwareAuth

ลายเซ็น:

export declare abstract class BaseAuth

เมธอด

วิธีการ	คีย์ตัวปรับแต่ง	คำอธิบาย
createCustomToken(uid, developerClaims)		สร้างโทเค็นที่กำหนดเอง (JWT) ของ Firebase ใหม่ที่ส่งกลับไปยังอุปกรณ์ไคลเอ็นต์ได้ เพื่อใช้ลงชื่อเข้าใช้ด้วยเมธอด `signInWithCustomToken()` ของ SDK ของไคลเอ็นต์ (อินสแตนซ์ที่รับรู้ถึงกลุ่มผู้ใช้จะฝังรหัสกลุ่มผู้ใช้ในโทเค็นด้วย)ดูตัวอย่างโค้ดและเอกสารโดยละเอียดได้ที่สร้างโทเค็นที่กำหนดเอง
createProviderConfig(การกำหนดค่า)		แสดงผลสัญญาที่แก้ไขแล้วด้วย `AuthProviderConfig` ที่สร้างขึ้นใหม่เมื่อมีการสร้างการกำหนดค่าผู้ให้บริการใหม่การรองรับผู้ให้บริการ SAML และ OIDC ต้องใช้ Identity Platform ของ Google Cloud (GCIP) หากต้องการดูข้อมูลเพิ่มเติมเกี่ยวกับ GCIP รวมถึงราคาและฟีเจอร์ โปรดดูเอกสารประกอบของ GCIP
createSessionCookie(idToken, sessionCookieOptions)		สร้างคุกกี้เซสชัน Firebase ใหม่ด้วยตัวเลือกที่ระบุ สตริง JWT ที่สร้างขึ้นสามารถตั้งค่าเป็นคุกกี้เซสชันฝั่งเซิร์ฟเวอร์ด้วยนโยบายคุกกี้ที่กำหนดเอง และใช้สำหรับการจัดการเซสชันได้ คุกกี้เซสชัน JWT จะมีการอ้างสิทธิ์เพย์โหลดเหมือนกับโทเค็นรหัสที่ระบุดูจัดการคุกกี้ของเซสชันสำหรับตัวอย่างโค้ดและเอกสารโดยละเอียด
createUser(พร็อพเพอร์ตี้)		สร้างผู้ใช้ใหม่ดูตัวอย่างโค้ดและเอกสารประกอบโดยละเอียดที่สร้างผู้ใช้
deleteProviderConfig(providerId)		ลบการกำหนดค่าผู้ให้บริการที่สอดคล้องกับรหัสผู้ให้บริการที่ส่งผ่าน หากไม่มีรหัสที่ระบุ ระบบจะแสดงข้อผิดพลาด `auth/configuration-not-found`การรองรับผู้ให้บริการ SAML และ OIDC ต้องใช้ Identity Platform ของ Google Cloud (GCIP) หากต้องการดูข้อมูลเพิ่มเติมเกี่ยวกับ GCIP รวมถึงราคาและฟีเจอร์ โปรดดูเอกสารประกอบของ GCIP
deleteUser(uid)		ลบผู้ใช้ที่มีอยู่ดูตัวอย่างโค้ดและเอกสารโดยละเอียดได้ที่ส่วนลบผู้ใช้
deleteUsers(uids)		การลบผู้ใช้ที่ระบุโดย uID ที่ระบุการลบผู้ใช้ที่ไม่มีอยู่จะไม่ทำให้เกิดข้อผิดพลาด (กล่าวคือ วิธีการนี้เป็นแบบเฉพาะตัว) ระบบจะถือว่าผู้ใช้ที่ไม่มีตัวตนถูกนำออกแล้ว ซึ่งจะนับเป็นค่า `DeleteUsersResult.successCount`คุณสามารถระบุตัวระบุได้สูงสุด 1, 000 รายการเท่านั้น หากส่งตัวระบุมากกว่า 1, 000 รายการ เมธอดนี้จะแสดงข้อผิดพลาด FirebaseAuthErrorปัจจุบัน API นี้จำกัดอัตราคำขอในเซิร์ฟเวอร์อยู่ที่ 1 QPS หากเกินจำนวนนี้ คุณอาจได้รับข้อผิดพลาดเกี่ยวกับการใช้งานเกินโควต้า ดังนั้น หากคุณต้องการลบผู้ใช้มากกว่า 1,000 ราย คุณอาจต้องเพิ่มการหน่วงเวลาเพื่อให้แน่ใจว่าคุณจะไม่เกินขีดจำกัดนี้
generateEmailConfirmLink(อีเมล, actionCodeSettings)		สร้างลิงก์การดำเนินการทางอีเมลนอกกลุ่มเพื่อยืนยันการเป็นเจ้าของอีเมลที่ระบุของผู้ใช้ ออบเจ็กต์ ActionCodeSettings ที่ระบุเป็นอาร์กิวเมนต์ของเมธอดนี้จะกำหนดว่าลิงก์จะได้รับการจัดการโดยแอปบนอุปกรณ์เคลื่อนที่หรือเบราว์เซอร์ พร้อมด้วยข้อมูลสถานะเพิ่มเติมที่จะส่งใน Deep Link เป็นต้น
generatePasswordresetLink(อีเมล, actionCodeSettings)		สร้างลิงก์การดำเนินการอีเมลนอกกลุ่มเพื่อรีเซ็ตรหัสผ่านของผู้ใช้ ระบบจะสร้างลิงก์สําหรับผู้ใช้ที่มีอีเมลที่ระบุ ออบเจ็กต์ ActionCodeSettings ซึ่งไม่บังคับจะกำหนดว่าลิงก์จะได้รับการจัดการโดยแอปบนอุปกรณ์เคลื่อนที่หรือเบราว์เซอร์ และข้อมูลสถานะเพิ่มเติมที่จะส่งใน Deep Link เป็นต้น
generateSignInWithEmailLink(email, actionCodeSettings)		สร้างลิงก์การดำเนินการทางอีเมลนอกกลุ่มเพื่อยืนยันการเป็นเจ้าของอีเมลที่ระบุของผู้ใช้ ออบเจ็กต์ ActionCodeSettings ที่ระบุเป็นอาร์กิวเมนต์ของเมธอดนี้จะกำหนดว่าลิงก์จะได้รับการจัดการโดยแอปบนอุปกรณ์เคลื่อนที่หรือเบราว์เซอร์ พร้อมด้วยข้อมูลสถานะเพิ่มเติมที่จะส่งใน Deep Link เป็นต้น
generateVerifyAndChangeEmailLink(email, newEmail, actionCodeSettings)		สร้างลิงก์การดำเนินการทางอีเมลนอกขอบเขตเพื่อยืนยันการเป็นเจ้าของอีเมลที่ระบุของผู้ใช้ ออบเจ็กต์ ActionCodeSettings ที่ระบุเป็นอาร์กิวเมนต์ของเมธอดนี้จะกำหนดว่าลิงก์จะได้รับการจัดการโดยแอปบนอุปกรณ์เคลื่อนที่หรือเบราว์เซอร์ พร้อมด้วยข้อมูลสถานะเพิ่มเติมที่จะส่งใน Deep Link เป็นต้น
getProviderConfig(providerId)		ค้นหาการกำหนดค่าผู้ให้บริการตรวจสอบสิทธิ์โดยใช้รหัสที่ระบุ แสดงผลสัญญาที่แก้ไขแล้วด้วยการกำหนดค่าผู้ให้บริการที่ตรงกับรหัสผู้ให้บริการที่ระบุ หากไม่มีรหัสที่ระบุ ระบบจะแสดงข้อผิดพลาด `auth/configuration-not-found`การรองรับผู้ให้บริการ SAML และ OIDC ต้องใช้ Identity Platform ของ Google Cloud (GCIP) หากต้องการดูข้อมูลเพิ่มเติมเกี่ยวกับ GCIP รวมถึงราคาและฟีเจอร์ โปรดดูเอกสารประกอบของ GCIP
getUser(uid)		รับข้อมูลผู้ใช้สำหรับผู้ใช้ที่สอดคล้องกับ `uid` ที่ระบุโปรดดูเรียกข้อมูลผู้ใช้เพื่อดูตัวอย่างโค้ดและเอกสารโดยละเอียด
getUserByEmail(อีเมล)		รับข้อมูลผู้ใช้ของผู้ใช้ที่สอดคล้องกับอีเมลที่ระบุดูตัวอย่างโค้ดและเอกสารประกอบโดยละเอียดได้ที่เรียกข้อมูลผู้ใช้
getUserByPhoneNumber(phoneNumber)		รับข้อมูลผู้ใช้ที่เกี่ยวข้องกับหมายเลขโทรศัพท์ที่กำหนด หมายเลขโทรศัพท์ต้องเป็นไปตามข้อกําหนด E.164ดูตัวอย่างโค้ดและเอกสารประกอบโดยละเอียดได้ที่เรียกข้อมูลผู้ใช้
getUserByProviderUid(providerId, uid)		รับข้อมูลผู้ใช้ของผู้ใช้ที่สอดคล้องกับรหัสผู้ให้บริการที่ระบุดูตัวอย่างโค้ดและเอกสารประกอบโดยละเอียดได้ที่เรียกข้อมูลผู้ใช้
getUsers(ตัวระบุ)		รับข้อมูลผู้ใช้ที่สอดคล้องกับตัวระบุที่ระบุไม่มีการรับประกันลำดับ โดยเฉพาะอย่างยิ่งรายการที่ n ในรายการผลลัพธ์ไม่รับประกันว่าจะตรงกับรายการที่ n ในรายการพารามิเตอร์อินพุตระบุตัวระบุได้สูงสุด 100 รายการเท่านั้น หากมีการระบุตัวระบุมากกว่า 100 รายการ เมธอดนี้จะแสดงข้อผิดพลาด FirebaseAuthError
importUsers(ผู้ใช้, ตัวเลือก)		นำเข้ารายชื่อผู้ใช้ที่ระบุไปยัง Firebase Auth อนุญาตให้นำเข้าผู้ใช้ได้ครั้งละไม่เกิน 1,000 ราย เมื่อนำเข้าผู้ใช้พร้อมรหัสผ่าน ต้องระบุ UserImportOptions การดำเนินการนี้ได้รับการเพิ่มประสิทธิภาพเพื่อการนำเข้าพร้อมกันหลายรายการ และจะไม่สนใจการตรวจสอบใน `uid`, `email` และความไม่ซ้ำกันของตัวระบุอื่นๆ ซึ่งอาจทำให้เกิดข้อมูลซ้ำซ้อน
listProviderConfigs(ตัวเลือก)		แสดงผลรายการการกำหนดค่าผู้ให้บริการที่มีอยู่ที่ตรงกับตัวกรองที่ระบุ โดยแสดงการกำหนดค่าผู้ให้บริการได้สูงสุดครั้งละ 100 รายการการสนับสนุนผู้ให้บริการ SAML และ OIDC ต้องใช้ Identity Platform ของ Google Cloud (GCIP) หากต้องการดูข้อมูลเพิ่มเติมเกี่ยวกับ GCIP รวมถึงราคาและฟีเจอร์ โปรดดูเอกสารประกอบของ GCIP
listUsers(maxResults, pageToken)		เรียกข้อมูลรายชื่อผู้ใช้ (กลุ่มเดียวเท่านั้น) ที่มีขนาด `maxResults` เริ่มต้นจากออฟเซ็ตตามที่ `pageToken` ระบุไว้ ค่านี้จะใช้เพื่อเรียกข้อมูลผู้ใช้ทั้งหมดของโปรเจ็กต์ที่ระบุเป็นชุดดูตัวอย่างโค้ดและเอกสารประกอบโดยละเอียดได้ที่แสดงผู้ใช้ทั้งหมด
revokeรีเฟรชTokens(uid)		เพิกถอนโทเค็นการรีเฟรชทั้งหมดสำหรับผู้ใช้ที่มีอยู่API นี้จะอัปเดต Userrecord.tokensValidAfterTime ของผู้ใช้เป็นเวลา UTC ปัจจุบัน เซิร์ฟเวอร์ที่เรียกสิ่งนี้จะต้องตั้งเวลานาฬิกาอย่างถูกต้องและซิงค์ข้อมูลแล้วแม้ว่าการดำเนินการนี้จะเพิกถอนเซสชันทั้งหมดสำหรับผู้ใช้ที่ระบุและปิดไม่ให้สร้างโทเค็นรหัสใหม่สำหรับเซสชันที่มีอยู่ แต่โทเค็นรหัสที่มีอยู่อาจยังใช้งานได้ต่อไปจนกว่าจะหมดอายุตามปกติ (1 ชั่วโมง) หากต้องการยืนยันว่าได้เพิกถอนโทเค็นรหัสแล้ว ให้ใช้ BaseAuth.verifyIdToken() โดยที่ `checkRevoked` ตั้งค่าเป็น "จริง"
setCustomUserClaims(uid, customUserClaims)		ตั้งค่าการอ้างสิทธิ์ของนักพัฒนาซอฟต์แวร์เพิ่มเติมสำหรับผู้ใช้ที่มีอยู่ที่ระบุโดย `uid` ที่ให้ไว้ ซึ่งมักจะใช้ในการกำหนดบทบาทและระดับการเข้าถึงของผู้ใช้ โดยการอ้างสิทธิ์เหล่านี้ควรมีผลกับอุปกรณ์ทุกเครื่องที่ผู้ใช้ลงชื่อเข้าใช้อยู่แล้ว (หลังจากโทเค็นหมดอายุหรือเมื่อมีการบังคับรีเฟรชโทเค็น) และในครั้งถัดไปที่ผู้ใช้ลงชื่อเข้าใช้ หากใช้ชื่อการอ้างสิทธิ์ OIDC ที่สงวนไว้ (sub, iat, iss ฯลฯ) ระบบจะแสดงข้อผิดพลาด รหัสดังกล่าวได้รับการตั้งค่าใน JWT ของโทเค็นรหัสของผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์ดูตัวอย่างโค้ดและเอกสารประกอบโดยละเอียดได้ที่การกำหนดบทบาทของผู้ใช้และระดับการเข้าถึง
updateProviderConfig(providerId, updatedConfig)		แสดงผลสัญญาที่แปลงค่าด้วย `AuthProviderConfig` ที่อัปเดตแล้วซึ่งสอดคล้องกับรหัสผู้ให้บริการที่ระบุ หากไม่มีรหัสที่ระบุ ระบบจะแสดงข้อผิดพลาด `auth/configuration-not-found`การรองรับผู้ให้บริการ SAML และ OIDC ต้องใช้ Identity Platform ของ Google Cloud (GCIP) หากต้องการดูข้อมูลเพิ่มเติมเกี่ยวกับ GCIP รวมถึงราคาและฟีเจอร์ โปรดดูเอกสารประกอบของ GCIP
updateUser(uid, พร็อพเพอร์ตี้)		อัปเดตผู้ใช้ที่มีอยู่ดูตัวอย่างโค้ดและเอกสารประกอบโดยละเอียดที่อัปเดตผู้ใช้
verifyIdToken(idToken, check คุณสามารถยกเลิก)		ยืนยันโทเค็นรหัส Firebase (JWT) หากโทเค็นถูกต้อง จะมีการดำเนินการตามที่สัญญาไว้ด้วยการอ้างสิทธิ์ที่ถอดรหัสของโทเค็น มิเช่นนั้น คำสัญญาจะถูกปฏิเสธหากตั้งค่า `checkRevoked` เป็น "จริง" ก่อนอื่นให้ตรวจสอบว่าผู้ใช้ที่เกี่ยวข้องถูกปิดใช้หรือไม่ หากใช่ ระบบจะแสดงข้อผิดพลาด `auth/user-disabled` หากไม่มี ให้ยืนยันว่าเซสชันที่เกี่ยวข้องกับโทเค็นรหัสถูกเพิกถอนหรือไม่ หากเซสชันของผู้ใช้ที่เกี่ยวข้องเป็นโมฆะ ระบบจะแสดงข้อผิดพลาด `auth/id-token-revoked` หากไม่ได้ระบุ ระบบจะไม่ใช้การตรวจสอบโปรดดูส่วนยืนยันโทเค็นรหัสเพื่อดูตัวอย่างโค้ดและเอกสารโดยละเอียด
verifySessionCookie(sessionCookie, checkdisputed)		ยืนยันคุกกี้เซสชัน Firebase ส่งคืนคำสัญญาที่มีการอ้างสิทธิ์คุกกี้ ปฏิเสธสัญญาหากยืนยันคุกกี้ไม่ได้หากตั้งค่า `checkRevoked` เป็น "จริง" ให้ตรวจสอบก่อนว่าได้ปิดใช้ผู้ใช้ที่เกี่ยวข้องอยู่หรือไม่ หากใช่ ระบบจะแสดงข้อผิดพลาด `auth/user-disabled` หากไม่เห็น ให้ตรวจสอบว่ามีการเพิกถอนเซสชันที่เกี่ยวข้องกับคุกกี้เซสชันแล้วหรือไม่ หากเซสชันของผู้ใช้ที่เกี่ยวข้องเป็นโมฆะ ระบบจะแสดงข้อผิดพลาด `auth/session-cookie-revoked` หากไม่ได้ระบุ ระบบจะไม่ทำการตรวจสอบดูตัวอย่างโค้ดและเอกสารประกอบโดยละเอียดที่ยืนยันคุกกี้ของเซสชัน

BaseAuth.createCustomToken()

สร้างโทเค็นที่กำหนดเอง (JWT) ของ Firebase ใหม่ที่ส่งกลับไปยังอุปกรณ์ไคลเอ็นต์ได้ เพื่อใช้ลงชื่อเข้าใช้ด้วยเมธอด signInWithCustomToken() ของ SDK ของไคลเอ็นต์ (อินสแตนซ์ที่รับรู้ถึงกลุ่มผู้ใช้จะฝังรหัสกลุ่มผู้ใช้ในโทเค็นด้วย)

ดูสร้างโทเค็นที่กำหนดเองสำหรับตัวอย่างโค้ดและเอกสารโดยละเอียด

ลายเซ็น:

createCustomToken(uid: string, developerClaims?: object): Promise<string>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
UID	string	`uid` ที่จะใช้เป็นชื่อเรื่องของโทเค็นที่กำหนดเอง
การอ้างสิทธิ์ของนักพัฒนาแอป	ออบเจ็กต์	การอ้างสิทธิ์เพิ่มเติมที่ไม่บังคับซึ่งจะรวมอยู่ในเพย์โหลดของโทเค็นที่กำหนดเอง

การคืนสินค้า:

คำสัญญา<string>

คำมั่นสัญญาที่ได้รับการดำเนินการด้วยโทเค็นที่กำหนดเองสำหรับ uid และเพย์โหลดที่ระบุ

BaseAuth.createProviderConfig()

แสดงผลสัญญาที่แปลงด้วย AuthProviderConfig ที่สร้างขึ้นใหม่เมื่อมีการสร้างการกำหนดค่าผู้ให้บริการใหม่

การสนับสนุนผู้ให้บริการ SAML และ OIDC ต้องใช้ Identity Platform ของ Google Cloud (GCIP) หากต้องการดูข้อมูลเพิ่มเติมเกี่ยวกับ GCIP รวมถึงราคาและฟีเจอร์ โปรดดูเอกสารประกอบของ GCIP

ลายเซ็น:

createProviderConfig(config: AuthProviderConfig): Promise<AuthProviderConfig>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
การกำหนดค่า	AuthProviderConfig	การกำหนดค่าผู้ให้บริการที่จะสร้าง

การคืนสินค้า:

สัญญา<AuthProviderConfig>

สัญญาที่แก้ไขแล้วเมื่อใช้การกำหนดค่าผู้ให้บริการที่สร้างไว้

BaseAuth.createSessionCookie()

สร้างคุกกี้เซสชัน Firebase ใหม่ด้วยตัวเลือกที่ระบุ สตริง JWT ที่สร้างขึ้นสามารถตั้งค่าเป็นคุกกี้เซสชันฝั่งเซิร์ฟเวอร์ด้วยนโยบายคุกกี้ที่กำหนดเอง และใช้สำหรับการจัดการเซสชันได้ คุกกี้เซสชัน JWT จะมีการอ้างสิทธิ์เพย์โหลดเหมือนกับโทเค็นรหัสที่ระบุ

โปรดดูตัวอย่างโค้ดและเอกสารโดยละเอียดที่จัดการคุกกี้ของเซสชัน

ลายเซ็น:

createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
IDToken	string	โทเค็นรหัส Firebase ที่จะแลกเปลี่ยนกับคุกกี้เซสชัน
ตัวเลือกคุกกี้เซสชัน	SessionCookieOptions	ตัวเลือกคุกกี้เซสชันซึ่งรวมถึงระยะเวลาเซสชันที่กำหนดเอง

การคืนสินค้า:

คำสัญญา<string>

คำสัญญาที่จบลงด้วยความสำเร็จด้วยคุกกี้เซสชันที่สร้างขึ้น

BaseAuth.createUser()

สร้างผู้ใช้ใหม่

โปรดดูตัวอย่างโค้ดและเอกสารโดยละเอียดที่สร้างผู้ใช้

ลายเซ็น:

createUser(properties: CreateRequest): Promise<UserRecord>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
พร็อพเพอร์ตี้	CreateRequest	ระบบจะสร้างพร็อพเพอร์ตี้ที่จะตั้งค่าในระเบียนผู้ใช้ใหม่

การคืนสินค้า:

คำมั่นสัญญา<Userrecord>

คำมั่นสัญญาที่เติมเต็มด้วยข้อมูลผู้ใช้ที่สอดคล้องกับผู้ใช้ที่สร้างใหม่

BaseAuth.deleteProviderConfig()

ลบการกำหนดค่าผู้ให้บริการที่สอดคล้องกับรหัสผู้ให้บริการที่ส่งผ่าน หากไม่มีรหัสที่ระบุ ระบบจะแสดงข้อผิดพลาด auth/configuration-not-found

ลายเซ็น:

deleteProviderConfig(providerId: string): Promise<void>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
รหัสผู้ให้บริการ	string	รหัสผู้ให้บริการที่ตรงกับการกำหนดค่าผู้ให้บริการที่จะลบ

การคืนสินค้า:

คำสัญญา<void>

สัญญาที่จะแก้ไขเมื่อเสร็จสมบูรณ์

BaseAuth.deleteUser()

ลบผู้ใช้ที่มีอยู่

โปรดดูตัวอย่างโค้ดและเอกสารโดยละเอียดที่ลบผู้ใช้

ลายเซ็น:

deleteUser(uid: string): Promise<void>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
UID	string	`uid` ที่เกี่ยวข้องกับผู้ใช้ที่จะลบ

การคืนสินค้า:

คำสัญญา<void>

สัญญาที่ว่างเปล่าซึ่งจะมีผลเมื่อผู้ใช้ถูกลบไปแล้ว

BaseAuth.deleteUsers()

ลบผู้ใช้ที่ระบุโดย UID ที่ระบุ

การลบผู้ใช้ที่ไม่มีอยู่จะไม่ทำให้เกิดข้อผิดพลาด (กล่าวคือ วิธีการนี้เป็นแบบเฉพาะตัว) ระบบจะถือว่าผู้ใช้ที่ไม่มีตัวตนถูกนำออกแล้ว จึงนับรวมในค่า DeleteUsersResult.successCount

ระบุตัวระบุได้สูงสุด 1,000 รายการเท่านั้น หากมีการระบุตัวระบุมากกว่า 1, 000 รายการ เมธอดนี้จะแสดงข้อผิดพลาด FirebaseAuthError

ปัจจุบัน API นี้มีการจำกัดอัตราคำขอในเซิร์ฟเวอร์ไว้ที่ 1 QPS หากเกินจำนวนนี้ คุณอาจได้รับข้อผิดพลาดเกี่ยวกับการใช้งานเกินโควต้า ดังนั้น หากคุณต้องการลบผู้ใช้มากกว่า 1,000 ราย คุณอาจต้องเพิ่มการหน่วงเวลาเพื่อให้แน่ใจว่าคุณจะไม่เกินขีดจำกัดนี้

ลายเซ็น:

deleteUsers(uids: string[]): Promise<DeleteUsersResult>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
UID	สตริง[]	`uids` ที่เกี่ยวข้องกับผู้ใช้ที่จะลบ

การคืนสินค้า:

คำมั่นสัญญา<DeleteUsersผลลัพธ์>

คำมั่นสัญญาที่จัดการกับจำนวนทั้งหมดของการลบที่ประสบความสำเร็จ/ล้มเหลว ตลอดจนอาร์เรย์ของข้อผิดพลาดที่สอดคล้องกับการลบที่ล้มเหลว

BaseAuth.generateEmailVerificationLink()

สร้างลิงก์การดำเนินการทางอีเมลนอกกลุ่มเพื่อยืนยันการเป็นเจ้าของอีเมลที่ระบุของผู้ใช้ ออบเจ็กต์ ActionCodeSettings ที่ระบุเป็นอาร์กิวเมนต์ของเมธอดนี้จะกำหนดว่าลิงก์จะได้รับการจัดการโดยแอปบนอุปกรณ์เคลื่อนที่หรือเบราว์เซอร์ พร้อมด้วยข้อมูลสถานะเพิ่มเติมที่จะส่งใน Deep Link เป็นต้น

ลายเซ็น:

generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
อีเมล	string	บัญชีอีเมลที่จะยืนยัน
การตั้งค่า actionCode	ActionCodeSettings	การตั้งค่ารหัสการดำเนินการ หากระบุ URL สถานะ/ดำเนินการต่อจะตั้งค่าเป็นพารามิเตอร์ "continueUrl" ในลิงก์การยืนยันอีเมล หน้า Landing Page สำหรับการยืนยันอีเมลเริ่มต้นจะใช้หน้า Landing Page นี้เพื่อแสดงลิงก์กลับไปยังแอปหากมีการติดตั้งไว้ หากไม่ได้ระบุ actionCodeSettings จะไม่มีการเพิ่ม URL ต่อท้าย URL การดำเนินการ URL สถานะที่ระบุต้องเป็นของโดเมนที่นักพัฒนาซอฟต์แวร์ในรายการที่อนุญาตพิเศษในคอนโซล มิฉะนั้นระบบจะแสดงข้อผิดพลาด การเปลี่ยนเส้นทางแอปบนอุปกรณ์เคลื่อนที่จะมีผลก็ต่อเมื่อนักพัฒนาแอปกำหนดค่าและยอมรับข้อกำหนดในการให้บริการของลิงก์แบบไดนามิกของ Firebase ระบบจะใช้ชื่อแพ็กเกจ Android และรหัสชุด iOS ต่อเมื่อมีการกำหนดค่าในโปรเจ็กต์การตรวจสอบสิทธิ์ Firebase เดียวกัน

การคืนสินค้า:

คำสัญญา<string>

สัญญาที่จะช่วยสิ้นสุดด้วยลิงก์ที่สร้างขึ้น

ตัวอย่าง

var actionCodeSettings = {
  url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generateEmailVerificationLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

BaseAuth.generateรหัสผ่านรีเซ็ตลิงก์()

สร้างลิงก์การดำเนินการอีเมลนอกกลุ่มเพื่อรีเซ็ตรหัสผ่านของผู้ใช้ ระบบจะสร้างลิงก์สําหรับผู้ใช้ที่มีอีเมลที่ระบุ ออบเจ็กต์ ActionCodeSettings ซึ่งไม่บังคับจะกำหนดว่าลิงก์จะได้รับการจัดการโดยแอปบนอุปกรณ์เคลื่อนที่หรือเบราว์เซอร์ และข้อมูลสถานะเพิ่มเติมที่จะส่งใน Deep Link เป็นต้น

ลายเซ็น:

generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
อีเมล	string	อีเมลของผู้ใช้ที่ต้องการรีเซ็ตรหัสผ่าน
การตั้งค่า actionCode	ActionCodeSettings	การตั้งค่ารหัสการดำเนินการ หากระบุ URL สถานะ/ดำเนินการต่อจะตั้งค่าเป็นพารามิเตอร์ "continueUrl" ในลิงก์รีเซ็ตรหัสผ่าน หน้า Landing Page สำหรับการรีเซ็ตรหัสผ่านเริ่มต้นจะใช้ข้อมูลนี้เพื่อแสดงลิงก์เพื่อย้อนกลับไปยังแอปหากมีการติดตั้งไว้ หากไม่ได้ระบุ actionCodeSettings จะไม่มีการเพิ่ม URL ต่อท้าย URL การดำเนินการ URL สถานะที่ระบุต้องเป็นของโดเมนที่นักพัฒนาซอฟต์แวร์ในรายการที่อนุญาตพิเศษในคอนโซล มิฉะนั้นระบบจะแสดงข้อผิดพลาด การเปลี่ยนเส้นทางแอปบนอุปกรณ์เคลื่อนที่จะมีผลก็ต่อเมื่อนักพัฒนาแอปกำหนดค่าและยอมรับข้อกำหนดในการให้บริการของลิงก์แบบไดนามิกของ Firebase ระบบจะใช้ชื่อแพ็กเกจ Android และรหัสชุด iOS ต่อเมื่อมีการกำหนดค่าในโปรเจ็กต์การตรวจสอบสิทธิ์ Firebase เดียวกัน

การคืนสินค้า:

คำสัญญา<string>

สัญญาที่จะช่วยสิ้นสุดด้วยลิงก์ที่สร้างขึ้น

ตัวอย่าง

var actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generatePasswordResetLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

BaseAuth.generateSignInWithEmailLink()

ลายเซ็น:

generateSignInWithEmailLink(email: string, actionCodeSettings: ActionCodeSettings): Promise<string>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
อีเมล	string	บัญชีอีเมลที่จะยืนยัน
การตั้งค่า actionCode	ActionCodeSettings	การตั้งค่ารหัสการดำเนินการ หากระบุ URL สถานะ/ดำเนินการต่อจะตั้งค่าเป็นพารามิเตอร์ "continueUrl" ในลิงก์การยืนยันอีเมล หน้า Landing Page สำหรับการยืนยันอีเมลเริ่มต้นจะใช้หน้า Landing Page นี้เพื่อแสดงลิงก์กลับไปยังแอปหากมีการติดตั้งไว้ หากไม่ได้ระบุ actionCodeSettings จะไม่มีการเพิ่ม URL ต่อท้าย URL การดำเนินการ URL สถานะที่ระบุต้องเป็นของโดเมนที่นักพัฒนาซอฟต์แวร์ในรายการที่อนุญาตพิเศษในคอนโซล มิฉะนั้นระบบจะแสดงข้อผิดพลาด การเปลี่ยนเส้นทางแอปบนอุปกรณ์เคลื่อนที่จะมีผลก็ต่อเมื่อนักพัฒนาแอปกำหนดค่าและยอมรับข้อกำหนดในการให้บริการของลิงก์แบบไดนามิกของ Firebase ระบบจะใช้ชื่อแพ็กเกจ Android และรหัสชุด iOS ต่อเมื่อมีการกำหนดค่าในโปรเจ็กต์การตรวจสอบสิทธิ์ Firebase เดียวกัน

การคืนสินค้า:

คำสัญญา<string>

สัญญาที่จะช่วยสิ้นสุดด้วยลิงก์ที่สร้างขึ้น

ตัวอย่าง

var actionCodeSettings = {
  url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generateEmailVerificationLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

BaseAuth.generateVerifyAndChangeEmailLink()

สร้างลิงก์การดำเนินการทางอีเมลนอกขอบเขตเพื่อยืนยันการเป็นเจ้าของอีเมลที่ระบุของผู้ใช้ ออบเจ็กต์ ActionCodeSettings ที่ระบุเป็นอาร์กิวเมนต์ของเมธอดนี้จะกำหนดว่าลิงก์จะได้รับการจัดการโดยแอปบนอุปกรณ์เคลื่อนที่หรือเบราว์เซอร์ พร้อมด้วยข้อมูลสถานะเพิ่มเติมที่จะส่งใน Deep Link เป็นต้น

ลายเซ็น:

generateVerifyAndChangeEmailLink(email: string, newEmail: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
อีเมล	string	บัญชีอีเมลปัจจุบัน
อีเมลใหม่	string	อีเมลที่กําลังอัปเดตบัญชี
การตั้งค่า actionCode	ActionCodeSettings	การตั้งค่ารหัสการดำเนินการ หากระบุ URL สถานะ/ดำเนินการต่อจะตั้งค่าเป็นพารามิเตอร์ "continueUrl" ในลิงก์การยืนยันอีเมล หน้า Landing Page สำหรับการยืนยันอีเมลเริ่มต้นจะใช้หน้า Landing Page นี้เพื่อแสดงลิงก์กลับไปยังแอปหากมีการติดตั้งไว้ หากไม่ได้ระบุ actionCodeSettings จะไม่มีการเพิ่ม URL ต่อท้าย URL การดำเนินการ URL สถานะที่ระบุต้องเป็นของโดเมนที่ได้รับสิทธิ์ในคอนโซล มิเช่นนั้นระบบจะแสดงข้อผิดพลาด การเปลี่ยนเส้นทางแอปบนอุปกรณ์เคลื่อนที่จะมีผลก็ต่อเมื่อนักพัฒนาแอปกำหนดค่าและยอมรับข้อกำหนดในการให้บริการของลิงก์แบบไดนามิกของ Firebase ระบบจะใช้ชื่อแพ็กเกจ Android และรหัสชุด iOS ต่อเมื่อมีการกำหนดค่าในโปรเจ็กต์การตรวจสอบสิทธิ์ Firebase เดียวกัน

การคืนสินค้า:

คำสัญญา<string>

สัญญาที่จะช่วยสิ้นสุดด้วยลิงก์ที่สร้างขึ้น

BaseAuth.getProviderConfig()

ค้นหาการกำหนดค่าผู้ให้บริการตรวจสอบสิทธิ์โดยใช้รหัสที่ระบุ แสดงผลสัญญาที่แก้ไขแล้วด้วยการกำหนดค่าผู้ให้บริการที่ตรงกับรหัสผู้ให้บริการที่ระบุ หากไม่มีรหัสที่ระบุ ระบบจะแสดงข้อผิดพลาด auth/configuration-not-found

ลายเซ็น:

getProviderConfig(providerId: string): Promise<AuthProviderConfig>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
รหัสผู้ให้บริการ	string	รหัสผู้ให้บริการที่ตรงกับการกำหนดค่าผู้ให้บริการเพื่อแสดงผล

การคืนสินค้า:

สัญญา<AuthProviderConfig>

สัญญาที่แก้ไขด้วยการกำหนดค่าที่สอดคล้องกับรหัสที่ระบุ

BaseAuth.getUser()

รับข้อมูลผู้ใช้สำหรับผู้ใช้ที่เกี่ยวข้องกับ uid ที่กำหนด

ดูเรียกข้อมูลผู้ใช้สำหรับตัวอย่างโค้ดและเอกสารโดยละเอียด

ลายเซ็น:

getUser(uid: string): Promise<UserRecord>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
UID	string	`uid` ที่เกี่ยวข้องกับผู้ใช้ที่เป็นเจ้าของข้อมูลที่จะดึงข้อมูล

การคืนสินค้า:

คำมั่นสัญญา<Userrecord>

คำมั่นสัญญาที่ส่งมอบข้อมูลผู้ใช้ที่สอดคล้องกับuidที่ระบุ

BaseAuth.getUserByEmail()

รับข้อมูลผู้ใช้สำหรับผู้ใช้ที่เกี่ยวข้องกับอีเมลที่ระบุ

ดูเรียกข้อมูลผู้ใช้สำหรับตัวอย่างโค้ดและเอกสารโดยละเอียด

ลายเซ็น:

getUserByEmail(email: string): Promise<UserRecord>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
อีเมล	string	อีเมลที่เกี่ยวข้องกับผู้ใช้ที่ต้องการดึงข้อมูล

การคืนสินค้า:

คำมั่นสัญญา<Userrecord>

คำมั่นสัญญาที่ส่งมอบข้อมูลผู้ใช้ที่สอดคล้องกับอีเมลที่ให้ไว้

BaseAuth.getUserByPhoneNumber()

รับข้อมูลผู้ใช้ที่เกี่ยวข้องกับหมายเลขโทรศัพท์ที่กำหนด หมายเลขโทรศัพท์ต้องเป็นไปตามข้อกำหนด E.164

ดูเรียกข้อมูลผู้ใช้สำหรับตัวอย่างโค้ดและเอกสารโดยละเอียด

ลายเซ็น:

getUserByPhoneNumber(phoneNumber: string): Promise<UserRecord>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
หมายเลขโทรศัพท์	string	หมายเลขโทรศัพท์ที่เกี่ยวข้องกับผู้ใช้ที่ต้องการดึงข้อมูล

การคืนสินค้า:

คำมั่นสัญญา<Userrecord>

คำมั่นสัญญาที่มอบข้อมูลผู้ใช้ที่สอดคล้องกับหมายเลขโทรศัพท์ที่ให้ไว้

BaseAuth.getUserByProviderUid()

รับข้อมูลผู้ใช้สำหรับผู้ใช้ที่สอดคล้องกับรหัสผู้ให้บริการที่กำหนด

ดูเรียกข้อมูลผู้ใช้สำหรับตัวอย่างโค้ดและเอกสารโดยละเอียด

ลายเซ็น:

getUserByProviderUid(providerId: string, uid: string): Promise<UserRecord>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
รหัสผู้ให้บริการ	string	รหัสผู้ให้บริการ เช่น "google.com" สําหรับผู้ให้บริการของ Google
UID	string	ตัวระบุผู้ใช้ของผู้ให้บริการนั้นๆ

การคืนสินค้า:

คำมั่นสัญญา<Userrecord>

คำมั่นสัญญาที่มีข้อมูลผู้ใช้ซึ่งสอดคล้องกับรหัสผู้ให้บริการที่ระบุ

BaseAuth.getUsers()

รับข้อมูลผู้ใช้ที่สอดคล้องกับตัวระบุที่ระบุ

ไม่มีการรับประกันการเรียงลำดับ โดยเฉพาะอย่างยิ่งรายการที่ n ในรายการผลลัพธ์ไม่รับประกันว่าตรงกับรายการที่ n ในรายการพารามิเตอร์อินพุต

ระบุตัวระบุได้สูงสุด 100 รายการเท่านั้น หากมีการระบุตัวระบุมากกว่า 100 รายการ เมธอดนี้จะแสดงข้อผิดพลาด FirebaseAuthError

ลายเซ็น:

getUsers(identifiers: UserIdentifier[]): Promise<GetUsersResult>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ตัวระบุ	UserIdentifier[]	ตัวระบุที่ใช้เพื่อระบุว่าควรส่งคืนบันทึกผู้ใช้ใด ต้องมีไม่เกิน 100 รายการ

การคืนสินค้า:

คำมั่นสัญญา<GetUsers Results>

สัญญาที่ยืนยันถึงบันทึกของผู้ใช้ที่เกี่ยวข้อง

ข้อยกเว้น

FirebaseAuthError หากตัวระบุใดๆ ไม่ถูกต้อง หรือมีการระบุตัวระบุมากกว่า 100 รายการ

BaseAuth.importUsers()

นำเข้ารายชื่อผู้ใช้ที่ระบุไปยัง Firebase Auth อนุญาตให้นำเข้าผู้ใช้ได้ครั้งละไม่เกิน 1,000 ราย เมื่อนำเข้าผู้ใช้พร้อมรหัสผ่าน ต้องระบุ UserImportOptions การดำเนินการนี้ได้รับการเพิ่มประสิทธิภาพเพื่อการนำเข้าพร้อมกันหลายรายการ และจะไม่สนใจการตรวจสอบใน uid, email และความไม่ซ้ำกันของตัวระบุอื่นๆ ซึ่งอาจทำให้เกิดข้อมูลซ้ำซ้อน

ลายเซ็น:

importUsers(users: UserImportRecord[], options?: UserImportOptions): Promise<UserImportResult>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ผู้ใช้	UserImportrecord[]	รายการบันทึกผู้ใช้ที่จะนำเข้าไปยัง Firebase Auth
ตัวเลือก	ตัวเลือกการนำเข้าของผู้ใช้	ตัวเลือกการนำเข้าของผู้ใช้ที่จำเป็นเมื่อผู้ใช้ที่ระบุมีข้อมูลเข้าสู่ระบบสำหรับรหัสผ่าน

การคืนสินค้า:

คำมั่นสัญญา<UserImport Results>

สัญญาที่จะแก้ไขเมื่อการดำเนินการเสร็จสิ้นโดยเป็นผลมาจากการนำเข้า ซึ่งรวมถึงจำนวนการนำเข้าที่สำเร็จ จำนวนการนำเข้าที่ล้มเหลว และข้อผิดพลาดที่เกี่ยวข้อง

BaseAuth.listProviderConfigs()

แสดงผลรายการการกำหนดค่าผู้ให้บริการที่มีอยู่ที่ตรงกับตัวกรองที่ระบุ ระบบจะแสดงการกำหนดค่าผู้ให้บริการได้สูงสุดครั้งละ 100 รายการ

ลายเซ็น:

listProviderConfigs(options: AuthProviderConfigFilter): Promise<ListProviderConfigResults>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ตัวเลือก	AuthProviderConfigFilter	ตัวกรองการกำหนดค่าผู้ให้บริการที่จะใช้

การคืนสินค้า:

คำมั่นสัญญา<ListProviderConfig Results>

สัญญาที่จะช่วยแก้ไขปัญหาด้วยรายการการกำหนดค่าผู้ให้บริการที่เป็นไปตามข้อกำหนดของตัวกรอง

BaseAuth.listUsers()

เรียกข้อมูลรายชื่อผู้ใช้ (กลุ่มเดียวเท่านั้น) ที่มีขนาด maxResults โดยเริ่มจากออฟเซ็ตตามที่ pageToken ระบุไว้ ข้อมูลนี้ใช้เพื่อเรียกข้อมูลผู้ใช้ทั้งหมดในโปรเจ็กต์ที่ระบุเป็นกลุ่ม

ดูแสดงรายชื่อผู้ใช้ทั้งหมดเพื่อดูตัวอย่างโค้ดและเอกสารโดยละเอียด

ลายเซ็น:

listUsers(maxResults?: number, pageToken?: string): Promise<ListUsersResult>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ผลลัพธ์สูงสุด	ตัวเลข	ขนาดหน้า 1000 หากไม่ระบุ ซึ่งเป็นจำนวนสูงสุดที่อนุญาตด้วย
pageToken	string	โทเค็นของหน้าถัดไป หากไม่ได้ระบุ ระบบจะแสดงผลผู้ใช้ตั้งแต่เริ่มต้นโดยไม่มีการชดเชย

การคืนสินค้า:

คำมั่นสัญญา<ListUsers Results>

คำสัญญาที่จะมีผลหลังจากที่กลุ่มผู้ใช้ที่ดาวน์โหลดไปแล้วในปัจจุบันและโทเค็นหน้าถัดไป

BaseAuth.revokeรีเฟรชTokens()

เพิกถอนโทเค็นการรีเฟรชทั้งหมดสำหรับผู้ใช้ที่มีอยู่

API นี้จะอัปเดต Userrecord.tokensValidAfterTime ของผู้ใช้เป็นเวลา UTC ปัจจุบัน จำเป็นต้องให้เซิร์ฟเวอร์ที่มีการเรียกใช้โค้ดนี้มีการตั้งนาฬิกาอย่างถูกต้องและซิงค์ข้อมูลแล้ว

แม้ว่าการดำเนินการนี้จะเพิกถอนเซสชันทั้งหมดของผู้ใช้ที่ระบุและปิดใช้โทเค็น ID ใหม่สำหรับเซสชันที่มีอยู่ไม่ให้มีการสร้างโทเค็นรหัสที่มีอยู่ แต่โทเค็นรหัสที่มีอยู่อาจยังใช้งานได้ต่อไปจนกว่าจะหมดอายุตามปกติ (1 ชั่วโมง) หากต้องการยืนยันว่าได้เพิกถอนโทเค็นรหัสแล้ว ให้ใช้ BaseAuth.verifyIdToken() โดยที่ checkRevoked ตั้งค่าเป็น "จริง"

ลายเซ็น:

revokeRefreshTokens(uid: string): Promise<void>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
UID	string	`uid` ที่เกี่ยวข้องกับผู้ใช้ที่ต้องการเพิกถอนโทเค็นการรีเฟรช

การคืนสินค้า:

คำสัญญา<void>

สัญญาว่างซึ่งดำเนินการแล้วจะเสร็จสิ้นเมื่อโทเค็นการรีเฟรชของผู้ใช้ถูกเพิกถอนแล้ว

BaseAuth.setCustomUserClaims()

ตั้งค่าการอ้างสิทธิ์ของนักพัฒนาซอฟต์แวร์เพิ่มเติมสำหรับผู้ใช้ที่มีอยู่ซึ่งระบุโดย uid ที่ให้ไว้ ซึ่งมักจะใช้ในการกำหนดบทบาทและระดับการเข้าถึงของผู้ใช้ โดยการอ้างสิทธิ์เหล่านี้ควรมีผลกับอุปกรณ์ทุกเครื่องที่ผู้ใช้ลงชื่อเข้าใช้อยู่แล้ว (หลังจากโทเค็นหมดอายุหรือเมื่อมีการบังคับรีเฟรชโทเค็น) และในครั้งถัดไปที่ผู้ใช้ลงชื่อเข้าใช้ หากใช้ชื่อการอ้างสิทธิ์ OIDC ที่สงวนไว้ (sub, iat, iss ฯลฯ) ระบบจะแสดงข้อผิดพลาด โดยจะมีการตั้งค่าใน JWT โทเค็นรหัสของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

ดูการระบุบทบาทของผู้ใช้และระดับการเข้าถึงเพื่อดูตัวอย่างโค้ดและเอกสารโดยละเอียด

ลายเซ็น:

setCustomUserClaims(uid: string, customUserClaims: object | null): Promise<void>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
UID	string	`uid` ของผู้ใช้ที่ต้องการแก้ไข
การอ้างสิทธิ์ของผู้ใช้ที่กำหนดเอง	ออบเจ็กต์ \| ค่าว่าง	นักพัฒนาซอฟต์แวร์อ้างว่าจะตั้งค่า หากมีการส่งผ่าน Null ระบบจะลบการอ้างสิทธิ์ที่กำหนดเองที่มีอยู่ การส่งผ่านเพย์โหลดการอ้างสิทธิ์ที่กำหนดเองที่มีขนาดใหญ่กว่า 1000 ไบต์จะทำให้เกิดข้อผิดพลาด ระบบจะเพิ่มการอ้างสิทธิ์ที่กำหนดเองลงในโทเค็น ID ของผู้ใช้ ซึ่งระบบจะส่งการอ้างสิทธิ์ทั้งหมดในคำขอที่ผ่านการตรวจสอบสิทธิ์แล้ว สำหรับแอตทริบิวต์ผู้ใช้ที่เกี่ยวข้องกับโปรไฟล์ที่ไม่มีสิทธิ์เข้าถึง ให้ใช้ฐานข้อมูลหรือระบบพื้นที่เก็บข้อมูลอื่นแยกต่างหาก

การคืนสินค้า:

คำสัญญา<void>

สัญญาที่จะแก้ไขเมื่อการดำเนินการเสร็จสมบูรณ์

BaseAuth.updateProviderConfig()

แสดงผลสัญญาที่แปลงค่าด้วย AuthProviderConfig ที่อัปเดตแล้วซึ่งสอดคล้องกับรหัสผู้ให้บริการที่ระบุ หากไม่มีรหัสที่ระบุ ระบบจะแสดงข้อผิดพลาด auth/configuration-not-found

ลายเซ็น:

updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest): Promise<AuthProviderConfig>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
รหัสผู้ให้บริการ	string	รหัสผู้ให้บริการที่ตรงกับการกำหนดค่าผู้ให้บริการที่จะอัปเดต
อัปเดตการกำหนดค่าแล้ว	UpdateAuthProviderRequest	การกำหนดค่าที่อัปเดตแล้ว

การคืนสินค้า:

สัญญา<AuthProviderConfig>

สัญญาที่จะได้รับการแก้ไขด้วยการกำหนดค่าผู้ให้บริการที่อัปเดต

BaseAuth.updateUser()

อัปเดตผู้ใช้ที่มีอยู่

โปรดดูตัวอย่างโค้ดและเอกสารประกอบโดยละเอียดที่อัปเดตผู้ใช้

ลายเซ็น:

updateUser(uid: string, properties: UpdateRequest): Promise<UserRecord>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
UID	string	`uid` ที่เกี่ยวข้องกับผู้ใช้ที่ต้องการอัปเดต
พร็อพเพอร์ตี้	UpdateRequest	พร็อพเพอร์ตี้ที่จะอัปเดตสำหรับผู้ใช้ที่ระบุ

การคืนสินค้า:

คำมั่นสัญญา<Userrecord>

คำมั่นสัญญาที่เติมเต็มด้วยข้อมูลผู้ใช้ที่อัปเดต

BaseAuth.verifyIdToken()

ยืนยันโทเค็นรหัส Firebase (JWT) หากโทเค็นถูกต้อง สัญญาจะมีการดำเนินการตามการอ้างสิทธิ์ที่ถอดรหัสแล้วของโทเค็น มิเช่นนั้น จะปฏิเสธสัญญา

หากตั้งค่า checkRevoked เป็น "จริง" ให้ตรวจสอบก่อนว่าได้ปิดใช้ผู้ใช้ที่เกี่ยวข้องแล้วหรือไม่ หากใช่ ระบบจะแสดงข้อผิดพลาด auth/user-disabled หากไม่มี ให้ยืนยันว่าเซสชันที่เกี่ยวข้องกับโทเค็นรหัสถูกเพิกถอนหรือไม่ หากเซสชันของผู้ใช้ที่เกี่ยวข้องเป็นโมฆะ ระบบจะแสดงข้อผิดพลาด auth/id-token-revoked หากไม่ได้ระบุ ระบบจะไม่นำเช็คไปใช้

ดูยืนยันโทเค็นรหัสเพื่อดูตัวอย่างโค้ดและเอกสารโดยละเอียด

ลายเซ็น:

verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
IDToken	string	โทเค็นรหัสที่จะยืนยัน
ตรวจสอบถูกยกเลิก	boolean	ตรวจสอบว่าโทเค็นรหัสถูกเพิกถอนหรือไม่ ซึ่งจำเป็นต้องมีคำขอเพิ่มเติมไปยังแบ็กเอนด์การตรวจสอบสิทธิ์ของ Firebase เพื่อตรวจสอบเวลา `tokensValidAfterTime` ของผู้ใช้ที่เกี่ยวข้อง เมื่อไม่ได้ระบุ การตรวจสอบเพิ่มเติมนี้จะไม่มีผล

การคืนสินค้า:

คำมั่นสัญญา<DecodedIdToken>

คำสัญญาที่ตอบสนองด้วยการอ้างสิทธิ์ที่ถอดรหัสแล้วของโทเค็น หากโทเค็นรหัสถูกต้อง หากโทเค็นรหัสถูกต้อง ไม่เช่นนั้น จะถือว่าเป็นคำสัญญาที่ถูกปฏิเสธ

BaseAuth.verifySessionCookie()

ยืนยันคุกกี้เซสชัน Firebase ส่งคืนคำสัญญาที่มีการอ้างสิทธิ์คุกกี้ ปฏิเสธคำมั่นสัญญาหากยืนยันคุกกี้ไม่ได้

หากตั้งค่า checkRevoked เป็น "จริง" ก่อนอื่นให้ตรวจสอบว่าผู้ใช้ที่เกี่ยวข้องถูกปิดใช้หรือไม่ หากใช่ ระบบจะแสดงข้อผิดพลาด auth/user-disabled หากไม่เห็น ให้ตรวจสอบว่ามีการเพิกถอนเซสชันที่เกี่ยวข้องกับคุกกี้เซสชันแล้วหรือไม่ หากเซสชันของผู้ใช้ที่เกี่ยวข้องเป็นโมฆะ ระบบจะแสดงข้อผิดพลาด auth/session-cookie-revoked หากไม่ได้ระบุ ระบบจะไม่ดำเนินการตรวจสอบ

โปรดดูยืนยันคุกกี้ของเซสชัน เพื่อดูตัวอย่างโค้ดและเอกสารโดยละเอียด

ลายเซ็น:

verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
คุกกี้เซสชัน	string	คุกกี้เซสชันที่จะยืนยัน
ตรวจสอบถูกยกเลิก	boolean

การคืนสินค้า:

คำมั่นสัญญา<DecodedIdToken>

คำมั่นสัญญาที่มีการดำเนินการตามการอ้างสิทธิ์ที่ถอดรหัสของคุกกี้เซสชัน หากคุกกี้เซสชันถูกต้อง หากคุกกี้เซสชันถูกต้อง หรือไม่เช่นนั้น จะถือเป็นการปฏิเสธ