前提条件
MFA APIを使用するには、事前にアプリケーションに対してMFAの付与タイプを有効にする必要があります。[Auth0 Dashboard]>[Applications(アプリケーション)]>[Advanced Settings(詳細設定)]>[Grant Types(付与タイプ)]に移動し、[MFA] を選択します。- Dashboardで、またはManagement APIを使って、要素としてOTPを構成します。
OTPで登録する
MFAトークンを取得する
登録をトリガーするタイミングによっては、以下のような方法で、MFA APIを使用するためのアクセストークンを取得できます。- 認証中に登録する場合は、「リソース所有者のパスワード付与とMFAで認証する」を参照してください。
- ユーザーがいつでも要素を登録できるようにする場合は、「MFA要素の登録を管理する」を参照してください。
Authenticatorを登録する
ユーザーの鑑別工具を登録するには、MFA AssociateエンドポイントにPOST
要求を送信します。このエンドポイントに必要なベアラートークンは、前の手順で取得したMFAトークンです。
OTPで登録するには、authenticator_types
パラメーターを[otp]
に設定します。
User is already enrolled(ユーザーは登録済みです)
」というエラーメッセージを受け取った場合、そのユーザーはすでにMFA要素を登録済みです。このユーザーに対して別の要素を関連付ける前に、既存の要素を使ってユーザーにチャレンジする必要があります。
ユーザーが鑑別工具を初めて関連付けている場合は、応答にrecovery_codes
が含まれます。復旧コードは、ユーザーが第二の認証要素であるアカウントやデバイスにアクセスできなくなったときに、ユーザーのアカウントにアクセスするために使用されます。このコードは1回しか使用できず、必要に応じて新しいコードが生成されます。
OTPの登録を確定する
登録を確定するには、エンドユーザーが、前のステップでGoogle AuthenticatorのようなOTP生成アプリケーションから取得したシークレットを入力する必要があります。このシークレットは、barcode_uri
を使ってQRコードをスキャンするか、OTPアプリケーションで手動でシークレットコードを入力します。QRコードをスキャンできない場合(たとえば、モバイルデバイスから登録している、デスクトップ用OTPアプリケーションを使用しているなど)に備えて、シークレットをテキストで取得する方法を提供する必要があります。
ユーザーがシークレットを入力したら、OTPアプリケーションが6桁のコードを表示し、これをユーザーがアプリケーションに入力します。そうすると、アプリケーションはPOST
要求をトークンエンドポイントに対して実行し、これにotp
値を含めます。
active
に返される値はtrue
です。
OTPを使ってチャレンジする
MFAトークンを取得する
「リソース所有者のパスワード付与とMFAで認証する」で説明されている手順に従ってMFAトークンを取得します。登録されているAuthenticatorを取得する
登録された全Authenticatorの一覧は、MFA Authenticatorエンドポイントを使って表示できます:受信したコードを使って認証を完了します。
ユーザーがワンタイムパスワードを収集すると、こちら側でそれを収集します。 OAuth0トークンエンドポイントを使用して、otp
パラメーターにワンタイムパスワードを指定し、コードを検証して認証トークンを取得します。