Modify Artifact
LAST UPDATED: MAR 27, 2024
This command can only be executed in the "On Event Ingestion" trigger within an event playbook. Adds extra fields or makes changes to the existing artifacts.
READER NOTE
Please note that this command is only applicable within an event Playbook.
Implementation | Python |
Command Category | System Utility |
Tags | ARTIFACT |
Inputs
Parameter Name | Required/Optional | Description | Sample Data |
---|---|---|---|
Source Type | Optional | NOT AVAILABLE |
|
Artifact Type | Optional | Select a type of artifat to modify |
|
Filter Condition | Optional | Identity fields of the artifact type; only the artifacts match all the fields will be modified |
JSON
|
JSON Object to update | Optional | The fields to be updated to the matching artifacts. For custom Artifacts, only "REP" is allowed to be updated |
|
Output
Remote Command API
The D3 command API allows you to send requests to D3 SOAR to execute this utility command via REST API.
Request
POST
https:/{base_url}/{api_namespace}/api/Command/modifyArtifact
Headers
Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.
Request Body
{
"Username": <Username here>,
"Site": <Site here>,
"CommandParams": {
"Source Type": <Source Type here>,
"Artifact Type": <Artifact Type here>,
"Filter Condition": [
{
"Field": <Field 1 here>,
"Operator": <Operator 1 here>,
"value": <Value 1 here>,
"condition": <Condition 1 here>
},
{
"Field": <Field 2 here>,
"Operator": <Operator 2 here>,
"value": <Value 2 here>,
"condition": <Condition 2 here>
}
],
"JSON Object to update": <JSON Object to update here>
}
}
Body Parameters
Parameter Name | Type | Required/Optional | Description |
---|---|---|---|
Username |
| Required | The username of your D3 SOAR account. |
Site |
| Required | The D3 SOAR site to run the remote command. |
Source Type |
| Optional | NOT AVAILABLE |
Artifact Type |
| Optional | Select a type of artifat to modify |
Filter Condition |
| Optional | Identity fields of the artifact type; only the artifacts match all the fields will be modified |
JSON Object to update |
| Optional | The fields to be updated to the matching artifacts. For custom Artifacts, only "REP" is allowed to be updated |
Sample Request
SAMPLE DATA
{
"Username": "Admin",
"Site": "Security Operations",
"CommandParams": {
"Source Type": "Trigger Output Data",
"Artifact Type": "User",
"Filter Condition": [
{
"Field": "$.UserName",
"Operator": "=",
"value": "user1",
"condition": "OR"
},
{
"Field": "$.UserName",
"Operator": "=",
"value": "user2",
"condition": ""
}
],
"JSON Object to update": "{\"UserName\" : \"NewUser\", \"REP\"}"
}
}
Response
Response Fields
Field Name | Type | Description |
---|---|---|
error |
| The error message if the API request has failed. |
returnData |
| The return data from the API request. |
Sample Response
{
"error": "",
"returnData": {
"Users": [
{
"UserName": "NewUser"
},
{
"UserName": "NewUser",
"REP": {
"RiskLevel": "low",
"RiskResult1": null,
"RiskResult2": null,
"Resource": "",
"UTCDateModified": null
}
}
]
}
}