List detectionRules

Article
06/22/2024

Namespace: microsoft.graph.security

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Get a list of custom detection rules. With custom detections, you can proactively monitor for and respond to various events and system states, including suspected breach activity and misconfigured assets in their organization network. Custom detection rules, which are written in Kusto query language (KQL), automatically trigger alerts and response actions once there are events matching their KQL queries.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	❌	❌	❌

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	CustomDetection.Read.All	CustomDetection.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	CustomDetection.Read.All	CustomDetection.ReadWrite.All

HTTP request

GET /security/rules/detectionRules

Optional query parameters

This method supports some of the OData query parameters to help customize the response. For general information, see OData query parameters.

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of detectionRule objects in the response body.

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/security/rules/detectionRules?$top=3


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Security.Rules.DetectionRules.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Top = 3;
});

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



mgc-beta security rules detection-rules list --top "3"

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphsecurity "github.com/microsoftgraph/msgraph-beta-sdk-go/security"
	  //other-imports
)


requestTop := int32(3)

requestParameters := &graphsecurity.SecurityRulesDetectionRulesRequestBuilderGetQueryParameters{
	Top: &requestTop,
}
configuration := &graphsecurity.SecurityRulesDetectionRulesRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
detectionRules, err := graphClient.Security().Rules().DetectionRules().Get(context.Background(), configuration)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.models.security.DetectionRuleCollectionResponse result = graphClient.security().rules().detectionRules().get(requestConfiguration -> {
	requestConfiguration.queryParameters.top = 3;
});

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

let detectionRules = await client.api('/security/rules/detectionRules')
	.version('beta')
	.top(3)
	.get();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Security\Rules\DetectionRules\DetectionRulesRequestBuilderGetRequestConfiguration;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestConfiguration = new DetectionRulesRequestBuilderGetRequestConfiguration();
$queryParameters = DetectionRulesRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->top = 3;
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->security()->rules()->detectionRules()->get($requestConfiguration)->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


Import-Module Microsoft.Graph.Beta.Security

Get-MgBetaSecurityRuleDetectionRule -Top 3

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.security.rules.detection_rules.detection_rules_request_builder import DetectionRulesRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = DetectionRulesRequestBuilder.DetectionRulesRequestBuilderGetQueryParameters(
		top = 3,
)

request_configuration = RequestConfiguration(
query_parameters = query_params,
)

