[DOCS] Move preconfigured Torq connector details (#166218)

This commit is contained in:
Lisa Cawley 2023-09-25 08:55:25 -07:00 committed by GitHub
parent 212bc53b8e
commit e74ec69a0f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
17 changed files with 427 additions and 42 deletions

View file

@ -1015,6 +1015,7 @@ Any modifications made to this file will be overwritten.
<li><a href="#config_properties_servicenow"><code>config_properties_servicenow</code> - Connector request properties for a ServiceNow ITSM connector</a></li>
<li><a href="#config_properties_servicenow_itom"><code>config_properties_servicenow_itom</code> - Connector request properties for a ServiceNow ITSM connector</a></li>
<li><a href="#config_properties_swimlane"><code>config_properties_swimlane</code> - Connector request properties for a Swimlane connector</a></li>
<li><a href="#config_properties_torq"><code>config_properties_torq</code> - Connector request properties for a Torq connector</a></li>
<li><a href="#config_properties_webhook"><code>config_properties_webhook</code> - Connector request properties for a Webhook connector</a></li>
<li><a href="#config_properties_xmatters"><code>config_properties_xmatters</code> - Connector request properties for an xMatters connector</a></li>
<li><a href="#connector_response_properties"><code>connector_response_properties</code> - Connector response properties</a></li>
@ -1035,6 +1036,7 @@ Any modifications made to this file will be overwritten.
<li><a href="#connector_response_properties_swimlane"><code>connector_response_properties_swimlane</code> - Connector response properties for a Swimlane connector</a></li>
<li><a href="#connector_response_properties_teams"><code>connector_response_properties_teams</code> - Connector response properties for a Microsoft Teams connector</a></li>
<li><a href="#connector_response_properties_tines"><code>connector_response_properties_tines</code> - Connector response properties for a Tines connector</a></li>
<li><a href="#connector_response_properties_torq"><code>connector_response_properties_torq</code> - Connector response properties for a Torq connector</a></li>
<li><a href="#connector_response_properties_webhook"><code>connector_response_properties_webhook</code> - Connector response properties for a Webhook connector</a></li>
<li><a href="#connector_response_properties_xmatters"><code>connector_response_properties_xmatters</code> - Connector response properties for an xMatters connector</a></li>
<li><a href="#connector_types"><code>connector_types</code> - Connector types</a></li>
@ -1056,6 +1058,7 @@ Any modifications made to this file will be overwritten.
<li><a href="#create_connector_request_swimlane"><code>create_connector_request_swimlane</code> - Create Swimlane connector request</a></li>
<li><a href="#create_connector_request_teams"><code>create_connector_request_teams</code> - Create Microsoft Teams connector request</a></li>
<li><a href="#create_connector_request_tines"><code>create_connector_request_tines</code> - Create Tines connector request</a></li>
<li><a href="#create_connector_request_torq"><code>create_connector_request_torq</code> - Create Torq connector request</a></li>
<li><a href="#create_connector_request_webhook"><code>create_connector_request_webhook</code> - Create Webhook connector request</a></li>
<li><a href="#create_connector_request_xmatters"><code>create_connector_request_xmatters</code> - Create xMatters connector request</a></li>
<li><a href="#features"><code>features</code> - </a></li>
@ -1106,6 +1109,7 @@ Any modifications made to this file will be overwritten.
<li><a href="#secrets_properties_slack_webhook"><code>secrets_properties_slack_webhook</code> - Connector secrets properties for a Webhook Slack connector</a></li>
<li><a href="#secrets_properties_swimlane"><code>secrets_properties_swimlane</code> - Connector secrets properties for a Swimlane connector</a></li>
<li><a href="#secrets_properties_teams"><code>secrets_properties_teams</code> - Connector secrets properties for a Microsoft Teams connector</a></li>
<li><a href="#secrets_properties_torq"><code>secrets_properties_torq</code> - Connector secrets properties for a Torq connector</a></li>
<li><a href="#secrets_properties_webhook"><code>secrets_properties_webhook</code> - Connector secrets properties for a Webhook connector</a></li>
<li><a href="#secrets_properties_xmatters"><code>secrets_properties_xmatters</code> - Connector secrets properties for an xMatters connector</a></li>
<li><a href="#updateConnector_400_response"><code>updateConnector_400_response</code> - </a></li>
@ -1124,6 +1128,7 @@ Any modifications made to this file will be overwritten.
<li><a href="#update_connector_request_slack_webhook"><code>update_connector_request_slack_webhook</code> - Update Slack connector request</a></li>
<li><a href="#update_connector_request_swimlane"><code>update_connector_request_swimlane</code> - Update Swimlane connector request</a></li>
<li><a href="#update_connector_request_teams"><code>update_connector_request_teams</code> - Update Microsoft Teams connector request</a></li>
<li><a href="#update_connector_request_torq"><code>update_connector_request_torq</code> - Update Torq connector request</a></li>
<li><a href="#update_connector_request_webhook"><code>update_connector_request_webhook</code> - Update Webhook connector request</a></li>
<li><a href="#update_connector_request_xmatters"><code>update_connector_request_xmatters</code> - Update xMatters connector request</a></li>
</ol>
@ -1529,6 +1534,13 @@ Any modifications made to this file will be overwritten.
<div class="param">mappings (optional)</div><div class="param-desc"><span class="param-type"><a href="#Connector_mappings_properties_for_a_Swimlane_connector">Connector_mappings_properties_for_a_Swimlane_connector</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="config_properties_torq"><code>config_properties_torq</code> - Connector request properties for a Torq connector</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Defines properties for connectors when type is <code>.torq</code>.</div>
<div class="field-items">
<div class="param">webhookIntegrationUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The endpoint URL of the Elastic Security integration in Torq. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="config_properties_webhook"><code>config_properties_webhook</code> - Connector request properties for a Webhook connector</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Defines properties for connectors when type is <code>.webhook</code>.</div>
@ -1842,6 +1854,22 @@ Any modifications made to this file will be overwritten.
<div class="param">is_missing_secrets (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type. </div>
<div class="param">is_preconfigured </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether it is a preconfigured connector. If true, the <code>config</code> and <code>is_missing_secrets</code> properties are omitted from the response. </div>
<div class="param">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </div>
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The display name for the connector. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="connector_response_properties_torq"><code>connector_response_properties_torq</code> - Connector response properties for a Torq connector</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_torq">config_properties_torq</a></span> </div>
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">.torq</div>
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the connector. </div>
<div class="param">is_deprecated </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector type is deprecated. </div>
<div class="param">is_missing_secrets (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type. </div>
<div class="param">is_preconfigured </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether it is a preconfigured connector. If true, the <code>config</code> and <code>is_missing_secrets</code> properties are omitted from the response. </div>
<div class="param">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </div>
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The display name for the connector. </div>
</div> <!-- field-items -->
</div>
@ -2093,6 +2121,18 @@ Any modifications made to this file will be overwritten.
<div class="param">secrets </div><div class="param-desc"><span class="param-type"><a href="#AnyType">map[String, oas_any_type_not_mapped]</a></span> Defines secrets for connectors when type is <code>.tines</code>. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="create_connector_request_torq"><code>create_connector_request_torq</code> - Create Torq connector request</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>The Torq connector uses a Torq webhook to trigger workflows with Kibana actions.</div>
<div class="field-items">
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_torq">config_properties_torq</a></span> </div>
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">.torq</div>
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The display name for the connector. </div>
<div class="param">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_torq">secrets_properties_torq</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="create_connector_request_webhook"><code>create_connector_request_webhook</code> - Create Webhook connector request</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>The Webhook connector uses axios to send a POST or PUT request to a web service.</div>
@ -2560,6 +2600,13 @@ Any modifications made to this file will be overwritten.
<div class="param">webhookUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The URL of the incoming webhook. If you are using the <code>xpack.actions.allowedHosts</code> setting, add the hostname to the allowed hosts. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="secrets_properties_torq"><code>secrets_properties_torq</code> - Connector secrets properties for a Torq connector</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Defines secrets for connectors when type is <code>.torq</code>.</div>
<div class="field-items">
<div class="param">token </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The secret of the webhook authentication header. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="secrets_properties_webhook"><code>secrets_properties_webhook</code> - Connector secrets properties for a Webhook connector</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Defines secrets for connectors when type is <code>.webhook</code>.</div>
@ -2718,6 +2765,15 @@ Any modifications made to this file will be overwritten.
<div class="param">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_teams">secrets_properties_teams</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="update_connector_request_torq"><code>update_connector_request_torq</code> - Update Torq connector request</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_torq">config_properties_torq</a></span> </div>
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The display name for the connector. </div>
<div class="param">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_torq">secrets_properties_torq</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="update_connector_request_webhook"><code>update_connector_request_webhook</code> - Update Webhook connector request</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>

View file

@ -7,10 +7,18 @@ Connectors provide a central place to store connection information for services
[cols="2"]
|===
a| <<d3security-action-type,D3 Security>>
| Send a request to D3 Security.
a| <<email-action-type,Email>>
| Send email from your server.
a| <<gen-ai-action-type,Generative AI>>
| Send a request to OpenAI.
a| <<resilient-action-type,{ibm-r}>>
| Create an incident in {ibm-r}.
@ -63,6 +71,10 @@ a| <<tines-action-type,Tines>>
| Send events to a Tines Story.
a| <<torq-action-type,Torq>>
| Trigger a Torq workflow.
a| <<webhook-action-type, {webhook}>>
| Send a request to a web service.
@ -75,18 +87,6 @@ a| <<xmatters-action-type,xMatters>>
| Send actionable alerts to on-call xMatters resources.
a| <<torq-action-type,Torq>>
| Trigger a Torq workflow.
a| <<gen-ai-action-type,Generative AI>>
| Send a request to OpenAI.
a| <<d3security-action-type,D3 Security>>
| Send a request to D3 Security.
|===
[NOTE]

View file

@ -3,6 +3,10 @@
++++
<titleabbrev>Torq</titleabbrev>
++++
:frontmatter-description: Add a connector that can use Torq to trigger workflows.
:frontmatter-tags-products: [kibana]
:frontmatter-tags-content-type: [how-to]
:frontmatter-tags-user-goals: [configure]
The Torq connector uses a Torq webhook to trigger workflows with Kibana actions.
@ -27,34 +31,6 @@ Torq endpoint URL:: Endpoint URL (webhook) of the Elastic Security integration y
Torq authentication header secret:: Secret of the webhook authentication header.
[float]
[[preconfigured-torq-configuration]]
=== Create preconfigured connectors
If you are running {kib} on-prem, you can define connectors by
adding `xpack.actions.preconfigured` settings to your `kibana.yml` file.
For example:
[source,yaml]
--
xpack.actions.preconfigured:
my-torq:
name: preconfigured-torq-connector-type
actionTypeId: .torq
config:
webhookIntegrationUrl: https://hooks.torq.io/v1/somehook
secrets:
token: mytorqtoken
--
Config defines information for the connector type.
`webhookIntegrationUrl`:: An address that corresponds to **Torq endpoint URL**.
Secrets defines sensitive information for the connector type.
`token`:: A string that corresponds to **Torq authentication header secret**.
[float]
[[torq-action-configuration]]
=== Test connectors

View file

@ -1,4 +1,6 @@
include::action-types/d3security.asciidoc[leveloffset=+1]
include::action-types/email.asciidoc[leveloffset=+1]
include::action-types/gen-ai.asciidoc[leveloffset=+1]
include::action-types/resilient.asciidoc[leveloffset=+1]
include::action-types/index.asciidoc[leveloffset=+1]
include::action-types/jira.asciidoc[leveloffset=+1]
@ -16,6 +18,4 @@ include::action-types/torq.asciidoc[leveloffset=+1]
include::action-types/webhook.asciidoc[leveloffset=+1]
include::action-types/cases-webhook.asciidoc[leveloffset=+1]
include::action-types/xmatters.asciidoc[leveloffset=+1]
include::action-types/gen-ai.asciidoc[leveloffset=+1]
include::action-types/d3security.asciidoc[leveloffset=+1]
include::pre-configured-connectors.asciidoc[leveloffset=+1]

View file

@ -113,11 +113,13 @@ Index names must start with `kibana-alert-history-` to take advantage of the pre
* <<preconfigured-resilient-configuration>>
* <<preconfigured-index-configuration>>
* <<preconfigured-jira-configuration>>
* <<preconfigured-teams-configuration>>
* <<preconfigured-opsgenie-configuration>>
* <<preconfigured-pagerduty-configuration>>
* <<preconfigured-server-log-configuration>>
* <<preconfigured-slack-configuration>>
* <<preconfigured-swimlane-configuration>>
* <<preconfigured-torq-configuration>>
* <<preconfigured-webhook-configuration>>
* <<preconfigured-cases-webhook-configuration>>
* <<preconfigured-xmatters-configuration>>
@ -528,6 +530,26 @@ xpack.actions.preconfigured:
<3> Field mappings for properties such as the alert identifer, severity, and rule name.
<4> The API authentication token for HTTP basic authentication. NOTE: This value should be stored in the <<creating-keystore, {kib} keystore>>.
[float]
[[preconfigured-torq-configuration]]
==== Torq connectors
The following example creates a <<torq-action-type,Torq connector>>:
[source,yaml]
--
xpack.actions.preconfigured:
my-torq:
name: preconfigured-torq-connector-type
actionTypeId: .torq
config:
webhookIntegrationUrl: https://hooks.torq.io/v1/somehook <1>
secrets:
token: mytorqtoken <2>
--
<1> The endpoint URL of the Elastic Security integration in Torq.
<2> The secret of the webhook authentication header.
[float]
[[preconfigured-webhook-configuration]]
==== Webhook connectors

View file

@ -432,6 +432,9 @@ For an <<xmatters-action-type,xMatters connector>>, specifies whether it uses HT
`xpack.actions.preconfigured.<connector-id>.config.viewIncidentUrl`::
For a <<cases-webhook-action-type,{webhook-cm} connector>>, specifies a URL string with either the external service ID or external service title Mustache variable to view a case in the external system.
`xpack.actions.preconfigured.<connector-id>.config.webhookIntegrationUrl`::
For a <<torq-action-type,Torq connector>>, specifies the endpoint URL of the Elastic Security integration in Torq.
`xpack.actions.preconfigured.<connector-id>.name`::
The name of the preconfigured connector.
@ -492,6 +495,7 @@ A token secret that varies by connector:
--
* For a <<d3security-action-type,D3 Security conector>>, specifies the D3 Security token.
* For a <<slack-action-type,Slack connector>>, specifies the Slack bot user OAuth token.
* For a <<torq-action-type,Torq connector>>, specifies the secret of the webhook authentication header.
--
`xpack.actions.preconfigured.<connector-id>.secrets.user`::

View file

@ -111,6 +111,9 @@
{
"$ref": "#/components/schemas/create_connector_request_tines"
},
{
"$ref": "#/components/schemas/create_connector_request_torq"
},
{
"$ref": "#/components/schemas/create_connector_request_webhook"
},
@ -389,6 +392,9 @@
{
"$ref": "#/components/schemas/create_connector_request_tines"
},
{
"$ref": "#/components/schemas/create_connector_request_torq"
},
{
"$ref": "#/components/schemas/create_connector_request_webhook"
},
@ -508,6 +514,9 @@
{
"$ref": "#/components/schemas/update_connector_request_teams"
},
{
"$ref": "#/components/schemas/update_connector_request_torq"
},
{
"$ref": "#/components/schemas/update_connector_request_webhook"
},
@ -2829,6 +2838,66 @@
}
}
},
"config_properties_torq": {
"title": "Connector request properties for a Torq connector",
"description": "Defines properties for connectors when type is `.torq`.",
"type": "object",
"required": [
"webhookIntegrationUrl"
],
"properties": {
"webhookIntegrationUrl": {
"description": "The endpoint URL of the Elastic Security integration in Torq.",
"type": "string"
}
}
},
"secrets_properties_torq": {
"title": "Connector secrets properties for a Torq connector",
"description": "Defines secrets for connectors when type is `.torq`.",
"type": "object",
"required": [
"token"
],
"properties": {
"token": {
"description": "The secret of the webhook authentication header.",
"type": "string"
}
}
},
"create_connector_request_torq": {
"title": "Create Torq connector request",
"description": "The Torq connector uses a Torq webhook to trigger workflows with Kibana actions.\n",
"type": "object",
"required": [
"config",
"connector_type_id",
"name",
"secrets"
],
"properties": {
"config": {
"$ref": "#/components/schemas/config_properties_torq"
},
"connector_type_id": {
"type": "string",
"description": "The type of connector.",
"enum": [
".torq"
],
"example": ".torq"
},
"name": {
"type": "string",
"description": "The display name for the connector.",
"example": "my-connector"
},
"secrets": {
"$ref": "#/components/schemas/secrets_properties_torq"
}
}
},
"config_properties_webhook": {
"title": "Connector request properties for a Webhook connector",
"description": "Defines properties for connectors when type is `.webhook`.",
@ -3776,6 +3845,50 @@
}
}
},
"connector_response_properties_torq": {
"title": "Connector response properties for a Torq connector",
"type": "object",
"required": [
"config",
"connector_type_id",
"id",
"is_deprecated",
"is_preconfigured",
"name"
],
"properties": {
"config": {
"$ref": "#/components/schemas/config_properties_torq"
},
"connector_type_id": {
"type": "string",
"description": "The type of connector.",
"enum": [
".torq"
]
},
"id": {
"type": "string",
"description": "The identifier for the connector."
},
"is_deprecated": {
"$ref": "#/components/schemas/is_deprecated"
},
"is_missing_secrets": {
"$ref": "#/components/schemas/is_missing_secrets"
},
"is_preconfigured": {
"$ref": "#/components/schemas/is_preconfigured"
},
"is_system_action": {
"$ref": "#/components/schemas/is_system_action"
},
"name": {
"type": "string",
"description": "The display name for the connector."
}
}
},
"connector_response_properties_webhook": {
"title": "Connector response properties for a Webhook connector",
"type": "object",
@ -3919,6 +4032,9 @@
{
"$ref": "#/components/schemas/connector_response_properties_tines"
},
{
"$ref": "#/components/schemas/connector_response_properties_torq"
},
{
"$ref": "#/components/schemas/connector_response_properties_webhook"
},
@ -4221,6 +4337,27 @@
}
}
},
"update_connector_request_torq": {
"title": "Update Torq connector request",
"type": "object",
"required": [
"config",
"name",
"secrets"
],
"properties": {
"config": {
"$ref": "#/components/schemas/config_properties_torq"
},
"name": {
"type": "string",
"description": "The display name for the connector."
},
"secrets": {
"$ref": "#/components/schemas/secrets_properties_torq"
}
}
},
"update_connector_request_webhook": {
"title": "Update Webhook connector request",
"type": "object",
@ -4286,6 +4423,7 @@
".swimlane",
".teams",
".tines",
".torq",
".webhook",
".xmatters"
],

