จัดการผู้ใช้

Firebase Admin SDK มี API สำหรับจัดการ ผู้ใช้ Firebase Authentication รายที่มีสิทธิ์ในระดับสูงขึ้น API การจัดการผู้ใช้ที่ดูแลระบบ ทำให้คุณสามารถทำงานต่อไปนี้โดยอัตโนมัติจาก สภาพแวดล้อมของเซิร์ฟเวอร์ที่ปลอดภัย:

• สร้างผู้ใช้ใหม่โดยไม่มีการควบคุมหรือจำกัดอัตราคำขอ
• ค้นหาผู้ใช้ตามเกณฑ์ต่างๆ เช่น UID, อีเมล หรือหมายเลขโทรศัพท์
• แสดงรายการผู้ใช้ทั้งหมดของโปรเจ็กต์ที่ระบุเป็นกลุ่ม
• เข้าถึงข้อมูลเมตาของผู้ใช้ รวมถึงวันที่สร้างบัญชีและวันที่ลงชื่อเข้าใช้ล่าสุด
• ลบผู้ใช้โดยไม่ต้องใช้รหัสผ่านที่มีอยู่
• อัปเดตพร็อพเพอร์ตี้ผู้ใช้ รวมถึงรหัสผ่าน โดยไม่ต้องลงชื่อเข้าใช้ ในฐานะผู้ใช้
• ยืนยันอีเมลโดยไม่ต้องดำเนินการตามขั้นตอนนอกขอบเขตสำหรับ กำลังยืนยันอีเมล
• เปลี่ยนอีเมลของผู้ใช้โดยไม่ส่งลิงก์อีเมลเพื่อเพิกถอนการเปลี่ยนแปลงเหล่านี้
• สร้างผู้ใช้ใหม่ที่มีหมายเลขโทรศัพท์โดยไม่ต้องผ่าน SMS ขั้นตอนการยืนยัน
• เปลี่ยนหมายเลขโทรศัพท์ของผู้ใช้โดยไม่ต้องดำเนินการยืนยันทาง SMS
• ผู้ใช้การจัดสรรออฟไลน์ที่อยู่ในสถานะปิดใช้ จากนั้นควบคุมในภายหลังว่าเมื่อใด เปิดใช้
• สร้างคอนโซลผู้ใช้ที่กำหนดเองซึ่งปรับแต่งให้เหมาะกับผู้ใช้แอปพลิเคชันที่กำหนด ระบบจัดการเนื้อหา

ก่อนเริ่มต้น

หากต้องการใช้ API การจัดการผู้ใช้ที่ Firebase Admin SDK มีให้ คุณต้องทำดังนี้ ต้องมีบัญชีบริการ ทำตามวิธีการตั้งค่า เพื่อดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีเริ่มต้นใช้งาน Admin SDK

เรียกข้อมูลผู้ใช้

วิธีหลักในการระบุผู้ใช้คือการใช้ uid ซึ่งเป็นตัวระบุที่ไม่ซ้ำกันสำหรับ ผู้ใช้รายนั้น Admin SDK มีวิธีที่ช่วยให้ดึงข้อมูลโปรไฟล์ได้ ข้อมูลของผู้ใช้ตาม uid:

Node.js

getAuth()
  .getUser(uid)
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log(`Successfully fetched user data: ${userRecord.toJSON()}`);
  })
  .catch((error) => {
    console.log('Error fetching user data:', error);
  });
manage_users.js

Java

UserRecord userRecord = FirebaseAuth.getInstance().getUser(uid);
// See the UserRecord reference doc for the contents of userRecord.
System.out.println("Successfully fetched user data: " + userRecord.getUid());

Python

from firebase_admin import auth

user = auth.get_user(uid)
print('Successfully fetched user data: {0}'.format(user.uid))

Go

// Get an auth client from the firebase.App
client, err := app.Auth(ctx)
if err != nil {
	log.Fatalf("error getting Auth client: %v\n", err)
}

u, err := client.GetUser(ctx, uid)
if err != nil {
	log.Fatalf("error getting user %s: %v\n", uid, err)
}
log.Printf("Successfully fetched user data: %v\n", u)
auth.go

C#

UserRecord userRecord = await FirebaseAuth.DefaultInstance.GetUserAsync(uid);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully fetched user data: {userRecord.Uid}");

เมธอดนี้แสดงผล UserRecord สำหรับผู้ใช้ที่สอดคล้องกับ uid ที่ให้ไว้กับเมธอด

หาก uid ที่ระบุไม่ได้เป็นของผู้ใช้ที่มีอยู่แล้ว หรือผู้ใช้ไม่สามารถ มีการดึงข้อมูลด้วยเหตุผลอื่น วิธีการข้างต้นเกิดข้อผิดพลาด สำหรับรายการรหัสข้อผิดพลาดทั้งหมด รวมถึงคำอธิบายและ โปรดดูขั้นตอนการแก้ปัญหาในหัวข้อข้อผิดพลาดของ Admin Auth API