result = await graph_client.security.rules.detection_rules.get(request_configuration = request_configuration)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.security.detectionRule",
      "id": "7506",
      "displayName": "ban file",
      "isEnabled": true,
      "createdBy": "NaderK@winatptestlic06.ccsctp.net",
      "createdDateTime": "2021-02-28T16:28:15.3863467Z",
      "lastModifiedDateTime": "2023-05-24T09:26:11.8630516Z",
      "lastModifiedBy": "GlobalAdmin@unifiedrbactest3.ccsctp.net",
      "detectorId": "67895317-b2a8-4ac3-8f8b-fa6b7765f2fe",
      "queryCondition": {
        "queryText": "DeviceFileEvents\r\n| where Timestamp > ago(1h)\r\n| where FileName == \"ifz30zlx.dll\"",
        "lastModifiedDateTime": null
      },
      "schedule": {
        "period": "24H",
        "nextRunDateTime": "2023-06-26T08:52:06.1766667Z"
      },
      "lastRunDetails": {
        "lastRunDateTime": "2023-06-25T08:52:06.1766667Z",
        "status": null,
        "failureReason": null,
        "errorCode": null
      },
      "detectionAction": {
        "alertTemplate": {
          "title": "unwanted dll",
          "description": "test",
          "severity": "low",
          "category": "Malware",
          "recommendedActions": null,
          "mitreTechniques": [],
          "impactedAssets": []
        },
        "organizationalScope": null,
        "responseActions": [
          {
            "@odata.type": "#microsoft.graph.security.restrictAppExecutionResponseAction",
            "identifier": "deviceId"
          },
          {
            "@odata.type": "#microsoft.graph.security.initiateInvestigationResponseAction",
            "identifier": "deviceId"
          },
          {
            "@odata.type": "#microsoft.graph.security.collectInvestigationPackageResponseAction",
            "identifier": "deviceId"
          },
          {
            "@odata.type": "#microsoft.graph.security.runAntivirusScanResponseAction",
            "identifier": "deviceId"
          },
          {
            "@odata.type": "#microsoft.graph.security.isolateDeviceResponseAction",
            "isolationType": "full",
            "identifier": "deviceId"
          },
          {
            "@odata.type": "#microsoft.graph.security.blockFileResponseAction",
            "identifier": "sha1",
            "deviceGroupNames": []
          }
        ]
      }
    },
    {
      "@odata.type": "#microsoft.graph.security.detectionRule",
      "id": "8575",
      "displayName": "Continuous_EmailAttachmentInfo_Mod300",
      "isEnabled": true,
      "createdBy": "rony@winatptestlic06.ccsctp.net",
      "createdDateTime": "2021-11-03T21:32:01.6144651Z",
      "lastModifiedDateTime": "2022-11-03T19:27:14.4187141Z",
      "lastModifiedBy": "InESecAdmin@winatptestlic06.ccsctp.net",
      "detectorId": "56ef4994-fe31-4ac9-b29f-0ca2f2cc9112",
      "queryCondition": {
        "queryText": "EmailAttachmentInfo\r\n| extend second = datetime_diff('second',now(),Timestamp)\r\n| where second % 300 == 0 ",
        "lastModifiedDateTime": "2022-11-03T19:27:14.4331537Z"
      },
      "schedule": {
        "period": "0",
        "nextRunDateTime": "2021-11-03T21:32:01.7863185Z"
      },
      "lastRunDetails": {
        "lastRunDateTime": "2021-11-03T21:32:01.7863185Z",
        "status": null,
        "failureReason": null,
        "errorCode": null
      },
      "detectionAction": {
        "alertTemplate": {
          "title": "EmailAttachmentInfo",
          "description": "EmailAttachmentInfo",
          "severity": "low",
          "category": "Exfiltration",
          "recommendedActions": "EmailAttachmentInfo",
          "mitreTechniques": [],
          "impactedAssets": [
            {
              "@odata.type": "#microsoft.graph.security.impactedMailboxAsset",
              "identifier": "recipientEmailAddress"
            },
            {
              "@odata.type": "#microsoft.graph.security.impactedUserAsset",
              "identifier": "recipientObjectId"
            }
          ]
        },
        "organizationalScope": null,
        "responseActions": [
          {
            "@odata.type": "#microsoft.graph.security.moveToDeletedItemsResponseAction",
            "identifier": "networkMessageId, recipientEmailAddress"
          }
        ]
      }
    },
    {
      "@odata.type": "#microsoft.graph.security.detectionRule",
      "id": "9794",
      "displayName": "UPDATED DET: Office/LoLBin Network Connection to Low-Reputation TLD",
      "isEnabled": true,
      "createdBy": "NaderK@winatptestlic06.ccsctp.net",
      "createdDateTime": "2022-02-02T10:26:01.7708581Z",
      "lastModifiedDateTime": "2022-02-02T10:26:01.7708581Z",
      "lastModifiedBy": "NaderK@winatptestlic06.ccsctp.net",
      "detectorId": "67aa92a1-b04b-4f2a-a223-236968a3da96",
      "queryCondition": {
        "queryText": "//https://www.spamhaus.org/statistics/tlds/      http://www.surbl.org/tld       https://www.iana.org/domains/root/db      https://unit42.paloaltonetworks.com/top-level-domains-cybercrime/\r\nDeviceNetworkEvents\r\n| where isnotempty(RemoteUrl) and RemoteIPType == \"Public\"\r\n| where InitiatingProcessFileName in~ (\"winword.exe\", \"excel.exe\", \"powerpnt.exe\", \"rundll32.exe\", \"regsvr32.exe\", \"certutil.exe\", \"bitsadmin.exe\", \"wscript.exe\", \"cscript.exe\", \"powershell.exe\", \"pwsh.exe\", \"powershell_ise.exe\")\r\n| extend TopLevelDomain=tolower(extract(@\"([A-Za-z0-9-]{1,63}\\.)+([A-Za-z]{2,10})\", 2, RemoteUrl))\r\n| where TopLevelDomain in (\"xyz\", \"top\", \"live\", \"loan\", \"club\", \"surf\", \"work\", \"biz\", \"ryukyu\", \"press\", \"ltd\", \"bid\", \"vip\", \"online\", \"download\" \"buzz\", \"cam\", \"ru\", \"cn\", \"ci\", \"ga\", \"gq\", \"tk\", \"tw\", \"ml\", \"cf\", \"cfd\", \"icu\", \"cm\")\r\n| extend TimeDiff=datetime_diff(\"Second\", Timestamp, InitiatingProcessCreationTime)\r\n| where TimeDiff < 30\r\n| project-reorder Timestamp, DeviceName, RemoteUrl, TopLevelDomain, TimeDiff, InitiatingProcessCommandLine, *\r\n//| summarize count() by InitiatingProcessFolderPath, TopLevelDomain, RemoteUrl",
        "lastModifiedDateTime": null
      },
      "schedule": {
        "period": "1H",
        "nextRunDateTime": "2023-06-25T10:17:06.4366667Z"
      },
      "lastRunDetails": {
        "lastRunDateTime": "2023-06-25T09:17:06.4366667Z",
        "status": null,
        "failureReason": null,
        "errorCode": null
      },
      "detectionAction": {
        "alertTemplate": {
          "title": "updated Office/LoLBin Network Connection to Low-Reputation TLD",
          "description": "This is a custom detection created by the Centene Detection Engineering team.\n\nAn Office application or Living-Off-The-Land Binary made an immediate remote connection to a domain with a low-reputation top level domain after execution. This activity is suspicious as threat actors typically use low-reputation TLDs for malicious purposes, such as hosting payloads for potential targets. These TLDs are often abused because of their low cost and lack of oversite. The TLDs included in the list cover destinations that have either a high count or a high percentage of low-reputation sites. ",
          "severity": "low",
          "category": "CommandAndControl",
          "recommendedActions": "Check the reputation of the RemoteUrl through OSINT tools such as VirusTotal and Hybrid Analysis.\n\nReview the document and device timeline for additional context and IOCs. \n\nCheck for related alerts on the associated endpoint. ",
          "mitreTechniques": ["T1071.001"],
          "impactedAssets": [
            {
              "@odata.type": "#microsoft.graph.security.impactedDeviceAsset",
              "identifier": "deviceId"
            }
          ]
        },
        "organizationalScope": {
          "scopeType": "deviceGroup",
          "scopeNames": ["UnassignedGroup"]
        },
        "responseActions": []
      }
    }
  ]
}

Share via

List detectionRules

Permissions

HTTP request

Optional query parameters

Request headers

Request body

Response

Examples

Request

Response

Feedback

Additional resources