View file

@ -55,6 +55,7 @@ paths:
- $ref: '#/components/schemas/create_connector_request_swimlane'
- $ref: '#/components/schemas/create_connector_request_teams'
- $ref: '#/components/schemas/create_connector_request_tines'
- $ref: '#/components/schemas/create_connector_request_torq'
- $ref: '#/components/schemas/create_connector_request_webhook'
- $ref: '#/components/schemas/create_connector_request_xmatters'
discriminator:
@ -208,6 +209,7 @@ paths:
- $ref: '#/components/schemas/create_connector_request_swimlane'
- $ref: '#/components/schemas/create_connector_request_teams'
- $ref: '#/components/schemas/create_connector_request_tines'
- $ref: '#/components/schemas/create_connector_request_torq'
- $ref: '#/components/schemas/create_connector_request_webhook'
- $ref: '#/components/schemas/create_connector_request_xmatters'
discriminator:
@ -264,6 +266,7 @@ paths:
- $ref: '#/components/schemas/update_connector_request_slack_webhook'
- $ref: '#/components/schemas/update_connector_request_swimlane'
- $ref: '#/components/schemas/update_connector_request_teams'
- $ref: '#/components/schemas/update_connector_request_torq'
- $ref: '#/components/schemas/update_connector_request_webhook'
- $ref: '#/components/schemas/update_connector_request_xmatters'
examples:
@ -1916,6 +1919,51 @@ components:
example: my-connector
secrets:
$ref: '#/components/schemas/secrets_properties_tines'
config_properties_torq:
title: Connector request properties for a Torq connector
description: Defines properties for connectors when type is `.torq`.
type: object
required:
- webhookIntegrationUrl
properties:
webhookIntegrationUrl:
description: The endpoint URL of the Elastic Security integration in Torq.
type: string
secrets_properties_torq:
title: Connector secrets properties for a Torq connector
description: Defines secrets for connectors when type is `.torq`.
type: object
required:
- token
properties:
token:
description: The secret of the webhook authentication header.
type: string
create_connector_request_torq:
title: Create Torq connector request
description: |
The Torq connector uses a Torq webhook to trigger workflows with Kibana actions.
type: object
required:
- config
- connector_type_id
- name
- secrets
properties:
config:
$ref: '#/components/schemas/config_properties_torq'
connector_type_id:
type: string
description: The type of connector.
enum:
- .torq
example: .torq
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: '#/components/schemas/secrets_properties_torq'
config_properties_webhook:
title: Connector request properties for a Webhook connector
description: Defines properties for connectors when type is `.webhook`.
@ -2626,6 +2674,38 @@ components:
name:
type: string
description: The display name for the connector.
connector_response_properties_torq:
title: Connector response properties for a Torq connector
type: object
required:
- config
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: '#/components/schemas/config_properties_torq'
connector_type_id:
type: string
description: The type of connector.
enum:
- .torq
id:
type: string
description: The identifier for the connector.
is_deprecated:
$ref: '#/components/schemas/is_deprecated'
is_missing_secrets:
$ref: '#/components/schemas/is_missing_secrets'
is_preconfigured:
$ref: '#/components/schemas/is_preconfigured'
is_system_action:
$ref: '#/components/schemas/is_system_action'
name:
type: string
description: The display name for the connector.
connector_response_properties_webhook:
title: Connector response properties for a Webhook connector
type: object
@ -2711,6 +2791,7 @@ components:
- $ref: '#/components/schemas/connector_response_properties_swimlane'
- $ref: '#/components/schemas/connector_response_properties_teams'
- $ref: '#/components/schemas/connector_response_properties_tines'
- $ref: '#/components/schemas/connector_response_properties_torq'
- $ref: '#/components/schemas/connector_response_properties_webhook'
- $ref: '#/components/schemas/connector_response_properties_xmatters'
discriminator:
@ -2922,6 +3003,21 @@ components:
description: The display name for the connector.
secrets:
$ref: '#/components/schemas/secrets_properties_teams'
update_connector_request_torq:
title: Update Torq connector request
type: object
required:
- config
- name
- secrets
properties:
config:
$ref: '#/components/schemas/config_properties_torq'
name:
type: string
description: The display name for the connector.
secrets:
$ref: '#/components/schemas/secrets_properties_torq'
update_connector_request_webhook:
title: Update Webhook connector request
type: object
@ -2975,6 +3071,7 @@ components:
- .swimlane
- .teams
- .tines
- .torq
- .webhook
- .xmatters
example: .server-log