ในบางกรณี คุณจะมีอีเมลของผู้ใช้แทนuid Firebase Admin SDK รองรับการค้นหาข้อมูลผู้ใช้ด้วยอีเมล

Node.js

getAuth()
  .getUserByEmail(email)
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log(`Successfully fetched user data: ${userRecord.toJSON()}`);
  })
  .catch((error) => {
    console.log('Error fetching user data:', error);
  });
manage_users.js

Java

UserRecord userRecord = FirebaseAuth.getInstance().getUserByEmail(email);
// See the UserRecord reference doc for the contents of userRecord.
System.out.println("Successfully fetched user data: " + userRecord.getEmail());

Python

from firebase_admin import auth

user = auth.get_user_by_email(email)
print('Successfully fetched user data: {0}'.format(user.uid))

Go

u, err := client.GetUserByEmail(ctx, email)
if err != nil {
	log.Fatalf("error getting user by email %s: %v\n", email, err)
}
log.Printf("Successfully fetched user data: %v\n", u)
auth.go

C#

UserRecord userRecord = await FirebaseAuth.DefaultInstance.GetUserByEmailAsync(email);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully fetched user data: {userRecord.Uid}");

เมธอดนี้แสดงออบเจ็กต์ UserRecord สำหรับค่า ผู้ใช้ที่ตรงกับอีเมลที่ระบุ

หากอีเมลที่ระบุไม่ได้เป็นของผู้ใช้เดิม หรือผู้ใช้ไม่สามารถ ถูกดึงข้อมูลไม่ว่าด้วยเหตุผลใดก็ตาม Admin SDK แสดงข้อผิดพลาด ดูรายการรหัสข้อผิดพลาดทั้งหมดรวมถึงคำอธิบาย และขั้นตอนการแก้ปัญหา โปรดดูข้อผิดพลาดของ API Authentication สำหรับผู้ดูแลระบบ

คำเตือน: สำหรับการค้นหาอีเมล คุณจะค้นหาได้เฉพาะอีเมลหลัก (ระดับบนสุด) และ ไม่ใช่อีเมลเฉพาะผู้ให้บริการ เช่น หากบัญชี Facebook ที่มี อีเมล [e-mail] อีกฉบับ เชื่อมโยงกับผู้ใช้ที่มีอยู่แล้วที่มี ส่งอีเมลถึง [e-mail] โทรหา getUserByEmail("[e-mail]") จะไม่แสดงผลใดๆ ในขณะที่ getUserByEmail("[e-mail]") จะแสดงผล ผู้ใช้ที่คาดไว้ ในกรณีของ "บัญชีเดียวต่ออีเมล" เริ่มต้น การตั้งค่า อีเมลแรกที่ใช้ในการลงชื่อเข้าใช้จะใช้เป็นระดับบนสุด อีเมล เว้นแต่จะมีการแก้ไขหลังจากนั้น เมื่อเลือก "หลายบัญชีต่ออีเมล" ได้รับการตั้งค่าแล้ว ระบบจะตั้งค่าอีเมลหลักเมื่อมีการสร้างผู้ใช้รหัสผ่าน เว้นแต่จะอัปเดตด้วยตนเอง

ในกรณีอื่นๆ คุณจะใช้หมายเลขโทรศัพท์ของผู้ใช้แทน uid Firebase Admin SDK รองรับการค้นหาข้อมูลผู้ใช้ด้วยหมายเลขโทรศัพท์ ดังนี้

Node.js

getAuth()
  .getUserByPhoneNumber(phoneNumber)
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log(`Successfully fetched user data:  ${userRecord.toJSON()}`);
  })
  .catch((error) => {
    console.log('Error fetching user data:', error);
  });
manage_users.js

Java

UserRecord userRecord = FirebaseAuth.getInstance().getUserByPhoneNumber(phoneNumber);
// See the UserRecord reference doc for the contents of userRecord.
System.out.println("Successfully fetched user data: " + userRecord.getPhoneNumber());

Python

from firebase_admin import auth

user = auth.get_user_by_phone_number(phone)
print('Successfully fetched user data: {0}'.format(user.uid))

Go

u, err := client.GetUserByPhoneNumber(ctx, phone)
if err != nil {
	log.Fatalf("error getting user by phone %s: %v\n", phone, err)
}
log.Printf("Successfully fetched user data: %v\n", u)
auth.go

C#

UserRecord userRecord = await FirebaseAuth.DefaultInstance.GetUserByPhoneNumberAsync(phoneNumber);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully fetched user data: {userRecord.Uid}");

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

