Skip to content

security-collaborationroot-list-analyzedemails.md

Latest commit

 

History

History
194 lines (165 loc) · 6.1 KB

security-collaborationroot-list-analyzedemails.md

File metadata and controls

194 lines (165 loc) · 6.1 KB
title List analyzedEmails
description Get a list of analyzedEmail objects and their properties.
author ajaj-shaikh
ms.localizationpriority medium
ms.subservice security
doc_type apiPageType
ms.date 06/21/2024

List analyzedEmails

Namespace: microsoft.graph.security

[!INCLUDE beta-disclaimer]

Get a list of analyzedEmail objects and their properties.

This API allows Security Operations teams to have direct access to hunt (query) for threats, IOCs, attack vectors, and evidences for a tenant. It is a powerful, near real-time tool to help Security Operations teams investigate and respond to threats. It consists of email metadata, verdict information, related underlying entities (attachments/URL), filters, and more.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

HTTP request

GET /security/collaboration/analyzedEmails

Query parameters

In the request URL, provide the following required query parameters with values.

Parameter Type Description
startTime DateTime The start time of the email search.
endTime DateTime The end time of the email search.

OData query parameters

This method supports the following OData query parameters to help customize the response: $count, $filter, $skiptoken, $top. For general information, see OData query parameters.

The following example shows how to use the $filter parameter to customize the response.

GET /security/collaboration/analyzedemails?startTime=2024-02-18&endTime=2024-02-20&filter=networkMessageId eq 'bde1f764-bbf4-5673-fbba-0asdhsgfhf1'
GET /security/collaboration/analyzedemails?startTime=2024-02-18&endTime=2024-02-20&filter=networkMessageId eq 'bde1f764-bbf4-5673-fbba-0asdhsgfhf1' and recipientEmailAddress eq 'tomas.richardson@contoso.com'

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 microsoft.graph.security.analyzedEmail objects in the response body.

Examples

Request

The following example shows a request.

GET https:security/collaboration/analyzedemails?startTime=2024-02-18&endTime=2024-02-20

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.analyzedEmail",
      "id": "String",
      "loggedDateTime": "Datetime",
      "networkMessageId": "String",
      "internetMessageId": "String",
      "senderDetail": {
        "@odata.type": "microsoft.graph.security.analyzedEmailSenderDetail"
      },
      "recipientEmailAddress": "String",
      "distributionList": "String",
      "subject": "String",
      "returnPath": "String",
      "directionality": "microsoft.graph.security.antispamDirectionality",
      "originalDelivery": {
        "@odata.type": "microsoft.graph.security.analyzedEmailDeliveryDetail"
      },
      "latestDelivery": {
        "@odata.type": "microsoft.graph.security.analyzedEmailDeliveryDetail"
      },
      "attachments": [
        {
          "@odata.type": "microsoft.graph.security.analyzedEmailAttachment"
        }
      ],
      "urls": [
        {
          "@odata.type": "microsoft.graph.security.analyzedEmailUrl"
        }
      ],
      "language": "String",
      "sizeInBytes": "Integer",
      "alertIds": [
        "String"
      ],
      "exchangeTransportRules": [
        {
          "@odata.type": "microsoft.graph.security.analyzedEmailExchangeTransportRuleInfo"
        }
      ],
      "overrideSources": [
        "String"
      ],
      "threatTypes": [
        "microsoft.graph.security.threatType"
      ],
      "detectionMethods": [
        "String"
      ],
      "contexts": [
        "String"
      ],
      "authenticationDetails": {
        "@odata.type": "microsoft.graph.security.analyzedEmailAuthenticationDetail"
      },
      "phishConfidenceLevel": "String",
      "spamConfidenceLevel": "String",
      "bulkComplaintLevel": "String",
      "emailClusterId": "String",
      "policyAction": "String",
      "policy": "String",
      "timelineEvents": [
        {
          "@odata.type": "microsoft.graph.security.timelineEvent"
        }
      ],
      "threatDetectionDetails": [
        {
          "@odata.type": "microsoft.graph.security.threatDetectionDetail"
        }
      ],
      "primaryOverrideSource": "String",
      "inboundConnectorFormattedName": "String",
      "policyType": "String",
      "clientType": "String",
      "dlpRules": [
        {
          "@odata.type": "microsoft.graph.security.analyzedEmailDlpRuleInfo"
        }
      ],
      "forwardingDetail": "String",
      "recipientDetail": {
        "@odata.type": "microsoft.graph.security.analyzedEmailRecipientDetail"
      }
    }
  ]
}