View file

@ -0,0 +1,9 @@
title: Connector request properties for a Torq connector
description: Defines properties for connectors when type is `.torq`.
type: object
required:
- webhookIntegrationUrl
properties:
webhookIntegrationUrl:
description: The endpoint URL of the Elastic Security integration in Torq.
type: string

View file

@ -18,6 +18,7 @@ oneOf:
- $ref: 'connector_response_properties_swimlane.yaml'
- $ref: 'connector_response_properties_teams.yaml'
- $ref: 'connector_response_properties_tines.yaml'
- $ref: 'connector_response_properties_torq.yaml'
- $ref: 'connector_response_properties_webhook.yaml'
- $ref: 'connector_response_properties_xmatters.yaml'
discriminator:

View file

@ -0,0 +1,31 @@
title: Connector response properties for a Torq connector
type: object
required:
- config
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: 'config_properties_torq.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .torq
id:
type: string
description: The identifier for the connector.
is_deprecated:
$ref: 'is_deprecated.yaml'
is_missing_secrets:
$ref: 'is_missing_secrets.yaml'
is_preconfigured:
$ref: 'is_preconfigured.yaml'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.

View file

@ -20,6 +20,7 @@ enum:
- .swimlane
- .teams
- .tines
- .torq
- .webhook
- .xmatters
example: .server-log

