Firebase Admin SDK, kullanıcılarınızı yüksek ayrıcalıklarla yönetmek için bir API sağlar.Firebase Authentication Yönetici kullanıcı yönetimi API'si, güvenli bir sunucu ortamından aşağıdaki görevleri programlı olarak tamamlamanızı sağlar:
- Hızlandırma veya hız sınırlaması olmadan yeni kullanıcılar oluşturun.
- Kullanıcıları benzersiz kimlik, e-posta veya telefon numarası gibi farklı ölçütlere göre arayın.
- Belirtilen bir projenin tüm kullanıcılarını gruplar halinde listeleyin.
- Hesap oluşturma tarihi ve son oturum açma tarihi gibi kullanıcı meta verilerine erişme
- Mevcut şifrelerini girmelerini gerektirmeden kullanıcıları silme
- Kullanıcı olarak oturum açmak zorunda kalmadan kullanıcı özelliklerini (şifreleri dahil) güncelleyin.
- 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 kullanıcının e-posta adresini değiştirin.
- SMS doğrulama akışını tamamlamak zorunda kalmadan telefon numarası içeren yeni bir kullanıcı oluşturun.
- SMS doğrulama akışını tamamlamak zorunda kalmadan kullanıcının telefon numarasını değiştirin.
- Kullanıcıları devre dışı durumda çevrimdışı olarak hazırlayın ve daha sonra ne zaman etkinleştirileceğini kontrol edin.
- Belirli bir uygulamanın kullanıcı yönetimi sistemine özel özel kullanıcı konsolları oluşturun.
Başlamadan önce
Firebase Admin SDK'sı tarafından sağlanan kullanıcı yönetimi API'sini kullanmak için bir hizmet hesabınız olmalıdır. Yönetici SDK'sını ilk kullanıma hazırlama hakkında daha fazla bilgi için kurulum talimatlarını uygulayın.
Kullanıcı verilerini alma
Kullanıcıları tanımlamanın birincil yolu, kullanıcının benzersiz tanımlayıcısı olan uid
'dir. Yönetici SDK'sı, kullanıcıların profil bilgilerini uid
özelliklerine göre getirmeyi sağlayan bir yöntem sağlar:
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('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)
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ı 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
yerine e-posta adresini alırsınız. Firebase Yönetici SDK'sı, e-posta ile 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('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)
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-postaya karşılık gelen kullanıcı için bir UserRecord
nesnesi döndürür.
Sağlanan e-posta mevcut bir kullanıcıya ait değilse veya kullanıcı başka bir nedenle getirilemiyorsa Yönetici SDK'sı hata verir. Açıklamalar ve çözüm adımları dahil olmak üzere hata kodlarının tam listesi için Yönetici Authentication API Hataları başlıklı makaleyi inceleyin.
Diğer durumlarda, kullanıcının uid
yerine telefon numarasını alırsınız. Firebase Admin SDK, 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('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)
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 Yönetici SDK'sı hata verir. Açıklamalar ve çözüm adımları dahil olmak üzere hata kodlarının tam listesi için Yönetici 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ı listesinin alınmasına da olanak tanır. Kullanıcıları kullanıcı kimliklerine, e-postalarına veya telefon numaralarına göre tanımlayabilirsiniz. Tek bir çağrıda en fazla 100 tanımlayıcı sağlanabilir. Tanımlayıcılar farklı türleri 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şte, ilgili UserRecord
veya bu tanımlayıcının neden aranamadığını belirten bir hata yer alır. Açıklamalar ve çözüm adımları dahil olmak üzere hata kodlarının tam listesi için Admin Authentication API Hataları başlıklı makaleyi inceleyin.
Kullanıcı oluşturma
Yönetici SDK'sı, yeni bir Firebase Authentication kullanıcısı oluşturmanıza olanak tanıyan bir yöntem sağlar. Bu yöntem, yeni oluşturulan kullanıcı hesabına eklenecek profil bilgilerini içeren bir nesne 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('Sucessfully created new user: {0}'.format(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. Bunun yerine yeni kullanıcı için kendi uid
değerinizi belirtmek isterseniz 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('Sucessfully created new user: {0}'.format(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 ila 128 karakter uzunluğunda bir dize olmalıdır. Bu değer sağlanmazsa otomatik olarak rastgele bir uid oluşturulur. Daha kısa uid s daha iyi performans sunar.
|
email |
dize | Kullanıcının birincil e-postası. Geçerli bir e-posta adresi olmalı. |
emailVerified |
boolean |
Kullanıcının birincil e-postasının doğrulanıp doğrulanmadığı. Değer belirtilmezse varsayılan olarak false değeri kullanılır.
|
phoneNumber |
dize | Kullanıcının birincil telefon numarası. Geçerli bir E.164 spesifikasyonu uyumlu telefon numarası olmalıdır. |
password |
dize | Kullanıcının şifresi karma oluşturma işlemi uygulanmadan, ham olarak gönderilir. 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 |
boolean |
Kullanıcının devre dışı olup olmadığı. Devre dışı için true ,
Etkin için false . Belirtilmezse varsayılan olarak false değeri kullanılır.
|
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ı zaten mevcut bir kullanıcı tarafından kullanılıyorsa ya da kullanıcı başka bir nedenle oluşturulamıyorsa yukarıdaki yöntem bir hatayla başarısız olur. Açıklamalar ve çözüm adımları dahil olmak üzere hata kodlarının tam listesi için Yönetici Authentication API Hataları bölümüne bakın.
Kullanıcıyı güncelleme
Firebase Yönetici SDK'sı, mevcut bir kullanıcının verilerini değiştirmeyi kolaylaştırır. Söz konusu 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('Sucessfully updated user: {0}'.format(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-postası. Geçerli bir e-posta adresi olmalı. |
emailVerified |
boolean |
Kullanıcının birincil e-postasının doğrulanıp doğrulanmadığı. Değer belirtilmezse varsayılan olarak false değeri kullanılır.
|
phoneNumber |
dize |
Kullanıcının yeni birincil telefon numarası. Geçerli bir E.164 spesifikasyonu uyumlu 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, karma oluşturma işlemi uygulanmamış ş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 olarak ayarlayın. null değilse geçerli bir URL olmalıdır.
|
disabled |
boolean |
Kullanıcının devre dışı olup olmadığı. Devre dışı için true ,
Etkin için false .
|
Güncelleme kullanıcı 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 kullanılıyorsa ya da kullanıcı başka bir nedenle güncellenemiyorsa yukarıdaki yöntem bir hatayla başarısız olur. Açıklamalar ve çözüm adımları 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
özelliklerine göre 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.");
Silme işlemi başarıyla tamamlandığında delete user yöntemi 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ıyı silme yöntemi hata verir.
Açıklamalar ve çözüm adımları dahil olmak üzere hata kodlarının tam listesi için Yönetici Authentication API Hataları başlıklı makaleyi inceleyin.
Birden Çok Kullanıcıyı Silme
Firebase Admin SDK'sı birden fazla kullanıcıyı tek seferde de silebilir. Ancak birden fazla kullanıcıyı tek seferde silmek için deleteUsers(uids)
gibi yöntemlerin kullanılmasının, Cloud Functions for Firebase için onDelete()
etkinlik işleyicilerini tetiklemeyeceğini unutmayın.
Bunun nedeni, toplu silme işleminin her kullanıcıda bir kullanıcı silme etkinliği tetiklememesidir. Silinen her kullanıcı için kullanıcı silme etkinliklerinin 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('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 yöntemi, silinemeyen kullanıcılarla ilgili hataların listesini döndürür. Açıklamalar ve çözüm adımları dahil olmak üzere hata kodlarının tam listesi için Yönetici Authentication API Hataları başlıklı makaleyi inceleyin.
Tüm kullanıcıları listeleme
Firebase Admin SDK, kullanıcı listesinin tamamını toplu olarak 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, kullanıcıların listesini ve sonraki kullanıcı grubunu listelemek için kullanılan bir sonraki sayfa jetonunu içerir. Tüm kullanıcılar listelendiğinde pageToken
döndürülmez.
maxResults
alanı belirtilmezse varsayılan olarak grup başına 1.000 kullanıcı kullanılır.
Bu, aynı anda listelenebilecek maksimum kullanıcı sayısıdır. Maksimum değerden büyük herhangi bir değer bağımsız değişken hatası oluşturur.
pageToken
belirtilmezse işlem, kullanıcıları baştan uid
'e göre sıralayarak listeler.
Açıklamalar ve çözüm adımları dahil olmak üzere hata kodlarının tam listesi için Yönetici 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ının firebaseauth.configs.getHashConfig
iznine sahip olması durumunda, şifre kullanıcıları için Firebase Auth arka ucu tarafından karma oluşturma işlemi uygulanmış 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. Doğrudan bir kullanıcıya/hizmet hesabına izin ekleyemezsiniz ancak özel bir IAM rolü oluşturarak dolaylı olarak ekleyebilirsiniz.
Ö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.
- İZİN EKLE'yi tıklayın.
firebaseauth.configs.getHashConfig
iznini arayın ve onay kutusunu seçin.- EKLE'yi tıklayın.
- Yeni rolü oluşturmayı tamamlamak için OLUŞTUR'u tıklayın.
Oluşturulan özel rolü IAM sayfasındaki kullanıcıya/hizmet hesabına ekleyin:
- IAM ve yönetici panelinde IAM'i seçin.
- Düzenlemek istediğiniz hizmeti veya kullanıcı hesabını üye listesinden 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.