إدارة المستخدمين

يوفّر مدير SDK في Firebase واجهة برمجة تطبيقات لإدارة مستخدمي Firebase Authentication الذين لديهم أذونات مميزة وعالية المستوى. تتيح لك واجهة برمجة التطبيقات لإدارة المستخدمين المشرفين إكمال المهام التالية آليًا من بيئة خادم آمنة:

  • إنشاء مستخدمين جُدد بدون أي تقييد أو تحديد للسرعة
  • ابحث عن المستخدمين حسب معايير مختلفة، مثل رقم تعريف المستخدم أو البريد الإلكتروني أو رقم الهاتف.
  • تتيح هذه الطريقة عرض قائمة بجميع مستخدمي مشروع محدّد على دفعات.
  • الوصول إلى البيانات الوصفية للمستخدم، بما في ذلك تاريخ إنشاء الحساب وتاريخ آخر تسجيل دخول
  • حذف المستخدمين بدون طلب كلمة المرور الحالية
  • تعديل سمات المستخدم، بما في ذلك كلمة المرور، بدون الحاجة إلى تسجيل الدخول بصفتك المستخدم
  • يمكنك التحقّق من عناوين البريد الإلكتروني بدون الحاجة إلى اتّباع مسارات الإجراءات خارج النطاق للتحقّق من عناوين البريد الإلكتروني.
  • تغيير عنوان البريد الإلكتروني لمستخدم بدون إرسال روابط عبر البريد الإلكتروني لإبطال هذه التغييرات
  • يمكنك إنشاء مستخدم جديد برقم هاتف بدون الحاجة إلى المرور بعملية التحقّق من خلال الرسائل القصيرة.
  • يمكنك تغيير رقم هاتف المستخدم بدون الحاجة إلى إجراء عملية التحقّق من خلال الرسائل القصيرة.
  • يمكنك توفير حسابات المستخدمين بلا إنترنت في حالة غير مفعَّلة، ثم التحكّم لاحقًا في وقت تفعيلها.
  • يمكنك إنشاء وحدات تحكّم مخصّصة للمستخدمين ومصمّمة لتناسب نظام إدارة المستخدمين في تطبيق معيّن.

قبل البدء

لاستخدام واجهة برمجة التطبيقات لإدارة المستخدمين التي يوفّرها مدير SDK في Firebase، يجب أن يكون لديك حساب خدمة. اتّبِع تعليمات الإعداد لمزيد من المعلومات حول كيفية إعداد حزمة SDK للمشرف.

استرداد بيانات المستخدمين

الطريقة الأساسية لتحديد هوية المستخدم هي من خلال uid، وهو معرّف فريد لذلك المستخدم. توفّر حزمة 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}')

متابعة

// 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. يتيح مدير SDK في Firebase البحث عن معلومات المستخدمين باستخدام عنوان بريد إلكتروني:

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}')

متابعة

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 للمستخدم الذي يتوافق مع عنوان البريد الإلكتروني المقدَّم.

إذا لم يكن البريد الإلكتروني المقدَّم ينتمي إلى مستخدم حالي أو تعذّر جلب المستخدم لأي سبب آخر، ستعرض حزمة SDK للمشرف خطأ. للاطّلاع على قائمة كاملة برموز الأخطاء، بما في ذلك الأوصاف وخطوات الحلّ، يُرجى مراجعة أخطاء واجهة برمجة تطبيقات مشرف Authentication.

في حالات أخرى، سيكون لديك رقم هاتف المستخدم بدلاً من uid. يتيح مدير SDK في Firebase البحث عن معلومات المستخدم باستخدام رقم الهاتف:

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}')

متابعة

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 للمشرف خطأ. للاطّلاع على قائمة كاملة برموز الأخطاء، بما في ذلك الأوصاف وخطوات الحلّ، يُرجى مراجعة أخطاء واجهة برمجة تطبيقات مشرف Authentication.

استرداد بيانات المستخدمين بشكل مجمّع

تتيح حزمة تطوير البرامج (SDK) لمشرف Firebase أيضًا استرداد قائمة بالمستخدمين استنادًا إلى المعرّفات التي تقدّمها. يمكنك تحديد المستخدمين من خلال رقم تعريف المستخدم أو البريد الإلكتروني أو رقم الهاتف. يمكن تقديم 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)

