You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/sentinel/stix-objects-api.md
+20-7Lines changed: 20 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -88,7 +88,7 @@ Method: `POST`<br>
88
88
#### Request body
89
89
The JSON object for the body contains the following fields:
90
90
91
-
|Field name|Data Type|Description|
91
+
|Field name|Data Type|Description|
92
92
|---|---|---|
93
93
|`sourcesystem` (required) | string | Identify your source system name. The value `Microsoft Sentinel` is restricted.|
94
94
|`stixobjects` (required) | array | An array of STIX objects in [STIX 2.0 or 2.1 format](https://docs.oasis-open.org/cti/stix/v2.1/cs01/stix-v2.1-cs01.html#_muftrcpnf89v)|
@@ -99,11 +99,11 @@ Create the array of STIX objects using the STIX format specification. Some of th
99
99
100
100
All the objects you import with the upload API share these common properties.
101
101
102
-
|Property Name|Type |Description |
102
+
|Property Name|Type |Description |
103
103
|----|----|----|
104
104
|`id` (required)| string | An ID used to identify the STIX object. See section [2.9](https://docs.oasis-open.org/cti/stix/v2.1/cs01/stix-v2.1-cs01.html#_64yvzeku5a5c) for specifications on how to create an `id`. The format looks something like `indicator--<UUID>`|
105
105
|`spec_version` (optional) | string | STIX object version. This value is required in the STIX specification, but since this API only supports STIX 2.0 and 2.1, when this field isn't set, the API defaults to `2.1`|
106
-
|`type` (required)|string | The value of this property *must* be a supported STIX object.|
106
+
|`type` (required)|string | The value of this property *must* be a supported STIX object.|
107
107
|`created` (required) | timestamp | See section [3.2](https://docs.oasis-open.org/cti/stix/v2.1/cs01/stix-v2.1-cs01.html#_xzbicbtscatx) for specifications of this common property.|
108
108
|`created_by_ref` (optional) | string | The created_by_ref property specifies the ID property of the entity that created this object.<br><br>If this attribute is omitted, the source of this information is undefined. For object creators who wish to remain anonymous, keep this value undefined.|
109
109
|`modified` (required) | timestamp | See section [3.2](https://docs.oasis-open.org/cti/stix/v2.1/cs01/stix-v2.1-cs01.html#_xzbicbtscatx) for specifications of this common property.|
@@ -119,9 +119,9 @@ For more information, see [STIX common properties](https://docs.oasis-open.org/c
119
119
120
120
#### Indicator
121
121
122
-
|Property Name|Type |Description |
122
+
|Property Name|Type |Description |
123
123
|----|----|----|
124
-
|`name` (optional)|string | A name used to identify the indicator.<br><br>Producers *should* provide this property to help products and analysts understand what this indicator actually does.|
124
+
|`name` (optional)|string | A name used to identify the indicator.<br><br>Producers *should* provide this property to help products and analysts understand what this indicator actually does.|
125
125
|`description` (optional) | string | A description that provides more details and context about the indicator, potentially including its purpose and its key characteristics.<br><br>Producers *should* provide this property to help products and analysts understand what this indicator actually does. |
126
126
|`indicator_types` (optional) | list of strings | A set of categorizations for this indicator.<br><br>The values for this property *should* come from the [indicator-type-ov](https://docs.oasis-open.org/cti/stix/v2.1/cs01/stix-v2.1-cs01.html#_cvhfwe3t9vuo)|
127
127
|`pattern` (required) | string | The detection pattern for this indicator *might* be expressed as a [STIX Patterning](https://docs.oasis-open.org/cti/stix/v2.1/cs01/stix-v2.1-cs01.html#_e8slinrhxcc9) or another appropriate language such as SNORT, YARA, etc. |
@@ -135,18 +135,26 @@ For more information, see [STIX indicator](https://docs.oasis-open.org/cti/stix/
135
135
136
136
#### Attack pattern
137
137
138
+
Follow the STIX specifications for creating an attack pattern STIX object. Use [this example](#sample-attack-pattern) as an extra reference.
139
+
138
140
For more information, see [STIX attack pattern](https://docs.oasis-open.org/cti/stix/v2.1/os/stix-v2.1-os.html#_axjijf603msy).
139
141
140
142
#### Identity
141
143
144
+
Follow the STIX specifications for creating an identity STIX object. Use [this example](#sample-relationship-with-threat-actor-and-identity) as an extra reference.
145
+
142
146
For more information, see [STIX identity](https://docs.oasis-open.org/cti/stix/v2.1/os/stix-v2.1-os.html#_wh296fiwpklp).
143
147
144
148
#### Threat actor
145
149
150
+
Follow the STIX specifications for creating a threat actor STIX object. Use [this example](#sample-relationship-with-threat-actor-and-identity) as an extra reference.
151
+
146
152
For more information, see [STIX threat actor](https://docs.oasis-open.org/cti/stix/v2.1/os/stix-v2.1-os.html#_k017w16zutw).
147
153
148
154
#### Relationship
149
155
156
+
Follow the STIX specifications for creating a relationship STIX object. Use [this example](#sample-relationship-with-threat-actor-and-identity) as an extra reference.
157
+
150
158
For more information, see [STIX relationship](https://docs.oasis-open.org/cti/stix/v2.1/os/stix-v2.1-os.html#_e2e1szrqfoan).
151
159
152
160
### Process the response message
@@ -166,7 +174,7 @@ The response body is an array of error messages in JSON format:
166
174
167
175
|Field name | Data Type | Description |
168
176
|----|----|----|
169
-
|errors| Array of error objects | List of validation errors |
177
+
|errors| Array of error objects | List of validation errors |
170
178
171
179
**Error object**
172
180
@@ -291,6 +299,9 @@ The objects are sent as an array, so the `recordIndex` begins at `0`.
291
299
292
300
In this example, the indicator is marked with the green TLP by using `marking-definition--089a6ecb-cc15-43cc-9494-767639779123` in the `object_marking_refs` common property. More extension attributes of `toxicity` and `rank` are also included. Although these properties aren't in the Microsoft Sentinel schema for indicators, ingesting an object with these properties doesn't trigger an error. The properties simply aren't referenced or indexed in the workspace.
293
301
302
+
> [!NOTE]
303
+
> This indicator has the `revoked` property set to `$true` and its `valid_until` date is in the past. This indicator as is doesn't work in analytics rules and doesn't return in queries unless an appropriate time range is specified.
304
+
294
305
```json
295
306
{
296
307
"sourcesystem": "TestStixObjects",
@@ -364,6 +375,8 @@ In this example, the indicator is marked with the green TLP by using `marking-de
364
375
365
376
#### Sample attack pattern
366
377
378
+
This attack pattern is only viewable in the management interface if you opt in to the new STIX tables. For more information about the tables required to view objects like this in KQL, see [View your threat intelligence](understand-threat-intelligence.md#view-your-threat-intelligence).
379
+
367
380
```json
368
381
{
369
382
"sourcesystem": "TestStixObjects",
@@ -601,4 +614,4 @@ To learn more about how to work with threat intelligence in Microsoft Sentinel,
0 commit comments