View file

@ -0,0 +1,24 @@
title: Create Torq connector request
description: >
The Torq connector uses a Torq webhook to trigger workflows with Kibana actions.
type: object
required:
- config
- connector_type_id
- name
- secrets
properties:
config:
$ref: 'config_properties_torq.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .torq
example: .torq
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_torq.yaml'

View file

@ -0,0 +1,9 @@
title: Connector secrets properties for a Torq connector
description: Defines secrets for connectors when type is `.torq`.
type: object
required:
- token
properties:
token:
description: The secret of the webhook authentication header.
type: string

View file

@ -0,0 +1,14 @@
title: Update Torq connector request
type: object
required:
- config
- name
- secrets
properties:
config:
$ref: 'config_properties_torq.yaml'
name:
type: string
description: The display name for the connector.
secrets:
$ref: 'secrets_properties_torq.yaml'

View file

@ -34,6 +34,7 @@ post:
- $ref: '../components/schemas/create_connector_request_swimlane.yaml'
- $ref: '../components/schemas/create_connector_request_teams.yaml'
- $ref: '../components/schemas/create_connector_request_tines.yaml'
- $ref: '../components/schemas/create_connector_request_torq.yaml'
- $ref: '../components/schemas/create_connector_request_webhook.yaml'
- $ref: '../components/schemas/create_connector_request_xmatters.yaml'
discriminator:

View file

@ -118,6 +118,7 @@ post:
- $ref: '../components/schemas/create_connector_request_swimlane.yaml'
- $ref: '../components/schemas/create_connector_request_teams.yaml'
- $ref: '../components/schemas/create_connector_request_tines.yaml'
- $ref: '../components/schemas/create_connector_request_torq.yaml'
- $ref: '../components/schemas/create_connector_request_webhook.yaml'
- $ref: '../components/schemas/create_connector_request_xmatters.yaml'
discriminator:
@ -176,6 +177,7 @@ put:
- $ref: '../components/schemas/update_connector_request_swimlane.yaml'
- $ref: '../components/schemas/update_connector_request_teams.yaml'
# - $ref: '../components/schemas/update_connector_request_tines.yaml'
- $ref: '../components/schemas/update_connector_request_torq.yaml'
- $ref: '../components/schemas/update_connector_request_webhook.yaml'
- $ref: '../components/schemas/update_connector_request_xmatters.yaml'
examples: