Microsoft Defender XDR UpdateIncident

Microsoft Defender XDR UpdateIncident

Certified

Update a Microsoft Defender XDR incident

Updates the status, classification, determination, assignee or custom tags of an incident (PATCH /security/incidents/{id}), only sending the properties that are set, and optionally adds a comment (POST /security/incidents/{id}/comments). Requires the Microsoft Graph application permission SecurityIncident.ReadWrite.All.

yaml
type: io.kestra.plugin.microsoft365.defender.UpdateIncident

Enrich an incident with an advanced hunting query, then assign it

yaml
id: defender_enrich_incident
namespace: company.security

inputs:
  - id: incidentId
    type: STRING
  - id: deviceName
    type: STRING
    # Device names only, so the input cannot change the KQL query below
    validator: "^[A-Za-z0-9._-]+$"

tasks:
  - id: hunt
    type: io.kestra.plugin.microsoft365.defender.HuntingQuery
    tenantId: "{{ secret('AZURE_TENANT_ID') }}"
    clientId: "{{ secret('AZURE_CLIENT_ID') }}"
    clientSecret: "{{ secret('AZURE_CLIENT_SECRET') }}"
    timespan: P1D
    fetchType: FETCH
    query: |
      DeviceProcessEvents
      | where DeviceName == "{{ inputs.deviceName }}"
      | where FileName in~ ("powershell.exe", "cmd.exe")
      | summarize count() by AccountName, FileName

  - id: assign
    type: io.kestra.plugin.microsoft365.defender.UpdateIncident
    tenantId: "{{ secret('AZURE_TENANT_ID') }}"
    clientId: "{{ secret('AZURE_CLIENT_ID') }}"
    clientSecret: "{{ secret('AZURE_CLIENT_SECRET') }}"
    incidentId: "{{ inputs.incidentId }}"
    status: IN_PROGRESS
    assignedTo: soc-tier2@company.com
    customTags:
      - kestra
    comment: "Hunting query returned {{ outputs.hunt.count }} suspicious process rows"
Installation

Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command:

kestractl plugins get io.kestra.plugin:plugin-microsoft365 --compatible-for $KESTRA_VERSION

For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.

Properties

Incident ID

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150

Assigned to

Owner of the incident, usually a user principal name.

Possible Values
UNKNOWNFALSE_POSITIVETRUE_POSITIVEINFORMATIONAL_EXPECTED_ACTIVITY

Classification

How the item was classified after investigation. Allowed values: UNKNOWN, FALSE_POSITIVE, TRUE_POSITIVE, INFORMATIONAL_EXPECTED_ACTIVITY.

Client ID

Client ID of the Azure service principal. If you don't have a service principal, refer to create a service principal with Azure CLI.

Client Secret

Service principal client secret. Use this for Client Secret authentication. Provide clientId, tenantId, and clientSecret. Either clientSecret OR pemCertificate must be provided, not both.

Comment

Comment added to the incident. Sent with a separate call because Microsoft Graph does not accept comments in the incident update.

SubTypestring

Custom tags

Replaces the custom tags of the incident.

Possible Values
UNKNOWNAPTMALWARESECURITY_PERSONNELSECURITY_TESTINGUNWANTED_SOFTWAREOTHERMULTI_STAGED_ATTACKCOMPROMISED_ACCOUNTPHISHINGMALICIOUS_USER_ACTIVITYNOT_MALICIOUSNOT_ENOUGH_DATA_TO_VALIDATECONFIRMED_ACTIVITYLINE_OF_BUSINESS_APPLICATION

Determination

What the investigation determined. Allowed values: UNKNOWN, APT, MALWARE, SECURITY_PERSONNEL, SECURITY_TESTING, UNWANTED_SOFTWARE, OTHER, MULTI_STAGED_ATTACK, COMPROMISED_ACCOUNT, PHISHING, MALICIOUS_USER_ACTIVITY, NOT_MALICIOUS, NOT_ENOUGH_DATA_TO_VALIDATE, CONFIRMED_ACTIVITY, LINE_OF_BUSINESS_APPLICATION.

PEM Certificate

Alternative authentication method using certificate-based authentication.
Use this for Client Certificate authentication. Provide clientId, tenantId, and pemCertificate.
Either clientSecret OR pemCertificate must be provided, not both.

Possible Values
ACTIVEIN_PROGRESSRESOLVEDREDIRECTEDAWAITING_ACTION

Status

Allowed values: ACTIVE, IN_PROGRESS, RESOLVED, REDIRECTED, AWAITING_ACTION.

Tenant ID

Updated incident

Incident object returned by Microsoft Graph, with the Graph field names.