REST Resource: projects.locations.instances.integrations.connectors

Resource: IntegrationConnector

This service is available for customers who migrated SOAR to a customer managed project and have the Chronicle API enabled. This resource describes the connector's definition.

JSON representation 
{
  "name": string,
  "displayName": string,
  "timeoutSeconds": string,
  "parameters": [
    {
      object (ConnectorParameter)
    }
  ],
  "rules": [
    {
      object (ConnectorRule)
    }
  ],
  "script": string,
  "author": string,
  "description": string,
  "enabled": boolean,
  "custom": boolean,
  "productFieldName": string,
  "eventFieldName": string,
  "integration": string
}
Fields
name

string

Identifier. The unique name of the connector. Format: projects/{project}/locations/{location}/instances/{instance}/integrations/{integration}/connectors/{connector}
displayName

string

Required. Connector's definition name.
timeoutSeconds

string (int64 format)

Required. Set the timeout of a single Python script run.
parameters[]

object (ConnectorParameter)

Optional. The connector's parameters definition.
rules[]

object (ConnectorRule)

Optional. The connector's rules definition.
script

string

Required. Connector's script.
author

string

Output only. User that created the connector in the system.
description

string

Optional. Connector's description.
enabled

boolean

Required. Determines whether the connector is disabled or enabled.
custom

boolean

Output only. Determines if the connector is a custom or commercial connector.
productFieldName

string

Required. The field name used to determine the device product.
eventFieldName

string

Required. The field name used to determine the event name (sub-type).
integration

string

Output only. Parent integration identifier.

ConnectorParameter

Connector parameters definition.

JSON representation 
{
  "id": string,
  "connectorId": string,
  "displayName": string,
  "type": enum (ParamType),
  "mode": enum (ParamMode),
  "mandatory": boolean,
  "defaultValue": string,
  "description": string,
  "advanced": boolean
}
Fields
id

string (int64 format)

Output only. The parameter's id.
connectorId

string (int64 format)

Output only. Connector's definition id.
displayName

string

Required. The parameter's display name.
type

enum (ParamType)

Required. The parameter's type.
mode

enum (ParamMode)

Required. The parameter's mode.
mandatory

boolean

Required. Indicates whether this parameter is mandatory for configuring a connector instance.
defaultValue

string

Optional. The default value of the parameter. The defaultValue is required for booleans / mandatory parameters.
description

string

Optional. The parameter's description.
advanced

boolean

Optional. The parameter's advanced flag.

ParamType

Connector Parameter Type

Enums
PARAM_TYPE_UNSPECIFIED Unspecified parameter type.
BOOLEAN Boolean parameter type.
INT Integer parameter type.
STRING String parameter type.
PASSWORD Password parameter type.
IP IP parameter type.
IP_OR_HOST IP or host parameter type.
URL URL parameter type.
DOMAIN Domain parameter type.
EMAIL Email parameter type.
VALUES_LIST Values parameter type.
VALUES_AS_SEMICOLON_SEPARATED_STRING Values as semicolon separated string parameter type.
MULTI_VALUES_SELECTION Multi values selection parameter type.
SCRIPT Script parameter type.
FILTER_LIST Filter list parameter type.

ParamMode

Connector Parameter Modes.

Enums
PARAM_MODE_UNSPECIFIED Unspecified parameter mode.
REGULAR Regular parameter.
CONNECTIVITY Connectivity parameter.
SCRIPT Script parameter.

ConnectorRule

Connector rules are used for allow/block lists rules.

JSON representation 
{
  "id": string,
  "displayName": string,
  "type": enum (RuleType)
}
Fields
id

string (int64 format)

Output only. The parameter's id.
displayName

string

Required. Connector's rule data name.
type

enum (RuleType)

Required. Connector's rule data type.

RuleType

Connector rule optional types.

Enums
RULE_TYPE_UNSPECIFIED Unspecified rule type.
ALLOW_LIST Allow list rule.
BLOCK_LIST Block list rule.

Methods

create

 Create a Integration Connector.

delete

 Delete a Connector.

executeTest

 Execute a test on a connector definition script.

fetchTemplate

 Retrieve the default recommended Integration Connector script template.

get

 Get a integration connector.

list

 List integration connectors.

patch

 Update a Integration Connector.