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

يوضّح لك هذا المستند كيفية استخدام Firebase Admin SDK في الإدارة. المستخدمين متعددي العوامل آليًا. عند إدارة المستخدمين متعددي العوامل، يمكنك الوصول إلى مجموعة متزايدة من خصائص المستخدمين مقارنةً إلى مستخدمين فرديين

قبل البدء

ثبِّت Node.js Admin SDK. Admin SDK أخرى اللغات غير متاحة حاليًا.

جذب المستخدمين

يمكنك استرداد بيانات متعددة العوامل ذات الصلة بالمستخدم، مثل قائمة بالبيانات المسجَّلة والعوامل الثانية من الكائن UserRecord. للحصول على سجلّ مستخدم، اتصل getUser() أو getUserByEmail()

يوضح المثال أدناه مستخدمًا مسجَّلاً متعدد العوامل:

// console.log(userRecord.toJSON());
{
  uid: 'some-uid',
  displayName: 'John Doe',
  email: '[e-mail]',
  photoURL: 'http://www.example.com/12345678/photo.png',
  emailVerified: true,
  phoneNumber: '[phone]',
  // Set this user as admin.
  customClaims: {admin: true},
  // User with Google provider.
  providerData: [{
    uid: 'google-uid',
    email: '[e-mail]',
    displayName: 'John Doe',
    photoURL: 'http://www.example.com/12345678/photo.png',
    providerId: 'google.com'
  }],
  multiFactor: {
    enrolledFactors: [
      // 2FA with SMS as 2nd factor.
      {
        uid: '53HG4HG45HG8G04GJ40J4G3J',
        phoneNumber: '[phone]',
        displayName: 'Work phone',
        enrollmentTime: 'Fri, 22 Sep 2017 01:49:58 GMT',
        factorId: 'phone',
      },
    ],
  },
};

مستخدمو بطاقة بيانات المتجر

يوضح الرمز أدناه كيفية إدراج جميع المستخدمين والتحقق مما إذا كان لديهم حساب ثانوي العامل المسجل:

admin.auth().listUsers(1000, nextPageToken)
  .then((listUsersResult) => {
    listUsersResult.users.forEach((userRecord) => {
      // Multi-factor enrolled users second factors can be retrieved via:
      if (userRecord.multiFactor) {
        userRecord.multiFactor.enrolledFactors.forEach((enrolledFactor) => {
          console.log(userRecord.uid, enrolledFactor.toJSON());
        });
      }
    });
  })
  .catch((error) => {
    console.log('Error listing users:', error);
  });

يتم إرجاع المستخدمين على دُفعات، ويتم ترتيبهم حسب uid. كل دُفعة من النتائج ويحتوي على قائمة بالمستخدمين ورمزًا مميزًا للصفحة التالية يُستخدم لجلب الدفعة التالية. عند إدراج جميع المستخدمين، لا يتم عرض pageToken.

ويحدِّد الحقل maxResult الحد الأقصى لحجم الدُفعة. القيمة التلقائية والحد الأقصى هو 1000.

إنشاء مستخدم

يُرجى الاتصال بالرقم createUser() لإنشاء مستخدم جديد. يجب على المستخدمين الجدد الذين لديهم عوامل ثانوية أن يكون لديك عنوان بريد إلكتروني تم إثبات ملكيته (اضبط emailVerified على true) وتستخدم يدعم العامل الأول لتسجيل الدخول. يُسمح بما يصل إلى 5 عوامل ثانوية لكل المستخدم.

يوضّح المثال كيفية إنشاء مستخدم جديد بعاملَين ثانويَين:

admin.auth().createUser({
  uid: '123456789',
  email: '[e-mail]',
  emailVerified: true,
  password: 'password',
  multiFactor: {
    enrolledFactors: [
      // When creating users with phone second factors, the uid and
      // enrollmentTime should not be specified. These will be provisioned by
      // the Auth server.
      // Primary second factor.
      {
        phoneNumber: '[phone]',
        displayName: 'Corp phone',
        factorId: 'phone',
      },
      // Backup second factor.
      {
        phoneNumber: '[phone]',
        displayName: 'Personal phone',
        factorId: 'phone'
      },
    ],
  },
})
.then((userRecord) => {
  console.log(userRecord.multiFactor.enrolledFactors);
})
.catch((error) => {
  console.log(error);
});

تحديث مستخدم

لتعديل بيانات مستخدم حالي، يمكنك الاتصال بالرقم updateUser():

admin.auth().updateUser(uid: '123456789', {
  multiFactor: {
    enrolledFactors: [
      {
        // uid will be auto-generated.
        phoneNumber: '[phone]',
        displayName: 'Spouse\'s phone',
        factorId: 'phone',
      },
      {
        // uid can also be specified. This is useful if a new second factor is added and an
        // existing enrolled second factor is kept unmodified.
        uid: 'existing-enrolled-mfa-uid',
        phoneNumber: '[phone]',
        displayName: 'Personal phone',
        factorId: 'phone',
      },
      {
        phoneNumber: '[phone]',
        displayName: 'Backup phone',
        factorId: 'phone',
        // Enrollment time can also be explicitly specified.
        enrollmentTime: new Date().toUTCString(),
      },
    ],
  },
})
.then((userRecord) => {
  console.log(userRecord.multiFactor.enrolledFactors);
})
.catch((error) => {
  console.log(error);
});

إضافة عامل ثانوي جديد

سيؤدي الاتصال برقم updateUser() الذي يضم قائمة enrolledFactors إلى محو بيانات أي من والعوامل الثانوية الحالية للمستخدم. لإضافة عامل ثانوي جديد أثناء بالمحافظة على العناصر الحالية، ابحث عن المستخدم أولاً، ثم أضف العامل الجديد إلى القائمة:

function enrollSecondFactor(userId, secondFactorPhoneNumber, secondFactorDisplayName) {
  return admin.auth().getUser(userId)
    .then((userRecord) => {
      const updatedList = (userRecord.multiFactor &&
        userRecord.multiFactor.toJSON().enrolledFactors) || [];
      updatedList.push({
        phoneNumber: secondFactorPhoneNumber,
        displayName: secondFactorDisplayName,
        factorId: 'phone',
      });
      return admin.auth().updateUser(userRecord.uid, {
        multiFactor: {
          enrolledFactors: updatedList,
        },
      });
    })
    .catch((error) => {
      console.log(error);
    });
}

إزالة عامل ثانوي

لإلغاء تسجيل مستخدم تمامًا من المصادقة متعددة العوامل، اضبط من enrolledFactors إلى null أو مصفوفة فارغة:

admin.auth().updateUser(uid: '123456789', {
  multiFactor: {
    enrolledFactors: null,
  },
})
.then((userRecord) => {
  console.log(userRecord.multiFactor);
})
.catch((error) => {
  console.log(error);
});