متابعة

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 المقابل أو خطأ يشير إلى سبب تعذُّر البحث عن هذا المعرّف. للحصول على قائمة كاملة برموز الأخطاء، بما في ذلك الأوصاف وخطوات الحلّ، يُرجى الاطّلاع على أخطاء واجهة برمجة تطبيقات Authentication للمشرفين.

إنشاء مستخدم

توفّر حزمة 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}')

متابعة

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}')

متابعة

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 المطلوب تعيينه للمستخدم الذي تم إنشاؤه حديثًا يجب أن تكون سلسلة تتراوح بين حرف واحد و128 حرفًا. وفي حال عدم توفيره، سيتم إنشاء uid عشوائي تلقائيًا. وتوفّر قيم uid الأقصر أداءً أفضل.
email سلسلة عنوان البريد الإلكتروني الأساسي للمستخدم يجب إدخال عنوان بريد إلكتروني صالح.
emailVerified قيمة منطقية ما إذا تم تأكيد عنوان البريد الإلكتروني الأساسي للمستخدم أم لا في حال عدم توفيرها، تكون القيمة التلقائية هي false.
phoneNumber سلسلة رقم الهاتف الأساسي للمستخدم يجب أن يكون رقم الهاتف صالحًا ومتوافقًا مع مواصفات E.164.
password سلسلة كلمة مرور المستخدم الأولية غير المجزأة. يجب أن يتألف من ستة أحرف على الأقل.
displayName سلسلة الاسم المعروض للمستخدمين
photoURL سلسلة عنوان URL لصورة المستخدم
disabled قيمة منطقية ما إذا كان المستخدم غير مفعَّل أم لا ‫true إذا كانت غير مفعَّلة false إذا كانت مفعَّلة إذا لم يتم توفيرها، تكون القيمة التلقائية هي false.

تعرض طريقة إنشاء المستخدم عنصر UserRecord للمستخدم الذي تم إنشاؤه حديثًا.

إذا كان uid أو عنوان البريد الإلكتروني أو رقم الهاتف المقدَّم مستخدَمًا من قِبل مستخدم حالي أو إذا تعذّر إنشاء المستخدم لأي سبب آخر، ستفشل الطريقة المذكورة أعلاه مع ظهور رسالة خطأ. للحصول على قائمة كاملة برموز الخطأ، بما في ذلك الأوصاف وخطوات الحلّ، يُرجى الاطّلاع على أخطاء Admin Authentication API.

تعديل مستخدم

تسهّل حزمة SDK الخاصة بمشرف Firebase تعديل بيانات مستخدم حالي. يجب تحديد 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}')

متابعة

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 قيمة منطقية ما إذا تم تأكيد عنوان البريد الإلكتروني الأساسي للمستخدم أم لا في حال عدم توفيرها، تكون القيمة التلقائية هي false.
phoneNumber string | null رقم الهاتف الأساسي الجديد للمستخدم يجب أن يكون رقم الهاتف صالحًا ومتوافقًا مع مواصفات E.164. يجب ضبط هذه السمة على null لمحو رقم هاتف المستخدم الحالي.
password سلسلة كلمة المرور الجديدة الأولية وغير المجزأة للمستخدم. يجب أن يتألف من ستة أحرف على الأقل.
displayName string | null الاسم المعروض الجديد للمستخدمين اضبط القيمة على null لمحو الاسم المعروض الحالي للمستخدم.
photoURL string | null عنوان URL الجديد لصورة المستخدمين اضبط القيمة على null لمحو عنوان URL الحالي لصورة المستخدم. إذا لم تكن السمة null، يجب أن تكون عنوان URL صالحًا.
disabled قيمة منطقية ما إذا كان المستخدم غير مفعَّل أم لا ‫true إذا كانت غير مفعَّلة false إذا كانت مفعَّلة

تعرض طريقة تعديل المستخدم عنصر UserRecord معدَّلاً عند اكتمال التعديل بنجاح.

إذا لم يتطابق uid المقدَّم مع مستخدم حالي، أو إذا كان عنوان البريد الإلكتروني أو رقم الهاتف المقدَّم مستخدَمًا من قِبل مستخدم حالي، أو إذا تعذّر تعديل المستخدم لأي سبب آخر، ستتعذّر الطريقة المذكورة أعلاه مع ظهور رسالة خطأ. للاطّلاع على قائمة كاملة برموز الأخطاء، بما في ذلك الأوصاف وخطوات الحلّ، يُرجى الاطّلاع على أخطاء واجهة برمجة تطبيقات Authentication للمشرف.

