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);
});
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(f'Successfully fetched user data: {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)
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);
});
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(f'Successfully fetched user data: {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)
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 จะแสดงข้อผิดพลาด ดูรายการรหัสข้อผิดพลาดทั้งหมด รวมถึงคำอธิบาย และขั้นตอนการแก้ไขได้ที่ข้อผิดพลาดของ Admin Authentication API
ในกรณีอื่นๆ คุณจะมีหมายเลขโทรศัพท์ของผู้ใช้แทน 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);
});
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(f'Successfully fetched user data: {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)
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
สำหรับ
ผู้ใช้ที่ตรงกับหมายเลขโทรศัพท์ที่ระบุ
หากหมายเลขโทรศัพท์ที่ระบุไม่ได้เป็นของผู้ใช้ที่มีอยู่ หรือไม่สามารถดึงข้อมูลผู้ใช้ได้ด้วยเหตุผลอื่นใด SDK ผู้ดูแลระบบจะแสดงข้อผิดพลาด ดูรายการรหัสข้อผิดพลาดทั้งหมด รวมถึงคำอธิบาย และขั้นตอนการแก้ไขได้ที่ข้อผิดพลาดของ Admin Authentication API
ดึงข้อมูลผู้ใช้เป็นกลุ่ม
นอกจากนี้ Firebase Admin SDK ยังช่วยให้คุณดึงรายการผู้ใช้ตามตัวระบุที่คุณระบุได้ด้วย คุณระบุผู้ใช้ได้โดยใช้รหัสผู้ใช้ อีเมล หรือ หมายเลขโทรศัพท์ คุณระบุตัวระบุได้สูงสุด 100 รายการในการเรียกใช้ครั้งเดียว ตัวระบุอาจมีประเภทต่างๆ ผสมกัน ดังนี้
Node.js
getAuth()
.getUsers([
{ uid: 'uid1' },
{ email: 'user2@example.com' },
{ phoneNumber: '+15555550003' },
{ 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);
});
Java
GetUsersResult result = FirebaseAuth.getInstance().getUsersAsync(Arrays.asList(
new UidIdentifier("uid1"),
new EmailIdentifier("user2@example.com"),
new PhoneIdentifier("+15555550003"),
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('user2@example.com'),
auth.PhoneIdentifier(+15555550003),
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: "user@example.com"},
auth.PhoneIdentifier{PhoneNumber: "+15555551234"},
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("user2@example.com"),
new PhoneIdentifier("+15555550003"),
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
ที่เกี่ยวข้องหรือข้อผิดพลาดที่ระบุสาเหตุ
ที่ค้นหาตัวระบุนั้นไม่ได้ ดูรายการรหัสข้อผิดพลาดทั้งหมด
รวมถึงคำอธิบายและขั้นตอนการแก้ไขได้ที่ข้อผิดพลาดของ Admin Authentication API
สร้างผู้ใช้
Admin SDK มีเมธอดที่ ช่วยให้คุณสร้างผู้ใช้ Firebase Authentication ใหม่ได้ เมธอดนี้ยอมรับ ออบเจ็กต์ที่มีข้อมูลโปรไฟล์ที่จะรวมไว้ใน บัญชีผู้ใช้ที่สร้างขึ้นใหม่
Node.js
getAuth()
.createUser({
email: 'user@example.com',
emailVerified: false,
phoneNumber: '+11234567890',
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);
});
Java
CreateRequest request = new CreateRequest()
.setEmail("user@example.com")
.setEmailVerified(false)
.setPassword("secretPassword")
.setPhoneNumber("+11234567890")
.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='user@example.com',
email_verified=False,
phone_number='+15555550100',
password='secretPassword',
display_name='John Doe',
photo_url='http://www.example.com/12345678/photo.png',
disabled=False)
print(f'Sucessfully created new user: {user.uid}')
Go
params := (&auth.UserToCreate{}).
Email("user@example.com").
EmailVerified(false).
PhoneNumber("+15555550100").
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)
C#
UserRecordArgs args = new UserRecordArgs()
{
Email = "user@example.com",
EmailVerified = false,
PhoneNumber = "+11234567890",
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
ของคุณเองสำหรับผู้ใช้ใหม่ ให้ระบุเป็นอาร์กิวเมนต์ที่ส่งไปยังเมธอดการสร้างผู้ใช้
Node.js
getAuth()
.createUser({
uid: 'some-uid',
email: 'user@example.com',
phoneNumber: '+11234567890',
})
.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);
});
Java
CreateRequest request = new CreateRequest()
.setUid("some-uid")
.setEmail("user@example.com")
.setPhoneNumber("+11234567890");
UserRecord userRecord = FirebaseAuth.getInstance().createUser(request);
System.out.println("Successfully created new user: " + userRecord.getUid());
Python
user = auth.create_user(
uid='some-uid', email='user@example.com', phone_number='+15555550100')
print(f'Sucessfully created new user: {user.uid}')
Go
params := (&auth.UserToCreate{}).
UID(uid).
Email("user@example.com").
PhoneNumber("+15555550100")
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)
C#
UserRecordArgs args = new UserRecordArgs()
{
Uid = "some-uid",
Email = "user@example.com",
PhoneNumber = "+11234567890",
};
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
อีเมล หรือหมายเลขโทรศัพท์ที่ระบุมีการใช้งานอยู่แล้วโดยผู้ใช้ที่มีอยู่ หรือสร้างผู้ใช้ไม่ได้ด้วยเหตุผลอื่นใด วิธีข้างต้นจะล้มเหลวพร้อมข้อผิดพลาด ดูรายการรหัสข้อผิดพลาดทั้งหมด รวมถึง
คำอธิบายและขั้นตอนการแก้ไขได้ที่ข้อผิดพลาดของ Admin Authentication API
อัปเดตผู้ใช้
Firebase Admin SDK ช่วยให้แก้ไขข้อมูลของผู้ใช้ที่มีอยู่ได้ คุณต้อง
ระบุ uid
พร้อมกับพร็อพเพอร์ตี้ที่จะอัปเดตสำหรับผู้ใช้รายนั้น
Node.js
getAuth()
.updateUser(uid, {
email: 'modifiedUser@example.com',
phoneNumber: '+11234567890',
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);
});
Java
UpdateRequest request = new UpdateRequest(uid)
.setEmail("user@example.com")
.setPhoneNumber("+11234567890")
.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='user@example.com',
phone_number='+15555550100',
email_verified=True,
password='newPassword',
display_name='John Doe',
photo_url='http://www.example.com/12345678/photo.png',
disabled=True)
print(f'Sucessfully updated user: {user.uid}')
Go
params := (&auth.UserToUpdate{}).
Email("user@example.com").
EmailVerified(true).
PhoneNumber("+15555550100").
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)
C#
UserRecordArgs args = new UserRecordArgs()
{
Uid = uid,
Email = "modifiedUser@example.com",
PhoneNumber = "+11234567890",
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
ที่ระบุไม่ตรงกับผู้ใช้ที่มีอยู่ อีเมลหรือหมายเลขโทรศัพท์ที่ระบุถูกผู้ใช้ที่มีอยู่ใช้งานอยู่แล้ว หรืออัปเดตผู้ใช้ไม่ได้ด้วยเหตุผลอื่นใด วิธีข้างต้นจะล้มเหลวพร้อมข้อผิดพลาด ดูรายการรหัสข้อผิดพลาดทั้งหมด รวมถึงคำอธิบายและขั้นตอนการแก้ไขได้ที่ข้อผิดพลาดของ Admin 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);
});
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)
C#
await FirebaseAuth.DefaultInstance.DeleteUserAsync(uid);
Console.WriteLine("Successfully deleted user.");
เมธอด delete user จะแสดงผลลัพธ์ที่ว่างเปล่าเมื่อการลบเสร็จสมบูรณ์ เรียบร้อยแล้ว
หาก uid
ที่ระบุไม่ตรงกับผู้ใช้ที่มีอยู่ หรือลบผู้ใช้ไม่ได้ด้วยเหตุผลอื่นใด เมธอดลบผู้ใช้จะแสดงข้อผิดพลาด
ดูรายการรหัสข้อผิดพลาดทั้งหมด รวมถึงคำอธิบาย
และขั้นตอนการแก้ไขได้ที่ข้อผิดพลาดของ Admin 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(f'Successfully deleted {result.success_count} users')
print(f'Failed to delete {result.failure_count} users')
for err in result.errors:
print(f'error #{result.index}, reason: {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 จะแสดงรายการความล้มเหลวสำหรับผู้ใช้ที่ ลบไม่ได้ ดูรายการรหัสข้อผิดพลาดทั้งหมด รวมถึงคำอธิบาย และขั้นตอนการแก้ไขได้ที่ข้อผิดพลาดของ Admin 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();
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
}
}
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
ดูรายการรหัสข้อผิดพลาดทั้งหมด รวมถึงคำอธิบาย และขั้นตอนการแก้ไขได้ที่ข้อผิดพลาดของ Admin Authentication API
แฮชรหัสผ่านของผู้ใช้ที่ระบุ
นอกจากนี้ API นี้ยังแสดง passwordSalt
และ passwordHash
ที่แฮชโดยแบ็กเอนด์ Firebase Auth สำหรับผู้ใช้รหัสผ่าน หากผู้ใช้/บัญชีบริการที่ใช้สร้างโทเค็นการเข้าถึง OAuth ของคำขอมีสิทธิ์ firebaseauth.configs.getHashConfig
ไม่เช่นนั้น ระบบจะไม่ตั้งค่า passwordHash
และ passwordSalt
เนื่องจากแฮชรหัสผ่านเป็นข้อมูลที่ละเอียดอ่อน บัญชีบริการ Firebase Admin SDK จึงไม่มีสิทธิ์ firebaseauth.configs.getHashConfig
โดยค่าเริ่มต้น คุณเพิ่มสิทธิ์ให้กับบัญชีผู้ใช้/บัญชีบริการโดยตรงไม่ได้ แต่ทำได้โดยอ้อมด้วยการสร้างบทบาท IAM ที่กำหนดเอง
วิธีสร้างบทบาท IAM ที่กำหนดเอง
- ไปที่หน้าบทบาทในแผง IAM และผู้ดูแลระบบใน Google Cloud คอนโซล
- เลือกโปรเจ็กต์จากเมนูแบบเลื่อนลงที่ด้านบนของหน้า
- คลิกสร้างบทบาท
- คลิกเพิ่มสิทธิ์
- ค้นหา
firebaseauth.configs.getHashConfig
สิทธิ์ แล้วเลือกช่องทำเครื่องหมายนั้น - คลิกเพิ่ม
- คลิกสร้างเพื่อสร้างบทบาทใหม่ให้เสร็จสมบูรณ์
เพิ่มบทบาทที่กำหนดเองที่สร้างขึ้นให้กับบัญชีผู้ใช้/บัญชีบริการในหน้า IAM โดยทำดังนี้
- ในแผง IAM และผู้ดูแลระบบ ให้เลือก IAM
- เลือกบัญชีบริการหรือบัญชีผู้ใช้จากรายชื่อสมาชิกเพื่อแก้ไข
- คลิกเพิ่มบทบาทอื่น
- ค้นหาบทบาทที่กำหนดเองใหม่ที่สร้างไว้ก่อนหน้านี้
- คลิกบันทึก