หากหมายเลขโทรศัพท์ที่ระบุไม่ได้เป็นของผู้ใช้หรือผู้ใช้ปัจจุบัน ดึงข้อมูลไม่ได้ด้วยเหตุผลอื่น Admin SDK เกิดข้อผิดพลาด ดูรายการรหัสข้อผิดพลาดทั้งหมดรวมถึงคำอธิบาย และขั้นตอนการแก้ปัญหา โปรดดูข้อผิดพลาดของ API Authentication สำหรับผู้ดูแลระบบ

เรียกข้อมูลผู้ใช้จำนวนมาก

นอกจากนี้ Firebase Admin SDK ยังอนุญาตให้ดึงข้อมูลรายชื่อผู้ใช้โดยอิงตาม ตัวระบุต่างๆ ที่คุณให้ไว้ คุณจะระบุผู้ใช้ได้จากรหัสผู้ใช้ อีเมล หรือ หมายเลขโทรศัพท์ สามารถระบุตัวระบุสูงสุด 100 รายการในการเรียกครั้งเดียว ตัวระบุมีหลายประเภทรวมกัน:

Node.js

getAuth()
  .getUsers([
    { uid: 'uid1' },
    { email: '[e-mail]' },
    { phoneNumber: '[phone]' },
    { providerId: 'google.com', providerUid: 'google_uid4' },
  ])
  .then((getUsersResult) => {
    console.log('Successfully fetched user data:');
    getUsersResult.users.forEach((userRecord) => {
      console.log(userRecord);
    });

    console.log('Unable to find users corresponding to these identifiers:');
    getUsersResult.notFound.forEach((userIdentifier) => {
      console.log(userIdentifier);
    });
  })
  .catch((error) => {
    console.log('Error fetching user data:', error);
  });
manage_users.js

Java

GetUsersResult result = FirebaseAuth.getInstance().getUsersAsync(Arrays.asList(
    new UidIdentifier("uid1"),
    new EmailIdentifier("[e-mail]"),
    new PhoneIdentifier("[phone]"),
    new ProviderIdentifier("google.com", "google_uid4"))).get();

System.out.println("Successfully fetched user data:");
for (UserRecord user : result.getUsers()) {
  System.out.println(user.getUid());
}

System.out.println("Unable to find users corresponding to these identifiers:");
for (UserIdentifier uid : result.getNotFound()) {
  System.out.println(uid);
}

Python

from firebase_admin import auth

result = auth.get_users([
    auth.UidIdentifier('uid1'),
    auth.EmailIdentifier('[e-mail]'),
    auth.PhoneIdentifier([phone]),
    auth.ProviderIdentifier('google.com', 'google_uid4')
])

print('Successfully fetched user data:')
for user in result.users:
    print(user.uid)

print('Unable to find users corresponding to these identifiers:')
for uid in result.not_found:
    print(uid)

Go

getUsersResult, err := client.GetUsers(ctx, []auth.UserIdentifier{
	auth.UIDIdentifier{UID: "uid1"},
	auth.EmailIdentifier{Email: "[e-mail]"},
	auth.PhoneIdentifier{PhoneNumber: "[phone]"},
	auth.ProviderIdentifier{ProviderID: "google.com", ProviderUID: "google_uid1"},
})
if err != nil {
	log.Fatalf("error retriving multiple users: %v\n", err)
}

log.Printf("Successfully fetched user data:")
for _, u := range getUsersResult.Users {
	log.Printf("%v", u)
}

log.Printf("Unable to find users corresponding to these identifiers:")
for _, id := range getUsersResult.NotFound {
	log.Printf("%v", id)
}

C#

GetUsersResult result = await FirebaseAuth.DefaultInstance.GetUsersAsync(
    new List<UserIdentifier>
    {
        new UidIdentifier("uid1"),
        new EmailIdentifier("[e-mail]"),
        new PhoneIdentifier("[phone]"),
        new ProviderIdentifier("google.com", "google_uid4"),
    });

Console.WriteLine("Successfully fetched user data:");
foreach (UserRecord user in result.Users)
{
    Console.WriteLine($"User: {user.Uid}");
}

Console.WriteLine("Unable to find users corresponding to these identifiers:");
foreach (UserIdentifier uid in result.NotFound)
{
    Console.WriteLine($"{uid}");
}

วิธีนี้จะแสดงรายการขนาดเดียวกับรายการอินพุตโดยที่แต่ละรายการ ที่มี UserRecord ที่สอดคล้องกันหรือข้อผิดพลาดที่ระบุสาเหตุ ไม่สามารถค้นหาตัวระบุนั้น ดูรายการรหัสข้อผิดพลาดทั้งหมด ซึ่งรวมถึงคำอธิบายและขั้นตอนการแก้ปัญหา โปรดดูที่ API การดูแลระบบ Authentication ข้อผิดพลาด

สร้างผู้ใช้

