エンドポイント
POST /mfa/challenge
Multi-factor Authentication (MFA) API のエンドポイントを使用すると、ユーザーがトークンエンドポイントを利用する際に MFA を必須にできるほか、ユーザーの認証器の登録や管理も行えます。
まず、アプリケーションとユーザーがサポートしているチャレンジの種類に応じて、チャレンジをリクエストします。ワンタイムパスワード (OTP) がサポートされていることがわかっている場合は、このチャレンジリクエストを省略できます。
次に、/oauth/token エンドポイントと指定したチャレンジの種類 (ワンタイムパスワード (OTP)、リカバリーコード、または帯域外 (OOB) チャレンジ) を使用して、多要素認証を検証します。
詳しくは、次を参照してください。
- Multi-factor Authentication and Resource Owner Password
- Multi-factor Authentication API
- Multi-factor Authentication in Auth0
チャレンジリクエスト
challenge_type は、ユーザーがどのようにチャレンジを受け取り、所持していることを証明するかを指定します。サポートされているチャレンジの種類は次のとおりです。
otp: ワンタイムパスワード (OTP)oob: SMS/音声メッセージ、または帯域外 (OOB)
注意事項
- このエンドポイントは登録をサポートしていません。チャレンジをリクエストする前に、ユーザーは希望する方法であらかじめ登録されている必要があります。
- Auth0 は、アプリケーションでサポートされている種類と、ユーザーが登録済みの種類に基づいて、チャレンジの種類を選択します。
- アプリケーションが、ユーザーが登録済みのチャレンジの種類をいずれもサポートしていない場合は、
unsupported_challenge_typeエラーが返されます。 - ユーザーが登録されていない場合は、
unsupported_challenge_typeエラーが返されます。 - ユーザーが登録されていない場合は、
association_requiredエラーが返されます。これは、MFA を利用するにはユーザーの登録が必要であることを示します。進め方については、下記の 認証器を追加する を参照してください。
詳しく見る
Body パラメーター
string
必須
mfa_required エラーで受け取ったトークン。string
必須
アプリケーションの Client ID。
string
アプリケーションの Client Secret。
string
アプリケーションが受け入れるチャレンジの種類の空白区切りリスト。指定可能な値:
oob, otpstring
アプリケーションの認証情報で署名したアサーションを含む JWT。
string
値は
urn:ietf:params:oauth:client-assertion-type:jwt-bearer です。string
チャレンジ対象の認証器の ID。