Firebase Admin SDK'sı, Firebase Authentication kullanıcılarınızı üst düzey ayrıcalıklarla yönetmek için bir API sağlar. Yönetici kullanıcı yönetimi API'si, aşağıdaki görevleri güvenli bir sunucu ortamından programatik olarak tamamlamanıza olanak tanır:
- Herhangi bir kısıtlama veya sıklık sınırlaması olmadan yeni kullanıcılar oluşturun.
- Kullanıcıları kullanıcı kimliği, e-posta veya telefon numarası gibi farklı ölçütlere göre arama
- Belirtilen bir projenin tüm kullanıcılarını toplu olarak listeler.
- Hesap oluşturma tarihi ve son oturum açma tarihi dahil olmak üzere kullanıcı meta verilerine erişme
- Mevcut şifrelerini istemeden kullanıcıları silme
- Kullanıcı olarak oturum açmak zorunda kalmadan şifreleri de dahil olmak üzere kullanıcı özelliklerini güncelleyebilirsiniz.
- E-postaları doğrulamak için bant dışı işlem akışlarından geçmek zorunda kalmadan e-postaları doğrulayın.
- Bu değişiklikleri iptal etmek için e-posta bağlantıları göndermeden bir kullanıcının e-posta adresini değiştirme
- SMS doğrulama akışından geçmek zorunda kalmadan telefon numarası olan yeni bir kullanıcı oluşturun.
- SMS doğrulama akışından geçmek zorunda kalmadan kullanıcının telefon numarasını değiştirme
- Kullanıcıların temel hazırlığını çevrimdışı olarak devre dışı durumda yapın ve daha sonra ne zaman etkinleştirileceğini kontrol edin.
- Belirli bir uygulamanın kullanıcı yönetimi sistemine göre uyarlanmış özel kullanıcı konsolları oluşturun.
Başlamadan önce
Firebase Admin SDK tarafından sağlanan kullanıcı yönetimi API'sini kullanmak için bir hizmet hesabınız olmalıdır. Admin SDK'yı ilk kullanıma hazırlama hakkında daha fazla bilgi için kurulum talimatlarını uygulayın.
Kullanıcı verilerini alma
Kullanıcıyı tanımlamanın birincil yolu, kullanıcıya ait benzersiz bir tanımlayıcı olan uid değeridir. Admin SDK, kullanıcıların profil bilgilerini uid ile getiren bir yöntem sunar:
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}");
Bu yöntem, yönteme sağlanan uid değerine karşılık gelen kullanıcı için bir UserRecord nesnesi döndürür.
Sağlanan uid mevcut bir kullanıcıya ait değilse veya kullanıcı başka bir nedenle getirilemiyorsa yukarıdaki yöntem bir hata verir.
Açıklamalar ve çözüm adımları da dahil olmak üzere hata kodlarının tam listesi için Admin Auth API Hataları başlıklı makaleyi inceleyin.
Bazı durumlarda, kullanıcının uid bilgisi yerine e-posta adresi elinizde olabilir. Firebase Admin SDK'sı, e-posta adresiyle kullanıcı bilgilerini aramayı destekler:
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}");
Bu yöntem, sağlanan e-posta adresine karşılık gelen kullanıcı için bir UserRecord nesnesi döndürür.
Sağlanan e-posta adresi mevcut bir kullanıcıya ait değilse veya kullanıcı başka bir nedenle getirilemiyorsa Admin SDK bir hata verir. Açıklamalar ve çözüm adımları da dahil olmak üzere hata kodlarının tam listesi için Admin Authentication API Hataları başlıklı makaleyi inceleyin.
Diğer durumlarda, kullanıcının uid yerine telefon numarasına sahip olursunuz. Firebase Admin SDK'sı, telefon numarasıyla kullanıcı bilgilerini aramayı destekler:
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}");
Bu yöntem, sağlanan telefon numarasına karşılık gelen kullanıcı için bir UserRecord nesnesi döndürür.
Sağlanan telefon numarası mevcut bir kullanıcıya ait değilse veya kullanıcı başka bir nedenle getirilemiyorsa Admin SDK bir hata verir. Açıklamalar ve çözüm adımları da dahil olmak üzere hata kodlarının tam listesi için Admin Authentication API Hataları başlıklı makaleyi inceleyin.
Kullanıcı verilerini toplu olarak alma
Firebase Admin SDK'sı, sağladığınız tanımlayıcılara göre kullanıcı listesi almanıza da olanak tanır. Kullanıcıları kullanıcı kimliği, e-posta adresi veya telefon numarasıyla tanımlayabilirsiniz. Tek bir çağrıda en fazla 100 tanımlayıcı sağlanabilir. Tanımlayıcılar farklı türlerin bir karışımını içerebilir:
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}");
}
Bu yöntem, giriş listesiyle aynı boyutta bir liste döndürür. Her giriş, ilgili UserRecord değerini veya bu tanımlayıcının neden aranamadığını belirten bir hata içerir. Açıklamalar ve çözüm adımları da dahil olmak üzere hata kodlarının tam listesi için Admin Authentication API Hataları başlıklı makaleyi inceleyin.
Kullanıcı oluşturma
Admin SDK, yeni bir Firebase Authentication kullanıcısı oluşturmanıza olanak tanıyan bir yöntem sunar. Bu yöntem, yeni oluşturulan kullanıcı hesabına dahil edilecek profil bilgilerini içeren bir nesneyi kabul eder:
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}");
Varsayılan olarak Firebase Authentication, yeni kullanıcı için rastgele bir uid oluşturur. Yeni kullanıcı için kendi uid değerinizi belirtmek istiyorsanız bunu kullanıcı oluşturma yöntemine iletilen bir bağımsız değişken olarak ekleyebilirsiniz:
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}");
Aşağıdaki özelliklerin herhangi bir kombinasyonu sağlanabilir:
Tablo 1. Kullanıcı oluşturma işlemi tarafından desteklenen özellikler
| Özellik | Tür | Açıklama |
|---|---|---|
uid |
dize |
Yeni oluşturulan kullanıcıya atanacak uid. 1-128 karakter uzunluğunda (bu değerler dahil) bir dize olmalıdır. Belirtilmezse rastgele bir uid otomatik olarak oluşturulur. Daha kısa uids daha iyi performans sağlar.
|
email |
dize | Kullanıcının birincil e-posta adresi. Geçerli bir e-posta adresi olmalı. |
emailVerified |
boole |
Kullanıcının birincil e-posta adresinin doğrulanıp doğrulanmadığı. Belirtilmezse varsayılan değer false olur.
|
phoneNumber |
dize | Kullanıcının birincil telefon numarası. E.164 spesifikasyonuna uygun geçerli bir telefon numarası olmalıdır. |
password |
dize | Kullanıcının ham, karma oluşturulmamış şifresi. En az altı karakter uzunluğunda olmalıdır. |
displayName |
dize | Kullanıcıların görünen adı. |
photoURL |
dize | Kullanıcının fotoğraf URL'si. |
disabled |
boole |
Kullanıcının devre dışı bırakılıp bırakılmadığı. Devre dışı için true;
etkin için false. Belirtilmezse varsayılan değer false olur.
|
Kullanıcı oluşturma yöntemi, yeni oluşturulan kullanıcı için bir UserRecord nesnesi döndürür.
Sağlanan uid, e-posta veya telefon numarası mevcut bir kullanıcı tarafından kullanılıyorsa ya da kullanıcı başka bir nedenle oluşturulamıyorsa yukarıdaki yöntem hata verir. Açıklamalar ve çözüm adımları da dahil olmak üzere hata kodlarının tam listesi için Admin Authentication API Hataları başlıklı makaleyi inceleyin.
Kullanıcı güncelleme
Firebase Admin SDK'sı, mevcut bir kullanıcının verilerini değiştirmeyi kolaylaştırır. Kullanıcı için güncellenecek özelliklerle birlikte bir uid belirtmeniz gerekir:
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}");
Aşağıdaki özelliklerin herhangi bir kombinasyonu sağlanabilir:
Tablo 2. Kullanıcı güncelleme işlemi tarafından desteklenen özellikler
| Özellik | Tür | Açıklama |
|---|---|---|
email |
dize | Kullanıcının yeni birincil e-posta adresi. Geçerli bir e-posta adresi olmalı. |
emailVerified |
boole |
Kullanıcının birincil e-posta adresinin doğrulanıp doğrulanmadığı. Belirtilmezse varsayılan değer false olur.
|
phoneNumber |
dize | null |
Kullanıcının yeni birincil telefon numarası. E.164 spesifikasyonuna uygun geçerli bir telefon numarası olmalıdır. Kullanıcının mevcut telefon numarasını temizlemek için null olarak ayarlayın.
|
password |
dize | Kullanıcının yeni ham, karma oluşturulmamış şifresi. En az altı karakter uzunluğunda olmalıdır. |
displayName |
dize | null |
Kullanıcıların yeni görünen adı. Kullanıcının mevcut görünen adını temizlemek için null olarak ayarlayın.
|
photoURL |
dize | null |
Kullanıcıların yeni fotoğraf URL'si. Kullanıcının mevcut fotoğraf URL'sini temizlemek için null değerine ayarlayın. null değilse geçerli bir URL olmalıdır.
|
disabled |
boole |
Kullanıcının devre dışı bırakılıp bırakılmadığı. Devre dışı için true;
etkin için false.
|
Kullanıcı güncelleme yöntemi, güncelleme başarıyla tamamlandığında güncellenmiş bir UserRecord nesnesi döndürür.
Sağlanan uid mevcut bir kullanıcıya karşılık gelmiyorsa, sağlanan e-posta veya telefon numarası mevcut bir kullanıcı tarafından zaten kullanılıyorsa ya da kullanıcı başka bir nedenle güncellenemiyorsa yukarıdaki yöntem hata vererek başarısız olur. Açıklamalar ve çözüm adımları da dahil olmak üzere hata kodlarının tam listesi için Admin Authentication API Hataları başlıklı makaleyi inceleyin.
Kullanıcı silme
Firebase Admin SDK'sı, mevcut kullanıcıları uid ile silmenize olanak tanır:
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.");
Kullanıcı silme yöntemi, silme işlemi başarıyla tamamlandığında boş bir sonuç döndürür.
Sağlanan uid mevcut bir kullanıcıya karşılık gelmiyorsa veya kullanıcı başka bir nedenle silinemiyorsa kullanıcı silme yöntemi hata verir.
Açıklamalar ve çözüm adımları da dahil olmak üzere hata kodlarının tam listesi için Admin Authentication API Hataları başlıklı makaleyi inceleyin.
Birden Fazla Kullanıcıyı Silme
Firebase Admin SDK'sı, birden fazla kullanıcıyı aynı anda silebilir. Ancak birden fazla kullanıcıyı aynı anda silmek için deleteUsers(uids) gibi yöntemler kullanıldığında Cloud Functions for Firebase için onDelete() etkinlik işleyicileri tetiklenmez.
Bunun nedeni, toplu silme işleminin her kullanıcı için bir kullanıcı silme etkinliği tetiklememesidir. Kullanıcı silme etkinliklerinin her silinen kullanıcı için tetiklenmesini istiyorsanız kullanıcıları tek tek silin.
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}");
}
Kullanıcı silme yöntemi, silinemeyen kullanıcılar için bir hata listesi döndürür. Açıklamalar ve çözüm adımları da dahil olmak üzere hata kodlarının tam listesi için Admin Authentication API Hataları başlıklı makaleyi inceleyin.
Tüm kullanıcıları listeleme
Firebase Admin SDK'sı, kullanıcı listesinin tamamını gruplar halinde almanıza olanak tanır:
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}");
}
Her sonuç grubu, bir kullanıcı listesi ve bir sonraki kullanıcı grubunu listelemek için kullanılan sonraki sayfa jetonunu içerir. Tüm kullanıcılar listelendiğinde pageToken döndürülmez.
maxResults alanı belirtilmezse grup başına varsayılan 1.000 kullanıcı kullanılır.
Bu, aynı zamanda bir kerede listelenmesine izin verilen maksimum kullanıcı sayısıdır. Maksimum değerden büyük olan tüm değerler bağımsız değişken hatası verir.
pageToken belirtilmezse işlem, kullanıcıları baştan itibaren uid ölçütüne göre sıralayarak listeler.
Açıklamalar ve çözüm adımları da dahil olmak üzere hata kodlarının tam listesi için Admin Authentication API Hataları başlıklı makaleyi inceleyin.
Listelenen kullanıcıların şifre karmaları
Bu API, istek OAuth erişim jetonunu oluşturmak için kullanılan kullanıcı/hizmet hesabı firebaseauth.configs.getHashConfig iznine sahipse şifre kullanıcıları için Firebase Auth arka ucu tarafından karma hale getirilen passwordSalt ve passwordHash değerlerini de döndürür. Aksi takdirde passwordHash ve passwordSalt ayarlanmaz.
Şifre karmalarının hassas yapısı nedeniyle Firebase Admin SDK hizmet hesabının varsayılan olarak firebaseauth.configs.getHashConfig izni yoktur. Bir kullanıcı/hizmet hesabına doğrudan izin ekleyemezsiniz ancak özel bir IAM rolü oluşturarak bunu dolaylı olarak yapabilirsiniz.
Özel IAM rolünü oluşturmak için:
- Google Cloud konsolundaki IAM ve yönetici panelinde Roller sayfasına gidin.
- Sayfanın üst kısmındaki açılır menüden projenizi seçin.
- ROL OLUŞTUR'u tıklayın.
- ADD PERMISSIONS'ı (İzin ekle) tıklayın.
firebaseauth.configs.getHashConfigiznini arayın ve bu onay kutusunu işaretleyin.- EKLE'yi tıklayın.
- Yeni rolü oluşturma işlemini tamamlamak için OLUŞTUR'u tıklayın.
Oluşturulan özel rolü IAM sayfasındaki kullanıcı/hizmet hesabına ekleyin:
- IAM ve yönetici panelinde IAM'i seçin.
- Düzenlemek için üye listesinden hizmet veya kullanıcı hesabını seçin.
- BAŞKA BİR ROL EKLE'yi tıklayın.
- Daha önce oluşturulan yeni özel rolü arayın.
- KAYDET'i tıklayın.