利用可能性はAuth0プランによって異なる
この機能が利用できるかどうかは、使用しているログイン実装とAuth0プラン(または契約)によります。詳細については、「価格設定」をお読みください。
前提条件
MFA APIを使用するには、事前にアプリケーションに対してMFAの付与タイプを有効にする必要があります。[Auth0 Dashboard]>[Applications(アプリケーション)]>[Advanced Settings(詳細設定)]>[Grant Types(付与タイプ)]に移動し、[MFA] を選択します。- Dashboardで、またはManagement APIを使って要素としてメールを構成します。
メールで登録する
ユーザーがプライマリIDで検証済みのメールアドレス以外にアドレスを追加登録できるようにするには、以下の手順を完了する必要があります。MFAトークンを取得する
登録をトリガーするタイミングによっては、以下のような方法で、MFA APIを使用するためのアクセストークンを取得できます。- 認証中に登録する場合は、「リソース所有者のパスワード付与とMFAで認証する」を参照してください。
- ユーザーがいつでも要素を登録できるようにする場合は、「MFA要素の登録を管理する」を参照してください。
Authenticatorを登録する
ユーザーの鑑別工具を登録するには、MFA AssociateエンドポイントにPOST
要求を送信します。このエンドポイントに必要なベアラートークンは、前の手順で取得したMFAトークンです。
次のパラメーターを使用します:
パラメーター | 値 |
---|---|
authentication_types | [oob] |
oob_channels | [email] |
email | email@address.com 、ユーザーのメールアドレス。 |
User is already enrolled(ユーザーは登録済みです)
」というエラーメッセージを受け取った場合、そのユーザーはすでにMFA要素を登録済みです。このユーザーに対して別の要素を関連付ける前に、既存の要素を使ってユーザーにチャレンジする必要があります。
ユーザーが鑑別工具を初めて関連付けている場合は、応答にrecovery_codes
が含まれます。復旧コードは、ユーザーが第二の認証要素であるアカウントやデバイスにアクセスできなくなったときに、ユーザーのアカウントにアクセスするために使用されます。このコードは1回しか使用できず、必要に応じて新しいコードが生成されます。
メールアドレスの登録を確定する
ユーザーは、アプリケーションに提供するための6桁のコードが記載されたメールを受信します。 登録を完了するには、/oath/token
エンドポイントにPOST
要求を行います。メールに記載された値とともに、前の応答で返されたoob_code
とbinding_code
を入れます。
active
に返される値はtrue
です。
ユーザーが受信するメールをカスタマイズするオプションもあります。詳細は、「メールテンプレートをカスタマイズする」をお読みください。
メールアドレスを使ってチャレンジする
MFAトークンを取得する
「リソース所有者のパスワード付与とMFAで認証する」で説明されている手順に従ってMFAトークンを取得します。登録されているオーセンティケーターを取得する
ユーザーにチャレンジするには、チャレンジしたい要素のauthenticator_id
が必要です。登録された全Authenticatorの一覧は、MFA Authenticatorエンドポイントを使って表示できます:
OTPを使ってユーザーにチャレンジする
メールチャレンジをトリガーするには、対応するauthenticator_id
とmfa_token
を使ってMFAチャレンジエンドポイントへPOST
を送ります。
受信したコードを使って認証を完了します。
成功すると以下の応答が届きます:oauth``/token
エンドポイントへの以下の呼び出しの中でbinding_code
パラメーターの要求の一部として送信します。