Admin SDK ระบุเมธอดที่ ช่วยให้คุณสร้างผู้ใช้ Firebase Authentication ใหม่ได้ เมธอดนี้ยอมรับ ที่มีข้อมูลโปรไฟล์ที่จะรวมใน บัญชีผู้ใช้:

Node.js

getAuth()
  .createUser({
    email: '[e-mail]',
    emailVerified: false,
    phoneNumber: '[phone]',
    password: 'secretPassword',
    displayName: 'John Doe',
    photoURL: 'http://www.example.com/12345678/photo.png',
    disabled: false,
  })
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log('Successfully created new user:', userRecord.uid);
  })
  .catch((error) => {
    console.log('Error creating new user:', error);
  });
manage_users.js

Java

CreateRequest request = new CreateRequest()
    .setEmail("[e-mail]")
    .setEmailVerified(false)
    .setPassword("secretPassword")
    .setPhoneNumber("[phone]")
    .setDisplayName("John Doe")
    .setPhotoUrl("http://www.example.com/12345678/photo.png")
    .setDisabled(false);

UserRecord userRecord = FirebaseAuth.getInstance().createUser(request);
System.out.println("Successfully created new user: " + userRecord.getUid());

Python

user = auth.create_user(
    email='[e-mail]',
    email_verified=False,
    phone_number='[phone]',
    password='secretPassword',
    display_name='John Doe',
    photo_url='http://www.example.com/12345678/photo.png',
    disabled=False)
print('Sucessfully created new user: {0}'.format(user.uid))

Go

params := (&auth.UserToCreate{}).
	Email("[e-mail]").
	EmailVerified(false).
	PhoneNumber("[phone]").
	Password("secretPassword").
	DisplayName("John Doe").
	PhotoURL("http://www.example.com/12345678/photo.png").
	Disabled(false)
u, err := client.CreateUser(ctx, params)
if err != nil {
	log.Fatalf("error creating user: %v\n", err)
}
log.Printf("Successfully created user: %v\n", u)
auth.go

C#

UserRecordArgs args = new UserRecordArgs()
{
    Email = "[e-mail]",
    EmailVerified = false,
    PhoneNumber = "[phone]",
    Password = "secretPassword",
    DisplayName = "John Doe",
    PhotoUrl = "http://www.example.com/12345678/photo.png",
    Disabled = false,
};
UserRecord userRecord = await FirebaseAuth.DefaultInstance.CreateUserAsync(args);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully created new user: {userRecord.Uid}");

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

Node.js

getAuth()
  .createUser({
    uid: 'some-uid',
    email: '[e-mail]',
    phoneNumber: '[phone]',
  })
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log('Successfully created new user:', userRecord.uid);
  })
  .catch((error) => {
    console.log('Error creating new user:', error);
  });
manage_users.js

Java

CreateRequest request = new CreateRequest()
    .setUid("some-uid")
    .setEmail("[e-mail]")
    .setPhoneNumber("[phone]");

UserRecord userRecord = FirebaseAuth.getInstance().createUser(request);
System.out.println("Successfully created new user: " + userRecord.getUid());

Python

user = auth.create_user(
    uid='some-uid', email='[e-mail]', phone_number='[phone]')
print('Sucessfully created new user: {0}'.format(user.uid))

Go

params := (&auth.UserToCreate{}).
	UID(uid).
	Email("[e-mail]").
	PhoneNumber("[phone]")
u, err := client.CreateUser(ctx, params)
if err != nil {
	log.Fatalf("error creating user: %v\n", err)
}
log.Printf("Successfully created user: %v\n", u)
auth.go

C#

UserRecordArgs args = new UserRecordArgs()
{
    Uid = "some-uid",
    Email = "[e-mail]",
    PhoneNumber = "[phone]",
};
UserRecord userRecord = await FirebaseAuth.DefaultInstance.CreateUserAsync(args);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully created new user: {userRecord.Uid}");

คุณระบุชุดค่าผสมของพร็อพเพอร์ตี้ต่อไปนี้ใดๆ ก็ได้

ตาราง 1. พร็อพเพอร์ตี้ที่การดำเนินการสร้างผู้ใช้รองรับ

