Skip to content

Commit 5120bbc

Browse files
adding clarity about working examples based on user feedback
1 parent 80f8d5d commit 5120bbc

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

articles/sentinel/stix-objects-api.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Method: `POST`<br>
8888
#### Request body
8989
The JSON object for the body contains the following fields:
9090

91-
|Field name |Data Type |Description|
91+
|Field name |Data Type |Description|
9292
|---|---|---|
9393
| `sourcesystem` (required) | string | Identify your source system name. The value `Microsoft Sentinel` is restricted.|
9494
| `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
9999

100100
All the objects you import with the upload API share these common properties.
101101

102-
|Property Name |Type | Description |
102+
|Property Name |Type | Description |
103103
|----|----|----|
104104
|`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>`|
105105
|`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.|
107107
|`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.|
108108
|`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.|
109109
|`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
119119

120120
#### Indicator
121121

122-
|Property Name |Type | Description |
122+
|Property Name |Type | Description |
123123
|----|----|----|
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.|
125125
|`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. |
126126
|`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) |
127127
|`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/
135135

136136
#### Attack pattern
137137

138+
Follow the STIX specifications for creating an attack pattern STIX object. Use [this example](#sample-attack-pattern) as an extra reference.
139+
138140
For more information, see [STIX attack pattern](https://docs.oasis-open.org/cti/stix/v2.1/os/stix-v2.1-os.html#_axjijf603msy).
139141

140142
#### Identity
141143

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+
142146
For more information, see [STIX identity](https://docs.oasis-open.org/cti/stix/v2.1/os/stix-v2.1-os.html#_wh296fiwpklp).
143147

144148
#### Threat actor
145149

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+
146152
For more information, see [STIX threat actor](https://docs.oasis-open.org/cti/stix/v2.1/os/stix-v2.1-os.html#_k017w16zutw).
147153

148154
#### Relationship
149155

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+
150158
For more information, see [STIX relationship](https://docs.oasis-open.org/cti/stix/v2.1/os/stix-v2.1-os.html#_e2e1szrqfoan).
151159

152160
### Process the response message
@@ -166,7 +174,7 @@ The response body is an array of error messages in JSON format:
166174

167175
|Field name | Data Type | Description |
168176
|----|----|----|
169-
|errors | Array of error objects | List of validation errors |
177+
|errors | Array of error objects | List of validation errors |
170178

171179
**Error object**
172180

@@ -291,6 +299,9 @@ The objects are sent as an array, so the `recordIndex` begins at `0`.
291299

292300
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.
293301

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+
294305
```json
295306
{
296307
"sourcesystem": "TestStixObjects",
@@ -364,6 +375,8 @@ In this example, the indicator is marked with the green TLP by using `marking-de
364375

365376
#### Sample attack pattern
366377

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+
367380
```json
368381
{
369382
"sourcesystem": "TestStixObjects",
@@ -601,4 +614,4 @@ To learn more about how to work with threat intelligence in Microsoft Sentinel,
601614
- [Understand threat intelligence](understand-threat-intelligence.md)
602615
- [Work with threat indicators](work-with-threat-indicators.md)
603616
- [Use matching analytics to detect threats](use-matching-analytics-to-detect-threats.md)
604-
- Utilize the intelligence feed from Microsoft and [enable MDTI data connector](connect-mdti-data-connector.md)
617+
- Utilize the intelligence feed from Microsoft and [enable the MDTI data connector](connect-mdti-data-connector.md)

0 commit comments

Comments
 (0)