Skip to content

Commit f1d1155

Browse files
committed
chore: Update config Schema
1 parent 84475f7 commit f1d1155

File tree

2 files changed

+35
-4
lines changed

2 files changed

+35
-4
lines changed
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Connector Configurations
2+
3+
Below is an exhaustive enumeration of all configurable parameters available, each accompanied by detailed explanations of their purposes, default behaviors, and usage guidelines to help you understand and utilize them effectively.
4+
5+
### Type: `object`
6+
7+
| Property | Type | Required | Possible values | Deprecated | Default | Description |
8+
| -------- | ---- | -------- | --------------- | ---------- | ------- | ----------- |
9+
| OPENCTI_URL | `string` || Format: [`uri`](https://json-schema.org/understanding-json-schema/reference/string#built-in-formats) | | | The base URL of the OpenCTI instance. |
10+
| OPENCTI_TOKEN | `string` || string | | | The API token to connect to OpenCTI. |
11+
| CONNECTOR_LIVE_STREAM_ID | `string` || string | | | The ID of the live stream to connect to. |
12+
| MICROSOFT_SENTINEL_INTEL_TENANT_ID | `string` || string | | | Your Azure App Tenant ID, see the screenshot to help you find this information. |
13+
| MICROSOFT_SENTINEL_INTEL_CLIENT_ID | `string` || string | | | Your Azure App Client ID, see the screenshot to help you find this information. |
14+
| MICROSOFT_SENTINEL_INTEL_CLIENT_SECRET | `string` || Format: [`password`](https://json-schema.org/understanding-json-schema/reference/string#built-in-formats) | | | Your Azure App Client secret, See the screenshot to help you find this information. |
15+
| MICROSOFT_SENTINEL_INTEL_WORKSPACE_ID | `string` || string | | | Your Azure Workspace ID |
16+
| MICROSOFT_SENTINEL_INTEL_WORKSPACE_NAME | `string` || string | | | The name of the log analytics workspace |
17+
| MICROSOFT_SENTINEL_INTEL_SUBSCRIPTION_ID | `string` || string | | | The subscription id where the Log Analytics is |
18+
| CONNECTOR_NAME | `string` | | string | | `"MicrosoftSentinelIntel"` | The name of the connector. |
19+
| CONNECTOR_SCOPE | `array` | | string | | `["sentinel"]` | The scope of the stream connector. |
20+
| CONNECTOR_LOG_LEVEL | `string` | | `debug` `info` `warn` `warning` `error` | | `"error"` | The minimum level of logs to display. |
21+
| CONNECTOR_TYPE | `const` | | `STREAM` | | `"STREAM"` | |
22+
| CONNECTOR_LIVE_STREAM_LISTEN_DELETE | `boolean` | | boolean | | `true` | Whether to listen for delete events on the live stream. |
23+
| CONNECTOR_LIVE_STREAM_NO_DEPENDENCIES | `boolean` | | boolean | | `true` | Whether to ignore dependencies when processing events from the live stream. |
24+
| MICROSOFT_SENTINEL_INTEL_SOURCE_SYSTEM | `string` | | string | | `"Opencti Stream Connector"` | The name of the source system displayed in Microsoft Sentinel |
25+
| MICROSOFT_SENTINEL_INTEL_DELETE_EXTENSIONS | `boolean` | | boolean | | `true` | Delete the extensions in the stix bundle sent to the SIEM |
26+
| MICROSOFT_SENTINEL_INTEL_EXTRA_LABELS | `array` | | string | | `[]` | Extra labels added to the bundle sent. String separated by comma |
27+
| MICROSOFT_SENTINEL_INTEL_WORKSPACE_API_VERSION | `string` | | string | | `"2024-02-01-preview"` | API version of the Microsoft log analytics workspace interface |
28+
| MICROSOFT_SENTINEL_INTEL_MANAGEMENT_API_VERSION | `string` | | string | | `"2025-03-01"` | API version of the Microsoft management interface |
29+
| MICROSOFT_SENTINEL_INTEL_RESOURCE_GROUP | `string` | | string | ⛔️ | `"default"` | The name of the resource group where the log analytics is |

stream/microsoft-sentinel-intel/__metadata__/connector_config_schema.json

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@
2020
"type": "string"
2121
},
2222
"CONNECTOR_SCOPE": {
23-
"default": "sentinel",
23+
"default": [
24+
"sentinel"
25+
],
2426
"description": "The scope of the stream connector.",
2527
"items": {
2628
"type": "string"
@@ -45,18 +47,17 @@
4547
"type": "string"
4648
},
4749
"CONNECTOR_LIVE_STREAM_ID": {
48-
"default": "live",
4950
"description": "The ID of the live stream to connect to.",
5051
"type": "string"
5152
},
5253
"CONNECTOR_LIVE_STREAM_LISTEN_DELETE": {
5354
"default": true,
54-
"description": "Whether to listen for delete events in the live stream.",
55+
"description": "Whether to listen for delete events on the live stream.",
5556
"type": "boolean"
5657
},
5758
"CONNECTOR_LIVE_STREAM_NO_DEPENDENCIES": {
5859
"default": true,
59-
"description": "Whether to avoid fetching dependencies for the objects received in the live stream.",
60+
"description": "Whether to ignore dependencies when processing events from the live stream.",
6061
"type": "boolean"
6162
},
6263
"MICROSOFT_SENTINEL_INTEL_TENANT_ID": {
@@ -123,6 +124,7 @@
123124
"required": [
124125
"OPENCTI_URL",
125126
"OPENCTI_TOKEN",
127+
"CONNECTOR_LIVE_STREAM_ID",
126128
"MICROSOFT_SENTINEL_INTEL_TENANT_ID",
127129
"MICROSOFT_SENTINEL_INTEL_CLIENT_ID",
128130
"MICROSOFT_SENTINEL_INTEL_CLIENT_SECRET",

0 commit comments

Comments
 (0)