List simulations

Namespace: microsoft.graph

Get a list of attack simulation campaigns 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


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/simulations

Optional query parameters

This method supports the $count, $filter, $orderby, $skipToken, $top, and $select OData query parameters to help customize the response. You can use the $filter and $orderby query parameters on the attackTechnique, attackType, completionDateTime, displayName, isAutomated, launchDateTime, and status properties.

If the result set spans multiple pages, the response body contains an @odata.nextLink that you can use to page through the result set.

The following are examples of their use:

GET /security/attackSimulation/simulations?$count=true
GET /security/attackSimulation/simulations?$filter={property} eq '{property-value}'
GET /security/attackSimulation/simulations?$filter={property} eq '{property-value}'&$top=5
GET /security/attackSimulation/simulations?$orderby={property}
GET /security/attackSimulation/simulations?$skipToken={skipToken}
GET /security/attackSimulation/simulations?$top=1
GET /security/attackSimulation/simulations?$select={property}

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.


If successful, this method returns a 200 OK response code and a collection of simulation objects in the response body.



The following example shows a request.



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": [
      "id": "f1b13829-3829-f1b1-2938-b1f12938b1f1",
      "displayName": "Sample Simulation",
      "description": "Sample Simulation Description",
      "attackType": "social",
      "attackTechnique": "credentialHarvesting",
      "status": "scheduled",
      "createdDateTime": "2021-01-01T01:01:01.01Z",
      "createdBy": {
        "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21",
        "displayName": "Reed Flores",
        "email": ""
      "lastModifiedDateTime": "2021-01-01T01:01:01.01Z",
      "lastModifiedBy": {
        "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21",
        "displayName": "Reed Flores",
        "email": ""
      "launchDateTime": "2021-01-01T02:01:01.01Z",
      "completionDateTime": "2021-01-07T01:01:01.01Z",
      "isAutomated": false,
      "automationId": "f1b13829-3829-f1b1-2938-b1f12938b1ab",
      "payloadDeliveryPlatform": "email"