Create simulation

Article
01/26/2023
6 minutes to read

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.

Create 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.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	AttackSimulation.ReadWrite.All

HTTP request

POST /security/attackSimulation/simulations

Request headers

Header	Value
Authorization	Bearer {token}. Required.
Content-Type	application/json

Request body

In the request body, supply a JSON representation of a simulation object.

The following table shows the properties that are required when you create the simulation.

Property	Type	Description
attackTechnique	simulationAttackTechnique	The social engineering technique used in the attack simulation and training campaign. Supports `$filter` and `$orderby`. Possible values are: `unknown`, `credentialHarvesting`, `attachmentMalware`, `driveByUrl`, `linkInAttachment`, `linkToMalwareFile`, `unknownFutureValue`. For more information on the types of social engineering attack techniques, see simulations.
attackType	simulationAttackType	Attack type of the attack simulation and training campaign. Supports `$filter` and `$orderby`. Possible values are: `unknown`, `social`, `cloud`, `endpoint`, `unknownFutureValue`.
completionDateTime	DateTimeOffset	Date and time of completion of the attack simulation and training campaign. Supports `$filter` and `$orderby`.
createdBy	emailIdentity	Identity of the user who created the attack simulation and training campaign.
createdDateTime	DateTimeOffset	Date and time of creation of the attack simulation and training campaign.
displayName	String	Display name of the attack simulation and training campaign. Supports `$filter` and `$orderby`.
durationInDays	Int32	Simulation duration in days.
includedAccountTarget	accountTargetContent	Users targeted in the simulation.
lastModifiedBy	emailIdentity	Identity of the user who most recently modified the attack simulation and training campaign.
launchDateTime	DateTimeOffset	Date and time of the launch/start of the attack simulation and training campaign. Supports `$filter` and `$orderby`.
payloadDeliveryPlatform	payloadDeliveryPlatform	Method of delivery of the phishing payload used in the attack simulation and training campaign. Possible values are: `unknown`, `sms`, `email`, `teams`, `unknownFutureValue`.
status	simulationStatus	Status of the attack simulation and training campaign. Supports `$filter` and `$orderby`. Possible values are: `unknown`, `draft`, `running`, `scheduled`, `succeeded`, `failed`, `cancelled`, `excluded`, `unknownFutureValue`.

Response

If successful, this method returns a 202 Accepted response code and a tracking header named location in the response.

Examples

Request

The following is an example of a request.

POST https://graph.microsoft.com/beta/security/attackSimulation/simulations
Content-type: application/json

{
  "displayName": "Graph Simulation",
  "payloadDeliveryPlatform": "email",
  "payload@odata.bind":"https://graph.microsoft.com/beta/security/attacksimulation/payloads/12345678-9abc-def0-123456789a",
  "durationInDays": 7,
  "attackTechnique": "credentialHarvesting",
  "attackType": "social",
  "status": "scheduled",
  "completionDateTime": "2022-09-16T06:13:08.4297612Z",
  "launchDateTime": "2022-09-05T06:13:08.4297612Z",
  "includedAccountTarget": {
    "@odata.type": "#microsoft.graph.addressBookAccountTargetContent",
    "type" : "addressBook",
    "accountTargetEmails" : [
        "john@contoso.com"
    ]
  },
}


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var simulation = new Simulation
{
	DisplayName = "Graph Simulation",
	PayloadDeliveryPlatform = PayloadDeliveryPlatform.Email,
	DurationInDays = 7,
	AttackTechnique = SimulationAttackTechnique.CredentialHarvesting,
	AttackType = SimulationAttackType.Social,
	Status = SimulationStatus.Scheduled,
	CompletionDateTime = DateTimeOffset.Parse("2022-09-16T06:13:08.4297612Z"),
	LaunchDateTime = DateTimeOffset.Parse("2022-09-05T06:13:08.4297612Z"),
	IncludedAccountTarget = new AddressBookAccountTargetContent
	{
		Type = AccountTargetContentType.AddressBook,
		AccountTargetEmails = new List<String>()
		{
			"john@contoso.com"
		}
	},
	AdditionalData = new Dictionary<string, object>()
	{
		{"payload@odata.bind", "https://graph.microsoft.com/beta/security/attacksimulation/payloads/12345678-9abc-def0-123456789a"}
	}
};

await graphClient.Security.AttackSimulation.Simulations
	.Request()
	.AddAsync(simulation);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

const simulation = {
  displayName: 'Graph Simulation',
  payloadDeliveryPlatform: 'email',
  'payload@odata.bind':'https://graph.microsoft.com/beta/security/attacksimulation/payloads/12345678-9abc-def0-123456789a',
  durationInDays: 7,
  attackTechnique: 'credentialHarvesting',
  attackType: 'social',
  status: 'scheduled',
  completionDateTime: '2022-09-16T06:13:08.4297612Z',
  launchDateTime: '2022-09-05T06:13:08.4297612Z',
  includedAccountTarget: {
    '@odata.type': '#microsoft.graph.addressBookAccountTargetContent',
    type: 'addressBook',
    accountTargetEmails: [
        'john@contoso.com'
    ]
  },
};

await client.api('/security/attackSimulation/simulations')
	.version('beta')
	.post(simulation);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

