認証器を追加

ユーザーに新しい認証器を関連付け、多要素認証（MFA）を有効にします。

​

エンドポイント

POST /mfa/associate

多要素認証 (MFA) 用の新しい認証要素を関連付けて追加します。

ユーザーに有効な認証要素がある場合、このエンドポイントを使用するには、enroll スコープを持ち、audience が https://{yourDomain}/mfa/ に設定されたアクセストークンが必要です。

ユーザーに有効な認証要素がない場合は、このリクエストでアクセストークンの代わりに mfa_required エラーの mfa_token を使用できます。

認証要素を追加した後は、検証する必要があります。認証要素を検証するには、/mfa/challenge エンドポイントから返される値の代わりに /mfa/associate リクエストのレスポンス値を使用し、検証フローを続行します。

認証要素が初めて追加されたときは、レスポンスに recovery_codes フィールドが含まれます。上記の リカバリーコードで検証する に示すように、recovery_codes を使用して多要素認証 (MFA) を完了できます。

このエンドポイントにアクセスするには、Authorization ヘッダーに次のクレームを含むアクセストークンを設定する必要があります。

• scope: enroll
• audience: https://{yourDomain}/mfa/

​

本文パラメーター

client_id · string · 必須

アプリケーションのクライアントIDです。

client_assertion · string

アプリケーションの認証情報を含む署名付きアサーションを格納した JWT です。アプリケーションの認証方式が Private Key JWT の場合に必須です。

client_assertion_type · string

値は urn:ietf:params:oauth:client-assertion-type:jwt-bearer です。アプリケーションの認証方式が Private Key JWT の場合に必須です。

client_secret · string · 必須

アプリケーションのクライアントシークレットです。Application Settings の Token Endpoint Authentication Method フィールドが Post または Basic の場合に必須です。

authenticator_types · array · 必須

値は、otp または oob を要素とする配列です。

oob_channels · array

authenticator_types に oob が含まれる場合は必須です。

phone_number · string

SMS または Voice に使用する電話番号です。oob_channels に sms または voice が含まれる場合に必須です。

​

レスポンススキーマ

​

レスポンスメッセージ

Status	Description
200	認証器の追加に成功した場合のレスポンス。
400	必須パラメーターが不足しているか、無効なための不正なリクエスト。
401	未認証。アクセストークンまたは mfa_token が無効です。