List payloads

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 a list of payloads for attack simulation campaigns. This operation expects the mandatory parameter source to filter and query the respective data source.

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/payloads?$filter=source eq 'Tenant'

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/payloads?$filter=source eq 'Tenant' and $count=true
GET /security/attackSimulation/payloads?$filter=source eq 'Tenant' and $filter={property} eq '{property-value}'
GET /security/attackSimulation/payloads?$filter=source eq 'Tenant' and $filter={property} eq '{property-value}'&$top=5
GET /security/attackSimulation/payloads?$filter=source eq 'Tenant' and $orderby={property}
GET /security/attackSimulation/payloads?$filter=source eq 'Tenant' and $skipToken={skipToken}
GET /security/attackSimulation/payloads?$filter=source eq 'Tenant' and $top=1
GET /security/attackSimulation/payloads?$filter=source eq 'Tenant' and $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 collection of payload objects in the response body.

Examples

Request

The following is an example of a request.

HTTP

GET https://graph.microsoft.com/beta/security/attackSimulation/payloads?$filter=source eq 'Tenant'

Go

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


requestFilter := "source eq 'Tenant'"

requestParameters := &graphconfig.SecurityAttackSimulationPayloadsRequestBuilderGetQueryParameters{
	Filter: &requestFilter,
}
configuration := &graphconfig.SecurityAttackSimulationPayloadsRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

result, err := graphClient.Security().AttackSimulation().Payloads().Get(context.Background(), configuration)

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.

PowerShell

Import-Module Microsoft.Graph.Security

Get-MgSecurityAttackSimulationPayload -Filter "source eq 'Tenant'" 

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.

PHP

<?php

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

$requestConfiguration = new PayloadsRequestBuilderGetRequestConfiguration();

$queryParameters = new PayloadsRequestBuilderGetQueryParameters();
$queryParameters->filter = "source eq 'Tenant'";

$requestConfiguration->queryParameters = $queryParameters;


$requestResult = $graphServiceClient->security()->attackSimulation()->payloads()->get($requestConfiguration);

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.

Response

The following is an example of a 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?$filter=source eq 'Tenant'",
    "@odata.nextLink": "https://graph.microsoft.com/beta/security/attackSimulation/payloads?$filter=source+eq+%27Tenant%27&$skiptoken=MyZRVkZCUVVGQlFVRXZMeTh2THk4dkx5OHZPSGxCUVVGQk4yZDZMMFZwZFRjcmF6WjJURk14TWtKVk9WYzNaejA5",
    "value": [
        {
            "id": "2f5548d1-0dd8-4cc8-9de0-e0d6ec7ea3dc",
            "name": "AttackSimTest Payload",
            "description": "AttackSim Test Payload",
            "attackType": "social",
            "platform": "email",
            "isAutomated": null,
            "status": "draft",
            "source": "tenant",
            "language": "en",
            "predictedCompromiseRate": 20.0,
            "complexity": "medium",
            "attackTechnique": "credentialHarvesting",
            "createdBy": {
                "email": "faiza@contoso.com",
                "id": "121212",
                "displayName": "Faiza"
            },
            "createdDateTime": "2022-01-12T03:15:01.5906699Z",
            "lastModifiedBy": {
                "email": "faiza@contoso.com",
                "id": "121212",
                "displayName": "Faiza"
            },
            "lastModifiedDateTime": "2021-10-07T12:23:18.8157586Z",
            "theme": "personalizedOffer",
            "Brand": "microsoft",
            "payloadIndustry": "IT",
            "isCurrentEvent": false,
            "isControversial": false,
            "payloadTags": [],
            "detail" : null
        }
    ]
}