github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Move preconfigured D3 Security connector details (#166112)

Browse source 
Co-authored-by: Ying Mao <ying.mao@elastic.co>
This commit is contained in:
Lisa Cawley 2023-09-12 10:17:53 -07:00 • committed by GitHub
parent 622b14de67
commit 0f1b5a23e1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
15 changed files with 446 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

56
docs/api-generated/connectors/connector-apis-passthru.asciidoc
View file

@ -1002,6 +1002,7 @@ Any modifications made to this file will be overwritten.
<li><a href="#Update_connector_request_body_properties"><code>Update_connector_request_body_properties</code> - Update connector request body properties</a></li>
<li><a href="#action_response_properties"><code>action_response_properties</code> - Action response properties</a></li>
<li><a href="#config_properties_cases_webhook"><code>config_properties_cases_webhook</code> - Connector request properties for Webhook - Case Management connector</a></li>
<li><a href="#config_properties_d3security"><code>config_properties_d3security</code> - Connector request properties for a D3 Security connector</a></li>
<li><a href="#config_properties_genai"><code>config_properties_genai</code> - Connector request properties for a generative AI connector</a></li>
<li><a href="#config_properties_index"><code>config_properties_index</code> - Connector request properties for an index connector</a></li>
<li><a href="#config_properties_jira"><code>config_properties_jira</code> - Connector request properties for a Jira connector</a></li>
@ -1015,6 +1016,7 @@ Any modifications made to this file will be overwritten.
<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>
<li><a href="#connector_response_properties_cases_webhook"><code>connector_response_properties_cases_webhook</code> - Connector request properties for a Webhook - Case Management connector</a></li>
<li><a href="#connector_response_properties_d3security"><code>connector_response_properties_d3security</code> - Connector response properties for a D3 Security connector</a></li>
<li><a href="#connector_response_properties_email"><code>connector_response_properties_email</code> - Connector response properties for an email connector</a></li>
<li><a href="#connector_response_properties_index"><code>connector_response_properties_index</code> - Connector response properties for an index connector</a></li>
<li><a href="#connector_response_properties_jira"><code>connector_response_properties_jira</code> - Connector response properties for a Jira connector</a></li>
@ -1034,6 +1036,7 @@ Any modifications made to this file will be overwritten.
<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>
<li><a href="#create_connector_request_cases_webhook"><code>create_connector_request_cases_webhook</code> - Create Webhook - Case Managment connector request</a></li>
<li><a href="#create_connector_request_d3security"><code>create_connector_request_d3security</code> - Create D3 Security connector request</a></li>
<li><a href="#create_connector_request_email"><code>create_connector_request_email</code> - Create email connector request</a></li>
<li><a href="#create_connector_request_genai"><code>create_connector_request_genai</code> - Create generative AI connector request</a></li>
<li><a href="#create_connector_request_index"><code>create_connector_request_index</code> - Create index connector request</a></li>
@ -1088,6 +1091,7 @@ Any modifications made to this file will be overwritten.
<li><a href="#run_connector_subaction_pushtoservice_subActionParams_incident_malware_url"><code>run_connector_subaction_pushtoservice_subActionParams_incident_malware_url</code> - </a></li>
<li><a href="#run_connector_subaction_pushtoservice_subActionParams_incident_source_ip"><code>run_connector_subaction_pushtoservice_subActionParams_incident_source_ip</code> - </a></li>
<li><a href="#secrets_properties_cases_webhook"><code>secrets_properties_cases_webhook</code> - Connector secrets properties for Webhook - Case Management connector</a></li>
<li><a href="#secrets_properties_d3security"><code>secrets_properties_d3security</code> - Connector secrets properties for a D3 Security connector</a></li>
<li><a href="#secrets_properties_genai"><code>secrets_properties_genai</code> - Connector secrets properties for a generative AI connector</a></li>
<li><a href="#secrets_properties_jira"><code>secrets_properties_jira</code> - Connector secrets properties for a Jira connector</a></li>
<li><a href="#secrets_properties_opsgenie"><code>secrets_properties_opsgenie</code> - Connector secrets properties for an Opsgenie connector</a></li>
@ -1102,6 +1106,7 @@ Any modifications made to this file will be overwritten.
<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>
<li><a href="#update_connector_request_cases_webhook"><code>update_connector_request_cases_webhook</code> - Update Webhook - Case Managment connector request</a></li>
<li><a href="#update_connector_request_d3security"><code>update_connector_request_d3security</code> - Update D3 Security connector request</a></li>
<li><a href="#update_connector_request_index"><code>update_connector_request_index</code> - Update index connector request</a></li>
<li><a href="#update_connector_request_jira"><code>update_connector_request_jira</code> - Update Jira connector request</a></li>
<li><a href="#update_connector_request_opsgenie"><code>update_connector_request_opsgenie</code> - Update Opsgenie connector request</a></li>
@ -1385,6 +1390,13 @@ Any modifications made to this file will be overwritten.
<div class="param">viewIncidentUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The URL to view the case in the external system. You can use variables to add the external system ID or external system title to the URL. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="config_properties_d3security"><code>config_properties_d3security</code> - Connector request properties for a D3 Security connector</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Defines properties for connectors when type is <code>.d3security</code>.</div>
<div class="field-items">
<div class="param">url </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The D3 Security API request URL. 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="config_properties_genai"><code>config_properties_genai</code> - Connector request properties for a generative AI connector</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Defines properties for connectors when type is <code>.gen-ai</code>.</div>
@ -1526,6 +1538,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_d3security"><code>connector_response_properties_d3security</code> - Connector response properties for a D3 Security 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_d3security">config_properties_d3security</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">.d3security</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>
@ -1817,6 +1845,18 @@ Any modifications made to this file will be overwritten.
<div class="param">secrets (optional)</div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_cases_webhook">secrets_properties_cases_webhook</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="create_connector_request_d3security"><code>create_connector_request_d3security</code> - Create D3 Security connector request</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>The connector uses axios to send a POST request to a D3 Security endpoint.</div>
<div class="field-items">
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_d3security">config_properties_d3security</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">.d3security</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_d3security">secrets_properties_d3security</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="create_connector_request_email"><code>create_connector_request_email</code> - Create email connector request</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>The email connector uses the SMTP protocol to send mail messages, using an integration of Nodemailer. An exception is Microsoft Exchange, which uses HTTP protocol for sending emails, Send mail. Email message text is sent as both plain text and html text.</div>
@ -2378,6 +2418,13 @@ Any modifications made to this file will be overwritten.
<div class="param">user (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The username for HTTP basic authentication. If <code>hasAuth</code> is set to <code>true</code>, this property is required. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="secrets_properties_d3security"><code>secrets_properties_d3security</code> - Connector secrets properties for a D3 Security connector</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Defines secrets for connectors when type is <code>.d3security</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 D3 Security token. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="secrets_properties_genai"><code>secrets_properties_genai</code> - Connector secrets properties for a generative AI connector</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Defines secrets for connectors when type is <code>.gen-ai</code>.</div>
@ -2492,6 +2539,15 @@ Any modifications made to this file will be overwritten.
<div class="param">secrets (optional)</div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_cases_webhook">secrets_properties_cases_webhook</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="update_connector_request_d3security"><code>update_connector_request_d3security</code> - Update D3 Security 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_d3security">config_properties_d3security</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_d3security">secrets_properties_d3security</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="update_connector_request_index"><code>update_connector_request_index</code> - Update index connector request</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>

63
docs/management/connectors/action-types/d3security.asciidoc
View file

@ -3,21 +3,14 @@
++++
<titleabbrev>D3 Security</titleabbrev>
++++
:frontmatter-description: Add a connector that can send requests to D3 Security.
:frontmatter-tags-products: [alerting]
:frontmatter-tags-content-type: [how-to]
:frontmatter-tags-user-goals: [configure]
The D3 Security connector uses https://github.com/axios/axios[axios] to send a POST request to a D3 Security endpoint. The connector uses the <<execute-connector-api,run connector API>> to send the request. You can use the connector for rule actions.
[float]
[[d3security-connector-prerequisites]]
=== Prerequisites
To use a D3 Security connector, you must first configure a webhook key in your D3 SOAR environment. To generate an API URL and a token in D3 Security:
1. Log in to your D3 SOAR environment.
2. Navigate to Configuration.
3. Navigate to Integration > Search for “Kibana”. Click “Fetch Event”.
4. Select the "Enable Webhook" checkbox.
5. Click Set up Webhook Keys.
6. Under Event Ingestion, Click +. Select the site for the webhook integration, then click Generate.
7. Copy the Request URL and Request Header Value to configure the Kibana connector
To create this connector, you must first configure a webhook key in your D3 SOAR environment. For configuration tips, refer to <<configure-d3security>>.
[float]
[[define-d3security-ui]]
@ -36,35 +29,7 @@ D3 Security connectors have the following configuration properties:
Name:: The name of the connector.
URL:: The D3 Security API request URL.
Token:: The D3 Security token
[float]
[[preconfigured-d3security-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,text]
--
xpack.actions.preconfigured:
my-d3security:
name: preconfigured-d3security-connector-type
actionTypeId: .d3security
config:
url: https://testurl.com/elasticsearch/VSOC/api/Data/Kibana/Security%20Operations/CreateEvents
secrets:
token: superlongtoken
--
Config defines information for the connector type.
`url`:: A URL string that corresponds to the *D3 Security API URL*.
Secrets defines sensitive information for the connector type.
`token`:: A string that corresponds to *D3 Security API Token*.
Token:: The D3 Security token.
[float]
[[d3security-action-configuration]]
@ -88,4 +53,18 @@ this can be any type, it is not validated
[[d3security-connector-networking-configuration]]
=== Connector networking configuration
Use the <<action-settings, Action configuration settings>> to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use `xpack.actions.customHostSettings` to set per-host configurations.
Use the <<action-settings, Action configuration settings>> to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use `xpack.actions.customHostSettings` to set per-host configurations.
[float]
[[configure-d3security]]
=== Configure D3 Security
To generate an API URL and a token in D3 Security:
1. Log in to your D3 SOAR environment.
2. Navigate to *Configuration*.
3. Navigate to *Integration*. Search for {kib}. Click *Fetch Event*.
4. Select the *Enable Webhook* checkbox.
5. Click *Set up Webhook Keys*.
6. Under *Event Ingestion*, click the plus sign(+). Select the site for the webhook integration, then click *Generate*.
7. Copy the request URL and request header value to configure the connector.

23
docs/management/connectors/pre-configured-connectors.asciidoc
View file

@ -106,6 +106,7 @@ Index names must start with `kibana-alert-history-` to take advantage of the pre
[float]
=== Examples
* <<preconfigured-d3security-configuration>>
* <<preconfigured-resilient-configuration>>
* <<preconfigured-index-configuration>>
* <<preconfigured-jira-configuration>>
@ -117,6 +118,26 @@ Index names must start with `kibana-alert-history-` to take advantage of the pre
* <<preconfigured-cases-webhook-configuration>>
* <<preconfigured-xmatters-configuration>>
[float]
[[preconfigured-d3security-configuration]]
==== D3 Security connectors
The following example creates a <<d3security-action-type,D3 Security connector>>:
[source,text]
--
xpack.actions.preconfigured:
my-d3security:
name: preconfigured-d3security-connector-type
actionTypeId: .d3security
config:
url: https://testurl.com/elasticsearch/VSOC/api/Data/Kibana/Security%20Operations/CreateEvents <1>
secrets:
token: superlongtoken <2>
--
<1> The D3 Security API request URL.
<2> The D3 Security token.
[float]
[[preconfigured-resilient-configuration]]
==== {ibm-r} connectors
@ -126,7 +147,7 @@ The following example creates a <<resilient-action-type,{ibm-r} connector>>:
[source,text]
--
xpack.actions.preconfigured:
my-resilient:
my-resilient:
name: preconfigured-resilient-connector-type
actionTypeId: .resilient
config:

24
docs/settings/alert-action-settings.asciidoc
View file

@ -343,6 +343,15 @@ For a <<cases-webhook-action-type,{webhook-cm} connector>>, specifies the REST A
+
NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure the hostname in the URL is added to the allowed hosts.
`xpack.actions.preconfigured.<connector-id>.config.url`::
A configuration URL that varies by connector:
+
--
* For a <<d3security-action-type,D3 Security conector>>, specifies the D3 Security API request URL.
NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure this hostname is added to the allowed hosts.
--
`xpack.actions.preconfigured.<connector-id>.config.usesBasic`::
For an <<xmatters-action-type,xMatters connector>>, specifies whether it uses HTTP basic authentication. Defaults to `true`.
@ -397,7 +406,8 @@ NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure this
A token secret that varies by connector:
+
--
For a <<slack-action-type,Slack connector>>, specifies the Slack bot user OAuth token.
* 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.
--
`xpack.actions.preconfigured.<connector-id>.secrets.user`::
@ -407,16 +417,16 @@ A user name secret that varies by connector:
* For a <<cases-webhook-action-type,{webhook-cm} connector>>, specifies a user name that is required when `xpack.actions.preconfigured.<connector-id>.config.hasAuth` is `true`.
* For an <<xmatters-action-type,xMatters connector>>, specifies a user name that is required when `xpack.actions.preconfigured.<connector-id>.config.usesBasic` is `true`.
--
`xpack.actions.preconfigured.<connector-id>.secrets.webhookUrl`::
For a <<teams-action-type,Microsoft Teams>>, specifies the URL of the incoming webhook.
A URL that varies by connector:
+
NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure the hostname is added to the allowed hosts.
`xpack.actions.preconfigured.<connector-id>.secrets.webhookUrl`::
--
* For a <<teams-action-type,Microsoft Teams>>, specifies the URL of the incoming webhook.
For a <<slack-action-type,Slack connector>>, specifies the Slack webhook URL.
+
NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure the hostname is added to the allowed hosts.
--
[float]
[[alert-settings]]

138
x-pack/plugins/actions/docs/openapi/bundled.json
View file

@ -60,6 +60,9 @@
{
"$ref": "#/components/schemas/create_connector_request_cases_webhook"
},
{
"$ref": "#/components/schemas/create_connector_request_d3security"
},
{
"$ref": "#/components/schemas/create_connector_request_email"
},
@ -329,6 +332,9 @@
{
"$ref": "#/components/schemas/create_connector_request_cases_webhook"
},
{
"$ref": "#/components/schemas/create_connector_request_d3security"
},
{
"$ref": "#/components/schemas/create_connector_request_email"
},
@ -451,6 +457,9 @@
{
"$ref": "#/components/schemas/update_connector_request_cases_webhook"
},
{
"$ref": "#/components/schemas/update_connector_request_d3security"
},
{
"$ref": "#/components/schemas/update_connector_request_index"
},
@ -1563,6 +1572,66 @@
}
}
},
"config_properties_d3security": {
"title": "Connector request properties for a D3 Security connector",
"description": "Defines properties for connectors when type is `.d3security`.",
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "The D3 Security API request URL. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.\n"
}
}
},
"secrets_properties_d3security": {
"title": "Connector secrets properties for a D3 Security connector",
"description": "Defines secrets for connectors when type is `.d3security`.",
"required": [
"token"
],
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "The D3 Security token."
}
}
},
"create_connector_request_d3security": {
"title": "Create D3 Security connector request",
"description": "The connector uses axios to send a POST request to a D3 Security endpoint.\n",
"type": "object",
"required": [
"config",
"connector_type_id",
"name",
"secrets"
],
"properties": {
"config": {
"$ref": "#/components/schemas/config_properties_d3security"
},
"connector_type_id": {
"type": "string",
"description": "The type of connector.",
"enum": [
".d3security"
],
"example": ".d3security"
},
"name": {
"type": "string",
"description": "The display name for the connector.",
"example": "my-connector"
},
"secrets": {
"$ref": "#/components/schemas/secrets_properties_d3security"
}
}
},
"config_properties_email": {
"title": "Connector request properties for an email connector",
"description": "Defines properties for connectors when type is `.email`.",
@ -2894,6 +2963,50 @@
}
}
},
"connector_response_properties_d3security": {
"title": "Connector response properties for a D3 Security connector",
"type": "object",
"required": [
"config",
"connector_type_id",
"id",
"is_deprecated",
"is_preconfigured",
"name"
],
"properties": {
"config": {
"$ref": "#/components/schemas/config_properties_d3security"
},
"connector_type_id": {
"type": "string",
"description": "The type of connector.",
"enum": [
".d3security"
]
},
"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_email": {
"title": "Connector response properties for an email connector",
"type": "object",
@ -3641,6 +3754,9 @@
{
"$ref": "#/components/schemas/connector_response_properties_cases_webhook"
},
{
"$ref": "#/components/schemas/connector_response_properties_d3security"
},
{
"$ref": "#/components/schemas/connector_response_properties_email"
},
@ -3718,6 +3834,27 @@
}
}
},
"update_connector_request_d3security": {
"title": "Update D3 Security connector request",
"type": "object",
"required": [
"config",
"name",
"secrets"
],
"properties": {
"config": {
"$ref": "#/components/schemas/config_properties_d3security"
},
"name": {
"type": "string",
"description": "The display name for the connector."
},
"secrets": {
"$ref": "#/components/schemas/secrets_properties_d3security"
}
}
},
"update_connector_request_index": {
"title": "Update index connector request",
"type": "object",
@ -3974,6 +4111,7 @@
"description": "The type of connector. For example, `.email`, `.index`, `.jira`, `.opsgenie`, or `.server-log`.",
"enum": [
".cases-webhook",
".d3security",
".email",
".gen-ai",
".index",

98
x-pack/plugins/actions/docs/openapi/bundled.yaml
View file

@ -38,6 +38,7 @@ paths:
description: The properties vary depending on the connector type.
oneOf:
- $ref: '#/components/schemas/create_connector_request_cases_webhook'
- $ref: '#/components/schemas/create_connector_request_d3security'
- $ref: '#/components/schemas/create_connector_request_email'
- $ref: '#/components/schemas/create_connector_request_genai'
- $ref: '#/components/schemas/create_connector_request_index'
@ -186,6 +187,7 @@ paths:
description: The properties vary depending on the connector type.
oneOf:
- $ref: '#/components/schemas/create_connector_request_cases_webhook'
- $ref: '#/components/schemas/create_connector_request_d3security'
- $ref: '#/components/schemas/create_connector_request_email'
- $ref: '#/components/schemas/create_connector_request_genai'
- $ref: '#/components/schemas/create_connector_request_index'
@ -243,6 +245,7 @@ paths:
description: The properties vary depending on the connector type.
oneOf:
- $ref: '#/components/schemas/update_connector_request_cases_webhook'
- $ref: '#/components/schemas/update_connector_request_d3security'
- $ref: '#/components/schemas/update_connector_request_index'
- $ref: '#/components/schemas/update_connector_request_jira'
- $ref: '#/components/schemas/update_connector_request_opsgenie'
@ -948,6 +951,52 @@ components:
example: my-connector
secrets:
$ref: '#/components/schemas/secrets_properties_cases_webhook'
config_properties_d3security:
title: Connector request properties for a D3 Security connector
description: Defines properties for connectors when type is `.d3security`.
type: object
required:
- url
properties:
url:
type: string
description: |
The D3 Security API request URL. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
secrets_properties_d3security:
title: Connector secrets properties for a D3 Security connector
description: Defines secrets for connectors when type is `.d3security`.
required:
- token
type: object
properties:
token:
type: string
description: The D3 Security token.
create_connector_request_d3security:
title: Create D3 Security connector request
description: |
The connector uses axios to send a POST request to a D3 Security endpoint.
type: object
required:
- config
- connector_type_id
- name
- secrets
properties:
config:
$ref: '#/components/schemas/config_properties_d3security'
connector_type_id:
type: string
description: The type of connector.
enum:
- .d3security
example: .d3security
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: '#/components/schemas/secrets_properties_d3security'
config_properties_email:
title: Connector request properties for an email connector
description: Defines properties for connectors when type is `.email`.
@ -1981,6 +2030,38 @@ components:
name:
type: string
description: The display name for the connector.
connector_response_properties_d3security:
title: Connector response properties for a D3 Security connector
type: object
required:
- config
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: '#/components/schemas/config_properties_d3security'
connector_type_id:
type: string
description: The type of connector.
enum:
- .d3security
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_email:
title: Connector response properties for an email connector
type: object
@ -2524,6 +2605,7 @@ components:
description: The properties vary depending on the connector type.
oneOf:
- $ref: '#/components/schemas/connector_response_properties_cases_webhook'
- $ref: '#/components/schemas/connector_response_properties_d3security'
- $ref: '#/components/schemas/connector_response_properties_email'
- $ref: '#/components/schemas/connector_response_properties_index'
- $ref: '#/components/schemas/connector_response_properties_jira'
@ -2558,6 +2640,21 @@ components:
example: my-connector
secrets:
$ref: '#/components/schemas/secrets_properties_cases_webhook'
update_connector_request_d3security:
title: Update D3 Security connector request
type: object
required:
- config
- name
- secrets
properties:
config:
$ref: '#/components/schemas/config_properties_d3security'
name:
type: string
description: The display name for the connector.
secrets:
$ref: '#/components/schemas/secrets_properties_d3security'
update_connector_request_index:
title: Update index connector request
type: object
@ -2742,6 +2839,7 @@ components:
description: The type of connector. For example, `.email`, `.index`, `.jira`, `.opsgenie`, or `.server-log`.
enum:
- .cases-webhook
- .d3security
- .email
- .gen-ai
- .index

11
x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_d3security.yaml Normal file
View file

@ -0,0 +1,11 @@
title: Connector request properties for a D3 Security connector
description: Defines properties for connectors when type is `.d3security`.
type: object
required:
- url
properties:
url:
type: string
description: >
The D3 Security API request URL.
If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.

1
x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties.yaml
View file

@ -2,6 +2,7 @@ title: Connector response properties
description: The properties vary depending on the connector type.
oneOf:
- $ref: 'connector_response_properties_cases_webhook.yaml'
- $ref: 'connector_response_properties_d3security.yaml'
- $ref: 'connector_response_properties_email.yaml'
- $ref: 'connector_response_properties_index.yaml'
- $ref: 'connector_response_properties_jira.yaml'

31
x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_d3security.yaml Normal file
View file

@ -0,0 +1,31 @@
title: Connector response properties for a D3 Security connector
type: object
required:
- config
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: 'config_properties_d3security.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .d3security
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.

1
x-pack/plugins/actions/docs/openapi/components/schemas/connector_types.yaml
View file

@ -3,6 +3,7 @@ type: string
description: The type of connector. For example, `.email`, `.index`, `.jira`, `.opsgenie`, or `.server-log`.
enum:
- .cases-webhook
- .d3security
- .email
- .gen-ai
- .index

24
x-pack/plugins/actions/docs/openapi/components/schemas/create_connector_request_d3security.yaml Normal file
View file

@ -0,0 +1,24 @@
title: Create D3 Security connector request
description: >
The connector uses axios to send a POST request to a D3 Security endpoint.
type: object
required:
- config
- connector_type_id
- name
- secrets
properties:
config:
$ref: 'config_properties_d3security.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .d3security
example: .d3security
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_d3security.yaml'

9
x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_d3security.yaml Normal file
View file

@ -0,0 +1,9 @@
title: Connector secrets properties for a D3 Security connector
description: Defines secrets for connectors when type is `.d3security`.
required:
- token
type: object
properties:
token:
type: string
description: The D3 Security token.

14
x-pack/plugins/actions/docs/openapi/components/schemas/update_connector_request_d3security.yaml Normal file
View file

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

1
x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector.yaml
View file

@ -17,6 +17,7 @@ post:
description: The properties vary depending on the connector type.
oneOf:
- $ref: '../components/schemas/create_connector_request_cases_webhook.yaml'
- $ref: '../components/schemas/create_connector_request_d3security.yaml'
- $ref: '../components/schemas/create_connector_request_email.yaml'
- $ref: '../components/schemas/create_connector_request_genai.yaml'
- $ref: '../components/schemas/create_connector_request_index.yaml'

2
x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector@{connectorid}.yaml
View file

@ -101,6 +101,7 @@ post:
description: The properties vary depending on the connector type.
oneOf:
- $ref: '../components/schemas/create_connector_request_cases_webhook.yaml'
- $ref: '../components/schemas/create_connector_request_d3security.yaml'
- $ref: '../components/schemas/create_connector_request_email.yaml'
- $ref: '../components/schemas/create_connector_request_genai.yaml'
- $ref: '../components/schemas/create_connector_request_index.yaml'
@ -159,6 +160,7 @@ put:
description: The properties vary depending on the connector type.
oneOf:
- $ref: '../components/schemas/update_connector_request_cases_webhook.yaml'
- $ref: '../components/schemas/update_connector_request_d3security.yaml'
# - $ref: '../components/schemas/update_connector_request_email.yaml'
# - $ref: '../components/schemas/create_connector_request_genai.yaml'
- $ref: '../components/schemas/update_connector_request_index.yaml'