REST Resource: customers.connectorConfigs

资源:ConnectorConfig

连接器配置的表示形式。

JSON 表示法
{
  "name": string,
  "displayName": string,
  "type": enum (ConnectorType),
  "details": {
    object (ConnectorConfigDetails)
  },
  "status": {
    object (ConnectorConfigStatus)
  }
}
字段
name

string

标识符。格式:customers/{customer}/connectorConfigs/{connectorConfig}

displayName

string

必需。配置的显示名称。

type

enum (ConnectorType)

必需。连接器的类型。

details

object (ConnectorConfigDetails)

必需。连接器配置的详细信息。

status

object (ConnectorConfigStatus)

仅限输出。连接器配置的状态。

ConnectorType

连接器配置类型的选项。

枚举
CONNECTOR_TYPE_UNSPECIFIED 默认值。此值未使用。
REPORTING 报告连接器。
DEVICE_TRUST 设备信任连接器。
XDR XDR 连接器。
IDENTITY_BASED_ENROLLMENT 身份验证连接器。
CERTIFICATE_AUTHORITY 证书授权机构连接器。API 中尚不支持。
ROOT_STORE 根证书连接器。

ConnectorConfigDetails

连接器配置的详细信息。

JSON 表示法
{

  // Union field details can be only one of the following:
  "splunkConfig": {
    object (SplunkConfig)
  },
  "googleSecOpsConfig": {
    object (GoogleSecOpsConfig)
  },
  "pubSubConfig": {
    object (PubSubConfig)
  },
  "crowdStrikeConfig": {
    object (CrowdStrikeConfig)
  },
  "crowdStrikeFalconNextGenConfig": {
    object (CrowdStrikeFalconNextGenConfig)
  },
  "paloAltoNetworksConfig": {
    object (PaloAltoNetworksConfig)
  },
  "deviceTrustConfig": {
    object (DeviceTrustConfig)
  },
  "crowdStrikeXdrConfig": {
    object (CrowdStrikeXdrConfig)
  },
  "pubSubXdrConfig": {
    object (PubSubXdrConfig)
  }
  // End of list of possible types for union field details.
}
字段
联合字段 details。连接器特定详细信息。details 只能是下列其中一项:
splunkConfig

object (SplunkConfig)

Splunk 连接器配置。

googleSecOpsConfig

object (GoogleSecOpsConfig)

Google SecOps 连接器配置。

pubSubConfig

object (PubSubConfig)

Pub/Sub 连接器配置。

crowdStrikeConfig

object (CrowdStrikeConfig)

CrowdStrike 连接器配置。

crowdStrikeFalconNextGenConfig

object (CrowdStrikeFalconNextGenConfig)

CrowdStrike Falcon Next Gen 连接器配置。

paloAltoNetworksConfig

object (PaloAltoNetworksConfig)

Palo Alto Networks 连接器配置。

deviceTrustConfig

object (DeviceTrustConfig)

设备信任连接器配置。

crowdStrikeXdrConfig

object (CrowdStrikeXdrConfig)

CrowdStrike XDR 连接器配置。

pubSubXdrConfig

object (PubSubXdrConfig)

Pub/Sub XDR 连接器配置。

SplunkConfig

Splunk 连接器配置。

JSON 表示法
{
  "unsecureScheme": boolean,
  "host": string,
  "portNumber": integer,
  "hecToken": string,
  "source": string,
  "reportingSettings": {
    object (ReportingSettings)
  }
}
字段
unsecureScheme

boolean

可选。是否使用不安全的 HTTP 方案。默认值为 false (HTTPS)。

host

string

必需。用于标识客户特定服务器以接收事件的主机。

portNumber

integer

可选。要使用的端口号。如果未设置,则使用默认 Splunk 端口。

hecToken

string

必需。仅限输入。要用作授权标头的数据输入的 HTTP 事件收集器令牌。

source

string

可选。用于替换 Splunk 管理控制台中设置的默认可选来源名称。

reportingSettings

object (ReportingSettings)

必需。Splunk 配置的报告设置。

ReportingSettings

连接器配置的报告设置。

JSON 表示法
{
  "enabledDefaultEvents": [
    enum (DefaultEvent)
  ],
  "enabledOptInEvents": [
    enum (OptInEvent)
  ],
  "enabledDeviceEvents": [
    enum (DeviceEvent)
  ]
}
字段
enabledDefaultEvents[]

enum (DefaultEvent)

可选。为此连接器启用的用户和浏览器事件的列表。空列表会停用所有默认事件,而使用 ALL_DEFAULT_EVENTS 会启用所有默认事件。

enabledOptInEvents[]

enum (OptInEvent)

可选。为此配置启用的选择启用事件的列表。空列表会停用所有选择性加入事件,而使用 ALL_OPT_IN_EVENTS 会启用所有选择性加入事件。

enabledDeviceEvents[]

enum (DeviceEvent)

可选。为此配置启用的设备事件的列表。空列表会停用所有设备事件,而使用 ALL_DEVICE_EVENTS 会启用所有设备事件。

DefaultEvent

默认报告事件。我们可能会添加更多活动。

枚举
DEFAULT_EVENT_UNSPECIFIED 默认值。此值未使用。
ALL_DEFAULT_EVENTS 所有默认事件。
BROWSER_CRASH_EVENT 浏览器崩溃事件。
BROWSER_EXTENSION_INSTALL_EVENT 浏览器扩展程序安装事件。
CONTENT_TRANSFER_EVENT 内容转移事件。
CONTENT_UNSCANNED_EVENT 未扫描内容事件。
DATA_ACCESS_CONTROL_EVENT 数据访问权限控制事件。
MALWARE_TRANSFER_EVENT 恶意软件转移事件。
PASSWORD_CHANGED_EVENT 密码更改事件。
PASSWORD_REUSE_EVENT 密码重复使用事件。
SENSITIVE_DATA_TRANSFER_EVENT 敏感数据传输事件。
SUSPICIOUS_URL_EVENT 可疑网址事件。
UNSAFE_SITE_VISIT_EVENT 不安全的网站访问事件。
URL_FILTERING_INTERSTITIAL_EVENT 网址过滤插页事件。

OptInEvent

选择启用报告事件。我们可能会添加更多活动。

枚举
OPT_IN_EVENT_UNSPECIFIED 默认值。此值未使用。
ALL_OPT_IN_EVENTS 所有选择性加入活动。
LOGIN_EVENT 登录事件。
PASSWORD_BREACH_EVENT 密码盗用事件。
URL_NAVIGATION_EVENT 网址导航事件。
EXTENSION_TELEMETRY_EVENT 扩展程序遥测事件。

DeviceEvent

设备事件。我们可能会添加更多活动。

枚举
DEVICE_EVENT_UNSPECIFIED 默认值。此值未使用。
ALL_DEVICE_EVENTS 所有设备事件。
ADD_REMOVE_USER_EVENT 添加/移除用户事件。
LOGIN_LOGOUT_EVENT 登录/退出登录事件。
CRD_EVENT CRD 事件。
PERIPHERAL_EVENT 外围设备事件。

GoogleSecOpsConfig

Google SecOps 连接器配置。

JSON 表示法
{
  "apiKey": string,
  "host": string,
  "reportingSettings": {
    object (ReportingSettings)
  }
}
字段
apiKey

string

必需。仅限输入。要在提取 API 上使用的 API 密钥。

host

string

必需。注入 API 端点的主机。允许客户将事件上传到特定地理区域中的服务器。没有此设置的现有配置默认为美国。

reportingSettings

object (ReportingSettings)

必需。Google SecOps 配置的报告设置。

PubSubConfig

Pub/Sub 连接器配置。

JSON 表示法
{
  "topicFullPath": string,
  "reportingSettings": {
    object (ReportingSettings)
  }
}
字段
topicFullPath

string

必需。要向其发送事件的主题的完整路径。

reportingSettings

object (ReportingSettings)

必需。Pub/Sub 配置的报告设置。

CrowdStrikeConfig

CrowdStrike 连接器配置。

JSON 表示法
{
  "apiKey": string,
  "host": string,
  "reportingSettings": {
    object (ReportingSettings)
  }
}
字段
apiKey

string

必需。仅限输入。要在提取 API 上使用的 API 密钥。

host

string

必需。用于标识客户特定服务器以接收事件的主机。

reportingSettings

object (ReportingSettings)

必需。CrowdStrike 配置的报告设置。

CrowdStrikeFalconNextGenConfig

CrowdStrike Falcon Next Gen 连接器配置。

JSON 表示法
{
  "apiKey": string,
  "host": string,
  "reportingSettings": {
    object (ReportingSettings)
  }
}
字段
apiKey

string

必需。仅限输入。要在提取 API 上使用的 API 密钥。

host

string

必需。用于标识客户特定服务器以接收事件的主机。

reportingSettings

object (ReportingSettings)

必需。CrowdStrike Falcon Next Gen 配置的报告设置。

PaloAltoNetworksConfig

Palo Alto Networks 连接器配置。

JSON 表示法
{
  "apiKey": string,
  "host": string,
  "reportingSettings": {
    object (ReportingSettings)
  }
}
字段
apiKey

string

必需。仅限输入。要在提取 API 上使用的 API 密钥。

host

string

必需。用于标识客户特定服务器以接收事件的主机。

reportingSettings

object (ReportingSettings)

必需。Palo Alto Networks 配置的报告设置。

DeviceTrustConfig

设备信任连接器的设备信任配置。

JSON 表示法
{
  "serviceProvider": enum (ServiceProvider),
  "urlMatchers": [
    string
  ],
  "serviceAccounts": [
    string
  ],
  "scope": enum (BrowserEnforcementScope)
}
字段
serviceProvider

enum (ServiceProvider)

可选。设备信任连接器的服务提供商。

urlMatchers[]

string

必需。允许参与认证流程以获取来自计算机的一组信号的网址列表。网址必须采用 HTTPS 架构,例如:“https://example.com”。允许使用通配符 *。如需详细了解有效网址格式,请访问 https://cloud.google.com/docs/chrome-enterprise/policies/url-patterns

serviceAccounts[]

string

必需。获准以完整访问权限调用已验证访问权限 API 的服务账号的电子邮件地址列表。

scope

enum (BrowserEnforcementScope)

必需。相应配置将应用到的范围。请注意,此设置仅适用于 Chrome 浏览器,因为在 ChromeOS 中,此设置始终处于应用状态。

ServiceProvider

设备信任连接器的服务提供商。

枚举
SERVICE_PROVIDER_UNSPECIFIED 默认值。
UNIVERSAL_DEVICE_TRUST 通用设备信任连接器。
OKTA Okta 服务提供商。
PING_IDENTITY Ping Identity 服务提供商。
ONELOGIN OneLogin 服务提供商。
DUO Duo 服务提供商。
ZSCALER Zscaler 服务提供商。
OMNISSA Omnissa 服务提供商。
JUMPCLOUD JumpCloud 服务提供商。

BrowserEnforcementScope

设备信任连接器的强制执行级别。

枚举
BROWSER_ENFORCEMENT_SCOPE_UNSPECIFIED 默认值。此值未使用。
BROWSERS_ONLY 仅强制执行浏览器。
PROFILES_ONLY 仅强制执行个人资料。
BROWSERS_AND_PROFILES 浏览器和个人资料均受强制执行。

CrowdStrikeXdrConfig

CrowdStrike XDR 连接器配置。

JSON 表示法
{
  "apiKey": string,
  "host": string,
  "xdrSettings": {
    object (XdrSettings)
  }
}
字段
apiKey

string

必需。仅限输入。要在提取 API 上使用的 API 密钥。

host

string

必需。用于标识客户特定服务器以接收事件的主机。

xdrSettings

object (XdrSettings)

必需。CrowdStrike XDR 配置的 XDR 设置。

XdrSettings

连接器配置的 XDR 设置。

JSON 表示法
{
  "enableAllXdrEvents": boolean
}
字段
enableAllXdrEvents

boolean

必需。是否启用所有 XDR 事件。

PubSubXdrConfig

Pub/Sub XDR 连接器配置。

JSON 表示法
{
  "topicFullPath": string,
  "xdrSettings": {
    object (XdrSettings)
  }
}
字段
topicFullPath

string

必需。要向其发送事件的主题的完整路径。

xdrSettings

object (XdrSettings)

必需。Pub/Sub XDR 配置的 XDR 设置。

ConnectorConfigStatus

连接器配置的状态。

JSON 表示法
{
  "state": enum (ConfigState),
  "failureStartTime": string,
  "updateTime": string
}
字段
state

enum (ConfigState)

仅限输出。连接器配置的状态。如果连接器在过去 24 小时内未成功发送事件,则连接器状态为“已停用”。

failureStartTime

string (Timestamp format)

仅限输出。自上次成功事件以来最早一次失败的现场记录时间。仅当状态为 DISABLED_BY_FAILURES 时,系统才会设置此字段。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

updateTime

string (Timestamp format)

仅限输出。相应状态的最近一次修改的实地记录时间。对于 ENABLED,这是状态更改为 ENABLED 的时间。对于 DISABLED_BY_FAILURES,这是最近一次向相应配置发送事件失败的时间。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

ConfigState

连接器配置的状态。我们可能会添加更多州。

枚举
CONFIG_STATE_UNKNOWN 默认值。
ENABLED 连接器配置已启用。
DISABLED_BY_FAILURES 由于出现故障,连接器配置暂时处于停用状态。

方法

create

创建连接器配置。

delete

删除连接器配置。

get

获取具有客户 ID 和配置 ID 的连接器配置。

list

列出客户的连接器配置。

patch

更新连接器配置。