Edit

Share via

Get payload

  • 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 for a tenant.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet
✅ ❌ ❌ ❌

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.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) AttackSimulation.Read.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application AttackSimulation.Read.All Not available.

HTTP request

GET /security/attackSimulation/payloads/{payloadId}
GET /security/attackSimulation/simulations/{simulationId}/payload

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. 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 payload object in the response body.

Examples

Request

The following example shows a request.

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

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#security/attackSimulation/payloads/2f5548d1-0dd8-4cc8-9de0-e0d6ec7ea3dc",
  "id": "2f5548d1-0dd8-4cc8-9de0-e0d6ec7ea3dc",
  "name": "AttackSimTest Payload",
  "description": "AttackSim Test Payload",
  "simulationAttackType": "social",
  "platform": "email",
  "isAutomated": null,
  "status": "draft",
  "source": "tenant",
  "language": "en",
  "predictedCompromiseRate": 20.0,
  "complexity": "medium",
  "technique": "credentialHarvesting",
  "createdBy": {
    "email": "[email protected]",
    "id": "121212",
    "displayName": "Faiza"
  },
  "createdDateTime": "2022-01-12T03:15:01.5906699Z",
  "lastModifiedBy": {
    "email": "[email protected]",
    "id": "121212",
    "displayName": "Faiza"
  },
  "lastModifiedDateTime": "2021-10-07T12:23:18.8157586Z",
  "theme": "personalizedOffer",
  "brand": "microsoft",
  "industry": "IT",
  "isCurrentEvent": false,
  "isControversial": false,
  "detail": null,
  "payloadTags": []
}