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

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 จะแสดงข้อผิดพลาด ดูรายการรหัสข้อผิดพลาดทั้งหมด รวมถึงคำอธิบายและขั้นตอนการแก้ปัญหาได้ที่ข้อผิดพลาด Authentication API ของผู้ดูแลระบบ

คำเตือน: สำหรับการค้นหาอีเมล คุณจะค้นหาได้เฉพาะอีเมลหลัก (ระดับบนสุด) เท่านั้น และไม่สามารถค้นหาอีเมลของผู้ให้บริการที่เฉพาะเจาะจง เช่น หากบัญชี 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 จะแสดงข้อผิดพลาด ดูรายการรหัสข้อผิดพลาดทั้งหมด รวมถึงคำอธิบายและขั้นตอนการแก้ปัญหาได้ที่ข้อผิดพลาด Authentication API ของผู้ดูแลระบบ

ดึงข้อมูลผู้ใช้หลายรายการพร้อมกัน

นอกจากนี้ 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 ที่เกี่ยวข้องหรือข้อผิดพลาดที่ระบุสาเหตุที่ค้นหาตัวระบุนั้นไม่ได้ ดูรายการรหัสข้อผิดพลาดทั้งหมด รวมถึงคำอธิบายและขั้นตอนการแก้ปัญหาได้ที่ข้อผิดพลาดของ Authentication API สำหรับผู้ดูแลระบบ

สร้างผู้ใช้

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 ของคุณเองสําหรับผู้ใช้ใหม่ ให้รวม uid นั้นไว้เป็นอาร์กิวเมนต์ที่ส่งไปยังเมธอดการสร้างผู้ใช้ ดังนี้

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, อีเมล หรือหมายเลขโทรศัพท์ที่ระบุอยู่แล้ว หรือสร้างผู้ใช้ไม่ได้เนื่องจากเหตุผลอื่นๆ วิธีการข้างต้นจะดำเนินการไม่สำเร็จและแสดงข้อผิดพลาด ดูรายการรหัสข้อผิดพลาดทั้งหมด รวมถึงคำอธิบายและขั้นตอนการแก้ปัญหาได้ที่ข้อผิดพลาด Authentication API ของผู้ดูแลระบบ

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

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

ลบผู้ใช้

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 ที่ระบุไม่ตรงกับผู้ใช้ที่มีอยู่หรือลบผู้ใช้ไม่ได้ด้วยเหตุผลอื่นๆ วิธีการลบผู้ใช้จะแสดงข้อผิดพลาด ดูรายการรหัสข้อผิดพลาดทั้งหมด รวมถึงคำอธิบายและขั้นตอนการแก้ปัญหาได้ที่ข้อผิดพลาด Authentication API ของผู้ดูแลระบบ

ลบผู้ใช้หลายราย

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

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

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

แสดงรายการผู้ใช้ทั้งหมด

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

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

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

นอกจากนี้ API นี้จะแสดงผล passwordSalt และ passwordHash ที่ผ่านการแฮชโดยแบ็กเอนด์ Firebase Auth สําหรับผู้ใช้รหัสผ่านด้วย หากบัญชีผู้ใช้/บัญชีบริการที่ใช้สร้างคําขอโทเค็นการเข้าถึง 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 บทบาทที่มีประสิทธิภาพนี้ให้สิทธิ์เกินขอบเขตที่ต้องการ