พร็อพเพอร์ตี้	ประเภท	คำอธิบาย
uid	สตริง	uid ที่จะมอบหมายให้กับผู้ใช้ที่สร้างขึ้นใหม่ ต้องเป็น ที่มีความยาวระหว่าง 1-128 อักขระ หากไม่ได้ระบุ เหตุการณ์ ระบบจะสร้าง uid แบบสุ่มโดยอัตโนมัติ สั้นลง uid ให้ประสิทธิภาพที่ดีกว่า
email	สตริง	อีเมลหลักของผู้ใช้ ต้องเป็นที่อยู่อีเมลที่ถูกต้อง
emailVerified	boolean	อีเมลหลักของผู้ใช้ได้รับการยืนยันหรือไม่ หากไม่ได้ระบุ ค่า ค่าเริ่มต้นคือ false
phoneNumber	สตริง	หมายเลขโทรศัพท์หลักของผู้ใช้ ต้องเป็นไปตามข้อกำหนดของ E.164 ที่ถูกต้อง หมายเลขโทรศัพท์
password	สตริง	รหัสผ่านดิบที่ไม่ได้แฮชของผู้ใช้ ต้องมีความยาวอย่างน้อย 6 อักขระ
displayName	สตริง	ผู้ใช้ ชื่อที่แสดง
photoURL	สตริง	URL รูปภาพของผู้ใช้
disabled	boolean	ผู้ใช้ถูกปิดใช้งานหรือไม่ true สำหรับการปิดใช้งาน falseสำหรับการเปิดใช้งาน หากไม่ได้ตั้งค่าไว้ ระบบจะใช้ค่าเริ่มต้นเป็น false

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

วิธีการสร้างผู้ใช้แสดงออบเจ็กต์ UserRecord สำหรับ ผู้ใช้ที่สร้างใหม่

หาก uid ที่ระบุมีการใช้งานแล้วโดยอีเมลหรือหมายเลขโทรศัพท์ที่มีอยู่ ไม่สามารถสร้างผู้ใช้หรือผู้ใช้ได้ด้วยเหตุผลอื่น วิธีการข้างต้นล้มเหลว เกิดข้อผิดพลาด สำหรับรายการรหัสข้อผิดพลาดทั้งหมด ได้แก่ โปรดดูคำอธิบายและขั้นตอนการแก้ปัญหาในหัวข้อ API ของAuthenticationผู้ดูแลระบบ ข้อผิดพลาด

อัปเดตผู้ใช้

Firebase Admin SDK ช่วยอำนวยความสะดวกในการแก้ไขข้อมูลผู้ใช้ที่มีอยู่ คุณต้องมี เพื่อระบุ uid พร้อมกับพร็อพเพอร์ตี้ที่จะอัปเดตสำหรับผู้ใช้รายนั้น

Node.js

getAuth()
  .updateUser(uid, {
    email: '[e-mail]',
    phoneNumber: '[phone]',
    emailVerified: true,
    password: 'newPassword',
    displayName: 'Jane Doe',
    photoURL: 'http://www.example.com/12345678/photo.png',
    disabled: true,
  })
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log('Successfully updated user', userRecord.toJSON());
  })
  .catch((error) => {
    console.log('Error updating user:', error);
  });
manage_users.js

Java

UpdateRequest request = new UpdateRequest(uid)
    .setEmail("[e-mail]")
    .setPhoneNumber("[phone]")
    .setEmailVerified(true)
    .setPassword("newPassword")
    .setDisplayName("Jane Doe")
    .setPhotoUrl("http://www.example.com/12345678/photo.png")
    .setDisabled(true);

UserRecord userRecord = FirebaseAuth.getInstance().updateUser(request);
System.out.println("Successfully updated user: " + userRecord.getUid());

Python

user = auth.update_user(
    uid,
    email='[e-mail]',
    phone_number='[phone]',
    email_verified=True,
    password='newPassword',
    display_name='John Doe',
    photo_url='http://www.example.com/12345678/photo.png',
    disabled=True)
print('Sucessfully updated user: {0}'.format(user.uid))

Go

params := (&auth.UserToUpdate{}).
	Email("[e-mail]").
	EmailVerified(true).
	PhoneNumber("[phone]").
	Password("newPassword").
	DisplayName("John Doe").
	PhotoURL("http://www.example.com/12345678/photo.png").
	Disabled(true)
u, err := client.UpdateUser(ctx, uid, params)
if err != nil {
	log.Fatalf("error updating user: %v\n", err)
}
log.Printf("Successfully updated user: %v\n", u)
auth.go

C#

UserRecordArgs args = new UserRecordArgs()
{
    Uid = uid,
    Email = "[e-mail]",
    PhoneNumber = "[phone]",
    EmailVerified = true,
    Password = "newPassword",
    DisplayName = "Jane Doe",
    PhotoUrl = "http://www.example.com/12345678/photo.png",
    Disabled = true,
};
UserRecord userRecord = await FirebaseAuth.DefaultInstance.UpdateUserAsync(args);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully updated user: {userRecord.Uid}");

คุณระบุชุดค่าผสมของพร็อพเพอร์ตี้ต่อไปนี้ใดๆ ก็ได้

ตาราง 2. พร็อพเพอร์ตี้ที่การดำเนินการอัปเดตผู้ใช้รองรับ

