ユーザーのMFA認証器登録情報をインポートする

移行後も既存ユーザーの認証器アプリ、SMS、メールの認証要素を保持できるよう、ユーザーレコードとともにMFA登録情報をAuth0にインポートします。

自動移行および一括ユーザーインポートを使用して、ユーザーのMFA登録情報をインポートできます。サポートされる登録タイプは次のとおりです。

• Email: メール認証用。
• Phone: SMS認証用。
• OTP: Google Authenticator などの認証アプリで使用するワンタイムパスワード (OTP) 用。

MFA登録情報をインポートすると、移行後にユーザーが再登録する必要がなくなるため、シームレスなユーザー体験を実現できます。

クラシックログインでは、複数の認証要素を持つユーザーによる認証要素の選択はサポートされていません。複数の登録済み認証要素を持つユーザーをインポートする予定がある場合は、Universal Login の利用を検討してください。

​

スキーマ

このスキーマは、以下2つのワークフローにおけるMFA認証要素に適用されます。

{
    "type": "array",
    "items": {
        "type": "object",
        "properties": {
            "totp": {
                "type": "object",
                "properties": {
                "secret": {
                    "type": "string",
                        "pattern": "^[A-Z2-7]+$",
                        "description": "The OTP secret is used for MFA authentication with Google Authenticator type apps. It must be supplied in un-padded Base32 encoding, such as: JBTWY3DPEHPK3PNP"
                    },
                },
                "additionalProperties": false,
                "required": ["secret"],
            },
            "phone": {
                "type": "object",
                "properties": {
                "value": {
                    "type": "string",
                    "pattern": "^\\+[0-9]{1,15}$",
                    "description": "The phone number for SMS or Voice MFA. The phone number should include a country code and begin with +, such as: [phone]"
                },
                },
                "additionalProperties": false,
                "required": ["value"],
            },
            "email": {
                "type": "object",
                "properties": {
                    "value": {
                        "type": "string",
                        "format": "email",
                        "description": "The email address for MFA"
                    },
                },
                "additionalProperties": false,
                "required": ["value"],
            },
        },
        "maxProperties": 1,
        "additionalProperties": false,
    },
    "minItems": 1,
    "maxItems": 10
}

​

自動移行

MFA の登録情報は、自動移行中にインポートすることもできます。これは、カスタム DB の Login スクリプト の最後でコールバックに渡されるユーザーの mfa_factors フィールドに、既存の登録情報を指定することで実現できます。

失敗はテナントログにログイン失敗として表示され、説明 Unable to import MFA factors によってほかの失敗と区別できます。例:

{
  "_id": "5e9df3b29ebabe00571c04a7",
  "date": "2020-04-20T19:10:42.916Z",
  "type": "fu",
  "description": "Unable to import MFA factors.",
  "connection": "Username-Password-Authentication",
  "connection_id": "con_mMkvaycgzgCS0p0z",
  "client_id": "aCbTAJNi5HbsjPJtRpSP6BIoLPOrSj2Cgg",
  "client_name": "All Applications",
  "ip": "10.12.13.1",
  "client_ip": null,
  "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.149 Safari/537.36",
  "details": {
    "error": {
      "message": "Unable to import MFA factors."
    }
  },
  "user_name": "[e-mail]",
  "strategy": "auth0",
  "strategy_type": "database"
}

​

一括ユーザーインポート

1. users.json ファイルを準備します。詳しくは一括ユーザーインポートを参照してください。
2. 各ユーザーに既存のMFA登録情報を含めます。
3. 一括ユーザーインポートを開始します。
4. 最初のリクエストで upsert オプションを有効にして、既存ユーザーの認証要素を更新します。
5. インポートジョブが完了したら、レスポンスにエラーがないか確認します。いずれかのユーザーのMFA認証要素のインポートに失敗した場合は、次のようなエラーが表示されます。

upsert オプションを使用すると、既存ユーザーに対するMFA関連以外の更新はすべて、そのユーザーのプロファイルに適用されます。たとえば、次のエラー概要では、ユーザーの picture 属性は http://example.org/jdoe.png に正常に設定されていますが、Auth0は指定されたMFA認証要素をインポートできませんでした。このような場合は、失敗したユーザーのインポートを再試行しても問題ありません。

[
  {
    "user": {
      "email": "[e-mail]",
      "picture": "http://example.org/jdoe.png",
      "mfa_factors": [
        {
          "totp": {
            "secret": "2PRXZWZAYYDAWCD"
          }
        },
        {
          "phone": {
            "value": "[phone]"
          }
        },
        {
          "email": {
            "value": "[e-mail]"
          }
        }
      ]
    },
    "errors": [
      {
        "code": "MFA_FACTORS_FAILED",
        "message": "Unable to import factors"
      }
    ]
  }
]

​

リカバリーコード

Auth0 では、リカバリーコードをインポートする方法は提供されていません。ユーザーの MFA 認証要素をインポートしても、リカバリーコードは付与されません。

ユーザーにリカバリーコードを提供するには、ユーザーがすでにリカバリーコードを登録しているかどうかを確認し、登録していない場合は Recovery Code Regeneration endpoint を使用して新しいコードを生成できます。

​

詳細はこちら

• データベースからの自動移行を設定する
• 一括ユーザーインポート