initiate+validate または validate only パターンの API 規約の検証

オンラインで編集

validate リソースは、使用される要素が "initiate+validate" または "validate only" の統合パターンをサポートする場合に、ランタイム MFA チャレンジ中に内部 Verify コンポーネントによって呼び出されます。

例えば、smsotp や totp などです。 Verify は、検証要求の試行が成功したか失敗したかを示す status が応答に含まれることを予期しています。 Verify 、リアルタイムウェブフックの initiate リソースに送信されるリクエストの例を以下に示す。 Webhook 構成に応じて、この同じペイロードをターゲット MFA プロバイダーに直接送信することも、ターゲット・プロバイダーが受け入れ可能な API クライアント要求に変換することもできます。
POST '/validate' \
'Content-Type: application/json' \
'Accept: application/json' \

{
  "capability":  "<<factor capability name, e.g. totp>>",
  "id": "<<factor or device identifier from external provider>>",
  "transactionId": "<<provider transaction identifier>>"
  "attributes":
    {
      "passvalue": "806795",
      "username": "<<external MFA username>>"
    }
}
注： この例の /validate HTTPは、ウェブフックの設定によって異なります。

検証要求の詳細

エレメント 説明
HTTP 要求 POST
HTTP ヘッダー - Content-Type 要求ペイロードのコンテンツ・タイプは、常に application/json です。
HTTP ヘッダー - Accept 応答ペイロードの予期されるコンテンツ・タイプは、常に application/json です。
Payload 検証されるトークンまたはパス値を表す JSON オブジェクト。 ペイロードは、ユーザーとその関連する MFA 登録も識別します。
id

必須。 MFA 要素機能に登録済みユーザーの固有 ID。
capability

必須。 MFA 要素機能タイプを識別します。 値は有効な文字ストリングです。 これは、Webhook に関連付けられている MFA プロバイダー用に構成されている機能の 1 つと一致している必要があります。
transactionId

オプション。 トランザクションまたはその他の MFA プロバイダー認証チャレンジ状態ハンドル。 この値は、検証が "initiate+validate" パターン・フローの一部として実行される場合に存在します。 その値は、前の "initiate" 応答に含まれている値と同じです。
attributes

必須。 要求固有の追加属性を検証します。
attributes.username

必須。 検証が要求される外部プロバイダー・システム内のユーザーの名前。
attributes.passvalue

必須。 検証されるトークンまたは値。
以下のコードは、validate 応答ペイロードのサンプルです。
{
    "attributes": {
        "<<any name>>": "<<any value>>"
    },
    "status": "SUCCESS"
}

検証応答の詳細

エレメント 説明
ペイロード・タイプ 検証試行状況を表す JSON オブジェクト。
HTTP 状況コード ステータスを HTTP 参照してください。
status 必須。 検証の完了状況。 有効な値は、SUCCESS、PENDING、TIMEOUT、CANCELED、および FAILED です。
attributes オプション。 MFA チャレンジをトリガーしたパブリック Verify クライアントに返される追加の属性。 追加の属性および値が存在する場合があります。