REST Resource: customers.connectorConfigs

資源:ConnectorConfig

連接器設定的代表。

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

string

ID。格式: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 正規化,並使用 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 正規化,並使用 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

更新連接器設定。