Simulation simulation = new Simulation();
simulation.displayName = "Graph Simulation";
simulation.payloadDeliveryPlatform = PayloadDeliveryPlatform.EMAIL;
simulation.additionalDataManager().put("payload@odata.bind", new JsonPrimitive("https://graph.microsoft.com/beta/security/attacksimulation/payloads/12345678-9abc-def0-123456789a"));
simulation.durationInDays = 7;
simulation.attackTechnique = SimulationAttackTechnique.CREDENTIAL_HARVESTING;
simulation.attackType = SimulationAttackType.SOCIAL;
simulation.status = SimulationStatus.SCHEDULED;
simulation.completionDateTime = OffsetDateTimeSerializer.deserialize("2022-09-16T06:13:08.4297612Z");
simulation.launchDateTime = OffsetDateTimeSerializer.deserialize("2022-09-05T06:13:08.4297612Z");
AddressBookAccountTargetContent includedAccountTarget = new AddressBookAccountTargetContent();
includedAccountTarget.type = AccountTargetContentType.ADDRESS_BOOK;
LinkedList<String> accountTargetEmailsList = new LinkedList<String>();
accountTargetEmailsList.add("john@contoso.com");
includedAccountTarget.accountTargetEmails = accountTargetEmailsList;
simulation.includedAccountTarget = includedAccountTarget;

graphClient.security().attackSimulation().simulations()
	.buildRequest()
	.post(simulation);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := graphmodels.NewSimulation()
displayName := "Graph Simulation"
requestBody.SetDisplayName(&displayName) 
payloadDeliveryPlatform := graphmodels.EMAIL_PAYLOADDELIVERYPLATFORM 
requestBody.SetPayloadDeliveryPlatform(&payloadDeliveryPlatform) 
durationInDays := int32(7)
requestBody.SetDurationInDays(&durationInDays) 
attackTechnique := graphmodels.CREDENTIALHARVESTING_SIMULATIONATTACKTECHNIQUE 
requestBody.SetAttackTechnique(&attackTechnique) 
attackType := graphmodels.SOCIAL_SIMULATIONATTACKTYPE 
requestBody.SetAttackType(&attackType) 
status := graphmodels.SCHEDULED_SIMULATIONSTATUS 
requestBody.SetStatus(&status) 
completionDateTime , err := time.Parse(time.RFC3339, "2022-09-16T06:13:08.4297612Z")
requestBody.SetCompletionDateTime(&completionDateTime) 
launchDateTime , err := time.Parse(time.RFC3339, "2022-09-05T06:13:08.4297612Z")
requestBody.SetLaunchDateTime(&launchDateTime) 
includedAccountTarget := graphmodels.NewAccountTargetContent()
type := graphmodels.ADDRESSBOOK_ACCOUNTTARGETCONTENTTYPE 
includedAccountTarget.SetType(&type) 
additionalData := map[string]interface{}{
	accountTargetEmails := []string {
		"john@contoso.com",

	}
}
includedAccountTarget.SetAdditionalData(additionalData)
requestBody.SetIncludedAccountTarget(includedAccountTarget)
additionalData := map[string]interface{}{
	"payload@odata.bind" : "https://graph.microsoft.com/beta/security/attacksimulation/payloads/12345678-9abc-def0-123456789a", 
}
requestBody.SetAdditionalData(additionalData)

result, err := graphClient.Security().AttackSimulation().Simulations().Post(context.Background(), requestBody, nil)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


Import-Module Microsoft.Graph.Security

$params = @{
	DisplayName = "Graph Simulation"
	PayloadDeliveryPlatform = "email"
	"Payload@odata.bind" = "https://graph.microsoft.com/beta/security/attacksimulation/payloads/12345678-9abc-def0-123456789a"
	DurationInDays = 7
	AttackTechnique = "credentialHarvesting"
	AttackType = "social"
	Status = "scheduled"
	CompletionDateTime = [System.DateTime]::Parse("2022-09-16T06:13:08.4297612Z")
	LaunchDateTime = [System.DateTime]::Parse("2022-09-05T06:13:08.4297612Z")
	IncludedAccountTarget = @{
		"@odata.type" = "#microsoft.graph.addressBookAccountTargetContent"
		Type = "addressBook"
		AccountTargetEmails = @(
			"john@contoso.com"
		)
	}
}

New-MgSecurityAttackSimulation -BodyParameter $params

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestBody = new Simulation();
$requestBody->setDisplayName('Graph Simulation');

$requestBody->setPayloadDeliveryPlatform(new PayloadDeliveryPlatform('email'));

$requestBody->setDurationInDays(7);

$requestBody->setAttackTechnique(new SimulationAttackTechnique('credentialharvesting'));

$requestBody->setAttackType(new SimulationAttackType('social'));

$requestBody->setStatus(new SimulationStatus('scheduled'));

$requestBody->setCompletionDateTime(new DateTime('2022-09-16T06:13:08.4297612Z'));

$requestBody->setLaunchDateTime(new DateTime('2022-09-05T06:13:08.4297612Z'));

$includedAccountTarget = new AccountTargetContent();
$includedAccountTarget->set@odatatype('#microsoft.graph.addressBookAccountTargetContent');

$includedAccountTarget->setType(new AccountTargetContentType('addressbook'));

$additionalData = [
'accountTargetEmails' => ['john@contoso.com', ],
];
$includedAccountTarget->setAdditionalData($additionalData);



$requestBody->setIncludedAccountTarget($includedAccountTarget);
$additionalData = [
'payload@odata.bind' => 'https://graph.microsoft.com/beta/security/attacksimulation/payloads/12345678-9abc-def0-123456789a', 
];
$requestBody->setAdditionalData($additionalData);




$requestResult = $graphServiceClient->security()->attackSimulation()->simulations()->post($requestBody);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following is an example of the response.

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

HTTP/1.1 202 Accepted

Create simulation

Permissions

HTTP request

Request headers

Request body

Response

Examples

Request

Response

Feedback

Additional resources

Additional resources