BaseAuth class

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

ลายเซ็น:

export declare abstract class BaseAuth

เมธอด

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

BaseAuth.createCustomToken()

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

คำมั่นสัญญา<สตริง>

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

BaseAuth.createProviderConfig()

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

สัญญา<AuthProviderConfig>

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

BaseAuth.createSessionCookie()

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

คำมั่นสัญญา<สตริง>

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

BaseAuth.createUser()

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

สัญญา<UserRecord>

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

BaseAuth.deleteProviderConfig()

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

คำสัญญา<โมฆะ>

คำมั่นสัญญาที่สำเร็จลุล่วง

BaseAuth.deleteUser()

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

คำสัญญา<โมฆะ>

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

BaseAuth.deleteUsers()

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

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

สัญญา<DeleteUsersResult>

คำมั่นสัญญาที่แก้ไขจำนวนรวมของการลบสำเร็จ/ไม่สำเร็จ รวมถึงอาร์เรย์ของข้อผิดพลาดที่สอดคล้องกับการลบที่ไม่สำเร็จ

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

ลายเซ็น:

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

พารามิเตอร์

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

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

คำมั่นสัญญา<สตริง>

คำมั่นสัญญาที่จะแก้ไขปัญหาด้วยลิงก์ที่สร้างขึ้น

ตัวอย่าง

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
    });

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

ลายเซ็น:

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

พารามิเตอร์

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

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

คำมั่นสัญญา<สตริง>

คำมั่นสัญญาที่จะแก้ไขปัญหาด้วยลิงก์ที่สร้างขึ้น

ตัวอย่าง

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
    });

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

ลายเซ็น:

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

พารามิเตอร์

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

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

คำมั่นสัญญา<สตริง>

คำมั่นสัญญาที่จะแก้ไขปัญหาด้วยลิงก์ที่สร้างขึ้น

ตัวอย่าง

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
    });

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

ลายเซ็น:

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

พารามิเตอร์

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

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

คำมั่นสัญญา<สตริง>

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

BaseAuth.getProviderConfig()

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

สัญญา<AuthProviderConfig>

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

BaseAuth.getUser()

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

สัญญา<UserRecord>

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

BaseAuth.getUserByEmail()

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

สัญญา<UserRecord>

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

BaseAuth.getUserByPhoneNumber()

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

สัญญา<UserRecord>

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

BaseAuth.getUserByProviderUid()

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

สัญญา<UserRecord>

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

BaseAuth.getUsers()

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

สัญญา<GetUsersผลลัพธ์>

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

ข้อยกเว้น

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

BaseAuth.importUsers()

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

ลายเซ็น:

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

พารามิเตอร์

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

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

สัญญา<UserImportผลลัพธ์>

คำมั่นสัญญาที่จะสิ้นสุดเมื่อการดำเนินการเสร็จสมบูรณ์เนื่องจากการนำเข้า ซึ่งรวมถึงจำนวนการนำเข้าที่สำเร็จ จำนวนการนำเข้าที่ไม่สำเร็จ และข้อผิดพลาดที่เกี่ยวข้อง

BaseAuth.listProviderConfigs()

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

สัญญา<ListProviderConfigResults>

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

BaseAuth.listUsers()

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

สัญญา<ListUsersผลลัพธ์>

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

BaseAuth.revokeRefreshTokens()

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

คำสัญญา<โมฆะ>

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

BaseAuth.setCustomUserClaims()

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

คำสัญญา<โมฆะ>

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

BaseAuth.updateProviderConfig()

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

สัญญา<AuthProviderConfig>

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

BaseAuth.updateUser()

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

สัญญา<UserRecord>

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

BaseAuth.verifyIdToken()

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

สัญญา<DeencryptedIdToken>

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

BaseAuth.verifySessionCookie()

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

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

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

ลายเซ็น:

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

พารามิเตอร์

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

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

สัญญา<DeencryptedIdToken>

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