พร็อพเพอร์ตี้	ประเภท	คำอธิบาย
email	สตริง	อีเมลหลักรายการใหม่ของผู้ใช้ ต้องเป็นที่อยู่อีเมลที่ถูกต้อง
emailVerified	boolean	อีเมลหลักของผู้ใช้ได้รับการยืนยันหรือไม่ หากไม่ได้ระบุ ค่า ค่าเริ่มต้นคือ false
phoneNumber	สตริง	หมายเลขโทรศัพท์หลักใหม่ของผู้ใช้ ต้องเป็นไปตามข้อกำหนดของ E.164 ที่ถูกต้อง หมายเลขโทรศัพท์ ตั้งค่าเป็น null เพื่อล้างรายการที่มีอยู่ของผู้ใช้ หมายเลขโทรศัพท์
password	สตริง	รหัสผ่านดิบที่ไม่ได้แฮชรายการใหม่ของผู้ใช้ ต้องมีความยาวอย่างน้อย 6 อักขระ
displayName	สตริง | null	ผู้ใช้ ชื่อที่แสดงใหม่ ตั้งค่าเป็น null เพื่อล้าง ชื่อที่แสดงที่มีอยู่
photoURL	สตริง | null	ผู้ใช้ URL รูปภาพใหม่ ตั้งค่าเป็น null เพื่อล้าง URL ของรูปภาพที่มีอยู่ หากไม่ใช่ null ต้องเป็น URL ที่ถูกต้อง
disabled	boolean	ผู้ใช้ถูกปิดใช้งานหรือไม่ true สำหรับการปิดใช้งาน falseสำหรับการเปิดใช้งาน

หมายเหตุ: พร็อพเพอร์ตี้ข้างต้นทั้งหมดไม่บังคับ หากพร็อพเพอร์ตี้บางรายการไม่ใช่ ค่าที่มีอยู่ของพร็อพเพอร์ตี้นั้นจะไม่เปลี่ยนแปลง

วิธีอัปเดตสำหรับผู้ใช้จะแสดงออบเจ็กต์ UserRecord ที่อัปเดตแล้วเมื่อ การอัปเดตเสร็จสมบูรณ์

หาก uid ที่ระบุไม่ตรงกับผู้ใช้ที่มีอยู่ อีเมลหรือหมายเลขโทรศัพท์มีการใช้งานแล้วโดยผู้ใช้ปัจจุบัน หรือผู้ใช้ไม่สามารถ ด้วยเหตุผลอื่น วิธีการด้านบนจะล้มเหลวโดย สำหรับรายการรหัสข้อผิดพลาดทั้งหมด รวมถึงคำอธิบายและวิธีแก้ปัญหา โปรดดูขั้นตอนที่หัวข้อข้อผิดพลาดของ API สำหรับผู้ดูแลระบบ Authentication

ลบผู้ใช้

Firebase Admin SDK อนุญาตให้ลบผู้ใช้ที่มีอยู่ภายใน uid ดังนี้

Node.js

getAuth()
  .deleteUser(uid)
  .then(() => {
    console.log('Successfully deleted user');
  })
  .catch((error) => {
    console.log('Error deleting user:', error);
  });
manage_users.js

Java

FirebaseAuth.getInstance().deleteUser(uid);
System.out.println("Successfully deleted user.");

Python

auth.delete_user(uid)
print('Successfully deleted user')

Go

err := client.DeleteUser(ctx, uid)
if err != nil {
	log.Fatalf("error deleting user: %v\n", err)
}
log.Printf("Successfully deleted user: %s\n", uid)
auth.go

C#

await FirebaseAuth.DefaultInstance.DeleteUserAsync(uid);
Console.WriteLine("Successfully deleted user.");

วิธีการลบของผู้ใช้จะแสดงผลลัพธ์ที่ว่างเปล่าเมื่อการลบเสร็จสมบูรณ์ สำเร็จ

หาก uid ที่ระบุไม่ตรงกับผู้ใช้ที่มีอยู่ หรือผู้ใช้ไม่สามารถ ถูกลบด้วยเหตุผลอื่น แต่เมธอด "ลบผู้ใช้" จะเกิดข้อผิดพลาด ดูรายการรหัสข้อผิดพลาดทั้งหมดรวมถึงคำอธิบาย และขั้นตอนการแก้ปัญหา โปรดดูข้อผิดพลาดของ API Authentication สำหรับผู้ดูแลระบบ

ลบผู้ใช้หลายคน

นอกจากนี้ Firebase Admin SDK ยังลบผู้ใช้หลายคนพร้อมกันได้ด้วย อย่างไรก็ตาม โปรดทราบว่าการใช้เมธอดอย่าง deleteUsers(uids) เพื่อลบผู้ใช้หลายรายที่ ครั้งเดียวจะไม่ทริกเกอร์เครื่องจัดการเหตุการณ์ onDelete() สำหรับ Cloud Functions for Firebase เนื่องจากการลบเป็นกลุ่มจะไม่ทริกเกอร์เหตุการณ์การลบผู้ใช้ใน ผู้ใช้แต่ละราย ลบผู้ใช้ 1 รายที่ หากต้องการให้เหตุการณ์การลบผู้ใช้เริ่มทํางานสําหรับผู้ใช้ที่ถูกลบแต่ละราย

