Edit

Get payloadDetail

  • Article

Namespace: microsoft.graph

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 an attack simulation campaign payload detail for a tenant.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) AttackSimulation.Read.All, AttackSimulation.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application AttackSimulation.Read.All, AttackSimulation.ReadWrite.All

HTTP request

GET /security/attackSimulation/payloads/{payloadId}/detail

Optional query parameters

This method does not currently support the OData query parameters to customize the response.

Request headers

Name Description
Authorization Bearer {token}. Required.

Request body

Do not supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a payloadDetail object in the response body.

Examples

Request

The following is an example of a request.

GET https://graph.microsoft.com/beta/security/attackSimulation/payload/f1b13829-3829-f1b1-2938-b1f12938b1a/detail

Response

The following is an example of the response.

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

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#security/attackSimulation/payloads/2f5548d1-0dd8-4cc8-9de0-e0d6ec7ea3dc/detail",
  "fromName": "faiza",
  "fromEmail": "faiza@contoso.com",
  "addIsExternalSender": false,
  "subject": "Payload Detail",
  "content": "<meta http-equiv=\"Content-Type\" content=\"text/html>\">",
  "phishingUrl": "http://www.widgetsinc10+.com",
  "coachMarks": [
    {
      "indicator": "URL hyperlinking",
      "description": "URL hyperlinking hides the true URL behind text; the text can also look like another link",
      "language": "en",
      "order": "0",
      "isValid": true,
      "coachmarkLocation": {
        "offset": 144,
        "length": 6,
        "type": "messageBody"
      }
    }
  ]
}