Quản lý người dùng đa yếu tố

Tài liệu này cho bạn biết cách sử dụng Firebase Admin SDK để quản lý người dùng đa yếu tố theo cách có lập trình. Khi quản lý người dùng đa yếu tố, bạn có quyền truy cập vào nhiều thuộc tính người dùng hơn so với cho người dùng một yếu tố.

Trước khi bắt đầu

Cài đặt Node.js Admin SDK. Admin SDK khác hiện không được hỗ trợ.

Thu hút người dùng

Bạn có thể truy xuất dữ liệu liên quan đến đa yếu tố của người dùng, chẳng hạn như danh sách người dùng đã đăng ký yếu tố thứ hai, từ đối tượng UserRecord. Để nhận hồ sơ người dùng, hãy gọi getUser() hoặc getUserByEmail().

Ví dụ bên dưới cho thấy một người dùng đã đăng ký xác thực nhiều yếu tố:

// 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',
      },
    ],
  },
};

Lập danh sách người dùng

Đoạn mã dưới đây cho biết cách liệt kê tất cả người dùng và kiểm tra xem họ có tài khoản phụ yếu tố được đăng ký:

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

Người dùng được trả về hàng loạt, theo thứ tự của uid. Mỗi lô kết quả chứa một danh sách người dùng và một mã thông báo trang tiếp theo dùng để tìm nạp lô tiếp theo. Khi tất cả người dùng được liệt kê, sẽ không có pageToken nào được trả về.

Trường maxResult chỉ định kích thước lô tối đa. Phương thức mặc định và giá trị tối đa là 1000.

Tạo người dùng

Gọi createUser() để tạo người dùng mới. Người dùng mới có yếu tố phụ phải có địa chỉ email đã xác minh (đặt emailVerified thành true) và sử dụng yếu tố chính được hỗ trợ để đăng nhập. Mỗi người dùng được phép sử dụng tối đa 5 yếu tố phụ.

Ví dụ cho thấy cách tạo một người dùng mới có 2 yếu tố phụ:

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

Cập nhật người dùng

Để cập nhật một người dùng hiện có, hãy gọi 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);
});

Thêm một yếu tố phụ mới

Việc gọi updateUser() bằng danh sách enrolledFactors sẽ xoá mọi yếu tố phụ hiện tại của người dùng. Để thêm một yếu tố phụ mới trong khi giữ chân người dùng hiện có, hãy tìm kiếm người dùng trước, sau đó thêm yếu tố mới vào danh sách:

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

Xoá một yếu tố phụ

Để huỷ đăng ký hoàn toàn cho người dùng khỏi xác thực đa yếu tố, hãy đặt enrolledFactors đến null hoặc một mảng trống:

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