用于端到端外部 MFA 集成的关键组件和信息

以下示例代码展示了一个实时 webhook，它能够支持上一节中的示例 MFA 提供商。

{
    "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 Status。

请参阅 Webhook 配置 API 参考。

外部 MFA 提供商可根据其对外部请求的处理结果返回以下响应。

响应	定义
暂挂	身份验证尚未完成。
成功	身份验证成功。
失败	身份验证失败。
已取消	身份验证未完成，因为某个实体取消了该操作。
TIMEOUT	由于超时，身份验证未完成。