Управление многофакторными пользователями

В этом документе показано, как использовать 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);
});