エンドツーエンドの外部 MFA 統合のためのキー・コンポーネントと情報

以下のサンプルコードは、前のセクションで紹介したMFAプロバイダーに対応したリアルタイムWebhookの例です。

{
    "name": "Some MFA Provider",
    "type": "realtime",
    "urls": ["https://some.address.com"],
    "authentication": {
        "type": "oauth",
        "oauth": {
            "client_id": "some_client_id",
            "client_secret": "some_client_secret",
            "token_endpoint": "https://some.address.com/token",
            "token_endpoint_auth_method": "client_secret_basic"
        }
    },
    "resources": {
        "enrollments": {
            "suffix": "/v1/enrollments",
            "method": "GET",
            "transform": {
                "outgoing": (CEL TRANSFORM),
                "incoming": (CEL TRANSFORM)
            }
        },
        "initiate": {
            "suffix": "/v1/mfa",
            "method": "POST",
            "expectedStatus": [201]
            "transform": {
                "outgoing": (CEL TRANSFORM),
                "incoming": (CEL TRANSFORM)
            }
        },
        "validate": {
            "suffix": "/v1/mfa",
            "method": "POST",
            "transform": {
                "outgoing": (CEL TRANSFORM),
                "incoming": (CEL TRANSFORM)
            }
        },
        "custom_totp_1": {
            "suffix": "/v1/mfa",
            "method": "POST",
            "transform": {
                "outgoing": (CEL TRANSFORM),
                "incoming": (CEL TRANSFORM)
            }
        },
        "result": {
            "suffix": "/v1/mfa/transactions",
            "method": "GET",
            "transform": {
                "outgoing": (CEL TRANSFORM),
                "incoming": (CEL TRANSFORM)
            }
        }
    },
    "purpose": ["external_mfa"]
}

以下の表で、リソースに関連付けられている構成可能な属性について説明します。

属性	説明
suffix	オプション。 アウトバウンド要求で使用されるベース URL に追加する接尾部。 Webhook リソースからのアウトバウンド要求は、base URL + suffix に送信されます。 構成で定義されているものを超えるスラッシュは追加されません。 発信要求 URL は、発信変換を使用して変更できます。 例えば、前の enrollments のサンプルでは、ISV Webhook コンポーネントはターゲット MFA プロバイダーの API エンドポイント https://some.address.com/v1/enrollments を開始します。
method	オプション。 発信 HTTP メソッドを POST から指定されたものに変更するメソッド。 API エンドポイントを開始するために使用される HTTP メソッド。 有効な値は、POST、PUT、GET、DELETE、PATCH です。メソッドは、発信変換を使用して変更できます。
transform.outgoing	オプション。 送信前にアウトバウンド要求に適用されるデータ変換を定義します。 変換では、ISV 内部 MFA フレームワークから送信された要求エレメント body、headers、http method、path、host にアクセスできます。
transform.incoming	オプション。 ISV MFA フレームワークに戻る前に着信応答に適用されるデータ変換を定義します。 変換では、ISV 内部 MFA フレームワークから送信された要求エレメント body、headers、status_code、request (現在の応答を生成する元の要求) にアクセスできます。
exepctedStatus	オプション。 ExpectedStatus これは、このWebhookによって起動されるAPIから返されることが期待される HTTP のステータスです。 属性が存在しない場合は、200 から 299 の範囲の状況コードが予期されます。 着信変換が実行される前に、予期される状況が検査されます。 「 HTTP 」のステータスを参照してください。

Webhook 構成 API リファレンスを参照してください。

外部MFAプロバイダーは、外部リクエストの結果に基づいて、以下の応答を返すことができます。

応答	定義
保留	認証はまだ完了していません。
SUCCESS	認証に成功しました。
FAILED	認証に失敗しました。
CANCELED	認証が完了しなかったのは、あるエンティティが試行をキャンセルしたためです。
TIMEOUT	タイムアウトが超過したため、認証が完了しませんでした。