多要素ユーザーの管理

このドキュメントでは、FirebaseAdminSDKを使用して多要素ユーザーをプログラムで管理する方法を説明します。多要素ユーザーを管理する場合、単一要素ユーザーと比較して、より多くのユーザープロパティにアクセスできます。

あなたが始める前に

Node.jsAdminSDKをインストールします。他のAdminSDK言語は現在サポートされていません。

ユーザーの獲得

登録されている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フィールドは、最大バッチサイズを指定します。デフォルトおよび最大値は1000です。

ユーザーの作成

createUser()を呼び出して、新しいユーザーを作成します。二次要素を持つ新規ユーザーは、確認済みの電子メールアドレス（ emailVerifiedをtrueに設定）を持ち、サポートされている最初の要素を使用してサインインする必要があります。ユーザーごとに最大5つの二次要素が許可されます。

この例は、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('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);
});

新しい二次的要因の追加

enrolledFactorsのリストを指定してupdateUser()を呼び出すと、ユーザーの現在の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);
    });
}

二次的要因の除去

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

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