Node.js

getAuth()
  .deleteUsers([uid1, uid2, uid3])
  .then((deleteUsersResult) => {
    console.log(`Successfully deleted ${deleteUsersResult.successCount} users`);
    console.log(`Failed to delete ${deleteUsersResult.failureCount} users`);
    deleteUsersResult.errors.forEach((err) => {
      console.log(err.error.toJSON());
    });
  })
  .catch((error) => {
    console.log('Error deleting users:', error);
  });

Java

DeleteUsersResult result = FirebaseAuth.getInstance().deleteUsersAsync(
    Arrays.asList("uid1", "uid2", "uid3")).get();

System.out.println("Successfully deleted " + result.getSuccessCount() + " users");
System.out.println("Failed to delete " + result.getFailureCount() + " users");
for (ErrorInfo error : result.getErrors()) {
  System.out.println("error #" + error.getIndex() + ", reason: " + error.getReason());
}

Python

from firebase_admin import auth

result = auth.delete_users(["uid1", "uid2", "uid3"])

print('Successfully deleted {0} users'.format(result.success_count))
print('Failed to delete {0} users'.format(result.failure_count))
for err in result.errors:
    print('error #{0}, reason: {1}'.format(result.index, result.reason))

Go

deleteUsersResult, err := client.DeleteUsers(ctx, []string{"uid1", "uid2", "uid3"})
if err != nil {
	log.Fatalf("error deleting users: %v\n", err)
}

log.Printf("Successfully deleted %d users", deleteUsersResult.SuccessCount)
log.Printf("Failed to delete %d users", deleteUsersResult.FailureCount)
for _, err := range deleteUsersResult.Errors {
	log.Printf("%v", err)
}

C#

DeleteUsersResult result = await FirebaseAuth.DefaultInstance.DeleteUsersAsync(new List<string>
    {
        "uid1",
        "uid2",
        "uid3",
    });

Console.WriteLine($"Successfully deleted {result.SuccessCount} users.");
Console.WriteLine($"Failed to delete {result.FailureCount} users.");

foreach (ErrorInfo err in result.Errors)
{
    Console.WriteLine($"Error #{err.Index}, reason: {err.Reason}");
}

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

แสดงผู้ใช้ทั้งหมด

Firebase Admin SDK ทำให้สามารถเรียกข้อมูลรายชื่อผู้ใช้ทั้งหมดเป็นกลุ่มได้ ดังนี้

Node.js

const listAllUsers = (nextPageToken) => {
  // List batch of users, 1000 at a time.
  getAuth()
    .listUsers(1000, nextPageToken)
    .then((listUsersResult) => {
      listUsersResult.users.forEach((userRecord) => {
        console.log('user', userRecord.toJSON());
      });
      if (listUsersResult.pageToken) {
        // List next batch of users.
        listAllUsers(listUsersResult.pageToken);
      }
    })
    .catch((error) => {
      console.log('Error listing users:', error);
    });
};
// Start listing users from the beginning, 1000 at a time.
listAllUsers();
manage_users.js

Java

// Start listing users from the beginning, 1000 at a time.
ListUsersPage page = FirebaseAuth.getInstance().listUsers(null);
while (page != null) {
  for (ExportedUserRecord user : page.getValues()) {
    System.out.println("User: " + user.getUid());
  }
  page = page.getNextPage();
}

// Iterate through all users. This will still retrieve users in batches,
// buffering no more than 1000 users in memory at a time.
page = FirebaseAuth.getInstance().listUsers(null);
for (ExportedUserRecord user : page.iterateAll()) {
  System.out.println("User: " + user.getUid());
}

Python

# Start listing users from the beginning, 1000 at a time.
page = auth.list_users()
while page:
    for user in page.users:
        print('User: ' + user.uid)
    # Get next batch of users.
    page = page.get_next_page()

# Iterate through all users. This will still retrieve users in batches,
# buffering no more than 1000 users in memory at a time.
for user in auth.list_users().iterate_all():
    print('User: ' + user.uid)

Go

// Note, behind the scenes, the Users() iterator will retrive 1000 Users at a time through the API
iter := client.Users(ctx, "")
for {
	user, err := iter.Next()
	if err == iterator.Done {
		break
	}
	if err != nil {
		log.Fatalf("error listing users: %s\n", err)
	}
	log.Printf("read user user: %v\n", user)
}

