Microsoft Defender Advanced Threat Protection
Microsoft Defender for Endpoint (previously Microsoft Defender Advanced Threat Protection (ATP)) is a unified platform for preventative protection, post-breach detection, automated investigation, and response.
Endpoint · Microsoft Defender for Endpoint
Details
| ID | Microsoft Defender Advanced Threat Protection |
|---|---|
| Provider | Microsoft |
| Category | Endpoint |
| From Version | 5.0.0 |
| Docker Image | demisto/crypto:1.0.0.11658507 |
| Supported Modules | Agentix XSIAM EDR Cortex Cloud Cloud Runtime Security |
README
Overview
Use the Microsoft Defender for Endpoint (previously Microsoft Defender Advanced Threat Protection (ATP)) integration for preventative protection, post-breach detection, automated investigation, and response.
Deprecation Announcement
Note: Following this announcement by Microsoft about migrating from the deprecated SIEM API to the Graph API, we are deprecating the following:
- 14 commands
- Fetch-incidents functionality
Replacement Options
- Some commands have direct replacements in the Microsoft Graph Security integration.
- Others do not have exact replacements but offer alternatives that return similar data.
- A few commands have no available replacements.
See Deprecation Details to find details on the deprecated commands and their replacements or alternatives.
Microsoft Defender Advanced Threat Protection Playbook
Microsoft Defender Advanced Threat Protection Get Machine Action Status
Use Cases
- Fetching incidents.
- Managing machines and performing actions on them.
- Blocking files and applications.
- Uploading and digesting threat indicators for the actions of allow, block, or alert.
Authentication
Microsoft integrations (Graph and Azure) in Cortex use Entra ID applications to authenticate with Microsoft APIs. These integrations use OAuth 2.0 and OpenID Connect standard-compliant authentication services, which use an Application to sign-in or delegate authentication. For more information, see the Microsoft identity platform overview.
Two application authentication methods are available:
For more details about the authentication used in this integration, see Microsoft Integrations - Authentication.
Note: When using the Authorization Code flow (either via the Cortex XSOAR application or by choosing delegated permissions for a self-deployed app), ensure the authenticated user has the required role permissions. This can be done via the Microsoft Defender Portal:
- If you are using the new unified RBAC permissions model, navigate to Defender Portal > Permissions and select Roles under Microsoft Defender XDR.
- If you are using the legacy permissions model, navigate to Defender Portal > Settings > Endpoints > Roles.
For a detailed comparison between the new and legacy permission models, refer to the permission mapping table.
Cortex XSOAR Application
To configure Cortex XSOAR application access to Microsoft Defender for Endpoint:
- Navigate to the Cortex Authorization page for Microsoft Defender for Endpoint.
- Select the user account with sufficient role permissions.
- After authorizing the application, copy the ID, Token, and Key values and insert them in integration instance settings corresponding fields.
- Ensure Authentication Type field is set to the Authorization Code option.
- Save the instance.
- Run the
!microsoft-atp-testcommand in the War Room to verify correct configuration.
Self-deployed Azure Application
- Navigate to the Azure portal and search for Microsoft Entra ID.
- On the App registrations page, click New registration.
- Click API Permissions > Add permission > APIs my organization uses, and type WindowsDefenderATP.
- Choose the type of permissions:
- Delegated Permissions - used by applications that act on behalf of a signed-in user. The application will have access to the resources that the user has access to, limited by the permissions granted to the application. Choose this option if you prefer the Authorization Code flow.
- Application Permissions - used by applications that run without a signed-in user. The application acts as its own identity and is granted direct access to data or resources. This is common for background services or daemons. Choose this option if you prefer the the Client Credentials flow.
- Select the permissions required by the integration (based on the chosen permission type), click Add permissions and Grant consent.
- To add a secret to the application, select Certificates & secrets, add a meaningful description, and click Add.
- In the integration instance settings, select the Use a self-deployed Azure Application checkbox and copy the application details based on the chosen permissions type:
- For Delegated Permissions:
- In the ID field, enter the application (client) ID.
- In the Token field, enter the directory (tenant) ID.
- In the Key field, enter the client secret.
- In the Authentication Type field, select the Authorization Code option.
- In the Application Redirect URI field, enter the Application redirect URI.
- Save the instance.
- Run the
!microsoft-atp-generate-login-urlcommand in the War Room and follow the instructions.
- For Application Permissions:
- In the ID field, enter the application (client) ID.
- In the Token field, enter the directory (tenant) ID.
- In the Key field, enter the client secret.
- In the Authentication Type field, select the Client Credentials option.
- Click Test to verify correct configuration.
- Save the instance.
- For Delegated Permissions:
Note: If you previously configured the Windows Defender ATP integration, you need to perform the authentication flow again for this integration and enter the authentication parameters you receive when configuring the integration instance.
Required Permissions
Add the following WindowsDefenderATP API permissions during app registration.
Choose Application Permissions for the Client Credentials flow, or Delegated Permissions for the Authorization Code flow.
- AdvancedQuery.Read.All - Application / AdvancedQuery.Read - Delegated
- Alert.ReadWrite.All - Application / Alert.ReadWrite - Delegated
- File.Read.All - Application / Delegated
- Ip.Read.All - Application / Delegated
- Machine.CollectForensics - Application / Delegated
- Machine.Isolate - Application / Delegated
- Machine.ReadWrite.All - Application / Machine.ReadWrite - Delegated
- Machine.RestrictExecution - Application / Delegated
- Machine.Scan - Application / Delegated
- Machine.StopAndQuarantine - Application / Delegated
- ThreatIndicators.ReadWrite.OwnedBy - Application / Delegated.
Note: This permission is only used for the deprecated!microsoft-atp-indicator-listcommand. If you are not using this command, it is not required. - Url.Read.All - Application / Delegated
- User.Read.All - Application / Delegated
- Ti.ReadWrite (Read and write IOCs belonging to the app) - Application / Delegated
- Vulnerability.Read.All - Application / Vulnerability.Read - Delegated
- Software.Read.All - Application / Software.Read - Delegated
- Machine.LiveResponse - Application / Delegated
- Machine.Read.All - Application / Machine.Read - Delegated
Note: Access permissions can be verified by running the !microsoft-atp-list-auth-permissions command after configuring the integration instance.
Configure Microsoft Defender for Endpoint in Cortex
| Parameter | Description | Example |
|---|---|---|
| Name | A meaningful name for the integration instance. | XXXXX Instance Alpha |
| Endpoint Type | The endpoint for accessing Microsoft Defender for Endpoint, see table below. | Worldwide |
| Fetches Incidents | Whether to fetch the incidents. | False |
| Incident Type | The type of incident to select. | Phishing |
| ID | The ID used to gain access to the integration. Your Client/Application ID. | |
| Token | A piece of data that servers use to verify for authenticity. This is your Tenant ID. | eea810f5-a6f6 |
| Key | Your client secret. | |
| Certificate Thumbprint | Used for certificate authentication. As appears in the “Certificates & secrets” page of the app. | A97BF50B7BB6D909CE8CAAF9FA8109A571134C33 |
| Private Key | Used for certificate authentication. The private key of the registered certificate. | eea810f5-a6f6 |
| Authentication Type | Type of authentication - either Authorization Code (recommended) or Client Credentials. | |
| Application redirect URI (for authorization code mode) | False | |
| Authorization code | for user-auth mode - received from the authorization step. see Detailed Instructions section | False |
| Azure Managed Identities Client ID | The Managed Identities client ID for authentication - relevant only if the integration is running on Azure VM. | UUID |
| Status for fetching alerts as incidents | The property values are, “New”, “InProgress” or “Resolved”. Comma-separated lists are supported, e.g., New,Resolved. | New,In Progress,Resolved |
| DetecitonSource to filter out alters for fetching as incidents. | The property values are, “Antivirus”, “CustomDetection”, “CustomTI”, “EDR” and “MDO”. Comma-separated lists are supported, e.g., Antivirus,EDR. | CustomDetection,EDR |
| Severity for fetching alerts as incidents | The property values are, “Informational”, “Low”, “Medium” and “High”. Comma-separated lists are supported, e.g., Medium,High. | Medium,High |
| Maximum number of incidents to fetch | The maximum number of incidents to retrieve per fetch. | 50 |
| Trust any Certificate (Not Secure) | When selected, certificates are not checked. | |
| Fetch alert evidence | When selected, fetches alerts in Microsoft Defender. | |
| Use system proxy settings | Runs the integration instance using the proxy server (HTTP or HTTPS) that you defined in the server configuration. | https://proxyserver.com |
| Use a self-deployed Azure Application | For authorization code flow, mark this as true. | |
| First Fetch Timestamp | The first timestamp to be fetched in the format <number> <time unit>. | 12 hours, 7 days |
| Server URL | The URL to the Microsoft Defender for Endpoint server, including the scheme, see note below. | https://api.securitycenter.windows.com |
Endpoint Type options
| Endpoint Type | Description |
|---|---|
| Worldwide | The publicly accessible Microsoft Defender for Endpoint |
| EU Geo Proximity | Microsoft Defender for Endpoint Geo proximity end point for the UK customers. |
| UK Geo Proximity | Microsoft Defender for Endpoint Geo proximity end point for the UK customers. |
| US Geo Proximity | Microsoft Defender for Endpoint Geo proximity end point for the US customers. |
| US GCC | Microsoft Defender for Endpoint for the USA Government Cloud Community (GCC) |
| US GCC-High | Microsoft Defender for Endpoint for the USA Government Cloud Community High (GCC-High) |
| DoD | Microsoft Defender for Endpoint for the USA Department of Defence (DoD) |
| Custom | Custom endpoint configuration to the Microsoft Defender for Endpoint, please see note below. |
Note: In most cases, setting the Endpoint type is preferred over setting the Server URL. Only set the Server URL when a custom URL is required for accessing a national cloud, or for self-deployment.
Fetched Incidents Data
- id
- incidentId
- investigationId
- assignedTo
- severity
- status
- classification
- determination
- investigationState
- detectionSource
- category
- threatFamilyName
- title
- description
- alertCreationTime
- firstEventTime
- lastEventTime
- lastUpdateTime
- resolvedTime
- machineId
- computerDnsName
- aadTenantId
- relatedUser
- comments
- evidence
Commands
You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.
- microsoft-atp-isolate-machine
- microsoft-atp-unisolate-machine
- microsoft-atp-get-machines
- microsoft-atp-get-file-related-machines
- microsoft-atp-get-machine-details
- microsoft-atp-run-antivirus-scan
- microsoft-atp-list-alerts (Deprecated)
- microsoft-atp-update-alert (Deprecated)
- microsoft-atp-advanced-hunting (Deprecated)
- microsoft-atp-create-alert (Deprecated)
- microsoft-atp-get-alert-related-user (Deprecated)
- microsoft-atp-get-alert-related-files (Deprecated)
- microsoft-atp-get-alert-related-ips (Deprecated)
- microsoft-atp-get-alert-related-domains (Deprecated)
- microsoft-atp-list-machine-actions-details
- microsoft-atp-collect-investigation-package
- microsoft-atp-get-investigation-package-sas-uri
- microsoft-atp-restrict-app-execution
- microsoft-atp-remove-app-restriction
- microsoft-atp-stop-and-quarantine-file
- microsoft-atp-list-investigations
- microsoft-atp-start-investigation
- microsoft-atp-get-domain-statistics
- microsoft-atp-get-domain-alerts (Deprecated)
- microsoft-atp-get-domain-machines
- microsoft-atp-get-file-statistics
- microsoft-atp-get-file-alerts (Deprecated)
- microsoft-atp-get-ip-statistics
- microsoft-atp-get-ip-alerts (Deprecated)
- microsoft-atp-get-user-alerts (Deprecated)
- microsoft-atp-get-user-machines
- microsoft-atp-add-remove-machine-tag
- microsoft-atp-indicator-list (Deprecated)
- microsoft-atp-indicator-get-by-id (Deprecated)
- microsoft-atp-indicator-create-network (Deprecated)
- microsoft-atp-indicator-create-file (Deprecated)
- microsoft-atp-indicator-update (Deprecated)
- microsoft-atp-indicator-delete (Deprecated)
- microsoft-atp-sc-indicator-list
- microsoft-atp-sc-indicator-get-by-id
- microsoft-atp-sc-indicator-create
- microsoft-atp-sc-indicator-update
- microsoft-atp-sc-indicator-delete
- microsoft-atp-list-machines-by-vulnerability
- microsoft-atp-get-file-info
- endpoint
- microsoft-atp-indicator-batch-update
- microsoft-atp-get-alert-by-id (Deprecated)
- microsoft-atp-request-and-download-investigation-package
- microsoft-atp-offboard-machine
- microsoft-atp-list-software
- microsoft-atp-list-software-version-distribution
- microsoft-atp-list-machines-by-software
- microsoft-atp-list-vulnerabilities-by-software
- microsoft-atp-list-vulnerabilities-by-machine
- microsoft-atp-list-vulnerabilities
- microsoft-atp-list-missing-kb-by-software
- microsoft-atp-get-machine-vulnerabilities
- microsoft-atp-get-machine-software
- microsoft-atp-get-machine-missing-kbs
1. microsoft-atp-isolate-machine
Isolates a machine from accessing external network.
Required Permissions
Machine.Isolate
Note: When using the Authorization Code flow (either via the Cortex XSOAR application or by choosing delegated permissions for a self-deployed app), ensure the authenticated user has the “Active Remediation Actions” role assigned. Refer to the Microsoft documentation on creating and managing roles.
Base Command
microsoft-atp-isolate-machine
Input
| Argument Name | Description | Required |
|---|---|---|
| machine_id | A comma-separated list of machine IDs to be used for isolation. e.g., 0a3250e0693a109f1affc9217be9459028aa8426,0a3250e0693a109f1affc9217be9459028aa8424. | Required |
| comment | A comment to associate with the action. | Required |
| isolation_type | Full isolation or selective isolation. (Restrict only limited set of applications from accessing the network). Possible values are: Full, Selective. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.MachineAction.ID | String | The machine action ID. |
| MicrosoftATP.MachineAction.Type | String | Type of the machine action. |
| MicrosoftATP.MachineAction.Scope | Unknown | Scope of the action. |
| MicrosoftATP.MachineAction.Requestor | String | The ID of the user that executed the action. |
| MicrosoftATP.MachineAction.RequestorComment | String | Comment that was written when issuing the action. |
| MicrosoftATP.MachineAction.Status | String | The current status of the command. |
| MicrosoftATP.MachineAction.MachineID | String | The machine ID on which the action was executed. |
| MicrosoftATP.MachineAction.ComputerDNSName | String | The machine DNS name on which the action was executed. |
| MicrosoftATP.MachineAction.CreationDateTimeUtc | Date | The date and time when the action was created. |
| MicrosoftATP.MachineAction.LastUpdateTimeUtc | Date | The last date and time when the action status was updated. |
| MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifier | String | The file identifier. |
| MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifierType | String | The type of the file identifier. Possible values: “SHA1” ,”SHA256”, and “MD5”. |
Command example
!microsoft-atp-isolate-machine comment=isolate_test_3 isolation_type=Full machine_id="12342c13fef,12342c13fef8f06606"
Context Example
{
"MicrosoftATP": {
"MachineAction": [
{
"ComputerDNSName": "desktop-s2455r8",
"CreationDateTimeUtc": "2022-01-25T14:25:52.6227941Z",
"ID": "1f3098e20464",
"LastUpdateTimeUtc": null,
"MachineID": "12342c13fef",
"RelatedFileInfo": {
"FileIdentifier": null,
"FileIdentifierType": null
},
"Requestor": "2f48b784-5da5-4e61-9957-012d2630f1e4",
"RequestorComment": "isolate_test_3",
"Scope": "Full",
"Status": "Pending",
"Type": "Isolate"
},
{
"ComputerDNSName": "desktop-s2455r9",
"CreationDateTimeUtc": "2022-01-25T14:25:53.2395007Z",
"ID": "6d39a3da0744",
"LastUpdateTimeUtc": null,
"MachineID": "12342c13fef8f06606",
"RelatedFileInfo": {
"FileIdentifier": null,
"FileIdentifierType": null
},
"Requestor": "2f48b784-5da5-4e61-9957-012d2630f1e4",
"RequestorComment": "isolate_test_3",
"Scope": "Full",
"Status": "Pending",
"Type": "Isolate"
}
]
}
}
Human Readable Output
The isolation request has been submitted successfully
ID Type Requestor RequestorComment Status MachineID ComputerDNSName 1f3098e20464 Isolate 2f48b784-5da5-4e61-9957-012d2630f1e4 isolate_test_3 Pending 12342c13fef desktop-s2455r8 6d39a3da0744 Isolate 2f48b784-5da5-4e61-9957-012d2630f1e4 isolate_test_3 Pending 12342c13fef8f06606 desktop-s2455r9
2. microsoft-atp-unisolate-machine
Remove a machine from isolation.
Required Permissions
Machine.Isolate
Base Command
microsoft-atp-unisolate-machine
Input
| Argument Name | Description | Required |
|---|---|---|
| machine_id | A comma-separated list of machine IDs to be used to stop the isolation. e.g., 0a3250e0693a109f1affc9217be9459028aa8426,0a3250e0693a109f1affc9217be9459028aa8424. | Required |
| comment | Comment to associate with the action. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.MachineAction.ID | String | The machine action ID. |
| MicrosoftATP.MachineAction.Type | String | Type of the action. |
| MicrosoftATP.MachineAction.Scope | Unknown | Scope of the action. |
| MicrosoftATP.MachineAction.Requestor | String | The ID of the user that executed the action. |
| MicrosoftATP.MachineAction.RequestorComment | String | The comment that was written when issuing the action. |
| MicrosoftATP.MachineAction.Status | String | The current status of the command. |
| MicrosoftATP.MachineAction.MachineID | String | The machine ID on which the action was executed. |
| MicrosoftATP.MachineAction.ComputerDNSName | String | The machine DNS name on which the action was executed |
| MicrosoftATP.MachineAction.CreationDateTimeUtc | Date | The date and time when the action was created. |
| MicrosoftATP.MachineAction.LastUpdateTimeUtc | Date | The last date and time when the action status was updated. |
| MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifier | String | The fileIdentifier. |
| MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifierType | String | The type of the file identifier. Possible values: “SHA1” ,”SHA256”, and “MD5”. |
Command example
!microsoft-atp-unisolate-machine comment=unisolate_test machine_id="4899036531e3,f70f9fe6b29"
Context Example
{
"MicrosoftATP": {
"MachineAction": [
{
"ComputerDNSName": "desktop-s2455r8",
"CreationDateTimeUtc": "2022-01-25T14:23:01.3053556Z",
"ID": "488176cc",
"LastUpdateTimeUtc": null,
"MachineID": "4899036531e3",
"RelatedFileInfo": {
"FileIdentifier": null,
"FileIdentifierType": null
},
"Requestor": "2f48b784-5da5-4e61-9957-012d2630f1e4",
"RequestorComment": "unisolate_test",
"Scope": null,
"Status": "Pending",
"Type": "Unisolate"
},
{
"ComputerDNSName": "desktop-s2455r9",
"CreationDateTimeUtc": "2022-01-25T14:23:01.8421701Z",
"ID": "a6422c40",
"LastUpdateTimeUtc": null,
"MachineID": "f70f9fe6b29",
"RelatedFileInfo": {
"FileIdentifier": null,
"FileIdentifierType": null
},
"Requestor": "2f48b784-5da5-4e61-9957-012d2630f1e4",
"RequestorComment": "unisolate_test",
"Scope": null,
"Status": "Pending",
"Type": "Unisolate"
}
]
}
}
Human Readable Output
The request to stop the isolation has been submitted successfully
ID Type Requestor RequestorComment Status MachineID ComputerDNSName 488176cc Unisolate 2f48b784-5da5-4e61-9957-012d2630f1e4 unisolate_test Pending 4899036531e3 devicename_2 a6422c40 Unisolate 2f48b784-5da5-4e61-9957-012d2630f1e4 unisolate_test Pending f70f9fe6b29 devicename_1
3. microsoft-atp-get-machines
Retrieves a collection of machines that have communicated with WDATP cloud in the last 30 days. Note, only ip or hostname can be a comma-separated list. If both are given as lists, an error will appear.
Base Command
microsoft-atp-get-machines
Input
| Argument Name | Description | Required |
|---|---|---|
| hostname | A comma-separated list of computer DNS name. | Optional |
| ip | A comma-separated list of the last machine IPs to access the internet. | Optional |
| risk_score | The machine risk score. Possible values are: Low, Medium, High. | Optional |
| health_status | The machine health status. Possible values are: Active, Inactive. | Optional |
| os_platform | The machine’s OS platform. Only a single platform can be added. | Optional |
| page_size | Number of machines to return in a page - must be lower or equal to 10,000. | Optional |
| page_num | The page number to retrieve. Default is 1. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.Machine.ID | String | The machine ID. |
| MicrosoftATP.Machine.ComputerDNSName | String | The machine DNS name. |
| MicrosoftATP.Machine.FirstSeen | Date | The first date and time the machine was observed by Microsoft Defender ATP. |
| MicrosoftATP.Machine.LastSeen | Date | The last date and time the machine was observed by Microsoft Defender ATP. |
| MicrosoftATP.Machine.OSPlatform | String | The operating system platform. |
| MicrosoftATP.Machine.OSVersion | String | The operating system version. |
| MicrosoftATP.Machine.OSProcessor | String | The operating system processor. |
| MicrosoftATP.Machine.LastIPAddress | String | The last IP on the machine. |
| MicrosoftATP.Machine.LastExternalIPAddress | String | The last machine IP to access the internet. |
| MicrosoftATP.Machine.OSBuild | Number | The operating system build number. |
| MicrosoftATP.Machine.HealthStatus | String | The machine health status. |
| MicrosoftATP.Machine.RBACGroupID | Number | The machine RBAC group ID. |
| MicrosoftATP.Machine.RBACGroupName | String | The machine RBAC group name. |
| MicrosoftATP.Machine.RiskScore | String | The machine risk score. |
| MicrosoftATP.Machine.ExposureLevel | String | The machine exposure score. |
| MicrosoftATP.Machine.IsAADJoined | Boolean | True if machine is AAD joined, False otherwise. |
| MicrosoftATP.Machine.AADDeviceID | String | The AAD Device ID. |
| MicrosoftATP.Machine.MachineTags | String | Set of machine tags. |
Command example
!microsoft-atp-get-machines hostname=desktop-s health_status=Active os_platform=Windows10 ip=1.2.3.4,1.2.3.5
Context Example
{
"MicrosoftATP": {
"Machine": {
"AgentVersion": "10.8040.19041.1466",
"ComputerDNSName": "desktop-s",
"ExposureLevel": "Medium",
"FirstSeen": "2020-02-20T14:44:11.4627779Z",
"HealthStatus": "Active",
"ID": "f70f9fe6b29",
"IPAddresses": [
{
"ipAddress": "1.2.3.4",
"macAddress": "1213123",
"operationalStatus": "Up",
"type": "Ethernet"
},
{
"ipAddress": "1234::1234:1234:1234:1234",
"macAddress": "1213123",
"operationalStatus": "Up",
"type": "Ethernet"
},
{
"ipAddress": "127.0.0.1",
"macAddress": "",
"operationalStatus": "Up",
"type": "SoftwareLoopback"
},
{
"ipAddress": "::1",
"macAddress": "",
"operationalStatus": "Up",
"type": "SoftwareLoopback"
}
],
"IsAADJoined": true,
"LastExternalIPAddress": "127.0.0.1",
"LastIPAddress": "1.2.3.4",
"LastSeen": "2022-01-26T11:14:22.9649216Z",
"MachineTags": [
"new test",
"test add tag",
"testing123"
],
"OSBuild": 19042,
"OSPlatform": "Windows10",
"OSProcessor": "x64",
"OSVersion": "20H2",
"RBACGroupID": 0,
"RiskScore": "Medium"
}
}
}
Human Readable Output
Microsoft Defender ATP Machines
ID ComputerDNSName OSPlatform LastIPAddress LastExternalIPAddress HealthStatus RiskScore ExposureLevel f70f9fe6b29 desktop-s Windows10 1.2.3.4 127.0.0.1 Active Medium Medium
4. microsoft-atp-get-file-related-machines
Gets a collection of machines related to a given file’s SHA1 hash.
Required Permissions
Machine.ReadWrite.All
Base Command
microsoft-atp-get-file-related-machines
Input
| Argument Name | Description | Required |
|---|---|---|
| file_hash | A comma-separated list of file SHA1 hash to get the related machines. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.FileMachine.Machines.ID | String | The machine ID. |
| MicrosoftATP.FileMachine.Machines.ComputerDNSName | String | The machine DNS name. |
| MicrosoftATP.FileMachine.Machines.FirstSeen | Date | The first date and time where the machine was observed by Microsoft Defender ATP. |
| MicrosoftATP.FileMachine.Machines.LastSeen | Date | The last date and time where the machine was observed by Microsoft Defender ATP. |
| MicrosoftATP.FileMachine.Machines.OSPlatform | String | The operating system platform. |
| MicrosoftATP.FileMachine.Machines.OSVersion | String | The operating system version. |
| MicrosoftATP.Machine.OSProcessor | String | The operating system processor. |
| MicrosoftATP.FileMachine.Machines.OSBuild | Number | Operating system build number. |
| MicrosoftATP.FileMachine.Machines.LastIPAddress | String | The last IP on the machine. |
| MicrosoftATP.FileMachine.Machines.LastExternalIPAddress | String | The last machine IP to access the internet. |
| MicrosoftATP.FileMachine.Machines.HelathStatus | String | The machine health status. |
| MicrosoftATP.FileMachine.Machines.RBACGroupID | Number | The machine RBAC group ID. |
| MicrosoftATP.FileMachine.Machines.RBACGroupName | String | The machine RBAC group name. |
| MicrosoftATP.FileMachine.Machines.RiskScore | String | The machine risk score. |
| MicrosoftATP.FileMachine.Machines.ExposureLevel | String | The machine exposure score. |
| MicrosoftATP.FileMachine.Machines.IsAADJoined | Boolean | True if machine is AAD joined, False otherwise. |
| MicrosoftATP.FileMachine.Machines.AADDeviceID | string | The AAD Device ID. |
| MicrosoftATP.FileMachine.Machines.MachineTags | String | Set of machine tags. |
| MicrosoftATP.FileMachine.File | String | The machine related file hash. |
Command example
!microsoft-atp-get-file-related-machines file_hash=1234567891acvgfdertukthgfdertyjhgfdset54,1234567891acvgfdertukthgfdertyjhgfdset53
Context Example
{
"MicrosoftATP": {
"FileMachine": [
{
"File": "1234567891acvgfdertukthgfdertyjhgfdset54",
"Machines": [
{
"AgentVersion": "10.8040.19041.1466",
"ComputerDNSName": "desktop-s9",
"ExposureLevel": "Medium",
"FirstSeen": "2020-02-20T14:44:11.4627779Z",
"HealthStatus": "Active",
"ID": "f70f9fe6",
"IPAddresses": [
{
"ipAddress": "1.2.3.4",
"macAddress": "123456789121",
"operationalStatus": "Up",
"type": "Ethernet"
},
{
"ipAddress": "1234::1234:1234:3177:11dc",
"macAddress": "123456789121",
"operationalStatus": "Up",
"type": "Ethernet"
},
{
"ipAddress": "127.0.0.1",
"macAddress": "",
"operationalStatus": "Up",
"type": "SoftwareLoopback"
},
{
"ipAddress": "::1",
"macAddress": "",
"operationalStatus": "Up",
"type": "SoftwareLoopback"
}
],
"IsAADJoined": true,
"LastExternalIPAddress": "127.0.0.1",
"LastIPAddress": "1.2.3.4",
"LastSeen": "2022-01-25T11:14:39.7435843Z",
"MachineTags": [
"new test",
"test add tag",
"testing123"
],
"OSBuild": 19042,
"OSPlatform": "Windows10",
"OSProcessor": "x64",
"OSVersion": "20H2",
"RBACGroupID": 0,
"RiskScore": "Medium"
}
]
},
{
"File": "1234567891acvgfdertukthgfdertyjhgfdset53",
"Machines": [
{
"AADDeviceID": "cfcf4177-227e-4cdb-ac8e-f9a3da1ca30c",
"AgentVersion": "10.8040.19041.1466",
"ComputerDNSName": "desktop-s8",
"ExposureLevel": "Medium",
"FirstSeen": "2020-02-17T08:30:07.2415577Z",
"HealthStatus": "Active",
"ID": "48990365",
"IPAddresses": [
{
"ipAddress": "1.2.3.5",
"macAddress": "005056941386",
"operationalStatus": "Up",
"type": "Ethernet"
},
{
"ipAddress": "123::1234:dd40:bc6e:23e1",
"macAddress": "123456789123",
"operationalStatus": "Up",
"type": "Ethernet"
},
{
"ipAddress": "127.0.0.1",
"macAddress": "",
"operationalStatus": "Up",
"type": "SoftwareLoopback"
},
{
"ipAddress": "::1",
"macAddress": "",
"operationalStatus": "Up",
"type": "SoftwareLoopback"
}
],
"IsAADJoined": true,
"LastExternalIPAddress": "127.0.0.1",
"LastIPAddress": "1.2.3.5",
"LastSeen": "2022-01-25T11:19:44.718919Z",
"MachineTags": [
"test Tag 2",
"test Tag 5"
],
"OSBuild": 19043,
"OSPlatform": "Windows10",
"OSProcessor": "x64",
"OSVersion": "21H1",
"RBACGroupID": 0,
"RiskScore": "Low"
}
]
}
]
}
}
Human Readable Output
Microsoft Defender ATP machines related to files [‘1234567891acvgfdertukthgfdertyjhgfdset54’, ‘1234567891acvgfdertukthgfdertyjhgfdset53’]
ID ComputerDNSName OSPlatform LastIPAddress LastExternalIPAddress HealthStatus RiskScore ExposureLevel f70f9fe6 desktop-s9 Windows10 1.2.3.4 127.0.0.1 Active Medium Medium 48990365 desktop-s8 Windows10 1.2.3.5 127.0.0.1 Active Low Medium
5. microsoft-atp-get-machine-details
Gets a machine’s details by its identity.
Required Permissions
Machine.ReadWrite.All
Base Command
microsoft-atp-get-machine-details
Input
| Argument Name | Description | Required |
|---|---|---|
| machine_id | A comma-separated list of machine IDs used to get the machine details, e.g., 0a3250e0693a109f1affc9217be9459028aa8426,0a3250e0693a109f1affc9217be9459028aa8424. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.Machine.ID | String | The machine ID. |
| MicrosoftATP.Machine.ComputerDNSName | String | The machine DNS name. |
| MicrosoftATP.Machine.FirstSeen | Date | The first date and time where the machine was observed by Microsoft Defender ATP. |
| MicrosoftATP.Machine.LastSeen | Date | The last date and time where the machine was observed by Microsoft Defender ATP. |
| MicrosoftATP.Machine.OSPlatform | String | The operating system platform. |
| MicrosoftATP.Machine.OSVersion | String | The operating system version. |
| MicrosoftATP.Machine.OSProcessor | String | The operating system processor. |
| MicrosoftATP.Machine.LastIPAddress | String | The last IP on the machine. |
| MicrosoftATP.Machine.LastExternalIPAddress | String | The last machine IP to access the internet. |
| MicrosoftATP.Machine.OSBuild | Number | The operating system build number. |
| MicrosoftATP.Machine.HealthStatus | String | The machine health status. |
| MicrosoftATP.Machine.RBACGroupID | Number | The machine RBAC group ID. |
| MicrosoftATP.Machine.RBACGroupName | String | The machine RBAC group name. |
| MicrosoftATP.Machine.RiskScore | String | The machine risk score. |
| MicrosoftATP.Machine.ExposureLevel | String | The machine exposure level. |
| MicrosoftATP.Machine.IsAADJoined | Boolean | True if machine is AAD joined, False otherwise. |
| MicrosoftATP.Machine.AADDeviceID | String | The AAD Device ID. |
| MicrosoftATP.Machine.MachineTags | String | Set of machine tags. |
| MicrosoftATP.Machine.NetworkInterfaces.MACAddress | String | MAC Address for the Network interface. |
| MicrosoftATP.Machine.NetworkInterfaces.IPAddresses | String | IP Address(es) for the Network interface. |
| MicrosoftATP.Machine.NetworkInterfaces.Type | String | Type of the Network interface (e.g. Ethernet). |
| MicrosoftATP.Machine.NetworkInterfaces.Status | String | Status for the Network interface (e.g. Up, Down). |
Command example
!microsoft-atp-get-machine-details machine_id=f70f9fe6b29,4899036531e
Context Example
{
"MicrosoftATP": {
"Machine": [
{
"AgentVersion": "10.8040.19041.1466",
"ComputerDNSName": "desktop-s9",
"ExposureLevel": "Medium",
"FirstSeen": "2020-02-20T14:44:11.4627779Z",
"HealthStatus": "Active",
"ID": "f70f9fe6",
"IPAddresses": [
{
"ipAddress": "1.2.3.4",
"macAddress": "1234645645",
"operationalStatus": "Up",
"type": "Ethernet"
},
{
"ipAddress": "1234::1234:1234:3177:11dc",
"macAddress": "1234645645",
"operationalStatus": "Up",
"type": "Ethernet"
},
{
"ipAddress": "127.0.0.1",
"macAddress": "",
"operationalStatus": "Up",
"type": "SoftwareLoopback"
},
{
"ipAddress": "::1",
"macAddress": "",
"operationalStatus": "Up",
"type": "SoftwareLoopback"
}
],
"IsAADJoined": true,
"LastExternalIPAddress": "127.0.0.1",
"LastIPAddress": "1.2.3.4",
"LastSeen": "2022-01-25T11:14:39.7435843Z",
"MachineTags": [
"new test",
"test add tag",
"testing123"
],
"OSBuild": 19042,
"OSPlatform": "Windows10",
"OSProcessor": "x64",
"OSVersion": "20H2",
"RBACGroupID": 0,
"RiskScore": "Medium"
},
{
"AADDeviceID": "cfcf4177-227e-4cdb-ac8e-f9a3da1ca30c",
"AgentVersion": "10.8040.19041.1466",
"ComputerDNSName": "desktop-s8",
"ExposureLevel": "Medium",
"FirstSeen": "2020-02-17T08:30:07.2415577Z",
"HealthStatus": "Active",
"ID": "48990365",
"IPAddresses": [
{
"ipAddress": "1.2.3.5",
"macAddress": "1234645645",
"operationalStatus": "Up",
"type": "Ethernet"
},
{
"ipAddress": "1234::1234:1234:bc6e:23e1",
"macAddress": "1234645645",
"operationalStatus": "Up",
"type": "Ethernet"
},
{
"ipAddress": "127.0.0.1",
"macAddress": "",
"operationalStatus": "Up",
"type": "SoftwareLoopback"
},
{
"ipAddress": "::1",
"macAddress": "",
"operationalStatus": "Up",
"type": "SoftwareLoopback"
}
],
"IsAADJoined": true,
"LastExternalIPAddress": "127.0.0.1",
"LastIPAddress": "1.2.3.5",
"LastSeen": "2022-01-25T11:19:44.718919Z",
"MachineTags": [
"test Tag 2",
"test Tag 5"
],
"OSBuild": 19043,
"OSPlatform": "Windows10",
"OSProcessor": "x64",
"OSVersion": "21H1",
"RBACGroupID": 0,
"RiskScore": "Low"
}
]
}
}
Human Readable Output
Microsoft Defender ATP machines [‘f70f9fe6b29’,’4899036531e’] details
ID ComputerDNSName OSPlatform LastIPAddress LastExternalIPAddress HealthStatus RiskScore ExposureLevel IPAddresses f70f9fe6 desktop-s9 Windows10 1.2.3.4 127.0.0.1 Active Medium Medium 1. | MAC : 1234645645 | IP Addresses : 1.2.3.4,1234::1234:1234:3177:11dc | Type : Ethernet | Status : Up
2. | MAC : | IP Addresses : 127.0.0.1,::1 | Type : SoftwareLoopback | Status : Up48990365 desktop-s8 Windows10 1.2.3.5 127.0.0.1 Active Low Medium 1. | MAC : 1234645645 | IP Addresses : 1.2.3.5,1234::1234:1234:bc6e:23e1 | Type : Ethernet | Status : Up
2. | MAC : | IP Addresses : 127.0.0.1,::1 | Type : SoftwareLoopback | Status : Up
6. microsoft-atp-run-antivirus-scan
Initiates Microsoft Defender Antivirus scan on a machine.
Required Permissions
Machine.Scan
Note: When using the Authorization Code flow (either via the Cortex XSOAR application or by choosing delegated permissions for a self-deployed app), ensure the authenticated user has the “Active Remediation Actions” role assigned. Refer to the Microsoft documentation on creating and managing roles.
Base Command
microsoft-atp-run-antivirus-scan
Input
| Argument Name | Description | Required |
|---|---|---|
| machine_id | A comma-separated list of machine IDs to run the scan on. | Required |
| comment | A comment to associate with the action. | Required |
| scan_type | Defines the type of the scan. Possible values are: Quick, Full. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.MachineAction.ID | String | The machine action ID. |
| MicrosoftATP.MachineAction.Type | String | The type of the action. |
| MicrosoftATP.MachineAction.Scope | Unknown | The scope of the action. |
| MicrosoftATP.MachineAction.Requestor | String | The ID of the user that executed the action. |
| MicrosoftATP.MachineAction.RequestorComment | String | The comment that was written when issuing the action. |
| MicrosoftATP.MachineAction.Status | String | The current status of the command. |
| MicrosoftATP.MachineAction.MachineID | String | The machine ID on which the action was executed. |
| MicrosoftATP.MachineAction.ComputerDNSName | String | The machine DNS name on which the action was executed. |
| MicrosoftATP.MachineAction.CreationDateTimeUtc | Date | The date and time when the action was created. |
| MicrosoftATP.MachineAction.LastUpdateTimeUtc | Date | The last date and time when the action status was updated. |
| MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifier | String | The file identifier. |
| MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifierType | String | The type of the file identifier. Possible values: “SHA1” ,”SHA256”, and “MD5”. |
Command example
!microsoft-atp-run-antivirus-scan machine_id=f70f9fe6,48990365 comment=test3 scan_type=Quick
Context Example
{
"MicrosoftATP": {
"MachineAction": [
{
"ComputerDNSName": "desktop-s9",
"CreationDateTimeUtc": "2022-01-25T17:57:18.7944822Z",
"ID": "98cf0adc",
"LastUpdateTimeUtc": null,
"MachineID": "f70f9fe6",
"RelatedFileInfo": {
"FileIdentifier": null,
"FileIdentifierType": null
},
"Requestor": "2f48b784-5da5-4e61-9957-012d2630f1e4",
"RequestorComment": "test3",
"Scope": "Quick",
"Status": "Pending",
"Type": "RunAntiVirusScan"
},
{
"ComputerDNSName": "desktop-s8",
"CreationDateTimeUtc": "2022-01-25T17:57:20.0458595Z",
"ID": "ecee8124",
"LastUpdateTimeUtc": null,
"MachineID": "48990365",
"RelatedFileInfo": {
"FileIdentifier": null,
"FileIdentifierType": null
},
"Requestor": "2f48b784-5da5-4e61-9957-012d2630f1e4",
"RequestorComment": "test3",
"Scope": "Quick",
"Status": "Pending",
"Type": "RunAntiVirusScan"
}
]
}
}
Human Readable Output
Antivirus scan successfully triggered
ID Type Requestor RequestorComment Status MachineID ComputerDNSName 98cf0adc RunAntiVirusScan 2f48b784-5da5-4e61-9957-012d2630f1e4 test3 Pending f70f9fe6 desktop-s9 ecee8124 RunAntiVirusScan 2f48b784-5da5-4e61-9957-012d2630f1e4 test3 Pending 48990365 desktop-s8
7. microsoft-atp-list-alerts (Deprecated)
This command has been deprecated. Use the ‘msg-search-alerts’ command in the ‘Microsoft Graph Security’ integration instead.
Gets a list of alerts that are present on the system. Filtering can be done on a single argument only.
Required Permissions
Alert.ReadWrite.All
Base Command
microsoft-atp-list-alerts
Input
| Argument Name | Description | Required |
|---|---|---|
| severity | Alert severity. Possible values are: High, Medium, Low, Informational. | Optional |
| status | Alert status. Possible values are: New, InProgress, Resolved. | Optional |
| category | Alert category; only one can be added. | Optional |
| limit | The maximum number of files to display. Default is 50. | Optional |
| creation_time | The creation timestamp from which to get alerts (<number> <time unit>, e.g., 12 hours, 7 days). | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.Alert.ID | String | The alert ID. |
| MicrosoftATP.Alert.IncidentID | Number | The Incident ID of the alert. |
| MicrosoftATP.Alert.InvestigationID | Number | The Investigation ID related to the alert. |
| MicrosoftATP.Alert.InvestigationState | String | The current state of the Investigation. |
| MicrosoftATP.Alert.AssignedTo | String | The owner of the alert. |
| MicrosoftATP.Alert.Severity | String | The severity of the alert. |
| MicrosoftATP.Alert.Status | String | The current status of the alert. |
| MicrosoftATP.Alert.Classification | String | The alert Classification. |
| MicrosoftATP.Alert.Determination | String | The determination of the alert. |
| MicrosoftATP.Alert.DetectionSource | String | The detection source. |
| MicrosoftATP.Alert.Category | String | The category of the alert. |
| MicrosoftATP.Alert.ThreatFamilyName | String | The threat family. |
| MicrosoftATP.Alert.Title | String | The alert title. |
| MicrosoftATP.Alert.Description | String | The alert description. |
| MicrosoftATP.Alert.AlertCreationTime | Date | The date and time the alert was created. |
| MicrosoftATP.Alert.FirstEventTime | Date | The first event time that triggered the alert on that machine. |
| MicrosoftATP.Alert.LastEventTime | Date | The last event time that triggered the alert on that machine. |
| MicrosoftATP.Alert.LastUpdateTime | Date | The UTC time of the last update. |
| MicrosoftATP.Alert.ResolvedTime | Date | The date and time in which the status of the alert was changed to ‘Resolved’. |
| MicrosoftATP.Alert.MachineID | String | The machine ID that is associated with the alert. |
| MicrosoftATP.Alert.ComputerDNSName | String | The machine DNS name. |
| MicrosoftATP.Alert.AADTenantID | String | The AAD tenant ID. |
| MicrosoftATP.Alert.Comments.Comment | String | The alert comment string. |
| MicrosoftATP.Alert.Comments.CreatedBy | String | The alert comment created by string. |
| MicrosoftATP.Alert.Comments.CreatedTime | Date | The alert comment created time date. |
| MicrosoftATP.Alert.Evidence | Unknown | Evidence related to the alert. |
| MicrosoftATP.Alert.DetectorID | String | The ID of the detector that triggered the alert. |
| MicrosoftATP.Alert.ThreatName | String | The threat name. |
| MicrosoftATP.Alert.RelatedUser | String | Details of the user related to a specific alert. |
| MicrosoftATP.Alert.MitreTechniques | String | MITRE Enterprise technique ID. |
| MicrosoftATP.Alert.RBACGroupName | String | The device RBAC group name. |
Command example
!microsoft-atp-list-alerts category=Malware severity=Informational status=Resolved creation_time="3 days" limit=1
Context Example
{
"MicrosoftATP": {
"Alert": {
"AADTenantID": "ebac1a16-81bf-449b-8d43-5732c3c1d999",
"AlertCreationTime": "2022-02-07T10:26:40.05748Z",
"AssignedTo": "Automation",
"Category": "Malware",
"Classification": null,
"Comments": [
{
"Comment": null,
"CreatedBy": null,
"CreatedTime": null
}
],
"ComputerDNSName": "win2016-msde-agent.msde.lab.demisto",
"Description": "Malware and unwanted software are undesirable applications that perform annoying, disruptive, or harmful actions on affected machines. Some of these undesirable applications can replicate and spread from one machine to another. Others are able to receive commands from remote attackers and perform activities associated with cyber attacks.\n\nThis detection might indicate that the malware was stopped from delivering its payload. However, it is prudent to check the machine for signs of infection.",
"DetectionSource": "WindowsDefenderAv",
"DetectorID": "d60f5b90-ecd8-4d77-8186-a801597ec762",
"Determination": null,
"Evidence": [
{
"aadUserId": null,
"accountName": null,
"detectionStatus": "Prevented",
"domainName": null,
"entityType": "File",
"evidenceCreationTime": "2022-02-07T10:26:40.24Z",
"fileName": "example.com",
"filePath": "C:\\Users\\admin\\Downloads",
"ipAddress": null,
"parentProcessCreationTime": null,
"parentProcessFileName": null,
"parentProcessFilePath": null,
"parentProcessId": null,
"processCommandLine": null,
"processCreationTime": null,
"processId": null,
"registryHive": null,
"registryKey": null,
"registryValue": null,
"registryValueType": null,
"sha1": "3395856ce81f2b7382dee72602f798b642f14140",
"sha256": "275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f",
"url": null,
"userPrincipalName": null,
"userSid": null
}
],
"FirstEventTime": "2022-02-07T10:20:52.2188896Z",
"ID": "da637798264000574516_1915313662",
"IncidentID": 648,
"InvestigationID": 675,
"InvestigationState": "SuccessfullyRemediated",
"LastEventTime": "2022-02-07T10:20:52.2571395Z",
"LastUpdateTime": "2022-02-07T10:57:13.93Z",
"MachineID": "4cceb3c642212014e0e9553aa8b59e999ea515ff",
"MitreTechniques": [],
"RBACGroupName": null,
"RelatedUser": null,
"ResolvedTime": "2022-02-07T10:57:13.773683Z",
"Severity": "Informational",
"Status": "Resolved",
"ThreatFamilyName": "Test_File",
"ThreatName": "Test_File",
"Title": "'Test_File' malware was prevented"
}
}
}
Human Readable Output
Microsoft Defender ATP alerts with limit of 1
ID Title Description IncidentID Severity Status Category ThreatFamilyName MachineID da637798264000574516_1915313662 ‘Test_File’ malware was prevented Malware and unwanted software are undesirable applications that perform annoying, disruptive, or harmful actions on affected machines. Some of these undesirable applications can replicate and spread from one machine to another. Others are able to receive commands from remote attackers and perform activities associated with cyber attacks.
This detection might indicate that the malware was stopped from delivering its payload. However, it is prudent to check the machine for signs of infection.648 Informational Resolved Malware Test_File 4cceb3c642212014e0e9553aa8b59e999ea515ff
8. microsoft-atp-update-alert (Deprecated)
This command has been deprecated. Use the ‘msg-update-alert’ command in the ‘Microsoft Graph Security’ integration instead.
Updates the properties of an alert entity.
Required Permissions
Alert.ReadWrite.All
Base Command
microsoft-atp-update-alert
Input
| Argument Name | Description | Required |
|---|---|---|
| alert_id | The alert ID to update. | Required |
| status | The alert status to update. Possible values: “New”, “InProgress”, and “Resolved”. | Optional |
| assigned_to | The owner of the alert. | Optional |
| classification | The specification of the alert. Possible values: “Unknown”, “FalsePositive”, “TruePositive”, “InformationalExpectedActivity”. | Optional |
| determination | The determination of the alert. Possible values: “NotAvailable”, “Malware”, “SecurityTesting”, “UnwantedSoftware”, and “Other”. | Optional |
| comment | The comment to be added to the alert. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.Alert.ID | String | The ID of the alert. |
| MicrosoftATP.Alert.IncidentID | Number | The incident ID of the alert. |
| MicrosoftATP.Alert.InvestigationID | Number | The investigation ID related to the alert. |
| MicrosoftATP.Alert.InvestigationState | String | The current state of the investigation. |
| MicrosoftATP.Alert.AssignedTo | String | The owner of the alert. |
| MicrosoftATP.Alert.Severity | String | The severity of the alert. |
| MicrosoftATP.Alert.Status | String | The current status of the alert. |
| MicrosoftATP.Alert.Classification | String | The alert classification. |
| MicrosoftATP.Alert.Determination | String | The determination of the alert. |
| MicrosoftATP.Alert.DetectionSource | String | The detection source. |
| MicrosoftATP.Alert.Category | String | The category of the alert. |
| MicrosoftATP.Alert.ThreatFamilyName | String | The threat family of the alert. |
| MicrosoftATP.Alert.Title | String | The title of the alert. |
| MicrosoftATP.Alert.Description | String | The description of the alert. |
| MicrosoftATP.Alert.AlertCreationTime | Date | The date and time the alert was created. |
| MicrosoftATP.Alert.FirstEventTime | Date | The first event time that triggered the alert on that machine. |
| MicrosoftATP.Alert.LastEventTime | Date | The last event time that triggered the alert on that machine. |
| MicrosoftATP.Alert.LastUpdateTime | Date | The UTC time of the last update. |
| MicrosoftATP.Alert.ResolvedTime | Date | The date and time in which the status of the alert was changed to “Resolved”. |
| MicrosoftATP.Alert.MachineID | String | The ID of the machine that is associated with the alert. |
| MicrosoftATP.Alert.ComputerDNSName | String | The DNS name of the machine. |
| MicrosoftATP.Alert.AADTenantID | String | The AAD tenant ID. |
| MicrosoftATP.Alert.Comments.Comment | String | The comment string of the alert. |
| MicrosoftATP.Alert.Comments.CreatedBy | String | The alert’s comment created by the string. |
| MicrosoftATP.Alert.Comments.CreatedTime | Date | The time and date the alert’s comment was created. |
Command Example
!microsoft-atp-update-alert alert_id=da637200417169017725_183736971 status=InProgress
Context Example
{
"MicrosoftATP.Alert": {
"Status": "InProgress",
"ID": "da637200417169017725_183736971"
}
}
Human Readable Output
The alert da637200417169017725_183736971 has been updated successfully
9. microsoft-atp-advanced-hunting (Deprecated)
This command has been deprecated. Use the ‘msg-advanced-hunting’ command in the ‘Microsoft Graph Security’ integration instead.
Runs programmatic queries in Microsoft Defender ATP Portal (https://securitycenter.windows.com/hunting).
- You can only run a query on data from the last 30 days.
- The maximum number of rows is 10,000.
- The number of executions is limited to 15 calls per minute, and 15 minutes of running time every hour, and 4 hours of running time a day.
- This API can only query tables belonging to Microsoft Defender for Endpoint.
The following reference - Data Schema,
lists all the tables in the schema. Each table name links to a page describing the column names for that table and which service it applies to.
Required Permissions
AdvancedQuery.Read.All
Base Command
microsoft-atp-advanced-hunting
Input
| Argument Name | Description | Required |
|---|---|---|
| query | The query to run. Must be passed if query_batch argument is empty. | Optional |
| timeout | The amount of time (in seconds) that a request waits for the query response before a timeout occurs. If specified with query_batch, will be applied to all queries in the array. Default is 10. | Optional |
| time_range | Time range to look back. The expected syntax is a human-readable time range, e.g., 60 minutes, 6 hours, 1 day, etc. If specified with query_batch, applies to all queries in the array. | Optional |
| query_batch | A JSON array of queries, limited to 10 queries. Cannot be provided with the query argument. Example for input: [ { “query”: “query #1”, “name”: “name #1”, “timeout”: “timeout #1” “time_range”: “2 days ago” // Non-mandatory, will override the {time_range} argument }, { “query”: “query #2”, “name”: “name #2”, “timeout”: “timeout #2” “time_range”: “6 days ago”t } ] . The query and name fields are mandatory. If timeout and time_range are specified, they will override the {timeout} and {time_range} argument. |
Optional |
| name | If stated along with query, the response will be saved in context under the Result.name path. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.Hunt.Result | String | The query results. |
Command example
```!microsoft-atp-advanced-hunting query_batch={"queries": [{"query": "DeviceInfo | where OnboardingStatus == 'Onboarded' | limit 10 | distinct DeviceName", "name": "name", "timeout": "20"}]}12
Context Example
{
"MicrosoftATP": {
"Hunt": {
"Result": [
{
"name": [
{
"DeviceName": "msde-agent-host-centos7.c.dmst-integrations.internal"
},
{
"DeviceName": "desktop-s2455r8"
}
]
}
]
}
}
}
Human Readable Output
Hunt results for name query
DeviceName msde-agent-host-centos7.c.dmst-integrations.internal desktop-s2455r8
Command Example
!microsoft-atp-advanced-hunting query="DeviceLogonEvents | take 1 | project DeviceId, ReportId, tostring(Timestamp)"
Context Example
{
"MicrosoftATP.Hunt.Result": [
{
"DeviceId": "4899036531e374137f63289c3267bad772c13fef",
"Timestamp": "2020-02-23T07:14:42.1599815Z",
"ReportId": "35275"
}
]
}
Human Readable Output
Hunt results
| Timestamp | DeviceId | ReportId |
|---|---|---|
| 2020-02-23T07:14:42.1599815Z | 4899036531e374137f63289c3267bad772c13fef | 35275 |
10. microsoft-atp-create-alert (Deprecated)
This command has been deprecated. No available replacement.
Creates a new alert entity using event data, as obtained from the Advanced Hunting.
Required Permissions
Alert.ReadWrite.All
Base Command
microsoft-atp-create-alert
Input
| Argument Name | Description | Required |
|---|---|---|
| machine_id | The ID of the machine on which the event was identified. | Required |
| severity | The severity of the alert. Severity of the alert. Possible values: “Low”, “Medium”, and “High”. | Required |
| title | The title of the alert. | Required |
| description | The description of the alert. | Required |
| recommended_action | Recommended action for the security officer to take when analyzing the alert. | Required |
| event_time | The time of the event, as obtained from the advanced query. | Required |
| report_id | The report ID, as obtained from the advanced query. | Required |
| category | The category of the alert. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.Alert.ID | String | The ID of the alert. |
| MicrosoftATP.Alert.IncidentID | Number | The incident ID of the alert. |
| MicrosoftATP.Alert.InvestigationID | Number | The investigation ID related to the alert. |
| MicrosoftATP.Alert.InvestigationState | String | The current state of the investigation. |
| MicrosoftATP.Alert.AssignedTo | String | The owner of the alert. |
| MicrosoftATP.Alert.Severity | String | The severity of the alert. |
| MicrosoftATP.Alert.Status | String | The current status of the alert. |
| MicrosoftATP.Alert.Classification | String | The classification of the alert. |
| MicrosoftATP.Alert.Determination | String | The determination of the alert. |
| MicrosoftATP.Alert.DetectionSource | String | The detection source. |
| MicrosoftATP.Alert.Category | String | The category of the alert. |
| MicrosoftATP.Alert.ThreatFamilyName | String | The threat family of the alert. |
| MicrosoftATP.Alert.Title | String | The title of the alert. |
| MicrosoftATP.Alert.Description | String | The description of the alert. |
| MicrosoftATP.Alert.AlertCreationTime | Date | The date and time the alert was created. |
| MicrosoftATP.Alert.FirstEventTime | Date | The first event time that triggered the alert on that machine. |
| MicrosoftATP.Alert.LastEventTime | Date | The last event time that triggered the alert on that machine. |
| MicrosoftATP.Alert.LastUpdateTime | Date | The UTC time of the last update. |
| MicrosoftATP.Alert.ResolvedTime | Date | The date and time in which the status of the alert was changed to “Resolved”. |
| MicrosoftATP.Alert.MachineID | String | The machine ID that is associated with the alert. |
| MicrosoftATP.Alert.ComputerDNSName | String | The DNS name of the machine. |
| MicrosoftATP.Alert.AADTenantID | String | The AAD tenant ID. |
| MicrosoftATP.Alert.Comments.Comment | String | The comment string of the alert. |
| MicrosoftATP.Alert.Comments.CreatedBy | String | The alert’s comment created by the string. |
| MicrosoftATP.Alert.Comments.CreatedTime | Date | The time and date the alert comment was created. |
Command Example
!microsoft-atp-create-alert category=Backdoor description="test" report_id=20279 event_time=2020-02-23T07:22:07.1532018Z machine_id=deviceid_2 recommended_action="runAntiVirusScan" severity=Low title="testing alert"
Context Example
{
"MicrosoftATP.Alert": {
"Category": "Backdoor",
"ThreatFamilyName": null,
"Severity": "Low",
"LastEventTime": "2020-02-23T07:22:07.1532018Z",
"FirstEventTime": "2020-02-23T07:22:07.1532018Z",
"Comments": [
{
"Comment": null,
"CreatedTime": null,
"CreatedBy": null
}
],
"AADTenantID": "TENANT-ID",
"AlertCreationTime": "2020-03-22T15:44:23.5446957Z",
"Status": "New",
"Description": "test",
"InvestigationState": "PendingApproval",
"MachineID": "4899036531e374137f63289c3267bad772c13fef",
"Title": "testing alert",
"InvestigationID": 10,
"Determination": null,
"IncidentID": 18,
"AssignedTo": null,
"DetectionSource": "CustomerTI",
"ResolvedTime": null,
"ID": "da637204886635759335_1480542752",
"LastUpdateTime": "2020-03-22T15:44:24.6533333Z",
"Classification": null,
"ComputerDNSName": "desktop-s2455r8",
"Evidence": []
}
}
Human Readable Output
Alert created
| ID | Title | Description | IncidentID | Severity | Status | Category | MachineID |
|---|---|---|---|---|---|---|---|
| da637204886635759335_1480542752 | testing alert | test | 18 | Low | New | Backdoor | 4899036531e374137f63289c3267bad772c13fef |
11. microsoft-atp-get-alert-related-user (Deprecated)
This command has been deprecated. An alternative is to use the ‘msg-get-alert-details’ command in the ‘Microsoft Graph Security’ integration, which can retrieve userAccount information as part of the alert details.
Retrieves the user associated with a specific alert.
Required Permissions
User.Read.All
Base Command
microsoft-atp-get-alert-related-user
Input
| Argument Name | Description | Required |
|---|---|---|
| id | The ID of the alert. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.AlertUser.User.ID | String | The ID of the user. |
| MicrosoftATP.AlertUser.User.AccountName | String | The account name. |
| MicrosoftATP.AlertUser.User.AccountDomain | String | The account domain. |
| MicrosoftATP.AlertUser.User.AccountSID | String | The account SID. |
| MicrosoftATP.AlertUser.User.FirstSeen | Date | The user first seen date and time. |
| MicrosoftATP.AlertUser.User.LastSeen | Date | The user last seen date and time. |
| MicrosoftATP.AlertUser.User.MostPrevalentMachineID | String | The most prevalent machine ID. |
| MicrosoftATP.AlertUser.User.LeastPrevalentMachineID | String | The least prevalent machine ID. |
| MicrosoftATP.AlertUser.User.LogonTypes | String | The user logon types. |
| MicrosoftATP.AlertUser.User.LogonCount | Number | The user logon count. |
| MicrosoftATP.AlertUser.User.DomainAdmin | Number | The domain admin. |
| MicrosoftATP.AlertUser.User.NetworkUser | Number | The network admin. |
| MicrosoftATP.AlertUser.AlertID | String | The ID of the alert. |
Command Example
!microsoft-atp-get-alert-related-user id=da637175364995825348_1865170845
Context Example
{
"MicrosoftATP.AlertUser": {
"User": {
"LeastPrevalentMachineID": "4899036531e374137f63289c3267bad772c13fef",
"MostPrevalentMachineID": "4899036531e374137f63289c3267bad772c13fef",
"LogonCount": 1,
"NetworkUser": false,
"DomainAdmin": false,
"LogonTypes": null,
"AccountName": "demisto",
"LastSeen": "2020-03-03T12:32:51Z",
"AccountSID": "S-1-5-21-4197691174-1403503641-4006700887-1001",
"AccountDomain": "desktop-s2455r8",
"ID": "desktop-s2455r8\\demisto",
"FirstSeen": "2020-02-23T07:14:42Z"
},
"AlertID": "da637175364995825348_1865170845"
}
}
Human Readable Output
Alert Related User
| AccountDomain | AccountName | AccountSID | DomainAdmin | FirstSeen | ID | LastSeen | LeastPrevalentMachineID | LogonCount | MostPrevalentMachineID | NetworkUser |
|---|---|---|---|---|---|---|---|---|---|---|
| desktop-s2455r8 | demisto | S-1-5-21-4197691174-1403503641-4006700887-1001 | false | 2020-02-23T07:14:42Z | desktop-s2455r8\demisto | 2020-03-03T12:32:51Z | 4899036531e374137f63289c3267bad772c13fef | 1 | 4899036531e374137f63289c3267bad772c13fef | false |
12. microsoft-atp-get-alert-related-files (Deprecated)
This command has been deprecated. An alternative is to use the ‘msg-get-alert-details’ command in the ‘Microsoft Graph Security’ integration, which can retrieve fileDetails as part of the alert details.
Retrieves the files associated to a specific alert.
Required Permissions
File.Read.All
Base Command
microsoft-atp-get-alert-related-files
Input
| Argument Name | Description | Required |
|---|---|---|
| id | The ID of the alert. | Required |
| limit | The limit of files to display. | Optional |
| offset | The page from which to get the related files. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.AlertFile.Files.FilePublisher | String | The file’s publisher. |
| MicrosoftATP.AlertFile.Files.Size | Number | The size of the file. |
| MicrosoftATP.AlertFile.Files.GlobalLastObserved | Date | The last time the file was observed. |
| MicrosoftATP.AlertFile.Files.Sha1 | String | The SHA1 hash of the file. |
| MicrosoftATP.AlertFile.Files.IsValidCertificate | Number | Whether the signing of the certificate was successfully verified by the Microsoft Defender ATP agent. |
| MicrosoftATP.AlertFile.Files.Sha256 | String | The SHA256 hash of the file. |
| MicrosoftATP.AlertFile.Files.Signer | String | The file signer. |
| MicrosoftATP.AlertFile.Files.GlobalPrevalence | Number | The file prevalence across the organization. |
| MicrosoftATP.AlertFile.Files.DeterminationValue | String | The determination of the file’s value. |
| MicrosoftATP.AlertFile.Files.GlobalFirstObserved | Date | The first time the file was observed. |
| MicrosoftATP.AlertFile.Files.FileType | String | The type of the file. |
| MicrosoftATP.AlertFile.Files.SignerHash | String | The hash of the signing certificate. |
| MicrosoftATP.AlertFile.Files.Issuer | String | The file issuer. |
| MicrosoftATP.AlertFile.Files.IsPeFile | Number | Wether the file is portable executable. |
| MicrosoftATP.AlertFile.Files.DeterminationType | String | The determination type of the file. |
| MicrosoftATP.AlertFile.Files.FileProductName | Unknown | The product name of the file. |
| MicrosoftATP.AlertFile.Files.Md5 | String | The MD5 hash of the file. |
Command Example
!microsoft-atp-get-alert-related-files id=da637175364995825348_1865170845
Context Example
{
"MicrosoftATP.AlertFile": {
"Files": [
{
"DeterminationType": "Unknown",
"SignerHash": "84ec67b9ac9d7789bab500503a7862173f432adb",
"Sha1": "d487580502354c61808c7180d1a336beb7ad4624",
"IsPeFile": true,
"GlobalPrevalence": 45004,
"SizeInBytes": 181248,
"Signer": "Microsoft Windows",
"GlobalFirstObserved": "2019-03-21T22:37:42.7608151Z",
"IsValidCertificate": true,
"GlobalLastObserved": "2020-03-22T22:48:20.608421Z",
"Sha256": "f1d62648ef915d85cb4fc140359e925395d315c70f3566b63bb3e21151cb2ce3",
"Md5": "f1139811bbf61362915958806ad30211",
"Issuer": "Microsoft Windows Production PCA 2011"
},
{
"DeterminationType": "Unknown",
"SignerHash": "84ec67b9ac9d7789bab500503a7862173f432adb",
"Sha1": "36c5d12033b2eaf251bae61c00690ffb17fddc87",
"IsPeFile": true,
"GlobalPrevalence": 1316463,
"SizeInBytes": 451584,
"Signer": "Microsoft Windows",
"GlobalFirstObserved": "2019-03-21T08:31:08.1952647Z",
"IsValidCertificate": true,
"GlobalLastObserved": "2020-03-23T09:24:49.9664767Z",
"Sha256": "908b64b1971a979c7e3e8ce4621945cba84854cb98d76367b791a6e22b5f6d53",
"Md5": "cda48fc75952ad12d99e526d0b6bf70a",
"Issuer": "Microsoft Windows Production PCA 2011"
}
],
"AlertID": "da637175364995825348_1865170845"
}
}
Human Readable Output
Alert da637175364995825348_1865170845 Related Files
| Sha1 | Sha256 | SizeInBytes |
|---|---|---|
| d487580502354c61808c7180d1a336beb7ad4624 | f1d62648ef915d85cb4fc140359e925395d315c70f3566b63bb3e21151cb2ce3 | 181248 |
| 36c5d12033b2eaf251bae61c00690ffb17fddc87 | 908b64b1971a979c7e3e8ce4621945cba84854cb98d76367b791a6e22b5f6d53 | 451584 |
13. microsoft-atp-get-alert-related-ips (Deprecated)
This command has been deprecated. An alternative is to use the ‘msg-get-alert-details’ command in the ‘Microsoft Graph Security’ integration, which can retrieve IpAddress as part of the alert details
Retrieves the IP addresses associated to a specific alert.
Required Permissions
Ip.Read.All
Base Command
microsoft-atp-get-alert-related-ips
Input
| Argument Name | Description | Required |
|---|---|---|
| id | The ID of the alert. | Required |
| limit | The limit of IP addresses to display. | Optional |
| offset | The page from which to get the related IP addresses. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.AlertIP.IPs.IpAddress | String | The address of the IP address. |
| MicrosoftATP.AlertIP.AlertID | String | The ID of the alert. |
Command Example
!microsoft-atp-get-alert-related-ips id=da637200417169017725_183736971 limit=3 offset=0
Context Example
{
"MicrosoftATP.AlertIP": {
"IPs": [],
"AlertID": "da637200417169017725_183736971"
}
}
Human Readable Output
Alert da637200417169017725_183736971 Related IPs: []
14. microsoft-atp-get-alert-related-domains (Deprecated)
This command has been deprecated. An alternative is to use the ‘msg-get-alert-details’ command in the ‘Microsoft Graph Security’ integration to retrieve DomainName as part of the alert details.
Retrieves the domains associated with a specific alert.
Required Permissions
URL.Read.All
Base Command
microsoft-atp-get-alert-related-domains
Input
| Argument Name | Description | Required |
|---|---|---|
| id | The ID of the alert. | Required |
| limit | The limit of domains to display. | Optional |
| offset | The page from which to get the related domains. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.AlertDomain.Domains.Domain | String | The domain address. |
| MicrosoftATP.AlertDomain.AlertID | Unknown | The ID of the alert. |
Command Example
!microsoft-atp-get-alert-related-domains id=da637175364995825348_1865170845 limit=2 offset=0
Context Example
{
"MicrosoftATP.AlertDomain": {
"Domains": [],
"AlertID": "da637175364995825348_1865170845"
}
}
Human Readable Output
Alert da637175364995825348_1865170845 Related Domains: []
15. microsoft-atp-list-machine-actions-details
Returns the machine’s actions. If an action ID is set it returns the information on the specific action.
Filtering can only be done on a single argument.
Required Permissions
Machine.ReadWrite.All
Base Command
microsoft-atp-list-machine-actions-details
Input
| Argument Name | Description | Required |
|---|---|---|
| id | ID of the action. | Optional |
| status | The machine action status. Possible values are: Pending, InProgress, Succeeded, Failed, TimeOut, Cancelled. | Optional |
| machine_id | A comma-separated list of machine IDs on which the action was executed. | Optional |
| type | The machine action type. Possible values are: RunAntiVirusScan, Offboard, CollectInvestigationPackage, Isolate, Unisolate, StopAndQuarantineFile, RestrictCodeExecution, UnrestrictCodeExecution. | Optional |
| requestor | The ID of the user that executed the action, only one can be added. | Optional |
| limit | The maximum number of machines to return. Default is 50. | Optional |
| filters | String representation of filters (Override every other filters). | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.MachineAction.ID | String | The machine action ID. |
| MicrosoftATP.MachineAction.Type | String | The type of the action. |
| MicrosoftATP.MachineAction.Scope | String | The scope of the action. |
| MicrosoftATP.MachineAction.Requestor | String | The ID of the user that executed the action. |
| MicrosoftATP.MachineAction.RequestorComment | String | The comment that was written when issuing the action. |
| MicrosoftATP.MachineAction.Status | String | The current status of the command. |
| MicrosoftATP.MachineAction.MachineID | String | The machine ID on which the action was executed. |
| MicrosoftATP.MachineAction.ComputerDNSName | String | The machine DNS name on which the action was executed. |
| MicrosoftATP.MachineAction.CreationDateTimeUtc | Date | The date and time when the action was created. |
| MicrosoftATP.MachineAction.LastUpdateTimeUtc | Date | The last date and time when the action status was updated. |
| MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifier | String | The file identifier. |
| MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifierType | String | The type of the file identifier. Possible values: “SHA1” ,”SHA256”, and “MD5”. |
Command example
!microsoft-atp-list-machine-actions-details machine_id="f70f9fe6,48990365" type=RunAntiVirusScan status=Succeeded
Context Example
{
"MicrosoftATP": {
"MachineAction": [
{
"ComputerDNSName": "desktop-s9",
"CreationDateTimeUtc": "2022-01-25T17:57:18.7944822Z",
"ID": "98cf0adc",
"LastUpdateTimeUtc": null,
"MachineID": "f70f9fe6",
"RelatedFileInfo": {
"FileIdentifier": null,
"FileIdentifierType": null
},
"Requestor": "2f48b784-5da5-4e61-9957-012d2630f1e4",
"RequestorComment": "test3",
"Scope": "Quick",
"Status": "Succeeded",
"Type": "RunAntiVirusScan"
},
{
"ComputerDNSName": "desktop-s8",
"CreationDateTimeUtc": "2022-01-25T17:56:04.3073008Z",
"ID": "99a29fc5",
"LastUpdateTimeUtc": null,
"MachineID": "48990365",
"RelatedFileInfo": {
"FileIdentifier": null,
"FileIdentifierType": null
},
"Requestor": "2f48b784-5da5-4e61-9957-012d2630f1e4",
"RequestorComment": "test2",
"Scope": "Quick",
"Status": "Succeeded",
"Type": "RunAntiVirusScan"
}
]
}
}
Human Readable Output
Machine actions Info
ID Type Requestor RequestorComment Status MachineID ComputerDNSName 98cf0adc RunAntiVirusScan 2f48b784-5da5-4e61-9957-012d2630f1e4 test3 Succeeded f70f9fe6 desktop-s9 99a29fc5 RunAntiVirusScan 2f48b784-5da5-4e61-9957-012d2630f1e4 test2 Succeeded 48990365 desktop-s8
16. microsoft-atp-collect-investigation-package
Collects an investigation package from a machine.
Required Permissions
Machine.CollectForensics
Note: When using the Authorization Code flow (either via the Cortex XSOAR application or by choosing delegated permissions for a self-deployed app), ensure the authenticated user has the “Active Remediation Actions” role assigned. Refer to the Microsoft documentation on creating and managing roles.
Base Command
microsoft-atp-collect-investigation-package
Input
| Argument Name | Description | Required |
|---|---|---|
| machine_id | The ID of the machine. | Required |
| comment | The comment to associate with the action. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.MachineAction.ID | String | The action ID of the machine. |
| MicrosoftATP.MachineAction.Type | String | The type of the action. |
| MicrosoftATP.MachineAction.Scope | String | The scope of the action. |
| MicrosoftATP.MachineAction.Requestor | String | The ID of the user that executed the action. |
| MicrosoftATP.MachineAction.RequestorComment | String | The comment that was written when issuing the action. |
| MicrosoftATP.MachineAction.Status | String | The current status of the command. |
| MicrosoftATP.MachineAction.MachineID | String | The machine ID on which the action was executed. |
| MicrosoftATP.MachineAction.ComputerDNSName | String | The machine DNS name the action was executed on. |
| MicrosoftATP.MachineAction.CreationDateTimeUtc | Date | The date and time when the action was created. |
| MicrosoftATP.MachineAction.LastUpdateTimeUtc | Date | The last date and time when the action status was updated. |
| MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifier | String | The file identifier. |
| MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifierType | String | The type of the file identifier. Possible values: “SHA1”, “SHA256”, and “MD5”. |
Command Example
!microsoft-atp-collect-investigation-package comment="testing" machine_id=f70f9fe6b29cd9511652434919c6530618f06606
Context Example
{
"MicrosoftATP.MachineAction": {
"Status": "Pending",
"CreationDateTimeUtc": "2020-03-23T10:08:05.8010798Z",
"MachineID": "f70f9fe6b29cd9511652434919c6530618f06606",
"LastUpdateTimeUtc": null,
"ComputerDNSName": null,
"Requestor": "2f48b784-5da5-4e61-9957-012d2630f1e4",
"RelatedFileInfo": {
"FileIdentifier": null,
"FileIdentifierType": null
},
"Scope": null,
"Type": "CollectInvestigationPackage",
"ID": "fa952f94-d672-47a6-a637-70b91339c079",
"RequestorComment": "testing"
}
}
Human Readable Output
Initiating collect investigation package from f70f9fe6b29cd9511652434919c6530618f06606 machine
| ID | Type | Requestor | RequestorComment | Status | MachineID |
|---|---|---|---|---|---|
| fa952f94-d672-47a6-a637-70b91339c079 | CollectInvestigationPackage | 2f48b784-5da5-4e61-9957-012d2630f1e4 | testing | Pending | f70f9fe6b29cd9511652434919c6530618f06606 |
17. microsoft-atp-get-investigation-package-sas-uri
Gets a URI that allows downloading of an investigation package.
Required Permissions
Machine.CollectForensics
Note: When using the Authorization Code flow (either via the Cortex XSOAR application or by choosing delegated permissions for a self-deployed app), ensure the authenticated user has the “Active Remediation Actions” role assigned. Refer to the Microsoft documentation on creating and managing roles.
Base Command
microsoft-atp-get-investigation-package-sas-uri
Input
| Argument Name | Description | Required |
|---|---|---|
| action_id | The action ID of the machine. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.InvestigationURI.Link | String | The investigation package URI. |
Command Example
!microsoft-atp-get-investigation-package-sas-uri action_id=6ae51f8f-68e6-4259-abae-0018fdf2e418
Context Example
{
"MicrosoftATP.InvestigationURI": {
"Link": "https://userrequests-us.securitycenter.windows.com:443/safedownload/WDATP_Investigation_Package.zip?token=MIICYwYJKoZIhvcNAQcCoIICV"
}
}
Human Readable Output
Success. This link is valid for a very short time and should be used immediately for downloading the package to a local storage: https:
//userrequests-us.securitycenter.windows.com:443/safedownload/WDATP_Investigation_Package.zip?token=MIICYwYJKoZIhvcNAQcCoIICV
18. microsoft-atp-restrict-app-execution
Restricts the execution of all applications on the machine except a predefined set.
Required Permissions
Machine.RestrictExecution
Note: When using the Authorization Code flow (either via the Cortex XSOAR application or by choosing delegated permissions for a self-deployed app), ensure the authenticated user has the “Active Remediation Actions” role assigned. Refer to the Microsoft documentation on creating and managing roles.
Base Command
microsoft-atp-restrict-app-execution
Input
| Argument Name | Description | Required |
|---|---|---|
| machine_id | The ID of the machine. | Required |
| comment | The comment to associate with the action. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.MachineAction.ID | String | The action ID of the machine. |
| MicrosoftATP.MachineAction.Type | String | The type of the action. |
| MicrosoftATP.MachineAction.Scope | String | The scope of the action. |
| MicrosoftATP.MachineAction.Requestor | String | The ID of the user that executed the action. |
| MicrosoftATP.MachineAction.RequestorComment | String | The comment that was written when issuing the action. |
| MicrosoftATP.MachineAction.Status | String | The current status of the command. |
| MicrosoftATP.MachineAction.MachineID | String | The machine ID the action was executed on. |
| MicrosoftATP.MachineAction.ComputerDNSName | String | The machine DNS name the action was executed on. |
| MicrosoftATP.MachineAction.CreationDateTimeUtc | Date | The date and time when the action was created. |
| MicrosoftATP.MachineAction.LastUpdateTimeUtc | Date | The last date and time when the action status was updated. |
| MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifier | String | The file identifier. |
| MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifierType | String | The type of the file identifier. Possible values: “SHA1”, “SHA256”, and “MD5”. |
Command Example
!microsoft-atp-restrict-app-execution machine_id=f70f9fe6b29cd9511652434919c6530618f06606 comment="test restrict app"
Context Example
{
"MicrosoftATP.MachineAction": {
"Status": "Pending",
"CreationDateTimeUtc": "2020-03-23T10:08:07.7643812Z",
"MachineID": "f70f9fe6b29cd9511652434919c6530618f06606",
"LastUpdateTimeUtc": null,
"ComputerDNSName": null,
"Requestor": "2f48b784-5da5-4e61-9957-012d2630f1e4",
"RelatedFileInfo": {
"FileIdentifier": null,
"FileIdentifierType": null
},
"Scope": null,
"Type": "RestrictCodeExecution",
"ID": "264c80f0-1452-43fb-92d0-5515dd0b821e",
"RequestorComment": "test restrict app"
}
}
Human Readable Output
Initiating Restrict execution of all applications on the machine f70f9fe6b29cd9511652434919c6530618f06606 except a predefined set
| ID | Type | Requestor | RequestorComment | Status | MachineID |
|---|---|---|---|---|---|
| 264c80f0-1452-43fb-92d0-5515dd0b821e | RestrictCodeExecution | 2f48b784-5da5-4e61-9957-012d2630f1e4 | test restrict app | Pending | f70f9fe6b29cd9511652434919c6530618f06606 |
19. microsoft-atp-remove-app-restriction
Enables the execution of any application on the machine.
Required Permissions
Machine.RestrictExecution
Note: When using the Authorization Code flow (either via the Cortex XSOAR application or by choosing delegated permissions for a self-deployed app), ensure the authenticated user has the “Active Remediation Actions” role assigned. Refer to the Microsoft documentation on creating and managing roles.
Base Command
microsoft-atp-remove-app-restriction
Input
| Argument Name | Description | Required |
|---|---|---|
| machine_id | The ID of the machine. | Required |
| comment | The comment to associate with the action. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.MachineAction.ID | String | The action ID of the machine. |
| MicrosoftATP.MachineAction.Type | String | The type of the action. |
| MicrosoftATP.MachineAction.Scope | String | The scope of the action. |
| MicrosoftATP.MachineAction.Requestor | String | The ID of the user that executed the action. |
| MicrosoftATP.MachineAction.RequestorComment | String | The comment that was written when issuing the action. |
| MicrosoftATP.MachineAction.Status | String | The current status of the command. |
| MicrosoftATP.MachineAction.MachineID | String | The machine ID the action was executed on. |
| MicrosoftATP.MachineAction.ComputerDNSName | String | The machine DNS name the action was executed on. |
| MicrosoftATP.MachineAction.CreationDateTimeUtc | Date | The date and time when the action was created. |
| MicrosoftATP.MachineAction.LastUpdateTimeUtc | Date | The last date and time when the action status was updated. |
| MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifier | String | The file identifier. |
| MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifierType | String | The type of the file identifier. Possible values: “SHA1”, “SHA256”, and “MD5”. |
Command Example
!microsoft-atp-remove-app-restriction machine_id=f70f9fe6b29cd9511652434919c6530618f06606 comment="testing remove restriction"
Context Example
{
"MicrosoftATP.MachineAction": {
"Status": "Pending",
"CreationDateTimeUtc": "2020-03-23T10:08:08.5355244Z",
"MachineID": "f70f9fe6b29cd9511652434919c6530618f06606",
"LastUpdateTimeUtc": null,
"ComputerDNSName": null,
"Requestor": "2f48b784-5da5-4e61-9957-012d2630f1e4",
"RelatedFileInfo": {
"FileIdentifier": null,
"FileIdentifierType": null
},
"Scope": null,
"Type": "UnrestrictCodeExecution",
"ID": "5e3cc0b8-b1a1-4a07-92bf-4d63ecec1b18",
"RequestorComment": "testing remove restriction"
}
}
Human Readable Output
Removing applications restriction on the machine f70f9fe6b29cd9511652434919c6530618f06606
| ID | Type | Requestor | RequestorComment | Status | MachineID |
|---|---|---|---|---|---|
| 5e3cc0b8-b1a1-4a07-92bf-4d63ecec1b18 | UnrestrictCodeExecution | 2f48b784-5da5-4e61-9957-012d2630f1e4 | testing remove restriction | Pending | f70f9fe6b29cd9511652434919c6530618f06606 |
20. microsoft-atp-stop-and-quarantine-file
Stops the execution of a file on a machine and deletes it.
Required Permissions
Machine.StopAndQuarantine
Note: When using the Authorization Code flow (either via the Cortex XSOAR application or by choosing delegated permissions for a self-deployed app), ensure the authenticated user has the “Active Remediation Actions” role assigned. Refer to the Microsoft documentation on creating and managing roles.
Base Command
microsoft-atp-stop-and-quarantine-file
Input
| Argument Name | Description | Required |
|---|---|---|
| machine_id | The ID of the machine. When providing multiple values, each value is checked for the same hash. | Required |
| file_hash | The file SHA1 hash to stop and quarantine on the machine. When providing multiple values, each value is checked for the same machine_id. | Required |
| comment | The comment to associate with the action. | Required |
| polling | Whether to poll for the action status. | Optional |
| timeout_in_seconds | The timeout in seconds for the polling. | Optional |
| interval_in_seconds | The interval in seconds between polling. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.MachineAction.ID | String | The action ID of the machine. |
| MicrosoftATP.MachineAction.Type | String | The type of the action. |
| MicrosoftATP.MachineAction.Scope | String | The scope of the action. |
| MicrosoftATP.MachineAction.Requestor | String | The ID of the user that executed the action. |
| MicrosoftATP.MachineAction.RequestorComment | String | The comment that was written when issuing the action. |
| MicrosoftATP.MachineAction.Status | String | The current status of the command. |
| MicrosoftATP.MachineAction.MachineID | String | The machine ID on which the action was executed. |
| MicrosoftATP.MachineAction.ComputerDNSName | String | The machine DNS name on which the action was executed. |
| MicrosoftATP.MachineAction.CreationDateTimeUtc | Date | The date and time when the action was created. |
| MicrosoftATP.MachineAction.LastUpdateTimeUtc | Date | The last date and time when the action status was updated. |
| MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifier | String | The file identifier. |
| MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifierType | String | The type of the file identifier. Possible values: “SHA1”, “SHA256”, and “MD5”. |
Command Example
!microsoft-atp-stop-and-quarantine-file comment="testing" file_hash=abe3ba25e5660c23dfe478d577cfacde5795870c machine_id=12345678
Context Example
{
"ID": "123",
"Type": "StopAndQuarantineFile",
"Scope": null,
"Requestor": "123abc",
"RequestorComment": "Test",
"Status": "Pending",
"MachineID": "12345678",
"ComputerDNSName": null,
"CreationDateTimeUtc": "2020-03-20T14:21:49.9097785Z",
"LastUpdateTimeUtc": "2020-02-27T12:21:00.4568741Z",
"RelatedFileInfo": {
"fileIdentifier": "87654321", "fileIdentifierType": "Sha1"
}
}
Human Readable Output
Stopping the execution of a file on 12345678 machine and deleting it
| ID | Type | Requestor | RequestorComment | Status | MachineID |
|---|---|---|---|---|---|
| 123 | StopAndQuarantineFile | 123abc | Test | Pending | 12345678 |
21. microsoft-atp-list-investigations
Retrieves a collection of investigations or retrieves a specific investigation by its ID.
Required Permissions
Alert.ReadWrite.All
Base Command
microsoft-atp-list-investigations
Input
| Argument Name | Description | Required |
|---|---|---|
| id | The ID can be the investigation ID or the investigation triggering an alert ID. | Optional |
| limit | The limit of investigations to display. | Optional |
| offset | The page from which to get the investigations. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.Investigation.ID | String | The ID of the investigation. |
| MicrosoftATP.Investigation.StartTime | Date | The date and time when the investigation was created. |
| MicrosoftATP.Investigation.EndTime | Date | The date and time when the investigation was completed. |
| MicrosoftATP.Investigation.State | String | The state of the investigation. |
| MicrosoftATP.Investigation.CancelledBy | Unknown | The ID of the user or application that cancelled that investigation. |
| MicrosoftATP.Investigation.StatusDetails | Unknown | The details of the state of the investigation. |
| MicrosoftATP.Investigation.MachineID | String | The machine ID the investigation is executed on. |
| MicrosoftATP.Investigation.ComputerDNSName | String | The machine DNS name the investigation is executed on. |
| MicrosoftATP.Investigation.TriggeringAlertID | String | The alert ID that triggered the investigation. |
Command Example
!microsoft-atp-list-investigations limit=3 offset=0
Context Example
{
"MicrosoftATP.Investigation": [
{
"CancelledBy": null,
"InvestigationState": "PendingApproval",
"MachineID": "4899036531e374137f63289c3267bad772c13fef",
"TriggeringAlertID": "da637200417169017725_183736971",
"ComputerDNSName": "desktop-s2455r8",
"StatusDetails": null,
"StartTime": "2020-03-17T11:35:17Z",
"EndTime": null,
"ID": "10"
},
{
"CancelledBy": null,
"InvestigationState": "PendingApproval",
"MachineID": "f70f9fe6b29cd9511652434919c6530618f06606",
"TriggeringAlertID": "da637200385941308230_1832866941",
"ComputerDNSName": "desktop-s2455r9",
"StatusDetails": null,
"StartTime": "2020-03-17T10:43:15Z",
"EndTime": null,
"ID": "9"
},
{
"CancelledBy": null,
"InvestigationState": "TerminatedBySystem",
"MachineID": "f70f9fe6b29cd9511652434919c6530618f06606",
"TriggeringAlertID": "da637189366671550108_395377714",
"ComputerDNSName": "desktop-s2455r9",
"StatusDetails": null,
"StartTime": "2020-03-04T16:37:50Z",
"EndTime": "2020-03-11T18:13:42Z",
"ID": "8"
}
]
}
Human Readable Output
Investigations Info
| ID | StartTime | EndTime | InvestigationState | MachineID | ComputerDNSName | TriggeringAlertID |
|---|---|---|---|---|---|---|
| 10 | 2020-03-17T11:35:17Z | PendingApproval | 4899036531e374137f63289c3267bad772c13fef | desktop-s2455r8 | da637200417169017725_183736971 | |
| 9 | 2020-03-17T10:43:15Z | PendingApproval | f70f9fe6b29cd9511652434919c6530618f06606 | desktop-s2455r9 | da637200385941308230_1832866941 | |
| 8 | 2020-03-04T16:37:50Z | 2020-03-11T18:13:42Z | TerminatedBySystem | f70f9fe6b29cd9511652434919c6530618f06606 | desktop-s2455r9 | da637189366671550108_395377714 |
22. microsoft-atp-start-investigation
Starts an automated investigation on a machine.
Required Permissions
Alert.ReadWrite.All
Base Command
microsoft-atp-start-investigation
Input
| Argument Name | Description | Required |
|---|---|---|
| machine_id | The ID of the machine. | Required |
| comment | The comment to associate with the action. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.Investigation.ID | String | The ID of the investigation. |
| MicrosoftATP.Investigation.StartTime | Date | The date and time when the investigation was created. |
| MicrosoftATP.Investigation.EndTime | Date | The date and time when the investigation was completed. |
| MicrosoftATP.Investigation.State | String | The state of the investigation. |
| MicrosoftATP.Investigation.CancelledBy | Unknown | The ID of the user or application that cancelled that investigation. |
| MicrosoftATP.Investigation.StatusDetails | Unknown | The details of the state of the investigation. |
| MicrosoftATP.Investigation.MachineID | String | The machine ID the investigation is executed on. |
| MicrosoftATP.Investigation.ComputerDNSName | String | The machine DNS name the investigation is executed on. |
| MicrosoftATP.Investigation.TriggeringAlertID | String | The alert ID that triggered the investigation. |
Command Example
!microsoft-atp-start-investigation comment="testing" machine_id=f70f9fe6b29cd9511652434919c6530618f06606
Context Example
{
"MicrosoftATP.Investigation": {
"CancelledBy": null,
"InvestigationState": "PendingApproval",
"MachineID": null,
"TriggeringAlertID": "da637205548921456173_375980286",
"ComputerDNSName": null,
"StatusDetails": null,
"StartTime": null,
"EndTime": null,
"ID": "da637205548921456173_375980286"
}
}
Human Readable Output
Starting investigation da637205548921456173_375980286 on f70f9fe6b29cd9511652434919c6530618f06606 machine
| ID | InvestigationState | TriggeringAlertID |
|---|---|---|
| da637205548921456173_375980286 | PendingApproval | da637205548921456173_375980286 |
23. microsoft-atp-get-domain-statistics
Retrieves statistics on the given domain.
Required Permissions
URL.Read.All
Base Command
microsoft-atp-get-domain-statistics
Input
| Argument Name | Description | Required |
|---|---|---|
| domain | The domain address. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.DomainStatistics.Statistics.Host | String | The domain host. |
| MicrosoftATP.DomainStatistics.Statistics.OrgPrevalence | String | The prevalence of the domain in the organization. |
| MicrosoftATP.DomainStatistics.Statistics.OrgFirstSeen | Date | The first date and time the domain was seen in the organization. |
| MicrosoftATP.DomainStatistics.Statistics.OrgLastSeen | Date | The last date and time the domain was seen in the organization. |
Command Example
!microsoft-atp-get-domain-statistics domain=google.com
Context Example
{
"MicrosoftATP.DomainStatistics": {
"Domain": "google.com",
"Statistics": {
"OrgLastSeen": "2020-02-24T13:14:54Z",
"Host": "google.com",
"OrgFirstSeen": "2020-02-24T12:50:04Z",
"OrgPrevalence": "1"
}
}
}
Human Readable Output
Statistics on google.com domain
| Host | OrgFirstSeen | OrgLastSeen | OrgPrevalence |
|---|---|---|---|
| google.com | 2020-02-24T12:50:04Z | 2020-02-24T13:14:54Z | 1 |
24. microsoft-atp-get-domain-alerts (Deprecated)
This command has been deprecated. No available replacement
Retrieves a collection of alerts related to a given domain address.
Required Permissions
Alert.ReadWrite.All
Base Command
microsoft-atp-get-domain-alerts
Input
| Argument Name | Description | Required |
|---|---|---|
| domain | The domain address. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.DomainAlert.Domain | String | The domain address. |
| MicrosoftATP.DomainAlert.Alerts.ID | String | The ID of the alert. |
| MicrosoftATP.DomainAlert.Alerts.IncidentID | Number | The incident ID of the alert. |
| MicrosoftATP.DomainAlert.Alerts.InvestigationID | Number | The investigation ID related to the alert. |
| MicrosoftATP.DomainAlert.Alerts.InvestigationState | String | The current state of the investigation. |
| MicrosoftATP.DomainAlert.Alerts.AssignedTo | String | The owner of the alert. |
| MicrosoftATP.DomainAlert.Alerts.Severity | String | The severity of the alert. |
| MicrosoftATP.DomainAlert.Alerts.Status | String | The current status of the alert. |
| MicrosoftATP.DomainAlert.Alerts.Classification | String | The alert classification. |
| MicrosoftATP.DomainAlert.Alerts.Determination | String | The determination of the alert. |
| MicrosoftATP.DomainAlert.Alerts.DetectionSource | String | The detection source. |
| MicrosoftATP.DomainAlert.Alerts.Category | String | The category of the alert. |
| MicrosoftATP.DomainAlert.Alerts.ThreatFamilyName | String | The family name of the threat. |
| MicrosoftATP.DomainAlert.Alerts.Title | String | The title of the alert. |
| MicrosoftATP.DomainAlert.Alerts.Description | String | The description of the alert. |
| MicrosoftATP.DomainAlert.Alerts.AlertCreationTime | Date | The date and time the alert was created. |
| MicrosoftATP.DomainAlert.Alerts.FirstEventTime | Date | The first event time that triggered the alert on that machine. |
| MicrosoftATP.DomainAlert.Alerts.LastEventTime | Date | The last event time that triggered the alert on that machine. |
| MicrosoftATP.DomainAlert.Alerts.LastUpdateTime | Date | The UTC time of the last update. |
| MicrosoftATP.DomainAlert.Alerts.ResolvedTime | Date | The date and time in which the status of the alert was changed to “Resolved”. |
| MicrosoftATP.DomainAlert.Alerts.MachineID | String | The machine ID that is associated with the alert. |
| MicrosoftATP.DomainAlert.Alerts.ComputerDNSName | String | The machine DNS name. |
| MicrosoftATP.DomainAlert.Alerts.AADTenantID | String | The AAD tenant ID. |
| MicrosoftATP.DomainAlert.Alerts.Comments.Comment | String | The alert comment string. |
| MicrosoftATP.DomainAlert.Alerts.Comments.CreatedBy | String | The alert comment created by the string. |
| MicrosoftATP.DomainAlert.Alerts.Comments.CreatedTime | Date | The alert comment create time and date. |
Command Example
!microsoft-atp-get-domain-alerts domain=google.com
Context Example
{
"MicrosoftATP.DomainAlert": {
"Domain": "google.com",
"Alerts": []
}
}
Human Readable Output
Domain google.com related alerts Info
No entries.
25. microsoft-atp-get-domain-machines
Retrieves a collection of machines that have communicated with a given domain address.
Required Permissions
Machine.ReadWrite.All
Base Command
microsoft-atp-get-domain-machines
Input
| Argument Name | Description | Required |
|---|---|---|
| domain | The domain address. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.DomainMachine.Domain | String | The domain address. |
| MicrosoftATP.DomainMachine.Machines.ID | String | The ID of the machine. |
| MicrosoftATP.DomainMachine.Machines.ComputerDNSName | String | The DNS name of the machine. |
| MicrosoftATP.DomainMachine.Machines.FirstSeen | Date | The first date and time when the machine was observed by Microsoft Defender ATP. |
| MicrosoftATP.DomainMachine.Machines.LastSeen | Date | The last date and time where the machine was observed by Microsoft Defender ATP. |
| MicrosoftATP.DomainMachine.Machines.OSPlatform | String | The operating system platform. |
| MicrosoftATP.DomainMachine.Machines.OSVersion | String | The operating system version. |
| MicrosoftATP.DomainMachine.Machines.OSProcessor | String | The operating system processor. |
| MicrosoftATP.DomainMachine.Machines.LastIPAddress | String | The last IP address on the machine. |
| MicrosoftATP.DomainMachine.Machines.LastExternalIPAddress | String | The last IP address the machine accessed. |
| MicrosoftATP.DomainMachine.Machines.OSBuild | Number | The operating system build number. |
| MicrosoftATP.DomainMachine.Machines.HealthStatus | String | The health status of the machine. |
| MicrosoftATP.DomainMachine.Machines.RBACGroupID | Number | The RBAC group ID of the machine. |
| MicrosoftATP.DomainMachine.Machines.RBACGroupName | String | The RBAC group name of the machine. |
| MicrosoftATP.DomainMachine.Machines.RiskScore | String | The risk score of the machine. |
| MicrosoftATP.DomainMachine.Machines.ExposureLevel | String | The exposure level of the machine. |
| MicrosoftATP.DomainMachine.Machines.IsAADJoined | Boolean | Whether the machine is AAD joined. |
| MicrosoftATP.DomainMachine.Machines.AADDeviceID | String | The AAD device ID. |
| MicrosoftATP.DomainMachine.Machines.MachineTags | String | The set of machine tags. |
Command Example
!microsoft-atp-get-domain-machines domain=google.com
Context Example
{
"MicrosoftATP.DomainMachine": {
"Domain": "google.com",
"Machines": [
{
"OSBuild": 18363,
"ExposureLevel": "Medium",
"OSPlatform": "Windows10",
"MachineTags": [
"test Tag 2",
"test Tag 5"
],
"AADDeviceID": "cfcf4177-227e-4cdb-ac8e-f9a3da1ca30c",
"ComputerDNSName": "desktop-s2455r8",
"RBACGroupID": 0,
"OSProcessor": "x64",
"HealthStatus": "Active",
"AgentVersion": "10.6940.18362.693",
"LastExternalIPAddress": "81.166.99.236",
"LastIPAddress": "192.168.1.71",
"OSVersion": "1909",
"RiskScore": "High",
"ID": "4899036531e374137f63289c3267bad772c13fef",
"FirstSeen": "2020-02-17T08:30:07.2415577Z",
"LastSeen": "2020-03-23T08:10:41.473428Z"
}
]
}
}
Human Readable Output
Machines that have communicated with google.com domain
| ID | ComputerDNSName | OSPlatform | LastIPAddress | LastExternalIPAddress | HealthStatus | RiskScore | ExposureLevel |
|---|---|---|---|---|---|---|---|
| 4899036531e374137f63289c3267bad772c13fef | desktop-s2455r8 | Windows10 | 192.168.1.71 | 81.166.99.236 | Active | High | Medium |
26. microsoft-atp-get-file-statistics
Retrieves statistics for the given file.
Required Permissions
File.Read.All
Base Command
microsoft-atp-get-file-statistics
Input
| Argument Name | Description | Required |
|---|---|---|
| file_hash | The file SHA1 hash to get statistics on. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.FileStatistics.Sha1 | String | The file SHA1 hash. |
| MicrosoftATP.FileStatistics.Statistics.OrgPrevalence | String | The number of times the file is detected in the organization. |
| MicrosoftATP.FileStatistics.Statistics.OrganizationPrevalence | Number | The number of times the file is detected in the organization. |
| MicrosoftATP.FileStatistics.Statistics.OrgFirstSeen | Date | The first date and time the file was seen in the organization. |
| MicrosoftATP.FileStatistics.Statistics.OrgLastSeen | Date | The last date and time the file was seen in the organization. |
| MicrosoftATP.FileStatistics.Statistics.GlobalPrevalence | String | The number of times the file is detected across all organizations by Microsoft Defender ATP. |
| MicrosoftATP.FileStatistics.Statistics.GloballyPrevalence | Number | The number of times the file is detected across all organizations by Microsoft Defender ATP. |
| MicrosoftATP.FileStatistics.Statistics.GlobalFirstObserved | Date | The first global observation date and time of the file. |
| MicrosoftATP.FileStatistics.Statistics.GlobalLastObserved | Date | The last global observation date and time of the file. |
| MicrosoftATP.FileStatistics.Statistics.TopFileNames | String | The top names of the file. |
| File.SHA1 | String | The SHA1 hash of the file. |
| File.OrganizationPrevalence | Number | The number of times the indicator is detected in the organization. |
| File.GlobalPrevalence | Number | The number of times the indicator is detected across all organizations by Microsoft Defender ATP. |
| File.OrganizationFirstSeen | Date | The date and time when the indicator was first seen in the organization. |
| File.OrganizationLastSeen | Date | The date and time when the indicator was last seen in the organization. |
| File.FirstSeenBySource | Date | The date and time when the indicator was first seen by Microsoft Defender ATP. |
| File.LastSeenBySource | Date | The date and time when the indicator was last seen by Microsoft Defender ATP. |
Command Example
!microsoft-atp-get-file-statistics file_hash=9fe3ba25e5660c23dfe478d577cfacde5795870c
Context Example
{
"File": {
"SHA1": "9fe3ba25e5660c23dfe478d577cfacde5795870c",
"FirstSeenBySource": "2019-04-03T04:10:18.1001071Z",
"LastSeenBySource": "2020-03-23T09:24:54.169574Z",
"GlobalPrevalence": 1355899,
"Hashes":[
{
"type" :"SHA1",
"value": "9fe3ba25e5660c23dfe478d577cfacde5795870c"
}
],
"OrganizationPrevalence": 0
},
"MicrosoftATP": {
"FileStatistics": {
"Sha1": "9fe3ba25e5660c23dfe478d577cfacde5795870c",
"Statistics": {
"TopFileNames": [
"lsass.exe"
],
"GlobalFirstObserved": "2019-04-03T04:10:18.1001071Z",
"GlobalPrevalence": "1355899",
"GloballyPrevalence": 1355899,
"OrgPrevalence": "0",
"OrganizationPrevalence": 0,
"GlobalLastObserved": "2020-03-23T09:24:54.169574Z"
}
}
}
}
Human Readable Output
Statistics on 9fe3ba25e5660c23dfe478d577cfacde5795870c file
| Global First Observed | Global Last Observed | Global Prevalence | Organization Prevalence | Top File Names |
|---|---|---|---|---|
| 2019-04-03T04:10:18.1001071Z | 2020-03-23T09:24:54.169574Z | 1355899 | 0 | lsass.exe |
File Indicator Example
| Type | Value | Verdict | Related Incidents | Expiration | Global Prevalence | Organization Prevalence | First Seen By Source | Last Seen By Source | Organization First Seen | Organization Last Seen |
|---|---|---|---|---|---|---|---|---|---|---|
| File | 50ef7c645fd5cbb95d50fbaddf6213800f9296ec | Benign | 2 | Never | 195803 | 0 | April 03, 2019 4:10 AM | March 23, 2020 9:24 AM | N/A | N/A |
27. microsoft-atp-get-file-alerts (Deprecated)
This command has been deprecated. No available replacement.
Retrieves a collection of alerts related to a given file hash.
Required Permissions
Alert.ReadWrite.All
Base Command
microsoft-atp-get-file-alerts
Input
| Argument Name | Description | Required |
|---|---|---|
| file_hash | The file SHA1 hash to get statistics on. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.FileAlert.Sha1 | String | The file SHA1 hash. |
| MicrosoftATP.FileAlert.Alerts.ID | String | The ID of the alert. |
| MicrosoftATP.FileAlert.Alerts.IncidentID | Number | The incident ID of the alert. |
| MicrosoftATP.FileAlert.Alerts.InvestigationID | Number | The investigation ID related to the alert. |
| MicrosoftATP.FileAlert.Alerts.InvestigationState | String | The current state of the investigation. |
| MicrosoftATP.FileAlert.Alerts.AssignedTo | String | The owner of the alert. |
| MicrosoftATP.FileAlert.Alerts.Severity | String | The severity of the alert. |
| MicrosoftATP.FileAlert.Alerts.Status | String | The current status of the alert. |
| MicrosoftATP.FileAlert.Alerts.Classification | String | The alert classification. |
| MicrosoftATP.FileAlert.Alerts.Determination | String | The determination of the alert. |
| MicrosoftATP.FileAlert.Alerts.DetectionSource | String | The detection source. |
| MicrosoftATP.FileAlert.Alerts.Category | String | The category of the alert. |
| MicrosoftATP.FileAlert.Alerts.ThreatFamilyName | String | The family name of the threat. |
| MicrosoftATP.FileAlert.Alerts.Title | String | The title of the alert. |
| MicrosoftATP.FileAlert.Alerts.Description | String | The description of the alert. |
| MicrosoftATP.FileAlert.Alerts.AlertCreationTime | Date | The date and time the alert was created. |
| MicrosoftATP.FileAlert.Alerts.FirstEventTime | Date | The first event time that triggered the alert on that machine. |
| MicrosoftATP.FileAlert.Alerts.LastEventTime | Date | The last event time that triggered the alert on that machine. |
| MicrosoftATP.FileAlert.Alerts.LastUpdateTime | Date | The UTC time of the last update. |
| MicrosoftATP.FileAlert.Alerts.ResolvedTime | Date | The date and time in which the status of the alert was changed to “Resolved”. |
| MicrosoftATP.FileAlert.Alerts.MachineID | String | The machine ID that is associated with the alert. |
| MicrosoftATP.FileAlert.Alerts.ComputerDNSName | String | The DNS name of the machine. |
| MicrosoftATP.FileAlert.Alerts.AADTenantID | String | The AAD tenant ID. |
| MicrosoftATP.FileAlert.Alerts.Comments.Comment | String | The alert comment string. |
| MicrosoftATP.FileAlert.Alerts.Comments.CreatedBy | String | The alert comment created by the string. |
| MicrosoftATP.FileAlert.Alerts.Comments.CreatedTime | Date | The time and date the alert comment was created. |
Command Example
!microsoft-atp-get-file-alerts file_hash=9fe3ba25e5660c23dfe478d577cfacde5795870c
Context Example
{
"MicrosoftATP.FileAlert": {
"Sha1": "9fe3ba25e5660c23dfe478d577cfacde5795870c",
"Alerts": [
{
"Category": "None",
"ThreatFamilyName": null,
"Severity": "Medium",
"LastEventTime": "2020-03-15T13:59:14.2438912Z",
"FirstEventTime": "2020-03-15T13:59:14.2438912Z",
"Comments": [
{
"Comment": null,
"CreatedTime": null,
"CreatedBy": null
}
],
"AADTenantID": "TENANT-ID",
"AlertCreationTime": "2020-03-17T11:55:31.890247Z",
"Status": "New",
"Description": "Created for test",
"InvestigationState": "PendingApproval",
"MachineID": "4899036531e374137f63289c3267bad772c13fef",
"Title": "test alert",
"InvestigationID": 10,
"Determination": null,
"IncidentID": 15,
"AssignedTo": null,
"DetectionSource": "CustomerTI",
"ResolvedTime": null,
"ID": "da637200429318902470_-1583197054",
"LastUpdateTime": "2020-03-17T11:55:33.0233333Z",
"Classification": null,
"ComputerDNSName": "desktop-s2455r8",
"Evidence": [
{
"userPrincipalName": null,
"processId": 656,
"sha1": "9fe3ba25e5660c23dfe478d577cfacde5795870c",
"parentProcessCreationTime": null,
"domainName": null,
"url": null,
"processCommandLine": "lsass.exe",
"entityType": "Process",
"processCreationTime": "2020-03-13T16:58:59Z",
"aadUserId": null,
"fileName": "lsass.exe",
"sha256": null,
"parentProcessId": 512,
"userSid": null,
"filePath": "c:\\windows\\system32\\lsass.exe",
"accountName": null,
"ipAddress": null
}
]
}
]
}
}
Human Readable Output
File 9fe3ba25e5660c23dfe478d577cfacde5795870c related alerts Info
| ID | Title | Description | IncidentID | Severity | Status | Category | MachineID |
|---|---|---|---|---|---|---|---|
| da637200429318902470_-1583197054 | test alert | Created for test | 15 | Medium | New | None | 4899036531e374137f63289c3267bad772c13fef |
28. microsoft-atp-get-ip-statistics
Retrieves statistics for the given IP address.
Required Permissions
Ip.Read.All
Base Command
microsoft-atp-get-ip-statistics
Input
| Argument Name | Description | Required |
|---|---|---|
| ip | The IP address. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.IPStatistics.Statistics.IPAddress | String | The IP address. |
| MicrosoftATP.IPStatistics.Statistics.OrgPrevalence | String | The prevalence of the IP address in the organization. |
| MicrosoftATP.IPStatistics.Statistics.OrgFirstSeen | Date | The first date and time the IP address was seen in the organization. |
| MicrosoftATP.IPStatistics.Statistics.OrgLastSeen | Date | The last date and time the IP address was seen in the organization. |
Command Example
!microsoft-atp-get-ip-statistics ip=8.8.8.8
Context Example
{
"MicrosoftATP.IPStatistics": {
"Statistics": {
"OrgLastSeen": "2020-03-01T15:19:40Z",
"OrgPrevalence": "1",
"OrgFirstSeen": "2020-02-22T12:52:35Z"
},
"IPAddress": "8.8.8.8"
}
}
Human Readable Output
Statistics on 8.8.8.8 IP
| OrgFirstSeen | OrgLastSeen | OrgPrevalence |
|---|---|---|
| 2020-02-22T12:52:35Z | 2020-03-01T15:19:40Z | 1 |
29. microsoft-atp-get-ip-alerts (Deprecated)
This command has been deprecated. No available replacement.
Retrieves a collection of alerts related to a given IP address.
Required Permissions
Alert.ReadWrite.All
Base Command
microsoft-atp-get-ip-alerts
Input
| Argument Name | Description | Required |
|---|---|---|
| ip | The Ip address. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.IPAlert.IPAddress | String | The IP address. |
| MicrosoftATP.IPAlert.Alerts.ID | String | The alert ID. |
| MicrosoftATP.IPAlert.Alerts.IncidentID | Number | The incident ID of the alert. |
| MicrosoftATP.IPAlert.Alerts.InvestigationID | Number | The investigation ID related to the alert. |
| MicrosoftATP.IPAlert.Alerts.InvestigationState | String | The current state of the investigation. |
| MicrosoftATP.IPAlert.Alerts.AssignedTo | String | The owner of the alert. |
| MicrosoftATP.IPAlert.Alerts.Severity | String | The severity of the alert. |
| MicrosoftATP.IPAlert.Alerts.Status | String | The current status of the alert. |
| MicrosoftATP.IPAlert.Alerts.Classification | String | The alert classification. |
| MicrosoftATP.IPAlert.Alerts.Determination | String | The determination of the alert. |
| MicrosoftATP.IPAlert.Alerts.DetectionSource | String | The detection source. |
| MicrosoftATP.IPAlert.Alerts.Category | String | The category of the alert. |
| MicrosoftATP.IPAlert.Alerts.ThreatFamilyName | String | The family name of the threat. |
| MicrosoftATP.IPAlert.Alerts.Title | String | The title of the alert. |
| MicrosoftATP.IPAlert.Alerts.Description | String | The description of the alert. |
| MicrosoftATP.IPAlert.Alerts.AlertCreationTime | Date | The date and time the alert was created. |
| MicrosoftATP.IPAlert.Alerts.FirstEventTime | Date | The first event time that triggered the alert on that machine. |
| MicrosoftATP.IPAlert.Alerts.LastEventTime | Date | The last event time that triggered the alert on that machine. |
| MicrosoftATP.IPAlert.Alerts.LastUpdateTime | Date | The UTC time of the last update. |
| MicrosoftATP.IPAlert.Alerts.ResolvedTime | Date | The date and time in which the status of the alert was changed to “Resolved”. |
| MicrosoftATP.IPAlert.Alerts.MachineID | String | The machine ID that is associated with the alert. |
| MicrosoftATP.IPAlert.Alerts.ComputerDNSName | String | The DNS name of the machine. |
| MicrosoftATP.IPAlert.Alerts.AADTenantID | String | The AAD tenant ID. |
| MicrosoftATP.IPAlert.Alerts.Comments.Comment | String | The alert’s comment string. |
| MicrosoftATP.IPAlert.Alerts.Comments.CreatedBy | String | The alert comment created by the string. |
| MicrosoftATP.IPAlert.Alerts.Comments.CreatedTime | Date | The time and date the alert comment was created. |
Command Example
!microsoft-atp-get-ip-alerts ip=8.8.8.8
Context Example
{
"MicrosoftATP.IPAlert": {
"Alerts": [],
"IPAddress": "8.8.8.8"
}
}
Human Readable Output
IP 8.8.8.8 related alerts Info
No entries.
30. microsoft-atp-get-user-alerts (Deprecated)
This command has been deprecated. No available replacement.
Retrieves a collection of alerts related to a given user ID.
Required Permissions
Alert.ReadWrite.All
Base Command
microsoft-atp-get-user-alerts
Input
| Argument Name | Description | Required |
|---|---|---|
| username | The user ID. The ID is not the full UPN, but only the username. For example, to retrieve alerts for “user1@test.com” use “user1”. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.UserAlert.Username | String | The name of the user. |
| MicrosoftATP.UserAlert.Alerts.ID | String | The ID of the alert. |
| MicrosoftATP.UserAlert.Alerts.IncidentID | Number | The incident ID of the alert. |
| MicrosoftATP.UserAlert.Alerts.InvestigationID | Number | The investigation ID related to the alert. |
| MicrosoftATP.UserAlert.Alerts.InvestigationState | String | The current state of the investigation. |
| MicrosoftATP.UserAlert.Alerts.AssignedTo | String | The owner of the alert. |
| MicrosoftATP.UserAlert.Alerts.Severity | String | The severity of the alert. |
| MicrosoftATP.UserAlert.Alerts.Status | String | The current status of the alert. |
| MicrosoftATP.UserAlert.Alerts.Classification | String | The alert classification. |
| MicrosoftATP.UserAlert.Alerts.Determination | String | The determination of the alert. |
| MicrosoftATP.UserAlert.Alerts.DetectionSource | String | The detection source. |
| MicrosoftATP.UserAlert.Alerts.Category | String | The category of the alert. |
| MicrosoftATP.UserAlert.Alerts.ThreatFamilyName | String | The family name of the threat. |
| MicrosoftATP.UserAlert.Alerts.Title | String | The title of the alert. |
| MicrosoftATP.UserAlert.Alerts.Description | String | The description of the alert. |
| MicrosoftATP.UserAlert.Alerts.AlertCreationTime | Date | The date and time the alert was created. |
| MicrosoftATP.UserAlert.Alerts.FirstEventTime | Date | The first event time that triggered the alert on that machine. |
| MicrosoftATP.UserAlert.Alerts.LastEventTime | Date | The last event time that triggered the alert on that machine. |
| MicrosoftATP.UserAlert.Alerts.LastUpdateTime | Date | The UTC time of the last update. |
| MicrosoftATP.UserAlert.Alerts.ResolvedTime | Date | The date and time when the status of the alert was changed to “Resolved”. |
| MicrosoftATP.UserAlert.Alerts.MachineID | String | The machine ID that is associated with the alert. |
| MicrosoftATP.UserAlert.Alerts.ComputerDNSName | String | The DNS name of the machine. |
| MicrosoftATP.UserAlert.Alerts.AADTenantID | String | The AAD tenant ID. |
| MicrosoftATP.UserAlert.Alerts.Comments.Comment | String | The comment string of the alert. |
| MicrosoftATP.UserAlert.Alerts.Comments.CreatedBy | String | The alert comment created by the string. |
| MicrosoftATP.UserAlert.Alerts.Comments.CreatedTime | Date | The time and date the alert comment was created. |
Command Example
!microsoft-atp-get-user-alerts username=demisto
Context Example
{
"MicrosoftATP.UserAlert": {
"Username": "demisto",
"Alerts": [
{
"Category": "DefenseEvasion",
"ThreatFamilyName": null,
"Severity": "Medium",
"LastEventTime": "2020-02-17T11:39:09.9948632Z",
"FirstEventTime": "2020-02-17T11:37:11.4901408Z",
"Comments": [
{
"Comment": null,
"CreatedTime": null,
"CreatedBy": null
}
],
"AADTenantID": "TENANT-ID",
"AlertCreationTime": "2020-02-17T11:40:33.5724218Z",
"Status": "InProgress",
"Description": "A process abnormally injected code into another process, As a result, unexpected code may be running in the target process memory. Injection is often used to hide malicious code execution within a trusted process. \nAs a result, the target process may exhibit abnormal behaviors such as opening a listening port or connecting to a command and control server.",
"InvestigationState": "Benign",
"MachineID": "4899036531e374137f63289c3267bad772c13fef",
"Title": "Suspicious process injection observed",
"InvestigationID": 1,
"Determination": null,
"IncidentID": 7,
"AssignedTo": "Automation",
"DetectionSource": "WindowsDefenderAtp",
"ResolvedTime": null,
"ID": "da637175364336494657_410871946",
"LastUpdateTime": "2020-03-17T11:29:55.0066667Z",
"Classification": null,
"ComputerDNSName": "desktop-s2455r8",
"Evidence": [
{
"userPrincipalName": null,
"processId": 11192,
"sha1": "36c5d12033b2eaf251bae61c00690ffb17fddc87",
"parentProcessCreationTime": "2020-02-17T08:03:34.9841426Z",
"domainName": null,
"url": null,
"processCommandLine": "\"powershell.exe\" ",
"entityType": "Process",
"processCreationTime": "2020-02-17T12:38:47.6521977Z",
"aadUserId": null,
"fileName": "powershell.exe",
"sha256": "908b64b1971a979c7e3e8ce4621945cba84854cb98d76367b791a6e22b5f6d53",
"parentProcessId": 9008,
"userSid": null,
"filePath": "C:\\Windows\\System32\\WindowsPowerShell\\v1.0",
"accountName": null,
"ipAddress": null
},
{
"userPrincipalName": null,
"processId": 12508,
"sha1": "d487580502354c61808c7180d1a336beb7ad4624",
"parentProcessCreationTime": "2020-02-17T12:38:47.6521977Z",
"domainName": null,
"url": null,
"processCommandLine": "\"notepad.exe\"",
"entityType": "Process",
"processCreationTime": "2020-02-17T12:41:04.9040946Z",
"aadUserId": null,
"fileName": "notepad.exe",
"sha256": "f1d62648ef915d85cb4fc140359e925395d315c70f3566b63bb3e21151cb2ce3",
"parentProcessId": 11192,
"userSid": null,
"filePath": "C:\\Windows\\System32",
"accountName": null,
"ipAddress": null
},
{
"userPrincipalName": null,
"processId": null,
"sha1": null,
"parentProcessCreationTime": null,
"domainName": "DESKTOP-S2455R8",
"url": null,
"processCommandLine": null,
"entityType": "User",
"processCreationTime": null,
"aadUserId": null,
"fileName": null,
"sha256": null,
"parentProcessId": null,
"userSid": "S-1-5-21-4197691174-1403503641-4006700887-1001",
"filePath": null,
"accountName": "demisto",
"ipAddress": null
},
{
"userPrincipalName": null,
"processId": 8936,
"sha1": "d487580502354c61808c7180d1a336beb7ad4624",
"parentProcessCreationTime": "2020-02-17T12:38:47.6521977Z",
"domainName": null,
"url": null,
"processCommandLine": "\"notepad.exe\"",
"entityType": "Process",
"processCreationTime": "2020-02-17T12:39:16.3783602Z",
"aadUserId": null,
"fileName": "notepad.exe",
"sha256": "f1d62648ef915d85cb4fc140359e925395d315c70f3566b63bb3e21151cb2ce3",
"parentProcessId": 11192,
"userSid": null,
"filePath": "C:\\Windows\\System32",
"accountName": null,
"ipAddress": null
}
]
}
]
}
]
}
}
Human Readable Output
User XSOAR related alerts Info
| ID | Title | Description | IncidentID | Severity | Status | Category | MachineID |
|---|---|---|---|---|---|---|---|
| da637175364336494657_410871946 | Suspicious process injection observed | A process abnormally injected code into another process, As a result, unexpected code may be running in the target process memory. Injection is often used to hide malicious code execution within a trusted process. As a result, the target process may exhibit abnormal behaviors such as opening a listening port or connecting to a command and control server. | 7 | Medium | InProgress | DefenseEvasion | 4899036531e374137f63289c3267bad772c13fef |
31. microsoft-atp-get-user-machines
Retrieves a collection of machines related to a given user ID.
Required Permissions
Machine.ReadWrite.All
Base Command
microsoft-atp-get-user-machines
Input
| Argument Name | Description | Required |
|---|---|---|
| username | The user ID. The ID is not the full UPN, but only the user name. For example, to retrieve machines for “user1@test.com” use “user1”. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.UserMachine.Username | String | The name of the user. |
| MicrosoftATP.UserMachine.Machines.ID | String | The ID of the machine. |
| MicrosoftATP.UserMachine.Machines.ComputerDNSName | String | The DNS name of the machine. |
| MicrosoftATP.UserMachine.Machines.FirstSeen | Date | The first date and time where the machine was observed by Microsoft Defender ATP. |
| MicrosoftATP.UserMachine.Machines.LastSeen | Date | The last date and time where the machine was observed by Microsoft Defender ATP. |
| MicrosoftATP.UserMachine.Machines.OSPlatform | String | The operating system platform. |
| MicrosoftATP.UserMachine.Machines.OSVersion | String | The operating system version. |
| MicrosoftATP.UserMachine.Machines.OSProcessor | String | The operating system processor. |
| MicrosoftATP.v.Machines.LastIPAddress | String | The last IP address on the machine. |
| MicrosoftATP.UserMachine.Machines.LastExternalIPAddress | String | The last IP address through which the machine accessed the internet. |
| MicrosoftATP.UserMachine.Machines.OSBuild | Number | The operating system build number. |
| MicrosoftATP.UserMachine.Machines.HealthStatus | String | The health status of the machine. |
| MicrosoftATP.UserMachine.Machines.RBACGroupID | Number | The RBAC group ID of the machine. |
| MicrosoftATP.UserMachine.Machines.RBACGroupName | String | The RBAC group name of the machine. |
| MicrosoftATP.UserMachine.Machines.RiskScore | String | The risk score of the machine. |
| MicrosoftATP.UserMachine.Machines.ExposureLevel | String | The exposure level of the machine. |
| MicrosoftATP.UserMachine.Machines.IsAADJoined | Boolean | Whether the machine is AAD joined. |
| MicrosoftATP.UserMachine.Machines.AADDeviceID | String | The AAD device ID. |
| MicrosoftATP.UserMachine.Machines.MachineTags | String | The set of machine tags. |
Command Example
!microsoft-atp-get-user-machines username=demisto
Context Example
{
"MicrosoftATP.UserMachine": {
"Username": "demisto",
"Machines": [
{
"OSBuild": 18363,
"ExposureLevel": "Medium",
"OSPlatform": "Windows10",
"MachineTags": [
"test Tag 2",
"test Tag 5"
],
"AADDeviceID": "cfcf4177-227e-4cdb-ac8e-f9a3da1ca30c",
"ComputerDNSName": "desktop-s2455r8",
"RBACGroupID": 0,
"OSProcessor": "x64",
"HealthStatus": "Active",
"AgentVersion": "10.6940.18362.693",
"LastExternalIPAddress": "81.166.99.236",
"LastIPAddress": "192.168.1.71",
"OSVersion": "1909",
"RiskScore": "High",
"ID": "4899036531e374137f63289c3267bad772c13fef",
"FirstSeen": "2020-02-17T08:30:07.2415577Z",
"LastSeen": "2020-03-23T08:10:41.473428Z"
},
{
"OSBuild": 18363,
"ExposureLevel": "Medium",
"OSPlatform": "Windows10",
"MachineTags": [
"test add tag",
"testing123"
],
"ComputerDNSName": "desktop-s2455r9",
"RBACGroupID": 0,
"OSProcessor": "x64",
"HealthStatus": "Active",
"AgentVersion": "10.6940.18362.693",
"LastExternalIPAddress": "81.166.99.236",
"LastIPAddress": "192.168.1.73",
"OSVersion": "1909",
"RiskScore": "Medium",
"ID": "f70f9fe6b29cd9511652434919c6530618f06606",
"FirstSeen": "2020-02-20T14:44:11.4627779Z",
"LastSeen": "2020-03-23T07:55:50.9986715Z"
}
]
}
}
Human Readable Output
Machines that are related to user XSOAR
| ID | ComputerDNSName | OSPlatform | LastIPAddress | LastExternalIPAddress | HealthStatus | RiskScore | ExposureLevel |
|---|---|---|---|---|---|---|---|
| 4899036531e374137f63289c3267bad772c13fef | desktop-s2455r8 | Windows10 | 192.168.1.71 | 81.166.99.236 | Active | High | Medium |
| f70f9fe6b29cd9511652434919c6530618f06606 | desktop-s2455r9 | Windows10 | 192.168.1.73 | 81.166.99.236 | Active | Medium | Medium |
32. microsoft-atp-add-remove-machine-tag
Adds or removes a tag on a specific machine.
Required Permissions
Machine.ReadWrite.All
Base Command
microsoft-atp-add-remove-machine-tag
Input
| Argument Name | Description | Required |
|---|---|---|
| machine_id | The ID of the machine. | Required |
| action | The action to use for the tag. | Required |
| tag | The name of the tag. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.Machine.ID | String | The ID of the machine. |
| MicrosoftATP.Machine.ComputerDNSName | String | The DNS name of the machine. |
| MicrosoftATP.Machine.FirstSeen | Date | The first date and time where the machine was observed by Microsoft Defender ATP. |
| MicrosoftATP.Machine.LastSeen | Date | The last date and time where the machine was observed by Microsoft Defender ATP. |
| MicrosoftATP.Machine.OSPlatform | String | The operating system platform. |
| MicrosoftATP.Machine.OSVersion | String | The operating system version. |
| MicrosoftATP.Machine.OSProcessor | String | The operating system processor. |
| MicrosoftATP.Machine.LastIPAddress | String | The last IP address on the machine. |
| MicrosoftATP.Machine.LastExternalIPAddress | String | The last IP address through which the machine accessed the internet. |
| MicrosoftATP.Machine.OSBuild | Number | The operating system build number. |
| MicrosoftATP.Machine.HealthStatus | String | The health status of the machine. |
| MicrosoftATP.Machine.RBACGroupID | Number | The RBAC group ID of the machine. |
| MicrosoftATP.Machine.RBACGroupName | String | The RBAC group name of the machine. |
| MicrosoftATP.Machine.RiskScore | String | The risk score of the machine. |
| MicrosoftATP.Machine.ExposureLevel | String | The exposure level of the machine. |
| MicrosoftATP.Machine.IsAADJoined | Boolean | Whether the machine is AAD joined. |
| MicrosoftATP.Machine.AADDeviceID | String | The AAD device ID. |
| MicrosoftATP.Machine.MachineTags | String | The set of machine tags. |
Command Example
!microsoft-atp-add-remove-machine-tag action=Add machine_id=f70f9fe6b29cd9511652434919c6530618f06606 tag="test add tag"
Context Example
{
"MicrosoftATP.Machine": {
"OSBuild": 18363,
"ExposureLevel": "Medium",
"OSPlatform": "Windows10",
"MachineTags": [
"test add tag",
"testing123"
],
"ComputerDNSName": "desktop-s2455r9",
"RBACGroupID": 0,
"OSProcessor": "x64",
"HealthStatus": "Active",
"AgentVersion": "10.6940.18362.693",
"LastExternalIPAddress": "81.166.99.236",
"LastIPAddress": "192.168.1.73",
"OSVersion": "1909",
"RiskScore": "Medium",
"ID": "f70f9fe6b29cd9511652434919c6530618f06606",
"FirstSeen": "2020-02-20T14:44:11.4627779Z",
"LastSeen": "2020-03-23T07:55:50.9986715Z"
}
}
Human Readable Output
Succeed to Add tag to f70f9fe6b29cd9511652434919c6530618f06606
| ID | ComputerDNSName | OSPlatform | LastExternalIPAddress | HealthStatus | RiskScore | ExposureLevel | MachineTags |
|---|---|---|---|---|---|---|---|
| f70f9fe6b29cd9511652434919c6530618f06606 | desktop-s2455r9 | Windows10 | 81.166.99.236 | Active | Medium | Medium | test add tag, testing123 |
microsoft-atp-indicator-list
Deprecated. Use the microsoft-atp-sc-indicator-list command instead. Lists all indicators by the ID that the system creates when the indicator is ingested.
Base Command
microsoft-atp-indicator-list
Input
| Argument Name | Description | Required |
|---|---|---|
| limit | The maximum number of indicators to return. Default is 50. | Optional |
| page_size | Specify the page size of the result set. Maximum is 200. Default value is 50. | Optional |
Context Output
| Path | Type | Description | |
|---|---|---|---|
| MicrosoftATP.Indicators.id | String | Created by the system when the indicator is ingested. Generated GUID/unique identifier. | |
| MicrosoftATP.Indicators.action | String | The action to apply if the indicator is matched from within the targetProduct security tool. Possible values are: unknown, allow, block, alert. | |
| MicrosoftATP.Indicators.additionalInformation | String | A catchall area into which extra data from the indicator not covered by the other indicator properties may be placed. Data placed into additionalInformation is typically not be used by the targetProduct security tool. | |
| MicrosoftATP.Indicators.azureTenantId | String | Stamped by the system when the indicator is ingested. The Entra ID tenant ID of submitting client. | |
| MicrosoftATP.Indicators.confidence | Number | An integer representing the confidence with which the data within the indicator accurately identifies malicious behavior. Possible values are 0 – 100, with 100 being the highest. | |
| MicrosoftATP.Indicators.description | String | Brief description (100 characters or less) of the threat represented by the indicator. | |
| MicrosoftATP.Indicators.diamondModel | String | The area of the Diamond Model in which this indicator exists. Possible values are: “unknown”, “adversary”, “capability”, “infrastructure”, “victim”. | |
| MicrosoftATP.Indicators.domainName | String | Domain name associated with this indicator. Should be in the format subdomain.domain.topleveldomain. | |
| MicrosoftATP.Indicators.emailEncoding | String | The type of text encoding used in the email. | |
| MicrosoftATP.Indicators.emailLanguage | String | The language of the email. | |
| MicrosoftATP.Indicators.emailRecipient | String | Recipient email address. | |
| MicrosoftATP.Indicators.emailSenderAddress | String | Email address of the attacker | victim. |
| MicrosoftATP.Indicators.emailSenderName | String | Display name of the attacker | victim.. |
| MicrosoftATP.Indicators.emailSourceDomain | String | Domain used in the email. | |
| MicrosoftATP.Indicators.emailSourceIpAddress | String | Source IP address of the email. | |
| MicrosoftATP.Indicators.emailSubject | String | Subject line of the email. | |
| MicrosoftATP.Indicators.emailXMailer | String | X-Mailer value used in the email. | |
| MicrosoftATP.Indicators.expirationDateTime | Date | DateTime string indicating when the indicator expires. To avoid stale indicators persisting in the system, all indicators must have an expiration date. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.externalId | String | An identification number that ties the indicator back to the indicator provider’s system (e.g. a foreign key). | |
| MicrosoftATP.Indicators.fileCompileDateTime | Date | DateTime when the file was compiled. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.fileCreatedDateTime | Date | DateTime when the file was created.The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.fileHashType | String | The type of hash stored in fileHashValue. Possible values are: “unknown”, “sha1”, “sha256”, “md5”, “authenticodeHash256”, “lsHash”, and “ctph”. | |
| MicrosoftATP.Indicators.fileHashValue | String | The file hash value. | |
| MicrosoftATP.Indicators.fileMutexName | String | Mutex name used in file-based detections. | |
| MicrosoftATP.Indicators.fileName | String | Name of the file if the indicator is file-based. Supports comma-separate list of file names. | |
| MicrosoftATP.Indicators.filePacker | String | The packer used to build the file in question. | |
| MicrosoftATP.Indicators.filePath | String | Path of the file indicating a compromise. May be a Windows or *nix style. | |
| MicrosoftATP.Indicators.fileSize | Number | Size of the file in bytes. | |
| MicrosoftATP.Indicators.fileType | String | Text description of the type of file. For example, “Word Document” or “Binary”. | |
| MicrosoftATP.Indicators.ingestedDateTime | Date | Stamped by the system when the indicator is ingested. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.isActive | Boolean | Used to deactivate indicators within system. By default, any indicator submitted is set as active. However, providers may submit existing indicators with this set to ‘False’ to deactivate indicators in the system. | |
| MicrosoftATP.Indicators.knownFalsePositives | String | Scenarios in which the indicator may cause false positives. This should be human-readable text. | |
| MicrosoftATP.Indicators.lastReportedDateTime | Date | The last time the indicator was seen. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.networkCidrBlock | String | CIDR Block notation representation of the network referenced in this indicator. Use only if the Source and Destination cannot be identified. | |
| MicrosoftATP.Indicators.networkDestinationAsn | Number | The destination autonomous system identifier of the network referenced in the indicator. | |
| MicrosoftATP.Indicators.networkDestinationCidrBlock | String | CIDR Block notation representation of the destination network in this indicator. | |
| MicrosoftATP.Indicators.networkDestinationIPv4 | String | IPv4 IP address destination. | |
| MicrosoftATP.Indicators.networkDestinationIPv6 | String | IPv6 IP address destination. | |
| MicrosoftATP.Indicators.networkDestinationPort | Number | TCP port destination. | |
| MicrosoftATP.Indicators.networkIPv4 | String | IPv4 IP address. | |
| MicrosoftATP.Indicators.networkIPv6 | String | IPv6 IP address. | |
| MicrosoftATP.Indicators.networkPort | Number | TCP port. | |
| MicrosoftATP.Indicators.networkProtocol | Number | Decimal representation of the protocol field in the IPv4 header. | |
| MicrosoftATP.Indicators.networkSourceAsn | Number | The source autonomous system identifier of the network referenced in the indicator. | |
| MicrosoftATP.Indicators.networkSourceCidrBlock | String | CIDR Block notation representation of the source network in this indicator. | |
| MicrosoftATP.Indicators.networkSourceIPv4 | String | IPv4 IP address source. | |
| MicrosoftATP.Indicators.networkSourceIPv6 | String | IPv6 IP address source. | |
| MicrosoftATP.Indicators.networkSourcePort | Number | TCP port source. | |
| MicrosoftATP.Indicators.passiveOnly | Boolean | Determines if the indicator should trigger an event that is visible to an end user. When set to ‘true,’ security tools will not notify the end user that a ‘hit’ has occurred. This is most often treated as audit or silent mode by security products where they will simply log that a match occurred but will not perform the action. Default value is false. | |
| MicrosoftATP.Indicators.severity | Number | Severity of the malicious behavior identified by the data within the indicator. Possible values are 0 – 5, where 5 is the most severe and zero is not severe at all. Default is 3 | |
| MicrosoftATP.Indicators.targetProduct | String | A string value representing a single security product to which the indicator should be applied. | |
| MicrosoftATP.Indicators.threatType | String | Each indicator must have a valid Indicator Threat Type. Possible values are: Botnet, C2, CryptoMining, Darknet, DDoS, MaliciousUrl, Malware, Phishing, Proxy, PUA, WatchList. | |
| MicrosoftATP.Indicators.tlpLevel | String | Traffic Light Protocol value for the indicator. Possible values are: unknown, white, green, amber, and red. | |
| MicrosoftATP.Indicators.url | String | Uniform Resource Locator. This URL complies with RFC 1738. | |
| MicrosoftATP.Indicators.userAgent | String | User-Agent string from a web request that could indicate compromise. | |
| MicrosoftATP.Indicators.vendorInformation | String | Information about the vendor. |
Command Example
#### Context Example
```json
{
"MicrosoftATP": {
"Indicators": {
"action": "block",
"activityGroupNames": [],
"azureTenantId": "TENANT-ID",
"description": "Title: Indicator Jacoviya.net of type DomainName, Description: Blob!",
"domainName": "jacoviya.net",
"expirationDateTime": "2020-09-02T17:08:46Z",
"id": "16",
"ingestedDateTime": "2020-08-26T17:08:49.158136Z",
"isActive": true,
"killChain": [],
"malwareFamilyNames": [],
"severity": 2,
"tags": [],
"targetProduct": "Microsoft Defender ATP"
}
}
}
Human Readable Output
Indicators from Microsoft ATP
id action severity domainName 16 block 2 jacoviya.net
microsoft-atp-indicator-get-by-id
Deprecated. Use the microsoft-atp-sc-indicator-get-by-id command instead. Gets an indicator by its ID.
Base Command
microsoft-atp-indicator-get-by-id
Input
| Argument Name | Description | Required |
|---|---|---|
| indicator_id | The ID of the indicator to get. | Required |
Context Output
| Path | Type | Description | |
|---|---|---|---|
| MicrosoftATP.Indicators.id | String | Created by the system when the indicator is ingested. Generated GUID/unique identifier. | |
| MicrosoftATP.Indicators.action | String | The action to apply if the indicator is matched from within the targetProduct security tool. Possible values are: unknown, allow, block, alert. | |
| MicrosoftATP.Indicators.additionalInformation | String | A catchall area into which extra data from the indicator not covered by the other indicator properties may be placed. Data placed into additionalInformation will typically not be used by the targetProduct security tool. | |
| MicrosoftATP.Indicators.azureTenantId | String | Timestamp when the indicator was ingested into the system. | |
| MicrosoftATP.Indicators.confidence | Number | An integer representing the confidence with which the data within the indicator accurately identifies malicious behavior. Possible values are 0 – 100, with 100 being the highest. | |
| MicrosoftATP.Indicators.description | String | Brief description (100 characters or less) of the threat represented by the indicator. | |
| MicrosoftATP.Indicators.diamondModel | String | The area of the Diamond Model in which this indicator exists. Possible values are: unknown, adversary, capability, infrastructure, victim. | |
| MicrosoftATP.Indicators.domainName | String | Domain name associated with this indicator. Should be in the format subdomain.domain.topleveldomain. | |
| MicrosoftATP.Indicators.emailEncoding | String | The type of text encoding used in the email. | |
| MicrosoftATP.Indicators.emailLanguage | String | The language of the email. | |
| MicrosoftATP.Indicators.emailRecipient | String | Recipient email address. | |
| MicrosoftATP.Indicators.emailSenderAddress | String | Email address of the attacker | victim. |
| MicrosoftATP.Indicators.emailSenderName | String | Display name of the attacker | victim.. |
| MicrosoftATP.Indicators.emailSourceDomain | String | Domain used in the email. | |
| MicrosoftATP.Indicators.emailSourceIpAddress | String | Source IP address of the email. | |
| MicrosoftATP.Indicators.emailSubject | String | Subject line of the email. | |
| MicrosoftATP.Indicators.emailXMailer | String | X-Mailer value used in the email. | |
| MicrosoftATP.Indicators.expirationDateTime | Date | DateTime string indicating when the indicator expires. To avoid stale indicators persisting in the system, all indicators must have an expiration date. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.externalId | String | An identification number that ties the indicator back to the indicator provider’s system (e.g. a foreign key). | |
| MicrosoftATP.Indicators.fileCompileDateTime | Date | DateTime when the file was compiled. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.fileCreatedDateTime | Date | DateTime when the file was created.The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.fileHashType | String | The type of hash stored in fileHashValue. Possible values are: unknown, sha1, sha256, md5, authenticodeHash256, lsHash, ctph. | |
| MicrosoftATP.Indicators.fileHashValue | String | The file hash value. | |
| MicrosoftATP.Indicators.fileMutexName | String | Mutex name used in file-based detections. | |
| MicrosoftATP.Indicators.fileName | String | Name of the file if the indicator is file-based. Supports comma-separate list of file names. | |
| MicrosoftATP.Indicators.filePacker | String | The packer used to build the file in question. | |
| MicrosoftATP.Indicators.filePath | String | Path of the file indicating a compromise. May be a Windows or *nix style. | |
| MicrosoftATP.Indicators.fileSize | Number | Size of the file in bytes. | |
| MicrosoftATP.Indicators.fileType | String | Text description of the type of file. For example, “Word Document” or “Binary”. | |
| MicrosoftATP.Indicators.ingestedDateTime | Date | Stamped by the system when the indicator is ingested. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.isActive | Boolean | Used to deactivate indicators within system. By default, any indicator submitted is set as active. However, providers may submit existing indicators with this set to ‘False’ to deactivate indicators in the system. | |
| MicrosoftATP.Indicators.knownFalsePositives | String | Scenarios in which the indicator may cause false positives. This should be human-readable text. | |
| MicrosoftATP.Indicators.lastReportedDateTime | Date | The last time the indicator was seen. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.networkCidrBlock | String | CIDR Block notation representation of the network referenced in this indicator. Use only if the Source and Destination cannot be identified. | |
| MicrosoftATP.Indicators.networkDestinationAsn | Number | The destination autonomous system identifier of the network referenced in the indicator. | |
| MicrosoftATP.Indicators.networkDestinationCidrBlock | String | CIDR Block notation representation of the destination network in this indicator. | |
| MicrosoftATP.Indicators.networkDestinationIPv4 | String | IPv4 IP address destination. | |
| MicrosoftATP.Indicators.networkDestinationIPv6 | String | IPv6 IP address destination. | |
| MicrosoftATP.Indicators.networkDestinationPort | Number | TCP port destination. | |
| MicrosoftATP.Indicators.networkIPv4 | String | IPv4 IP address. | |
| MicrosoftATP.Indicators.networkIPv6 | String | IPv6 IP address. | |
| MicrosoftATP.Indicators.networkPort | Number | TCP port. | |
| MicrosoftATP.Indicators.networkProtocol | Number | Decimal representation of the protocol field in the IPv4 header. | |
| MicrosoftATP.Indicators.networkSourceAsn | Number | The source autonomous system identifier of the network referenced in the indicator. | |
| MicrosoftATP.Indicators.networkSourceCidrBlock | String | CIDR Block notation representation of the source network in this indicator. | |
| MicrosoftATP.Indicators.networkSourceIPv4 | String | IPv4 IP address source. | |
| MicrosoftATP.Indicators.networkSourceIPv6 | String | IPv6 IP address source. | |
| MicrosoftATP.Indicators.networkSourcePort | Number | TCP port source. | |
| MicrosoftATP.Indicators.passiveOnly | Boolean | Determines if the indicator should trigger an event that is visible to an end user. When set to ‘true,’ security tools will not notify the end user that a ‘hit’ has occurred. This is most often treated as audit or silent mode by security products where they will simply log that a match occurred but will not perform the action. Default value is false. | |
| MicrosoftATP.Indicators.severity | Number | Severity of the malicious behavior identified by the data within the indicator. Possible values are 0 – 5, where 5 is the most severe and zero is not severe at all. Default is 3 | |
| MicrosoftATP.Indicators.targetProduct | String | A string value representing a single security product to which the indicator should be applied. | |
| MicrosoftATP.Indicators.threatType | String | Each indicator must have a valid Indicator Threat Type. Possible values are: Botnet, C2, CryptoMining, Darknet, DDoS, MaliciousUrl, Malware, Phishing, Proxy, PUA, WatchList. | |
| MicrosoftATP.Indicators.tlpLevel | String | Traffic Light Protocol value for the indicator. Possible values are: unknown, white, green, or amber. | |
| MicrosoftATP.Indicators.url | String | Uniform Resource Locator. This URL complies with RFC 1738. | |
| MicrosoftATP.Indicators.userAgent | String | User-Agent string from a web request that could indicate compromise. | |
| MicrosoftATP.Indicators.vendorInformation | String | Information about the vendor. |
Command Example
!microsoft-atp-indicator-get-by-id indicator_id=17
Context Example
{
"MicrosoftATP": {
"Indicators": {
"action": "block",
"activityGroupNames": [],
"azureTenantId": "TENANT-ID",
"description": "Title: Indicator example.com of type DomainName, Description: A description!",
"domainName": "example.com",
"expirationDateTime": "2020-09-02T17:17:57Z",
"id": "17",
"ingestedDateTime": "2020-08-26T17:18:00.0537984Z",
"isActive": true,
"killChain": [],
"malwareFamilyNames": [],
"severity": 2,
"tags": [],
"targetProduct": "Microsoft Defender ATP"
}
}
}
Human Readable Output
Indicators from Microsoft ATP
id action severity domainName 17 block 2 example.com
microsoft-atp-indicator-create-network
Deprecated. Use the microsoft-atp-sc-indicator-create command instead. Creates a network indicator.
Base Command
microsoft-atp-indicator-create-network
Input
| Argument Name | Description | Required |
|---|---|---|
| action | The action to apply if the indicator is matched from within the targetProduct security tool. | Required |
| description | Brief description (100 characters or less) of the threat represented by the indicator. | Required |
| expiration_time | DateTime string indicating when the indicator expires. Format: (<number> <time unit>, e.g., 12 hours, 7 days). | Required |
| threat_type | Each indicator must have a valid Indicator Threat Type. Possible values are: Botnet, C2, Cryptomining, Darknet, DDoS, MaliciousUrl, Malware, Phishing, Proxy, PUA, or WatchList. | Required |
| tlp_level | Traffic Light Protocol value for the indicator. Possible values are: unknown, white, green, or amber. | Optional |
| confidence | An integer representing the confidence with which the data within the indicator accurately identifies malicious behavior. Possible values are 0 – 100 with 100 being the highest. | Optional |
| severity | The severity of the malicious behavior identified by the data within the indicator. Possible values are Informational, Low, MediumLow, MediumHigh, High, where 5 is the most severe and zero is not severe at all. | Optional |
| tags | A comma-separated list that stores arbitrary tags/keywords. | Optional |
| domain_name | Domain name associated with this indicator. Should be in the format subdomain.domain.topleveldomain (For example, example.domain.net) | Optional |
| network_cidr_block | CIDR Block notation representation of the network referenced in this indicator. Use only if the Source and Destination cannot be identified. | Optional |
| network_destination_asn | The destination autonomous system identifier of the network referenced in the indicator. | Optional |
| network_destination_cidr_block | CIDR Block notation representation of the destination network in this indicator. | Optional |
| network_destination_ipv4 | IPv4 IP address destination. | Optional |
| network_destination_ipv6 | IPv6 IP address destination. |
Optional |
| network_destination_port | TCP port destination. | Optional |
| network_ipv4 | IPv4 IP address. Use only if the Source and Destination cannot be identified. | Optional |
| network_ipv6 | IPv6 IP address. Use only if the Source and Destination cannot be identified. | Optional |
| network_port | TCP port. Use only if the Source and Destination cannot be identified. | Optional |
| network_protocol | Decimal representation of the protocol field in the IPv4 header. | Optional |
| network_source_asn | The source autonomous system identifier of the network referenced in the indicator. | Optional |
| network_source_cidr_block | CIDR Block notation representation of the source network in this indicator. | Optional |
| network_source_ipv4 | IPv4 IP address source. | Optional |
| network_source_ipv6 | IPv6 IP address source. | Optional |
| network_source_port | TCP port source. | Optional |
| url | Uniform Resource Locator. This URL must comply with RFC 1738. | Optional |
| user_agent | User-Agent string from a web request that could indicate compromise. | Optional |
Context Output
| Path | Type | Description | |
|---|---|---|---|
| MicrosoftATP.Indicators.id | String | Created by the system when the indicator is ingested. Generated GUID/unique identifier. | |
| MicrosoftATP.Indicators.action | String | The action to apply if the indicator is matched from within the targetProduct security tool. Possible values are: unknown, allow, block, alert. | |
| MicrosoftATP.Indicators.additionalInformation | String | A catchall area into which extra data from the indicator not covered by the other indicator properties may be placed. Data placed into additionalInformation will typically not be used by the targetProduct security tool. | |
| MicrosoftATP.Indicators.azureTenantId | String | Timestamp when the indicator was ingested into the system. | |
| MicrosoftATP.Indicators.confidence | Number | An integer representing the confidence with which the data within the indicator accurately identifies malicious behavior. Possible values are 0 – 100, with 100 being the highest. | |
| MicrosoftATP.Indicators.description | String | Brief description (100 characters or less) of the threat represented by the indicator. | |
| MicrosoftATP.Indicators.diamondModel | String | The area of the Diamond Model in which this indicator exists. Possible values are: unknown, adversary, capability, infrastructure, victim. | |
| MicrosoftATP.Indicators.domainName | String | Domain name associated with this indicator. Should be in the format subdomain.domain.topleveldomain. | |
| MicrosoftATP.Indicators.emailEncoding | String | The type of text encoding used in the email. | |
| MicrosoftATP.Indicators.emailLanguage | String | The language of the email. | |
| MicrosoftATP.Indicators.emailRecipient | String | Recipient email address. | |
| MicrosoftATP.Indicators.emailSenderAddress | String | Email address of the attacker | victim. |
| MicrosoftATP.Indicators.emailSenderName | String | Display name of the attacker | victim.. |
| MicrosoftATP.Indicators.emailSourceDomain | String | Domain used in the email. | |
| MicrosoftATP.Indicators.emailSourceIpAddress | String | Source IP address of the email. | |
| MicrosoftATP.Indicators.emailSubject | String | Subject line of the email. | |
| MicrosoftATP.Indicators.emailXMailer | String | X-Mailer value used in the email. | |
| MicrosoftATP.Indicators.expirationDateTime | Date | DateTime string indicating when the indicator expires. To avoid stale indicators persisting in the system, all indicators must have an expiration date. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.externalId | String | An identification number that ties the indicator back to the indicator provider’s system (e.g. a foreign key). | |
| MicrosoftATP.Indicators.fileCompileDateTime | Date | DateTime when the file was compiled. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.fileCreatedDateTime | Date | DateTime when the file was created.The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.fileHashType | String | The type of hash stored in fileHashValue. Possible values are: unknown, sha1, sha256, md5, authenticodeHash256, lsHash, or ctph. Possible values are: unknown, sha1, sha256, md5, authenticodeHash256, lsHash, ctph. | |
| MicrosoftATP.Indicators.fileHashValue | String | The file hash value. | |
| MicrosoftATP.Indicators.fileMutexName | String | Mutex name used in file-based detections. | |
| MicrosoftATP.Indicators.fileName | String | Name of the file if the indicator is file-based. Supports comma-separate list of file names. | |
| MicrosoftATP.Indicators.filePacker | String | The packer used to build the file in question. | |
| MicrosoftATP.Indicators.filePath | String | Path of the file indicating a compromise. May be a Windows or *nix style. | |
| MicrosoftATP.Indicators.fileSize | Number | Size of the file in bytes. | |
| MicrosoftATP.Indicators.fileType | String | Text description of the type of file. For example, “Word Document” or “Binary”. | |
| MicrosoftATP.Indicators.ingestedDateTime | Date | Stamped by the system when the indicator is ingested. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.isActive | Boolean | Used to deactivate indicators within system. By default, any indicator submitted is set as active. However, providers may submit existing indicators with this set to ‘False’ to deactivate indicators in the system. | |
| MicrosoftATP.Indicators.knownFalsePositives | String | Scenarios in which the indicator may cause false positives. This should be human-readable text. | |
| MicrosoftATP.Indicators.lastReportedDateTime | Date | The last time the indicator was seen. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.networkCidrBlock | String | CIDR Block notation representation of the network referenced in this indicator. Use only if the Source and Destination cannot be identified. | |
| MicrosoftATP.Indicators.networkDestinationAsn | Number | The destination autonomous system identifier of the network referenced in the indicator. | |
| MicrosoftATP.Indicators.networkDestinationCidrBlock | String | CIDR Block notation representation of the destination network in this indicator. | |
| MicrosoftATP.Indicators.networkDestinationIPv4 | String | IPv4 IP address destination. | |
| MicrosoftATP.Indicators.networkDestinationIPv6 | String | IPv6 IP address destination. | |
| MicrosoftATP.Indicators.networkDestinationPort | Number | TCP port destination. | |
| MicrosoftATP.Indicators.networkIPv4 | String | IPv4 IP address. | |
| MicrosoftATP.Indicators.networkIPv6 | String | IPv6 IP address. | |
| MicrosoftATP.Indicators.networkPort | Number | TCP port. | |
| MicrosoftATP.Indicators.networkProtocol | Number | Decimal representation of the protocol field in the IPv4 header. | |
| MicrosoftATP.Indicators.networkSourceAsn | Number | The source autonomous system identifier of the network referenced in the indicator. | |
| MicrosoftATP.Indicators.networkSourceCidrBlock | String | CIDR Block notation representation of the source network in this indicator. | |
| MicrosoftATP.Indicators.networkSourceIPv4 | String | IPv4 IP address source. | |
| MicrosoftATP.Indicators.networkSourceIPv6 | String | IPv6 IP address source. | |
| MicrosoftATP.Indicators.networkSourcePort | Number | TCP port source. | |
| MicrosoftATP.Indicators.passiveOnly | Boolean | Determines if the indicator should trigger an event that is visible to an end user. When set to ‘true,’ security tools will not notify the end user that a ‘hit’ has occurred. This is most often treated as audit or silent mode by security products where they will simply log that a match occurred but will not perform the action. Default value is false. | |
| MicrosoftATP.Indicators.severity | Number | Severity of the malicious behavior identified by the data within the indicator. Possible values are 0 – 5, where 5 is the most severe and zero is not severe at all. Default is 3 | |
| MicrosoftATP.Indicators.targetProduct | String | A string value representing a single security product to which the indicator should be applied. | |
| MicrosoftATP.Indicators.threatType | String | Each indicator must have a valid Indicator Threat Type. Possible values are: Botnet, C2, CryptoMining, Darknet, DDoS, MaliciousUrl, Malware, Phishing, Proxy, PUA, WatchList. | |
| MicrosoftATP.Indicators.tlpLevel | String | Traffic Light Protocol value for the indicator. Possible values are: unknown, white, green, or amber. | |
| MicrosoftATP.Indicators.url | String | Uniform Resource Locator. This URL complies with RFC 1738. | |
| MicrosoftATP.Indicators.userAgent | String | User-Agent string from a web request that could indicate compromise. | |
| MicrosoftATP.Indicators.vendorInformation | String | Information about the vendor. |
Command Example
!microsoft-atp-indicator-create-network action=unknown description="A description!" expiration_time="7 days" threat_type=CryptoMining domain_name="example.com"
Context Example
{
"MicrosoftATP": {
"Indicators": {
"action": "block",
"activityGroupNames": [],
"azureTenantId": "TENANT-ID",
"description": "Title: Indicator example.com of type DomainName, Description: A description!",
"domainName": "example.com",
"expirationDateTime": "2020-09-02T17:17:57Z",
"id": "17",
"ingestedDateTime": "2020-08-26T17:18:00.0537984Z",
"isActive": true,
"killChain": [],
"malwareFamilyNames": [],
"severity": 2,
"tags": [],
"targetProduct": "Microsoft Defender ATP"
}
}
}
Human Readable Output
Indicator 17 was successfully created
id action severity domainName 17 block 2 example.com
microsoft-atp-indicator-create-file
Deprecated. Use the microsoft-atp-sc-indicator-create command instead. Creates a file indicator
Base Command
microsoft-atp-indicator-create-file
Input
| Argument Name | Description | Required |
|---|---|---|
| action | The action to apply if the indicator is matched from within the targetProduct security tool. | Required |
| description | Brief description (100 characters or less) of the threat represented by the indicator. | Required |
| expiration_time | DateTime string indicating when the indicator expires. Format: (<number> <time unit>, e.g., 12 hours, 7 days). | Required |
| threat_type | Each indicator must have a valid Indicator Threat Type. Possible values are: Botnet, C2, Cryptomining, Darknet, DDoS, MaliciousUrl, Malware, Phishing, Proxy, PUA, or WatchList. | Required |
| tlp_level | Traffic Light Protocol value for the indicator. Possible values are: unknown, white, green, or amber. | Optional |
| confidence | An integer representing the confidence with which the data within the indicator accurately identifies malicious behavior. Possible values are 0 – 100 with 100 being the highest. | Optional |
| severity | The severity of the malicious behavior identified by the data within the indicator. Possible values are Informational, Low, MediumLow, MediumHigh, High, where 5 is the most severe and zero is not severe at all. | Optional |
| tags | A comma-separated list that stores arbitrary tags/keywords. | Optional |
| file_compile_date_time | DateTime when the file was compiled. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | Optional |
| file_created_date_time | DateTime when the file was created.The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | Optional |
| file_hash_type | The type of hash stored in fileHashValue. Possible values are: unknown, sha1, sha256, md5, authenticodeHash256, lsHash, or ctph. | Optional |
| file_hash_value | The file hash value. | Optional |
| file_mutex_name | Mutex name used in file-based detections. | Optional |
| file_name | Name of the file if the indicator is file-based. Supports comma-separate list of file names. | Optional |
| file_packer | The packer used to build the file in question. | Optional |
| file_path | Path of the file indicating a compromise. Can be a Windows or *nix style path. | Optional |
| file_size | Size of the file in bytes. | Optional |
| file_type | Text description of the type of file. For example, “Word Document” or “Binary”. | Optional |
Context Output
| Path | Type | Description | |
|---|---|---|---|
| MicrosoftATP.Indicators.id | String | Created by the system when the indicator is ingested. Generated GUID/unique identifier. | |
| MicrosoftATP.Indicators.action | String | The action to apply if the indicator is matched from within the targetProduct security tool. Possible values are: unknown, allow, block, alert. | |
| MicrosoftATP.Indicators.additionalInformation | String | A catchall area into which extra data from the indicator not covered by the other indicator properties may be placed. Data placed into additionalInformation will typically not be used by the targetProduct security tool. | |
| MicrosoftATP.Indicators.azureTenantId | String | Timestamp when the indicator was ingested into the system. | |
| MicrosoftATP.Indicators.confidence | Number | An integer representing the confidence with which the data within the indicator accurately identifies malicious behavior. Possible values are 0 – 100, with 100 being the highest. | |
| MicrosoftATP.Indicators.description | String | Brief description (100 characters or less) of the threat represented by the indicator. | |
| MicrosoftATP.Indicators.diamondModel | String | The area of the Diamond Model in which this indicator exists. Possible values are: unknown, adversary, capability, infrastructure, victim. | |
| MicrosoftATP.Indicators.domainName | String | Domain name associated with this indicator. Should be in the format subdomain.domain.topleveldomain. | |
| MicrosoftATP.Indicators.emailEncoding | String | The type of text encoding used in the email. | |
| MicrosoftATP.Indicators.emailLanguage | String | The language of the email. | |
| MicrosoftATP.Indicators.emailRecipient | String | Recipient email address. | |
| MicrosoftATP.Indicators.emailSenderAddress | String | Email address of the attacker | victim. |
| MicrosoftATP.Indicators.emailSenderName | String | Display name of the attacker | victim.. |
| MicrosoftATP.Indicators.emailSourceDomain | String | Domain used in the email. | |
| MicrosoftATP.Indicators.emailSourceIpAddress | String | Source IP address of the email. | |
| MicrosoftATP.Indicators.emailSubject | String | Subject line of the email. | |
| MicrosoftATP.Indicators.emailXMailer | String | X-Mailer value used in the email. | |
| MicrosoftATP.Indicators.expirationDateTime | Date | DateTime string indicating when the indicator expires. To avoid stale indicators persisting in the system, all indicators must have an expiration date. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.externalId | String | An identification number that ties the indicator back to the indicator provider’s system (e.g. a foreign key). | |
| MicrosoftATP.Indicators.fileCompileDateTime | Date | DateTime when the file was compiled. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.fileCreatedDateTime | Date | DateTime when the file was created.The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.fileHashType | String | The type of hash stored in fileHashValue. Possible values are: unknown, sha1, sha256, md5, authenticodeHash256, lsHash, or ctph. Possible values are: unknown, sha1, sha256, md5, authenticodeHash256, lsHash, ctph. | |
| MicrosoftATP.Indicators.fileHashValue | String | The file hash value. | |
| MicrosoftATP.Indicators.fileMutexName | String | Mutex name used in file-based detections. | |
| MicrosoftATP.Indicators.fileName | String | Name of the file if the indicator is file-based. Supports comma-separate list of file names. | |
| MicrosoftATP.Indicators.filePacker | String | The packer used to build the file in question. | |
| MicrosoftATP.Indicators.filePath | String | Path of the file indicating a compromise. May be a Windows or *nix style. | |
| MicrosoftATP.Indicators.fileSize | Number | Size of the file in bytes. | |
| MicrosoftATP.Indicators.fileType | String | Text description of the type of file. For example, “Word Document” or “Binary”. | |
| MicrosoftATP.Indicators.ingestedDateTime | Date | Stamped by the system when the indicator is ingested. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.isActive | Boolean | Used to deactivate indicators within system. By default, any indicator submitted is set as active. However, providers may submit existing indicators with this set to ‘False’ to deactivate indicators in the system. | |
| MicrosoftATP.Indicators.knownFalsePositives | String | Scenarios in which the indicator may cause false positives. This should be human-readable text. | |
| MicrosoftATP.Indicators.lastReportedDateTime | Date | The last time the indicator was seen. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.networkCidrBlock | String | CIDR Block notation representation of the network referenced in this indicator. Use only if the Source and Destination cannot be identified. | |
| MicrosoftATP.Indicators.networkDestinationAsn | Number | The destination autonomous system identifier of the network referenced in the indicator. | |
| MicrosoftATP.Indicators.networkDestinationCidrBlock | String | CIDR Block notation representation of the destination network in this indicator. | |
| MicrosoftATP.Indicators.networkDestinationIPv4 | String | IPv4 IP address destination. | |
| MicrosoftATP.Indicators.networkDestinationIPv6 | String | IPv6 IP address destination. | |
| MicrosoftATP.Indicators.networkDestinationPort | Number | TCP port destination. | |
| MicrosoftATP.Indicators.networkIPv4 | String | IPv4 IP address. | |
| MicrosoftATP.Indicators.networkIPv6 | String | IPv6 IP address. | |
| MicrosoftATP.Indicators.networkPort | Number | TCP port. | |
| MicrosoftATP.Indicators.networkProtocol | Number | Decimal representation of the protocol field in the IPv4 header. | |
| MicrosoftATP.Indicators.networkSourceAsn | Number | The source autonomous system identifier of the network referenced in the indicator. | |
| MicrosoftATP.Indicators.networkSourceCidrBlock | String | CIDR Block notation representation of the source network in this indicator. | |
| MicrosoftATP.Indicators.networkSourceIPv4 | String | IPv4 IP address source. | |
| MicrosoftATP.Indicators.networkSourceIPv6 | String | IPv6 IP address source. | |
| MicrosoftATP.Indicators.networkSourcePort | Number | TCP port source. | |
| MicrosoftATP.Indicators.passiveOnly | Boolean | Determines if the indicator should trigger an event that is visible to an end user. When set to ‘true,’ security tools will not notify the end user that a ‘hit’ has occurred. This is most often treated as audit or silent mode by security products where they will simply log that a match occurred but will not perform the action. Default value is false. | |
| MicrosoftATP.Indicators.severity | Number | Severity of the malicious behavior identified by the data within the indicator. Possible values are 0 – 5, where 5 is the most severe and zero is not severe at all. Default is 3 | |
| MicrosoftATP.Indicators.targetProduct | String | A string value representing a single security product to which the indicator should be applied. | |
| MicrosoftATP.Indicators.threatType | String | Each indicator must have a valid Indicator Threat Type. Possible values are: Botnet, C2, CryptoMining, Darknet, DDoS, MaliciousUrl, Malware, Phishing, Proxy, PUA, WatchList. | |
| MicrosoftATP.Indicators.tlpLevel | String | Traffic Light Protocol value for the indicator. Possible values are: unknown, white, green, or amber. | |
| MicrosoftATP.Indicators.url | String | Uniform Resource Locator. This URL complies with RFC 1738. | |
| MicrosoftATP.Indicators.userAgent | String | User-Agent string from a web request that could indicate compromise. | |
| MicrosoftATP.Indicators.vendorInformation | String | Information about the vendor. |
Command Example
!microsoft-atp-indicator-create-file action=allow description="A description" expiration_time="3 days" threat_type=Darknet confidence=23 file_hash_type=sha256 file_hash_value=50d858e0985ecc7f60418aaf0cc5ab587f42c2570a884095a9e8ccacd0f6545c
Context Example
{
"MicrosoftATP": {
"Indicators": {
"action": "allow",
"activityGroupNames": [],
"azureTenantId": "TENANT-ID",
"description": "Title: Indicator 50d858e0985ecc7f60418aaf0cc5ab587f42c2570a884095a9e8ccacd0f6545c of type FileSha256, Description: A description",
"expirationDateTime": "2020-08-29T17:18:01Z",
"fileHashType": "sha256",
"fileHashValue": "50d858e0985ecc7f60418aaf0cc5ab587f42c2570a884095a9e8ccacd0f6545c",
"id": "18",
"ingestedDateTime": "2020-08-26T17:18:03.5249643Z",
"isActive": true,
"killChain": [],
"malwareFamilyNames": [],
"severity": 2,
"tags": [],
"targetProduct": "Microsoft Defender ATP"
}
}
}
Human Readable Output
Indicator 18 was successfully created
id action severity fileHashType fileHashValue 18 allow 2 sha256 50d858e0985ecc7f60418aaf0cc5ab587f42c2570a884095a9e8ccacd0f6545c
microsoft-atp-indicator-update
Deprecated. Use the microsoft-atp-sc-indicator-update command instead. Updates the specified indicator.
Base Command
microsoft-atp-indicator-update
Input
| Argument Name | Description | Required |
|---|---|---|
| indicator_id | The ID of the indicator to update. | Required |
| severity | The severity of the malicious behavior identified by the data within the indicator. Possible values are Informational, Low, MediumLow, MediumHigh, High, where High is the most severe and Informational is not severe at all. | Optional |
| expiration_time | DateTime string indicating when the indicator expires. Format: (<number> <time unit>, e.g., 12 hours, 7 days). | Required |
| description | Brief description (100 characters or less) of the threat represented by the indicator. | Optional |
Context Output
| Path | Type | Description | |
|---|---|---|---|
| MicrosoftATP.Indicators.id | String | Created by the system when the indicator is ingested. Generated GUID/unique identifier. | |
| MicrosoftATP.Indicators.action | String | The action to apply if the indicator is matched from within the targetProduct security tool. Possible values are: unknown, allow, block, alert. | |
| MicrosoftATP.Indicators.additionalInformation | String | A catchall area into which extra data from the indicator not covered by the other indicator properties may be placed. Data placed into additionalInformation will typically not be used by the targetProduct security tool. | |
| MicrosoftATP.Indicators.azureTenantId | String | Timestamp when the indicator was ingested into the system. | |
| MicrosoftATP.Indicators.confidence | Number | An integer representing the confidence with which the data within the indicator accurately identifies malicious behavior. Possible values are 0 – 100, with 100 being the highest. | |
| MicrosoftATP.Indicators.description | String | Brief description (100 characters or less) of the threat represented by the indicator. | |
| MicrosoftATP.Indicators.diamondModel | String | The area of the Diamond Model in which this indicator exists. Possible values are: unknown, adversary, capability, infrastructure, victim. | |
| MicrosoftATP.Indicators.domainName | String | Domain name associated with this indicator. Should be in the format subdomain.domain.topleveldomain. | |
| MicrosoftATP.Indicators.emailEncoding | String | The type of text encoding used in the email. | |
| MicrosoftATP.Indicators.emailLanguage | String | The language of the email. | |
| MicrosoftATP.Indicators.emailRecipient | String | Recipient email address. | |
| MicrosoftATP.Indicators.emailSenderAddress | String | Email address of the attacker | victim. |
| MicrosoftATP.Indicators.emailSenderName | String | Display name of the attacker | victim.. |
| MicrosoftATP.Indicators.emailSourceDomain | String | Domain used in the email. | |
| MicrosoftATP.Indicators.emailSourceIpAddress | String | Source IP address of the email. | |
| MicrosoftATP.Indicators.emailSubject | String | Subject line of the email. | |
| MicrosoftATP.Indicators.emailXMailer | String | X-Mailer value used in the email. | |
| MicrosoftATP.Indicators.expirationDateTime | Date | DateTime string indicating when the indicator expires. To avoid stale indicators persisting in the system, all indicators must have an expiration date. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.externalId | String | An identification number that ties the indicator back to the indicator provider’s system (e.g. a foreign key). | |
| MicrosoftATP.Indicators.fileCompileDateTime | Date | DateTime when the file was compiled. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.fileCreatedDateTime | Date | DateTime when the file was created.The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.fileHashType | String | The type of hash stored in fileHashValue. Possible values are: unknown, sha1, sha256, md5, authenticodeHash256, lsHash, or ctph. Possible values are: unknown, sha1, sha256, md5, authenticodeHash256, lsHash, ctph. | |
| MicrosoftATP.Indicators.fileHashValue | String | The file hash value. | |
| MicrosoftATP.Indicators.fileMutexName | String | Mutex name used in file-based detections. | |
| MicrosoftATP.Indicators.fileName | String | Name of the file if the indicator is file-based. Supports comma-separate list of file names. | |
| MicrosoftATP.Indicators.filePacker | String | The packer used to build the file in question. | |
| MicrosoftATP.Indicators.filePath | String | Path of the file indicating a compromise. May be a Windows or *nix style. | |
| MicrosoftATP.Indicators.fileSize | Number | Size of the file in bytes. | |
| MicrosoftATP.Indicators.fileType | String | Text description of the type of file. For example, “Word Document” or “Binary”. | |
| MicrosoftATP.Indicators.ingestedDateTime | Date | Stamped by the system when the indicator is ingested. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.isActive | Boolean | Used to deactivate indicators within system. By default, any indicator submitted is set as active. However, providers may submit existing indicators with this set to ‘False’ to deactivate indicators in the system. | |
| MicrosoftATP.Indicators.knownFalsePositives | String | Scenarios in which the indicator may cause false positives. This should be human-readable text. | |
| MicrosoftATP.Indicators.lastReportedDateTime | Date | The last time the indicator was seen. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ | |
| MicrosoftATP.Indicators.networkCidrBlock | String | CIDR Block notation representation of the network referenced in this indicator. Use only if the Source and Destination cannot be identified. | |
| MicrosoftATP.Indicators.networkDestinationAsn | Number | The destination autonomous system identifier of the network referenced in the indicator. | |
| MicrosoftATP.Indicators.networkDestinationCidrBlock | String | CIDR Block notation representation of the destination network in this indicator. | |
| MicrosoftATP.Indicators.networkDestinationIPv4 | String | IPv4 IP address destination. | |
| MicrosoftATP.Indicators.networkDestinationIPv6 | String | IPv6 IP address destination. | |
| MicrosoftATP.Indicators.networkDestinationPort | Number | TCP port destination. | |
| MicrosoftATP.Indicators.networkIPv4 | String | IPv4 IP address. | |
| MicrosoftATP.Indicators.networkIPv6 | String | IPv6 IP address. | |
| MicrosoftATP.Indicators.networkPort | Number | TCP port. | |
| MicrosoftATP.Indicators.networkProtocol | Number | Decimal representation of the protocol field in the IPv4 header. | |
| MicrosoftATP.Indicators.networkSourceAsn | Number | The source autonomous system identifier of the network referenced in the indicator. | |
| MicrosoftATP.Indicators.networkSourceCidrBlock | String | CIDR Block notation representation of the source network in this indicator. | |
| MicrosoftATP.Indicators.networkSourceIPv4 | String | IPv4 IP address source. | |
| MicrosoftATP.Indicators.networkSourceIPv6 | String | IPv6 IP address source. | |
| MicrosoftATP.Indicators.networkSourcePort | Number | TCP port source. | |
| MicrosoftATP.Indicators.passiveOnly | Boolean | Determines if the indicator should trigger an event that is visible to an end user. When set to ‘true,’ security tools will not notify the end user that a ‘hit’ has occurred. This is most often treated as audit or silent mode by security products where they will simply log that a match occurred but will not perform the action. Default value is false. | |
| MicrosoftATP.Indicators.severity | Number | Severity of the malicious behavior identified by the data within the indicator. Possible values are 0 – 5, where 5 is the most severe and zero is not severe at all. Default is 3 | |
| MicrosoftATP.Indicators.targetProduct | String | A string value representing a single security product to which the indicator should be applied. | |
| MicrosoftATP.Indicators.threatType | String | Each indicator must have a valid Indicator Threat Type. Possible values are: Botnet, C2, CryptoMining, Darknet, DDoS, MaliciousUrl, Malware, Phishing, Proxy, PUA, WatchList. | |
| MicrosoftATP.Indicators.tlpLevel | String | Traffic Light Protocol value for the indicator. Possible values are: unknown, white, green, or amber. | |
| MicrosoftATP.Indicators.url | String | Uniform Resource Locator. This URL complies with RFC 1738. | |
| MicrosoftATP.Indicators.userAgent | String | User-Agent string from a web request that could indicate compromise. | |
| MicrosoftATP.Indicators.vendorInformation | String | Information about the vendor. |
Command Example
!microsoft-atp-indicator-update expiration_time="2 days" indicator_id=18
Context Example
{
"MicrosoftATP": {
"Indicators": {
"action": "allow",
"activityGroupNames": [],
"azureTenantId": "TENANT-ID",
"description": "Title: Indicator 50d858e0985ecc7f60418aaf0cc5ab587f42c2570a884095a9e8ccacd0f6545c of type FileSha256, Description: A description",
"expirationDateTime": "2020-08-28T17:21:15Z",
"fileHashType": "sha256",
"fileHashValue": "50d858e0985ecc7f60418aaf0cc5ab587f42c2570a884095a9e8ccacd0f6545c",
"id": "18",
"ingestedDateTime": "2020-08-26T17:18:03.5249643Z",
"isActive": true,
"killChain": [],
"malwareFamilyNames": [],
"severity": 0,
"tags": [],
"targetProduct": "Microsoft Defender ATP"
}
}
}
Human Readable Output
Indicator ID: 18 was updated successfully
action azureTenantId description expirationDateTime fileHashType fileHashValue id ingestedDateTime isActive severity targetProduct allow TENANT-ID Title: Indicator 50d858e0985ecc7f60418aaf0cc5ab587f42c2570a884095a9e8ccacd0f6545c of type FileSha256, Description: A description 2020-08-28T17:21:15Z sha256 50d858e0985ecc7f60418aaf0cc5ab587f42c2570a884095a9e8ccacd0f6545c 18 2020-08-26T17:18:03.5249643Z true 0 Microsoft Defender ATP
microsoft-atp-indicator-delete
Deprecated. Use the microsoft-atp-sc-indicator-delete command instead. Deletes the specified indicator.
Base Command
microsoft-atp-indicator-delete
Input
| Argument Name | Description | Required |
|---|---|---|
| indicator_id | The ID of the indicator to delete. | Required |
Context Output
There is no context output for this command.
Command Example
!microsoft-atp-indicator-delete indicator_id=18
Human Readable Output
Indicator ID: 18 was successfully deleted
microsoft-atp-sc-indicator-list
Lists all indicators by the ID that the system creates when the indicator is ingested.
Permissions
Ti.ReadWrite
Note
To ensure that the application is accessible to all indicators, the ‘Ti.ReadWrite.All’ permission must be granted. Without this permission, the application will only be accessible to the indicators it has created.
Base Command
microsoft-atp-sc-indicator-list
Input
| Argument Name | Description | Required |
|---|---|---|
| limit | The maximum number of indicators to return. Default is 50. | Optional |
| skip | The number of indicators that are to be skipped and not included in the result. | Optional |
| indicator_value | The value of the indicator to get. | Optional |
| indicator_title | The title of the indicator to get. | Optional |
| indicator_type | The type of the indicator to get. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.Indicators.id | String | Created by the system when the indicator is ingested. Generated GUID/unique identifier. |
| MicrosoftATP.Indicators.action | String | The action to apply if the indicator is matched from within the targetProduct security tool. Possible values: “unknown”, “allow”, “block”, and “alert”. |
| MicrosoftATP.Indicators.description | String | Brief description (100 characters or less) of the threat represented by the indicator. |
| MicrosoftATP.Indicators.expirationTime | Date | DateTime string indicating when the indicator expires. To avoid stale indicators persisting in the system, all indicators must have an expiration date. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ |
| MicrosoftATP.Indicators.severity | String | The severity of the malicious behavior identified by the data within the indicator. Possible values: “Informational”, “Low”, “Medium”, and “High”, where High is the most severe and Informational is not severe at all. |
| MicrosoftATP.Indicators.indicatorValue | String | The value of the indicator. |
| MicrosoftATP.Indicators.recommendedActions | String | Recommended actions for the indicator. |
| MicrosoftATP.Indicators.generateAlert | Boolean | Whether an alert was generated. |
| MicrosoftATP.Indicators.rbacGroupNames | Unknown | A list of RBAC device group names where the indicator is exposed and active. Empty list if it is exposed to all devices. |
| MicrosoftATP.Indicators.mitreTechniques | Unknown | A list of MITRE techniques. |
| MicrosoftATP.Indicators.indicatorType | String | Indicator Type. Possible values: “FileSha1”, “FileSha256”, “IpAddress”, “DomainName” and “Url”. |
| MicrosoftATP.Indicators.lastUpdateTime | Date | The last time the indicator was updated. |
| MicrosoftATP.Indicators.createdByDisplayName | String | Display name of the created app. |
| MicrosoftATP.Indicators.application | String | The application associated with the indicator. |
| MicrosoftATP.Indicators.title | String | Indicator title. |
| MicrosoftATP.Indicators.createdBySource | String | Source of indicator creation. For example, PublicApi. |
| MicrosoftATP.Indicators.historicalDetection | Boolean | Whether a historical detection exists. |
| MicrosoftATP.Indicators.lastUpdatedBy | String | Identity of the user/application that last updated the indicator. |
| MicrosoftATP.Indicators.creationTimeDateTimeUtc | Date | The date and time when the indicator was created. |
| MicrosoftATP.Indicators.category | Number | A number representing the indicator category. |
| MicrosoftATP.Indicators.createdBy | String | Unique identity of the user/application that submitted the indicator. |
| File.MD5 | String | The MD5 hash of the file. |
| File.SHA1 | String | The SHA1 hash of the file. |
| File.SHA256 | String | The SHA256 hash of the file. |
| Domain.Name | String | The domain name, for example: “google.com”. |
| IP.Address | String | IP address. |
| URL.Data | String | The URL. |
| DBotScore.Indicator | String | The indicator that was tested. |
| DBotScore.Type | String | The indicator type. |
| DBotScore.Vendor | String | The vendor used to calculate the score. |
| DBotScore.Score | Number | The actual score. |
Command Example
!microsoft-atp-sc-indicator-list limit=2
Context Example
{
"DBotScore": [
{
"Indicator": "1.1.1.1",
"Score": 0,
"Type": "ip",
"Vendor": "Microsoft Defender Advanced Threat Protection test"
},
{
"Indicator": "5.5.5.5",
"Score": 0,
"Type": "ip",
"Vendor": "Microsoft Defender Advanced Threat Protection test"
}
],
"IP": [
{
"Address": "1.1.1.1"
},
{
"Address": "5.5.5.5"
}
],
"MicrosoftATP": {
"Indicators": [
{
"action": "Allowed",
"category": 1,
"createdBy": "1281a70f-8ffb-4b3c-bc82-eef2a44dbb2a",
"createdByDisplayName": "MS Graph ATP",
"createdBySource": "PublicApi",
"creationTimeDateTimeUtc": "2021-08-17T08:57:46.1460707Z",
"description": "description",
"expirationTime": "2021-08-18T08:57:45Z",
"generateAlert": false,
"historicalDetection": false,
"id": "5142",
"indicatorType": "IpAddress",
"indicatorValue": "1.1.1.1",
"lastUpdateTime": "2021-08-17T08:57:46.1563409Z",
"severity": "Low",
"title": "title"
},
{
"action": "Allowed",
"category": 1,
"createdBy": "1281a70f-8ffb-4b3c-bc82-eef2a44dbb2a",
"createdByDisplayName": "MS Graph ATP",
"createdBySource": "PublicApi",
"creationTimeDateTimeUtc": "2021-08-17T08:56:49.1898574Z",
"description": "description",
"expirationTime": "2021-08-18T08:56:48Z",
"generateAlert": false,
"historicalDetection": false,
"id": "5141",
"indicatorType": "IpAddress",
"indicatorValue": "5.5.5.5",
"lastUpdateTime": "2021-08-17T08:56:49.2017376Z",
"severity": "Low",
"title": "title"
}
]
}
}
Human Readable Output
Results found in Microsoft Defender ATP SC for value: 5.5.5.5
id action indicatorValue indicatorType severity title description 5141 Allowed 5.5.5.5 IpAddress Low title description
microsoft-atp-sc-indicator-update
Updates the specified indicator.
Permissions
Ti.ReadWrite
Base Command
microsoft-atp-sc-indicator-update
Input
| Argument Name | Description | Required |
|---|---|---|
| indicator_value | The value of the indicator to update. | Required |
| indicator_type | Indicator Type. Possible values are: FileSha1, FileSha256, IpAddress, DomainName, Url. | Required |
| action | The action taken if the indicator is discovered in the organization. Possible values are: Alert, AlertAndBlock, Allowed. | Required |
| severity | The severity of the malicious behavior identified by the data within the indicator. Possible values: “Informational”, “Low”, “Medium”, and “High”, where High is the most severe and Informational is not severe at all. | Optional |
| expiration_time | DateTime string indicating when the indicator expires. Format: (<number> <time unit>, e.g., 12 hours, 7 days). Default is 14 days. | Optional |
| indicator_description | Brief description (100 characters or less) of the threat represented by the indicator. | Required |
| indicator_title | Indicator alert title. | Required |
| indicator_application | The application associated with the indicator. | Optional |
| recommended_actions | TI indicator alert recommended actions. | Optional |
| rbac_group_names | Comma-separated list of RBAC group names the indicator is applied to. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.Indicators.id | String | Created by the system when the indicator is ingested. Generated GUID/unique identifier. |
| MicrosoftATP.Indicators.action | String | The action to apply if the indicator is matched from within the targetProduct security tool. Possible values: “unknown”, “allow”, “block”, and “alert”. |
| MicrosoftATP.Indicators.description | String | Brief description (100 characters or less) of the threat represented by the indicator. |
| MicrosoftATP.Indicators.expirationTime | Date | DateTime string indicating when the indicator expires. To avoid stale indicators persisting in the system, all indicators must have an expiration date. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ |
| MicrosoftATP.Indicators.severity | String | The severity of the malicious behavior identified by the data within the indicator. Possible values: “Informational”, “Low”, “Medium”, and “High”, where High is the most severe and Informational is not severe at all. |
| MicrosoftATP.Indicators.indicatorValue | String | The value of the indicator. |
| MicrosoftATP.Indicators.recommendedActions | String | Recommended actions for the indicator. |
| MicrosoftATP.Indicators.generateAlert | Boolean | Whether an alert was generated. |
| MicrosoftATP.Indicators.rbacGroupNames | Unknown | A list of RBAC device group names where the indicator is exposed and active. Empty list if it is exposed to all devices. |
| MicrosoftATP.Indicators.mitreTechniques | Unknown | A list of MITRE techniques. |
| MicrosoftATP.Indicators.indicatorType | String | Indicator Type. Possible values: “FileSha1”, “FileSha256”, “IpAddress”, “DomainName” and “Url”. |
| MicrosoftATP.Indicators.lastUpdateTime | Date | The last time the indicator was updated. |
| MicrosoftATP.Indicators.createdByDisplayName | String | Display name of the created app. |
| MicrosoftATP.Indicators.application | String | The application associated with the indicator. |
| MicrosoftATP.Indicators.title | String | Indicator title. |
| MicrosoftATP.Indicators.createdBySource | String | Source of indicator creation. For example, PublicApi. |
| MicrosoftATP.Indicators.historicalDetection | Boolean | Whether a historical detection exists. |
| MicrosoftATP.Indicators.lastUpdatedBy | String | Identity of the user/application that last updated the indicator. |
| MicrosoftATP.Indicators.creationTimeDateTimeUtc | Date | The date and time when the indicator was created. |
| MicrosoftATP.Indicators.category | Number | An number representing the indicator category. |
| MicrosoftATP.Indicators.createdBy | String | Unique identity of the user/application that submitted the indicator. |
| File.MD5 | String | The MD5 hash of the file. |
| File.SHA1 | String | The SHA1 hash of the file. |
| File.SHA256 | String | The SHA256 hash of the file. |
| Domain.Name | String | The domain name, for example: “google.com”. |
| IP.Address | String | IP address. |
| URL.Data | String | The URL. |
| DBotScore.Indicator | String | The indicator that was tested. |
| DBotScore.Type | String | The indicator type. |
| DBotScore.Vendor | String | The vendor used to calculate the score. |
| DBotScore.Score | Number | The actual score. |
Command Example
!microsoft-atp-sc-indicator-update action=Allowed indicator_description=test indicator_title=title indicator_type=IpAddress indicator_value=2.2.2.2 expiration_time="1 day" severity=Low
Context Example
{
"DBotScore": {
"Indicator": "2.2.2.2",
"Score": 0,
"Type": "ip",
"Vendor": "Microsoft Defender Advanced Threat Protection test"
},
"IP": {
"Address": "2.2.2.2"
},
"MicrosoftATP": {
"Indicators": {
"@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#Indicators/$entity",
"action": "Allowed",
"category": 1,
"createdBy": "1281a70f-8ffb-4b3c-bc82-eef2a44dbb2a",
"createdByDisplayName": "MS Graph ATP",
"createdBySource": "PublicApi",
"creationTimeDateTimeUtc": "2021-08-17T08:58:12.0340768Z",
"description": "test",
"expirationTime": "2021-08-18T08:58:12Z",
"generateAlert": false,
"historicalDetection": false,
"id": "5143",
"indicatorType": "IpAddress",
"indicatorValue": "2.2.2.2",
"lastUpdateTime": "2021-08-17T08:58:13.5312934Z",
"lastUpdatedBy": "1281a70f-8ffb-4b3c-bc82-eef2a44dbb2a",
"mitreTechniques": [],
"rbacGroupIds": [],
"rbacGroupNames": [],
"severity": "Low",
"title": "title"
}
}
}
Human Readable Output
Indicator 2.2.2.2 was updated successfully
id action indicatorValue indicatorType severity title description 5143 Allowed 2.2.2.2 IpAddress Low title test
microsoft-atp-sc-indicator-get-by-id
Gets an indicator by its ID.
Permissions
Ti.ReadWrite
Base Command
microsoft-atp-sc-indicator-get-by-id
Input
| Argument Name | Description | Required |
|---|---|---|
| indicator_id | The ID of the indicator to get. The ID can be retrieved by running the microsoft-atp-sc-indicator-list command. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.Indicators.id | String | Created by the system when the indicator is ingested. Generated GUID/unique identifier. |
| MicrosoftATP.Indicators.action | String | The action to apply if the indicator is matched from within the targetProduct security tool. Possible values: “unknown”, “allow”, “block”, and “alert”. |
| MicrosoftATP.Indicators.description | String | Brief description (100 characters or less) of the threat represented by the indicator. |
| MicrosoftATP.Indicators.expirationTime | Date | DateTime string indicating when the indicator expires. To avoid stale indicators persisting in the system, all indicators must have an expiration date. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ |
| MicrosoftATP.Indicators.severity | String | The severity of the malicious behavior identified by the data within the indicator. Possible values: “Informational”, “Low”, “Medium” and “High”, where High is the most severe and Informational is not severe at all. |
| MicrosoftATP.Indicators.indicatorValue | String | The value of the indicator. |
| MicrosoftATP.Indicators.recommendedActions | String | Recommended actions for the indicator. |
| MicrosoftATP.Indicators.generateAlert | Boolean | Whether an alert was generated. |
| MicrosoftATP.Indicators.rbacGroupNames | Unknown | A list of RBAC device group names where the indicator is exposed and active. Empty list if it is exposed to all devices. |
| MicrosoftATP.Indicators.mitreTechniques | Unknown | A list of MITRE techniques. |
| MicrosoftATP.Indicators.indicatorType | String | Indicator Type. Possible values: “FileSha1”, “FileSha256”, “IpAddress”, “DomainName” and “Url”. |
| MicrosoftATP.Indicators.lastUpdateTime | Date | The last time the indicator was updated. |
| MicrosoftATP.Indicators.createdByDisplayName | String | Display name of the created app. |
| MicrosoftATP.Indicators.application | String | The application associated with the indicator. |
| MicrosoftATP.Indicators.title | String | Indicator title. |
| MicrosoftATP.Indicators.createdBySource | String | Source of indicator creation. For example, PublicApi. |
| MicrosoftATP.Indicators.historicalDetection | Boolean | Whether a historical detection exists. |
| MicrosoftATP.Indicators.lastUpdatedBy | String | Identity of the user/application that last updated the indicator. |
| MicrosoftATP.Indicators.creationTimeDateTimeUtc | Date | The date and time when the indicator was created. |
| MicrosoftATP.Indicators.category | Number | An number representing the indicator category. |
| MicrosoftATP.Indicators.createdBy | String | Unique identity of the user/application that submitted the indicator. |
| File.MD5 | String | The MD5 hash of the file. |
| File.SHA1 | String | The SHA1 hash of the file. |
| File.SHA256 | String | The SHA256 hash of the file. |
| Domain.Name | String | The domain name, for example: “google.com”. |
| IP.Address | String | IP address. |
| URL.Data | String | The URL. |
| DBotScore.Indicator | String | The indicator that was tested. |
| DBotScore.Type | String | The indicator type. |
| DBotScore.Vendor | String | The vendor used to calculate the score. |
| DBotScore.Score | Number | The actual score. |
Command Example
!microsoft-atp-sc-indicator-get-by-id indicator_id=5142
Context Example
{
"DBotScore": {
"Indicator": "1.1.1.1",
"Score": 0,
"Type": "ip",
"Vendor": "Microsoft Defender Advanced Threat Protection test"
},
"IP": {
"Address": "1.1.1.1"
},
"MicrosoftATP": {
"Indicators": {
"@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#Indicators/$entity",
"action": "Allowed",
"additionalInfo": null,
"application": null,
"bypassDurationHours": null,
"category": 1,
"certificateInfo": null,
"createdBy": "1281a70f-8ffb-4b3c-bc82-eef2a44dbb2a",
"createdByDisplayName": "MS Graph ATP",
"createdBySource": "PublicApi",
"creationTimeDateTimeUtc": "2021-08-17T08:57:46.1460707Z",
"description": "description",
"educateUrl": null,
"expirationTime": "2021-08-18T08:57:45Z",
"externalId": null,
"generateAlert": false,
"historicalDetection": false,
"id": "5142",
"indicatorType": "IpAddress",
"indicatorValue": "1.1.1.1",
"lastUpdateTime": "2021-08-17T08:57:46.1563409Z",
"lastUpdatedBy": null,
"lookBackPeriod": null,
"mitreTechniques": [],
"notificationBody": null,
"notificationId": null,
"rbacGroupIds": [],
"rbacGroupNames": [],
"recommendedActions": null,
"severity": "Low",
"title": "title",
"version": null
}
}
}
Human Readable Output
Results found in Microsoft Defender ATP SC for value: 1.1.1.1
id action indicatorValue indicatorType severity title description 5142 Allowed 1.1.1.1 IpAddress Low title description
microsoft-atp-sc-indicator-delete
Deletes the specified indicator.
Permissions
Ti.ReadWrite
Base Command
microsoft-atp-sc-indicator-delete
Input
| Argument Name | Description | Required |
|---|---|---|
| indicator_id | The ID of the indicator to delete. The ID can be retrieved by running the microsoft-atp-sc-indicator-list command. | Required |
Context Output
There is no context output for this command.
Command Example
!microsoft-atp-sc-indicator-delete indicator_id=5142
Human Readable Output
Indicator ID: 5142 was successfully deleted
microsoft-atp-sc-indicator-create
Creates a new indicator.
Permissions
Ti.ReadWrite
Base Command
microsoft-atp-sc-indicator-create
Input
| Argument Name | Description | Required |
|---|---|---|
| indicator_value | The value of the indicator to update. | Required |
| indicator_type | Indicator Type. Possible values are: FileSha1, FileSha256, IpAddress, DomainName, Url. | Required |
| action | The action taken if the indicator is discovered in the organization. Possible values are: Alert, AlertAndBlock, Allowed. | Required |
| severity | The severity of the malicious behavior identified by the data within the indicator. Possible values: “Informational”, “Low”, “Medium”, and “High”, where High is the most severe and Informational is not severe at all. | Optional |
| expiration_time | DateTime string indicating when the indicator expires. Format: (<number> <time unit>, e.g., 12 hours, 7 days). Default is 14 days. | Optional |
| indicator_description | Brief description (100 characters or less) of the threat represented by the indicator. | Required |
| indicator_title | Indicator alert title. | Required |
| indicator_application | The application associated with the indicator. | Optional |
| recommended_actions | TI indicator alert recommended actions. | Optional |
| rbac_group_names | Comma-separated list of RBAC group names the indicator is applied to. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.Indicators.id | String | Created by the system when the indicator is ingested. Generated GUID/unique identifier. |
| MicrosoftATP.Indicators.action | String | The action to apply if the indicator is matched from within the targetProduct security tool. Possible values: “unknown”, “allow”, “block”, “alert”. |
| MicrosoftATP.Indicators.description | String | Brief description (100 characters or less) of the threat represented by the indicator. |
| MicrosoftATP.Indicators.expirationTime | Date | DateTime string indicating when the indicator expires. To avoid stale indicators persisting in the system, all indicators must have an expiration date. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: ‘2014-01-01T00:00:00Z’ |
| MicrosoftATP.Indicators.severity | String | The severity of the malicious behavior identified by the data within the indicator. Possible values: “Informational”, “Low”, “Medium”, and “High”, where High is the most severe and Informational is not severe at all. |
| MicrosoftATP.Indicators.indicatorValue | String | The value of the indicator. |
| MicrosoftATP.Indicators.recommendedActions | String | Recommended actions for the indicator. |
| MicrosoftATP.Indicators.generateAlert | Boolean | Whether an alert was generated. |
| MicrosoftATP.Indicators.rbacGroupNames | Unknown | A list of RBAC device group names where the indicator is exposed and active. Empty list if it is exposed to all devices. |
| MicrosoftATP.Indicators.mitreTechniques | Unknown | A list of MITRE techniques. |
| MicrosoftATP.Indicators.indicatorType | String | Type of the indicator. Possible values: “FileSha1”, “FileSha256”, “IpAddress”, “DomainName” and “Url”. |
| MicrosoftATP.Indicators.lastUpdateTime | Date | The last time the indicator was updated. |
| MicrosoftATP.Indicators.createdByDisplayName | String | Display name of the created app. |
| MicrosoftATP.Indicators.application | String | The application associated with the indicator. |
| MicrosoftATP.Indicators.title | String | Indicator title. |
| MicrosoftATP.Indicators.createdBySource | String | Source of indicator creation. For example, PublicApi. |
| MicrosoftATP.Indicators.historicalDetection | Boolean | Whether a historical detection exists. |
| MicrosoftATP.Indicators.lastUpdatedBy | String | Identity of the user/application that last updated the indicator. |
| MicrosoftATP.Indicators.creationTimeDateTimeUtc | Date | The date and time when the indicator was created. |
| MicrosoftATP.Indicators.category | Number | An number representing the indicator category. |
| MicrosoftATP.Indicators.createdBy | String | Unique identity of the user/application that submitted the indicator. |
| File.MD5 | String | The MD5 hash of the file. |
| File.SHA1 | String | The SHA1 hash of the file. |
| File.SHA256 | String | The SHA256 hash of the file. |
| Domain.Name | String | The domain name, for example: “google.com”. |
| IP.Address | String | IP address. |
| URL.Data | String | The URL. |
| DBotScore.Indicator | String | The indicator that was tested. |
| DBotScore.Type | String | The indicator type. |
| DBotScore.Vendor | String | The vendor used to calculate the score. |
| DBotScore.Score | Number | The actual score. |
Command Example
!microsoft-atp-sc-indicator-create action=Allowed indicator_description=test indicator_title=title indicator_type=IpAddress indicator_value=2.2.2.2 expiration_time="1 day" severity=Informational
Context Example
{
"DBotScore": {
"Indicator": "2.2.2.2",
"Score": 0,
"Type": "ip",
"Vendor": "Microsoft Defender Advanced Threat Protection test"
},
"IP": {
"Address": "2.2.2.2"
},
"MicrosoftATP": {
"Indicators": {
"@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#Indicators/$entity",
"action": "Allowed",
"createdBy": "1281a70f-8ffb-4b3c-bc82-eef2a44dbb2a",
"createdByDisplayName": "MS Graph ATP",
"createdBySource": "PublicApi",
"creationTimeDateTimeUtc": "2021-08-17T08:58:12.0340768Z",
"description": "test",
"expirationTime": "2021-08-18T08:58:11Z",
"generateAlert": false,
"historicalDetection": false,
"id": "5143",
"indicatorType": "IpAddress",
"indicatorValue": "2.2.2.2",
"lastUpdateTime": "2021-08-17T08:58:12.0438875Z",
"mitreTechniques": [],
"rbacGroupIds": [],
"rbacGroupNames": [],
"severity": "Informational",
"title": "title"
}
}
}
Human Readable Output
Indicator 2.2.2.2 was updated successfully
id action indicatorValue indicatorType severity title description 5143 Allowed 2.2.2.2 IpAddress Informational title test
microsoft-atp-list-machines-by-vulnerability
Retrieves a list of machines affected by a vulnerability.
Required Permissions
Vulnerability.Read.All
Base Command
microsoft-atp-list-machines-by-vulnerability
Input
| Argument Name | Description | Required |
|---|---|---|
| cve_id | A comma-separated list of CVE IDs used for getting the machines. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.CveMachine.ID | String | The machine ID. |
| MicrosoftATP.CveMachine.ComputerDNSName | String | The machine hostname. |
| MicrosoftATP.CveMachine.OSPlatform | String | The operating system platform. |
| MicrosoftATP.CveMachine.RBACGroupName | String | The machine RBAC group name. |
| MicrosoftATP.CveMachine.CVE | Unknown | The given CVE IDs related to this machine. |
Command example
!microsoft-atp-list-machines-by-vulnerability cve_id=CVE-2021-32810,CVE-2020-12321
Context Example
{
"MicrosoftATP": {
"CveMachine": [
{
"ComputerDNSName": "ec2amaz",
"ID": "f3bba49a",
"OSPlatform": "WindowsServer2016",
"RBACGroupID": 0,
"CVE": ["CVE-2021-32810", "CVE-2020-12321"]
},
{
"ComputerDNSName": "msde-agent-host-centos7",
"ID": "48a62a74",
"OSPlatform": "Linux",
"RBACGroupID": 0,
"CVE": ["CVE-2020-12321"]
}
]
}
}
Human Readable Output
Microsoft Defender ATP machines by vulnerabilities: [‘CVE-2021-32810’, ‘CVE-2020-12321’]
ID ComputerDNSName OSPlatform RBACGroupID CVE f3bba49a ec2amaz WindowsServer2016 0 CVE-2021-32810,CVE-2020-12321 48a62a74 msde-agent-host-centos7 Linux 0 CVE-2020-12321
microsoft-atp-get-file-info
Retrieves file information by a file hash (SHA1 or SHA256).
Required Permissions
File.Read.All
Base Command
microsoft-atp-get-file-info
Input
| Argument Name | Description | Required |
|---|---|---|
| hash | A comma-separated list of file hashes (SHA1 or SHA256) used for getting the file information. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.File.Sha1 | String | The SHA1 hash of the file. |
| MicrosoftATP.File.Md5 | String | The MD5 hash of the file. |
| MicrosoftATP.File.Sha256 | String | The SHA256 hash of the file. |
| MicrosoftATP.File.GlobalPrevalence | Number | The file prevalence across the organization. |
| MicrosoftATP.File.GlobalFirstObserved | Date | The first time the file was observed. |
| MicrosoftATP.File.GlobalLastObserved | Date | The last time the file was observed. |
| MicrosoftATP.File.Size | Number | The size of the file. |
| MicrosoftATP.File.FileType | String | The type of the file. |
| MicrosoftATP.File.IsPeFile | Boolean | True if the file is portable executable, False otherwise. |
| MicrosoftATP.File.FilePublisher | String | The file’s publisher. |
| MicrosoftATP.File.FileProductName | String | The file product name. |
| MicrosoftATP.File.Signer | String | The file signer. |
| MicrosoftATP.File.Issuer | String | The file issuer. |
| MicrosoftATP.File.SignerHash | String | The hash of the signing certificate. |
| MicrosoftATP.File.IsValidCertificate | Boolean | Was signing certificate successfully verified by Microsoft Defender ATP agent. |
| MicrosoftATP.File.DeterminationValue | String | The file determination value. |
| MicrosoftATP.File.DeterminationType | String | The file determination type. |
| File.SHA1 | String | The SHA1 hash of the file. |
| File.SHA256 | String | The SHA256 hash of the file. |
| File.Type | String | The file type. |
| File.Size | Number | The file size. |
Command example
!microsoft-atp-get-file-info hash="3395856ce81,db79e9e669c"
Context Example
{
"File": [
{
"Sha1": "3395856ce81",
"Sha256": "275a021bbfb648",
"Size": 68
},
{
"Sha1": "db79e9e669c",
"Sha256": "ef67e4b2bb4ee5",
"Size": 36768
}
],
"MicrosoftATP": {
"File": [
{
"DeterminationType": "Unknown",
"DeterminationValue": "Virus:DOS/EICAR_Test_File",
"GlobalFirstObserved": "2013-03-03T14:00:34.8213548Z",
"GlobalLastObserved": "2022-01-26T17:31:27.4706316Z",
"GlobalPrevalence": 37933,
"IsPeFile": false,
"Md5": "44d88612fea8a8",
"Sha1": "3395856ce81",
"Sha256": "275a021bbfb648",
"Size": 68,
"SizeInBytes": 68
},
{
"DeterminationType": "Unknown",
"GlobalFirstObserved": "2022-01-14T18:04:15.9389909Z",
"GlobalLastObserved": "2022-01-26T17:36:07.8400883Z",
"GlobalPrevalence": 8418,
"IsPeFile": false,
"Md5": "b0c6a0cfdac",
"Sha1": "db79e9e669c",
"Sha256": "ef67e4b2bb4ee5",
"Size": 36768,
"SizeInBytes": 36768
}
]
}
}
Human Readable Output
Microsoft Defender ATP file info by hashes: [‘3395856ce81’, ‘db79e9e669c’]
Sha1 Sha256 Size 3395856ce81 275a021bbfb648 68 db79e9e669c ef67e4b2bb4ee5 36768
endpoint
Gets machines that have communicated with Microsoft Defender for Endpoint cloud. At least one of the following arguments is required ip, hostanme ot id. Otherwise, an error appears.
Required Permissions
Machine.Read.All
Machine.ReadWrite.All
Base Command
endpoint
Input
| Argument Name | Description | Required |
|---|---|---|
| id | The endpoint ID. | Optional |
| ip | The endpoint IP address. | Optional |
| hostname | The endpoint hostname. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| Endpoint.ID | String | The endpoint’s identifier. |
| Endpoint.Hostname | String | The hostname of the endpoint. |
| Endpoint.OS | String | The endpoint’s operating system. |
| Endpoint.OSVersion | String | The endpoint’s operating system’s version. |
| Endpoint.IPAddress | String | The endpoint’s IP address. |
| Endpoint.Status | String | The health status of the endpoint. |
| Endpoint.MACAddress | String | The endpoint’s MAC address. |
| Endpoint.Vendor | String | The integration name of the endpoint vendor. |
| MicrosoftATP.Machine.ID | String | The machine ID. |
| MicrosoftATP.Machine.ComputerDNSName | String | The machine DNS name. |
| MicrosoftATP.Machine.FirstSeen | Date | The first date and time where the machine was observed by Microsoft Defender ATP. |
| MicrosoftATP.Machine.LastSeen | Date | The last date and time where the machine was observed by Microsoft Defender ATP. |
| MicrosoftATP.Machine.OSPlatform | String | The operating system platform. |
| MicrosoftATP.Machine.OSVersion | String | The operating system version. |
| MicrosoftATP.Machine.OSProcessor | String | The operating system processor. |
| MicrosoftATP.Machine.LastIPAddress | String | The last IP on the machine. |
| MicrosoftATP.Machine.LastExternalIPAddress | String | The last machine IP to access the internet. |
| MicrosoftATP.Machine.OSBuild | Number | The operating system build number. |
| MicrosoftATP.Machine.HealthStatus | String | The machine health status. |
| MicrosoftATP.Machine.RBACGroupID | Number | The machine RBAC group ID. |
| MicrosoftATP.Machine.RBACGroupName | String | The machine RBAC group name. |
| MicrosoftATP.Machine.RiskScore | String | The machine risk score. |
| MicrosoftATP.Machine.ExposureLevel | String | The machine exposure score. |
| MicrosoftATP.Machine.IsAADJoined | Boolean | True if machine is AAD joined, False otherwise. |
| MicrosoftATP.Machine.AADDeviceID | String | The AAD Device ID. |
| MicrosoftATP.Machine.MachineTags | String | Set of machine tags. |
| MicrosoftATP.Machine.IPAddresses.ipAddress | String | The machine IP address. |
| MicrosoftATP.Machine.IPAddresses.MACAddress | String | The machine MAC address. |
| MicrosoftATP.Machine.IPAddresses.operationalStatus | String | The machine operational status. |
| MicrosoftATP.Machine.IPAddresses.type | String | The machine macine IP address type. |
| MicrosoftATP.Machine.AgentVersion | String | The machine Agent version. |
Command example
!endpoint id="f3bba49a,48a62a74"ip=1.2.3.4 hostname="ec2amaz-ua9hieu"
Context Example
{
"Endpoint": [
{
"Hostname": "msde-agent-host-centos7.c.dmst-integrations.internal",
"ID": "48a62a74",
"IPAddress": "10.0.0.1",
"MACAddress": "123456789123",
"OS": "CentOS",
"OSVersion": "7.9 x64 bit",
"Status": "Online",
"Vendor": "Microsoft Defender ATP"
},
{
"Hostname": "ec2amaz-ua9hieu",
"ID": "f3bba49a",
"IPAddress": "1.2.3.4",
"MACAddress": "123456789123",
"OS": "WindowsServer2016",
"OSVersion": "1607 x64 bit",
"Status": "Online",
"Vendor": "Microsoft Defender ATP"
}
],
"MicrosoftATP": {
"Machine": [
{
"AgentVersion": "30.121112.15302.0",
"ComputerDNSName": "msde-agent-host-centos7.c.dmst-integrations.internal",
"ExposureLevel": "Medium",
"FirstSeen": "2022-01-23T09:13:42.982Z",
"HealthStatus": "Active",
"ID": "48a62a74",
"IPAddresses": [
{
"ipAddress": "10.0.0.1",
"macAddress": "123456789123",
"operationalStatus": "Up",
"type": "Other"
},
{
"ipAddress": "fe80::178b:6498:fc7f:2856",
"macAddress": "123456789123",
"operationalStatus": "Up",
"type": "Other"
},
{
"ipAddress": "127.0.0.1",
"macAddress": "000000000000",
"operationalStatus": "Up",
"type": "Other"
},
{
"ipAddress": "::1",
"macAddress": "000000000000",
"operationalStatus": "Up",
"type": "Other"
}
],
"IsAADJoined": false,
"LastExternalIPAddress": "127.0.0.1",
"LastIPAddress": "10.0.0.1",
"LastSeen": "2022-01-27T09:13:53.1394181Z",
"MACAddress": "123456789123",
"OSPlatform": "CentOS",
"OSProcessor": "x64",
"OSVersion": "7.9",
"RBACGroupID": 0,
"RiskScore": "Medium"
},
{
"AgentVersion": "10.3720.16299.2015",
"ComputerDNSName": "ec2amaz-ua9hieu",
"ExposureLevel": "High",
"FirstSeen": "2022-01-23T15:36:02.286Z",
"HealthStatus": "Active",
"ID": "f3bba49a",
"IPAddresses": [
{
"ipAddress": "1.2.3.4",
"macAddress": "123456789123",
"operationalStatus": "Up",
"type": "Ethernet"
},
{
"ipAddress": "fe80::a998:1c4a:7e1c:4865",
"macAddress": "123456789123",
"operationalStatus": "Up",
"type": "Ethernet"
},
{
"ipAddress": "127.0.0.1",
"macAddress": "",
"operationalStatus": "Up",
"type": "SoftwareLoopback"
},
{
"ipAddress": "::1",
"macAddress": "",
"operationalStatus": "Up",
"type": "SoftwareLoopback"
},
{
"ipAddress": "fe80::5efe:1.2.3.4",
"macAddress": "00000000000000E0",
"operationalStatus": "Down",
"type": "Tunnel"
},
{
"ipAddress": "127.0.0.1",
"macAddress": "00000000000000E0",
"operationalStatus": "Up",
"type": "Tunnel"
},
{
"ipAddress": "fe80::2412:1420:53e0:f88b",
"macAddress": "00000000000000E0",
"operationalStatus": "Up",
"type": "Tunnel"
}
],
"IsAADJoined": false,
"LastExternalIPAddress": "127.0.0.1",
"LastIPAddress": "1.2.3.4",
"LastSeen": "2022-01-26T22:21:19.2024139Z",
"MACAddress": "123456789123",
"OSBuild": 14393,
"OSPlatform": "WindowsServer2016",
"OSProcessor": "x64",
"OSVersion": "1607",
"RBACGroupID": 0,
"RiskScore": "None"
}
]
}
}
Human Readable Output
Microsoft Defender ATP Machine
ID ComputerDNSName OSPlatform LastIPAddress LastExternalIPAddress HealthStatus RiskScore ExposureLevel f3bba49a ec2amaz-ua9hieu WindowsServer2016 1.2.3.4 127.0.0.1 Active None High
microsoft-atp-indicator-batch-update
Updates batch of indicator. If an indicator does not exist, a new indicator will be created.
Required Permissions
Ti.ReadWrite
Ti.ReadWrite.All
Limitations
- Rate limitations for this API are 30 calls per minute.
- There is a limit of 15,000 active indicators per tenant.
- Maximum batch size for one API call is 500.
Note
Please read here about the Microsoft Defender for Endpoint indicator resource type.
We suggest using the TransformIndicatorToMSDefenderIOC automation to load the XSOAR IOCs to MSDE indicator format.
Base Command
microsoft-atp-indicator-batch-update
Input
| Argument Name | Description | Required |
|---|---|---|
| indicator_batch | A JSON object with a list of MS defender ATP indicators to update. The indicator_batch query should be a list of dictionaries. For example: [{“indicatorValue”: “value1”}, {“indicatorValue”: “value2”}]. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.Indicators.ID | String | Created by the system when the indicator is ingested. Generated GUID/unique identifier. |
| MicrosoftATP.Indicators.Value | String | The value of the indicator. |
| MicrosoftATP.Indicators.FailureReason | String | The reason for update failure. |
| MicrosoftATP.Indicators.IsFailed | Boolean | Whether the update failed. |
Command example
!microsoft-atp-indicator-batch-update indicator_batch=`[{"indicatorValue": "220e7d15b011d7fac48f2bd61114db1022197f7f","indicatorType": "FileSha1","title": "demo","application": "demo-test", "action": "Alert","severity": "Informational","description": "demo2","recommendedActions": "nothing","rbacGroupNames": ["group1", "group2"]},{"indicatorValue": "2233223322332233223322332233223322332233223322332233223322332222","indicatorType": "FileSha256","title": "demo2","application": "demo-test2","action": "Alert","severity": "Medium","description": "demo2","recommendedActions": "nothing","rbacGroupNames": []}]`
Context Example
{
"MicrosoftATP": {
"Indicators": [
{
"FailureReason": null,
"ID": "5217",
"IsFailed": false,
"Value": "220e7d15b011d7fac48f2bd61114db1022197f7f"
},
{
"FailureReason": null,
"ID": "5218",
"IsFailed": false,
"Value": "2233223322332233223322332233223322332233223322332233223322332222"
}
]
}
}
Human Readable Output
Indicators updated successfully
ID Value IsFailed 5217 220e7d15b011d7fac48f2bd61114db1022197f7f false 5218 2233223322332233223322332233223322332233223322332233223322332222 false
microsoft-atp-get-alert-by-id (Deprecated)
This command has been deprecated. Use ‘msg-get-alert-details’ in the ‘Microsoft Graph Security’ integration instead.
Retrieves specific alert by the given alert ID.
Required Permissions
Alert.ReadWrite.All
Base Command
microsoft-atp-get-alert-by-id
Input
| Argument Name | Description | Required |
|---|---|---|
| alert_ids | A comma-separated list of alert IDs. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.Alert.ID | String | The alert ID. |
| MicrosoftATP.Alert.IncidentID | Number | The incident ID of the alert. |
| MicrosoftATP.Alert.InvestigationID | Number | The investigation ID related to the alert. |
| MicrosoftATP.Alert.InvestigationState | String | The current state of the Investigation. |
| MicrosoftATP.Alert.AssignedTo | String | The owner of the alert. |
| MicrosoftATP.Alert.Severity | String | The severity of the alert. |
| MicrosoftATP.Alert.Status | String | The current status of the alert. |
| MicrosoftATP.Alert.Classification | String | The alert Classification. |
| MicrosoftATP.Alert.Determination | String | The determination of the alert. |
| MicrosoftATP.Alert.DetectionSource | String | The detection source. |
| MicrosoftATP.Alert.Category | String | The category of the alert. |
| MicrosoftATP.Alert.ThreatFamilyName | String | The threat family. |
| MicrosoftATP.Alert.Title | String | The alert title. |
| MicrosoftATP.Alert.Description | String | The alert description. |
| MicrosoftATP.Alert.AlertCreationTime | Date | The date and time the alert was created. |
| MicrosoftATP.Alert.FirstEventTime | Date | The first event time that triggered the alert on that machine. |
| MicrosoftATP.Alert.LastEventTime | Date | The last event time that triggered the alert on that machine. |
| MicrosoftATP.Alert.LastUpdateTime | Date | The UTC time of the last update. |
| MicrosoftATP.Alert.ResolvedTime | Date | The date and time when the status of the alert was changed to ‘Resolved’. |
| MicrosoftATP.Alert.MachineID | String | The machine ID that is associated with the alert. |
| MicrosoftATP.Alert.ComputerDNSName | String | The machine DNS name. |
| MicrosoftATP.Alert.AADTenantID | String | The AAD tenant ID. |
| MicrosoftATP.Alert.Comments.Comment | String | The alert comment string. |
| MicrosoftATP.Alert.Comments.CreatedBy | String | The alert comment created by string. |
| MicrosoftATP.Alert.Comments.CreatedTime | Date | The alert comment created time date. |
| MicrosoftATP.Alert.Evidence | Unknown | Evidence related to the alert. |
| MicrosoftATP.Alert.DetectorID | String | The ID of the detector that triggered the alert. |
| MicrosoftATP.Alert.ThreatName | String | The threat name. |
| MicrosoftATP.Alert.RelatedUser | String | Details of the user related to a specific alert. |
| MicrosoftATP.Alert.MitreTechniques | String | MITRE Enterprise technique ID. |
| MicrosoftATP.Alert.RBACGroupName | String | The device RBAC group name. |
Command example
!microsoft-atp-get-alert-by-id alert_ids=da637797972607470400_795854214,da637750706361180181_-1167994114
Context Example
{
"MicrosoftATP": {
"Alert": [
{
"AADTenantID": "ebac1a16-81bf-449b-8d43-5732c3c1d999",
"AlertCreationTime": "2022-02-07T02:21:00.7470678Z",
"AssignedTo": "Automation",
"Category": "SuspiciousActivity",
"Classification": null,
"Comments": [
{
"Comment": null,
"CreatedBy": null,
"CreatedTime": null
}
],
"ComputerDNSName": "msde-agent-host-win2016-dc.msde.lab.demisto",
"Description": "MS Graph ATP (Application Id: 1281a70f-8ffb-4b3c-bc82-eef2a44dbb2a) initiated an Automated investigation on msde-agent-host-win2016-dc.msde.lab.demisto.\r\nThe investigation automatically identifies and reviews threat artifacts for possible remediation.\r\n\r\nDetails: testing",
"DetectionSource": "AutomatedInvestigation",
"DetectorID": "5c6b7d86-c91f-4f8c-8aec-9d2086f46527",
"Determination": null,
"Evidence": [],
"FirstEventTime": "2022-02-07T02:21:00.6440488Z",
"ID": "da637797972607470400_795854214",
"IncidentID": 645,
"InvestigationID": 656,
"InvestigationState": "Benign",
"LastEventTime": "2022-02-07T02:21:00.6440488Z",
"LastUpdateTime": "2022-02-07T02:53:34.76Z",
"MachineID": "96444b946be252d1f4550354edef5fdc23aca2c5",
"MitreTechniques": [],
"RBACGroupName": null,
"RelatedUser": null,
"ResolvedTime": "2022-02-07T02:53:34.7299762Z",
"Severity": "Informational",
"Status": "Resolved",
"ThreatFamilyName": null,
"ThreatName": null,
"Title": "Automated investigation started manually"
},
{
"AADTenantID": "ebac1a16-81bf-449b-8d43-5732c3c1d999",
"AlertCreationTime": "2021-12-14T09:23:56.0980302Z",
"AssignedTo": "Automation",
"Category": "SuspiciousActivity",
"Classification": "TruePositive",
"Comments": [
{
"Comment": null,
"CreatedBy": null,
"CreatedTime": null
}
],
"ComputerDNSName": "desktop-s2455r8",
"Description": "MS Graph ATP (Application Id: 1281a70f-8ffb-4b3c-bc82-eef2a44dbb2a) initiated an Automated investigation on desktop-s2455r8.\r\nThe investigation automatically identifies and reviews threat artifacts for possible remediation.\r\n\r\nDetails: testing",
"DetectionSource": "AutomatedInvestigation",
"DetectorID": "5c6b7d86-c91f-4f8c-8aec-9d2086f46527",
"Determination": null,
"Evidence": [],
"FirstEventTime": "2021-12-14T09:23:55.875227Z",
"ID": "da637750706361180181_-1167994114",
"IncidentID": 510,
"InvestigationID": 441,
"InvestigationState": "Benign",
"LastEventTime": "2021-12-14T09:23:55.875227Z",
"LastUpdateTime": "2021-12-15T01:52:41.3Z",
"MachineID": "4899036531e374137f63289c3267bad772c13fef",
"MitreTechniques": [],
"RBACGroupName": null,
"RelatedUser": null,
"ResolvedTime": "2021-12-14T09:52:16.8080395Z",
"Severity": "Informational",
"Status": "Resolved",
"ThreatFamilyName": null,
"ThreatName": null,
"Title": "Automated investigation started manually"
}
]
}
}
Human Readable Output
Microsoft Defender ATP Alerts Info for IDs [‘da637797972607470400795854214’, ‘da637750706361180181-1167994114’]
ID Title Description IncidentID Severity Status Classification Category MachineID da637797972607470400_795854214 Automated investigation started manually MS Graph ATP (Application Id: 1281a70f-8ffb-4b3c-bc82-eef2a44dbb2a) initiated an Automated investigation on msde-agent-host-win2016-dc.msde.lab.demisto.
The investigation automatically identifies and reviews threat artifacts for possible remediation.
Details: testing645 Informational Resolved SuspiciousActivity 96444b946be252d1f4550354edef5fdc23aca2c5 da637750706361180181_-1167994114 Automated investigation started manually MS Graph ATP (Application Id: 1281a70f-8ffb-4b3c-bc82-eef2a44dbb2a) initiated an Automated investigation on desktop-s2455r8.
The investigation automatically identifies and reviews threat artifacts for possible remediation.
Details: testing510 Informational Resolved TruePositive SuspiciousActivity 4899036531e374137f63289c3267bad772c13fef
microsoft-atp-live-response-put-file
Puts a file from the library to the device. Files are saved in a working folder and are deleted when the device restarts by default.
Base Command
microsoft-atp-live-response-put-file
Input
| Argument Name | Description | Required |
|---|---|---|
| machine_id | Machine ID to add file to. | Required |
| comment | A comment to associate with the action. | Required |
| file_name | File name to take from library to device. | Required |
| machine_action_id | Action ID to retrieve status and data for. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.LiveResponseAction.id | String | The machine action ID. |
| MicrosoftATP.LiveResponseAction.type | String | The machine action type. |
| MicrosoftATP.LiveResponseAction.title | String | The machine action title. |
| MicrosoftATP.LiveResponseAction.requestor | String | The machine action requestor. |
| MicrosoftATP.LiveResponseAction.requestorComment | String | The machine action requestorComment. |
| MicrosoftATP.LiveResponseAction.status | String | The machine action status. |
| MicrosoftATP.LiveResponseAction.machineId | String | The machine ID. |
| MicrosoftATP.LiveResponseAction.computerDnsName | String | The computerDnsName. |
| MicrosoftATP.LiveResponseAction.creationDateTimeUtc | Date | The action creationDateTimeUtc. |
| MicrosoftATP.LiveResponseAction.lastUpdateDateTimeUtc | Date | The machine action lastUpdateDateTimeUtc. |
| MicrosoftATP.LiveResponseAction.cancellationRequestor | String | The machine action cancellationRequestor. |
| MicrosoftATP.LiveResponseAction.cancellationComment | String | The machine action cancellationComment. |
| MicrosoftATP.LiveResponseAction.cancellationDateTimeUtc | String | The cancellationDateTimeUtc. |
| MicrosoftATP.LiveResponseAction.errorHResult | String | The errorHResult if exists. |
| MicrosoftATP.LiveResponseAction.scope | String | The action scope. |
| MicrosoftATP.LiveResponseAction.externalId | String | The machine action externalId. |
| MicrosoftATP.LiveResponseAction.requestSource | String | The machine action requestSource. |
| MicrosoftATP.LiveResponseAction.relatedFileInfo | String | The machine action relatedFileInfo. |
| MicrosoftATP.LiveResponseAction.commands.index | String | The machine action command index. |
| MicrosoftATP.LiveResponseAction.commands.startTime | String | The machine action command startTime. |
| MicrosoftATP.LiveResponseAction.commands.endTime | String | The machine action command endTime. |
| MicrosoftATP.LiveResponseAction.commands.commandStatus | String | The machine action command Status. |
| MicrosoftATP.LiveResponseAction.commands.errors | String | The machine action command errors if found. |
| MicrosoftATP.LiveResponseAction.commands.command.type | String | The machine action command type. |
| MicrosoftATP.LiveResponseAction.commands.command.params.key | String | The machine action command params key. |
| MicrosoftATP.LiveResponseAction.commands.command.params.value | String | The machine action command params value. |
| MicrosoftATP.LiveResponseAction.troubleshootInfo | String | The machine action troubleshootInfo. |
Command example
!microsoft-atp-live-response-put-file machine_id="4899036531e374137f63289c3267bad772c13fef" comment="testing" file_name="C:\Users\demisto\Desktop\test.txt"
Context Example
{
"MicrosoftATP": {
"LiveResponseAction": {
"@odata.context": "https://api-us.securitycenter.microsoft.com/api/$metadata#MachineActions/$entity",
"cancellationComment": null,
"cancellationDateTimeUtc": null,
"cancellationRequestor": null,
"commands": [
{
"command": {
"params": [
{
"key": "FileName",
"value": "C:\Users\demisto\Desktop\test.txt"
}
],
"type": "PutFile"
},
"commandStatus": "Created",
"endTime": null,
"errors": [],
"index": 0,
"startTime": null
}
],
"computerDnsName": "desktop-s2455r8",
"creationDateTimeUtc": "2022-02-07T10:32:14.1704612Z",
"errorHResult": 0,
"externalId": null,
"id": "20d1de3f-acef-4715-8bed-a92223c5553c",
"lastUpdateDateTimeUtc": "2022-02-07T10:32:14.1704612Z",
"machineId": "4899036531e374137f63289c3267bad772c13fef",
"relatedFileInfo": null,
"requestSource": "PublicApi",
"requestor": "2f48b784-5da5-4e61-9957-012d2630f1e4",
"requestorComment": "testing",
"scope": null,
"status": "Pending",
"title": null,
"troubleshootInfo": null,
"type": "LiveResponse"
}
}
}
Human Readable Output
Machine Action
Commands Creation time Hostname Machine Action Id MachineId Status {‘index’: 0, ‘startTime’: None, ‘endTime’: None, ‘commandStatus’: ‘Created’, ‘errors’: [], ‘command’: {‘type’: ‘PutFile’, ‘params’: [{‘key’: ‘FileName’, ‘value’: ‘C:\Users\demisto\Desktop\test.txt’}]}} 2022-02-07T10:32:14.1704612Z desktop-s2455r8 20d1de3f-acef-4715-8bed-a92223c5553c 4899036531e374137f63289c3267bad772c13fef Failed
microsoft-atp-live-response-run-script
Runs a script from the library on a device. The Args parameter is passed to your script. Timeouts after 10 minutes.
Base Command
microsoft-atp-live-response-run-script
Input
| Argument Name | Description | Required |
|---|---|---|
| machine_id | Machine ID to add file to. | Required |
| comment | A comment to associate with the action. | Required |
| scriptName | Script name to run on device. | Required |
| arguments | Arguments to run the script with. | Optional |
| machine_action_id | Action ID to retrieve status and data for. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.LiveResponseAction.script_name | String | The script name. |
| MicrosoftATP.LiveResponseAction.exit_code | String | The script exit code. |
| MicrosoftATP.LiveResponseAction.script_output | String | The script outputs. |
| MicrosoftATP.LiveResponseAction.script_errors | String | The script errors if found. |
microsoft-atp-live-response-get-file
Collect file from a device. NOTE: Backslashes in path must be escaped.
Base Command
microsoft-atp-live-response-get-file
Input
| Argument Name | Description | Required |
|---|---|---|
| machine_id | Machine ID to add file to. | Required |
| comment | A comment to associate with the action. | Required |
| path | File path to get from device. | Required |
| machine_action_id | Action ID to retrieve status and data for. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.LiveResponseAction.id | String | The machine action ID. |
| MicrosoftATP.LiveResponseAction.type | String | The machine action type. |
| MicrosoftATP.LiveResponseAction.title | String | The machine action title. |
| MicrosoftATP.LiveResponseAction.requestor | String | The machine action requestor. |
| MicrosoftATP.LiveResponseAction.requestorComment | String | The machine action requestorComment. |
| MicrosoftATP.LiveResponseAction.status | String | The machine action status. |
| MicrosoftATP.LiveResponseAction.machineId | String | The machine ID. |
| MicrosoftATP.LiveResponseAction.computerDnsName | String | The computerDnsName. |
| MicrosoftATP.LiveResponseAction.creationDateTimeUtc | Date | The action creationDateTimeUtc. |
| MicrosoftATP.LiveResponseAction.lastUpdateDateTimeUtc | Date | The machine action lastUpdateDateTimeUtc. |
| MicrosoftATP.LiveResponseAction.cancellationRequestor | String | The machine action cancellationRequestor. |
| MicrosoftATP.LiveResponseAction.cancellationComment | String | The machine action cancellationComment. |
| MicrosoftATP.LiveResponseAction.cancellationDateTimeUtc | String | The cancellationDateTimeUtc. |
| MicrosoftATP.LiveResponseAction.errorHResult | String | The errorHResult if exists. |
| MicrosoftATP.LiveResponseAction.scope | String | The action scope. |
| MicrosoftATP.LiveResponseAction.externalId | String | The machine action externalId. |
| MicrosoftATP.LiveResponseAction.requestSource | String | The machine action requestSource. |
| MicrosoftATP.LiveResponseAction.relatedFileInfo | String | The machine action relatedFileInfo. |
| MicrosoftATP.LiveResponseAction.commands.index | String | The machine action command index. |
| MicrosoftATP.LiveResponseAction.commands.startTime | String | The machine action command startTime. |
| MicrosoftATP.LiveResponseAction.commands.endTime | String | The machine action command endTime. |
| MicrosoftATP.LiveResponseAction.commands.commandStatus | String | The machine action command Status. |
| MicrosoftATP.LiveResponseAction.commands.errors | String | The machine action command errors if found. |
| MicrosoftATP.LiveResponseAction.commands.command.type | String | The machine action command type. |
| MicrosoftATP.LiveResponseAction.commands.command.params.key | String | The machine action command params key. |
| MicrosoftATP.LiveResponseAction.commands.command.params.value | String | The machine action command params value. |
| MicrosoftATP.LiveResponseAction.troubleshootInfo | String | The machine action troubleshootInfo. |
microsoft-atp-live-response-result
Gets a result file for a specified action.
Base Command
microsoft-atp-live-response-result
Input
| Argument Name | Description | Required |
|---|---|---|
| machine_action_id | Action ID to retrieve status and data for. | Required |
| command_index | A command index to retrieve file for. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.LiveResponseAction | String | The machine action ID. |
Command example
!microsoft-atp-live-response-result machine_action_id=11a86b87-12b8-423b-9e8d-9775ab2da78f command_index=0
Context Example
{
"File": {
"EntryID": "230@c1c0b1a7-2a6b-40be-8479-7399ee467a6b",
"Info": "application/json",
"MD5": "1f2bc070ced88de8c80323acfcdbd33c",
"Name": "Response Result",
"SHA1": "eb7568c1342d7fac8c570e53e2ce8103025b605b",
"SHA256": "9df3ced59fd1f346aad035016beb5ebf89838b2f02b1610ee7e0cbfd396cbf02",
"SHA512": "a62de5d64827f60a9885e95658d203f4a7eb7d070873a0379c5ac52d8b013fc12c0e9187c3f83103dcb1bf937d88bf0b48f32f77e72ead30231e5eefca681de9",
"SSDeep": "6:YWGc00ZR/+MqifdvuxAbimLPsYRa7+R98A7V/NJviD5BW+yWrbmD3he6an:YWGb0ZRmKQODYqa7+X7XSB9y+bmhan",
"Size": 293,
"Type": "JSON data"
},
"MicrosoftATP": {
"LiveResponseResult": {
"exit_code": 0,
"script_errors": "",
"script_name": "test_script.ps1",
"script_output": "Transcript started, output file is C:\\ProgramData\\Microsoft\\Windows Defender Advanced Threat Protection\\Temp\\PSScriptOutputs\\PSScript_Transcript_{1954B499-1836-4928-90A2-86DE508BD1B0}.txt\n\u0000"
}
}
}
Human Readable Output
file_link: https://automatedirstrprdeus.blob.core.windows.net/investigation-actions-data/b7df6ab7-5c73-4e13-8cd3-82e1f3d849ed/CustomPlaybookCommandOutput/7ef257a5069c45fe790be86d479d1518?se=2022-02-07T14%3A33%3A07Z&sp=rt&sv=2020-06-12&sr=b&rscd=attachment%3B%20filename%3Doutput_11a86b87-12b8-423b-9e8d-9775ab2da78f_0.json&skoid=34334208-452d-4d6d-afc6-0c319d62a726&sktid=124edf19-b350-4797-aefc-3206115ffdb3&skt=2022-02-07T13%3A48%3A07Z&ske=2022-02-07T14%3A33%3A07Z&sks=b&skv=2020-06-12&sig=IRxMKavzQqHplTsAL350holkkm%2B3NI2mhUUWxaHbOAM%3D
microsoft-atp-advanced-hunting-lateral-movement-evidence
NOTE: This endpoint will be deprecated by Microsoft on January 31, 2027. We recommend switching to the Microsoft Graph Security Integration and using the msg-advanced-hunting command. For more information, see the Microsoft documentation
Detects evidence of attempted lateral movement. When you select a “query_purpose” argument, a designated query template is used.
Base Command
microsoft-atp-advanced-hunting-lateral-movement-evidence
Input
| Argument Name | Description | Required |
|---|---|---|
| query_purpose | When you select a “query_purpose” argument, a designated query template is used. “network_connections” - The network connections initiated by the host/file to other internal hosts. “smb_connections” - SMB connections. “credential_dumping” - Was there a use of credential dumping? If so can we detect the use of the dumped users on other hosts on the network. “management_connection” - Management connection attempts to other hosts. | Required |
| device_name | Device name to look for. | Optional |
| remote_ip_count | Threshold for network enumeration in smb_connection. | Optional |
| file_name | File name to look for. | Optional |
| sha1 | SHA1 hash to look for. | Optional |
| sha256 | SHA256 hash to look for. | Optional |
| md5 | MD5 hash to look for. | Optional |
| device_id | Device ID to look for. | Optional |
| query_operation | Query operator to use with provided arguments. Possible values are: or, and. Default is or. | Optional |
| limit | The maximum number of results to retrieve. Default is 50. | Optional |
| time_range | Time range to look back. Expected syntax is a human readable time range, e.g. 60 minutes, 6 hours, 1 day, etc. | Optional |
| timeout | The amount of time (in seconds) that a request waits for the query response before a timeout occurs. Default is 10. | Optional |
| page | The page number from which to start a search. Default is 1. | Optional |
| show_query | Show the query as part of the entry result. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.HuntLateralMovementEvidence.Result.network_connections | String | The query results for network_connections query_purpose. |
| MicrosoftATP.HuntLateralMovementEvidence.Result.smb_connections | String | The query results for smb_connections query_purpose. |
| MicrosoftATP.HuntLateralMovementEvidence.Result.credential_dumping | String | The query results for credential_dumping query_purpose. |
| MicrosoftATP.HuntLateralMovementEvidence.Result.management_connection | String | The query results for management_connection query_purpose. |
Command example
!microsoft-atp-advanced-hunting-lateral-movement-evidence query_purpose=network_connections device_name=devicename_2,devicename_1 limit=6
Context Example
{
"MicrosoftATP": {
"HuntLateralMovementEvidence": {
"Result": {
"network_connections": [
{
"DeviceName": "devicename_2",
"InitiatingProcessFileName": "",
"RemoteIP": "ip1",
"RemotePort": 54296,
"TotalConnections": 21
}
]
}
}
}
}
Human Readable Output
Lateral Movement Evidence Hunt (network_connections) Results
DeviceName RemoteIP RemotePort TotalConnections devicename_2 ip1 54296 21
Command example
!microsoft-atp-advanced-hunting-lateral-movement-evidence query_purpose=smb_connections device_name=devicename_1
Context Example
{
"MicrosoftATP": {
"HuntLateralMovementEvidence": {
"Result": {
"smb_connections": [
{
"DeviceName": "devicename_1",
"InitiatingProcessCreationTime": "2022-03-03T19:43:46.4373311Z",
"InitiatingProcessFileName": "powershell.exe",
"InitiatingProcessId": 5748,
"RemoteIPCount": 5
},
{
"DeviceName": "devicename_1",
"InitiatingProcessCreationTime": "2022-03-03T19:51:43.2411889Z",
"InitiatingProcessFileName": "powershell_ise.exe",
"InitiatingProcessId": 10084,
"RemoteIPCount": 17
}
]
}
}
}
}
Human Readable Output
Lateral Movement Evidence Hunt (smb_connections) Results
DeviceName InitiatingProcessCreationTime InitiatingProcessFileName InitiatingProcessId RemoteIPCount devicename_1 2022-03-03T19:43:46.4373311Z powershell.exe 5748 5 devicename_1 2022-03-03T19:51:43.2411889Z powershell_ise.exe 10084 17
Command example
!microsoft-atp-advanced-hunting-lateral-movement-evidence query_purpose="management_connection" device_id="4cceb3c642212014e0e9553aa8b59e999ea515ff" query_operation="or" limit="50" timeout="10"
Context Example
{
"MicrosoftATP": {
"HuntLateralMovementEvidence": {
"Result": {
"management_connection": [
{
"DeviceName": "device_name",
"LocalIP": "ip3",
"RemoteIP": "ip4",
"RemotePort": 135,
"TotalCount": 41
},
{
"DeviceName": "device_name",
"LocalIP": "ip3",
"RemoteIP": "ip3",
"RemotePort": 139,
"TotalCount": 1
}
]
}
}
}
}
Human Readable Output
Lateral Movement Evidence Hunt (management_connection) Results
DeviceName LocalIP RemoteIP RemotePort TotalCount device_name ip3 ip4 135 41 device_name ip3 ip3 139 1
microsoft-atp-advanced-hunting-persistence-evidence
NOTE: This endpoint will be deprecated by Microsoft on January 31, 2027. We recommend switching to the Microsoft Graph Security Integration and using the msg-advanced-hunting command. For more information, see the Microsoft documentation
Detects evidence of persistence. When you select a “query_purpose” argument, a designated query template is used.
Base Command
microsoft-atp-advanced-hunting-persistence-evidence
Input
| Argument Name | Description | Required |
|---|---|---|
| query_purpose | When you select a “query_purpose” argument, a designated query template is used. “scheduled_job” - Did the process create any scheduled jobs? “registry_entry” - Did it write to the registry? Requires also argument process_cmd to be provided. “startup_folder_changes” - Was anything added to the startup folder? “new_service_created” - Was a new service created? “service_updated” - Was an existing service edited? “file_replaced” - Was a file replaced in program files? “new_user” - Was a new user created? (On the local machine). “new_group” - Was a new group created? “group_user_change” - Was a user added to a group? (On the local machine) “local_firewall_change” - Was there a change to the local FW rules? “host_file_change” - Was there a change to the hosts file?. Possible values are: scheduled_job, registry_entry, startup_folder_changes, new_service_created, service_updated, file_replaced, new_user, new_group, group_user_change, local_firewall_change, host_file_change. | Required |
| device_name | Device name to look for. | Optional |
| file_name | File name to look for. | Optional |
| sha1 | SHA1 hash to look for. | Optional |
| sha256 | SHA256 hash to look for. | Optional |
| md5 | MD5 hash to look for. | Optional |
| device_id | Device ID to look for. | Optional |
| query_operation | Query operator to use with provided arguments. Possible values are: or, and. Default is or. | Optional |
| limit | Maximum number of results to retrieve. Default is 50. | Optional |
| time_range | Time range to look back. Expected syntax is a human readable time range, e.g. 60 minutes, 6 hours, 1 day, etc. | Optional |
| timeout | The amount of time (in seconds) that a request waits for the query response before a timeout occurs. Default is 10. | Optional |
| process_cmd | Proccess command line that initiated the registry entry. Can only be used with “registry_entry” query_purpose. | Optional |
| page | The page number from which to start a search. Default is 1. | Optional |
| show_query | Show the query as part of the entry result. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.HuntPersistenceEvidence.Result.scheduled_job | String | The query results for scheduled_job query_purpose. |
| MicrosoftATP.HuntPersistenceEvidence.Result.registry_entry | String | The query results for registry_entry query_purpose. |
| MicrosoftATP.HuntPersistenceEvidence.Result.startup_folder_changes | String | The query results for startup_folder_changes query_purpose. |
| MicrosoftATP.HuntPersistenceEvidence.Result.new_service_created | String | The query results for new_service_created query_purpose. |
| MicrosoftATP.HuntPersistenceEvidence.Result.service_updated | String | The query results for service_updated query_purpose. |
| MicrosoftATP.HuntPersistenceEvidence.Result.file_replaced | String | The query results for file_replaced query_purpose. |
| MicrosoftATP.HuntPersistenceEvidence.Result.new_user | String | The query results for new_user query_purpose. |
| MicrosoftATP.HuntPersistenceEvidence.Result.new_group | String | The query results for new_group query_purpose. |
| MicrosoftATP.HuntPersistenceEvidence.Result.group_user_change | String | The query results for group_user_change query_purpose. |
| MicrosoftATP.HuntPersistenceEvidence.Result.local_firewall_change | String | The query results for local_firewall_change query_purpose. |
| MicrosoftATP.HuntPersistenceEvidence.Result.host_file_change | String | The query results for host_file_change query_purpose. |
Command example
!microsoft-atp-advanced-hunting-persistence-evidence query_purpose=scheduled_job device_name=devicename_2 device_id=4cceb3c642212014e0e9553aa8b59e999ea515ff,96444b946be252d1f4550354edef5fdc23aca2c5 query_operation=or
Human Readable Output
Persistence EvidenceHunt Hunt (scheduled_job) Results
No entries.
Command example
!microsoft-atp-advanced-hunting-persistence-evidence query_purpose=new_service_created file_name=installer,services
Context Example
{
"MicrosoftATP": {
"HuntPersistenceEvidence": {
"Result": {
"new_service_created": [
{
"DeviceName": "devicename_2",
"InitiatingProcessCommandLine": "services.exe",
"InitiatingProcessFileName": "services.exe",
"InitiatingProcessVersionInfoOriginalFileName": "services.exe",
"InitiatingProcessVersionInfoProductName": "Microsoft\u00ae Windows\u00ae Operating System",
"RegistryKey": "HKEY_LOCAL_MACHINE\\SYSTEM\\ControlSet001\\Services\\MpKsl49022091",
"RegistryValueData": "",
"RegistryValueName": "",
"RegistryValueType": "None",
"Timestamp": "2022-03-12T00:45:51.2745622Z"
},
{
"DeviceName": "devicename_2",
"InitiatingProcessCommandLine": "services.exe",
"InitiatingProcessFileName": "services.exe",
"InitiatingProcessVersionInfoOriginalFileName": "services.exe",
"InitiatingProcessVersionInfoProductName": "Microsoft\u00ae Windows\u00ae Operating System",
"RegistryKey": "HKEY_LOCAL_MACHINE\\SYSTEM\\ControlSet001\\Services\\MpKsl897892ef",
"RegistryValueData": "",
"RegistryValueName": "",
"RegistryValueType": "None",
"Timestamp": "2022-03-13T00:45:49.9561415Z"
}
]
}
}
}
}
Human Readable Output
Persistence EvidenceHunt Hunt (new_service_created) Results
DeviceName InitiatingProcessCommandLine InitiatingProcessFileName InitiatingProcessVersionInfoOriginalFileName InitiatingProcessVersionInfoProductName RegistryKey RegistryValueType Timestamp devicename_2 services.exe services.exe services.exe Microsoft® Windows® Operating System HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Services\MpKsl49022091 None 2022-03-12T00:45:51.2745622Z devicename_2 services.exe services.exe services.exe Microsoft® Windows® Operating System HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Services\MpKsl897892ef None 2022-03-13T00:45:49.9561415Z
Command example
!microsoft-atp-advanced-hunting-persistence-evidence query_purpose=new_user device_name=desktop
Context Example
{
"MicrosoftATP": {
"HuntPersistenceEvidence": {
"Result": {
"new_user": [
{
"AccountDomain": "devicename_1",
"AccountName": "delete_me",
"AccountSid": "accound-sid",
"DeviceName": "devicename_1",
"InitiatingProcessAccountName": "demisto",
"InitiatingProcessLogonId": 74706995,
"Timestamp": "2022-03-03T21:25:52.4538765Z"
}
]
}
}
}
}
Human Readable Output
Persistence EvidenceHunt Hunt (new_user) Results
AccountDomain AccountName AccountSid DeviceName InitiatingProcessAccountName InitiatingProcessLogonId Timestamp devicename_1 delete_me accound-sid devicename_1 demisto 74706995 2022-03-03T21:25:52.4538765Z
Command example
!microsoft-atp-advanced-hunting-persistence-evidence query_purpose=new_group device_id=deviceid device_name=desktop query_operation=and
Context Example
{
"MicrosoftATP": {
"HuntPersistenceEvidence": {
"Result": {
"new_group": [
{
"AccountDomain": "",
"AccountName": "",
"AccountSid": "",
"AdditionalFields": "{\"GroupName\":\"Test_group_delete\",\"GroupDomainName\":\"devicename_1\",\"GroupSid\":\"S-1-5-21-4197691174-1403503641-4006700887-1006\"}",
"DeviceName": "devicename_1",
"InitiatingProcessAccountName": "demisto",
"InitiatingProcessLogonId": 74706995,
"Timestamp": "2022-03-03T21:26:30.8791017Z"
}
]
}
}
}
}
Human Readable Output
Persistence EvidenceHunt Hunt (new_group) Results
AdditionalFields DeviceName InitiatingProcessAccountName InitiatingProcessLogonId Timestamp {“GroupName”:”Test_group_delete”,”GroupDomainName”:”devicename_1”,”GroupSid”:”S-1-5-21-4197691174-1403503641-4006700887-1006”} devicename_1 demisto 74706995 2022-03-03T21:26:30.8791017Z
Command example
!microsoft-atp-advanced-hunting-persistence-evidence query_purpose=group_user_change device_name=desktop
Context Example
{
"MicrosoftATP": {
"HuntPersistenceEvidence": {
"Result": {
"group_user_change": [
{
"AccountSid": "accound-sid"
}
]
}
}
}
}
Human Readable Output
Persistence EvidenceHunt Hunt (group_user_change) Results
AccountSid accound-sid
Command example
!microsoft-atp-advanced-hunting-persistence-evidence query_purpose=local_firewall_change device_name=desktop
Human Readable Output
Persistence EvidenceHunt Hunt (local_firewall_change) Results
No entries.
Command example
!microsoft-atp-advanced-hunting-persistence-evidence query_purpose=host_file_change device_name=desktop
Human Readable Output
Persistence EvidenceHunt Hunt (host_file_change) Results
No entries.
microsoft-atp-advanced-hunting-process-details
NOTE: This endpoint will be deprecated by Microsoft on January 31, 2027. We recommend switching to the Microsoft Graph Security Integration and using the msg-advanced-hunting command. For more information, see the Microsoft documentation
Detects process details. When you select a “query_purpose” argument, a designated query template is used.
Base Command
microsoft-atp-advanced-hunting-process-details
Input
| Argument Name | Description | Required |
|---|---|---|
| query_purpose | When you select a “query_purpose” argument, a designated query template is used. “parent_process” - Parent process. “grandparent_process” - Grandparent process. “process_details” - Process hash, path, signature details. “beaconing_evidence” - Does the process appear to be beaconing? “powershell_execution_unsigned_files” - Has the file executed PowerShell? Query without specifying processes. No additional arguments are required. “process_excecution_powershell” - Has the file executed PowerShell?. Possible values are: parent_process, grandparent_process, process_details, beaconing_evidence, powershell_execution_unsigned_files, process_excecution_powershell. | Required |
| device_name | Device name to look for. | Optional |
| file_name | File name to look for. | Optional |
| sha1 | SHA1 hash to look for. | Optional |
| sha256 | SHA256 hash to look for. | Optional |
| md5 | MD5 hash to look for. | Optional |
| device_id | Device ID to look for. | Optional |
| query_operation | Query operator to use with provided arguments. Possible values are: or, and. Default is or. | Optional |
| limit | Maximum number of results to retrieve. Default is 50. | Optional |
| time_range | Time range to look back. Expected syntax is a human readable time range, e.g. 60 minutes, 6 hours, 1 day, etc. | Optional |
| timeout | The amount of time (in seconds) that a request waits for the query response before a timeout occurs. Default is 10. | Optional |
| page | The page number from which to start a search. Default is 1. | Optional |
| show_query | Show the query as part of the entry result. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.HuntProcessDetails.Result.parent_process | String | The query results for parent_process query_purpose. |
| MicrosoftATP.HuntProcessDetails.Result.grandparent_process | String | The query results for grandparent_process query_purpose. |
| MicrosoftATP.HuntProcessDetails.Result.process_details | String | The query results for process_details query_purpose. |
| MicrosoftATP.HuntProcessDetails.Result.beaconing_evidence | String | The query results for beaconing_evidence query_purpose. |
| MicrosoftATP.HuntProcessDetails.Result.powershell_execution_unsigned_files | String | The query results for powershell_execution_unsigned_files query_purpose. |
| MicrosoftATP.HuntProcessDetails.Result.process_excecution_powershell | String | The query results for process_excecution_powershell query_purpose. |
Command example
!microsoft-atp-advanced-hunting-process-details query_purpose=beaconing_evidence file_name=powershell device_name=desktop query_operation=and
Context Example
{
"MicrosoftATP": {
"HuntProcessDetails": {
"Result": {
"beaconing_evidence": [
{
"ActionType": "ConnectionSuccess",
"DeviceId": "deviceid_2",
"DeviceName": "devicename_2",
"InitiatingProcessFileName": "powershell.exe",
"InitiatingProcessMD5": "md5",
"InitiatingProcessSHA1": "sha1",
"InitiatingProcessSHA256": "sha256",
"LocalIP": "ip1",
"LocalIPType": "Private",
"LocalPort": 49169,
"Protocol": "Tcp",
"RemoteIP": "ip3",
"RemoteIPType": "Public",
"RemotePort": 443,
"RemoteUrl": "winatp-gw-eus.microsoft.com",
"Timestamp": "2022-03-15T20:38:30.5393171Z"
},
{
"ActionType": "ConnectionSuccess",
"DeviceId": "deviceid",
"DeviceName": "devicename_1",
"InitiatingProcessFileName": "powershell.exe",
"InitiatingProcessMD5": "md5",
"InitiatingProcessSHA1": "sha1",
"InitiatingProcessSHA256": "sha256",
"LocalIP": "ip2",
"LocalIPType": "Private",
"LocalPort": 52110,
"Protocol": "Tcp",
"RemoteIP": "ip3",
"RemoteIPType": "Public",
"RemotePort": 443,
"RemoteUrl": "winatp-gw-eus.microsoft.com",
"Timestamp": "2022-03-15T15:33:29.0892401Z"
}
]
}
}
}
}
Human Readable Output
Process Details Hunt (beaconing_evidence) Results
ActionType DeviceId DeviceName InitiatingProcessFileName InitiatingProcessMD5 InitiatingProcessSHA1 InitiatingProcessSHA256 LocalIP LocalIPType LocalPort Protocol RemoteIP RemoteIPType RemotePort RemoteUrl Timestamp ConnectionSuccess deviceid_2 devicename_2 powershell.exe md5 sha1 sha256 ip1 Private 49169 Tcp ip3 Public 443 winatp-gw-eus.microsoft.com 2022-03-15T20:38:30.5393171Z ConnectionSuccess deviceid devicename_1 powershell.exe md5 sha1 sha256 ip2 Private 52110 Tcp ip3 Public 443 winatp-gw-eus.microsoft.com 2022-03-15T15:33:29.0892401Z
microsoft-atp-advanced-hunting-network-connections
NOTE: This endpoint will be deprecated by Microsoft on January 31, 2027. We recommend switching to the Microsoft Graph Security Integration and using the msg-advanced-hunting command. For more information, see the Microsoft documentation
Detects network connections. When you select a “query_purpose” argument, a designated query template is used.
Base Command
microsoft-atp-advanced-hunting-network-connections
Input
| Argument Name | Description | Required |
|---|---|---|
| query_purpose | When you select a “query_purpose” argument, a designated query template is used. “external_addresses” - Network connections to external addresses. “dns_query” - DNS query. Query by providing hash or filename or specific processes. At least one of file arguments (file_name, sha1, sha256, md5) is required and one of device arguments (device_name, device_id). “encoded_commands” - Are there commands with base 64 encoding? Only device arguments are required (device_name, device_id), at least one. Possible values are: external_addresses, dns_query, encoded_commands. | Required |
| device_name | Device name to look for. | Optional |
| file_name | File name to look for. | Optional |
| sha1 | SHA1 hash to look for. | Optional |
| sha256 | SHA256 hash to look for. | Optional |
| md5 | MD5 hash to look for. | Optional |
| device_id | Device ID to look for. | Optional |
| query_operation | Query operator to use with provided arguments. Possible values are: or, and. Default is or. | Optional |
| limit | Maximum number of results to retrieve. Default is 50. | Optional |
| time_range | Time range to look back. Expected syntax is a human readable time range, e.g. 60 minutes, 6 hours, 1 day, etc. | Optional |
| timeout | The amount of time (in seconds) that a request waits for the query response before a timeout occurs. Default is 10. | Optional |
| page | The page number from which to start a search. Default is 1. | Optional |
| show_query | Show the query as part of the entry result. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.HuntNetworkConnections.Result.external_addresses | String | The query results for external_addresses query_purpose. |
| MicrosoftATP.HuntNetworkConnections.Result.dns_query | String | The query results for dns_query query_purpose. |
| MicrosoftATP.HuntNetworkConnections.Result.encoded_commands | String | The query results for encoded_commands query_purpose. |
Command example
!microsoft-atp-advanced-hunting-network-connections query_purpose=dns_query device_name=devicename_1,devicename_2
Context Example
{
"MicrosoftATP": {
"HuntNetworkConnections": {
"Result": {
"dns_query": [
{
"ActionType": "NetworkSignatureInspected",
"DeviceName": "devicename_2",
"Packetinfo": "{\"SignatureName\":\"DNS_Request\",\"SignatureMatchedContent\":\"h%D4%01%00%00%01%00%00%00%00%00%00%05ctldl%0Dwindowsupdate%03com\",\"SamplePacketContent\":\"[\\\"h%D4%01%00%00%01%00%00%00%00%00%00%05ctldl%0Dwindowsupdate%03com%00%00%01%00%01\\\"]\"}",
"RemoteIP": "8.8.8.8",
"Timestamp": "2022-03-15T20:01:20.3307099Z"
},
{
"ActionType": "NetworkSignatureInspected",
"DeviceName": "devicename_2",
"Packetinfo": "{\"SignatureName\":\"DNS_Request\",\"SignatureMatchedContent\":\"%B0%C5%01%00%00%01%00%00%00%00%00%00%06us-v20%06events%04data%09microsoft%03com\",\"SamplePacketContent\":\"[\\\"%B0%C5%01%00%00%01%00%00%00%00%00%00%06us-v20%06events%04data%09microsoft%03com%00%00%01%00%01\\\"]\"}",
"RemoteIP": "8.8.8.8",
"Timestamp": "2022-03-15T20:01:20.3327319Z"
}
]
}
}
}
}
Human Readable Output
Network Connections Hunt (dns_query) Results
ActionType DeviceName Packetinfo RemoteIP Timestamp NetworkSignatureInspected devicename_2 {“SignatureName”:”DNS_Request”,”SignatureMatchedContent”:”h%D4%01%00%00%01%00%00%00%00%00%00%05ctldl%0Dwindowsupdate%03com”,”SamplePacketContent”:”["h%D4%01%00%00%01%00%00%00%00%00%00%05ctldl%0Dwindowsupdate%03com%00%00%01%00%01"]”} 8.8.8.8 2022-03-15T20:01:20.3307099Z NetworkSignatureInspected devicename_2 {“SignatureName”:”DNS_Request”,”SignatureMatchedContent”:”%B0%C5%01%00%00%01%00%00%00%00%00%00%06us-v20%06events%04data%09microsoft%03com”,”SamplePacketContent”:”["%B0%C5%01%00%00%01%00%00%00%00%00%00%06us-v20%06events%04data%09microsoft%03com%00%00%01%00%01"]”} 8.8.8.8 2022-03-15T20:01:20.3327319Z
microsoft-atp-advanced-hunting-cover-up
NOTE: This endpoint will be deprecated by Microsoft on January 31, 2027. We recommend switching to the Microsoft Graph Security Integration and using the msg-advanced-hunting command. For more information, see the Microsoft documentation
Detects cover up actions. When you select a “query_purpose” argument, a designated query template is used.
Base Command
microsoft-atp-advanced-hunting-cover-up
Input
| Argument Name | Description | Required |
|---|---|---|
| query_purpose | When you select a “query_purpose” argument, a designated query template is used. “file_deleted” - Did the file delete itself? “event_log_cleared” - Was the event log cleared? Requires at least one of device arguments (device_name/device_id). “compromised_information” - Information on a compromised user and Its activities Requires only username argument. “connected_devices” - All connected devices by compromised user Requires only username argument. “action_types” - All action types created by a user on each machine Requires only username argument. “common_files” - Most common files associated with a user Requires only username argument. Possible values are: file_deleted, event_log_cleared, compromised_information, connected_devices, action_types, common_files. | Required |
| device_name | Device name to look for. | Optional |
| file_name | File name to look for. | Optional |
| sha1 | SHA1 hash to look for. | Optional |
| sha256 | SHA256 hash to look for. | Optional |
| md5 | MD5 hash to look for. | Optional |
| device_id | Device ID to look for. | Optional |
| username | Username to look for in relevant query types. | Optional |
| query_operation | Query operator to use with provided arguments. Possible values are: or, and. Default is or. | Optional |
| limit | Maximum number of results to retrieve. Default is 50. | Optional |
| time_range | Time range to look back. Expected syntax is a human readable time range, e.g. 60 minutes, 6 hours, 1 day, etc. | Optional |
| timeout | The amount of time (in seconds) that a request waits for the query response before a timeout occurs. Default is 10. | Optional |
| page | The page number from which to start a search. Default is 1. | Optional |
| show_query | Show the query as part of the entry result. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.HuntCoverUp.Result.file_deleted | String | The query results for file_deleted query_purpose. |
| MicrosoftATP.HuntCoverUp.Result.event_log_cleared | String | The query results for event_log_cleared query_purpose. |
| MicrosoftATP.HuntCoverUp.Result.compromised_information | String | The query results for compromised_information query_purpose. |
| MicrosoftATP.HuntCoverUp.Result.connected_devices | String | The query results for connected_devices query_purpose. |
| MicrosoftATP.HuntCoverUp.Result.action_types | String | The query results for action_types query_purpose. |
| MicrosoftATP.HuntCoverUp.Result.common_files | String | The query results for common_files query_purpose. |
Command example
!microsoft-atp-advanced-hunting-cover-up query_purpose=file_deleted file_name=chrome device_name=desktop query_operation=and
Context Example
{
"MicrosoftATP": {
"HuntCoverUp": {
"Result": {
"file_deleted": [
{
"DeviceId": "deviceid",
"DeviceName": "devicename_1",
"FileName": "old_chrome_proxy.exe",
"FolderPath": "C:\\Program Files\\Google\\Chrome\\Temp\\scoped_dir9640_1501542081",
"InitiatingProcessCommandLine": "\"setup.exe\" --rename-chrome-exe --system-level --verbose-logging --channel=stable",
"InitiatingProcessFileName": "setup.exe",
"InitiatingProcessVersionInfoProductName": "Google Chrome Installer",
"Timestamp": "2022-03-10T09:41:21.9388696Z"
},
{
"DeviceId": "deviceid",
"DeviceName": "devicename_1",
"FileName": "old_chrome_proxy.exe",
"FolderPath": "C:\\Program Files\\Google\\Chrome\\Temp\\scoped_dir9640_1501542081",
"InitiatingProcessCommandLine": "\"setup.exe\" --rename-chrome-exe --system-level --verbose-logging --channel=stable",
"InitiatingProcessFileName": "setup.exe",
"InitiatingProcessVersionInfoProductName": "Google Chrome Installer",
"Timestamp": "2022-03-10T09:41:21.9390745Z"
},
{
"DeviceId": "deviceid",
"DeviceName": "devicename_1",
"FileName": "chrome_pwa_launcher.exe",
"FolderPath": "C:\\Program Files\\Google\\Chrome\\Application\\98.0.4758.102",
"InitiatingProcessCommandLine": "\"setup.exe\" --channel=stable --delete-old-versions --system-level --verbose-logging",
"InitiatingProcessFileName": "setup.exe",
"InitiatingProcessVersionInfoProductName": "Google Chrome Installer",
"Timestamp": "2022-03-10T09:41:37.3955125Z"
},
{
"DeviceId": "deviceid",
"DeviceName": "devicename_1",
"FileName": "chrome_pwa_launcher.exe",
"FolderPath": "C:\\Program Files\\Google\\Chrome\\Application\\98.0.4758.102",
"InitiatingProcessCommandLine": "\"setup.exe\" --channel=stable --delete-old-versions --system-level --verbose-logging",
"InitiatingProcessFileName": "setup.exe",
"InitiatingProcessVersionInfoProductName": "Google Chrome Installer",
"Timestamp": "2022-03-10T09:41:37.3957224Z"
},
{
"DeviceId": "deviceid",
"DeviceName": "devicename_1",
"FileName": "99.0.4844.51_98.0.4758.102_chrome_updater.exe",
"FolderPath": "C:\\Program Files (x86)\\Google\\Update\\Install\\{CD86F442-5CCD-4E90-B0AC-36D19A65A0C5}",
"InitiatingProcessCommandLine": "\"GoogleUpdate.exe\" /svc",
"InitiatingProcessFileName": "GoogleUpdate.exe",
"InitiatingProcessVersionInfoProductName": "Google Update",
"Timestamp": "2022-03-08T13:29:06.7875767Z"
},
{
"DeviceId": "deviceid",
"DeviceName": "devicename_1",
"FileName": "99.0.4844.51_98.0.4758.102_chrome_updater.exe",
"FolderPath": "C:\\Program Files (x86)\\Google\\Update\\Install\\{CD86F442-5CCD-4E90-B0AC-36D19A65A0C5}",
"InitiatingProcessCommandLine": "\"GoogleUpdate.exe\" /svc",
"InitiatingProcessFileName": "GoogleUpdate.exe",
"InitiatingProcessVersionInfoProductName": "Google Update",
"Timestamp": "2022-03-08T13:29:06.7877821Z"
}
]
}
}
}
}
Human Readable Output
Cover Up Hunt (file_deleted) Results
DeviceId DeviceName FileName FolderPath InitiatingProcessCommandLine InitiatingProcessFileName InitiatingProcessVersionInfoProductName Timestamp deviceid devicename_1 old_chrome_proxy.exe C:\Program Files\Google\Chrome\Temp\scoped_dir9640_1501542081 “setup.exe” –rename-chrome-exe –system-level –verbose-logging –channel=stable setup.exe Google Chrome Installer 2022-03-10T09:41:21.9388696Z deviceid devicename_1 old_chrome_proxy.exe C:\Program Files\Google\Chrome\Temp\scoped_dir9640_1501542081 “setup.exe” –rename-chrome-exe –system-level –verbose-logging –channel=stable setup.exe Google Chrome Installer 2022-03-10T09:41:21.9390745Z deviceid devicename_1 chrome_pwa_launcher.exe C:\Program Files\Google\Chrome\Application\98.0.4758.102 “setup.exe” –channel=stable –delete-old-versions –system-level –verbose-logging setup.exe Google Chrome Installer 2022-03-10T09:41:37.3955125Z deviceid devicename_1 chrome_pwa_launcher.exe C:\Program Files\Google\Chrome\Application\98.0.4758.102 “setup.exe” –channel=stable –delete-old-versions –system-level –verbose-logging setup.exe Google Chrome Installer 2022-03-10T09:41:37.3957224Z deviceid devicename_1 99.0.4844.51_98.0.4758.102_chrome_updater.exe C:\Program Files (x86)\Google\Update\Install{CD86F442-5CCD-4E90-B0AC-36D19A65A0C5} “GoogleUpdate.exe” /svc GoogleUpdate.exe Google Update 2022-03-08T13:29:06.7875767Z deviceid devicename_1 99.0.4844.51_98.0.4758.102_chrome_updater.exe C:\Program Files (x86)\Google\Update\Install{CD86F442-5CCD-4E90-B0AC-36D19A65A0C5} “GoogleUpdate.exe” /svc GoogleUpdate.exe Google Update 2022-03-08T13:29:06.7877821Z
Command example
!microsoft-atp-advanced-hunting-cover-up query_purpose=event_log_cleared device_name=devicename_1
Context Example
{
"MicrosoftATP": {
"HuntCoverUp": {
"Result": {
"event_log_cleared": [
{
"ClearedLogList": [
"\"wevtutil.exe\" clear-log System",
"\"wevtutil.exe\" cl System"
],
"DeviceId": "deviceid",
"DeviceName": "devicename_1",
"FileName": "wevtutil.exe",
"InitiatingProcessFileName": "powershell.exe",
"LogClearCount": 2,
"Timestamp": "2022-03-09T07:15:00Z"
}
]
}
}
}
}
Human Readable Output
Cover Up Hunt (event_log_cleared) Results
ClearedLogList DeviceId DeviceName FileName InitiatingProcessFileName LogClearCount Timestamp “wevtutil.exe” clear-log System,
“wevtutil.exe” cl Systemdeviceid devicename_1 wevtutil.exe powershell.exe 2 2022-03-09T07:15:00Z
Command example
!microsoft-atp-advanced-hunting-cover-up query_purpose=compromised_information username=demisto
Context Example
{
"MicrosoftATP": {
"HuntCoverUp": {
"Result": {
"compromised_information": [
{
"ActionType": "LogonSuccess",
"DeviceId": "deviceid",
"DeviceName": "devicename_1",
"FileName": "",
"FolderPath": "",
"InitiatingProcessFileName": "lsass.exe",
"MD5": "",
"SHA1": "",
"SHA256": "",
"Timestamp": "2022-03-16T08:05:44.8315718Z"
},
{
"ActionType": "LogonSuccess",
"DeviceId": "deviceid",
"DeviceName": "devicename_1",
"FileName": "",
"FolderPath": "",
"InitiatingProcessFileName": "lsass.exe",
"MD5": "",
"SHA1": "",
"SHA256": "",
"Timestamp": "2022-02-28T12:34:02.8853766Z"
},
{
"ActionType": "LogonSuccess",
"DeviceId": "deviceid",
"DeviceName": "devicename_1",
"FileName": "",
"FolderPath": "",
"InitiatingProcessFileName": "",
"MD5": "",
"SHA1": "",
"SHA256": "",
"Timestamp": "2022-02-28T12:34:02.8855892Z"
},
{
"ActionType": "LogonSuccess",
"DeviceId": "deviceid",
"DeviceName": "devicename_1",
"FileName": "",
"FolderPath": "",
"InitiatingProcessFileName": "lsass.exe",
"MD5": "",
"SHA1": "",
"SHA256": "",
"Timestamp": "2022-02-28T12:34:05.6575357Z"
},
{
"ActionType": "LogonAttempted",
"DeviceId": "deviceid",
"DeviceName": "devicename_1",
"FileName": "",
"FolderPath": "",
"InitiatingProcessFileName": "svchost.exe",
"MD5": "",
"SHA1": "",
"SHA256": "",
"Timestamp": "2022-02-28T12:34:05.7005903Z"
},
{
"ActionType": "LogonFailed",
"DeviceId": "deviceid",
"DeviceName": "devicename_1",
"FileName": "",
"FolderPath": "",
"InitiatingProcessFileName": "",
"MD5": "",
"SHA1": "",
"SHA256": "",
"Timestamp": "2022-03-16T08:05:36.0887779Z"
}
]
}
}
}
}
Human Readable Output
Cover Up Hunt (compromised_information) Results
ActionType DeviceId DeviceName InitiatingProcessFileName Timestamp LogonSuccess deviceid devicename_1 lsass.exe 2022-03-16T08:05:44.8315718Z LogonSuccess deviceid devicename_1 lsass.exe 2022-02-28T12:34:02.8853766Z LogonSuccess deviceid devicename_1 2022-02-28T12:34:02.8855892Z LogonSuccess deviceid devicename_1 lsass.exe 2022-02-28T12:34:05.6575357Z LogonAttempted deviceid devicename_1 svchost.exe 2022-02-28T12:34:05.7005903Z LogonFailed deviceid devicename_1 2022-03-16T08:05:36.0887779Z
microsoft-atp-advanced-hunting-file-origin
NOTE: This endpoint will be deprecated by Microsoft on January 31, 2027. We recommend switching to the Microsoft Graph Security Integration and using the msg-advanced-hunting command. For more information, see the Microsoft documentation
How did the file get on the machine. Possible details are “dropped_file” - Was the file dropped? From where? “created_file” - Created by another File (script, compiled binary). “network_shared” - Shared via network. “execution_chain” - What is the process execution chain.
Base Command
microsoft-atp-advanced-hunting-file-origin
Input
| Argument Name | Description | Required |
|---|---|---|
| device_name | Device name to look for. | Optional |
| file_name | File name to look for. | Optional |
| sha1 | SHA1 hash to look for. | Optional |
| sha256 | SHA256 hash to look for. | Optional |
| md5 | MD5 hash to look for. | Optional |
| device_id | Device ID to look for. | Optional |
| query_operation | Query operator to use with provided arguments. Possible values are: or, and. Default is or. | Optional |
| limit | Maximum number of results to retrieve. Default is 50. | Optional |
| time_range | Time range to look back. Expected syntax is a human readable time range, e.g. 60 minutes, 6 hours, 1 day, etc. | Optional |
| timeout | The amount of time (in seconds) that a request waits for the query response before a timeout occurs. Default is 10. | Optional |
| page | The page number from which to start a search. Default is 1. | Optional |
| show_query | Show the query as part of the entry result. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.HuntFileOrigin.Result | String | The query results. |
microsoft-atp-advanced-hunting-privilege-escalation
NOTE: This endpoint will be deprecated by Microsoft on January 31, 2027. We recommend switching to the Microsoft Graph Security Integration and using the msg-advanced-hunting command. For more information, see the Microsoft documentation
Is there evidence for privilege escalation.
Base Command
microsoft-atp-advanced-hunting-privilege-escalation
Input
| Argument Name | Description | Required |
|---|---|---|
| device_name | Device name to look for. | Optional |
| device_id | Device ID to look for. | Optional |
| query_operation | Query operator to use with provided arguments. Possible values are: or, and. Default is or. | Optional |
| limit | Maximum number of results to retrieve. Default is 50. | Optional |
| time_range | Time range to look back. Expected syntax is a human readable time range, e.g. 60 minutes, 6 hours, 1 day, etc. | Optional |
| timeout | The amount of time (in seconds) that a request waits for the query response before a timeout occurs. Default is 10. | Optional |
| page | The page number from which to start a search. Default is 1. | Optional |
| show_query | Show the query as part of the entry result. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.HuntPrivilegeEscalation.Result | String | The query results. |
microsoft-atp-advanced-hunting-tampering
NOTE: This endpoint will be deprecated by Microsoft on January 31, 2027. We recommend switching to the Microsoft Graph Security Integration and using the msg-advanced-hunting command. For more information, see the Microsoft documentation
Detect if there was any evidence of MSDE agent/sensor manipulation.
Base Command
microsoft-atp-advanced-hunting-tampering
Input
| Argument Name | Description | Required |
|---|---|---|
| device_name | Device name to look for. | Optional |
| device_id | Device ID to look for. | Optional |
| query_operation | Query operator to use with provided arguments. Possible values are: or, and. Default is or. | Optional |
| limit | Maximum number of results to retrieve. Default is 50. | Optional |
| time_range | Time range to look back. Expected syntax is a human readable time range, e.g. 60 minutes, 6 hours, 1 day, etc. | Optional |
| timeout | The amount of time (in seconds) that a request waits for the query response before a timeout occurs. Default is 10. | Optional |
| page | The page number from which to start a search. Default is 1. | Optional |
| show_query | Show the query as part of the entry result. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.HuntTampering.Result | String | The query results. |
microsoft-atp-live-response-cancel-action
Cancels an action with an unfinished status.
Base Command
microsoft-atp-live-response-cancel-action
Input
| Argument Name | Description | Required |
|---|---|---|
| machine_action_id | Action ID to retrieve status and data for. | Required |
| comment | A comment to associate with the action. | Required |
Context Output
There is no context output for this command.
microsoft-atp-get-machine-users
Retrieves a collection of logged on users on a specific device.
Required Permissions
User.Read.All
Base Command
microsoft-atp-get-machine-users
Input
| Argument Name | Description | Required |
|---|---|---|
| machine_id | A machine ID used for getting logged on users. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.MachineUser.ID | String | The user ID. |
| MicrosoftATP.MachineUser.AccountName | String | The user account name. |
| MicrosoftATP.MachineUser.AccountDomain | String | The domain of the user account. |
| MicrosoftATP.MachineUser.FirstSeen | Date | The first date and time the user has logged on the machine. |
| MicrosoftATP.MachineUser.LastSeen | Date | The last date and time the user has logged on the machine. |
| MicrosoftATP.MachineUser.LogonTypes | String | The logon types of the user on the machine. |
| MicrosoftATP.MachineUser.DomainAdmin | Boolean | True if user is Domain Admin, False otherwise. |
| MicrosoftATP.MachineUser.NetworkUser | Boolean | True if user is network user, False otherwise. |
| MicrosoftATP.MachineUser.MachineID | String | The machine ID. |
Command example
!microsoft-atp-get-machine-users machine_id=0a3250e0693a109f1affc9217be9459028aa8424
Context Example
{
"MicrosoftATP": {
"MachineUser": [
{
"id": "contoso\\user1",
"accountName": "user1",
"accountDomain": "contoso",
"firstSeen": "2019-12-18T08:02:54Z",
"lastSeen": "2020-01-06T08:01:48Z",
"logonTypes": "Interactive",
"isDomainAdmin": true,
"isOnlyNetworkUser": false,
"machineId": "111e6dd8c833c8a052ea231ec1b19adaf497b625"
},
...
]
}
}
Human Readable Output
Microsoft Defender ATP logon users for machine 111e6dd8c833c8a052ea231ec1b19adaf497b625
ID AccountName AccountDomain FirstSeen LastSeen LogonTypes DomainAdmin NetworkUser contoso\user1 user1 contoso 2019-12-18T08:02:54Z 2020-01-06T08:01:48Z Interactive True False
microsoft-atp-get-machine-alerts (Deprecated)
This command has been deprecated. No available replacement.
Retrieves all alerts related to a specific device.
Required Permissions
Alert.ReadWrite.All
Base Command
microsoft-atp-get-machine-alerts
Input
| Argument Name | Description | Required |
|---|---|---|
| machine_id | A machine ID used for getting machine related alerts, e.g. 0a3250e0693a109f1affc9217be9459028aa8424. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.MachineAlerts.ID | String | The alert ID. |
| MicrosoftATP.MachineAlerts.Title | String | The alert title. |
| MicrosoftATP.MachineAlerts.Description | String | The alert description. |
| MicrosoftATP.MachineAlerts.IncidentID | String | The incident ID, if alert belongs to one. |
| MicrosoftATP.MachineAlerts.Severity | String | The alert severtiy. |
| MicrosoftATP.MachineAlerts.Status | String | The alert status. |
| MicrosoftATP.MachineAlerts.Classification | String | The alert classification. |
| MicrosoftATP.MachineAlerts.Category | String | The alert category. |
| MicrosoftATP.MachineAlerts.ThreatFamilyName | String | The alert threat family name. |
| MicrosoftATP.MachineAlerts.MachineID | String | The alerts machine ID. |
Command example
!microsoft-atp-get-machine-alerts machine_id=0a3250e0693a109f1affc9217be9459028aa8424
Context Example
{
"MicrosoftATP": {
"MachineAlerts": [
{
"id": "da637472900382838869_1364969609",
"incidentId": 1126093,
"severity": "Low",
"status": "New",
"category": "Execution",
"classification": null,
"threatFamilyName": null,
"title": "Low-reputation arbitrary code executed by signed executable",
"description": "Binaries signed by Microsoft can be used to run low-reputation arbitrary code. This technique hides the execution of malicious code within a trusted process. As a result, the trusted process might exhibit suspicious behaviors, such as opening a listening port or connecting to a command-and-control (C&C) server.",
"machineId": "111e6dd8c833c8a052ea231ec1b19adaf497b625"
},
...
]
}
}
Human Readable Output
Alerts that are related to machine 111e6dd8c833c8a052ea231ec1b19adaf497b625
ID Title Description IncidentID Severity Status Classification Category ThreatFamilyName MachineID da637472900382838869_1364969609 Low-reputation arbitrary code executed by signed executable Binaries signed by Microsoft can be used to run low-reputation arbitrary code. This technique hides the execution of malicious code within a trusted process. As a result, the trusted process might exhibit suspicious behaviors, such as opening a listening port or connecting to a command-and-control (C&C) server. 1126093 Low New Execution 111e6dd8c833c8a052ea231ec1b19adaf497b625
microsoft-atp-offboard-machine
Offboard a machine from microsoft ATP.
Required Permissions
Machine.Offboard
Base Command
microsoft-atp-offboard-machine
Input
| Argument Name | Description | Required |
|---|---|---|
| machine_id | A comma-separated list of machine IDs to be used for offboarding. e.g., 0a3250e0693a109f1affc9217be9459028aa8426,0a3250e0693a109f1affc9217be9459028aa8424. | Required |
| comment | A comment to associate with the action. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.OffboardMachine.ID | String | The machine action ID. |
| MicrosoftATP.OffboardMachine.Type | String | Type of the machine action. |
| MicrosoftATP.OffboardMachine.Scope | Unknown | Scope of the action. |
| MicrosoftATP.OffboardMachine.Requestor | String | The ID of the user that executed the action. |
| MicrosoftATP.OffboardMachine.RequestorComment | String | Comment that was written when issuing the action. |
| MicrosoftATP.OffboardMachine.Status | String | The current status of the command. |
| MicrosoftATP.OffboardMachine.MachineID | String | The machine ID on which the action was executed. |
| MicrosoftATP.OffboardMachine.ComputerDNSName | String | The machine DNS name on which the action was executed. |
| MicrosoftATP.OffboardMachine.CreationDateTimeUtc | Date | The date and time when the action was created. |
| MicrosoftATP.OffboardMachine.LastUpdateTimeUtc | Date | The last date and time when the action status was updated. |
| MicrosoftATP.OffboardMachine.cancellationDateTimeUtc | Date | The date and time when the action was canceled. |
| MicrosoftATP.OffboardMachine.RelatedFileInfo | String | The file info. |
| MicrosoftATP.OffboardMachine.troubleshootInfo | String | Troubleshooting information. |
Command example
!microsoft-atp-offboard-machine comment="Testing Offboarding" machine_id="12342c13fef"
Context Example
{
"MicrosoftATP": {
"MachineAction": [
{
"cancellationDateTimeUtc": null,
"computerDnsName": "desktop-s2455r8",
"creationDateTimeUtc": "2022-07-12T14:19:55.4872498Z",
"id": "947a677a-a11a-4240-ab6q-91277e2386b9",
"lastUpdateDateTimeUtc": "2022-07-12T14:19:55.4872521Z",
"machineId": null,
"relatedFileInfo": null,
"requestor": "2f48b784-5da5-4e61-9957-012d2630f1e4",
"requestorComment": "Testing Offboarding",
"scope": null,
"status": "Pending",
"troubleshootInfo": null,
"type": "Offboard"
}
]
}
}
Human Readable Output
The offboarding request has been submitted successfully
ID Type Requestor RequestorComment Status MachineID ComputerDNSName 947a677a-a11a-4240-ab6q-91277e2386b9 Offboard 2f48b784-5da5-4e61-9957-012d2630f1e4 offboard test Pending 12342c13fef desktop-s2455r8
=======
microsoft-atp-request-and-download-investigation-package
Collect and download an investigation package as a gz file.
Base Command
microsoft-atp-request-and-download-investigation-package
Input
| Argument Name | Description | Required |
|---|---|---|
| machine_id | The machine ID. | Required |
| comment | A comment to associate with the action. | Required |
| timeout_in_seconds | Timeout for polling. | Optional |
| machine_action_id | Action ID to retrieve status and data for. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.MachineAction.ID | String | The machine action ID. |
| MicrosoftATP.MachineAction.Status | String | The current status of the machine action. |
| MicrosoftATP.MachineAction.MachineID | String | The machine ID on which the action was executed. |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.MachineAction.ID | String | The machine action ID. |
| MicrosoftATP.MachineAction.Type | String | Type of the machine action. |
| MicrosoftATP.MachineAction.Scope | Unknown | Scope of the action. |
| MicrosoftATP.MachineAction.Requestor | String | The ID of the user that executed the action. |
| MicrosoftATP.MachineAction.RequestorComment | String | Comment that was written when issuing the action. |
| MicrosoftATP.MachineAction.Status | String | The current status of the command. |
| MicrosoftATP.MachineAction.MachineID | String | The machine ID on which the action was executed. |
| MicrosoftATP.MachineAction.ComputerDNSName | String | The machine DNS name on which the action was executed. |
| MicrosoftATP.MachineAction.CreationDateTimeUtc | Date | The date and time when the action was created. |
| MicrosoftATP.MachineAction.LastUpdateTimeUtc | Date | The last date and time when the action status was updated. |
| MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifier | String | The file identifier. |
| MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifierType | String | The type of the file identifier. Possible values: “SHA1” ,”SHA256”, and “MD5”. |
Command example
!microsoft-atp-isolate-machine comment=isolate_test_3 isolation_type=Full machine_id="12342c13fef,12342c13fef8f06606"
Context Example
{
"MicrosoftATP": {
"MachineAction": [
{
"ComputerDNSName": "desktop-s2455r8",
"CreationDateTimeUtc": "2022-01-25T14:25:52.6227941Z",
"ID": "1f3098e20464",
"LastUpdateTimeUtc": null,
"MachineID": "12342c13fef",
"RelatedFileInfo": {
"FileIdentifier": null,
"FileIdentifierType": null
},
"Requestor": "2f48b784-5da5-4e61-9957-012d2630f1e4",
"RequestorComment": "isolate_test_3",
"Scope": "Full",
"Status": "Pending",
"Type": "Isolate"
},
{
"ComputerDNSName": "desktop-s2455r9",
"CreationDateTimeUtc": "2022-01-25T14:25:53.2395007Z",
"ID": "6d39a3da0744",
"LastUpdateTimeUtc": null,
"MachineID": "12342c13fef8f06606",
"RelatedFileInfo": {
"FileIdentifier": null,
"FileIdentifierType": null
},
"Requestor": "2f48b784-5da5-4e61-9957-012d2630f1e4",
"RequestorComment": "isolate_test_3",
"Scope": "Full",
"Status": "Pending",
"Type": "Isolate"
}
]
}
}
Human Readable Output
The isolation request has been submitted successfully
ID Type Requestor RequestorComment Status MachineID ComputerDNSName 1f3098e20464 Isolate 2f48b784-5da5-4e61-9957-012d2630f1e4 isolate_test_3 Pending 12342c13fef desktop-s2455r8 6d39a3da0744 Isolate 2f48b784-5da5-4e61-9957-012d2630f1e4 isolate_test_3 Pending 12342c13fef8f06606 desktop-s2455r9
microsoft-atp-test
Tests connectivity to Microsoft Defender for Endpoint.
Base Command
microsoft-atp-test
Input
There are no input arguments for this command.
Context Output
There is no context output for this command.
microsoft-atp-list-software
Retrieves the organization software inventory.
Base Command
microsoft-atp-list-software
Input
| Argument Name | Description | Required |
|---|---|---|
| id | Software ID. | Optional |
| name | Software name. | Optional |
| vendor | Software publisher name. | Optional |
| limit | Maximum number of results to retrieve. Default is 50. | Optional |
| offset | The number of items in the queried collection that are to be skipped and not included in the result. Default is 0. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.Software.id | String | Software ID. |
| MicrosoftATP.Software.name | String | Software name. |
| MicrosoftATP.Software.vendor | String | Software publisher name. |
| MicrosoftATP.Software.weaknesses | Number | Number of discovered vulnerabilities. |
| MicrosoftATP.Software.publicExploit | Boolean | Whether a public exploit exists for some of the vulnerabilities. |
| MicrosoftATP.Software.activeAlert | Boolean | Whether an active alert is associated with this software. |
| MicrosoftATP.Software.exposedMachines | Number | Number of exposed devices. |
| MicrosoftATP.Software.installedMachines | Number | The number of installed machines. |
| MicrosoftATP.Software.impactScore | Number | Exposure score impact of this software. |
| MicrosoftATP.Software.isNormalized | Boolean | Whether the software is normalized. |
| MicrosoftATP.Software.category | String | Software category. |
| MicrosoftATP.Software.distributions | String | Software distributions. |
Command example
!microsoft-atp-list-software id=some_id
Context Example
{
"MicrosoftATP": {
"Software": {
"activeAlert": false,
"category": "",
"distributions": [],
"exposedMachines": 0,
"id": "some_id",
"impactScore": 0,
"installedMachines": 1,
"isNormalized": false,
"name": "some_name",
"publicExploit": false,
"vendor": "some_vendor",
"weaknesses": 0
}
}
}
Human Readable Output
Microsoft Defender ATP list software
id name vendor weaknesses activeAlert exposedMachines installedMachines publicExploit some_id some_name some_vendor 0 false 0 1 false
microsoft-atp-list-software-version-distribution
Retrieves a list of your organization’s software version distribution.
Base Command
microsoft-atp-list-software-version-distribution
Input
| Argument Name | Description | Required |
|---|---|---|
| id | Software ID. Use the !microsoft-atp-list-software command to get the ID. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.SoftwareVersion.version | String | Version number |
| MicrosoftATP.SoftwareVersion.installations | Number | Installations number. |
| MicrosoftATP.SoftwareVersion.vulnerabilities | Number | Number of vulnerabilities. |
Command example
!microsoft-atp-list-software-version-distribution id=some_id
Context Example
{
"MicrosoftATP": {
"SoftwareVersion": [
{
"installations": 2,
"version": "7.0.2.0",
"vulnerabilities": 7
},
{
"installations": 1,
"version": "6.2.4.0",
"vulnerabilities": 0
}
]
}
}
Human Readable Output
Microsoft Defender ATP software version distribution
version installations vulnerabilities 7.0.2.0 2 7 6.2.4.0 1 0
microsoft-atp-list-machines-by-software
Retrieve a list of device references that has this software installed.
Base Command
microsoft-atp-list-machines-by-software
Input
| Argument Name | Description | Required |
|---|---|---|
| id | Software ID. Use the !microsoft-atp-list-software command to get the ID. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.SoftwareMachine.id | String | Machine identity. |
| MicrosoftATP.SoftwareMachine.computerDnsName | String | Machine fully qualified name. |
| MicrosoftATP.SoftwareMachine.osPlatform | String | Operating system platform. |
| MicrosoftATP.SoftwareMachine.rbacGroupName | String | Machine group name. |
| MicrosoftATP.SoftwareMachine.rbacGroupId | Number | Machine group ID. |
Command example
!microsoft-atp-list-machines-by-software id=some_id
Context Example
{
"MicrosoftATP": {
"SoftwareMachine": [
{
"computerDnsName": "some_dns_name_1",
"id": "1111111111111111111111111111111111111111",
"osPlatform": "WindowsServer2016",
"rbacGroupId": 1111,
"rbacGroupName": "UnassignedGroup"
},
{
"computerDnsName": "some_dns_name_2",
"id": "2222222222222222222222222222222222222222",
"osPlatform": "WindowsServer2016",
"rbacGroupId": 2222,
"rbacGroupName": "UnassignedGroup"
},
{
"computerDnsName": "some_dns_name_3",
"id": "3333333333333333333333333333333333333333",
"osPlatform": "Windows10",
"rbacGroupId": 3333,
"rbacGroupName": "UnassignedGroup"
}
]
}
}
Human Readable Output
Microsoft Defender ATP list machines by software: some_id
id computerDnsName osPlatform rbacGroupName rbacGroupId 1111111111111111111111111111111111111111 some_dns_name_1 WindowsServer2016 UnassignedGroup 1111 2222222222222222222222222222222222222222 some_dns_name_2 WindowsServer2016 UnassignedGroup 2222 3333333333333333333333333333333333333333 some_dns_name_3 Windows10 UnassignedGroup 3333
microsoft-atp-list-vulnerabilities-by-software
Retrieves a list of all the vulnerabilities affecting the organization per software.
Base Command
microsoft-atp-list-vulnerabilities-by-software
Input
| Argument Name | Description | Required |
|---|---|---|
| id | Software ID. Use the !microsoft-atp-list-software command to get the ID. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.SoftwareCVE.id | String | Vulnerability ID. |
| MicrosoftATP.SoftwareCVE.name | String | Vulnerability title. |
| MicrosoftATP.SoftwareCVE.description | String | Vulnerability description. |
| MicrosoftATP.SoftwareCVE.severity | String | Vulnerability severity. Possible values are: “Low”, “Medium”, “High”, “Critical” |
| MicrosoftATP.SoftwareCVE.cvssV3 | Number | CVSS v3 score. |
| MicrosoftATP.SoftwareCVE.exposedMachines | Number | Number of exposed devices. |
| MicrosoftATP.SoftwareCVE.publishedOn | Date | Date when vulnerability was published. Date format will be in ISO 8601 format or relational expressions like “7 days ago”. |
| MicrosoftATP.SoftwareCVE.updatedOn | Date | Date when vulnerability was updated. Date format will be in ISO 8601 format or relational expressions like “7 days ago”. |
| MicrosoftATP.SoftwareCVE.publicExploit | Boolean | Whether a public exploit exists for some of the vulnerabilities. |
| MicrosoftATP.SoftwareCVE.exploitVerified | Boolean | Whether a public exploit exists. |
| MicrosoftATP.SoftwareCVE.exploitInKit | Boolean | Whether the exploit is part of an exploit kit. |
| MicrosoftATP.SoftwareCVE.exploitTypes | String | Exploit impact. Possible values are: “Local privilege escalation”, “Denial of service”, “Local”. |
| MicrosoftATP.SoftwareCVE.exploitUris | String | Exploit source URLs. |
Command example
!microsoft-atp-list-vulnerabilities-by-software id=some_software
Context Example
{
"CVE": [
{
"CVSS": {
"Score": 5.9
},
"Description": "This vulnerability affects the following vendors: vendor_1, vendor_2, vendor_3. To view more details about this vulnerability please visit the vendor website.",
"ID": "CVE-2222-22222",
"Modified": "2021-05-17T22:56:00Z",
"Published": "2021-05-17T22:56:00Z"
}
],
"DBotScore": [
{
"Indicator": "CVE-2222-22222",
"Score": 0,
"Type": "cve",
"Vendor": "some_vendor"
}
],
"MicrosoftATP": {
"SoftwareCVE": [
{
"cvssV3": 5.9,
"description": "This vulnerability affects the following vendors: vendor_1, vendor_2, vendor_3. To view more details about this vulnerability please visit the vendor website.",
"exploitInKit": false,
"exploitTypes": [],
"exploitUris": [],
"exploitVerified": false,
"exposedMachines": 2,
"id": "CVE-2222-22222",
"name": "CVE-2222-22222",
"publicExploit": false,
"publishedOn": "2021-05-17T22:56:00Z",
"severity": "Medium",
"updatedOn": "2021-05-17T22:56:00Z"
}
]
}
}
Human Readable Output
Microsoft Defender ATP vulnerability CCVE-2222-22222 by software: some_software
id name description severity cvssV3 publishedOn updatedOn exposedMachines exploitVerified publicExploit CVE-2222-22222 CVE-2222-22222 This vulnerability affects the following vendors: vendor_1, vendor_2, vendor_3. To view more details about this vulnerability please visit the vendor website. Medium 5.9 2021-05-17T22:56:00Z 2021-05-17T22:56:00Z 2 false false
microsoft-atp-list-vulnerabilities-by-machine
Retrieves a list of all the vulnerabilities affecting the organization per machine.
Base Command
microsoft-atp-list-vulnerabilities-by-machine
Input
| Argument Name | Description | Required |
|---|---|---|
| machine_id | A comma-separated list of machine IDs used for getting the vulnerabilities. | Optional |
| software_id | A comma-separated list of software IDs used for getting the vulnerabilities. | Optional |
| cve_id | A comma-separated list of CVE IDs used for getting the vulnerabilities. | Optional |
| product_name | A comma-separated list of product names used for getting the vulnerabilities. | Optional |
| product_version | A comma-separated list of product versions used for getting the vulnerabilities. | Optional |
| severity | A comma-separated list of vulnerability severities. Possible values are: “Low”, “Medium”, “High”, “Critical”. | Optional |
| product_vendor | A comma-separated list of product vendors used for getting the vulnerabilities. | Optional |
| limit | Maximum number of results to retrieve. Default is 25. | Optional |
| offset | The number of items in the queried collection that are to be skipped and not included in the result. Default is 0. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.MachineCVE.id | String | Vulnerability ID. |
| MicrosoftATP.MachineCVE.cveId | String | CVE ID. |
| MicrosoftATP.MachineCVE.machineId | String | Machine ID. |
| MicrosoftATP.MachineCVE.fixingKbId | Unknown | Fixing Kb ID. |
| MicrosoftATP.MachineCVE.productName | String | Product name. |
| MicrosoftATP.MachineCVE.productVendor | String | Name of the product vendor. |
| MicrosoftATP.MachineCVE.productVersion | String | Product version. |
| MicrosoftATP.MachineCVE.severity | String | Vulnerability severity. Possible values are: “Low”, “Medium”, “High”, “Critical”. |
Command example
!microsoft-atp-list-vulnerabilities-by-machine cve_id=CVE-1111-1111
Context Example
{
"CVE": {
"CVSS": {},
"ID": "1111111111111111111111111111111111111111-_-CVE-1111-1111-_-some_vendor-_-some_name-_-11.11.11.11111111-_-"
},
"DBotScore": {
"Indicator": "1111111111111111111111111111111111111111-_-CVE-1111-1111-_-some_vendor-_-some_name-_-11.11.11.11111111-_-",
"Score": 0,
"Type": "cve",
"Vendor": "Microsoft Defender Advanced Threat Protection"
},
"MicrosoftATP": {
"MachineCVE": {
"cveId": "CVE-1111-1111",
"fixingKbId": null,
"id": "1111111111111111111111111111111111111111-_-CVE-1111-1111-_-some_vendor-_-some_name-_-11.11.11.11111111-_-",
"machineId": "1111111111111111111111111111111111111111",
"productName": "some_name",
"productVendor": "some_vendor",
"productVersion": "11.11.11.11111111",
"severity": "Medium"
}
}
}
Human Readable Output
Microsoft Defender ATP vulnerability CVE-1111-1111
id cveId machineId productName productVendor productVersion severity 1111111111111111111111111111111111111111--CVE-1111-1111--some_vendor--some_name--11.11.11.11111111-_- CVE-1111-1111 1111111111111111111111111111111111111111 some_name some_vendor 11.11.11.11111111 Medium
microsoft-atp-list-vulnerabilities
Retrieves a list of all vulnerabilities.
Base Command
microsoft-atp-list-vulnerabilities
Input
| Argument Name | Description | Required |
|---|---|---|
| id | Vulnerability ID. | Optional |
| name_equal | Vulnerability title. | Optional |
| name_contains | Vulnerability title. Does not work with another filter arguments. | Optional |
| description_contains | Vulnerability description. Does not work with another filter arguments. | Optional |
| published_on | Date when the vulnerability was published. Date format will be in ISO 8601 format or relational expressions like “7 days ago”. | Optional |
| cvss | CVSS v3 score. | Optional |
| severity | A comma-separated list of vulnerability severities. Possible values are: “Low”, “Medium”, “High”, “Critical”. | Optional |
| updated_on | Date when the vulnerability was updated. Date format will be in ISO 8601 format or relational expressions like “7 days ago”. | Optional |
| limit | Maximum number of results to retrieve. Default is 25. | Optional |
| offset | The number of items in the queried collection that are to be skipped and not included in the result. Default is 0. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.Vulnerability.id | String | Vulnerability ID. |
| MicrosoftATP.Vulnerability.name | String | Vulnerability title. |
| MicrosoftATP.Vulnerability.description | String | Vulnerability description. |
| MicrosoftATP.Vulnerability.severity | String | Vulnerability severity. Possible values are: “Low”, “Medium”, “High”, “Critical”. |
| MicrosoftATP.Vulnerability.cvssV3 | Number | CVSS v3 score. |
| MicrosoftATP.Vulnerability.exposedMachines | Number | Number of exposed devices. |
| MicrosoftATP.Vulnerability.publishedOn | Date | Date when the vulnerability was published. Date format will be in ISO 8601 format or relational expressions like “7 days ago”. |
| MicrosoftATP.Vulnerability.updatedOn | Date | Date when the vulnerability was updated. Date format will be in ISO 8601 format or relational expressions like “7 days ago”. |
| MicrosoftATP.Vulnerability.publicExploit | Boolean | Whether the public exploit exists. |
| MicrosoftATP.Vulnerability.exploitVerified | Boolean | Whether the exploit is verified to work. |
| MicrosoftATP.Vulnerability.exploitInKit | Boolean | Whether the exploit is part of an exploit kit. |
| MicrosoftATP.Vulnerability.exploitTypes | String | Exploit impact. Possible values are: “Local privilege escalation”, “Denial of service”, “Local”. |
| MicrosoftATP.Vulnerability.exploitUris | String | Exploit source URLs. |
Command example
!microsoft-atp-list-vulnerabilities id="CVE-1111-1111"
Context Example
{
"CVE": {
"CVSS": {
"Score": 6.5
},
"Description": "some_description.",
"ID": "CVE-1111-1111",
"Modified": "2002-09-10T00:00:00Z",
"Published": "2002-09-10T00:00:00Z"
},
"DBotScore": {
"Indicator": "CVE-1111-1111",
"Score": 0,
"Type": "cve",
"Vendor": "some_vendor"
},
"MicrosoftATP": {
"SoftwareCVE": {
"cvssV3": 6.5,
"description": "some_description.",
"exploitInKit": false,
"exploitTypes": [],
"exploitUris": [],
"exploitVerified": false,
"exposedMachines": 0,
"id": "CVE-1111-1111",
"name": "CVE-1111-1111",
"publicExploit": false,
"publishedOn": "2002-09-10T00:00:00Z",
"severity": "Medium",
"updatedOn": "2002-09-10T00:00:00Z"
}
}
}
Human Readable Output
Microsoft Defender ATP vulnerabilities
id name description severity publishedOn updatedOn exposedMachines exploitVerified publicExploit cvssV3 CVE-1111-1111 CVE-1111-1111 some_description. Medium 2002-09-10T00:00:00Z 2002-09-10T00:00:00Z 0 false false 6.5
microsoft-atp-list-missing-kb-by-software
Retrieves missing KBs (security updates) by software ID.
Base Command
microsoft-atp-list-missing-kb-by-software
Input
| Argument Name | Description | Required |
|---|---|---|
| id | Software ID. Use the !microsoft-atp-list-software command to get the ID. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicMicrosoftATP.SoftwareKB.id | String | Software ID. |
| MicMicrosoftATP.SoftwareKB.name | String | Software name. |
| MicMicrosoftATP.SoftwareKB.osBuild | Number | The operating system build number. |
| MicMicrosoftATP.SoftwareKB.productsNames | String | Product names. |
| MicMicrosoftATP.SoftwareKB.url | String | URL. |
| MicMicrosoftATP.SoftwareKB.machineMissedOn | Number | Machine missed on. |
| MicMicrosoftATP.SoftwareKB.cveAddressed | Number | CVE addressed. |
Command example
!microsoft-atp-list-missing-kb-by-software id=some_id
Context Example
{
"MicrosoftATP": {
"SoftwareKB": [
{
"cveAddressed": 2,
"id": "1111111",
"machineMissedOn": 1,
"name": "some_name_1",
"osBuild": 22222,
"productsNames": [
"some_id"
],
"url": "some_url_1"
},
{
"cveAddressed": 2,
"id": "2222222",
"machineMissedOn": 1,
"name": "some_name_2",
"osBuild": 22222,
"productsNames": [
"some_id"
],
"url": "some_url_2"
},
]
}
}
Human Readable Output
Microsoft Defender ATP missing kb by software: some_id
id name osBuild productsNames url machineMissedOn cveAddressed 1111111 some_name_1 22222 some_id some_url_1 1 2 2222222 some_name_2 22222 some_id some_url_2 1 2
microsoft-atp-generate-login-url
Generate the login url used for Authorization code flow.
Base Command
microsoft-atp-generate-login-url
Input
There are no input arguments for this command.
Context Output
There is no context output for this command.
Command Example
#### Human Readable Output
>### Authorization instructions
>
>1. Click on the [login URL](https://login.microsoftonline.com) to sign in and grant Cortex XSOAR permissions for your Azure Service Management.
You will be automatically redirected to a link with the following structure:
```REDIRECT_URI?code=AUTH_CODE&session_state=SESSION_STATE```
>2. Copy the `AUTH_CODE` (without the `code=` prefix, and the `session_state` parameter)
and paste it in your instance configuration under the **Authorization code** parameter.
### microsoft-atp-auth-reset
***
Run this command if for some reason you need to rerun the authentication process.
#### Base Command
`microsoft-atp-auth-reset`
#### Input
There are no input arguments for this command.
#### Context Output
There is no context output for this command.
### microsoft-atp-get-machine-by-ip
***
Find Machines seen with the requested internal IP in the time range of 15 minutes prior and after a given timestamp.
#### Base Command
`microsoft-atp-get-machine-by-ip`
#### Input
| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| ip | The endpoint IP address. | Required |
| timestamp | The timestamp in witch the machines were seen with the internal ip address, 15 minutes before and after it. The given timestamp must be in the past 30 days. Timestamp format example- 2019-09-22T08:44:05Z. | Required |
| limit | Maximum number of results to return. Default is 50. | Optional |
| all_results | Whether to retrieve all results. If true, the "limit" argument will be ignored. | Optional |
#### Context Output
| **Path** | **Type** | **Description** |
| --- | --- | --- |
| MicrosoftATP.Machine.ID | String | The machine ID. |
| MicrosoftATP.Machine.ComputerDNSName | String | The machine DNS name. |
| MicrosoftATP.Machine.FirstSeen | Date | The first date and time the machine was observed by Microsoft Defender ATP. |
| MicrosoftATP.Machine.LastSeen | Date | The last date and time the machine was observed by Microsoft Defender ATP. |
| MicrosoftATP.Machine.OSPlatform | String | The operating system platform. |
| MicrosoftATP.Machine.OSVersion | String | The operating system version. |
| MicrosoftATP.Machine.OSProcessor | String | The operating system processor. |
| MicrosoftATP.Machine.LastIPAddress | String | The last IP on the machine. |
| MicrosoftATP.Machine.LastExternalIPAddress | String | The last machine IP to access the internet. |
| MicrosoftATP.Machine.OSBuild | Number | The operating system build number. |
| MicrosoftATP.Machine.HealthStatus | String | The machine health status. |
| MicrosoftATP.Machine.RBACGroupID | Number | The machine RBAC group ID. |
| MicrosoftATP.Machine.RBACGroupName | String | The machine RBAC group name. |
| MicrosoftATP.Machine.RiskScore | String | The machine risk score. |
| MicrosoftATP.Machine.ExposureLevel | String | The machine exposure score. |
| MicrosoftATP.Machine.IsAADJoined | Boolean | True if machine is AAD joined, False otherwise. |
| MicrosoftATP.Machine.AADDeviceID | String | The AAD Device ID. |
| MicrosoftATP.Machine.MachineTags | String | Set of machine tags. |
| MicrosoftATP.Machine.IPAddresses.ipAddress | String | The machine IP address. |
| MicrosoftATP.Machine.IPAddresses.MACAddress | String | The machine MAC address. |
| MicrosoftATP.Machine.IPAddresses.operationalStatus | String | The machine operational status. |
| MicrosoftATP.Machine.IPAddresses.type | String | The machine IP address type. |
| MicrosoftATP.Machine.AgentVersion | String | The machine Agent version. |
#### Command example
```!microsoft-atp-get-machine-by-ip ip=8.8.8.8 timestamp=2024-05-23T10:15:00Z```
#### Human Readable Output
>### Microsoft Defender ATP Machine
>
>|ID|ComputerDNSName|OSPlatform|LastIPAddress|LastExternalIPAddress|HealthStatus|RiskScore|ExposureLevel|
>|---|---|---|---|---|---|---|---|
>| f3bba49a | ec2amaz-ua9hieu | WindowsServer2016 | 1.2.3.4 | 127.0.0.1 | Active | None | High |
## Deprecation Details
| **Deprecated Commands** | **Replacement** |
|----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `Fetch incidents` | Use `Fetch incidents` in the `Microsoft Graph Security` integration, and select `Graph Security Alert` under the `Alert type`. |
| `microsoft-atp-create-alert` | No available replacement. |
| `microsoft-atp-get-alert-by-id` | Use `msg-get-alert-details` in the `Microsoft Graph Security` integration instead. |
| `microsoft-atp-get-alert-related-files` | An alternative is to use the `msg-get-alert-details` command in the `Microsoft Graph Security` integration, which can retrieve `fileDetails` as part of the alert details. See Microsoft documentation [here](https://learn.microsoft.com/en-us/graph/api/resources/security-fileevidence?view=graph-rest-1.0). |
| `microsoft-atp-get-alert-related-ips` | An alternative is to use the `msg-get-alert-details` command in the `Microsoft Graph Security` integration, which can retrieve `IpAddress` as part of the alert details. See Microsoft documentation [here](https://learn.microsoft.com/en-us/graph/api/resources/security-ipevidence?view=graph-rest-1.0). |
| `microsoft-atp-get-alert-related-user` | An alternative is to use the `msg-get-alert-details` command in the `Microsoft Graph Security` integration, which can retrieve `userAccount` information as part of the alert details. See Microsoft documentation [here](https://learn.microsoft.com/en-us/graph/api/resources/security-userevidence?view=graph-rest-1.0). |
| `microsoft-atp-get-alert-related-domains` | An alternative is to use the `msg-get-alert-details` command in the `Microsoft Graph Security` integration to retrieve `DomainName` as part of the alert details. See Microsoft documentation [here](https://learn.microsoft.com/en-us/graph/api/resources/security-userevidence?view=graph-rest-1.0). |
| `microsoft-atp-get-domain-alerts` | No available replacement. |
| `microsoft-atp-get-file-alerts` | No available replacement. |
| `microsoft-atp-get-ip-alerts` | No available replacement. |
| `microsoft-atp-get-machine-alerts` | No available replacement. |
| `microsoft-atp-get-user-alerts` | No available replacement. |
| `microsoft-atp-list-alerts` | Use the `msg-search-alerts` command in the `Microsoft Graph Security` integration instead. |
| `microsoft-atp-update-alert` | Use the `msg-update-alert` command in the `Microsoft Graph Security` integration instead. |
| `microsoft-atp-advanced-hunting` | Use the `msg-advanced-hunting` command in the `Microsoft Graph Security` integration instead. |
### microsoft-atp-get-machine-vulnerabilities
***
Run this command to get the vulnerabilities from a specific machine.
#### Base Command
`microsoft-atp-get-machine-vulnerabilities`
#### Input
| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| machine_id | Machine ID. Use the !microsoft-atp-get-machines command to get the ID. | Required |
#### Context Output
| **Path** | **Type** | **Description** |
| --- | --- | --- |
| MicrosoftATP.PublicVulnerability.ID | String | The vulnerability ID. |
| MicrosoftATP.PublicVulnerability.Name | String | The vulnerability name. |
| MicrosoftATP.PublicVulnerability.CVESupportability | String | The CVE supportability. |
| MicrosoftATP.PublicVulnerability.CVSSV3 | Number | The CVSS V3. |
| MicrosoftATP.PublicVulnerability.CVSSVector | String | The CVSS vector. |
| MicrosoftATP.PublicVulnerability.Description | String | A description of this vulnerability. |
| MicrosoftATP.PublicVulnerability.EPSS | Number | The EPSS. |
| MicrosoftATP.PublicVulnerability.ExploitInKit | Boolean | Is this vulnerability in an exploit kit? |
| MicrosoftATP.PublicVulnerability.ExploitTypes | String | The type(s) of exploit(s). |
| MicrosoftATP.PublicVulnerability.ExploitUris | String | The exploit URIs. |
| MicrosoftATP.PublicVulnerability.ExploitVerified | Boolean | Is this exploit verified? |
| MicrosoftATP.PublicVulnerability.ExposedMachines | Number | The amount of machines exposed to this vulnerability. |
| MicrosoftATP.PublicVulnerability.FirstDetected | String | The date and time when this vulnerability was first detected. |
| MicrosoftATP.PublicVulnerability.PublicExploit | Boolean | Does this vulnerability have a public exploit? |
| MicrosoftATP.PublicVulnerability.PublishedOn | String | The date and time when this vulnerability was published. |
| MicrosoftATP.PublicVulnerability.Severity | String | The severity of this vulnerability. |
| MicrosoftATP.PublicVulnerability.Tags | String | The tags associated with this vulnerability. |
| MicrosoftATP.PublicVulnerability.UpdatedOn | String | The date and time when this vulnerability was last updated. |
#### Command example
```!microsoft-atp-get-machine-vulnerabilities machine_id="12342c13fef```
#### Context Example
```json
{
"MicrosoftATP": {
"PublicVulnerability": {
"@odata.context": "https://api.securitycenter.windows.com/api/$metadata#Collection(microsoft.windowsDefenderATP.api.PublicVulnerabilityDto)",
"CVESupportability": "Supported",
"CVSSV3": 3.7,
"CVSSVector": "CVSS:3.0/AV:N/AC:H/PR:N/UI:N/S:U/C:N/I:N/A:L/E:F/RL:O/RC:C",
"Description": "Summary: Foo is vulnerable to a denial of service due to improper server configuration validation.", # noqa: E501
"EPSS": 0,
"ExploitInKit": False,
"ExploitTypes": [
"Remote"
],
"ExploitUris": [],
"ExploitVerified": False,
"ExposedMachines": 1,
"FirstDetected": "20XX-MM-DDThh:mm:ssZ",
"ID": "CVE-20XX-1234",
"Name": "CVE-20XX-1234",
"PublicExploit": False,
"PublishedOn": "20XX-MM-DDThh:mm:ssZ",
"Severity": "Low",
"Tags": [],
"UpdatedOn": "20XX-MM-DDThh:mm:ssZ"
}
}
}
Human Readable Output
Microsoft Defender ATP Vulnerability
ID Name CVESupportability CVSSV3 CVSSVector Description EPSS ExploitInKit ExploitTypes ExploitVerified ExposedMachines FirstDetected PublicExploit PublishedOn Severity UpdatedOn CVE-20XX-1234 CVE-20XX-1234 Supported 3.7 CVSS:3.0/AV:N/AC:H/PR:N/UI:N/S:U/C:N/I:N/A:L/E:F/RL:O/RC:C Summary: Foo is vulnerable to a denial of service due to improper server configuration validation. 0 false Remote false 1 20XX
microsoft-atp-get-machine-software
Run this command to get the sofware installed on a specific machine.
Base Command
microsoft-atp-get-machine-software
Input
| Argument Name | Description | Required |
|---|---|---|
| machine_id | Machine ID. Use the !microsoft-atp-get-machines command to get the ID. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.Software.ID | String | The Software ID. |
| MicrosoftATP.Software.Name | String | The software name. |
| MicrosoftATP.Software.Vendor | String | The software vendor name. |
| MicrosoftATP.Software.Weaknesses | Number | The amount of weaknesses present in the software. |
| MicrosoftATP.Software.PublicExploit | Boolean | Does this software have a public exploit? |
| MicrosoftATP.Software.ActiveAlert | Boolean | Does this software have an active alert? |
| MicrosoftATP.Software.ExposedMachines | Number | The amount of machines exposed to this software. |
| MicrosoftATP.Software.InstalledMachines | Number | The amount of machines with this software installed. |
| MicrosoftATP.Software.ImpactScore | Number | The impact score of the software. |
| MicrosoftATP.Software.IsNormalized | Number | Is the software value normalized? |
| MicrosoftATP.Software.Category | String | The software category. |
| MicrosoftATP.Software.Distributions | String | The distributions on which this software is present. |
Command example
!microsoft-atp-get-machine-software machine_id="12342c13fef
Context Example
{
"MicrosoftATP": {
"Software": {
"@odata.context": "https://api.securitycenter.windows.com/api/$metadata#Software",
"ID": "some_id",
"Name": "some_name",
"Vendor": "some_vendor",
"Weaknesses": 0,
"PublicExploit": false,
"ActiveAlert": false,
"ExposedMachines": 0,
"InstalledMachines": 1,
"ImpactScore": 0,
"IsNormalized": false,
"Category": "",
"Distributions": []
}
}
}
Human Readable Output
Microsoft Defender ATP Software
ID Name Vendor PublicExploit ActiveAlert ExposedMachines InstalledMachines ImpactScore IsNormalized some_id some_name some_vendor false false 0 1 0 false another_id another_name another_vendor true true 0 1 0 false
microsoft-atp-get-machine-missing-kbs
Run this command to get the missing security updates (KBs) from a specific machine.
Base Command
microsoft-atp-get-machine-missing-kbs
Input
| Argument Name | Description | Required |
|---|---|---|
| machine_id | Machine ID. Use the !microsoft-atp-get-machines command to get the ID. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.PublicProductFix.ID | String | Software ID. |
| MicrosoftATP.PublicProductFix.Name | String | Software name. |
| MicrosoftATP.PublicProductFix.ProductsNames | String | The product names. |
| MicrosoftATP.PublicProductFix.URL | String | URL. |
| MicrosoftATP.PublicProductFix.MachineMissedOn | Number | Machine missed on. |
| MicrosoftATP.PublicProductFix.CVEAddressed | Number | CVE addressed. |
| MicrosoftATP.PublicProductFix.OSBuild | String | The OS Build version. |
Command example
!microsoft-atp-get-machine-missing-kbs machine_id="12342c13fef,12342c13fef8f06606
Context Example
{
"MicrosoftATP": {
"PublicProductFix": {
"@odata.context": "https://api.securitycenter.windows.com/api/$metadata#Collection(microsoft.windowsDefenderATP.api.PublicProductFixDto)",
"ID": "1234567",
"Name": "March 20XX Security Updates",
"ProductsNames": [
"windows_10",
"edge",
"internet_explorer"
],
"URL": "https://catalog.update.microsoft.com/v7/site/Search.aspx?q=KB1234567",
"MachineMissedOn": 1,
"CVEAddressed": 97,
"OSBuild": 12345
}
}
}
Human Readable Output
Microsoft Defender ATP Security Update
ID Name OSBuild URL MachineMissedOn CVEAddressed \n — — — — — — 1234567 March 20XX Security Updates 12345 https://catalog.update.microsoft.com/v7/site/Search.aspx?q=KB1234567 1 97
microsoft-atp-list-auth-permissions
This command gets the permissions from the currently configured credentials. Use for debugging and detecting permission issues.
Base Command
microsoft-atp-list-auth-permissions
Input
There are no input arguments for this command.
Context Output
There is no context output for this command.
file
Checks the file reputation of the specified hash.
Base Command
file
Input
| Argument Name | Description | Required |
|---|---|---|
| file | Hash of the file to query. Supports MD5, SHA1, and SHA256. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| MicrosoftATP.File.Sha1 | String | The SHA1 hash of the file. |
| MicrosoftATP.File.MD5 | String | The MD5 hash of the file. |
| MicrosoftATP.File.Sha256 | String | The SHA256 hash of the file. |
| MicrosoftATP.File.GlobalPrevalence | Number | The file prevalence across the organization. |
| MicrosoftATP.File.GlobalFirstObserved | Date | The first time the file was observed. |
| MicrosoftATP.File.GlobalLastObserved | Date | The last time the file was observed. |
| MicrosoftATP.File.Size | Number | The size of the file. |
| MicrosoftATP.File.FileType | String | The type of the file. |
| MicrosoftATP.File.IsPeFile | Boolean | True if the file is portable executable, False otherwise. |
| MicrosoftATP.File.FilePublisher | String | The file’s publisher. |
| MicrosoftATP.File.FileProductName | String | The file product name. |
| MicrosoftATP.File.Signer | String | The file signer. |
| MicrosoftATP.File.Issuer | String | The file issuer. |
| MicrosoftATP.File.SignerHash | String | The hash of the signing certificate. |
| MicrosoftATP.File.IsValidCertificate | Boolean | Was signing certificate successfully verified by Microsoft Defender ATP agent. |
| MicrosoftATP.File.DeterminationValue | String | The file determination value. |
| MicrosoftATP.File.DeterminationType | String | The file determination type. |
| File.SHA1 | String | The SHA1 hash of the file. |
| File.SHA256 | String | The SHA256 hash of the file. |
| File.Type | String | The file type. |
| File.Size | Number | The file size. |
| DBotScore.Indicator | String | The indicator that was tested. |
| DBotScore.Type | String | The indicator type. |
| DBotScore.Vendor | String | The vendor used to calculate the score. |
| DBotScore.Score | Number | The actual score. |
Command example
!file file="1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"
Context Example
{
"MicrosoftATP": {
"File": {
"Sha1": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
"MD5": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
"Sha256": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
"GlobalPrevalence": 1,
"GlobalFirstObserved": "2022-01-01T00:00:00Z",
"GlobalLastObserved": "2022-01-01T00:00:00Z",
"Size": 123456,
"FileType": "PE",
"IsPeFile": true,
"FilePublisher": "Microsoft Corporation",
"FileProductName": "Microsoft Windows",
"Signer": "Microsoft Corporation",
"Issuer": "Microsoft Corporation",
"SignerHash": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
"IsValidCertificate": true,
"DeterminationValue": "Malicious",
"DeterminationType": "MachineLearning",
}
},
"File": {
"SHA1": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
"SHA256": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
"Type": "PE",
"Size": 123456,
},
"DBotScore": {
"Indicator": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
"Type": "hash",
"Vendor": "Microsoft Defender ATP",
"Score": 3
}
}
Human Readable Output
Microsoft Defender ATP File
SHA1 MD5 SHA256 GlobalPrevalence GlobalFirstObserved GlobalLastObserved Size FileType IsPeFile FilePublisher FileProductName Signer Issuer SignerHash IsValidCertificate DeterminationValue DeterminationType 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef 1 2022-01-01T00:00:00Z 2022-01-01T00:00:00Z 123456 PE true Microsoft Corporation Microsoft Windows Microsoft Corporation Microsoft Corporation 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef true Malicious MachineLearning
Configuration parameters
endpoint_type— Endpoint Type_auth_id_encrypted—_tenant_id_encrypted—_auth_id— ID_tenant_id— Tokencredentials—creds_certificate— Certificate Thumbprintcertificate_thumbprint— Certificate Thumbprintprivate_key— Private Keyauth_type— Authentication Typeredirect_uri— Application redirect URI (for authorization code mode)auth_code— Authorization codemanaged_identities_client_id—Reliability— Source ReliabilityisFetch— Fetch incidentsincidentType— Incident typeincidentFetchInterval— Incidents Fetch Intervalfetch_status— Status for fetching alerts as incidents. Comma-separated lists are supported, e.g., New,Resolved.fetch_detectionsource— DetectionSource to filter out alerts for fetching as incidents.fetch_severity— Severity for fetching alerts as incidents. Comma-separated lists are supported, e.g., Medium,High.max_fetch— Maximum number of incidents to fetchurl— Server URL (e.g., https://api.securitycenter.microsoft.com)self_deployed— Use a self-deployed Azure Applicationinsecure— Trust any certificate (not secure)fetch_evidence— Fetch alert evidenceproxy— Use system proxy settingsfirst_fetch_timestamp— First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days)is_gcc— Using Microsoft GCC? (Deprecated)auth_id— ID (received from the admin consent - see Detailed Instructions (?) section) (Deprecated)tenant_id— Token (received from the admin consent - see Detailed Instructions (?) (Deprecated) section)enc_key— Key (received from the admin consent - see Detailed Instructions (?) section) (Deprecated)
Commands (81)
-
endpointGets machines that have communicated with Microsoft Defender for Endpoint cloud. At least one of the following arguments is required - IP, hostname, or ID. Otherwise, an error appears.
-
fileChecks the file reputation of the specified hash.
-
microsoft-atp-add-remove-machine-tagAdds or removes a tag on a specific machine.
-
microsoft-atp-advanced-huntingDeprecatedDeprecated. Use the 'msg-advanced-hunting' command in the 'Microsoft Graph Security' integration instead.
-
microsoft-atp-advanced-hunting-cover-upDetects cover up actions. When you select a “query_purpose” argument, a designated query template is used.
-
microsoft-atp-advanced-hunting-file-originIndicates how the file got on the machine. Possible details are "dropped_file" - Was the file dropped? From where? "created_file" - Created by another File (script, compiled binary). "network_shared" - Shared via network. "execution_chain" - What is the process execution chain.
-
microsoft-atp-advanced-hunting-lateral-movement-evidenceDetects evidence of attempted lateral movement. When you select a “query_purpose” argument, a designated query template is used.
-
microsoft-atp-advanced-hunting-network-connectionsDetects network connections. When you select a “query_purpose” argument, a designated query template is used.
-
microsoft-atp-advanced-hunting-persistence-evidenceDetects evidence of persistence. When you select a “query_purpose” argument, a designated query template is used.
-
microsoft-atp-advanced-hunting-privilege-escalationDetects evidence of privilege escalation.
-
microsoft-atp-advanced-hunting-process-detailsDetects process details. When you select a “query_purpose” argument, a designated query template is used.
-
microsoft-atp-advanced-hunting-tamperingDetects evidence of MSDE agent/sensor manipulation.
-
microsoft-atp-auth-resetRun this command if for some reason you need to rerun the authentication process.
-
microsoft-atp-collect-investigation-packageCollect an investigation package from a machine.
-
microsoft-atp-create-alertDeprecatedDeprecated. No available replacement.
-
microsoft-atp-generate-login-urlGenerate the login url used for Authorization code flow.
-
microsoft-atp-get-alert-by-idDeprecatedDeprecated. Use 'msg-get-alert-details' in the 'Microsoft Graph Security' integration instead.
-
microsoft-atp-get-alert-related-domainsDeprecatedDeprecated. An alternative is to use the 'msg-get-alert-details' command in the 'Microsoft Graph Security' integration to retrieve `DomainName` as part of the alert details.
-
microsoft-atp-get-alert-related-filesDeprecatedDeprecated. An alternative is to use the 'msg-get-alert-details' command in the 'Microsoft Graph Security' integration, which can retrieve `fileDetails` as part of the alert details.
-
microsoft-atp-get-alert-related-ipsDeprecatedDeprecated. An alternative is to use the 'msg-get-alert-details' command in the 'Microsoft Graph Security' integration, which can retrieve `IpAddress` as part of the alert details.
-
microsoft-atp-get-alert-related-userDeprecatedDeprecated. An alternative is to use the 'msg-get-alert-details' command in the 'Microsoft Graph Security' integration, which can retrieve `userAccount` information as part of the alert details.
-
microsoft-atp-get-domain-alertsDeprecatedDeprecated. No available replacement.
-
microsoft-atp-get-domain-machinesRetrieves a collection of machines that have communicated to or from a given domain address.
-
microsoft-atp-get-domain-statisticsRetrieves statistics on the given domain.
-
microsoft-atp-get-file-alertsDeprecatedDeprecated. No available replacement.
-
microsoft-atp-get-file-infoRetrieves file information by a file hash (SHA1 or SHA256).
-
microsoft-atp-get-file-related-machinesGets a collection of machines with a given file SHA1 hash.
-
microsoft-atp-get-file-statisticsRetrieves statistics for the given file.
-
microsoft-atp-get-investigation-package-sas-uriGets a URI that allows downloading an investigation package.
-
microsoft-atp-get-ip-alertsDeprecatedDeprecated. No available replacement.
-
microsoft-atp-get-ip-statisticsRetrieves statistics for a given IP.
-
microsoft-atp-get-machine-alertsDeprecatedDeprecated. No available replacement.
-
microsoft-atp-get-machine-by-ipFind Machines seen with the requested internal IP in the time range of 15 minutes prior and after a given timestamp.
-
microsoft-atp-get-machine-detailsGet a machine's details by its identity.
-
microsoft-atp-get-machine-missing-kbsGet the specific machine's missing security updates (KBs).
-
microsoft-atp-get-machine-softwareGet the specific machine's software details.
-
microsoft-atp-get-machine-usersRetrieves a collection of logged on users on a specific device.
-
microsoft-atp-get-machine-vulnerabilitiesGet the specific machine's vulnerabilities.
-
microsoft-atp-get-machinesRetrieves a collection of machines that communicated with WDATP cloud in the last 30 days. Note - only IP or hostname can be a comma-separated list. If both are given as lists, an error will appear.
-
microsoft-atp-get-user-alertsDeprecatedDeprecated. No available replacement.
-
microsoft-atp-get-user-machinesRetrieves a collection of machines related to a given user ID.
-
microsoft-atp-indicator-batch-updateUpdates a batch of indicators. If an indicator does not exist, a new indicator is created.
-
microsoft-atp-indicator-create-fileDeprecatedDeprecated. Use the microsoft-atp-sc-indicator-create command instead. Creates a file indicator.
-
microsoft-atp-indicator-create-networkDeprecatedDeprecated. Use the microsoft-atp-sc-indicator-create command instead. Creates a network indicator.
-
microsoft-atp-indicator-deleteDeprecatedDeprecated. Use the microsoft-atp-sc-indicator-delete command instead. Deletes the specified indicator.
-
microsoft-atp-indicator-get-by-idDeprecatedDeprecated. Use the microsoft-atp-sc-indicator-get-by-id command instead. Gets an indicator by its ID.
-
microsoft-atp-indicator-listDeprecatedDeprecated. Use the microsoft-atp-sc-indicator-list command instead. Lists all indicators by the ID that the system creates when the indicator is ingested.
-
microsoft-atp-indicator-updateDeprecatedDeprecated. Use the microsoft-atp-sc-indicator-update command instead. Updates the specified indicator.
-
microsoft-atp-isolate-machineIsolates a machine from accessing external networks.
-
microsoft-atp-list-alertsDeprecatedDeprecated. Use the 'msg-search-alerts' command in the 'Microsoft Graph Security' integration instead.
-
microsoft-atp-list-auth-permissionsThis command gets the permissions from the currently configured credentials. Use for debugging and detecting permission issues.
-
microsoft-atp-list-investigationsRetrieves a collection of investigations or retrieves a specific investigation by its ID.
-
microsoft-atp-list-machine-actions-detailsReturn the machine's actions. If you set an action ID, it returns the info on the specific action. Filtering can be done only on one argument.
-
microsoft-atp-list-machines-by-softwareRetrieve a list of device references that has this software installed.
-
microsoft-atp-list-machines-by-vulnerabilityRetrieves a list of machines affected by a vulnerability.
-
microsoft-atp-list-missing-kb-by-softwareRetrieves missing KBs (security updates) by software ID.
-
microsoft-atp-list-softwareRetrieves the organization software inventory.
-
microsoft-atp-list-software-version-distributionRetrieves a list of your organization's software version distribution.
-
microsoft-atp-list-vulnerabilitiesRetrieves a list of all vulnerabilities.
-
microsoft-atp-list-vulnerabilities-by-machineRetrieves a list of all the vulnerabilities affecting the organization per machine.
-
microsoft-atp-list-vulnerabilities-by-softwareRetrieves a list of all the vulnerabilities affecting the organization per software.
-
microsoft-atp-live-response-cancel-actionCancels an action with an unfinished status.
-
microsoft-atp-live-response-get-fileCollects a file from a device. Note: Backslashes in the path must be escaped.
-
microsoft-atp-live-response-put-filePuts a file from the library to the device. Files are saved in a working folder and are deleted when the device restarts by default.
-
microsoft-atp-live-response-resultGets a result file for a specified action.
-
microsoft-atp-live-response-run-scriptRuns a script from the library on a device. The Args parameter is passed to your script. Timeouts after 10 minutes.
-
microsoft-atp-offboard-machineOffboard a machine from Microsoft Defender for Endpoint.
-
microsoft-atp-remove-app-restrictionEnable the execution of any application on the machine.
-
microsoft-atp-request-and-download-investigation-packageCollect and download an investigation package from a machine.
-
microsoft-atp-restrict-app-executionRestricts the execution of all applications on the machine except for a predefined set.
-
microsoft-atp-run-antivirus-scanInitiate a Microsoft Defender Antivirus scan on a machine.
-
microsoft-atp-sc-indicator-createCreates a new indicator.
-
microsoft-atp-sc-indicator-deleteDeletes the specified indicator.
-
microsoft-atp-sc-indicator-get-by-idGets an indicator by its ID.
-
microsoft-atp-sc-indicator-listLists all indicators by the ID that the system creates when the indicator is ingested.
-
microsoft-atp-sc-indicator-updateUpdates the specified indicator.
-
microsoft-atp-start-investigationStarts an automated investigation on a machine.
-
microsoft-atp-stop-and-quarantine-fileStop the execution of a file on a machine and delete it.
-
microsoft-atp-testTests connectivity to Microsoft Defender for Endpoint.
-
microsoft-atp-unisolate-machineUndo an isolation of a machine.
-
microsoft-atp-update-alertDeprecatedDeprecated. Use the 'msg-update-alert' command in the 'Microsoft Graph Security' integration instead.
category: Endpoint provider: Microsoft sectionorder: - Connect - Collect commonfields: id: Microsoft Defender Advanced Threat Protection version: -1 configuration: - defaultvalue: Worldwide display: Endpoint Type name: endpoint_type type: 15 section: Connect additionalinfo: |- When selecting the Custom option, the Server URL parameter must be filled. More information can be found on the integration page - https://xsoar.pan.dev/docs/reference/integrations/microsoft-defender-advanced-threat-protection options: - Worldwide - EU Geo Proximity - UK Geo Proximity - US Geo Proximity - US GCC - US GCC-High - DoD - Custom advanced: true required: false - displaypassword: ID name: _auth_id_encrypted type: 9 hiddenusername: true section: Connect required: false - displaypassword: Token name: _tenant_id_encrypted type: 9 hiddenusername: true section: Connect required: false - display: ID name: _auth_id type: 0 section: Connect required: false hidden: true - display: Token name: _tenant_id type: 0 section: Connect required: false hidden: true - displaypassword: Key section: Connect name: credentials type: 9 hiddenusername: true required: false - display: Certificate Thumbprint name: creds_certificate type: 9 displaypassword: Private Key section: Connect advanced: true required: false - additionalinfo: Used for certificate authentication. As appears in the "Certificates & secrets" page of the app. display: Certificate Thumbprint name: certificate_thumbprint type: 4 hidden: true section: Connect advanced: true required: false - additionalinfo: Used for certificate authentication. The private key of the registered certificate. display: Private Key name: private_key type: 14 hidden: true section: Connect advanced: true required: false - additionalinfo: Type of authentication - either Authorization Code (recommended) or Client Credentials. display: Authentication Type name: auth_type defaultvalue: Client Credentials options: - Authorization Code - Client Credentials - Azure Managed Identities type: 15 section: Connect advanced: true required: false - display: Application redirect URI (for authorization code mode) name: redirect_uri type: 0 section: Connect advanced: true required: false - display: Authorization code displaypassword: Authorization code additionalinfo: for user-auth mode - received from the authorization step. see Detailed Instructions section hiddenusername: true name: auth_code type: 9 section: Connect advanced: true required: false - additionalinfo: The Managed Identities client ID for authentication - relevant only if the integration is running on Azure VM. displaypassword: Azure Managed Identities Client ID name: managed_identities_client_id hiddenusername: true type: 9 section: Connect required: false - name: Reliability additionalinfo: Reliability of the source providing the intelligence data. defaultvalue: B - Usually reliable display: Source Reliability options: - A+ - 3rd party enrichment - A - Completely reliable - B - Usually reliable - C - Fairly reliable - D - Not usually reliable - E - Unreliable - F - Reliability cannot be judged type: 15 section: Collect advanced: true required: false - display: Fetch incidents name: isFetch type: 8 section: Collect required: false supportedModules: - agentix - xsiam - display: Incident type name: incidentType type: 13 section: Connect required: false supportedModules: - agentix - xsiam - display: Incidents Fetch Interval name: incidentFetchInterval defaultvalue: '1' required: false type: 19 section: Collect advanced: true supportedModules: - agentix - xsiam - defaultvalue: New display: 'Status for fetching alerts as incidents. Comma-separated lists are supported, e.g., New,Resolved.' name: fetch_status options: - New - InProgress - Resolved type: 16 section: Collect advanced: true required: false - display: 'DetectionSource to filter out alerts for fetching as incidents.' name: fetch_detectionsource options: - Antivirus - Automated investigation - Custom detection - Custom TI - EDR - Microsoft 365 Defender - Microsoft Defender for Office 365 - Microsoft Defender Experts - SmartScreen - Third-party sensors type: 16 section: Collect advanced: true required: false - defaultvalue: Informational,Low,Medium,High display: 'Severity for fetching alerts as incidents. Comma-separated lists are supported, e.g., Medium,High.' name: fetch_severity type: 16 options: - Informational - Low - Medium - High section: Collect advanced: true required: false - defaultvalue: '50' display: Maximum number of incidents to fetch name: max_fetch type: 0 section: Collect required: false supportedModules: - agentix - xsiam - display: Server URL (e.g., https://api.securitycenter.microsoft.com) name: url type: 0 section: Connect advanced: true defaultvalue: additionalinfo: More information can be found on https://cortex.marketplace.pan.dev/marketplace/details/MicrosoftDefenderAdvancedThreatProtection/ required: false - additionalinfo: Select this checkbox if you are using a self-deployed Azure application. display: Use a self-deployed Azure Application name: self_deployed type: 8 section: Connect advanced: false required: false - display: Trust any certificate (not secure) name: insecure type: 8 section: Connect advanced: true required: false - display: Fetch alert evidence name: fetch_evidence type: 8 section: Collect advanced: true required: false - display: Use system proxy settings name: proxy type: 8 section: Connect advanced: true required: false - defaultvalue: '3 days' display: First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days) name: first_fetch_timestamp type: 0 section: Collect required: false - display: Using Microsoft GCC? (Deprecated) name: is_gcc type: 8 hidden: true section: Connect advanced: true defaultvalue: 'false' required: false - display: ID (received from the admin consent - see Detailed Instructions (?) section) (Deprecated) name: auth_id type: 4 hidden: true section: Connect advanced: true required: false - display: Token (received from the admin consent - see Detailed Instructions (?) (Deprecated) section) name: tenant_id type: 4 hidden: true section: Connect advanced: true required: false - display: Key (received from the admin consent - see Detailed Instructions (?) section) (Deprecated) name: enc_key type: 4 hidden: true section: Connect advanced: true required: false description: Microsoft Defender for Endpoint (previously Microsoft Defender Advanced Threat Protection (ATP)) is a unified platform for preventative protection, post-breach detection, automated investigation, and response. display: Microsoft Defender for Endpoint name: Microsoft Defender Advanced Threat Protection script: commands: - description: Find Machines seen with the requested internal IP in the time range of 15 minutes prior and after a given timestamp. name: microsoft-atp-get-machine-by-ip arguments: - description: The endpoint IP address. name: ip required: true - name: timestamp description: The timestamp in witch the machines were seen with the internal ip address, 15 minutes before and after it. The given timestamp must be in the past 30 days. Timestamp format example- 2019-09-22T08:44:05Z. required: true - name: limit defaultValue: '50' description: Maximum number of results to return. - name: all_results description: Whether to retrieve all results. If true, the "limit" argument will be ignored. defaultValue: false outputs: - contextPath: MicrosoftATP.Machine.ID description: The machine ID. type: String - contextPath: MicrosoftATP.Machine.ComputerDNSName description: The machine DNS name. type: String - contextPath: MicrosoftATP.Machine.FirstSeen description: The first date and time the machine was observed by Microsoft Defender ATP. type: Date - contextPath: MicrosoftATP.Machine.LastSeen description: The last date and time the machine was observed by Microsoft Defender ATP. type: Date - contextPath: MicrosoftATP.Machine.OSPlatform description: The operating system platform. type: String - contextPath: MicrosoftATP.Machine.OSVersion description: The operating system version. type: String - contextPath: MicrosoftATP.Machine.OSProcessor description: The operating system processor. type: String - contextPath: MicrosoftATP.Machine.LastIPAddress description: The last IP on the machine. type: String - contextPath: MicrosoftATP.Machine.LastExternalIPAddress description: The last machine IP to access the internet. type: String - contextPath: MicrosoftATP.Machine.OSBuild description: The operating system build number. type: Number - contextPath: MicrosoftATP.Machine.HealthStatus description: The machine health status. type: String - contextPath: MicrosoftATP.Machine.RBACGroupID description: The machine RBAC group ID. type: Number - contextPath: MicrosoftATP.Machine.RBACGroupName description: The machine RBAC group name. type: String - contextPath: MicrosoftATP.Machine.RiskScore description: The machine risk score. type: String - contextPath: MicrosoftATP.Machine.ExposureLevel description: The machine exposure score. type: String - contextPath: MicrosoftATP.Machine.IsAADJoined description: True if machine is AAD joined, False otherwise. type: Boolean - contextPath: MicrosoftATP.Machine.AADDeviceID description: The AAD Device ID. type: String - contextPath: MicrosoftATP.Machine.MachineTags description: Set of machine tags. type: String - contextPath: MicrosoftATP.Machine.IPAddresses.ipAddress description: The machine IP address. type: String - contextPath: MicrosoftATP.Machine.IPAddresses.MACAddress description: The machine MAC address. type: String - contextPath: MicrosoftATP.Machine.IPAddresses.operationalStatus description: The machine operational status. type: String - contextPath: MicrosoftATP.Machine.IPAddresses.type description: The machine IP address type. type: String - contextPath: MicrosoftATP.Machine.AgentVersion description: The machine Agent version. type: String - arguments: - description: Flag for the rate limit retry. name: ran_once_flag deprecated: true description: Tests connectivity to Microsoft Defender for Endpoint. name: microsoft-atp-test polling: true - arguments: - description: A comma-separated list of machine IDs to be used for isolation. e.g., 0a3250e0693a109f1affc9217be9459028aa8426,0a3250e0693a109f1affc9217be9459028aa8424. isArray: true name: machine_id required: true default: true - description: A comment to associate with the action. name: comment required: true - description: Full isolation or selective isolation. (Restrict only limited set of applications from accessing the network). name: isolation_type auto: PREDEFINED predefined: - Full - Selective required: true - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Isolates a machine from accessing external networks. name: microsoft-atp-isolate-machine outputs: - contextPath: MicrosoftATP.MachineAction.ID description: The machine action ID. type: String - contextPath: MicrosoftATP.MachineAction.Type description: Type of the machine action. type: String - contextPath: MicrosoftATP.MachineAction.Scope description: Scope of the action. type: Unknown - contextPath: MicrosoftATP.MachineAction.Requestor description: The ID of the user that executed the action. type: String - contextPath: MicrosoftATP.MachineAction.RequestorComment description: Comment that was written when issuing the action. type: String - contextPath: MicrosoftATP.MachineAction.Status description: The current status of the command. type: String - contextPath: MicrosoftATP.MachineAction.MachineID description: The machine ID on which the action was executed. type: String - contextPath: MicrosoftATP.MachineAction.ComputerDNSName description: The machine DNS name on which the action was executed. type: String - contextPath: MicrosoftATP.MachineAction.CreationDateTimeUtc description: The date and time when the action was created. type: Date - contextPath: MicrosoftATP.MachineAction.LastUpdateTimeUtc description: The last date and time when the action status was updated. type: Date - contextPath: MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifier description: The file identifier. type: String - contextPath: MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifierType description: 'The type of the file identifier. Possible values: "SHA1" ,"SHA256", and "MD5".' type: String execution: true polling: true compliantpolicies: - EndPoint Isolation - arguments: - description: A comma-separated list of machine IDs to be used to stop the isolation. e.g., 0a3250e0693a109f1affc9217be9459028aa8426,0a3250e0693a109f1affc9217be9459028aa8424. isArray: true name: machine_id required: true - description: Comment to associate with the action. name: comment required: true - description: Flag for the rate limit retry. name: ran_once_flag deprecated: true description: Undo an isolation of a machine. name: microsoft-atp-unisolate-machine outputs: - contextPath: MicrosoftATP.MachineAction.ID description: The machine action ID. type: String - contextPath: MicrosoftATP.MachineAction.Type description: Type of the action. type: String - contextPath: MicrosoftATP.MachineAction.Scope description: Scope of the action. type: Unknown - contextPath: MicrosoftATP.MachineAction.Requestor description: The ID of the user that executed the action. type: String - contextPath: MicrosoftATP.MachineAction.RequestorComment description: The comment that was written when issuing the action. type: String - contextPath: MicrosoftATP.MachineAction.Status description: The current status of the command. type: String - contextPath: MicrosoftATP.MachineAction.MachineID description: The machine ID on which the action was executed. type: String - contextPath: MicrosoftATP.MachineAction.ComputerDNSName description: The machine DNS name on which the action was executed. type: String - contextPath: MicrosoftATP.MachineAction.CreationDateTimeUtc description: The date and time when the action was created. type: Date - contextPath: MicrosoftATP.MachineAction.LastUpdateTimeUtc description: The last date and time when the action status was updated. type: Date - contextPath: MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifier description: The fileIdentifier. type: String - contextPath: MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifierType description: 'The type of the file identifier. Possible values: "SHA1" ,"SHA256", and "MD5".' type: String polling: true compliantpolicies: - EndPoint Isolation - arguments: - description: A comma-separated list of computer DNS name. isArray: true name: hostname - description: A comma-separated list of the last machine IPs to access the internet. name: ip - auto: PREDEFINED description: The machine risk score. isArray: true name: risk_score predefined: - Low - Medium - High - auto: PREDEFINED description: The machine health status. name: health_status predefined: - Active - Inactive - description: The machine's OS platform. Only a single platform can be added. name: os_platform - description: Number of machines to return in a page - must be lower or equal to 10,000. name: page_size defaultValue: '50' - description: The page number to retrieve. defaultValue: '1' name: page_num - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Retrieves a collection of machines that communicated with WDATP cloud in the last 30 days. Note - only IP or hostname can be a comma-separated list. If both are given as lists, an error will appear. name: microsoft-atp-get-machines outputs: - contextPath: MicrosoftATP.Machine.ID description: The machine ID. type: String - contextPath: MicrosoftATP.Machine.ComputerDNSName description: The machine DNS name. type: String - contextPath: MicrosoftATP.Machine.FirstSeen description: The first date and time the machine was observed by Microsoft Defender ATP. type: Date - contextPath: MicrosoftATP.Machine.LastSeen description: The last date and time the machine was observed by Microsoft Defender ATP. type: Date - contextPath: MicrosoftATP.Machine.OSPlatform description: The operating system platform. type: String - contextPath: MicrosoftATP.Machine.OSVersion description: The operating system version. type: String - contextPath: MicrosoftATP.Machine.OSProcessor description: The operating system processor. type: String - contextPath: MicrosoftATP.Machine.LastIPAddress description: The last IP on the machine. type: String - contextPath: MicrosoftATP.Machine.LastExternalIPAddress description: The last machine IP to access the internet. type: String - contextPath: MicrosoftATP.Machine.OSBuild description: The operating system build number. type: Number - contextPath: MicrosoftATP.Machine.HealthStatus description: The machine health status. type: String - contextPath: MicrosoftATP.Machine.RBACGroupID description: The machine RBAC group ID. type: Number - contextPath: MicrosoftATP.Machine.RBACGroupName description: The machine RBAC group name. type: String - contextPath: MicrosoftATP.Machine.RiskScore description: The machine risk score. type: String - contextPath: MicrosoftATP.Machine.ExposureLevel description: The machine exposure score. type: String - contextPath: MicrosoftATP.Machine.IsAADJoined description: True if machine is AAD joined, False otherwise. type: Boolean - contextPath: MicrosoftATP.Machine.AADDeviceID description: The AAD Device ID. type: String - contextPath: MicrosoftATP.Machine.MachineTags description: Set of machine tags. type: String polling: true - arguments: - description: A comma-separated list of file SHA1 hashes to get the related machines. isArray: true name: file_hash required: true - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Gets a collection of machines with a given file SHA1 hash. name: microsoft-atp-get-file-related-machines outputs: - contextPath: MicrosoftATP.FileMachine.Machines.ID description: The machine ID. type: String - contextPath: MicrosoftATP.FileMachine.Machines.ComputerDNSName description: The machine DNS name. type: String - contextPath: MicrosoftATP.FileMachine.Machines.FirstSeen description: The first date and time the machine was observed by Microsoft Defender ATP. type: Date - contextPath: MicrosoftATP.FileMachine.Machines.LastSeen description: The last date and time the machine was observed by Microsoft Defender ATP. type: Date - contextPath: MicrosoftATP.FileMachine.Machines.OSPlatform description: The operating system platform. type: String - contextPath: MicrosoftATP.FileMachine.Machines.OSVersion description: The operating system version. type: String - contextPath: MicrosoftATP.Machine.OSProcessor description: The operating system processor. type: String - contextPath: MicrosoftATP.FileMachine.Machines.OSBuild description: Operating system build number. type: Number - contextPath: MicrosoftATP.FileMachine.Machines.LastIPAddress description: The last IP on the machine. type: String - contextPath: MicrosoftATP.FileMachine.Machines.LastExternalIPAddress description: The last machine IP to access the internet. type: String - contextPath: MicrosoftATP.FileMachine.Machines.HelathStatus description: The machine health status. type: String - contextPath: MicrosoftATP.FileMachine.Machines.RBACGroupID description: The machine RBAC group ID. type: Number - contextPath: MicrosoftATP.FileMachine.Machines.RBACGroupName description: The machine RBAC group name. type: String - contextPath: MicrosoftATP.FileMachine.Machines.RiskScore description: The machine risk score. type: String - contextPath: MicrosoftATP.FileMachine.Machines.ExposureLevel description: The machine exposure score. type: String - contextPath: MicrosoftATP.FileMachine.Machines.IsAADJoined description: True if machine is AAD joined, False otherwise. type: Boolean - contextPath: MicrosoftATP.FileMachine.Machines.AADDeviceID description: The AAD Device ID. type: string - contextPath: MicrosoftATP.FileMachine.Machines.MachineTags description: Set of machine tags. type: String - contextPath: MicrosoftATP.FileMachine.File description: The machine related file hash. type: String polling: true - arguments: - description: A comma-separated list of machine IDs used to get the machine details, e.g., 0a3250e0693a109f1affc9217be9459028aa8426,0a3250e0693a109f1affc9217be9459028aa8424. isArray: true name: machine_id required: true default: true - description: Flag for the rate limit retry. name: ran_once_flag deprecated: true description: Get a machine's details by its identity. name: microsoft-atp-get-machine-details outputs: - contextPath: MicrosoftATP.Machine.ID description: The machine ID. type: String - contextPath: MicrosoftATP.Machine.ComputerDNSName description: The machine DNS name. type: String - contextPath: MicrosoftATP.Machine.FirstSeen description: The first date and time the machine was observed by Microsoft Defender ATP. type: Date - contextPath: MicrosoftATP.Machine.LastSeen description: The last date and time the machine was observed by Microsoft Defender ATP. type: Date - contextPath: MicrosoftATP.Machine.OSPlatform description: The operating system platform. type: String - contextPath: MicrosoftATP.Machine.OSVersion description: The operating system version. type: String - contextPath: MicrosoftATP.Machine.OSProcessor description: The operating system processor. type: String - contextPath: MicrosoftATP.Machine.LastIPAddress description: The last IP on the machine. type: String - contextPath: MicrosoftATP.Machine.LastExternalIPAddress description: The last machine IP to access the internet. type: String - contextPath: MicrosoftATP.Machine.OSBuild description: The operating system build number. type: Number - contextPath: MicrosoftATP.Machine.HealthStatus description: The machine health status. type: String - contextPath: MicrosoftATP.Machine.RBACGroupID description: 'The machine RBAC group ID.' type: Number - contextPath: MicrosoftATP.Machine.RBACGroupName description: The machine RBAC group name. type: String - contextPath: MicrosoftATP.Machine.RiskScore description: The machine risk score. type: String - contextPath: MicrosoftATP.Machine.ExposureLevel description: The machine exposure level. type: String - contextPath: MicrosoftATP.Machine.IsAADJoined description: True if machine is AAD joined, False otherwise. type: Boolean - contextPath: MicrosoftATP.Machine.AADDeviceID description: The AAD Device ID. type: String - contextPath: MicrosoftATP.Machine.MachineTags description: Set of machine tags. type: String - contextPath: MicrosoftATP.Machine.NetworkInterfaces.MACAddress description: MAC Address for the network interface. type: String - contextPath: MicrosoftATP.Machine.NetworkInterfaces.IPAddresses description: IP Address(es) for the network interface. type: String - contextPath: MicrosoftATP.Machine.NetworkInterfaces.Type description: Type of the network interface (e.g. Ethernet). type: String - contextPath: MicrosoftATP.Machine.NetworkInterfaces.Status description: Status for the network interface (e.g. Up, Down). type: String polling: true - arguments: - description: A comma-separated list of machine IDs to run the scan on. name: machine_id isArray: true required: true - description: A comment to associate with the action. name: comment required: true - description: Defines the scan type. name: scan_type auto: PREDEFINED predefined: - Quick - Full required: true - description: Flag for the rate limit retry. name: ran_once_flag deprecated: true description: Initiate a Microsoft Defender Antivirus scan on a machine. name: microsoft-atp-run-antivirus-scan outputs: - contextPath: MicrosoftATP.MachineAction.ID description: The machine action ID. type: String - contextPath: MicrosoftATP.MachineAction.Type description: The type of action. type: String - contextPath: MicrosoftATP.MachineAction.Scope description: The scope of the action. type: Unknown - contextPath: MicrosoftATP.MachineAction.Requestor description: The ID of the user that executed the action. type: String - contextPath: MicrosoftATP.MachineAction.RequestorComment description: The comment that was written when issuing the action. type: String - contextPath: MicrosoftATP.MachineAction.Status description: The current status of the command. type: String - contextPath: MicrosoftATP.MachineAction.MachineID description: The machine ID on which the action was executed. type: String - contextPath: MicrosoftATP.MachineAction.ComputerDNSName description: The machine DNS name on which the action was executed. type: String - contextPath: MicrosoftATP.MachineAction.CreationDateTimeUtc description: The date and time the action was created. type: Date - contextPath: MicrosoftATP.MachineAction.LastUpdateTimeUtc description: The last date and time the action status was updated. type: Date - contextPath: MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifier description: The file identifier. type: String - contextPath: MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifierType description: 'The type of the file identifier. Possible values: "SHA1" ,"SHA256", and "MD5".' type: String polling: true - arguments: - description: Alert severity. name: severity auto: PREDEFINED predefined: - High - Medium - Low - Informational - auto: PREDEFINED description: Alert status. name: status predefined: - New - InProgress - Resolved - description: Alert category; only one can be added. name: category - description: Maximum number of files to display. name: limit defaultValue: '50' - description: The creation timestamp from which to get alerts (<number> <time unit>, e.g., 12 hours, 7 days). name: creation_time - description: Flag for the rate limit retry. name: ran_once_flag deprecated: true description: Deprecated. Use the 'msg-search-alerts' command in the 'Microsoft Graph Security' integration instead. name: microsoft-atp-list-alerts outputs: - contextPath: MicrosoftATP.Alert.ID description: The alert ID. type: String - contextPath: MicrosoftATP.Alert.IncidentID description: The incident ID of the alert. type: Number - contextPath: MicrosoftATP.Alert.InvestigationID description: The investigation ID related to the alert. type: Number - contextPath: MicrosoftATP.Alert.InvestigationState description: The current state of the investigation. type: String - contextPath: MicrosoftATP.Alert.AssignedTo description: The owner of the alert. type: String - contextPath: MicrosoftATP.Alert.Severity description: The severity of the alert. type: String - contextPath: MicrosoftATP.Alert.Status description: The current status of the alert. type: String - contextPath: MicrosoftATP.Alert.Classification description: The alert classification. type: String - contextPath: MicrosoftATP.Alert.Determination description: The determination of the alert. type: String - contextPath: MicrosoftATP.Alert.DetectionSource description: The detection source. type: String - contextPath: MicrosoftATP.Alert.Category description: The category of the alert. type: String - contextPath: MicrosoftATP.Alert.ThreatFamilyName description: The threat family. type: String - contextPath: MicrosoftATP.Alert.Title description: The alert title. type: String - contextPath: MicrosoftATP.Alert.Description description: The alert description. type: String - contextPath: MicrosoftATP.Alert.AlertCreationTime description: The date and time the alert was created. type: Date - contextPath: MicrosoftATP.Alert.FirstEventTime description: The first event time that triggered the alert on that machine. type: Date - contextPath: MicrosoftATP.Alert.LastEventTime description: The last event time that triggered the alert on that machine. type: Date - contextPath: MicrosoftATP.Alert.LastUpdateTime description: The UTC time of the last update. type: Date - contextPath: MicrosoftATP.Alert.ResolvedTime description: The date and time the alert status changed to 'Resolved'. type: Date - contextPath: MicrosoftATP.Alert.MachineID description: The machine ID associated with the alert. type: String - contextPath: MicrosoftATP.Alert.ComputerDNSName description: The machine DNS name. type: String - contextPath: MicrosoftATP.Alert.AADTenantID description: The AAD tenant ID. type: String - contextPath: MicrosoftATP.Alert.Comments.Comment description: The alert comment string. type: String - contextPath: MicrosoftATP.Alert.Comments.CreatedBy description: The alert comment created by string. type: String - contextPath: MicrosoftATP.Alert.Comments.CreatedTime description: The alert comment created time date. type: Date - contextPath: MicrosoftATP.Alert.Evidence description: Evidence related to the alert. type: Unknown - contextPath: MicrosoftATP.Alert.DetectorID description: The ID of the detector that triggered the alert. type: String - contextPath: MicrosoftATP.Alert.ThreatName description: The threat name. type: String - contextPath: MicrosoftATP.Alert.RelatedUser description: Details of the user related to a specific alert. type: String - contextPath: MicrosoftATP.Alert.MitreTechniques description: MITRE Enterprise technique ID. type: String - contextPath: MicrosoftATP.Alert.RBACGroupName description: The device RBAC group name. type: String polling: true deprecated: true - arguments: - description: Alert ID to update. name: alert_id required: true - description: Alert status to update. name: status auto: PREDEFINED predefined: - New - InProgress - Resolved - name: assigned_to description: Owner of the alert. - description: The specification of the alert. name: classification auto: PREDEFINED predefined: - Unknown - FalsePositive - TruePositive - InformationalExpectedActivity - description: |- The determination of the alert. name: determination auto: PREDEFINED predefined: - NotAvailable - Malware - SecurityTesting - UnwantedSoftware - MultiStagedAttack - MaliciousUserActivity - CompromisedAccount - Phishing - LineOfBusinessApplication - ConfirmedActivity - NotMalicious - Other - description: Comment to be added to the alert. name: comment - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: "Deprecated. Use the 'msg-update-alert' command in the 'Microsoft Graph Security' integration instead." name: microsoft-atp-update-alert outputs: - contextPath: MicrosoftATP.Alert.ID description: The alert ID. type: String - contextPath: MicrosoftATP.Alert.IncidentID description: The incident ID of the alert. type: Number - contextPath: MicrosoftATP.Alert.InvestigationID description: The investigation ID related to the alert. type: Number - contextPath: MicrosoftATP.Alert.InvestigationState description: The current state of the investigation. type: String - contextPath: MicrosoftATP.Alert.AssignedTo description: The owner of the alert. type: String - contextPath: MicrosoftATP.Alert.Severity description: The severity of the alert. type: String - contextPath: MicrosoftATP.Alert.Status description: The current status of the alert. type: String - contextPath: MicrosoftATP.Alert.Classification description: The alert classification. type: String - contextPath: MicrosoftATP.Alert.Determination description: The determination of the alert. type: String - contextPath: MicrosoftATP.Alert.DetectionSource description: The detection source. type: String - contextPath: MicrosoftATP.Alert.Category description: The category of the alert. type: String - contextPath: MicrosoftATP.Alert.ThreatFamilyName description: The threat family. type: String - contextPath: MicrosoftATP.Alert.Title description: The alert title. type: String - contextPath: MicrosoftATP.Alert.Description description: The alert description. type: String - contextPath: MicrosoftATP.Alert.AlertCreationTime description: The date and time the alert was created. type: Date - contextPath: MicrosoftATP.Alert.FirstEventTime description: The first event time that triggered the alert on that machine. type: Date - contextPath: MicrosoftATP.Alert.LastEventTime description: The last event time that triggered the alert on that machine. type: Date - contextPath: MicrosoftATP.Alert.LastUpdateTime description: The UTC time of the last update. type: Date - contextPath: MicrosoftATP.Alert.ResolvedTime description: The date and time the alert status changed to 'Resolved'. type: Date - contextPath: MicrosoftATP.Alert.MachineID description: The machine ID associated with the alert. type: String - contextPath: MicrosoftATP.Alert.ComputerDNSName description: The machine DNS name. type: String - contextPath: MicrosoftATP.Alert.AADTenantID description: The AAD tenant ID. type: String - contextPath: MicrosoftATP.Alert.Comments.Comment description: The alert comment string. type: String - contextPath: MicrosoftATP.Alert.Comments.CreatedBy description: The alert comment created by string. type: String - contextPath: MicrosoftATP.Alert.Comments.CreatedTime description: The alert comment created time date. type: Date polling: true deprecated: true - arguments: - description: The query to run. Must be passed if query_batch argument is not provided. name: query default: true - description: The amount of time (in seconds) that a request waits for the query response before a timeout occurs. If specified with query_batch, will be applied to all queries in the array. name: timeout defaultValue: '10' - description: Time range to look back. The expected syntax is a human-readable time range, e.g., 60 minutes, 6 hours, 1 day, etc. If specified with query_batch, applies to all queries in the array. name: time_range defaultValue: '' predefined: - '' - description: Flag for the rate limit retry. name: ran_once_flag deprecated: true - description: |- A JSON array of queries, limited to 10 queries. Cannot be provided with the query argument. Example for input: [{ "query": "query #1", "name": "name #1", "timeout": "timeout #1", "time_range": "2 days ago" }, { "query": "query #2", "name": "name #2", "timeout": "timeout #2", "time_range": "6 days ago" }] The query and name fields are mandatory. If timeout and time_range are specified, they will override the {timeout} and {time_range} argument. name: query_batch - description: If stated along with query, the response will be be saved in context under the Result.name path. name: name description: "Deprecated. Use the 'msg-advanced-hunting' command in the 'Microsoft Graph Security' integration instead." name: microsoft-atp-advanced-hunting outputs: - contextPath: MicrosoftATP.Hunt.Result description: The query results. type: String polling: true deprecated: true - arguments: - description: ID of the machine on which the event was identified. name: machine_id required: true - description: Severity of the alert. name: severity auto: PREDEFINED predefined: - Low - Medium - High required: true - description: Title for the alert. name: title required: true - description: Description of the alert. name: description required: true - description: Recommended action for the security officer to take when analyzing the alert. name: recommended_action required: true - description: The time of the event, as obtained from the advanced query. name: event_time required: true - description: The report ID, as obtained from the advanced query. name: report_id required: true - auto: PREDEFINED defaultValue: None description: Category of the alert. name: category predefined: - None - SuspiciousActivity - Malware - CredentialTheft - Exploit - WebExploit - DocumentExploit - PrivilegeEscalation - Persistence - RemoteAccessTool - CommandAndControl - SuspiciousNetworkTraffic - Ransomware - MalwareDownload - Reconnaissance - WebFingerprinting - Weaponization - Delivery - SocialEngineering - CredentialStealing - Installation - Backdoor - Trojan - TrojanDownloader - LateralMovement - ExplorationEnumeration - NetworkPropagation - Exfiltration - NotApplicable - EnterprisePolicy - General required: true - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Deprecated. No available replacement. name: microsoft-atp-create-alert outputs: - contextPath: MicrosoftATP.Alert.ID description: The alert ID. type: String - contextPath: MicrosoftATP.Alert.IncidentID description: The incident ID of the alert. type: Number - contextPath: MicrosoftATP.Alert.InvestigationID description: The investigation ID related to the alert. type: Number - contextPath: MicrosoftATP.Alert.InvestigationState description: The current state of the investigation. type: String - contextPath: MicrosoftATP.Alert.AssignedTo description: The owner of the alert. type: String - contextPath: MicrosoftATP.Alert.Severity description: The severity of the alert. type: String - contextPath: MicrosoftATP.Alert.Status description: The current status of the alert. type: String - contextPath: MicrosoftATP.Alert.Classification description: The alert classification. type: String - contextPath: MicrosoftATP.Alert.Determination description: The determination of the alert. type: String - contextPath: MicrosoftATP.Alert.DetectionSource description: The detection source. type: String - contextPath: MicrosoftATP.Alert.Category description: The category of the alert. type: String - contextPath: MicrosoftATP.Alert.ThreatFamilyName description: The threat family. type: String - contextPath: MicrosoftATP.Alert.Title description: The alert title. type: String - contextPath: MicrosoftATP.Alert.Description description: The alert description. type: String - contextPath: MicrosoftATP.Alert.AlertCreationTime description: The date and time the alert was created. type: Date - contextPath: MicrosoftATP.Alert.FirstEventTime description: The first event time that triggered the alert on that machine. type: Date - contextPath: MicrosoftATP.Alert.LastEventTime description: The last event time that triggered the alert on that machine. type: Date - contextPath: MicrosoftATP.Alert.LastUpdateTime description: The UTC time of the last update. type: Date - contextPath: MicrosoftATP.Alert.ResolvedTime description: The date and time the alert status changed to 'Resolved'. type: Date - contextPath: MicrosoftATP.Alert.MachineID description: The machine ID associated with the alert. type: String - contextPath: MicrosoftATP.Alert.ComputerDNSName description: The machine DNS name. type: String - contextPath: MicrosoftATP.Alert.AADTenantID description: The AAD tenant ID. type: String - contextPath: MicrosoftATP.Alert.Comments.Comment description: The alert comment string. type: String - contextPath: MicrosoftATP.Alert.Comments.CreatedBy description: The alert comment created by string. type: String - contextPath: MicrosoftATP.Alert.Comments.CreatedTime description: The alert comment created time date. type: Date polling: true deprecated: true - arguments: - description: ID of the alert. name: id required: true - description: Flag for the rate limit retry. name: ran_once_flag deprecated: true description: Deprecated. An alternative is to use the 'msg-get-alert-details' command in the 'Microsoft Graph Security' integration, which can retrieve `userAccount` information as part of the alert details. name: microsoft-atp-get-alert-related-user outputs: - contextPath: MicrosoftATP.AlertUser.User.ID description: The user ID. type: String - contextPath: MicrosoftATP.AlertUser.User.AccountName description: The account name. type: String - contextPath: MicrosoftATP.AlertUser.User.AccountDomain description: The account domain. type: String - contextPath: MicrosoftATP.AlertUser.User.AccountSID description: The account SID. type: String - contextPath: MicrosoftATP.AlertUser.User.FirstSeen description: The user first seen date time. type: Date - contextPath: MicrosoftATP.AlertUser.User.LastSeen description: The user last seen date time. type: Date - contextPath: MicrosoftATP.AlertUser.User.MostPrevalentMachineID description: The most prevalent machine ID. type: String - contextPath: MicrosoftATP.AlertUser.User.LeastPrevalentMachineID description: The least prevalent machine ID. type: String - contextPath: MicrosoftATP.AlertUser.User.LogonTypes description: The user logon types. type: String - contextPath: MicrosoftATP.AlertUser.User.LogonCount description: The count of user logons. type: Number - contextPath: MicrosoftATP.AlertUser.User.DomainAdmin description: The domain admin. type: Number - contextPath: MicrosoftATP.AlertUser.User.NetworkUser description: The network user. type: Number - contextPath: MicrosoftATP.AlertUser.AlertID description: The alert ID. type: String polling: true deprecated: true - arguments: - description: ID of the alert. name: id required: true - defaultValue: '50' description: The maximum number of files to display. name: limit - defaultValue: '0' description: The page from which to get the related files. name: offset - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Deprecated. An alternative is to use the 'msg-get-alert-details' command in the 'Microsoft Graph Security' integration, which can retrieve `fileDetails` as part of the alert details. name: microsoft-atp-get-alert-related-files outputs: - contextPath: MicrosoftATP.AlertFile.Files.FilePublisher description: The file's publisher. type: String - contextPath: MicrosoftATP.AlertFile.Files.Size description: The size of the file. type: Number - contextPath: MicrosoftATP.AlertFile.Files.GlobalLastObserved description: The last time the file was observed. type: Date - contextPath: MicrosoftATP.AlertFile.Files.Sha1 description: The SHA1 hash of the file. type: String - contextPath: MicrosoftATP.AlertFile.Files.IsValidCertificate description: Whether the signing certificate was successfully verified by the Microsoft Defender ATP agent. type: Number - contextPath: MicrosoftATP.AlertFile.Files.Sha256 description: The SHA256 hash of the file. type: String - contextPath: MicrosoftATP.AlertFile.Files.Signer description: The file signer. type: String - contextPath: MicrosoftATP.AlertFile.Files.GlobalPrevalence description: The file prevalence across the organization. type: Number - contextPath: MicrosoftATP.AlertFile.Files.DeterminationValue description: The file determination value. type: String - contextPath: MicrosoftATP.AlertFile.Files.GlobalFirstObserved description: The first time the file was observed. type: Date - contextPath: MicrosoftATP.AlertFile.Files.FileType description: The type of the file. type: String - contextPath: MicrosoftATP.AlertFile.Files.SignerHash description: The hash of the signing certificate. type: String - contextPath: MicrosoftATP.AlertFile.Files.Issuer description: The file issuer. type: String - contextPath: MicrosoftATP.AlertFile.Files.IsPeFile description: True if the file is portable executable, False otherwise. type: Number - contextPath: MicrosoftATP.AlertFile.Files.DeterminationType description: The file determination type. type: String - contextPath: MicrosoftATP.AlertFile.Files.FileProductName description: The file product name. type: Unknown - contextPath: MicrosoftATP.AlertFile.Files.Md5 description: The MD5 hash of the file. type: String polling: true deprecated: true - arguments: - description: ID of the alert. name: id required: true - defaultValue: '50' description: The maximum number of IPs to display. name: limit - defaultValue: '0' description: The page from which to get the related IPs. name: offset - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Deprecated. An alternative is to use the 'msg-get-alert-details' command in the 'Microsoft Graph Security' integration, which can retrieve `IpAddress` as part of the alert details. name: microsoft-atp-get-alert-related-ips outputs: - contextPath: MicrosoftATP.AlertIP.IPs.IpAddress description: The address of the IP. type: String - contextPath: MicrosoftATP.AlertIP.AlertID description: The alert ID. type: String polling: true deprecated: true - arguments: - description: ID of the alert. name: id required: true - description: The maximum number of domains to display. name: limit defaultValue: '50' - description: The page from which to get the related domains. name: offset defaultValue: '0' - description: Flag for the rate limit retry. name: ran_once_flag deprecated: true description: |- Deprecated. An alternative is to use the 'msg-get-alert-details' command in the 'Microsoft Graph Security' integration to retrieve `DomainName` as part of the alert details. name: microsoft-atp-get-alert-related-domains outputs: - contextPath: MicrosoftATP.AlertDomain.Domains.Domain description: The domain address. type: String - contextPath: MicrosoftATP.AlertDomain.AlertID description: The alert ID. type: Unknown polling: true deprecated: true - arguments: - description: ID of the action. name: id - description: The machine action status. name: status auto: PREDEFINED predefined: - Pending - InProgress - Succeeded - Failed - TimeOut - Cancelled - description: A comma-separated list of machine IDs on which the action was executed. name: machine_id isArray: true - auto: PREDEFINED description: The machine action type. name: type predefined: - RunAntiVirusScan - Offboard - CollectInvestigationPackage - Isolate - Unisolate - StopAndQuarantineFile - RestrictCodeExecution - UnrestrictCodeExecution - description: The ID of the user that executed the action; only one can be added. name: requestor - defaultValue: '50' description: The maximum number of machines to return. name: limit - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag - name: filters description: String representation of filters (Override every other filters). description: |- Return the machine's actions. If you set an action ID, it returns the info on the specific action. Filtering can be done only on one argument. name: microsoft-atp-list-machine-actions-details outputs: - contextPath: MicrosoftATP.MachineAction.ID description: The machine action ID. type: String - contextPath: MicrosoftATP.MachineAction.Type description: The type of the action. type: String - contextPath: MicrosoftATP.MachineAction.Scope description: The scope of the action. type: String - contextPath: MicrosoftATP.MachineAction.Requestor description: The ID of the user that executed the action. type: String - contextPath: MicrosoftATP.MachineAction.RequestorComment description: The comment that was written when issuing the action. type: String - contextPath: MicrosoftATP.MachineAction.Status description: The current status of the command. type: String - contextPath: MicrosoftATP.MachineAction.MachineID description: The machine ID on which the action was executed. type: String - contextPath: MicrosoftATP.MachineAction.ComputerDNSName description: The machine DNS name on which the action was executed. type: String - contextPath: MicrosoftATP.MachineAction.CreationDateTimeUtc description: The date and time the action was created. type: Date - contextPath: MicrosoftATP.MachineAction.LastUpdateTimeUtc description: The last date and time the action status was updated. type: Date - contextPath: MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifier description: The file identifier. type: String - contextPath: MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifierType description: 'The file identifier type. Possible values: "SHA1" ,"SHA256", and "MD5".' type: String polling: true - arguments: - description: The machine ID. name: machine_id required: true - description: Comment to associate with the action. name: comment required: true - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Collect an investigation package from a machine. name: microsoft-atp-collect-investigation-package outputs: - contextPath: MicrosoftATP.MachineAction.ID description: The machine action ID. type: String - contextPath: MicrosoftATP.MachineAction.Type description: The type of the action. type: String - contextPath: MicrosoftATP.MachineAction.Scope description: The scope of the action. type: String - contextPath: MicrosoftATP.MachineAction.Requestor description: The ID of the user that executed the action. type: String - contextPath: MicrosoftATP.MachineAction.RequestorComment description: The comment that was written when issuing the action. type: String - contextPath: MicrosoftATP.MachineAction.Status description: The current status of the command. type: String - contextPath: MicrosoftATP.MachineAction.MachineID description: The machine ID on which the action was executed. type: String - contextPath: MicrosoftATP.MachineAction.ComputerDNSName description: The machine DNS name on which the action was executed. type: String - contextPath: MicrosoftATP.MachineAction.CreationDateTimeUtc description: The date and time the action was created. type: Date - contextPath: MicrosoftATP.MachineAction.LastUpdateTimeUtc description: The last date and time the action status was updated. type: Date - contextPath: MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifier description: The file identifier. type: String - contextPath: MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifierType description: 'The file identifier type. Possible values: "SHA1" ,"SHA256", and "MD5".' type: String polling: true - arguments: - description: machine action ID. name: action_id required: true - description: Flag for the rate limit retry. name: ran_once_flag deprecated: true description: Gets a URI that allows downloading an investigation package. name: microsoft-atp-get-investigation-package-sas-uri outputs: - contextPath: MicrosoftATP.InvestigationURI.Link description: The investigation package URI. type: String polling: true - arguments: - description: The machine ID. name: machine_id required: true - description: Comment to associate with the action. name: comment - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Restricts the execution of all applications on the machine except for a predefined set. name: microsoft-atp-restrict-app-execution outputs: - contextPath: MicrosoftATP.MachineAction.ID description: The machine action ID. type: String - contextPath: MicrosoftATP.MachineAction.Type description: The type of the action. type: String - contextPath: MicrosoftATP.MachineAction.Scope description: The scope of the action. type: String - contextPath: MicrosoftATP.MachineAction.Requestor description: The ID of the user that executed the action. type: String - contextPath: MicrosoftATP.MachineAction.RequestorComment description: The comment that was written when issuing the action. type: String - contextPath: MicrosoftATP.MachineAction.Status description: The current status of the command. type: String - contextPath: MicrosoftATP.MachineAction.MachineID description: The machine ID on which the action was executed. type: String - contextPath: MicrosoftATP.MachineAction.ComputerDNSName description: The machine DNS name on which the action was executed. type: String - contextPath: MicrosoftATP.MachineAction.CreationDateTimeUtc description: The date and time the action was created. type: Date - contextPath: MicrosoftATP.MachineAction.LastUpdateTimeUtc description: The last date and time the action status was updated. type: Date - contextPath: MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifier description: The file identifier. type: String - contextPath: MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifierType description: 'The file identifier type. Possible values: "SHA1" ,"SHA256", and "MD5".' type: String polling: true - arguments: - description: The machine ID. name: machine_id required: true - description: |- Comment to associate with the action. name: comment required: true - description: Flag for the rate limit retry. name: ran_once_flag deprecated: true description: Enable the execution of any application on the machine. name: microsoft-atp-remove-app-restriction outputs: - contextPath: MicrosoftATP.MachineAction.ID description: The machine action ID. type: String - contextPath: MicrosoftATP.MachineAction.Type description: The type of the action. type: String - contextPath: MicrosoftATP.MachineAction.Scope description: The scope of the action. type: String - contextPath: MicrosoftATP.MachineAction.Requestor description: The ID of the user that executed the action. type: String - contextPath: MicrosoftATP.MachineAction.RequestorComment description: The comment that was written when issuing the action. type: String - contextPath: MicrosoftATP.MachineAction.Status description: The current status of the command. type: String - contextPath: MicrosoftATP.MachineAction.MachineID description: The machine ID on which the action was executed. type: String - contextPath: MicrosoftATP.MachineAction.ComputerDNSName description: The machine DNS name on which the action was executed. type: String - contextPath: MicrosoftATP.MachineAction.CreationDateTimeUtc description: The date and time the action was created. type: Date - contextPath: MicrosoftATP.MachineAction.LastUpdateTimeUtc description: The last date and time the action status was updated. type: Date - contextPath: MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifier description: The file identifier. type: String - contextPath: MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifierType description: 'The file identifier type. Possible values: "SHA1" ,"SHA256", and "MD5".' type: String polling: true - arguments: - description: The machine ID. When providing multiple values, each value is checked for the same hash. name: machine_id isArray: true required: true - description: |- The file SHA1 hash to stop and quarantine on the machine. When providing multiple values, each value is checked for the same machine_id. name: file_hash isArray: true required: true - description: Comment to associate with the action. name: comment required: true - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag - description: Whether to use polling. auto: PREDEFINED defaultValue: 'false' name: polling predefined: - 'true' - 'false' - name: timeout_in_seconds description: Timeout for polling. Default is 300 seconds. - name: interval_in_seconds description: Interval between polling. Default is 10 seconds. Must be 10 or higher. - description: action IDs to use in polling commands. (automatically filled by polling). name: action_ids deprecated: true description: Stop the execution of a file on a machine and delete it. name: microsoft-atp-stop-and-quarantine-file outputs: - contextPath: MicrosoftATP.MachineAction.ID description: The machine action ID. type: String - contextPath: MicrosoftATP.MachineAction.Type description: The type of the action. type: String - contextPath: MicrosoftATP.MachineAction.Scope description: The scope of the action. type: String - contextPath: MicrosoftATP.MachineAction.Requestor description: The ID of the user that executed the action. type: String - contextPath: MicrosoftATP.MachineAction.RequestorComment description: The comment that was written when issuing the action. type: String - contextPath: MicrosoftATP.MachineAction.Status description: The current status of the command. type: String - contextPath: MicrosoftATP.MachineAction.MachineID description: The machine ID on which the action was executed. type: String - contextPath: MicrosoftATP.MachineAction.ComputerDNSName description: The machine DNS name on which the action was executed. type: String - contextPath: MicrosoftATP.MachineAction.CreationDateTimeUtc description: The date and time the action was created. type: Date - contextPath: MicrosoftATP.MachineAction.LastUpdateTimeUtc description: The last date and time the action status was updated. type: Date - contextPath: MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifier description: The file identifier. type: String - contextPath: MicrosoftATP.MachineAction.RelatedFileInfo.FileIdentifierType description: 'The file identifier type. Possible values: "SHA1" ,"SHA256", and "MD5".' type: String polling: true compliantpolicies: - Quarantine File - arguments: - description: ID can be the investigation ID or the investigation triggering alert ID. name: id - description: The maximum number of investigations to display. name: limit defaultValue: '50' - defaultValue: '0' description: The page from which to get the investigations. name: offset predefined: - '' - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Retrieves a collection of investigations or retrieves a specific investigation by its ID. name: microsoft-atp-list-investigations outputs: - contextPath: MicrosoftATP.Investigation.ID description: The investigation ID. type: String - contextPath: MicrosoftATP.Investigation.StartTime description: The date and time the investigation was created. type: Date - contextPath: MicrosoftATP.Investigation.EndTime description: The date and time the investigation was completed. type: Date - contextPath: MicrosoftATP.Investigation.State description: The investigation state. type: String - contextPath: MicrosoftATP.Investigation.CancelledBy description: The ID of the user/application that cancelled that investigation. type: Unknown - contextPath: MicrosoftATP.Investigation.StatusDetails description: The details about the investigation state. type: Unknown - contextPath: MicrosoftATP.Investigation.MachineID description: The machine ID on which the investigation is executed. type: String - contextPath: MicrosoftATP.Investigation.ComputerDNSName description: The machine DNS name on which the investigation is executed. type: String - contextPath: MicrosoftATP.Investigation.TriggeringAlertID description: The alert ID that triggered the investigation. type: String polling: true - arguments: - description: The machine's ID. name: machine_id required: true - description: Comment to associate with the action. name: comment required: true - defaultValue: '50' description: The amount of time (in seconds) that a request waits for the query response before a timeout occurs. name: timeout - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Starts an automated investigation on a machine. name: microsoft-atp-start-investigation outputs: - contextPath: MicrosoftATP.Investigation.ID description: The investigation ID. type: String - contextPath: MicrosoftATP.Investigation.StartTime description: The date and time the investigation was created. type: Date - contextPath: MicrosoftATP.Investigation.EndTime description: The date and time the investigation was completed. type: Date - contextPath: MicrosoftATP.Investigation.State description: The investigation state. type: String - contextPath: MicrosoftATP.Investigation.CancelledBy description: The ID of the user/application that cancelled that investigation. type: Unknown - contextPath: MicrosoftATP.Investigation.StatusDetails description: The details about the investigation state. type: Unknown - contextPath: MicrosoftATP.Investigation.MachineID description: The machine ID on which the investigation is executed. type: String - contextPath: MicrosoftATP.Investigation.ComputerDNSName description: The machine DNS name on which the investigation is executed. type: String - contextPath: MicrosoftATP.Investigation.TriggeringAlertID description: The alert ID that triggered the investigation. type: String polling: true - arguments: - description: The domain address. name: domain required: true - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Retrieves statistics on the given domain. name: microsoft-atp-get-domain-statistics outputs: - contextPath: MicrosoftATP.DomainStatistics.Statistics.Host description: The domain host. type: String - contextPath: MicrosoftATP.DomainStatistics.Statistics.OrgPrevalence description: The prevalence of the domain in the organization. type: String - contextPath: MicrosoftATP.DomainStatistics.Statistics.OrgFirstSeen description: The first date and time the domain was in the organization. type: Date - contextPath: MicrosoftATP.DomainStatistics.Statistics.OrgLastSeen description: The last date and time the domain was in the organization. type: Date polling: true - arguments: - description: The domain address. name: domain required: true - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Deprecated. No available replacement. name: microsoft-atp-get-domain-alerts outputs: - contextPath: MicrosoftATP.DomainAlert.Domain description: The domain address. type: String - contextPath: MicrosoftATP.DomainAlert.Alerts.ID description: The alert ID. type: String - contextPath: MicrosoftATP.DomainAlert.Alerts.IncidentID description: The incident ID of the alert. type: Number - contextPath: MicrosoftATP.DomainAlert.Alerts.InvestigationID description: The investigation ID related to the alert. type: Number - contextPath: MicrosoftATP.DomainAlert.Alerts.InvestigationState description: The current state of the investigation. type: String - contextPath: MicrosoftATP.DomainAlert.Alerts.AssignedTo description: The owner of the alert. type: String - contextPath: MicrosoftATP.DomainAlert.Alerts.Severity description: The severity of the alert. type: String - contextPath: MicrosoftATP.DomainAlert.Alerts.Status description: The current status of the alert. type: String - contextPath: MicrosoftATP.DomainAlert.Alerts.Classification description: The alert classification. type: String - contextPath: MicrosoftATP.DomainAlert.Alerts.Determination description: The determination of the alert. type: String - contextPath: MicrosoftATP.DomainAlert.Alerts.DetectionSource description: The detection source. type: String - contextPath: MicrosoftATP.DomainAlert.Alerts.Category description: The category of the alert. type: String - contextPath: MicrosoftATP.DomainAlert.Alerts.ThreatFamilyName description: The threat family name. type: String - contextPath: MicrosoftATP.DomainAlert.Alerts.Title description: The alert title. type: String - contextPath: MicrosoftATP.DomainAlert.Alerts.Description description: The alert description. type: String - contextPath: MicrosoftATP.DomainAlert.Alerts.AlertCreationTime description: The date and time the alert was created. type: Date - contextPath: MicrosoftATP.DomainAlert.Alerts.FirstEventTime description: The first event time that triggered the alert on that machine. type: Date - contextPath: MicrosoftATP.DomainAlert.Alerts.LastEventTime description: The last event time that triggered the alert on that machine. type: Date - contextPath: MicrosoftATP.DomainAlert.Alerts.LastUpdateTime description: The last update time that triggered the alert on that machine. type: Date - contextPath: MicrosoftATP.DomainAlert.Alerts.ResolvedTime description: The date and time the status of the alert was changed to 'Resolved'. type: Date - contextPath: MicrosoftATP.DomainAlert.Alerts.MachineID description: The machine ID associated with the alert. type: String - contextPath: MicrosoftATP.DomainAlert.Alerts.ComputerDNSName description: The machine DNS name. type: String - contextPath: MicrosoftATP.DomainAlert.Alerts.AADTenantID description: The AAD tenant ID. type: String - contextPath: MicrosoftATP.DomainAlert.Alerts.Comments.Comment description: The alert comment string. type: String - contextPath: MicrosoftATP.DomainAlert.Alerts.Comments.CreatedBy description: The alert comment created by string. type: String - contextPath: MicrosoftATP.DomainAlert.Alerts.Comments.CreatedTime description: The alert comment created time date. type: Date polling: true deprecated: true - arguments: - description: The domain address. name: domain required: true - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Retrieves a collection of machines that have communicated to or from a given domain address. name: microsoft-atp-get-domain-machines outputs: - contextPath: MicrosoftATP.DomainMachine.Domain description: The domain address. type: String - contextPath: MicrosoftATP.DomainMachine.Machines.ID description: The machine ID. type: String - contextPath: MicrosoftATP.DomainMachine.Machines.ComputerDNSName description: The machine DNS name. type: String - contextPath: MicrosoftATP.DomainMachine.Machines.FirstSeen description: The first date and time the machine was observed by Microsoft Defender ATP. type: Date - contextPath: MicrosoftATP.DomainMachine.Machines.LastSeen description: The last date and time the machine was observed by Microsoft Defender ATP. type: Date - contextPath: MicrosoftATP.DomainMachine.Machines.OSPlatform description: The operating system platform. type: String - contextPath: MicrosoftATP.DomainMachine.Machines.OSVersion description: The operating system version. type: String - contextPath: MicrosoftATP.DomainMachine.Machines.OSProcessor description: The operating system processor. type: String - contextPath: MicrosoftATP.DomainMachine.Machines.LastIPAddress description: The last IP on the machine. type: String - contextPath: MicrosoftATP.DomainMachine.Machines.LastExternalIPAddress description: The last IP through which the machine accessed the internet. type: String - contextPath: MicrosoftATP.DomainMachine.Machines.OSBuild description: The operating system build number. type: Number - contextPath: MicrosoftATP.DomainMachine.Machines.HealthStatus description: The machine health status. type: String - contextPath: MicrosoftATP.DomainMachine.Machines.RBACGroupID description: The machine RBAC group ID. type: Number - contextPath: MicrosoftATP.DomainMachine.Machines.RBACGroupName description: The machine RBAC group name. type: String - contextPath: MicrosoftATP.DomainMachine.Machines.RiskScore description: The machine risk score. type: String - contextPath: MicrosoftATP.DomainMachine.Machines.ExposureLevel description: The machine exposure level. type: String - contextPath: MicrosoftATP.DomainMachine.Machines.IsAADJoined description: True if machine is AAD joined, False otherwise. type: Boolean - contextPath: MicrosoftATP.DomainMachine.Machines.AADDeviceID description: The AAD Device ID. type: String - contextPath: MicrosoftATP.DomainMachine.Machines.MachineTags description: Set of machine tags. type: String polling: true - arguments: - description: File SHA1 hash to get statistics on. name: file_hash required: true - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Retrieves statistics for the given file. name: microsoft-atp-get-file-statistics outputs: - contextPath: MicrosoftATP.FileStatistics.Sha1 description: The file SHA1 hash. type: String - contextPath: MicrosoftATP.FileStatistics.Statistics.OrgPrevalence description: The number of times the file is detected in the organization. type: String - contextPath: MicrosoftATP.FileStatistics.Statistics.OrganizationPrevalence description: The number of times the file is detected in the organization. type: Number - contextPath: MicrosoftATP.FileStatistics.Statistics.OrgFirstSeen description: The first date and time the file was in the organization. type: Date - contextPath: MicrosoftATP.FileStatistics.Statistics.OrgLastSeen description: The last date and time the file was in the organization. type: Date - contextPath: MicrosoftATP.FileStatistics.Statistics.GlobalPrevalence description: The number of times the file is detected across all organizations by Microsoft Defender ATP. type: String - contextPath: MicrosoftATP.FileStatistics.Statistics.GloballyPrevalence description: The number of times the file is detected across all organizations by Microsoft Defender ATP. type: Number - contextPath: MicrosoftATP.FileStatistics.Statistics.GlobalFirstObserved description: The global first observation date and time of the file. type: Date - contextPath: MicrosoftATP.FileStatistics.Statistics.GlobalLastObserved description: The global last observation date and time of the file. type: Date - contextPath: MicrosoftATP.FileStatistics.Statistics.TopFileNames description: The file's top names. type: String - contextPath: File.SHA1 description: The SHA1 hash of the file. type: String - contextPath: File.OrganizationPrevalence description: The number of times the indicator is detected in the organization. type: Number - contextPath: File.GlobalPrevalence description: The number of times the indicator is detected across all organizations by Microsoft Defender ATP. type: Number - contextPath: File.OrganizationFirstSeen description: The date and time when the indicator was first seen in the organization. type: Date - contextPath: File.OrganizationLastSeen description: The date and time when the indicator was last seen in the organization. type: Date - contextPath: File.FirstSeenBySource description: The date and time when the indicator was first seen by Microsoft Defender ATP. type: Date - contextPath: File.LastSeenBySource description: The date and time when the indicator was last seen by Microsoft Defender ATP. type: Date polling: true - arguments: - description: File SHA1 hash to get statistics on. name: file_hash required: true - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Deprecated. No available replacement. name: microsoft-atp-get-file-alerts outputs: - contextPath: MicrosoftATP.FileAlert.Sha1 description: The file SHA1 hash. type: String - contextPath: MicrosoftATP.FileAlert.Alerts.ID description: The alert ID. type: String - contextPath: MicrosoftATP.FileAlert.Alerts.IncidentID description: The incident ID of the alert. type: Number - contextPath: MicrosoftATP.FileAlert.Alerts.InvestigationID description: The investigation ID related to the alert. type: Number - contextPath: MicrosoftATP.FileAlert.Alerts.InvestigationState description: The current state of the investigation. type: String - contextPath: MicrosoftATP.FileAlert.Alerts.AssignedTo description: The owner of the alert. type: String - contextPath: MicrosoftATP.FileAlert.Alerts.Severity description: The severity of the alert. type: String - contextPath: MicrosoftATP.FileAlert.Alerts.Status description: The current status of the alert. type: String - contextPath: MicrosoftATP.FileAlert.Alerts.Classification description: The alert classification. type: String - contextPath: MicrosoftATP.FileAlert.Alerts.Determination description: The determination of the alert. type: String - contextPath: MicrosoftATP.FileAlert.Alerts.DetectionSource description: The detection source. type: String - contextPath: MicrosoftATP.FileAlert.Alerts.Category description: The category of the alert. type: String - contextPath: MicrosoftATP.FileAlert.Alerts.ThreatFamilyName description: The threat family name. type: String - contextPath: MicrosoftATP.FileAlert.Alerts.Title description: The alert title. type: String - contextPath: MicrosoftATP.FileAlert.Alerts.Description description: The alert description. type: String - contextPath: MicrosoftATP.FileAlert.Alerts.AlertCreationTime description: The date and time the alert was created. type: Date - contextPath: MicrosoftATP.FileAlert.Alerts.FirstEventTime description: The first event time that triggered the alert on that machine. type: Date - contextPath: MicrosoftATP.FileAlert.Alerts.LastEventTime description: The last event time that triggered the alert on that machine. type: Date - contextPath: MicrosoftATP.FileAlert.Alerts.LastUpdateTime description: The last update time that triggered the alert on that machine. type: Date - contextPath: MicrosoftATP.FileAlert.Alerts.ResolvedTime description: The date and time the status of the alert was changed to 'Resolved'. type: Date - contextPath: MicrosoftATP.FileAlert.Alerts.MachineID description: The machine ID associated with the alert. type: String - contextPath: MicrosoftATP.FileAlert.Alerts.ComputerDNSName description: The machine DNS name. type: String - contextPath: MicrosoftATP.FileAlert.Alerts.AADTenantID description: The AAD tenant ID. type: String - contextPath: MicrosoftATP.FileAlert.Alerts.Comments.Comment description: The alert comment string. type: String - contextPath: MicrosoftATP.FileAlert.Alerts.Comments.CreatedBy description: The alert comment created by string. type: String - contextPath: MicrosoftATP.FileAlert.Alerts.Comments.CreatedTime description: The alert comment created time date. type: Date polling: true deprecated: true - arguments: - description: The IP address. name: ip required: true - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Retrieves statistics for a given IP. name: microsoft-atp-get-ip-statistics outputs: - contextPath: MicrosoftATP.IPStatistics.Statistics.IPAddress description: The IP address. type: String - contextPath: MicrosoftATP.IPStatistics.Statistics.OrgPrevalence description: The prevalence of the IP in the organization. type: String - contextPath: MicrosoftATP.IPStatistics.Statistics.OrgFirstSeen description: The first date and time the IP was in the organization. type: Date - contextPath: MicrosoftATP.IPStatistics.Statistics.OrgLastSeen description: The last date and time the IP was in the organization. type: Date polling: true - arguments: - description: |- The IP address. name: ip required: true - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Deprecated. No available replacement. name: microsoft-atp-get-ip-alerts outputs: - contextPath: MicrosoftATP.IPAlert.IPAddress description: The IP address. type: String - contextPath: MicrosoftATP.IPAlert.Alerts.ID description: The alert ID. type: String - contextPath: MicrosoftATP.IPAlert.Alerts.IncidentID description: The incident ID of the alert. type: Number - contextPath: MicrosoftATP.IPAlert.Alerts.InvestigationID description: The investigation ID related to the alert. type: Number - contextPath: MicrosoftATP.IPAlert.Alerts.InvestigationState description: The current state of the investigation. type: String - contextPath: MicrosoftATP.IPAlert.Alerts.AssignedTo description: The owner of the alert. type: String - contextPath: MicrosoftATP.IPAlert.Alerts.Severity description: The severity of the alert. type: String - contextPath: MicrosoftATP.IPAlert.Alerts.Status description: The current status of the alert. type: String - contextPath: MicrosoftATP.IPAlert.Alerts.Classification description: The alert classification. type: String - contextPath: MicrosoftATP.IPAlert.Alerts.Determination description: The determination of the alert. type: String - contextPath: MicrosoftATP.IPAlert.Alerts.DetectionSource description: The detection source. type: String - contextPath: MicrosoftATP.IPAlert.Alerts.Category description: The category of the alert. type: String - contextPath: MicrosoftATP.IPAlert.Alerts.ThreatFamilyName description: The threat family name. type: String - contextPath: MicrosoftATP.IPAlert.Alerts.Title description: The alert title. type: String - contextPath: MicrosoftATP.IPAlert.Alerts.Description description: The alert description. type: String - contextPath: MicrosoftATP.IPAlert.Alerts.AlertCreationTime description: The date and time the alert was created. type: Date - contextPath: MicrosoftATP.IPAlert.Alerts.FirstEventTime description: The first event time that triggered the alert on that machine. type: Date - contextPath: MicrosoftATP.IPAlert.Alerts.LastEventTime description: The last event time that triggered the alert on that machine. type: Date - contextPath: MicrosoftATP.IPAlert.Alerts.LastUpdateTime description: The last update time that triggered the alert on that machine. type: Date - contextPath: MicrosoftATP.IPAlert.Alerts.ResolvedTime description: The date and time the status of the alert was changed to 'Resolved'. type: Date - contextPath: MicrosoftATP.IPAlert.Alerts.MachineID description: The machine ID associated with the alert. type: String - contextPath: MicrosoftATP.IPAlert.Alerts.ComputerDNSName description: The machine DNS name. type: String - contextPath: MicrosoftATP.IPAlert.Alerts.AADTenantID description: The AAD tenant ID. type: String - contextPath: MicrosoftATP.IPAlert.Alerts.Comments.Comment description: The alert comment string. type: String - contextPath: MicrosoftATP.IPAlert.Alerts.Comments.CreatedBy description: The alert comment created by string. type: String - contextPath: MicrosoftATP.IPAlert.Alerts.Comments.CreatedTime description: The alert comment created time date. type: Date polling: true deprecated: true - arguments: - description: |- The user ID. Note that the ID is not the full UPN, but only the username. (e.g., to retrieve alerts for user1@test.com, use user1). name: username required: true - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Deprecated. No available replacement. name: microsoft-atp-get-user-alerts outputs: - contextPath: MicrosoftATP.UserAlert.Username description: The username. type: String - contextPath: MicrosoftATP.UserAlert.Alerts.ID description: The alert ID. type: String - contextPath: MicrosoftATP.UserAlert.Alerts.IncidentID description: The incident ID of the alert. type: Number - contextPath: MicrosoftATP.UserAlert.Alerts.InvestigationID description: The investigation ID related to the alert. type: Number - contextPath: MicrosoftATP.UserAlert.Alerts.InvestigationState description: The current state of the investigation. type: String - contextPath: MicrosoftATP.UserAlert.Alerts.AssignedTo description: The owner of the alert. type: String - contextPath: MicrosoftATP.UserAlert.Alerts.Severity description: The severity of the alert. type: String - contextPath: MicrosoftATP.UserAlert.Alerts.Status description: The current status of the alert. type: String - contextPath: MicrosoftATP.UserAlert.Alerts.Classification description: The alert classification. type: String - contextPath: MicrosoftATP.UserAlert.Alerts.Determination description: The determination of the alert. type: String - contextPath: MicrosoftATP.UserAlert.Alerts.DetectionSource description: The detection source. type: String - contextPath: MicrosoftATP.UserAlert.Alerts.Category description: The category of the alert. type: String - contextPath: MicrosoftATP.UserAlert.Alerts.ThreatFamilyName description: The threat family name. type: String - contextPath: MicrosoftATP.UserAlert.Alerts.Title description: The alert title. type: String - contextPath: MicrosoftATP.UserAlert.Alerts.Description description: The alert description. type: String - contextPath: MicrosoftATP.UserAlert.Alerts.AlertCreationTime description: The date and time the alert was created. type: Date - contextPath: MicrosoftATP.UserAlert.Alerts.FirstEventTime description: The first event time that triggered the alert on that machine. type: Date - contextPath: MicrosoftATP.UserAlert.Alerts.LastEventTime description: The last event time that triggered the alert on that machine. type: Date - contextPath: MicrosoftATP.UserAlert.Alerts.LastUpdateTime description: The last update time that triggered the alert on that machine. type: Date - contextPath: MicrosoftATP.UserAlert.Alerts.ResolvedTime description: The date and time the status of the alert was changed to 'Resolved'. type: Date - contextPath: MicrosoftATP.UserAlert.Alerts.MachineID description: The machine ID associated with the alert. type: String - contextPath: MicrosoftATP.UserAlert.Alerts.ComputerDNSName description: The machine DNS name. type: String - contextPath: MicrosoftATP.UserAlert.Alerts.AADTenantID description: The AAD tenant ID. type: String - contextPath: MicrosoftATP.UserAlert.Alerts.Comments.Comment description: The alert comment string. type: String - contextPath: MicrosoftATP.UserAlert.Alerts.Comments.CreatedBy description: The alert comment created by string. type: String - contextPath: MicrosoftATP.UserAlert.Alerts.Comments.CreatedTime description: The alert comment created time date. type: Date polling: true deprecated: true - arguments: - description: |- The user ID. Note that the ID is not the full UPN, but only the username. (e.g., to retrieve machines for user1@test.com, use user1). name: username required: true - description: Flag for the rate limit retry. name: ran_once_flag deprecated: true description: Retrieves a collection of machines related to a given user ID. name: microsoft-atp-get-user-machines outputs: - contextPath: MicrosoftATP.UserMachine.Username description: The username. type: String - contextPath: MicrosoftATP.UserMachine.Machines.ID description: The machine ID. type: String - contextPath: MicrosoftATP.UserMachine.Machines.ComputerDNSName description: The machine DNS name. type: String - contextPath: MicrosoftATP.UserMachine.Machines.FirstSeen description: The first date and time the machine was observed by Microsoft Defender ATP. type: Date - contextPath: MicrosoftATP.UserMachine.Machines.LastSeen description: The last date and time the machine was observed by Microsoft Defender ATP. type: Date - contextPath: MicrosoftATP.UserMachine.Machines.OSPlatform description: The operating system platform. type: String - contextPath: MicrosoftATP.UserMachine.Machines.OSVersion description: The operating system version. type: String - contextPath: MicrosoftATP.UserMachine.Machines.OSProcessor description: The operating system processor. type: String - contextPath: MicrosoftATP.v.Machines.LastIPAddress description: The last IP on the machine. type: String - contextPath: MicrosoftATP.UserMachine.Machines.LastExternalIPAddress description: The last IP through which the machine accessed the internet. type: String - contextPath: MicrosoftATP.UserMachine.Machines.OSBuild description: The operating system build number. type: Number - contextPath: MicrosoftATP.UserMachine.Machines.HealthStatus description: The machine health status. type: String - contextPath: MicrosoftATP.UserMachine.Machines.RBACGroupID description: The machine RBAC group ID. type: Number - contextPath: MicrosoftATP.UserMachine.Machines.RBACGroupName description: The machine RBAC group name. type: String - contextPath: MicrosoftATP.UserMachine.Machines.RiskScore description: The machine risk score. type: String - contextPath: MicrosoftATP.UserMachine.Machines.ExposureLevel description: The machine exposure level. type: String - contextPath: MicrosoftATP.UserMachine.Machines.IsAADJoined description: True if machine is AAD joined, False otherwise. type: Boolean - contextPath: MicrosoftATP.UserMachine.Machines.AADDeviceID description: The AAD device ID. type: String - contextPath: MicrosoftATP.UserMachine.Machines.MachineTags description: Set of machine tags. type: String polling: true - arguments: - description: The machine ID. name: machine_id required: true - description: The action to use for the tag. name: action auto: PREDEFINED predefined: - Add - Remove required: true - description: The tag name. name: tag required: true - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Adds or removes a tag on a specific machine. name: microsoft-atp-add-remove-machine-tag outputs: - contextPath: MicrosoftATP.Machine.ID description: The machine ID. type: String - contextPath: MicrosoftATP.Machine.ComputerDNSName description: 'The machine DNS name.' type: String - contextPath: MicrosoftATP.Machine.FirstSeen description: The first date and time the machine was observed by Microsoft Defender ATP. type: Date - contextPath: MicrosoftATP.Machine.LastSeen description: The last date and time the machine was observed by Microsoft Defender ATP. type: Date - contextPath: MicrosoftATP.Machine.OSPlatform description: The operating system platform. type: String - contextPath: MicrosoftATP.Machine.OSVersion description: The operating system version. type: String - contextPath: MicrosoftATP.Machine.OSProcessor description: 'The operating system processor.' type: String - contextPath: MicrosoftATP.Machine.LastIPAddress description: The last IP on the machine. type: String - contextPath: MicrosoftATP.Machine.LastExternalIPAddress description: "The last IP through which the machine accessed the internet." type: String - contextPath: MicrosoftATP.Machine.OSBuild description: The operating system build number. type: Number - contextPath: MicrosoftATP.Machine.HealthStatus description: "The machine health status." type: String - contextPath: MicrosoftATP.Machine.RBACGroupID description: "The machine RBAC group ID." type: Number - contextPath: MicrosoftATP.Machine.RBACGroupName description: 'The machine RBAC group name.' type: String - contextPath: MicrosoftATP.Machine.RiskScore description: The machine risk score. type: String - contextPath: MicrosoftATP.Machine.ExposureLevel description: The machine exposure level. type: String - contextPath: MicrosoftATP.Machine.IsAADJoined description: True if machine is AAD joined, False otherwise. type: Boolean - contextPath: MicrosoftATP.Machine.AADDeviceID description: The AAD device ID. type: String - contextPath: MicrosoftATP.Machine.MachineTags description: Set of machine tags. type: String polling: true - arguments: - description: The maximum number of indicators to return. name: limit defaultValue: '50' - description: Specifies the page size of the result set. Maximum is 200. name: page_size defaultValue: '50' - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag deprecated: true description: Deprecated. Use the microsoft-atp-sc-indicator-list command instead. Lists all indicators by the ID that the system creates when the indicator is ingested. name: microsoft-atp-indicator-list outputs: - contextPath: MicrosoftATP.Indicators.id description: Generated GUID/unique identifier. Created by the system when the indicator is ingested. type: String - contextPath: MicrosoftATP.Indicators.action description: 'The action to apply if the indicator is matched from within the targetProduct security tool. Possible values: "unknown", "allow", "block", and "alert".' type: String - contextPath: MicrosoftATP.Indicators.additionalInformation description: A catchall area into which extra data from the indicator not covered by the other indicator properties may be placed. Data placed into additionalInformation is typically not used by the targetProduct security tool. type: String - contextPath: MicrosoftATP.Indicators.azureTenantId description: Stamped by the system when the indicator is ingested. The Entra ID tenant ID of the submitting client. type: String - contextPath: MicrosoftATP.Indicators.confidence description: An integer representing the confidence with which the data within the indicator accurately identifies malicious behavior. Values are 0 – 100, with 100 being the highest. type: Number - contextPath: MicrosoftATP.Indicators.description description: Brief description (100 characters or less) of the threat represented by the indicator. type: String - contextPath: MicrosoftATP.Indicators.diamondModel description: 'The area of the Diamond Model in which this indicator exists. Possible values: "unknown", "adversary", "capability", "infrastructure", and "victim".' type: String - contextPath: MicrosoftATP.Indicators.domainName description: Domain name associated with this indicator. Should be in the format subdomain.domain.topleveldomain. type: String - contextPath: MicrosoftATP.Indicators.expirationDateTime description: "DateTime string indicating when the indicator expires. To avoid stale indicators persisting in the system, all indicators must have an expiration date. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.externalId description: An identification number that ties the indicator back to the indicator provider’s system (e.g., a foreign key). type: String - contextPath: MicrosoftATP.Indicators.fileCompileDateTime description: "DateTime the file was compiled. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.fileCreatedDateTime description: "DateTime the file was created. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.fileHashType description: 'The type of hash stored in fileHashValue. Possible values: "unknown", "sha1", "sha256", "md5", "authenticodeHash256", "lsHash", and "ctph".' type: String - contextPath: MicrosoftATP.Indicators.fileHashValue description: The file hash value. type: String - contextPath: MicrosoftATP.Indicators.fileMutexName description: The Mutex name used in file-based detections. type: String - contextPath: MicrosoftATP.Indicators.fileName description: The name of the file if the indicator is file-based. Multiple file names may be delimited by commas. type: String - contextPath: MicrosoftATP.Indicators.filePacker description: The packer used to build the file in question. type: String - contextPath: MicrosoftATP.Indicators.filePath description: The path of the file indicating a compromise. Can be a Windows or *nix style path. type: String - contextPath: MicrosoftATP.Indicators.fileSize description: The size of the file in bytes. type: Number - contextPath: MicrosoftATP.Indicators.fileType description: Text description of the type of file. For example, “Word Document” or “Binary”. type: String - contextPath: MicrosoftATP.Indicators.ingestedDateTime description: "Timestamp the indicator was ingested into the system. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.isActive description: Used to deactivate indicators within the system. By default, any indicator submitted is set as active. However, providers may submit existing indicators with this set to ‘False’ to deactivate indicators in the system. type: Boolean - contextPath: MicrosoftATP.Indicators.knownFalsePositives description: Scenarios in which the indicator may cause false positives. This should be human-readable text. type: String - contextPath: MicrosoftATP.Indicators.lastReportedDateTime description: "The last time the indicator was seen. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.networkCidrBlock description: CIDR Block notation representation of the network referenced in this indicator. Use only if the Source and Destination cannot be identified. type: String - contextPath: MicrosoftATP.Indicators.networkDestinationAsn description: The destination autonomous system identifier of the network referenced in the indicator. type: Number - contextPath: MicrosoftATP.Indicators.networkDestinationCidrBlock description: The CIDR Block notation representation of the destination network in this indicator. type: String - contextPath: MicrosoftATP.Indicators.networkDestinationIPv4 description: The IPv4 IP address destination. type: String - contextPath: MicrosoftATP.Indicators.networkDestinationIPv6 description: The IPv6 IP address destination. type: String - contextPath: MicrosoftATP.Indicators.networkDestinationPort description: The TCP port destination. type: Number - contextPath: MicrosoftATP.Indicators.networkIPv4 description: The IPv4 IP address. type: String - contextPath: MicrosoftATP.Indicators.networkIPv6 description: The IPv6 IP address. type: String - contextPath: MicrosoftATP.Indicators.networkPort description: The TCP port. type: Number - contextPath: MicrosoftATP.Indicators.networkProtocol description: The decimal representation of the protocol field in the IPv4 header. type: Number - contextPath: MicrosoftATP.Indicators.networkSourceAsn description: The source autonomous system identifier of the network referenced in the indicator. type: Number - contextPath: MicrosoftATP.Indicators.networkSourceCidrBlock description: The CIDR Block notation representation of the source network in this indicator. type: String - contextPath: MicrosoftATP.Indicators.networkSourceIPv4 description: The IPv4 IP address source. type: String - contextPath: MicrosoftATP.Indicators.networkSourceIPv6 description: The IPv6 IP address source. type: String - contextPath: MicrosoftATP.Indicators.networkSourcePort description: The TCP port source. type: Number - contextPath: MicrosoftATP.Indicators.passiveOnly description: Determines if the indicator should trigger an event that is visible to an end user. When set to ‘true,’ security tools do not notify the end user that a ‘hit’ has occurred. This is most often treated as audit or silent mode by security products where they simply log that a match occurred but do not perform the action. Default value is false. type: Boolean - contextPath: MicrosoftATP.Indicators.severity description: 'Severity of the malicious behavior identified by the data within the indicator. Possible values: "Informational", "Low", "MediumLow", "MediumHigh", and "High", where High is the most severe and Informational is not severe at all.' type: String - contextPath: MicrosoftATP.Indicators.targetProduct description: A string value representing a single security product to which the indicator should be applied. type: String - contextPath: MicrosoftATP.Indicators.threatType description: 'Each indicator must have a valid Indicator Threat Type. Possible values: "Botnet", "C2", "CryptoMining", "Darknet", "DDoS", "MaliciousUrl", "Malware", "Phishing", "Proxy", "PUA", and "WatchList".' type: String - contextPath: MicrosoftATP.Indicators.tlpLevel description: 'Traffic Light Protocol value for the indicator. Possible values: "unknown", "white", "green", "amber", and "red".' type: String - contextPath: MicrosoftATP.Indicators.url description: Uniform Resource Locator. This URL complies with RFC 1738. type: String - contextPath: MicrosoftATP.Indicators.userAgent description: User-Agent string from a web request that could indicate compromise. type: String - contextPath: MicrosoftATP.Indicators.vendorInformation description: Information about the vendor. type: String - contextPath: File.Name description: The full file name (including file extension). type: String - contextPath: File.Size description: The size of the file in bytes. type: Number - contextPath: File.MD5 description: The MD5 hash of the file. type: String - contextPath: File.SHA1 description: The SHA1 hash of the file. type: String - contextPath: File.SHA256 description: The SHA256 hash of the file. type: String - contextPath: File.SHA512 description: The SHA512 hash of the file. type: String - contextPath: File.Type description: The file type, as determined by libmagic (same as displayed in file entries). type: String - contextPath: File.Path description: The path where the file is located. type: String - contextPath: Domain.Name description: 'The domain name, for example: "google.com".' type: String - contextPath: IP.Address description: The IP address. type: String - contextPath: URL.Data description: The URL. type: String polling: true - arguments: - description: The ID of the indicator to get. name: indicator_id required: true default: true - description: Flag for the rate limit retry. name: ran_once_flag deprecated: true deprecated: true description: Deprecated. Use the microsoft-atp-sc-indicator-get-by-id command instead. Gets an indicator by its ID. name: microsoft-atp-indicator-get-by-id outputs: - contextPath: MicrosoftATP.Indicators.id description: Created by the system when the indicator is ingested. Generated GUID/unique identifier. type: String - contextPath: MicrosoftATP.Indicators.action description: 'The action to apply if the indicator is matched from within the targetProduct security tool. Possible values: "unknown", "allow", "block", and "alert".' type: String - contextPath: MicrosoftATP.Indicators.additionalInformation description: A catchall area into which extra data from the indicator not covered by the other indicator properties may be placed. Data placed into additionalInformation is typically not used by the targetProduct security tool. type: String - contextPath: MicrosoftATP.Indicators.azureTenantId description: Stamped by the system when the indicator is ingested. The Entra ID tenant ID of the submitting client. type: String - contextPath: MicrosoftATP.Indicators.confidence description: An integer representing the confidence with which the data within the indicator accurately identifies malicious behavior. Possible values are 0 – 100, with 100 being the highest. type: Number - contextPath: MicrosoftATP.Indicators.description description: Brief description (100 characters or less) of the threat represented by the indicator. type: String - contextPath: MicrosoftATP.Indicators.diamondModel description: 'The area of the Diamond Model in which this indicator exists. Possible values: "unknown", "adversary", "capability", "infrastructure", and "victim".' type: String - contextPath: MicrosoftATP.Indicators.domainName description: Domain name associated with this indicator. Should be in the format subdomain.domain.topleveldomain. type: String - contextPath: MicrosoftATP.Indicators.expirationDateTime description: "DateTime string indicating when the indicator expires. To avoid stale indicators persisting in the system, all indicators must have an expiration date. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.externalId description: An identification number that ties the indicator back to the indicator provider’s system (e.g., a foreign key). type: String - contextPath: MicrosoftATP.Indicators.fileCompileDateTime description: "DateTime the file was compiled. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.fileCreatedDateTime description: "DateTime the file was created. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.fileHashType description: 'The type of hash stored in fileHashValue. Possible values: "unknown", "sha1", "sha256", "md5", "authenticodeHash256", "lsHash", and "ctph".' type: String - contextPath: MicrosoftATP.Indicators.fileHashValue description: The file hash value. type: String - contextPath: MicrosoftATP.Indicators.fileMutexName description: The Mutex name used in file-based detections. type: String - contextPath: MicrosoftATP.Indicators.fileName description: The name of the file if the indicator is file-based. Multiple file names may be delimited by commas. type: String - contextPath: MicrosoftATP.Indicators.filePacker description: The packer used to build the file in question. type: String - contextPath: MicrosoftATP.Indicators.filePath description: The path of the file indicating a compromise. Can be a Windows or *nix style path. type: String - contextPath: MicrosoftATP.Indicators.fileSize description: The size of the file in bytes. type: Number - contextPath: MicrosoftATP.Indicators.fileType description: Text description of the type of file. For example, “Word Document” or “Binary”. type: String - contextPath: MicrosoftATP.Indicators.ingestedDateTime description: "Timestamp the indicator was ingested into the system. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.isActive description: Used to deactivate indicators within the system. By default, any indicator submitted is set as active. However, providers may submit existing indicators with this set to ‘False’ to deactivate indicators in the system. type: Boolean - contextPath: MicrosoftATP.Indicators.knownFalsePositives description: Scenarios in which the indicator may cause false positives. This should be human-readable text. type: String - contextPath: MicrosoftATP.Indicators.lastReportedDateTime description: "The last time the indicator was seen. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.networkCidrBlock description: CIDR Block notation representation of the network referenced in this indicator. Use only if the Source and Destination cannot be identified. type: String - contextPath: MicrosoftATP.Indicators.networkDestinationAsn description: The destination autonomous system identifier of the network referenced in the indicator. type: Number - contextPath: MicrosoftATP.Indicators.networkDestinationCidrBlock description: CIDR Block notation representation of the destination network in this indicator. type: String - contextPath: MicrosoftATP.Indicators.networkDestinationIPv4 description: The IPv4 IP address destination. type: String - contextPath: MicrosoftATP.Indicators.networkDestinationIPv6 description: The IPv6 IP address destination. type: String - contextPath: MicrosoftATP.Indicators.networkDestinationPort description: The TCP port destination. type: Number - contextPath: MicrosoftATP.Indicators.networkIPv4 description: The IPv4 IP address. type: String - contextPath: MicrosoftATP.Indicators.networkIPv6 description: The IPv6 IP address. type: String - contextPath: MicrosoftATP.Indicators.networkPort description: The TCP port. type: Number - contextPath: MicrosoftATP.Indicators.networkProtocol description: The decimal representation of the protocol field in the IPv4 header. type: Number - contextPath: MicrosoftATP.Indicators.networkSourceAsn description: The source autonomous system identifier of the network referenced in the indicator. type: Number - contextPath: MicrosoftATP.Indicators.networkSourceCidrBlock description: The CIDR Block notation representation of the source network in this indicator. type: String - contextPath: MicrosoftATP.Indicators.networkSourceIPv4 description: The IPv4 IP address source. type: String - contextPath: MicrosoftATP.Indicators.networkSourceIPv6 description: The IPv6 IP address source. type: String - contextPath: MicrosoftATP.Indicators.networkSourcePort description: The TCP port source. type: Number - contextPath: MicrosoftATP.Indicators.passiveOnly description: Determines if the indicator should trigger an event that is visible to an end user. When set to ‘true,’ security tools do not notify the end user that a ‘hit’ has occurred. This is most often treated as audit or silent mode by security products where they simply log that a match occurred but do not perform the action. Default value is false. type: Boolean - contextPath: MicrosoftATP.Indicators.severity description: 'Severity of the malicious behavior identified by the data within the indicator. Possible values: "Informational", "Low", "MediumLow", "MediumHigh", and "High", where High is the most severe and Informational is not severe at all.' type: String - contextPath: MicrosoftATP.Indicators.targetProduct description: A string value representing a single security product to which the indicator should be applied. type: String - contextPath: MicrosoftATP.Indicators.threatType description: 'Each indicator must have a valid Indicator Threat Type. Possible values: "Botnet", "C2", "CryptoMining", "Darknet", "DDoS", "MaliciousUrl", "Malware", "Phishing", "Proxy", "PUA", and "WatchList".' type: String - contextPath: MicrosoftATP.Indicators.tlpLevel description: 'Traffic Light Protocol value for the indicator. Possible values: "unknown", "white", "green", "amber", and "red".' type: String - contextPath: MicrosoftATP.Indicators.url description: Uniform Resource Locator. This URL complies with RFC 1738. type: String - contextPath: MicrosoftATP.Indicators.userAgent description: User-Agent string from a web request that could indicate compromise. type: String - contextPath: MicrosoftATP.Indicators.vendorInformation description: Information about the vendor. type: String - contextPath: File.Name description: The full file name (including file extension). type: String - contextPath: File.Size description: The size of the file in bytes. type: Number - contextPath: File.MD5 description: The MD5 hash of the file. type: String - contextPath: File.SHA1 description: The SHA1 hash of the file. type: String - contextPath: File.SHA256 description: The SHA256 hash of the file. type: String - contextPath: File.SHA512 description: The SHA512 hash of the file. type: String - contextPath: File.Type description: The file type, as determined by libmagic (same as displayed in file entries). type: String - contextPath: File.Path description: The path where the file is located. type: String - contextPath: Domain.Name description: 'The domain name, for example: "google.com".' type: String - contextPath: IP.Address description: The IP address. type: String - contextPath: URL.Data description: The URL. type: String polling: true - arguments: - auto: PREDEFINED description: The action to apply if the indicator is matched from within the targetProduct security tool. name: action predefined: - unknown - allow - block - alert required: true - description: Brief description (100 characters or less) of the threat represented by the indicator. name: description required: true - description: 'DateTime string indicating when the indicator expires. Format: (<number> <time unit>, e.g., 12 hours, 7 days).' name: expiration_time required: true - auto: PREDEFINED description: Each indicator must have a valid Indicator Threat Type. name: threat_type predefined: - Botnet - C2 - CryptoMining - Darknet - DDoS - MaliciousUrl - Malware - Phishing - Proxy - PUA - WatchList required: true - auto: PREDEFINED description: 'Traffic Light Protocol value for the indicator.' name: tlp_level predefined: - unknown - white - green - amber - description: An integer representing the confidence with which the data within the indicator accurately identifies malicious behavior. Possible values are 0 – 100, with 100 being the highest. name: confidence - auto: PREDEFINED defaultValue: MediumHigh description: 'The severity of the malicious behavior identified by the data within the indicator, where High is the most severe and Informational is not severe at all.' name: severity predefined: - Informational - Low - MediumLow - MediumHigh - High - description: A comma-separated list that stores arbitrary tags/keywords. name: tags - description: "DateTime the file was compiled. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." name: file_compile_date_time - description: "DateTime the file was created. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." name: file_created_date_time - description: The type of hash stored in fileHashValue. name: file_hash_type auto: PREDEFINED predefined: - unknown - sha1 - sha256 - md5 - authenticodeHash256 - lsHash - ctph - description: The file hash value. name: file_hash_value - description: The Mutex name used in file-based detections. name: file_mutex_name - description: The name of the file if the indicator is file-based. Supports comma-separated list of file names. name: file_name - description: The packer used to build the file in question. name: file_packer - description: The path of the file indicating a compromise. May be a Windows or *nix style path. name: file_path - description: Size of the file in bytes. name: file_size - description: Text description of the type of file. For example, “Word Document” or “Binary”. name: file_type - description: Flag for the rate limit retry. name: ran_once_flag deprecated: true deprecated: true description: Deprecated. Use the microsoft-atp-sc-indicator-create command instead. Creates a file indicator. name: microsoft-atp-indicator-create-file outputs: - contextPath: MicrosoftATP.Indicators.id description: Created by the system when the indicator is ingested. Generated GUID/unique identifier. type: String - contextPath: MicrosoftATP.Indicators.action description: 'The action to apply if the indicator is matched from within the targetProduct security tool. Possible values: "unknown", "allow", "block", and "alert".' type: String - contextPath: MicrosoftATP.Indicators.additionalInformation description: A catchall area into which extra data from the indicator not covered by the other indicator properties may be placed. Data placed into additionalInformation is typically not used by the targetProduct security tool. type: String - contextPath: MicrosoftATP.Indicators.azureTenantId description: Stamped by the system when the indicator is ingested. The Entra ID tenant id of submitting client. type: String - contextPath: MicrosoftATP.Indicators.confidence description: An integer representing the confidence with which the data within the indicator accurately identifies malicious behavior. Possible values are 0 – 100, with 100 being the highest. type: Number - contextPath: MicrosoftATP.Indicators.description description: Brief description (100 characters or less) of the threat represented by the indicator. type: String - contextPath: MicrosoftATP.Indicators.diamondModel description: 'The area of the Diamond Model in which this indicator exists. Possible values: "unknown", "adversary", "capability", "infrastructure", and "victim".' type: String - contextPath: MicrosoftATP.Indicators.domainName description: Domain name associated with this indicator. Should be in the format subdomain.domain.topleveldomain. type: String - contextPath: MicrosoftATP.Indicators.expirationDateTime description: "DateTime string indicating when the indicator expires. To avoid stale indicators persisting in the system, all indicators must have an expiration date. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.externalId description: An identification number that ties the indicator back to the indicator provider’s system (e.g., a foreign key). type: String - contextPath: MicrosoftATP.Indicators.fileCompileDateTime description: "DateTime the file was compiled. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.fileCreatedDateTime description: "DateTime the file was created. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.fileHashType description: 'The type of hash stored in fileHashValue. Possible values: "unknown", "sha1", "sha256", "md5", "authenticodeHash256", "lsHash", and "ctph".' type: String - contextPath: MicrosoftATP.Indicators.fileHashValue description: The file hash value. type: String - contextPath: MicrosoftATP.Indicators.fileMutexName description: The Mutex name used in file-based detections. type: String - contextPath: MicrosoftATP.Indicators.fileName description: The name of the file if the indicator is file-based. Multiple file names may be delimited by commas. type: String - contextPath: MicrosoftATP.Indicators.filePacker description: The packer used to build the file in question. type: String - contextPath: MicrosoftATP.Indicators.filePath description: The path of the file indicating a compromise. Can be a Windows or *nix style path. type: String - contextPath: MicrosoftATP.Indicators.fileSize description: The size of the file in bytes. type: Number - contextPath: MicrosoftATP.Indicators.fileType description: Text description of the type of file. For example, “Word Document” or “Binary”. type: String - contextPath: MicrosoftATP.Indicators.ingestedDateTime description: "Timestamp the indicator was ingested into the system. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.isActive description: Used to deactivate indicators within the system. By default, any indicator submitted is set as active. However, providers may submit existing indicators with this set to ‘False’ to deactivate indicators in the system. type: Boolean - contextPath: MicrosoftATP.Indicators.knownFalsePositives description: Scenarios in which the indicator may cause false positives. This should be human-readable text. type: String - contextPath: MicrosoftATP.Indicators.lastReportedDateTime description: "The last time the indicator was seen. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.networkCidrBlock description: CIDR Block notation representation of the network referenced in this indicator. Use only if the Source and Destination cannot be identified. type: String - contextPath: MicrosoftATP.Indicators.networkDestinationAsn description: The destination autonomous system identifier of the network referenced in the indicator. type: Number - contextPath: MicrosoftATP.Indicators.networkDestinationCidrBlock description: The CIDR Block notation representation of the destination network in this indicator. type: String - contextPath: MicrosoftATP.Indicators.networkDestinationIPv4 description: The IPv4 IP address destination. type: String - contextPath: MicrosoftATP.Indicators.networkDestinationIPv6 description: The IPv6 IP address destination. type: String - contextPath: MicrosoftATP.Indicators.networkDestinationPort description: The TCP port destination. type: Number - contextPath: MicrosoftATP.Indicators.networkIPv4 description: The IPv4 IP address. type: String - contextPath: MicrosoftATP.Indicators.networkIPv6 description: The IPv6 IP address. type: String - contextPath: MicrosoftATP.Indicators.networkPort description: The TCP port. type: Number - contextPath: MicrosoftATP.Indicators.networkProtocol description: The decimal representation of the protocol field in the IPv4 header. type: Number - contextPath: MicrosoftATP.Indicators.networkSourceAsn description: The source autonomous system identifier of the network referenced in the indicator. type: Number - contextPath: MicrosoftATP.Indicators.networkSourceCidrBlock description: The CIDR Block notation representation of the source network in this indicator. type: String - contextPath: MicrosoftATP.Indicators.networkSourceIPv4 description: The IPv4 IP address source. type: String - contextPath: MicrosoftATP.Indicators.networkSourceIPv6 description: The IPv6 IP address source. type: String - contextPath: MicrosoftATP.Indicators.networkSourcePort description: The TCP port source. type: Number - contextPath: MicrosoftATP.Indicators.passiveOnly description: Determines if the indicator should trigger an event that is visible to an end user. When set to ‘true,’ security tools do not notify the end user that a ‘hit’ has occurred. This is most often treated as audit or silent mode by security products where they simply log that a match occurred but do not perform the action. Default value is false. type: Boolean - contextPath: MicrosoftATP.Indicators.severity description: 'Severity of the malicious behavior identified by the data within the indicator. Possible values: "Informational", "Low", "MediumLow", "MediumHigh", and "High", where High is the most severe and Informational is not severe at all.' type: Number - contextPath: MicrosoftATP.Indicators.targetProduct description: A string value representing a single security product to which the indicator should be applied. type: String - contextPath: MicrosoftATP.Indicators.threatType description: 'Each indicator must have a valid Indicator Threat Type. Possible values: "Botnet", "C2", "CryptoMining", "Darknet", "DDoS", "MaliciousUrl", "Malware", "Phishing", "Proxy", "PUA", and "WatchList".' type: String - contextPath: MicrosoftATP.Indicators.tlpLevel description: 'Traffic Light Protocol value for the indicator. Possible values: "unknown", "white", "green", "amber", and "red".' type: String - contextPath: MicrosoftATP.Indicators.url description: Uniform Resource Locator. This URL complies with RFC 1738. type: String - contextPath: MicrosoftATP.Indicators.userAgent description: User-Agent string from a web request that could indicate compromise. type: String - contextPath: MicrosoftATP.Indicators.vendorInformation description: Information about the vendor. type: String - contextPath: File.Name description: The full file name (including file extension). type: String - contextPath: File.Size description: 'The size of the file in bytes.' type: Number - contextPath: File.MD5 description: The MD5 hash of the file. type: String - contextPath: File.SHA1 description: The SHA1 hash of the file. type: String - contextPath: File.SHA256 description: The SHA256 hash of the file. type: String - contextPath: File.SHA512 description: The SHA512 hash of the file. type: String - contextPath: File.Type description: The file type, as determined by libmagic (same as displayed in file entries). type: String - contextPath: File.Path description: The path where the file is located. type: String polling: true - arguments: - description: The action to apply if the indicator is matched from within the targetProduct security tool. name: action required: true auto: PREDEFINED predefined: - unknown - allow - block - alert - description: 'Brief description (100 characters or less) of the threat represented by the indicator.' name: description required: true - description: 'DateTime string indicating when the indicator expires. Format: (<number> <time unit>, e.g., 12 hours, 7 days).' name: expiration_time required: true - description: Each indicator must have a valid Indicator Threat Type. name: threat_type auto: PREDEFINED predefined: - Botnet - C2 - CryptoMining - Darknet - DDoS - MaliciousUrl - Malware - Phishing - Proxy - PUA - WatchList required: true - description: 'Traffic Light Protocol value for the indicator.' name: tlp_level auto: PREDEFINED predefined: - unknown - white - green - amber - description: An integer representing the confidence with which the data within the indicator accurately identifies malicious behavior. Possible values are 0 – 100, with 100 being the highest. name: confidence - auto: PREDEFINED defaultValue: MediumHigh description: 'The severity of the malicious behavior identified by the data within the indicator, where High is the most severe and Informational is not severe at all.' name: severity predefined: - Informational - Low - MediumLow - MediumHigh - High - description: A comma-separated list that stores arbitrary tags/keywords. name: tags - description: Domain name associated with this indicator. Should be of the format subdomain.domain.topleveldomain (For example, example.domain.net). name: domain_name - description: CIDR Block notation representation of the network referenced in this indicator. Use only if the Source and Destination cannot be identified. name: network_cidr_block - description: The destination autonomous system identifier of the network referenced in the indicator. name: network_destination_asn - description: The CIDR Block notation representation of the destination network in this indicator. name: network_destination_cidr_block - description: The IPv4 IP address destination. name: network_destination_ipv4 - description: The IPv6 IP address destination. name: network_destination_ipv6 - description: The TCP port destination. name: network_destination_port - description: The IPv4 IP address. Use only if the Source and Destination cannot be identified. name: network_ipv4 - description: The IPv6 IP address. Use only if the Source and Destination cannot be identified. name: network_ipv6 - description: The TCP port. Use only if the Source and Destination cannot be identified. name: network_port - description: The decimal representation of the protocol field in the IPv4 header. name: network_protocol - description: The source autonomous system identifier of the network referenced in the indicator. name: network_source_asn - description: The CIDR Block notation representation of the source network in this indicator. name: network_source_cidr_block - description: The IPv4 IP address source. name: network_source_ipv4 - description: The IPv6 IP address source. name: network_source_ipv6 - description: The TCP port source. name: network_source_port - description: Uniform Resource Locator. This URL must comply with RFC 1738. name: url - description: User-Agent string from a web request that could indicate a compromise. name: user_agent - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag deprecated: true description: Deprecated. Use the microsoft-atp-sc-indicator-create command instead. Creates a network indicator. name: microsoft-atp-indicator-create-network outputs: - contextPath: MicrosoftATP.Indicators.id description: Created by the system when the indicator is ingested. Generated GUID/unique identifier. type: String - contextPath: MicrosoftATP.Indicators.action description: 'The action to apply if the indicator is matched from within the targetProduct security tool. Possible values: "unknown", "allow", "block", and "alert".' type: String - contextPath: MicrosoftATP.Indicators.additionalInformation description: A catchall area into which extra data from the indicator not covered by the other indicator properties may be placed. Data placed into additionalInformation is typically not used by the targetProduct security tool. type: String - contextPath: MicrosoftATP.Indicators.azureTenantId description: Stamped by the system when the indicator is ingested. The Entra ID tenant ID of the submitting client. type: String - contextPath: MicrosoftATP.Indicators.confidence description: An integer representing the confidence with which the data within the indicator accurately identifies malicious behavior. Possible values are 0 – 100, with 100 being the highest. type: Number - contextPath: MicrosoftATP.Indicators.description description: Brief description (100 characters or less) of the threat represented by the indicator. type: String - contextPath: MicrosoftATP.Indicators.diamondModel description: 'The area of the Diamond Model in which this indicator exists. Possible values: "unknown", "adversary", "capability", "infrastructure", and "victim".' type: String - contextPath: MicrosoftATP.Indicators.domainName description: Domain name associated with this indicator. Should be in the format subdomain.domain.topleveldomain. type: String - contextPath: MicrosoftATP.Indicators.expirationDateTime description: "DateTime string indicating when the indicator expires. To avoid stale indicators persisting in the system, all indicators must have an expiration date. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.externalId description: An identification number that ties the indicator back to the indicator provider’s system (e.g., a foreign key). type: String - contextPath: MicrosoftATP.Indicators.fileCompileDateTime description: "DateTime the file was compiled. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.fileCreatedDateTime description: "DateTime the file was created. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.fileHashType description: 'The type of hash stored in fileHashValue. Possible values: "unknown", "sha1", "sha256", "md5", "authenticodeHash256", "lsHash", and "ctph".' type: String - contextPath: MicrosoftATP.Indicators.fileHashValue description: The file hash value. type: String - contextPath: MicrosoftATP.Indicators.fileMutexName description: The Mutex name used in file-based detections. type: String - contextPath: MicrosoftATP.Indicators.fileName description: The name of the file if the indicator is file-based. Multiple file names may be delimited by commas. type: String - contextPath: MicrosoftATP.Indicators.filePacker description: The packer used to build the file in question. type: String - contextPath: MicrosoftATP.Indicators.filePath description: The path of the file indicating a compromise. Can be a Windows or *nix style path. type: String - contextPath: MicrosoftATP.Indicators.fileSize description: The size of the file in bytes. type: Number - contextPath: MicrosoftATP.Indicators.fileType description: Text description of the type of file. For example, “Word Document” or “Binary”. type: String - contextPath: MicrosoftATP.Indicators.ingestedDateTime description: "Timestamp the indicator was ingested into the system. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.isActive description: Used to deactivate indicators within the system. By default, any indicator submitted is set as active. However, providers may submit existing indicators with this set to ‘False’ to deactivate indicators in the system. type: Boolean - contextPath: MicrosoftATP.Indicators.knownFalsePositives description: Scenarios in which the indicator may cause false positives. This should be human-readable text. type: String - contextPath: MicrosoftATP.Indicators.lastReportedDateTime description: "The last time the indicator was seen. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.networkCidrBlock description: The CIDR Block notation representation of the network referenced in this indicator. Use only if the Source and Destination cannot be identified. type: String - contextPath: MicrosoftATP.Indicators.networkDestinationAsn description: The destination autonomous system identifier of the network referenced in the indicator. type: Number - contextPath: MicrosoftATP.Indicators.networkDestinationCidrBlock description: The CIDR Block notation representation of the destination network in this indicator. type: String - contextPath: MicrosoftATP.Indicators.networkDestinationIPv4 description: The IPv4 IP address destination. type: String - contextPath: MicrosoftATP.Indicators.networkDestinationIPv6 description: The IPv6 IP address destination. type: String - contextPath: MicrosoftATP.Indicators.networkDestinationPort description: The TCP port destination. type: Number - contextPath: MicrosoftATP.Indicators.networkIPv4 description: The IPv4 IP address. type: String - contextPath: MicrosoftATP.Indicators.networkIPv6 description: The IPv6 IP address. type: String - contextPath: MicrosoftATP.Indicators.networkPort description: The TCP port. type: Number - contextPath: MicrosoftATP.Indicators.networkProtocol description: The decimal representation of the protocol field in the IPv4 header. type: Number - contextPath: MicrosoftATP.Indicators.networkSourceAsn description: The source autonomous system identifier of the network referenced in the indicator. type: Number - contextPath: MicrosoftATP.Indicators.networkSourceCidrBlock description: The CIDR Block notation representation of the source network in this indicator. type: String - contextPath: MicrosoftATP.Indicators.networkSourceIPv4 description: The IPv4 IP address source. type: String - contextPath: MicrosoftATP.Indicators.networkSourceIPv6 description: The IPv6 IP address source. type: String - contextPath: MicrosoftATP.Indicators.networkSourcePort description: The TCP port source. type: Number - contextPath: MicrosoftATP.Indicators.passiveOnly description: Determines if the indicator should trigger an event that is visible to an end user. When set to ‘true,’ security tools do not notify the end user that a ‘hit’ has occurred. This is most often treated as audit or silent mode by security products where they simply log that a match occurred but do not perform the action. Default value is false. type: Boolean - contextPath: MicrosoftATP.Indicators.severity description: 'Severity of the malicious behavior identified by the data within the indicator. Possible values: "Informational", "Low", "MediumLow", "MediumHigh", and "High", where High is the most severe and Informational is not severe at all.' type: Number - contextPath: MicrosoftATP.Indicators.targetProduct description: A string value representing a single security product to which the indicator should be applied. type: String - contextPath: MicrosoftATP.Indicators.threatType description: 'Each indicator must have a valid Indicator Threat Type. Possible values: "Botnet", "C2", "CryptoMining", "Darknet", "DDoS", "MaliciousUrl", "Malware", "Phishing", "Proxy", "PUA", and "WatchList".' type: String - contextPath: MicrosoftATP.Indicators.tlpLevel description: 'Traffic Light Protocol value for the indicator. Possible values: "unknown", "white", "green", "amber", and "red".' type: String - contextPath: MicrosoftATP.Indicators.url description: Uniform Resource Locator. This URL complies with RFC 1738. type: String - contextPath: MicrosoftATP.Indicators.userAgent description: User-Agent string from a web request that could indicate compromise. type: String - contextPath: MicrosoftATP.Indicators.vendorInformation description: Information about the vendor. type: String - contextPath: File.Name description: The full file name (including file extension). type: String - contextPath: Domain.Name description: 'The domain name, for example: "google.com".' type: String - contextPath: IP.Address description: The IP address. type: String - contextPath: URL.Data description: The URL. type: String polling: true - arguments: - description: The ID of the indicator to update. name: indicator_id required: true - description: 'The severity of the malicious behavior identified by the data within the indicator, where High is the most severe and Informational is not severe at all.' name: severity defaultValue: MediumHigh auto: PREDEFINED predefined: - Informational - Low - MediumLow - MediumHigh - High - description: 'DateTime string indicating when the indicator expires. Format: (<number> <time unit>, e.g., 12 hours, 7 days).' name: expiration_time required: true - description: Brief description (100 characters or less) of the threat represented by the indicator. name: description - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag deprecated: true description: Deprecated. Use the microsoft-atp-sc-indicator-update command instead. Updates the specified indicator. name: microsoft-atp-indicator-update outputs: - contextPath: MicrosoftATP.Indicators.id description: Created by the system when the indicator is ingested. Generated GUID/unique identifier. type: String - contextPath: MicrosoftATP.Indicators.action description: 'The action to apply if the indicator is matched from within the targetProduct security tool. Possible values: "unknown", "allow", "block", "alert".' type: String - contextPath: MicrosoftATP.Indicators.additionalInformation description: A catchall area into which extra data from the indicator not covered by the other indicator properties may be placed. Data placed into additionalInformation is typically not used by the targetProduct security tool. type: String - contextPath: MicrosoftATP.Indicators.azureTenantId description: Stamped by the system when the indicator is ingested. The Entra ID tenant ID of the submitting client. type: String - contextPath: MicrosoftATP.Indicators.confidence description: An integer representing the confidence with which the data within the indicator accurately identifies malicious behavior. Possible values are 0 – 100, with 100 being the highest. type: Number - contextPath: MicrosoftATP.Indicators.description description: Brief description (100 characters or less) of the threat represented by the indicator. type: String - contextPath: MicrosoftATP.Indicators.diamondModel description: 'The area of the Diamond Model in which this indicator exists. Possible values: "unknown", "adversary", "capability", "infrastructure", and "victim".' type: String - contextPath: MicrosoftATP.Indicators.domainName description: Domain name associated with this indicator. Should be in the format subdomain.domain.topleveldomain. type: String - contextPath: MicrosoftATP.Indicators.expirationDateTime description: "DateTime string indicating when the indicator expires. To avoid stale indicators persisting in the system, all indicators must have an expiration date. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.externalId description: An identification number that ties the indicator back to the indicator provider’s system (e.g., a foreign key). type: String - contextPath: MicrosoftATP.Indicators.fileCompileDateTime description: "DateTime the file was compiled. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.fileCreatedDateTime description: "DateTime the file was created. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.fileHashType description: 'The type of hash stored in fileHashValue. Possible values: "unknown", "sha1", "sha256", "md5", "authenticodeHash256", "lsHash", and "ctph".' type: String - contextPath: MicrosoftATP.Indicators.fileHashValue description: The file hash value. type: String - contextPath: MicrosoftATP.Indicators.fileMutexName description: The Mutex name used in file-based detections. type: String - contextPath: MicrosoftATP.Indicators.fileName description: The name of the file if the indicator is file-based. Multiple file names may be delimited by commas. type: String - contextPath: MicrosoftATP.Indicators.filePacker description: The packer used to build the file in question. type: String - contextPath: MicrosoftATP.Indicators.filePath description: The path of the file indicating a compromise. Can be a Windows or *nix style path. type: String - contextPath: MicrosoftATP.Indicators.fileSize description: The size of the file in bytes. type: Number - contextPath: MicrosoftATP.Indicators.fileType description: Text description of the type of file. For example, “Word Document” or “Binary”. type: String - contextPath: MicrosoftATP.Indicators.ingestedDateTime description: "Timestamp the indicator was ingested into the system. The Timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.isActive description: Used to deactivate indicators within the system. By default, any indicator submitted is set as active. However, providers may submit existing indicators with this set to ‘False’ to deactivate indicators in the system. type: Boolean - contextPath: MicrosoftATP.Indicators.knownFalsePositives description: Scenarios in which the indicator may cause false positives. This should be human-readable text. type: String - contextPath: MicrosoftATP.Indicators.lastReportedDateTime description: "The last time the indicator was seen. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.networkCidrBlock description: The CIDR Block notation representation of the network referenced in this indicator. Use only if the Source and Destination cannot be identified. type: String - contextPath: MicrosoftATP.Indicators.networkDestinationAsn description: The destination autonomous system identifier of the network referenced in the indicator. type: Number - contextPath: MicrosoftATP.Indicators.networkDestinationCidrBlock description: The CIDR Block notation representation of the destination network in this indicator. type: String - contextPath: MicrosoftATP.Indicators.networkDestinationIPv4 description: The IPv4 IP address destination. type: String - contextPath: MicrosoftATP.Indicators.networkDestinationIPv6 description: The IPv6 IP address destination. type: String - contextPath: MicrosoftATP.Indicators.networkDestinationPort description: The TCP port destination. type: Number - contextPath: MicrosoftATP.Indicators.networkIPv4 description: The IPv4 IP address. type: String - contextPath: MicrosoftATP.Indicators.networkIPv6 description: The IPv6 IP address. type: String - contextPath: MicrosoftATP.Indicators.networkPort description: The TCP port. type: Number - contextPath: MicrosoftATP.Indicators.networkProtocol description: The decimal representation of the protocol field in the IPv4 header. type: Number - contextPath: MicrosoftATP.Indicators.networkSourceAsn description: The source autonomous system identifier of the network referenced in the indicator. type: Number - contextPath: MicrosoftATP.Indicators.networkSourceCidrBlock description: The CIDR Block notation representation of the source network in this indicator. type: String - contextPath: MicrosoftATP.Indicators.networkSourceIPv4 description: The IPv4 IP address source. type: String - contextPath: MicrosoftATP.Indicators.networkSourceIPv6 description: The IPv6 IP address source. type: String - contextPath: MicrosoftATP.Indicators.networkSourcePort description: The TCP port source. type: Number - contextPath: MicrosoftATP.Indicators.passiveOnly description: Determines if the indicator should trigger an event that is visible to an end user. When set to ‘true,’ security tools do not notify the end user that a ‘hit’ has occurred. This is most often treated as audit or silent mode by security products where they simply log that a match occurred but do not perform the action. Default value is false. type: Boolean - contextPath: MicrosoftATP.Indicators.severity description: 'Severity of the malicious behavior identified by the data within the indicator. Possible values: "Informational", "Low", "MediumLow", "MediumHigh", and "High", where High is the most severe and Informational is not severe at all.' type: String - contextPath: MicrosoftATP.Indicators.targetProduct description: A string value representing a single security product to which the indicator should be applied. type: String - contextPath: MicrosoftATP.Indicators.threatType description: 'Each indicator must have a valid Indicator Threat Type. Possible values: "Botnet", "C2", "CryptoMining", "Darknet", "DDoS", "MaliciousUrl", "Malware", "Phishing", "Proxy", "PUA", and "WatchList".' type: String - contextPath: MicrosoftATP.Indicators.tlpLevel description: 'Traffic Light Protocol value for the indicator. Possible values: "unknown", "white", "green", "amber", and "red".' type: String - contextPath: MicrosoftATP.Indicators.url description: Uniform Resource Locator. This URL complies with RFC 1738. type: String - contextPath: MicrosoftATP.Indicators.userAgent description: User-Agent string from a web request that could indicate compromise. type: String - contextPath: MicrosoftATP.Indicators.vendorInformation description: Information about the vendor. type: String - contextPath: File.Name description: The full file name (including file extension). type: String - contextPath: File.Size description: The size of the file in bytes. type: Number - contextPath: File.MD5 description: The MD5 hash of the file. type: String - contextPath: File.SHA1 description: The SHA1 hash of the file. type: String - contextPath: File.SHA256 description: The SHA256 hash of the file. type: String - contextPath: File.SHA512 description: The SHA512 hash of the file. type: String - contextPath: File.Type description: The file type, as determined by libmagic (same as displayed in file entries). type: String - contextPath: File.Path description: The path where the file is located. type: String - contextPath: Domain.Name description: 'The domain name, for example: "google.com".' type: String - contextPath: IP.Address description: IP address. type: String - contextPath: URL.Data description: The URL. type: String polling: true - arguments: - description: The ID of the indicator to delete. name: indicator_id required: true - description: 'Flag for the rate limit retry.' name: ran_once_flag deprecated: true description: Deprecated. Use the microsoft-atp-sc-indicator-delete command instead. Deletes the specified indicator. name: microsoft-atp-indicator-delete deprecated: true polling: true - arguments: - description: The value of the indicator to update. name: indicator_value required: true - auto: PREDEFINED description: Indicator Type. name: indicator_type required: true predefined: - FileSha1 - FileSha256 - FileMd5 - IpAddress - DomainName - Url - auto: PREDEFINED description: The action taken if the indicator is discovered in the organization. name: action required: true predefined: - Audit - Block - BlockAndRemediate - Allowed - Warn - auto: PREDEFINED description: 'The severity of the malicious behavior identified by the data within the indicator, where High is the most severe and Informational is not severe at all.' name: severity predefined: - Informational - Low - Medium - High - description: 'DateTime string indicating when the indicator expires. Format: (<number> <time unit>, e.g., 12 hours, 7 days). If not provided, the indicator will not expire.' name: expiration_time - description: Brief description (100 characters or less) of the threat represented by the indicator. name: indicator_description required: true - description: The indicator alert title. name: indicator_title required: true - description: The application associated with the indicator. name: indicator_application - description: The indicator alert recommended actions. name: recommended_actions - description: A comma-separated list of RBAC group names the indicator is applied to. isArray: true name: rbac_group_names - description: Flag for the rate limit retry. name: ran_once_flag deprecated: true - description: Whether to generate an alert for the indicator. name: generate_alert description: Updates the specified indicator. name: microsoft-atp-sc-indicator-update outputs: - contextPath: MicrosoftATP.Indicators.id description: Created by the system when the indicator is ingested. Generated GUID/unique identifier. type: String - contextPath: MicrosoftATP.Indicators.action description: 'The action to apply if the indicator is matched from within the targetProduct security tool. Possible values: "unknown", "allow", "block", and "alert".' type: String - contextPath: MicrosoftATP.Indicators.description description: Brief description (100 characters or less) of the threat represented by the indicator. type: String - contextPath: MicrosoftATP.Indicators.expirationTime description: "DateTime string indicating when the indicator expires. To avoid stale indicators persisting in the system, all indicators must have an expiration date. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.severity description: 'The severity of the malicious behavior identified by the data within the indicator. Possible values: "Informational", "Low", "Medium", and "High", where High is the most severe and Informational is not severe at all.' type: String - contextPath: MicrosoftATP.Indicators.indicatorValue description: The value of the indicator. type: String - contextPath: MicrosoftATP.Indicators.recommendedActions description: Recommended actions for the indicator. type: String - contextPath: MicrosoftATP.Indicators.generateAlert description: Whether an alert was generated. type: Boolean - contextPath: MicrosoftATP.Indicators.rbacGroupNames description: A list of RBAC device group names where the indicator is exposed and active. Empty list if it is exposed to all devices. type: Unknown - contextPath: MicrosoftATP.Indicators.mitreTechniques description: A list of MITRE techniques. type: Unknown - contextPath: MicrosoftATP.Indicators.indicatorType description: 'The indicator type. Possible values: "FileSha1", "FileSha256", "IpAddress", "DomainName" and "Url".' type: String - contextPath: MicrosoftATP.Indicators.lastUpdateTime description: The last time the indicator was updated. type: Date - contextPath: MicrosoftATP.Indicators.createdByDisplayName description: Display name of the created app. type: String - contextPath: MicrosoftATP.Indicators.application description: The application associated with the indicator. type: String - contextPath: MicrosoftATP.Indicators.title description: The indicator title. type: String - contextPath: MicrosoftATP.Indicators.createdBySource description: The source of indicator creation. For example, PublicApi. type: String - contextPath: MicrosoftATP.Indicators.historicalDetection description: Whether a historical detection exists. type: Boolean - contextPath: MicrosoftATP.Indicators.lastUpdatedBy description: The identity of the user/application that last updated the indicator. type: String - contextPath: MicrosoftATP.Indicators.creationTimeDateTimeUtc description: The date and time the indicator was created. type: Date - contextPath: MicrosoftATP.Indicators.category description: An number representing the indicator category. type: Number - contextPath: MicrosoftATP.Indicators.createdBy description: Unique identity of the user/application that submitted the indicator. type: String - contextPath: File.MD5 description: The MD5 hash of the file. type: String - contextPath: File.SHA1 description: The SHA1 hash of the file. type: String - contextPath: File.SHA256 description: The SHA256 hash of the file. type: String - contextPath: Domain.Name description: 'The domain name, for example: "google.com".' type: String - contextPath: IP.Address description: The IP address. type: String - contextPath: URL.Data description: The URL. type: String - contextPath: DBotScore.Indicator description: The indicator that was tested. type: String - contextPath: DBotScore.Type description: The indicator type. type: String - contextPath: DBotScore.Vendor description: The vendor used to calculate the score. type: String - contextPath: DBotScore.Score description: The actual score. type: Number polling: true compliantpolicies: - Quarantine File - arguments: - description: The value of the indicator to update. name: indicator_value required: true - description: Indicator Type. name: indicator_type auto: PREDEFINED required: true predefined: - FileSha1 - FileSha256 - FileMd5 - IpAddress - DomainName - Url - auto: PREDEFINED description: The action taken if the indicator is discovered in the organization. name: action required: true predefined: - Audit - Block - BlockAndRemediate - Allowed - Warn - auto: PREDEFINED description: 'The severity of the malicious behavior identified by the data within the indicator, where High is the most severe and Informational is not severe at all.' name: severity predefined: - Informational - Low - Medium - High - description: 'DateTime string indicating when the indicator expires. Format: (<number> <time unit>, e.g., 12 hours, 7 days). If not provided, the indicator will not expire.' name: expiration_time - description: Brief description (100 characters or less) of the threat represented by the indicator. name: indicator_description required: true - description: The indicator alert title. name: indicator_title required: true - description: The application associated with the indicator. name: indicator_application - description: The indicator alert recommended actions. name: recommended_actions - description: A comma-separated list of RBAC group names the indicator is applied to. isArray: true name: rbac_group_names - description: Flag for the rate limit retry. name: ran_once_flag deprecated: true - description: Whether to generate an alert for the indicator. name: generate_alert description: Creates a new indicator. name: microsoft-atp-sc-indicator-create outputs: - contextPath: MicrosoftATP.Indicators.id description: Created by the system when the indicator is ingested. Generated GUID/unique identifier. type: String - contextPath: MicrosoftATP.Indicators.action description: 'The action to apply if the indicator is matched from within the targetProduct security tool. Possible values: "unknown", "allow", "block", "alert".' type: String - contextPath: MicrosoftATP.Indicators.description description: Brief description (100 characters or less) of the threat represented by the indicator. type: String - contextPath: MicrosoftATP.Indicators.expirationTime description: "DateTime string indicating when the indicator expires. To avoid stale indicators persisting in the system, all indicators must have an expiration date. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.severity description: 'The severity of the malicious behavior identified by the data within the indicator. Possible values: "Informational", "Low", "Medium", and "High", where High is the most severe and Informational is not severe at all.' type: String - contextPath: MicrosoftATP.Indicators.indicatorValue description: The value of the indicator. type: String - contextPath: MicrosoftATP.Indicators.recommendedActions description: Recommended actions for the indicator. type: String - contextPath: MicrosoftATP.Indicators.generateAlert description: Whether an alert was generated. type: Boolean - contextPath: MicrosoftATP.Indicators.rbacGroupNames description: A list of RBAC device group names where the indicator is exposed and active. Empty list if it is exposed to all devices. type: Unknown - contextPath: MicrosoftATP.Indicators.mitreTechniques description: A list of MITRE techniques. type: Unknown - contextPath: MicrosoftATP.Indicators.indicatorType description: 'Indicator Type. Possible values: "FileSha1", "FileSha256", "IpAddress", "DomainName" and "Url".' type: String - contextPath: MicrosoftATP.Indicators.lastUpdateTime description: The last time the indicator was updated. type: Date - contextPath: MicrosoftATP.Indicators.createdByDisplayName description: The display name of the created app. type: String - contextPath: MicrosoftATP.Indicators.application description: The application associated with the indicator. type: String - contextPath: MicrosoftATP.Indicators.title description: The indicator title. type: String - contextPath: MicrosoftATP.Indicators.createdBySource description: Source of indicator creation. For example, PublicApi. type: String - contextPath: MicrosoftATP.Indicators.historicalDetection description: Whether a historical detection exists. type: Boolean - contextPath: MicrosoftATP.Indicators.lastUpdatedBy description: The identity of the user/application that last updated the indicator. type: String - contextPath: MicrosoftATP.Indicators.creationTimeDateTimeUtc description: The date and time the indicator was created. type: Date - contextPath: MicrosoftATP.Indicators.category description: An number representing the indicator category. type: Number - contextPath: MicrosoftATP.Indicators.createdBy description: Unique identity of the user/application that submitted the indicator. type: String - contextPath: File.MD5 description: The MD5 hash of the file. type: String - contextPath: File.SHA1 description: The SHA1 hash of the file. type: String - contextPath: File.SHA256 description: The SHA256 hash of the file. type: String - contextPath: Domain.Name description: 'The domain name, for example: "google.com".' type: String - contextPath: IP.Address description: IP address. type: String - contextPath: URL.Data description: The URL. type: String - contextPath: DBotScore.Indicator description: The indicator that was tested. type: String - contextPath: DBotScore.Type description: The indicator type. type: String - contextPath: DBotScore.Vendor description: The vendor used to calculate the score. type: String - contextPath: DBotScore.Score description: The actual score. type: Number polling: true compliantpolicies: - Quarantine File - arguments: - description: The ID of the indicator to delete. The ID can be retrieved by running the microsoft-atp-sc-indicator-list command. name: indicator_id required: true - description: Flag for the rate limit retry. name: ran_once_flag deprecated: true description: Deletes the specified indicator. name: microsoft-atp-sc-indicator-delete polling: true compliantpolicies: - Quarantine File - arguments: - description: The maximum number of indicators to return. name: limit defaultValue: '50' - description: The number of indicators that are to be skipped and not included in the result. name: skip - description: The value of the indicator to get. name: indicator_value - description: The title of the indicator to get. name: indicator_title - auto: PREDEFINED description: The type of the indicator to get. name: indicator_type predefined: - FileSha1 - FileSha256 - FileMd5 - IpAddress - DomainName - Url - CertificateThumbprint - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Lists all indicators by the ID that the system creates when the indicator is ingested. name: microsoft-atp-sc-indicator-list outputs: - contextPath: MicrosoftATP.Indicators.id description: Created by the system when the indicator is ingested. Generated GUID/unique identifier. type: String - contextPath: MicrosoftATP.Indicators.action description: 'The action to apply if the indicator is matched from within the targetProduct security tool. Possible values: "unknown", "allow", "block", and "alert".' type: String - contextPath: MicrosoftATP.Indicators.description description: Brief description (100 characters or less) of the threat represented by the indicator. type: String - contextPath: MicrosoftATP.Indicators.expirationTime description: "DateTime string indicating when the indicator expires. To avoid stale indicators persisting in the system, all indicators must have an expiration date. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.severity description: 'The severity of the malicious behavior identified by the data within the indicator. Possible values: "Informational", "Low", "Medium", and "High", where High is the most severe and Informational is not severe at all.' type: String - contextPath: MicrosoftATP.Indicators.indicatorValue description: The value of the indicator. type: String - contextPath: MicrosoftATP.Indicators.recommendedActions description: Recommended actions for the indicator. type: String - contextPath: MicrosoftATP.Indicators.generateAlert description: Whether an alert was generated. type: Boolean - contextPath: MicrosoftATP.Indicators.rbacGroupNames description: A list of RBAC device group names where the indicator is exposed and active. Empty list if it is exposed to all devices. type: Unknown - contextPath: MicrosoftATP.Indicators.mitreTechniques description: A list of MITRE techniques. type: Unknown - contextPath: MicrosoftATP.Indicators.indicatorType description: 'Indicator Type. Possible values: "FileSha1", "FileSha256", "IpAddress", "DomainName" and "Url".' type: String - contextPath: MicrosoftATP.Indicators.lastUpdateTime description: The last time the indicator was updated. type: Date - contextPath: MicrosoftATP.Indicators.createdByDisplayName description: The display name of the created app. type: String - contextPath: MicrosoftATP.Indicators.application description: The application associated with the indicator. type: String - contextPath: MicrosoftATP.Indicators.title description: The indicator title. type: String - contextPath: MicrosoftATP.Indicators.createdBySource description: The source of indicator creation. For example, PublicApi. type: String - contextPath: MicrosoftATP.Indicators.historicalDetection description: Whether a historical detection exists. type: Boolean - contextPath: MicrosoftATP.Indicators.lastUpdatedBy description: The identity of the user/application that last updated the indicator. type: String - contextPath: MicrosoftATP.Indicators.creationTimeDateTimeUtc description: The date and time the indicator was created. type: Date - contextPath: MicrosoftATP.Indicators.category description: A number representing the indicator category. type: Number - contextPath: MicrosoftATP.Indicators.createdBy description: Unique identity of the user/application that submitted the indicator. type: String - contextPath: File.MD5 description: The MD5 hash of the file. type: String - contextPath: File.SHA1 description: The SHA1 hash of the file. type: String - contextPath: File.SHA256 description: The SHA256 hash of the file. type: String - contextPath: Domain.Name description: 'The domain name, for example: "google.com".' type: String - contextPath: IP.Address description: The IP address. type: String - contextPath: URL.Data description: The URL. type: String - contextPath: DBotScore.Indicator description: The indicator that was tested. type: String - contextPath: DBotScore.Type description: The indicator type. type: String - contextPath: DBotScore.Vendor description: The vendor used to calculate the score. type: String - contextPath: DBotScore.Score description: The actual score. type: Number polling: true - arguments: - description: The ID of the indicator to get. The ID can be retrieved by running the microsoft-atp-sc-indicator-list command. name: indicator_id default: true required: true - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Gets an indicator by its ID. name: microsoft-atp-sc-indicator-get-by-id outputs: - contextPath: MicrosoftATP.Indicators.id description: Created by the system when the indicator is ingested. Generated GUID/unique identifier. type: String - contextPath: MicrosoftATP.Indicators.action description: 'The action to apply if the indicator is matched from within the targetProduct security tool. Possible values: "unknown", "allow", "block", and "alert".' type: String - contextPath: MicrosoftATP.Indicators.description description: Brief description (100 characters or less) of the threat represented by the indicator. type: String - contextPath: MicrosoftATP.Indicators.expirationTime description: "DateTime string indicating when the indicator expires. To avoid stale indicators persisting in the system, all indicators must have an expiration date. The timestamp type represents date and time information in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like: '2014-01-01T00:00:00Z'." type: Date - contextPath: MicrosoftATP.Indicators.severity description: 'The severity of the malicious behavior identified by the data within the indicator. Possible values: "Informational", "Low", "Medium" and "High", where High is the most severe and Informational is not severe at all.' type: String - contextPath: MicrosoftATP.Indicators.indicatorValue description: The value of the indicator. type: String - contextPath: MicrosoftATP.Indicators.recommendedActions description: Recommended actions for the indicator. type: String - contextPath: MicrosoftATP.Indicators.generateAlert description: Whether an alert was generated. type: Boolean - contextPath: MicrosoftATP.Indicators.rbacGroupNames description: A list of RBAC device group names where the indicator is exposed and active. Empty list if it is exposed to all devices. type: Unknown - contextPath: MicrosoftATP.Indicators.mitreTechniques description: A list of MITRE techniques. type: Unknown - contextPath: MicrosoftATP.Indicators.indicatorType description: 'Indicator type. Possible values: "FileSha1", "FileSha256", "IpAddress", "DomainName" and "Url".' type: String - contextPath: MicrosoftATP.Indicators.lastUpdateTime description: The last time the indicator was updated. type: Date - contextPath: MicrosoftATP.Indicators.createdByDisplayName description: The display name of the created app. type: String - contextPath: MicrosoftATP.Indicators.application description: The application associated with the indicator. type: String - contextPath: MicrosoftATP.Indicators.title description: The indicator title. type: String - contextPath: MicrosoftATP.Indicators.createdBySource description: The source of indicator creation. For example, PublicApi. type: String - contextPath: MicrosoftATP.Indicators.historicalDetection description: Whether a historical detection exists. type: Boolean - contextPath: MicrosoftATP.Indicators.lastUpdatedBy description: The identity of the user/application that last updated the indicator. type: String - contextPath: MicrosoftATP.Indicators.creationTimeDateTimeUtc description: The date and time the indicator was created. type: Date - contextPath: MicrosoftATP.Indicators.category description: An number representing the indicator category. type: Number - contextPath: MicrosoftATP.Indicators.createdBy description: Unique identity of the user/application that submitted the indicator. type: String - contextPath: File.MD5 description: The MD5 hash of the file. type: String - contextPath: File.SHA1 description: The SHA1 hash of the file. type: String - contextPath: File.SHA256 description: The SHA256 hash of the file. type: String - contextPath: Domain.Name description: 'The domain name, for example: "google.com".' type: String - contextPath: IP.Address description: The IP address. type: String - contextPath: URL.Data description: The URL. type: String - contextPath: DBotScore.Indicator description: The indicator that was tested. type: String - contextPath: DBotScore.Type description: The indicator type. type: String - contextPath: DBotScore.Vendor description: The vendor used to calculate the score. type: String - contextPath: DBotScore.Score description: The actual score. type: Number polling: true - arguments: - description: Software ID. Use the !microsoft-atp-list-software command to get the ID. name: id description: Retrieve a list of device references that has this software installed. name: microsoft-atp-list-machines-by-software outputs: - contextPath: MicrosoftATP.SoftwareMachine.id description: Machine identity. type: String - contextPath: MicrosoftATP.SoftwareMachine.computerDnsName description: Machine fully qualified name. type: String - contextPath: MicrosoftATP.SoftwareMachine.osPlatform description: Operating system platform. type: String - contextPath: MicrosoftATP.SoftwareMachine.rbacGroupName description: Machine group name. type: String - contextPath: MicrosoftATP.SoftwareMachine.rbacGroupId description: Machine group ID. type: Number - arguments: - description: Software ID. Use the !microsoft-atp-list-software command to get the ID. required: true name: id description: Retrieves missing KBs (security updates) by software ID. name: microsoft-atp-list-missing-kb-by-software outputs: - contextPath: MicMicrosoftATP.SoftwareKB.id description: Software ID. type: String - contextPath: MicMicrosoftATP.SoftwareKB.name description: Software name. type: String - contextPath: MicMicrosoftATP.SoftwareKB.osBuild description: The operating system build number. type: Number - contextPath: MicMicrosoftATP.SoftwareKB.productsNames description: 'Product names.' type: String - contextPath: MicMicrosoftATP.SoftwareKB.url description: URL. type: String - contextPath: MicMicrosoftATP.SoftwareKB.machineMissedOn description: Machine missed on. type: Number - contextPath: MicMicrosoftATP.SoftwareKB.cveAddressed description: CVE addressed. type: Number - arguments: - description: Software ID. Use the !microsoft-atp-list-software command to get the ID. name: id required: true description: Retrieves a list of all the vulnerabilities affecting the organization per software. name: microsoft-atp-list-vulnerabilities-by-software outputs: - contextPath: MicrosoftATP.SoftwareCVE.id description: Vulnerability ID. type: String - contextPath: MicrosoftATP.SoftwareCVE.name description: Vulnerability title. type: String - contextPath: MicrosoftATP.SoftwareCVE.description description: Vulnerability description. type: String - contextPath: MicrosoftATP.SoftwareCVE.severity description: 'Vulnerability severity. Possible values are: "Low", "Medium", "High", "Critical".' type: String - contextPath: MicrosoftATP.SoftwareCVE.cvssV3 description: CVSS v3 score. type: Number - contextPath: MicrosoftATP.SoftwareCVE.exposedMachines description: Number of exposed devices. type: Number - contextPath: MicrosoftATP.SoftwareCVE.publishedOn description: Date when vulnerability was published. Date format will be in ISO 8601 format or relational expressions like “7 days ago”. type: Date - contextPath: MicrosoftATP.SoftwareCVE.updatedOn description: Date when vulnerability was updated. Date format will be in ISO 8601 format or relational expressions like “7 days ago”. type: Date - contextPath: MicrosoftATP.SoftwareCVE.publicExploit description: Whether a public exploit exists for some of the vulnerabilities. type: Boolean - contextPath: MicrosoftATP.SoftwareCVE.exploitVerified description: Whether a public exploit exists. type: Boolean - contextPath: MicrosoftATP.SoftwareCVE.exploitInKit description: Whether the exploit is part of an exploit kit. type: Boolean - contextPath: MicrosoftATP.SoftwareCVE.exploitTypes description: 'Exploit impact. Possible values are: "Local privilege escalation", "Denial of service", "Local".' type: String - contextPath: MicrosoftATP.SoftwareCVE.exploitUris description: Exploit source URLs. type: String - arguments: - description: Software ID. isArray: true name: id - description: Software name. isArray: true name: name - description: Software publisher name. isArray: true name: vendor - description: Maximum number of results to retrieve. name: limit defaultValue: '50' - description: The number of items in the queried collection that are to be skipped and not included in the result.. name: offset defaultValue: '0' description: Retrieves the organization software inventory. name: microsoft-atp-list-software outputs: - contextPath: MicrosoftATP.Software.id description: Software ID. type: String - contextPath: MicrosoftATP.Software.name description: Software name. type: String - contextPath: MicrosoftATP.Software.vendor description: Software publisher name. type: String - contextPath: MicrosoftATP.Software.weaknesses description: Number of discovered vulnerabilities. type: Number - contextPath: MicrosoftATP.Software.publicExploit description: Whether a public exploit exists for some of the vulnerabilities. type: Boolean - contextPath: MicrosoftATP.Software.activeAlert description: Whether an active alert is associated with this software. type: Boolean - contextPath: MicrosoftATP.Software.exposedMachines description: Number of exposed devices. type: Number - contextPath: MicrosoftATP.Software.installedMachines description: 'The number of installed machines.' type: Number - contextPath: MicrosoftATP.Software.impactScore description: Exposure score impact of this software. type: Number - contextPath: MicrosoftATP.Software.isNormalized description: Whether the software is normalized. type: Boolean - contextPath: MicrosoftATP.Software.category description: Software category. type: String - contextPath: MicrosoftATP.Software.distributions description: Software distributions. type: String - arguments: - description: A comma-separated list of machine IDs used for getting the vulnerabilities. isArray: true name: machine_id - description: A comma-separated list of software IDs used for getting the vulnerabilities. name: software_id isArray: true - description: A comma-separated list of CVE IDs used for getting the vulnerabilities. name: cve_id isArray: true - description: A comma-separated list of product names used for getting the vulnerabilities. name: product_name isArray: true - description: A comma-separated list of product versions used for getting the vulnerabilities. name: product_version isArray: true - description: 'A comma-separated list of vulnerability severities. Possible values are: "Low", "Medium", "High", "Critical".' name: severity isArray: true - description: 'A comma-separated list of product vendors used for getting the vulnerabilities.' isArray: true name: product_vendor - description: Maximum number of results to retrieve. name: limit defaultValue: '25' - description: The number of items in the queried collection that are to be skipped and not included in the result. name: offset defaultValue: '0' description: Retrieves a list of all the vulnerabilities affecting the organization per machine. name: microsoft-atp-list-vulnerabilities-by-machine outputs: - contextPath: MicrosoftATP.MachineCVE.id description: Vulnerability ID. type: String - contextPath: MicrosoftATP.MachineCVE.cveId description: CVE ID. type: String - contextPath: MicrosoftATP.MachineCVE.machineId description: Machine ID. type: String - contextPath: MicrosoftATP.MachineCVE.fixingKbId description: 'Fixing Kb ID.' type: Unknown - contextPath: MicrosoftATP.MachineCVE.productName description: Product name. type: String - contextPath: MicrosoftATP.MachineCVE.productVendor description: Name of the product vendor. type: String - contextPath: MicrosoftATP.MachineCVE.productVersion description: Product version. type: String - contextPath: MicrosoftATP.MachineCVE.severity description: 'Vulnerability severity. Possible values are: "Low", "Medium", "High", "Critical".' type: String - arguments: - description: Vulnerability ID. name: id isArray: true - description: Vulnerability title. name: name_equal - description: Vulnerability title. Does not work with another filter arguments. name: name_contains - description: Vulnerability description. Does not work with another filter arguments. name: description_contains - description: Date when the vulnerability was published. Date format will be in ISO 8601 format or relational expressions like “7 days ago”. name: published_on - description: CVSS v3 score. name: cvss - description: 'A comma-separated list of vulnerability severities. Possible values are: "Low", "Medium", "High", "Critical".' isArray: true name: severity - description: Date when the vulnerability was updated. Date format will be in ISO 8601 format or relational expressions like “7 days ago”. name: updated_on - description: Maximum number of results to retrieve. name: limit defaultValue: '25' - description: The number of items in the queried collection that are to be skipped and not included in the result. defaultValue: '0' name: offset description: |- Retrieves a list of all vulnerabilities. name: microsoft-atp-list-vulnerabilities outputs: - contextPath: MicrosoftATP.Vulnerability.id description: Vulnerability ID. type: String - contextPath: MicrosoftATP.Vulnerability.name description: Vulnerability title. type: String - contextPath: MicrosoftATP.Vulnerability.description description: Vulnerability description. type: String - contextPath: MicrosoftATP.Vulnerability.severity description: 'Vulnerability severity. Possible values are: "Low", "Medium", "High", "Critical".' type: String - contextPath: MicrosoftATP.Vulnerability.cvssV3 description: CVSS v3 score. type: Number - contextPath: MicrosoftATP.Vulnerability.exposedMachines description: Number of exposed devices. type: Number - contextPath: MicrosoftATP.Vulnerability.publishedOn description: Date when the vulnerability was published. Date format will be in ISO 8601 format or relational expressions like “7 days ago”. type: Date - contextPath: MicrosoftATP.Vulnerability.updatedOn description: Date when the vulnerability was updated. Date format will be in ISO 8601 format or relational expressions like “7 days ago”. type: Date - contextPath: MicrosoftATP.Vulnerability.publicExploit description: Whether the public exploit exists. type: Boolean - contextPath: MicrosoftATP.Vulnerability.exploitVerified description: Whether the exploit is verified to work. type: Boolean - contextPath: MicrosoftATP.Vulnerability.exploitInKit description: Whether the exploit is part of an exploit kit. type: Boolean - contextPath: MicrosoftATP.Vulnerability.exploitTypes description: 'Exploit impact. Possible values are: "Local privilege escalation", "Denial of service", "Local".' type: String - contextPath: MicrosoftATP.Vulnerability.exploitUris description: Exploit source URLs. type: String - arguments: - description: Software ID. Use the !microsoft-atp-list-software command to get the ID. name: id description: |- Retrieves a list of your organization's software version distribution. name: microsoft-atp-list-software-version-distribution outputs: - contextPath: MicrosoftATP.SoftwareVersion.version description: Version number. type: String - contextPath: MicrosoftATP.SoftwareVersion.installations description: Installations number. type: Number - contextPath: MicrosoftATP.SoftwareVersion.vulnerabilities description: Number of vulnerabilities. type: Number - arguments: - default: true description: A comma-separated list of CVE IDs used for getting the machines. isArray: true name: cve_id required: true - description: Flag for the rate limit retry. name: ran_once_flag deprecated: true description: Retrieves a list of machines affected by a vulnerability. name: microsoft-atp-list-machines-by-vulnerability outputs: - contextPath: MicrosoftATP.CveMachine.ID description: The machine ID. type: String - contextPath: MicrosoftATP.CveMachine.ComputerDNSName description: The machine hostname. type: String - contextPath: MicrosoftATP.CveMachine.OSPlatform description: The operating system platform. type: String - contextPath: MicrosoftATP.CveMachine.RBACGroupName description: The machine RBAC group name. type: String - contextPath: MicrosoftATP.CveMachine.CVE description: The given CVE IDs related to this machine. type: Unknown polling: true - arguments: - description: A comma-separated list of file hashes (SHA1 or SHA256) used for getting the file information. isArray: true name: hash default: true required: true - description: Flag for the rate limit retry. name: ran_once_flag deprecated: true description: Retrieves file information by a file hash (SHA1 or SHA256). name: microsoft-atp-get-file-info outputs: - contextPath: MicrosoftATP.File.Sha1 description: The SHA1 hash of the file. type: String - contextPath: MicrosoftATP.File.MD5 description: The MD5 hash of the file. type: String - contextPath: MicrosoftATP.File.Sha256 description: The SHA256 hash of the file. type: String - contextPath: MicrosoftATP.File.GlobalPrevalence description: The file prevalence across the organization. type: Number - contextPath: MicrosoftATP.File.GlobalFirstObserved description: The first time the file was observed. type: Date - contextPath: MicrosoftATP.File.GlobalLastObserved description: The last time the file was observed. type: Date - contextPath: MicrosoftATP.File.Size description: The size of the file. type: Number - contextPath: MicrosoftATP.File.FileType description: The type of the file. type: String - contextPath: MicrosoftATP.File.IsPeFile description: True if the file is portable executable, False otherwise. type: Boolean - contextPath: MicrosoftATP.File.FilePublisher description: The file's publisher. type: String - contextPath: MicrosoftATP.File.FileProductName description: The file product name. type: String - contextPath: MicrosoftATP.File.Signer description: The file signer. type: String - contextPath: MicrosoftATP.File.Issuer description: The file issuer. type: String - contextPath: MicrosoftATP.File.SignerHash description: The hash of the signing certificate. type: String - contextPath: MicrosoftATP.File.IsValidCertificate description: Was signing certificate successfully verified by Microsoft Defender ATP agent. type: Boolean - contextPath: MicrosoftATP.File.DeterminationValue description: The file determination value. type: String - contextPath: MicrosoftATP.File.DeterminationType description: The file determination type. type: String - contextPath: File.SHA1 description: The SHA1 hash of the file. type: String - contextPath: File.SHA256 description: The SHA256 hash of the file. type: String - contextPath: File.Type description: The file type. type: String - contextPath: File.Size description: The file size. type: Number polling: true - name: endpoint description: Gets machines that have communicated with Microsoft Defender for Endpoint cloud. At least one of the following arguments is required - IP, hostname, or ID. Otherwise, an error appears. arguments: - name: id description: 'The endpoint ID.' isArray: true - name: ip description: The endpoint IP address. default: true isArray: true - description: The endpoint hostname. isArray: true name: hostname - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag outputs: - contextPath: Endpoint.ID description: The endpoint's identifier. type: String - contextPath: Endpoint.Hostname description: The hostname of the endpoint. type: String - contextPath: Endpoint.OS description: The endpoint's operating system. type: String - contextPath: Endpoint.OSVersion description: The endpoint's operating system's version. type: String - contextPath: Endpoint.IPAddress description: The endpoint's IP address. type: String - contextPath: Endpoint.Status description: The health status of the endpoint. type: String - contextPath: Endpoint.MACAddress description: The endpoint's MAC address. type: String - contextPath: Endpoint.Vendor description: The integration name of the endpoint vendor. type: String - contextPath: MicrosoftATP.Machine.ID description: The machine ID. type: String - contextPath: MicrosoftATP.Machine.ComputerDNSName description: The machine DNS name. type: String - contextPath: MicrosoftATP.Machine.FirstSeen description: The first date and time the machine was observed by Microsoft Defender ATP. type: Date - contextPath: MicrosoftATP.Machine.LastSeen description: The last date and time the machine was observed by Microsoft Defender ATP. type: Date - contextPath: MicrosoftATP.Machine.OSPlatform description: The operating system platform. type: String - contextPath: MicrosoftATP.Machine.OSVersion description: The operating system version. type: String - contextPath: MicrosoftATP.Machine.OSProcessor description: The operating system processor. type: String - contextPath: MicrosoftATP.Machine.LastIPAddress description: The last IP on the machine. type: String - contextPath: MicrosoftATP.Machine.LastExternalIPAddress description: The last machine IP to access the internet. type: String - contextPath: MicrosoftATP.Machine.OSBuild description: The operating system build number. type: Number - contextPath: MicrosoftATP.Machine.HealthStatus description: The machine health status. type: String - contextPath: MicrosoftATP.Machine.RBACGroupID description: The machine RBAC group ID. type: Number - contextPath: MicrosoftATP.Machine.RBACGroupName description: The machine RBAC group name. type: String - contextPath: MicrosoftATP.Machine.RiskScore description: The machine risk score. type: String - contextPath: MicrosoftATP.Machine.ExposureLevel description: The machine exposure score. type: String - contextPath: MicrosoftATP.Machine.IsAADJoined description: True if machine is AAD joined, False otherwise. type: Boolean - contextPath: MicrosoftATP.Machine.AADDeviceID description: The AAD Device ID. type: String - contextPath: MicrosoftATP.Machine.MachineTags description: Set of machine tags. type: String - contextPath: MicrosoftATP.Machine.IPAddresses.ipAddress description: The machine IP address. type: String - contextPath: MicrosoftATP.Machine.IPAddresses.MACAddress description: The machine MAC address. type: String - contextPath: MicrosoftATP.Machine.IPAddresses.operationalStatus description: The machine operational status. type: String - contextPath: MicrosoftATP.Machine.IPAddresses.type description: The machine IP address type. type: String - contextPath: MicrosoftATP.Machine.AgentVersion description: The machine Agent version. type: String polling: true - name: microsoft-atp-indicator-batch-update description: Updates a batch of indicators. If an indicator does not exist, a new indicator is created. arguments: - name: indicator_batch description: 'A JSON object with a list of MS defender ATP indicators to update. The indicator_batch query should be a list of dictionaries. For example: [{"indicatorValue": "value1"}, {"indicatorValue": "value2"}].' required: true - name: ran_once_flag description: Flag for the rate limit retry. deprecated: true outputs: - contextPath: MicrosoftATP.Indicators.ID description: Created by the system when the indicator is ingested. Generated GUID/unique identifier. type: String - contextPath: MicrosoftATP.Indicators.Value description: The value of the indicator. type: String - contextPath: MicrosoftATP.Indicators.FailureReason description: The reason for update failure. type: String - contextPath: MicrosoftATP.Indicators.IsFailed description: Whether the update failed. type: Boolean polling: true - name: microsoft-atp-get-alert-by-id description: "Deprecated. Use 'msg-get-alert-details' in the 'Microsoft Graph Security' integration instead." arguments: - name: alert_ids description: A comma-separated list of alert IDs. required: true isArray: true - name: ran_once_flag description: Flag for the rate limit retry. deprecated: true outputs: - contextPath: MicrosoftATP.Alert.ID description: The alert ID. type: String - contextPath: MicrosoftATP.Alert.IncidentID description: The incident ID of the alert. type: Number - contextPath: MicrosoftATP.Alert.InvestigationID description: The investigation ID related to the alert. type: Number - contextPath: MicrosoftATP.Alert.InvestigationState description: The current state of the investigation. type: String - contextPath: MicrosoftATP.Alert.AssignedTo description: The owner of the alert. type: String - contextPath: MicrosoftATP.Alert.Severity description: The severity of the alert. type: String - contextPath: MicrosoftATP.Alert.Status description: The current status of the alert. type: String - contextPath: MicrosoftATP.Alert.Classification description: The alert classification. type: String - contextPath: MicrosoftATP.Alert.Determination description: The determination of the alert. type: String - contextPath: MicrosoftATP.Alert.DetectionSource description: The detection source. type: String - contextPath: MicrosoftATP.Alert.Category description: The category of the alert. type: String - contextPath: MicrosoftATP.Alert.ThreatFamilyName description: The threat family. type: String - contextPath: MicrosoftATP.Alert.Title description: The alert title. type: String - contextPath: MicrosoftATP.Alert.Description description: The alert description. type: String - contextPath: MicrosoftATP.Alert.AlertCreationTime description: The date and time the alert was created. type: Date - contextPath: MicrosoftATP.Alert.FirstEventTime description: The first event time that triggered the alert on that machine. type: Date - contextPath: MicrosoftATP.Alert.LastEventTime description: The last event time that triggered the alert on that machine. type: Date - contextPath: MicrosoftATP.Alert.LastUpdateTime description: The UTC time of the last update. type: Date - contextPath: MicrosoftATP.Alert.ResolvedTime description: The date and time when the status of the alert was changed to 'Resolved'. type: Date - contextPath: MicrosoftATP.Alert.MachineID description: The machine ID associated with the alert. type: String - contextPath: MicrosoftATP.Alert.ComputerDNSName description: The machine DNS name. type: String - contextPath: MicrosoftATP.Alert.AADTenantID description: The AAD tenant ID. type: String - contextPath: MicrosoftATP.Alert.Comments.Comment description: The alert comment string. type: String - contextPath: MicrosoftATP.Alert.Comments.CreatedBy description: The alert comment created by string. type: String - contextPath: MicrosoftATP.Alert.Comments.CreatedTime description: The alert comment created time date. type: Date - contextPath: MicrosoftATP.Alert.Evidence description: Evidence related to the alert. type: Unknown - contextPath: MicrosoftATP.Alert.DetectorID description: The ID of the detector that triggered the alert. type: String - contextPath: MicrosoftATP.Alert.ThreatName description: The threat name. type: String - contextPath: MicrosoftATP.Alert.RelatedUser description: Details of the user related to a specific alert. type: String - contextPath: MicrosoftATP.Alert.MitreTechniques description: MITRE Enterprise technique ID. type: String - contextPath: MicrosoftATP.Alert.RBACGroupName description: The device RBAC group name. type: String polling: true deprecated: true - name: microsoft-atp-live-response-get-file description: 'Collects a file from a device. Note: Backslashes in the path must be escaped.' arguments: - name: machine_id description: Machine ID to add the file to. required: true default: true - name: comment description: A comment to associate with the action. required: true - name: path description: File path to get from the device. required: true - name: machine_action_id description: Action ID to retrieve status and data for. deprecated: true - name: interval_in_seconds description: Interval between polling. Default is 10 seconds. Must be 10 or higher. - name: timeout_in_seconds description: Timeout for polling. Default is 600 seconds. - name: ran_once_flag description: Flag for the rate limit retry. deprecated: true outputs: - contextPath: MicrosoftATP.LiveResponseAction.id description: The machine action ID. type: String - contextPath: MicrosoftATP.LiveResponseAction.type description: The machine action type. type: String - contextPath: MicrosoftATP.LiveResponseAction.title description: The machine action title. type: String - contextPath: MicrosoftATP.LiveResponseAction.requestor description: The machine action requestor. type: String - contextPath: MicrosoftATP.LiveResponseAction.requestorComment description: The machine action requestorComment. type: String - contextPath: MicrosoftATP.LiveResponseAction.status description: The machine action status. type: String - contextPath: MicrosoftATP.LiveResponseAction.machineId description: The machine ID. type: String - contextPath: MicrosoftATP.LiveResponseAction.computerDnsName description: The computer DNS name. type: String - contextPath: MicrosoftATP.LiveResponseAction.creationDateTimeUtc description: The action creationDateTimeUtc. type: Date - contextPath: MicrosoftATP.LiveResponseAction.lastUpdateDateTimeUtc description: The machine action lastUpdateDateTimeUtc. type: Date - contextPath: MicrosoftATP.LiveResponseAction.cancellationRequestor description: The machine action cancellationRequestor. type: String - contextPath: MicrosoftATP.LiveResponseAction.cancellationComment description: The machine action cancellationComment. type: String - contextPath: MicrosoftATP.LiveResponseAction.cancellationDateTimeUtc description: The cancellationDateTimeUtc. type: String - contextPath: MicrosoftATP.LiveResponseAction.errorHResult description: The errorHResult if it exists. type: String - contextPath: MicrosoftATP.LiveResponseAction.scope description: The action scope. type: String - contextPath: MicrosoftATP.LiveResponseAction.externalId description: The machine action externalId. type: String - contextPath: MicrosoftATP.LiveResponseAction.requestSource description: The machine action requestSource. type: String - contextPath: MicrosoftATP.LiveResponseAction.relatedFileInfo description: The machine action relatedFileInfo. type: String - contextPath: MicrosoftATP.LiveResponseAction.commands.index description: The machine action command index. type: String - contextPath: MicrosoftATP.LiveResponseAction.commands.startTime description: The machine action command startTime. type: String - contextPath: MicrosoftATP.LiveResponseAction.commands.endTime description: The machine action command endTime. type: String - contextPath: MicrosoftATP.LiveResponseAction.commands.commandStatus description: The machine action command Status. type: String - contextPath: MicrosoftATP.LiveResponseAction.commands.errors description: The machine action command errors if found. type: String - contextPath: MicrosoftATP.LiveResponseAction.commands.command.type description: The machine action command type. type: String - contextPath: MicrosoftATP.LiveResponseAction.commands.command.params.key description: The machine action command params key. type: String - contextPath: MicrosoftATP.LiveResponseAction.commands.command.params.value description: The machine action command params value. type: String - contextPath: MicrosoftATP.LiveResponseAction.troubleshootInfo description: The machine action troubleshoot information. type: String polling: true execution: true - name: microsoft-atp-live-response-run-script description: |- Runs a script from the library on a device. The Args parameter is passed to your script. Timeouts after 10 minutes. arguments: - name: machine_id description: The machine ID to add the file to. required: true default: true - name: comment description: A comment to associate with the action. required: true - name: scriptName description: The script name to run on the device. required: true - name: arguments description: Arguments to run the script with. - name: machine_action_id description: The action ID to retrieve status and data for. deprecated: true - name: interval_in_seconds description: Interval between polling. Default is 10 seconds. Must be 10 or higher. - name: timeout_in_seconds description: Timeout for polling. Default is 600 seconds. - name: ran_once_flag description: Flag for the rate limit retry. deprecated: true outputs: - contextPath: MicrosoftATP.LiveResponseAction.script_name description: The script name. type: String - contextPath: MicrosoftATP.LiveResponseAction.exit_code description: The script exit code. type: String - contextPath: MicrosoftATP.LiveResponseAction.script_output description: The script outputs. type: String - contextPath: MicrosoftATP.LiveResponseAction.script_errors description: The script errors if found. type: String polling: true execution: true - name: microsoft-atp-live-response-put-file description: Puts a file from the library to the device. Files are saved in a working folder and are deleted when the device restarts by default. arguments: - name: machine_id description: The machine ID to add the file to. required: true default: true - name: comment description: A comment to associate with the action. required: true - name: file_name description: File name to take from the library to the device. required: true - name: machine_action_id description: Action ID to retrieve status and data for. deprecated: true - name: interval_in_seconds description: Interval between polling. Default is 10 seconds. Must be 10 or higher. - name: timeout_in_seconds description: Timeout for polling. Default is 600 seconds. - name: ran_once_flag description: Flag for the rate limit retry. deprecated: true outputs: - contextPath: MicrosoftATP.LiveResponseAction.id description: The machine action ID. type: String - contextPath: MicrosoftATP.LiveResponseAction.type description: The machine action type. type: String - contextPath: MicrosoftATP.LiveResponseAction.title description: The machine action title. type: String - contextPath: MicrosoftATP.LiveResponseAction.requestor description: The machine action requestor. type: String - contextPath: MicrosoftATP.LiveResponseAction.requestorComment description: The machine action requestorComment. type: String - contextPath: MicrosoftATP.LiveResponseAction.status description: The machine action status. type: String - contextPath: MicrosoftATP.LiveResponseAction.machineId description: The machine ID. type: String - contextPath: MicrosoftATP.LiveResponseAction.computerDnsName description: The computer DNS name. type: String - contextPath: MicrosoftATP.LiveResponseAction.creationDateTimeUtc description: The action creationDateTimeUtc. type: Date - contextPath: MicrosoftATP.LiveResponseAction.lastUpdateDateTimeUtc description: The machine action lastUpdateDateTimeUtc. type: Date - contextPath: MicrosoftATP.LiveResponseAction.cancellationRequestor description: The machine action cancellationRequestor. type: String - contextPath: MicrosoftATP.LiveResponseAction.cancellationComment description: The machine action cancellationComment. type: String - contextPath: MicrosoftATP.LiveResponseAction.cancellationDateTimeUtc description: The cancellationDateTimeUtc. type: String - contextPath: MicrosoftATP.LiveResponseAction.errorHResult description: The errorHResult if exists. type: String - contextPath: MicrosoftATP.LiveResponseAction.scope description: The action scope. type: String - contextPath: MicrosoftATP.LiveResponseAction.externalId description: The machine action externalId. type: String - contextPath: MicrosoftATP.LiveResponseAction.requestSource description: The machine action requestSource. type: String - contextPath: MicrosoftATP.LiveResponseAction.relatedFileInfo description: The machine action relatedFileInfo. type: String - contextPath: MicrosoftATP.LiveResponseAction.commands.index description: The machine action command index. type: String - contextPath: MicrosoftATP.LiveResponseAction.commands.startTime description: The machine action command startTime. type: String - contextPath: MicrosoftATP.LiveResponseAction.commands.endTime description: The machine action command endTime. type: String - contextPath: MicrosoftATP.LiveResponseAction.commands.commandStatus description: The machine action command Status. type: String - contextPath: MicrosoftATP.LiveResponseAction.commands.errors description: The machine action command errors if found. type: String - contextPath: MicrosoftATP.LiveResponseAction.commands.command.type description: The machine action command type. type: String - contextPath: MicrosoftATP.LiveResponseAction.commands.command.params.key description: The machine action command params key. type: String - contextPath: MicrosoftATP.LiveResponseAction.commands.command.params.value description: The machine action command params value. type: String - contextPath: MicrosoftATP.LiveResponseAction.troubleshootInfo description: The machine action troubleshootInfo. type: String execution: true polling: true - name: microsoft-atp-live-response-result description: Gets a result file for a specified action. arguments: - name: machine_action_id description: The action ID to retrieve status and data for. required: true default: true - name: command_index description: A command index to retrieve the file for. required: true - name: ran_once_flag description: Flag for the rate limit retry. deprecated: true outputs: - contextPath: MicrosoftATP.LiveResponseAction description: The machine action ID. type: String execution: true - name: microsoft-atp-live-response-cancel-action description: Cancels an action with an unfinished status. arguments: - name: machine_action_id description: Action ID to retrieve status and data for. required: true default: true - name: comment description: A comment to associate with the action. required: true - name: ran_once_flag description: Flag for the rate limit retry. deprecated: true outputs: [] polling: true execution: true - arguments: - description: When you select a “query_purpose” argument, a designated query template is used. "network_connections" - The network connections initiated by the host/file to other internal hosts. "smb_connections" - SMB connections. "credential_dumping" - Was there a use of credential dumping? If so can we detect the use of the dumped users on other hosts on the network. "management_connection" - Management connection attempts to other hosts. name: query_purpose required: true auto: PREDEFINED defaultValue: '' predefined: - network_connections - smb_connections - credential_dumping - management_connection - description: Device name to look for. name: device_name defaultValue: '' - name: remote_ip_count description: Threshold for network enumeration in smb_connection. defaultValue: '' - name: file_name description: The file name to look for. defaultValue: '' - name: sha1 description: The SHA1 hash to look for. defaultValue: '' - name: sha256 description: The SHA256 hash to look for. defaultValue: '' - name: md5 description: The MD5 hash to look for. defaultValue: '' - name: device_id description: The device ID to look for. defaultValue: '' - name: query_operation description: The query operator to use with provided arguments. defaultValue: 'or' auto: PREDEFINED predefined: - or - and - name: limit description: The maximum number of results to retrieve. defaultValue: '50' - description: Time range to look back. Expected syntax is a human readable time range, e.g. 60 minutes, 6 hours, 1 day, etc. name: time_range - defaultValue: '10' description: The amount of time (in seconds) that a request waits for the query response before a timeout occurs. name: timeout - defaultValue: '1' description: The page number from which to start a search. Default is 1. name: page - description: Show the query as part of the entry result. name: show_query defaultValue: 'false' - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Detects evidence of attempted lateral movement. When you select a “query_purpose” argument, a designated query template is used. name: microsoft-atp-advanced-hunting-lateral-movement-evidence outputs: - contextPath: MicrosoftATP.HuntLateralMovementEvidence.Result.network_connections description: The query results for network_connections query_purpose. type: String - contextPath: MicrosoftATP.HuntLateralMovementEvidence.Result.smb_connections description: The query results for smb_connections query_purpose. type: String - contextPath: MicrosoftATP.HuntLateralMovementEvidence.Result.credential_dumping description: The query results for credential_dumping query_purpose. type: String - contextPath: MicrosoftATP.HuntLateralMovementEvidence.Result.management_connection description: The query results for management_connection query_purpose. type: String polling: true - arguments: - description: When you select a “query_purpose” argument, a designated query template is used. "scheduled_job" - Did the process create any scheduled jobs? "registry_entry" - Did it write to the registry? Requires also the process_cmd argument to be provided. "startup_folder_changes" - Was anything added to the startup folder? "new_service_created" - Was a new service created? "service_updated" - Was an existing service edited? "file_replaced" - Was a file replaced in program files? "new_user" - Was a new user created (on the local machine)? "new_group" - Was a new group created? "group_user_change" - Was a user added to a group (on the local machine)? "local_firewall_change" - Was there a change to the local FW rules? "host_file_change" - Whether there was a change to the hosts file or not. name: query_purpose defaultValue: '' required: true auto: PREDEFINED predefined: - scheduled_job - registry_entry - startup_folder_changes - new_service_created - service_updated - file_replaced - new_user - new_group - group_user_change - local_firewall_change - host_file_change - description: Device name to look for. name: device_name defaultValue: '' - name: file_name description: File name to look for. defaultValue: '' - name: sha1 description: SHA1 hash to look for. defaultValue: '' - name: sha256 description: SHA256 hash to look for. defaultValue: '' - name: md5 description: MD5 hash to look for. defaultValue: '' - name: device_id description: Device ID to look for. defaultValue: '' - name: query_operation description: Query operator to use with the provided arguments. defaultValue: 'or' auto: PREDEFINED predefined: - or - and - name: limit description: Maximum number of results to retrieve. defaultValue: '50' - description: Time range to look back. Expected syntax is a human readable time range, e.g. 60 minutes, 6 hours, 1 day, etc. name: time_range - defaultValue: '10' description: The amount of time (in seconds) that a request waits for the query response before a timeout occurs. name: timeout - defaultValue: '1' description: The page number from which to start a search. Default is 1. name: page - description: Show the query as part of the entry result. name: show_query defaultValue: 'false' - description: Process command line that initiated the registry entry. Can only be used with "registry_entry" query_purpose. name: process_cmd - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Detects evidence of persistence. When you select a “query_purpose” argument, a designated query template is used. name: microsoft-atp-advanced-hunting-persistence-evidence outputs: - contextPath: MicrosoftATP.HuntPersistenceEvidence.Result.scheduled_job description: The query results for scheduled_job query_purpose. type: String - contextPath: MicrosoftATP.HuntPersistenceEvidence.Result.registry_entry description: The query results for registry_entry query_purpose. type: String - contextPath: MicrosoftATP.HuntPersistenceEvidence.Result.startup_folder_changes description: The query results for startup_folder_changes query_purpose. type: String - contextPath: MicrosoftATP.HuntPersistenceEvidence.Result.new_service_created description: The query results for new_service_created query_purpose. type: String - contextPath: MicrosoftATP.HuntPersistenceEvidence.Result.service_updated description: The query results for service_updated query_purpose. type: String - contextPath: MicrosoftATP.HuntPersistenceEvidence.Result.file_replaced description: The query results for file_replaced query_purpose. type: String - contextPath: MicrosoftATP.HuntPersistenceEvidence.Result.new_user description: The query results for new_user query_purpose. type: String - contextPath: MicrosoftATP.HuntPersistenceEvidence.Result.new_group description: The query results for new_group query_purpose. type: String - contextPath: MicrosoftATP.HuntPersistenceEvidence.Result.group_user_change description: The query results for group_user_change query_purpose. type: String - contextPath: MicrosoftATP.HuntPersistenceEvidence.Result.local_firewall_change description: The query results for local_firewall_change query_purpose. type: String - contextPath: MicrosoftATP.HuntPersistenceEvidence.Result.host_file_change description: The query results for host_file_change query_purpose. type: String polling: true - arguments: - description: Device name to look for. name: device_name defaultValue: '' - description: File name to look for. name: file_name defaultValue: '' - description: SHA1 hash to look for. name: sha1 defaultValue: '' - description: SHA256 hash to look for. name: sha256 defaultValue: '' - description: MD5 hash to look for. name: md5 defaultValue: '' - description: Device ID to look for. name: device_id defaultValue: '' - name: query_operation description: Query operator to use with provided arguments. defaultValue: 'or' auto: PREDEFINED predefined: - or - and - name: limit description: Maximum number of results to retrieve. defaultValue: '50' - name: time_range description: Time range to look back. Expected syntax is a human readable time range, e.g. 60 minutes, 6 hours, 1 day, etc. - name: timeout description: The amount of time (in seconds) that a request waits for the query response before a timeout occurs. defaultValue: '10' - defaultValue: '1' description: The page number from which to start a search. Default is 1. name: page - defaultValue: 'false' description: Show the query as part of the entry result. name: show_query - description: Flag for the rate limit retry. name: ran_once_flag deprecated: true description: Indicates how the file got on the machine. Possible details are "dropped_file" - Was the file dropped? From where? "created_file" - Created by another File (script, compiled binary). "network_shared" - Shared via network. "execution_chain" - What is the process execution chain. name: microsoft-atp-advanced-hunting-file-origin outputs: - contextPath: MicrosoftATP.HuntFileOrigin.Result description: The query results. type: String polling: true - arguments: - description: When you select a “query_purpose” argument, a designated query template is used. "parent_process" - Parent process. "grandparent_process" - Grandparent process. "process_details" - Process hash, path, signature details. "beaconing_evidence" - Does the process appear to be beaconing? "powershell_execution_unsigned_files" - Has the file executed PowerShell? Query without specifying processes. No additional arguments are required. "process_excecution_powershell" - Whether there the file executed PowerShell or not. name: query_purpose required: true auto: PREDEFINED defaultValue: '' predefined: - parent_process - grandparent_process - process_details - beaconing_evidence - powershell_execution_unsigned_files - process_excecution_powershell - description: Device name to look for. name: device_name defaultValue: '' - description: File name to look for. name: file_name defaultValue: '' - name: sha1 description: SHA1 hash to look for. defaultValue: '' - name: sha256 description: SHA256 hash to look for. defaultValue: '' - name: md5 description: MD5 hash to look for. defaultValue: '' - name: device_id description: Device ID to look for. defaultValue: '' - name: query_operation auto: PREDEFINED description: Query operator to use with provided arguments. defaultValue: or predefined: - or - and - name: limit description: Maximum number of results to retrieve. defaultValue: '50' - name: time_range description: Time range to look back. Expected syntax is a human readable time range, e.g. 60 minutes, 6 hours, 1 day, etc. - defaultValue: '10' description: The amount of time (in seconds) that a request waits for the query response before a timeout occurs. name: timeout - defaultValue: '1' description: The page number from which to start a search. Default is 1. name: page - defaultValue: 'false' description: Show the query as part of the entry result. name: show_query - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Detects process details. When you select a “query_purpose” argument, a designated query template is used. name: microsoft-atp-advanced-hunting-process-details outputs: - contextPath: MicrosoftATP.HuntProcessDetails.Result.parent_process description: The query results for parent_process query_purposeThe query results. type: String - contextPath: MicrosoftATP.HuntProcessDetails.Result.grandparent_process description: The query results for grandparent_process query_purpose. type: String - contextPath: MicrosoftATP.HuntProcessDetails.Result.process_details description: The query results for process_details query_purpose. type: String - contextPath: MicrosoftATP.HuntProcessDetails.Result.beaconing_evidence description: The query results for beaconing_evidence query_purpose. type: String - contextPath: MicrosoftATP.HuntProcessDetails.Result.powershell_execution_unsigned_files description: The query results for powershell_execution_unsigned_files query_purpose. type: String - contextPath: MicrosoftATP.HuntProcessDetails.Result.process_excecution_powershell description: The query results for process_excecution_powershell query_purpose. type: String polling: true - name: microsoft-atp-advanced-hunting-network-connections description: Detects network connections. When you select a “query_purpose” argument, a designated query template is used. arguments: - name: query_purpose description: When you select a “query_purpose” argument, a designated query template is used. "external_addresses" - Network connections to external addresses. "dns_query" - DNS query. Query by providing hash or filename or specific processes. At least one of file arguments (file_name, sha1, sha256, md5) is required and one of device arguments (device_name, device_id). "encoded_commands" - Are there commands with base 64 encoding? Only device arguments are required (device_name, device_id), at least one. defaultValue: '' required: true auto: PREDEFINED predefined: - external_addresses - dns_query - encoded_commands - name: device_name description: Device name to look for. defaultValue: '' - name: file_name description: File name to look for. defaultValue: '' - name: sha1 description: SHA1 hash to look for. defaultValue: '' - name: sha256 description: SHA256 hash to look for. defaultValue: '' - defaultValue: '' description: MD5 hash to look for. name: md5 - defaultValue: '' description: Device ID to look for. name: device_id - defaultValue: 'or' description: Query operator to use with provided arguments. name: query_operation auto: PREDEFINED predefined: - or - and - description: Maximum number of results to retrieve. name: limit defaultValue: '50' - name: time_range description: Time range to look back. Expected syntax is a human readable time range, e.g. 60 minutes, 6 hours, 1 day, etc. - defaultValue: '10' description: The amount of time (in seconds) that a request waits for the query response before a timeout occurs. name: timeout - defaultValue: '1' description: The page number from which to start a search. Default is 1. name: page - defaultValue: 'false' description: Show the query as part of the entry result. name: show_query - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag outputs: - contextPath: MicrosoftATP.HuntNetworkConnections.Result.external_addresses description: The query results for external_addresses query_purpose. type: String - contextPath: MicrosoftATP.HuntNetworkConnections.Result.dns_query description: The query results for dns_query query_purpose. type: String - contextPath: MicrosoftATP.HuntNetworkConnections.Result.encoded_commands description: The query results for encoded_commands query_purpose. type: String polling: true - name: microsoft-atp-advanced-hunting-privilege-escalation description: Detects evidence of privilege escalation. arguments: - name: device_name description: Device name to look for. defaultValue: '' - name: device_id description: Device ID to look for. defaultValue: '' - name: query_operation auto: PREDEFINED description: Query operator to use with provided arguments. defaultValue: or predefined: - or - and - name: limit description: Maximum number of results to retrieve. defaultValue: '50' - name: time_range description: Time range to look back. Expected syntax is a human readable time range, e.g. 60 minutes, 6 hours, 1 day, etc. - defaultValue: '10' description: The amount of time (in seconds) that a request waits for the query response before a timeout occurs. name: timeout - defaultValue: '1' description: The page number from which to start a search. Default is 1. name: page - defaultValue: 'false' description: Show the query as part of the entry result. name: show_query - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag outputs: - contextPath: MicrosoftATP.HuntPrivilegeEscalation.Result description: The query results. type: String - name: microsoft-atp-advanced-hunting-tampering description: Detects evidence of MSDE agent/sensor manipulation. arguments: - name: device_name description: Device name to look for. defaultValue: '' - name: device_id description: Device ID to look for. defaultValue: '' - name: query_operation description: Query operator to use with provided arguments. defaultValue: 'or' auto: PREDEFINED predefined: - or - and - name: limit description: Maximum number of results to retrieve. defaultValue: '50' - name: time_range description: Time range to look back. Expected syntax is a human readable time range, e.g. 60 minutes, 6 hours, 1 day, etc. - name: timeout description: The amount of time (in seconds) that a request waits for the query response before a timeout occurs. defaultValue: '10' - name: page description: The page number from which to start a search. Default is 1. defaultValue: '1' - name: show_query description: Show the query as part of the entry result. defaultValue: 'false' - name: ran_once_flag description: Flag for the rate limit retry. deprecated: true outputs: - contextPath: MicrosoftATP.HuntTampering.Result description: The query results. type: String polling: true - arguments: - description: When you select a “query_purpose” argument, a designated query template is used. "file_deleted" - Did the file delete itself? "event_log_cleared" - Was the event log cleared? Requires at least one of device arguments (device_name/device_id). "compromised_information" - Information on a compromised user and its activities. Requires only username argument. "connected_devices" - All connected devices by compromised user. Requires only username argument. "action_types" - All action types created by a user on each machine. Requires only username argument. "common_files" - Most common files associated with a user. Requires only username argument. name: query_purpose required: true auto: PREDEFINED defaultValue: '' predefined: - file_deleted - event_log_cleared - compromised_information - connected_devices - action_types - common_files - description: Device name to look for. name: device_name defaultValue: '' - name: file_name description: File name to look for. defaultValue: '' - name: sha1 description: SHA1 hash to look for. defaultValue: '' - name: sha256 description: SHA256 hash to look for. defaultValue: '' - name: md5 description: MD5 hash to look for. defaultValue: '' - name: device_id description: Device ID to look for. defaultValue: '' - name: username description: Username to look for in relevant query types. defaultValue: '' - name: query_operation auto: PREDEFINED description: Query operator to use with provided arguments. defaultValue: or predefined: - or - and - name: limit description: Maximum number of results to retrieve. defaultValue: '50' - name: time_range description: Time range to look back. Expected syntax is a human readable time range, e.g. 60 minutes, 6 hours, 1 day, etc. - defaultValue: '10' description: The amount of time (in seconds) that a request waits for the query response before a timeout occurs. name: timeout - defaultValue: '1' description: The page number from which to start a search. Default is 1. name: page - defaultValue: 'false' description: Show the query as part of the entry result. name: show_query - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Detects cover up actions. When you select a “query_purpose” argument, a designated query template is used. name: microsoft-atp-advanced-hunting-cover-up outputs: - contextPath: MicrosoftATP.HuntCoverUp.Result.file_deleted description: The query results for file_deleted query_purpose. type: String - contextPath: MicrosoftATP.HuntCoverUp.Result.event_log_cleared description: The query results for event_log_cleared query_purpose. type: String - contextPath: MicrosoftATP.HuntCoverUp.Result.compromised_information description: The query results for compromised_information query_purpose. type: String - contextPath: MicrosoftATP.HuntCoverUp.Result.connected_devices description: The query results for connected_devices query_purpose. type: String - contextPath: MicrosoftATP.HuntCoverUp.Result.action_types description: The query results for action_types query_purpose. type: String - contextPath: MicrosoftATP.HuntCoverUp.Result.common_files description: The query results for common_files query_purpose. type: String polling: true - arguments: - default: true description: A machine ID used for getting logged on users. name: machine_id required: true - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Retrieves a collection of logged on users on a specific device. name: microsoft-atp-get-machine-users outputs: - contextPath: MicrosoftATP.MachineUser.ID description: The user ID. type: String - contextPath: MicrosoftATP.MachineUser.AccountName description: The user account name. type: String - contextPath: MicrosoftATP.MachineUser.AccountDomain description: The domain of the user account. type: String - contextPath: MicrosoftATP.MachineUser.FirstSeen description: The first date and time the user has logged on the machine. type: Date - contextPath: MicrosoftATP.MachineUser.LastSeen description: The last date and time the user has logged on the machine. type: Date - contextPath: MicrosoftATP.MachineUser.LogonTypes description: The logon types of the user on the machine. type: String - contextPath: MicrosoftATP.MachineUser.DomainAdmin description: True if user is Domain Admin, False otherwise. type: Boolean - contextPath: MicrosoftATP.MachineUser.NetworkUser description: True if user is network user, False otherwise. type: Boolean - contextPath: MicrosoftATP.MachineUser.MachineID description: The machine ID. type: String polling: true - arguments: - description: A machine ID used for getting machine related alerts. name: machine_id required: true default: true - description: Flag for the rate limit retry. name: ran_once_flag deprecated: true description: Deprecated. No available replacement. name: microsoft-atp-get-machine-alerts outputs: - contextPath: MicrosoftATP.MachineAlerts.ID description: The alert ID. type: String - contextPath: MicrosoftATP.MachineAlerts.Title description: The alert title. type: String - contextPath: MicrosoftATP.MachineAlerts.Description description: The alert description. type: String - contextPath: MicrosoftATP.MachineAlerts.IncidentID description: The incident ID, if alert belongs to one. type: String - contextPath: MicrosoftATP.MachineAlerts.Severity description: The alert severity. type: String - contextPath: MicrosoftATP.MachineAlerts.Status description: The alert status. type: String - contextPath: MicrosoftATP.MachineAlerts.Classification description: The alert classification. type: String - contextPath: MicrosoftATP.MachineAlerts.Category description: The alert category. type: String - contextPath: MicrosoftATP.MachineAlerts.ThreatFamilyName description: The alert threat family name. type: String - contextPath: MicrosoftATP.MachineAlerts.MachineID description: The alerts machine ID. type: String polling: true deprecated: true - arguments: - description: The machine ID. Can be retrieved by running the 'microsoft-atp-get-machines' command. name: machine_id required: true - description: Comment to associate with the action. name: comment required: true - description: Timeout for polling. Default is 600 seconds. name: timeout_in_seconds - description: Action ID to retrieve status and data for. Retrieved from the 'get-machine-investigation-package' command. name: machine_action_id deprecated: true - description: Interval between polling. Default is 10 seconds. Must be 10 or higher. name: interval_in_seconds - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag description: Collect and download an investigation package from a machine. name: microsoft-atp-request-and-download-investigation-package outputs: - contextPath: MicrosoftATP.MachineAction.ID description: The machine action ID. type: String - contextPath: MicrosoftATP.MachineAction.Status description: The current status of the machine action. type: String - contextPath: MicrosoftATP.MachineAction.MachineID description: The machine ID on which the action was executed. type: String polling: true - description: Offboard a machine from Microsoft Defender for Endpoint. name: microsoft-atp-offboard-machine arguments: - default: true description: A comma-separated list of machine IDs to be used for offboarding. e.g., 0a3250e0693a109f1affc9217be9459028aa8426,0a3250e0693a109f1affc9217be9459028aa8424. isArray: true name: machine_id required: true - description: A comment to associate with the action. name: comment required: true - deprecated: true description: Flag for the rate limit retry. name: ran_once_flag execution: true outputs: - contextPath: MicrosoftATP.OffboardMachine.ID description: The machine action ID. type: String - contextPath: MicrosoftATP.OffboardMachine.Type description: Type of the machine action. type: String - contextPath: MicrosoftATP.OffboardMachine.Scope description: Scope of the action. type: Unknown - contextPath: MicrosoftATP.OffboardMachine.Requestor description: The ID of the user that executed the action. type: String - contextPath: MicrosoftATP.OffboardMachine.RequestorComment description: Comment that was written when issuing the action. type: String - contextPath: MicrosoftATP.OffboardMachine.Status description: The current status of the command. type: String - contextPath: MicrosoftATP.OffboardMachine.MachineID description: The machine ID on which the action was executed. type: String - contextPath: MicrosoftATP.OffboardMachine.ComputerDNSName description: The machine DNS name on which the action was executed. type: String - contextPath: MicrosoftATP.OffboardMachine.CreationDateTimeUtc description: The date and time when the action was created. type: Date - contextPath: MicrosoftATP.OffboardMachine.LastUpdateTimeUtc description: The last date and time when the action status was updated. type: Date - contextPath: MicrosoftATP.OffboardMachine.cancellationDateTimeUtc description: The date and time when the action was canceled. type: Date - contextPath: MicrosoftATP.OffboardMachine.RelatedFileInfo description: The file info. type: String - contextPath: MicrosoftATP.OffboardMachine.troubleshootInfo description: Troubleshooting information. type: String polling: true - description: Generate the login url used for Authorization code flow. name: microsoft-atp-generate-login-url arguments: [] - description: Run this command if for some reason you need to rerun the authentication process. execution: false name: microsoft-atp-auth-reset arguments: [] - description: This command gets the permissions from the currently configured credentials. Use for debugging and detecting permission issues. name: microsoft-atp-list-auth-permissions - arguments: - description: The machine ID. Can be retrieved by running the 'microsoft-atp-get-machines' command. name: machine_id required: true description: Get the specific machine's software details. name: microsoft-atp-get-machine-software polling: true outputs: - contextPath: MicrosoftATP.Software.ID description: The software ID. type: String - contextPath: MicrosoftATP.Software.Name description: The software name. type: String - contextPath: MicrosoftATP.Software.Vendor description: The software vendor name. type: String - contextPath: MicrosoftATP.Software.Weaknesses description: The amount of weaknesses present in the software. type: Number - contextPath: MicrosoftATP.Software.PublicExploit description: Does this software have a public exploit? type: Boolean - contextPath: MicrosoftATP.Software.ActiveAlert description: Does this software have an active alert? type: Boolean - contextPath: MicrosoftATP.Software.ExposedMachines description: The amount of machines exposed to this software. type: Number - contextPath: MicrosoftATP.Software.InstalledMachines description: The amount of machines with this software installed. type: Number - contextPath: MicrosoftATP.Software.ImpactScore description: The impact score of the software. type: Number - contextPath: MicrosoftATP.Software.IsNormalized description: Is the software value normalized? type: Boolean - contextPath: MicrosoftATP.Software.Category description: The software category. type: String - contextPath: MicrosoftATP.Software.Distributions description: The distributions on which this software is present. type: String - arguments: - description: The machine ID. Can be retrieved by running the 'microsoft-atp-get-machines' command. name: machine_id required: true description: Get the specific machine's missing security updates (KBs). name: microsoft-atp-get-machine-missing-kbs polling: true outputs: - contextPath: MicrosoftATP.PublicProductFix.ID description: The missing KB ID. type: String - contextPath: MicrosoftATP.PublicProductFix.Name description: The missing KB name. type: String - contextPath: MicrosoftATP.PublicProductFix.ProductsNames description: The product names. type: String - contextPath: MicrosoftATP.PublicProductFix.URL description: The KB URL. type: String - contextPath: MicrosoftATP.PublicProductFix.MachineMissedOn description: The amount of machines that is missing this KB. type: Number - contextPath: MicrosoftATP.PublicProductFix.CVEAddressed description: The CVE addressed by this KB. type: Number - contextPath: MicrosoftATP.PublicProductFix.OSBuild description: The OS build. type: String - arguments: - default: true description: Hash of the file to query. Supports MD5, SHA1, and SHA256. isArray: true name: file required: true description: Checks the file reputation of the specified hash. name: file outputs: - contextPath: MicrosoftATP.File.Sha1 description: The SHA1 hash of the file. type: String - contextPath: MicrosoftATP.File.MD5 description: The MD5 hash of the file. type: String - contextPath: MicrosoftATP.File.Sha256 description: The SHA256 hash of the file. type: String - contextPath: MicrosoftATP.File.GlobalPrevalence description: The file prevalence across the organization. type: Number - contextPath: MicrosoftATP.File.GlobalFirstObserved description: The first time the file was observed. type: Date - contextPath: MicrosoftATP.File.GlobalLastObserved description: The last time the file was observed. type: Date - contextPath: MicrosoftATP.File.Size description: The size of the file. type: Number - contextPath: MicrosoftATP.File.FileType description: The type of the file. type: String - contextPath: MicrosoftATP.File.IsPeFile description: True if the file is portable executable, False otherwise. type: Boolean - contextPath: MicrosoftATP.File.FilePublisher description: The file's publisher. type: String - contextPath: MicrosoftATP.File.FileProductName description: The file product name. type: String - contextPath: MicrosoftATP.File.Signer description: The file signer. type: String - contextPath: MicrosoftATP.File.Issuer description: The file issuer. type: String - contextPath: MicrosoftATP.File.SignerHash description: The hash of the signing certificate. type: String - contextPath: MicrosoftATP.File.IsValidCertificate description: Was signing certificate successfully verified by Microsoft Defender ATP agent. type: Boolean - contextPath: MicrosoftATP.File.DeterminationValue description: The file determination value. type: String - contextPath: MicrosoftATP.File.DeterminationType description: The file determination type. type: String - contextPath: File.SHA1 description: The SHA1 hash of the file. type: String - contextPath: File.SHA256 description: The SHA256 hash of the file. type: String - contextPath: File.Type description: The file type. type: String - contextPath: File.Size description: The file size. type: Number - contextPath: DBotScore.Indicator description: The indicator that was tested. type: String - contextPath: DBotScore.Type description: The indicator type. type: String - contextPath: DBotScore.Vendor description: The vendor used to calculate the score. type: String - contextPath: DBotScore.Score description: The actual score. type: Number - arguments: - description: The machine ID. Can be retrieved by running the 'microsoft-atp-get-machines' command. name: machine_id required: true description: Get the specific machine's vulnerabilities. name: microsoft-atp-get-machine-vulnerabilities polling: true outputs: - contextPath: MicrosoftATP.PublicVulnerability.ID description: The vulnerability ID. type: String - contextPath: MicrosoftATP.PublicVulnerability.Name description: The vulnerability name. type: String - contextPath: MicrosoftATP.PublicVulnerability.CVESupportability description: The CVE supportability. type: String - contextPath: MicrosoftATP.PublicVulnerability.CVSSV3 description: The CVSS V3. type: Number - contextPath: MicrosoftATP.PublicVulnerability.CVSSVector description: The CVSS vector. type: String - contextPath: MicrosoftATP.PublicVulnerability.Description description: A description of this vulnerability. type: String - contextPath: MicrosoftATP.PublicVulnerability.EPSS description: The EPSS. type: Number - contextPath: MicrosoftATP.PublicVulnerability.ExploitInKit description: Is this vulnerability in an exploit kit? type: Boolean - contextPath: MicrosoftATP.PublicVulnerability.ExploitTypes description: The type(s) of exploit(s). type: String - contextPath: MicrosoftATP.PublicVulnerability.ExploitUris description: The exploit URIs. type: String - contextPath: MicrosoftATP.PublicVulnerability.ExploitVerified description: Is this exploit verified? type: Boolean - contextPath: MicrosoftATP.PublicVulnerability.ExposedMachines description: The amount of machines exposed to this vulnerability. type: Number - contextPath: MicrosoftATP.PublicVulnerability.FirstDetected description: The date and time when this vulnerability was first detected. type: String - contextPath: MicrosoftATP.PublicVulnerability.PublicExploit description: Does this vulnerability have a public exploit? type: Boolean - contextPath: MicrosoftATP.PublicVulnerability.PublishedOn description: The date and time when this vulnerability was published. type: String - contextPath: MicrosoftATP.PublicVulnerability.Severity description: The severity of this vulnerability. type: String - contextPath: MicrosoftATP.PublicVulnerability.Tags description: The tags associated with this vulnerability. type: String - contextPath: MicrosoftATP.PublicVulnerability.UpdatedOn description: The date and time when this vulnerability was last updated. type: String dockerimage: demisto/crypto:1.0.0.11658507 isfetch: true runonce: false script: '-' subtype: python3 type: python defaultmapperin: Microsoft Defender For Endpoint Mapper fromversion: 5.0.0 tests: - Microsoft Defender Advanced Threat Protection - Test - Microsoft Defender Advanced Threat Protection - Test dev - Microsoft Defender Advanced Threat Protection - Test self deployed - Microsoft Defender Advanced Threat Protection - Test prod