› ›

Okta 模块

Okta 模块从 Okta API 收集事件。具体来说，这支持读取 Okta 系统日志 API。

每个文件集都有单独的变量设置来配置模块的行为。如果您未指定变量设置，则 okta 模块将使用默认值。

对于高级用例，您还可以覆盖输入设置。请参阅覆盖输入设置。

在命令行中指定设置时，请记住在设置前加上模块名称，例如，okta.system.var.paths 而不是 system.var.paths。

Okta 系统日志记录与您的组织相关的系统事件，以便提供审计跟踪，可用于了解平台活动并诊断问题。此模块使用 httpjson 输入实现，并配置为遍历日志，同时遵守 Okta 发送的任何速率限制标头。

这是一个模块的示例配置。

- module: okta
  system:
    var.url: https://yourOktaDomain/api/v1/logs
    var.api_key: '00QCjAl4MlV-WPXM...0HmjFx-vbGua'

var.url

指定 Okta 系统日志 API 的 URL。必填。

    var.url: https://mycompany.okta.com/api/v1/logs

var.api_key

指定用于向 API 发出请求的 Okta API 令牌。必填。令牌在 HTTP Authorization 标头中使用 SSWS 方案。有关如何获取令牌的信息，请参阅创建 API 令牌。

    var.api_key: '00QCjAl4MlV-WPXM...0HmjFx-vbGua'

var.http_client_timeout

模块发出的 HTTP 请求的时间限制持续时间。默认为 60s。

var.interval

向 API 发出请求之间的持续时间。默认为 60s。

var.keep_original_message

布尔标志，指示是否应将原始 JSON 事件字符串包含在 event.original 字段中。默认为 true。

var.ssl

SSL 参数的配置选项，例如用于基于 HTTPS 的连接的证书颁发机构。如果缺少 ssl 部分，则主机 CA 用于与 Okta 的 HTTPS 连接。有关更多信息，请参阅 SSL。

    var.ssl:
      supported_protocols: [TLSv1.2]

var.initial_interval

可以定义初始间隔。模块第一次启动时，将从当前时刻减去初始间隔值获取事件。后续重启将从上次读取的事件开始获取事件。它默认为 24h。

    var.initial_interval: 24h # will fetch events starting 24h ago.

input.request.rate_limit.early_limit

您可以覆盖 HTTP JSON 中的默认速率限制行为。Okta 模块的默认值是使用高达 Okta 速率限制的 89%，这应该可以避免 Okta 对速率限制使用情况发出警告。

    input.request.rate_limit.early_limit: 0.89

此模块附带一个示例仪表盘。

有关模块中每个字段的说明，请参阅导出字段部分。