Get simulation

Namespace: microsoft.graph

Get an attack simulation campaign 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/simulations/{simulationId}

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

Examples

Example 1: Get an attack simulation campaign

Request

The following example shows a request.

GET https://graph.microsoft.com/v1.0/security/attackSimulation/simulations/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

{
    "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"
}

Example 2: Get included account targets

The following example shows how to get included account targets (users) for an attack simulation campaign for a tenant.

Request

The following example shows a request.

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

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.type": "#microsoft.graph.addressBookAccountTargetContent",
  "type": "addressBook",
  "accountTargetEmails": [
    "john@contoso.com"
  ]
}

Example 3: Get excluded account targets

The following example shows how to get excluded account targets (users) for an attack simulation campaign for a tenant.

Request

The following example shows a request.

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

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.type": "#microsoft.graph.addressBookAccountTargetContent",
  "type": "addressBook",
  "accountTargetEmails": [
    "alie@contoso.com"
  ]
}

Example 4: Get training setting details

The following example shows how to get training setting details for a simulation.

Request

The following example shows a request.

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

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/v1.0/$metadata#security/attackSimulation/simulations('d93188b6-6473-4fdb-a73f-48d0dbdd0df6')/trainingSetting",
  "trainingCompletionDuration": "month",
  "completionDateTime": "0001-01-01T00:00:00Z",
  "settingType": "microsoftManaged"
}

Example 5: Get end user notification setting

The following example shows how to get end user notification setting details for a simulation.

Request

The following example shows a request.

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

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/v1.0/$metadata#security/attackSimulation/simulations('d93188b6-6473-4fdb-a73f-48d0dbdd0df6')/endUserNotificationSetting",
  "settingType": "noNotification",
  "positiveReinforcement": null,
  "notificationPreference": "unknown"
}