WDATP API “Hello World” (or using a simple PowerShell script to pull alerts via WDATP APIs)

5 Minutes

 Low complexity

 

Applying a security solution in an enterprise environment can be a complex endeavor. Customers deploy various layers of protection solutions, investigation platforms and hunting tools. Security Operation teams attempt to tackle this task, but typically lack expensive and experienced human resources to overcome this challenge. Automation is a decent mitigation but automating the security procedures and wiring the security components all together to a solid cyber security solution, requires programmatic access to each solution.

 

In these series of blogs, we will walk you through common automation scenarios that you can achieve with Windows Defender ATP to optimize workflows. For more information on Windows Defender ATP APIs, see the full documentation.

 

We called this blog “Hello World” as every long software journey starts with a simple step. We’ll show you how to programmatically extract Windows Defender ATP alerts with a PowerShell script. You can schedule this script to run on any machine and you may modify it to use the alert information in your specific use case. We can imagine a handful of standard use cases where a Security Operations Center (SOC) can leverage this basic capability.

 

Some scenarios where this can be applied include use with security information and event management (SIEM) connectors, ticketing systems, and security orchestration and response (SOAR) solutions. SIEM connectors may be the simplest example while ticketing systems are a common one, and SOAR solutions may be a complex use case.

 

So let gets started….

 

How long it takes to go through this example?

 

It only takes 5 minutes done in two steps:

• Application registration: takes 2 minutes
• Use examples: only requires copy/paste of a short PowerShell script

Do I need permission to connect?

For the app registration stage, you must have a Global administrator role in your Azure Active Directory (Azure AD) tenant.

 

Step 1 - Register the app in Azure Active Directory

 

• With your Global administrator credentials, login to the Azure portal.
  • Azure Active Directory > App registrations > New registration.

 

• In the registration form:
  • Name - Name your application.
  • Supported account type – leave the default setting.
  • Redirect Uri – leave empty.

• Click Register

The application I created is the authentication entity, just like a service account. I now need to set permissions to my app and save its credential for later use.

 

• On your new application page, click API Permissions > Add permission > APIs my organization uses > type WindowsDefenderATP and click on WindowsDefenderATP

•  

  Note: WindowsDefenderATP does not appear in the original list. You need to start writing its name in the text box to see it appear

• Choose Application permissions > Alert.Read.All > Click on Add permissions:

• After clicking the Add Permissions button, on the next screen we need to grant consent for the permission to take effect.

• Press the "Grant admin consent for {your tenant name}" button.

As explained, the registered app is an authentication entity with permission to access all alerts for reading. Now I need to get and store the authentication and authorization credentials:

• Key (application secret), Application ID, and Tenant ID

Think of your secret like a password, Application ID as username and Tenant ID as a domain.

 

• To get credentials:
  • In your application page, Click Certificate & Secrets
  • Specify a key description and set an expiration for 1 year.

• Click Add.
• The application key will appear.
  IMPORTANT: Copy and store this key in a safe place. Treat it like a password.
• Get your application ID and your tenant ID:
  • On your application page, go to Overview and copy the following

 

 

 

 Done! You have successfully registered an application. You may reuse this application when going through the exercises that we’ll be using in future blogs and experiments.

 

Now we’ll need to connect the API which means getting a token. The token is proof for Windows Defender ATP that an API call is authenticated and authorized.

 

Connecting the API:

• Copy the text below to PowerShell ISE or to a text editor.

 

 

# That code get the App Context Token and save it to file name "Latest-token.txt" under the current directory
# Paste below your Tenant ID, App ID and App Secret (App key).

$tenantId = 'f839b112-d9d7-94d27-9bf6-94542403f21c' ### Paste your own tenant ID here
$appId = '94fbf312-ae3f-47f4-8eeb-d375d1299e8f' ### Paste your own app ID here
$appSecret = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890=' ### Paste your own app keys here

$resourceAppIdUri = 'https://api.securitycenter.windows.com'
$oAuthUri = "https://login.windows.net/$TenantId/oauth2/token"

$authBody = [Ordered] @{
    resource = "$resourceAppIdUri"
    client_id = "$appId"
    client_secret = "$appSecret"
    grant_type = 'client_credentials'
}

$authResponse = Invoke-RestMethod -Method Post -Uri $oAuthUri -Body $authBody -ErrorAction Stop
$token = $authResponse.access_token
Out-File -FilePath "./Latest-token.txt" -InputObject $token
return $token

 

 

• Save the script to file. You can name it "Get-Token.ps1".
• Running this script by pressing F5 will get a token and save it in the working folder under the name "./Latest-token.txt".

 

 

Sanity Check

• In your browser go to: https://jwt.ms/
• Copy the token (the content of the Latest-token.txt file).
• Paste in the top box.
• Look for the "roles" section. Find the Alert.Read.All role.

 

• Now let’s gets the alerts, Copy the following text to a new PowerShell Script.

 

# Returns Alerts created in the past 48 hours.
$token = ./Get-Token.ps1       
#run the script Get-Token.ps1  - make sure you are running this script from the same folder of Get-Token.ps1
# Get Alert from the last 48 hours. Make sure you have alerts in that time frame.

$dateTime = (Get-Date).ToUniversalTime().AddHours(-48).ToString("o")      

# The URL contains the type of query and the time filter we create above
# Read more about other query options and filters here
$url = "https://api.securitycenter.windows.com/api/alerts?`$filter=alertCreationTime ge $dateTime"

# Set the WebRequest headers
$headers = @{
    'Content-Type' = 'application/json'
    Accept = 'application/json'
    Authorization = "Bearer $token"
}

# Send the webrequest and get the results. 
$response = Invoke-WebRequest -Method Get -Uri $url -Headers $headers -ErrorAction Stop
#Extract the alerts from the results. 
$alerts =  ($response | ConvertFrom-Json).value | ConvertTo-Json

#Get string with the execution time. We concatenate that string to the output file to avoid overwrite the file
$dateTimeForFileName = Get-Date -Format o | foreach {$_ -replace ":", "."}   

#save the result as json and as csv
$outputJsonPath = "./Latest Alerts $dateTimeForFileName.json"    
$outputCsvPath = "./Latest Alerts $dateTimeForFileName.csv"

Out-File -FilePath $outputJsonPath -InputObject $alerts
($alerts | ConvertFrom-Json) | Export-CSV $outputCsvPath -NoTypeInformation

• Save the file in the same folder you saved the previous script (Get-Token.ps1).
• You can run the script by right-clicking on the file and choosing "Run with PowerShell" or run it from PowerShell console.
  NOTE: If you are using powershell_ise.exe make sure to change directory to the directory with the scripts.

 

• You will now see two files (json and csv) created in the same folder as the scripts.
• The files are the latest alert from your tenant in the past 48 hours.

 

You’re all done! You have just successfully:

• Created and registered and application
• Granted permission for that application to read alerts
• Connected the API
• Use a PowerShell script to return alerts created in the past 48 hours

 

 

In the next blog, we’ll walk you through updating alert status programmatically. I invite you to suggest more use cases that you’d like for us to blog about, provide feedback, and ask questions about this post!

 

Thanks!

Haim Goldshtein, security software engineer, WDATP

Dan Michelson, program manager, WDATP

@Ben Alfasi, software engineer, Windows Defender ATP