حذف مستخدم

يسمح مدير SDK في Firebase بحذف المستخدمين الحاليين من خلال 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')

متابعة

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

تعرض طريقة حذف المستخدم نتيجة فارغة عند اكتمال عملية الحذف بنجاح.

إذا لم يتطابق uid المقدَّم مع مستخدم حالي أو تعذّر حذف المستخدم لأي سبب آخر، ستعرض طريقة حذف المستخدم خطأً. للاطّلاع على قائمة كاملة برموز الأخطاء، بما في ذلك الأوصاف وخطوات الحلّ، يُرجى مراجعة أخطاء واجهة برمجة تطبيقات مشرف Authentication.

حذف عدة مستخدمين

يمكن أيضًا لـ 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}')

متابعة

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

تعرض طريقة حذف المستخدمين قائمة بحالات تعذُّر حذف المستخدمين. للاطّلاع على قائمة كاملة برموز الأخطاء، بما في ذلك الأوصاف وخطوات الحلّ، يُرجى مراجعة أخطاء واجهة برمجة تطبيقات مشرف Authentication.

عرض قائمة بجميع المستخدمين

تتيح حزمة تطوير البرامج (SDK) لمشرف Firebase استرداد قائمة المستخدمين بالكامل على دفعات:

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)

متابعة

// 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، يتم استخدام القيمة التلقائية التي تبلغ 1000 مستخدم لكل دفعة. وهذا هو أيضًا الحد الأقصى لعدد المستخدمين المسموح بإدراجهم في المرة الواحدة. وأي قيمة أكبر من الحد الأقصى ستؤدي إلى ظهور خطأ في الوسيطة. في حال عدم تحديد pageToken، ستعرض العملية المستخدمين من البداية، مرتّبين حسب uid.

للاطّلاع على قائمة كاملة برموز الأخطاء، بما في ذلك الأوصاف وخطوات الحلّ، يُرجى الاطّلاع على أخطاء واجهة برمجة تطبيقات Authentication للمشرفين.

تجزئات كلمات المرور للمستخدمين المُدرَجين

تعرض واجهة برمجة التطبيقات هذه أيضًا passwordSalt وpasswordHash مجزّأين من خلال الواجهة الخلفية لخدمة "مصادقة Firebase" لمستخدمي كلمات المرور إذا كان حساب المستخدم/الخدمة المستخدَم لإنشاء رمز الدخول المميز لبروتوكول OAuth الخاص بالطلب لديه إذن firebaseauth.configs.getHashConfig. وإلا لن يتم ضبط passwordHash وpasswordSalt.

نظرًا للطبيعة الحساسة لتجزئة كلمات المرور، لا يملك حساب خدمة مدير SDK في Firebase الإذن firebaseauth.configs.getHashConfig تلقائيًا. لا يمكنك إضافة إذن مباشرةً إلى حساب مستخدم أو حساب خدمة، ولكن يمكنك إجراء ذلك بشكل غير مباشر من خلال إنشاء دور مخصّص في "إدارة الهوية وإمكانية الوصول".

لإنشاء دور مخصّص في "إدارة الهوية وإمكانية الوصول"، اتّبِع الخطوات التالية:

  1. انتقِل إلى صفحة الأدوار في لوحة إدارة الهوية وإمكانية الوصول والمشرف في وحدة تحكّم Google Cloud.
  2. اختَر مشروعك من القائمة المنسدلة في أعلى الصفحة.
  3. انقر على إنشاء دور
  4. انقر على إضافة أذونات.
  5. ابحث عن إذن firebaseauth.configs.getHashConfig وضَع علامة في مربّع الاختيار هذا.
  6. انقر على إضافة
  7. انقر على إنشاء لإنهاء إنشاء الدور الجديد.

أضِف الدور المخصّص الذي تم إنشاؤه إلى حساب المستخدم أو الخدمة في صفحة "إدارة الهوية وإمكانية الوصول":

  1. في لوحة إدارة الهوية وإمكانية الوصول والمشرف، اختَر إدارة الهوية وإمكانية الوصول
  2. اختَر الخدمة أو حساب المستخدم من قائمة الأعضاء لتعديله.
  3. انقر على إضافة دور آخر.
  4. ابحث عن الدور المخصّص الجديد الذي أنشأته سابقًا.
  5. انقر على حفظ.