多要素ユーザーをプログラムによって管理する

このドキュメントでは、Identity Platform Admin SDK を使用して、多要素ユーザーをプログラムで管理する方法について説明します。多要素ユーザーを管理する場合、単一要素ユーザーと比べて、拡大された範囲のユーザー プロパティにアクセスできます。

始める前に

ユーザーを取得する

ユーザーの多要素に関する関連データ（登録済みの第 2 要素のリストなど）は、UserRecord オブジェクトから取得できます。ユーザー レコードを取得するには、getUser() または getUserByEmail() を呼び出します。

次の例は、多要素が登録されているユーザーを示しています。

// console.log(userRecord.toJSON());
{
  uid: 'some-uid',
  displayName: 'John Doe',
  email: 'johndoe@gmail.com',
  photoURL: 'http://www.example.com/12345678/photo.png',
  emailVerified: true,
  phoneNumber: '+11234567890',
  // Set this user as admin.
  customClaims: {admin: true},
  // User with Google provider.
  providerData: [{
    uid: 'google-uid',
    email: 'johndoe@gmail.com',
    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: '+16505551234',
        displayName: 'Work phone',
        enrollmentTime: 'Fri, 22 Sep 2017 01:49:58 GMT',
        factorId: 'phone',
      },
    ],
  },
};

ユーザーの一覧を表示する

次のコードは、すべてのユーザーを一覧表示し、第 2 要素が登録されているかどうかを確認する方法を示しています。

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 フィールドは、最大のバッチサイズを指定します。デフォルト値および最大値は 1,000 です。

ユーザーを作成する

createUser() を呼び出して新しいユーザーを作成します。第 2 要素を持つ新しいユーザーは、確認済みのメールアドレス（emailVerified を true に設定）を所有し、サポートされている第 1 要素を使用してログインする必要があります。ユーザーごとに最大 5 つの第 2 要素を指定できます。

次の例は、2 つの第 2 要素を持つ新しいユーザーを作成する方法を示しています。

admin.auth().createUser({
  uid: '123456789',
  email: 'user@example.com',
  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: '+16505550001',
        displayName: 'Corp phone',
        factorId: 'phone',
      },
      // Backup second factor.
      {
        phoneNumber: '+16505550002',
        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: '+16505550003',
        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: '+16505550004',
        displayName: 'Personal phone',
        factorId: 'phone',
      },
      {
        phoneNumber: '+16505550005',
        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);
});

新しい第 2 要素を追加する

enrolledFactors のリストを指定して updateUser() を呼び出すと、ユーザーの現在の第 2 要素がすべて消去されます。既存の第 2 要素を保持しながら新しい第 2 要素を追加するには、まずユーザーを検索して、次に新しい要素をリストに追加します。

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

第 2 要素を削除する

多要素認証からユーザーの登録を完全に解除するには、enrolledFactors に null または空の配列を設定します。

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

次のステップ