This integration collects events generated by Microsoft Defender for Endpoint to test the efficacy and configuration of the security control using Security Validation jobs.
Use this document to configure the integration using one of the following methods:
- MSI (Supported and recommended for new integration configurations)
- Legacy (Supported for existing integration configurations)
Configure MSI Integration
This document covers the the MSI method of creating an integration. This method is the recommended approach for configuring new integrations in Security Validation.
API Calls
| API | Usage |
|---|---|
login.microsoftonline.com |
Authentication workflow |
/api/machines/{id}/alerts |
Get alerts |
/api/machines |
Query for devices in Microsoft Defender for Endpoint |
/api/machineactions |
Query for machine actions in Microsoft Defender for Endpoint |
Supported Versions
Defender for Endpoint Plan 2
Before You Begin
To configure this integration, you need:
- The hostname of your Microsoft Defender for Endpoint instance
- Tenant ID
- Client ID
- Client Secret
Get Tenant ID
- Log in to the Microsoft Azure management portal with a user that has permission to Azure Active Directory.
- Select Azure Active Directory from the hamburger menu. The Overview page loads.
- While viewing the Overview page, copy the value of the Tenant ID and paste it to a safe location for use in the integration configuration.
Create an Azure Active Directory Application
- While in the Azure Active Directory management portal, click App Registrations from the menu.
- Click New Registration
- Enter a Name for the application. For example, Mandiant Advantage Defender for Endpoint Integration.
- Select the Supported Account Types option that best suits your needs.
- Click Register. The application is created.
- Copy the value of the Application (client) ID and paste it to a safe location for use in the integration configuration.
- Click Add a certificate or secret.
- Click New client secret.
- Enter a Description for the client secret.
- Set an expiry date for the client secret using the Expires drop-down option.
- Click Add.
- Copy the Value of the client secret and paste it to a safe location for use in the integration configuration. NOTE: this value cannot be viewed again once you close this page.
Define API Permissions
- While in the newly created application configuration in the Azure Portal, click API Permissions from the menu.
- Click Add a permission.
- Click the APIs my organization uses tab.
- Click WindowsDefenderATP.
- Select the Alert.Read.All and Machine.Read.All permissions.
- Click Add permissions.
Configure Security Validation
-
Go to Settings > Integrations.
- From the Integrations table, click Add Integration > Microsoft Defender for Endpoint.
You can add this as either a Direct or Remote Integration.
- Enter a meaningful Integration Name.
- Optional: From the Proxy drop-down, choose a proxy profile if one is available. If one isn't available and all outbound connections go through a proxy, first, set up a Proxy Rule.
- Optional: Change the HttpProtocols value to determine what protocol is used for requests (Https or Http).
- Enter the API Endpoint FQDN value for the Microsoft Defender for Endpoint instance. The default is api.securitycenter.window.com.
- Enter a Port value. The default is 443.
- Enter the Client Id and Client Secret values that you generated.
- Enter the Tenant ID for your Microsoft Defender for Endpoint instance.
- Optional: Change the Authorization URL, if needed. The default is https://login.microsoftonline.com/.
- Optional: Check Verify Ssl if you want this verification done for requests to an upstream server.
- Optional: Change the Timeout value if you want a different frequency of requests to an upstream server. The default is 30 (seconds).
- Optional: Modify the FieldMapModel values, as necessary.
- Each field map box can hold a JSON-formatted comma-separated list of columns returned by the API to be considered for each field when translating into the normalized event object format. Example: description could be configured to be 'msg_s' or 'SyslogMessage' in some environments. The field map tries both if set to: ['msg_s','SyslogMessage'] and whichever matches first is the column that is used.
- When configuring an integration in Security Validation, you can assign additional host values in the Field Map settings. If none of the assigned fields return a valid host name, Network Actions may miss matched events from the third-party technology. Additional hosts values helps ensure the likelihood of a match between the two environments.
-
Optional: Expand Advanced options and update the information as necessary.
- Update Query Time and Delay Time.
The Query time is the amount of time (minutes) before and after the query runs that the platform looks for events, while the Delay time is the amount of time (minutes) that the platform waits to run the first query after a Job Action starts. For example, you configure your integration with the following values: Query time = 5, Query interval = 30 seconds, and Delay time = 0. When a Job Actions starts at 12:00:00, the first time the query runs, the platform looks for events from 11:55:00 to 12:00:00. Then 30 seconds later, it looks for events from 11:55:30 to 12:00:30. This interval continues, with the last query looking from 12:00:00 to 12:05:00. If you instead configured the Delay time to equal 10, it would run the same query, but it wouldn't start that query until 12:10:00.If your monitors are set to run more frequently than the query time, this configuration impacts the pass/fail results for AEDA monitors.
- Update Query Interval (seconds).
- Configure correlation queries:
- Select Correlation Query Enabled and fill in the Correlation Query.
- Modify the Correlation Query Interval, if necessary (minutes).
- Select
Discover network devices automatically, the default and recommended option.
If unselected, reported events won't include product information for any matching network security technology.
- Select Save Suspicious Events.
- Modify the Event Time Adjustment (seconds). The default is 0.
-
Modify the Limit value if you need to prevent a flood of results. This value is set to 10000 by default. This limit applies to both events and alerts individually, so if you set it to 10, you can still see a maximum of 10 events and 10 alerts.
- Update Query Time and Delay Time.
-
Click Save.
Verify connectivity
- Go to Settings > Integrations.
- From the Direct Integrations table, click
> Test to verify that:
- The Director can communicate with the integration host on the port and protocol specified.
- The integration credentials are valid and working.
For more information on setting up queries, see Manage Integrations.
Configure Legacy Integration
This document applies to Classic/Legacy Integrations. You may continue to use these integration configurations. While no active development is happening for these integrations, we continue to provide Classic/Legacy Integrations in the product. You do not have to move to MSI Integrations. If your support engineer or TSC recommends or you choose to move to MSI Integrations, you can take advantage of the latest features and functionality. For more information, see the MSI Integration documentation in the Integrations Overview.
This integration is remote capable.
Update Defender ATP
- Identify or create credentials to access integration with read access, at minimum.
- Identify the following values in the Azure Web portal:
Refer to the Microsoft documentation for instructions on creating an app to get this information.
- Client ID
- Client Secret
- Authorization URL
- Tenant ID
API Calls
The following API calls are used by the Validation Platform.
|
Purpose |
Call |
|---|---|
| Get alerts for the Actor | /api/alerts |
| Get authorization token | Authorization URL provided by Defender ATP |
Update the Validation Platform
Prerequisites
Information to gather before you start:
- Identify the host, or geographic region, of your Defender ATP instance (US, UK, or EU).
- Identify the Port used for Defender ATP communication (this defaults to 443).
- Identify the Client ID unique to your application.
- Identify the Client Secret unique to your application.
- Identify the Authorization URL unique to your application.
- Identify the Tenant ID unique to your application.
Microsoft SIEM API is being replaced with Microsoft Graph for accessing Defender events. If your system employs Microsoft Graph, the settings shown here will need to be configured before you can successfully integrate with Microsoft Defender ATP.
To add the Defender ATP integration
-
Go to Settings > Integrations.
- Click Add Integration > Defender ATP.
You can add this as either a Local or Remote Integration.
-
Enter information for the Host, Port, and Protocol.
- If using an alternate hostname, that needs to be defined on Windows Actors for MS Defender ATP to make a hostname-based match.
- The host is auto-populated with the required info for the current API version but can be changed to one of the options listed that follow the Host text box.
- Enter information for the Client ID and Client Secret.
- (Optional) Update the API Version. This is set to the current supported API by default.
- Update the Auth URL.
This is set correctly for MS Defender for Endpoint API. Update this if you are not using the MS Defender for Endpoint API.
- Add the Tenant ID.
This is necessary if you're using the MS Defender for Endpoint API.
- Add the Resource.
This is necessary if you are using the Legacy SIEM API.
-
Expand Advanced options and update the information if necessary.
-
Click Submit.
Set up Proxy Assignment
If all outbound connections go through a proxy, you may want to set up a proxy definition and assignment for your integration. For information on setting up your proxy rules, see Proxy Rules.
Verify connectivity
To verify connectivity to Defender ATP
Click Test to verify that:
- The Director can communicate with the integration host on the port and protocol specified.
- The integration credentials are valid and working.