POST /mfa/challenge
多要素認証 (MFA) API エンドポイントでは、ユーザーがトークンエンドポイントを利用する際に MFA を強制できるほか、ユーザー認証要素の登録と管理も行えます。
まず、アプリケーションとユーザーでサポートされているチャレンジタイプに基づいて、チャレンジをリクエストします。ワンタイムパスワード (OTP) がサポートされていることがわかっている場合は、チャレンジリクエストを省略できます。
次に、/oauth/token エンドポイントと指定したチャレンジタイプ (ワンタイムパスワード (OTP) 、リカバリーコード、または帯域外 (OOB) チャレンジ) を使用して、多要素認証を検証します。
詳細については、以下を参照してください。
チャレンジリクエスト
challenge_type は、ユーザーがどの方法でチャレンジを受け取り、所持を証明するかを示します。サポートされているチャレンジタイプは次のとおりです。
otp: ワンタイムパスワード (OTP) 用oob: SMS/音声メッセージ、または帯域外 (OOB) 用
注意事項
- このエンドポイントは登録をサポートしていません。チャレンジをリクエストする前に、ユーザーは希望する方法で事前に登録されている必要があります。
- Auth0 は、アプリケーションでサポートされているタイプと、ユーザーが登録しているタイプに基づいて、チャレンジタイプを選択します。
- アプリケーションが、ユーザーが登録しているいずれのチャレンジタイプもサポートしていない場合、
unsupported_challenge_typeエラーが返されます。 - ユーザーが登録されていない場合は、
unsupported_challenge_typeエラーが返されます。 - ユーザーが登録されていない場合は、
association_requiredエラーが返されます。これは、MFA を使用するにはユーザーが登録する必要があることを示します。続行方法については、以下の認証要素を追加するを参照してください。
詳しく見る
パラメーター
mfa_required エラーで受け取ったトークン。アプリケーションのクライアントID。
アプリケーションのクライアントシークレット。
アプリケーションが受け付けるチャレンジタイプの空白区切りリスト。使用可能な値:
oob, otpアプリケーションの認証情報を含む署名付きアサーションを格納した JWT。
値は
urn:ietf:params:oauth:client-assertion-type:jwt-bearer です。チャレンジする認証要素の ID。
レスポンス
| ステータス | 説明 |
|---|---|
| 200 | チャレンジリクエストが正常に完了しました |
| 400 | サポートされていないチャレンジタイプや登録漏れなど、無効なリクエスト。 |