// Iterating by pages 100 users at a time.
// Note that using both the Next() function on an iterator and the NextPage()
// on a Pager wrapping that same iterator will result in an error.
pager := iterator.NewPager(client.Users(ctx, ""), 100, "")
for {
	var users []*auth.ExportedUserRecord
	nextPageToken, err := pager.NextPage(&users)
	if err != nil {
		log.Fatalf("paging error %v\n", err)
	}
	for _, u := range users {
		log.Printf("read user user: %v\n", u)
	}
	if nextPageToken == "" {
		break
	}
}
auth.go

C#

// Start listing users from the beginning, 1000 at a time.
var pagedEnumerable = FirebaseAuth.DefaultInstance.ListUsersAsync(null);
var responses = pagedEnumerable.AsRawResponses().GetAsyncEnumerator();
while (await responses.MoveNextAsync())
{
    ExportedUserRecords response = responses.Current;
    foreach (ExportedUserRecord user in response.Users)
    {
        Console.WriteLine($"User: {user.Uid}");
    }
}

// Iterate through all users. This will still retrieve users in batches,
// buffering no more than 1000 users in memory at a time.
var enumerator = FirebaseAuth.DefaultInstance.ListUsersAsync(null).GetAsyncEnumerator();
while (await enumerator.MoveNextAsync())
{
    ExportedUserRecord user = enumerator.Current;
    Console.WriteLine($"User: {user.Uid}");
}

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

หากไม่ได้ระบุช่อง maxResults ระบบจะใช้ผู้ใช้เริ่มต้น 1, 000 รายต่อกลุ่ม และยังเป็นจำนวนผู้ใช้สูงสุดที่อนุญาตให้แสดงต่อครั้งด้วย ช่วง ค่าที่มากกว่าค่าสูงสุดจะแสดงข้อผิดพลาดเกี่ยวกับอาร์กิวเมนต์ หากไม่ได้ระบุ pageToken ไว้ การดำเนินการนี้จะแสดงผู้ใช้จาก เริ่มต้น เรียงลำดับตาม uid

ดูรายการรหัสข้อผิดพลาดทั้งหมดรวมถึงคำอธิบาย และขั้นตอนการแก้ปัญหา โปรดดูข้อผิดพลาดของ API Authentication สำหรับผู้ดูแลระบบ

แฮชรหัสผ่านของผู้ใช้ที่แสดง

API นี้ยังแสดงผล passwordSalt และ passwordHash ที่แฮชโดย แบ็กเอนด์การตรวจสอบสิทธิ์ Firebase สำหรับผู้ใช้รหัสผ่านในกรณีที่บัญชีผู้ใช้/บริการเคยใช้ สร้างโทเค็นเพื่อการเข้าถึง OAuth ของคำขอจะมี สิทธิ์ firebaseauth.configs.getHashConfig หรือไม่เช่นนั้น passwordHash และ passwordSalt จะไม่ได้รับการตั้งค่า

เนื่องจากแฮชรหัสผ่านมีลักษณะที่ละเอียดอ่อน บริการ Firebase Admin SDK บัญชีไม่มีสิทธิ์firebaseauth.configs.getHashConfigภายใน "ค่าเริ่มต้น" คุณเพิ่มสิทธิ์ให้บัญชีผู้ใช้/บริการโดยตรงไม่ได้ แต่จะ จะทำเช่นนั้นได้โดยอ้อม การสร้างบทบาท IAM ที่กำหนดเอง

วิธีสร้างบทบาท IAM ที่กำหนดเอง

1. ไปที่หน้าบทบาทใน IAM & แผงผู้ดูแลระบบ คอนโซล Google Cloud
2. เลือกโปรเจ็กต์จากเมนูแบบเลื่อนลงที่ด้านบนของหน้า
3. คลิกสร้างบทบาท
4. คลิกเพิ่มสิทธิ์
5. ค้นหาสิทธิ์ firebaseauth.configs.getHashConfig แล้วเลือกสิทธิ์นั้น ช่องทำเครื่องหมาย
6. คลิกเพิ่ม
7. คลิกสร้างเพื่อสร้างบทบาทใหม่ให้เสร็จสิ้น

เพิ่มบทบาทที่กำหนดเองที่สร้างขึ้นไปยังบัญชีผู้ใช้/บริการในหน้า IAM ดังนี้

1. ใน IAM และ แผงการดูแลระบบ ให้เลือก IAM
2. เลือกบริการหรือบัญชีผู้ใช้จากรายการสมาชิกเพื่อแก้ไข
3. คลิกเพิ่มบทบาทอื่น
4. ค้นหาบทบาทใหม่ที่กำหนดเองที่สร้างไว้ก่อนหน้านี้
5. คลิกบันทึก

คำเตือน: ห้ามใช้บทบาท Editor เป็นวิธีในการเพิ่ม firebaseauth.configs.getHashConfig บทบาทที่ทรงพลังนี้ทำให้ สิทธิ์นอกเหนือจากขอบเขตที่ตั้งใจไว้