Files
windows-itpro-docs/windows/security/threat-protection/microsoft-defender-atp/get-user-related-alerts.md
2020-01-06 16:01:15 +02:00

2.5 KiB

title, description, keywords, search.product, ms.prod, ms.mktglfcycl, ms.sitesec, ms.pagetype, ms.author, author, ms.localizationpriority, manager, audience, ms.collection, ms.topic
title description keywords search.product ms.prod ms.mktglfcycl ms.sitesec ms.pagetype ms.author author ms.localizationpriority manager audience ms.collection ms.topic
Get user related alerts API Retrieves a collection of alerts related to a given user ID. apis, graph api, supported apis, get, user, related, alerts eADQiWindows 10XVcnh w10 deploy library security macapara mjcaparas medium dansimp ITPro M365-security-compliance article

Get user related alerts API

Applies to: Microsoft Defender Advanced Threat Protection (Microsoft Defender ATP)

API description

Retrieves a collection of alerts related to a given user ID.

Limitations

  1. Rate limitations for this API are 100 calls per minute and 1500 calls per hour.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Use Microsoft Defender ATP APIs

Permission type Permission Permission display name
Application Alert.Read.All 'Read all alerts'
Application Alert.ReadWrite.All 'Read and write all alerts'
Delegated (work or school account) Alert.Read 'Read alerts'
Delegated (work or school account) Alert.ReadWrite 'Read and write alerts'

Note

When obtaining a token using user credentials:

  • The user needs to have at least the following role permission: 'View Data' (See Create and manage roles for more information)
  • Response will include only alerts, associated with machines, that the user have access to, based on machine group settings (See Create and manage machine groups for more information)

HTTP request

GET /api/users/{id}/alerts

Note that the id is not the full UPN, but only the user name. (e.g., to retrieve alerts for user1@contoso.com use /api/users/user1/alerts)

Request headers

Name Type Description
Authorization String Bearer {token}. Required.

Request body

Empty

Response

If successful and user exist - 200 OK. If the user do not exist - 404 Not Found.

Example

Request

Here is an example of the request.

[!includeImprove request performance]

GET https://api.securitycenter.windows.com/api/users/user1/alerts