Get simulation

Namespace: microsoft.graph

Get an attack simulation campaign 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
Delegated (personal Microsoft account) Not supported.
Application AttackSimulation.Read.All

HTTP request

GET /security/attackSimulation/simulations/{simulationId}

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/{simulationId}?$count=true
GET /security/attackSimulation/simulations/{simulationId}?$filter={property} eq '{property-value}'
GET /security/attackSimulation/simulations/{simulationId}?$filter={property} eq '{property-value}'&$top=5
GET /security/attackSimulation/simulations/{simulationId}?$orderby={property}
GET /security/attackSimulation/simulations/{simulationId}?$skipToken={skipToken}
GET /security/attackSimulation/simulations/{simulationId}?$top=1
GET /security/attackSimulation/simulations/{simulationId}?$select={property}

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

Examples

Request

The following is an example of a request.

GET https://graph.microsoft.com/v1.0/security/attackSimulation/simulations/f1b13829-3829-f1b1-2938-b1f12938b1a

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

{
    "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": "reed@contoso.com"
    },
    "lastModifiedDateTime": "2021-01-01T01:01:01.01Z",
    "lastModifiedBy": {
        "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21",
        "displayName": "Reed Flores",
        "email": "reed@contoso.com"
    },
    "launchDateTime": "2021-01-01T02:01:01.01Z",
    "completionDateTime": "2021-01-07T01:01:01.01Z",
    "isAutomated": false,
    "automationId": "f1b13829-3829-f1b1-2938-b1f12938b1ab",
    "payloadDeliveryPlatform": "email"
}