Get training

Namespace: microsoft.graph

Get an attack simulation training 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

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

HTTP request

GET /security/attackSimulation/trainings/{trainingId}

Optional query parameters

This method doesn't 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 training object in the response body.

Examples

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/v1.0/security/attackSimulation/trainings/21b2b7d1-11ae-a7a8-99c8-9029a4e70cc9

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Security.AttackSimulation.Trainings["{training-id}"].GetAsync();

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

CLI

mgc security attack-simulation trainings get --training-id {training-id}

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

Go

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
trainings, err := graphClient.Security().AttackSimulation().Trainings().ByTrainingId("training-id").Get(context.Background(), nil)

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

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Training result = graphClient.security().attackSimulation().trainings().byTrainingId("{training-id}").get();

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

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let training = await client.api('/security/attackSimulation/trainings/21b2b7d1-11ae-a7a8-99c8-9029a4e70cc9')
	.get();

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

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->security()->attackSimulation()->trainings()->byTrainingId('training-id')->get()->wait();

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-MgSecurityAttackSimulationTraining -TrainingId $trainingId

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

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.security.attack_simulation.trainings.by_training_id('training-id').get()

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

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/trainings/$entity",
    "id": "db8175cd-bafe-433a-a823-a2d6dd6c5e6a",
    "displayName": "Mass Market Phishing - Amazon Gift Card",
    "description": "Mass Market Phishing - Amazon Gift Card",
    "durationInMinutes": 3,
    "source": "global",
    "type": "unknown",
    "tags": [
        "CredentialHarvesting",
        "DriveByUrl",
        "Compliance",
        "Basic",
        "Phishing"
    ],
    "availabilityStatus": "available",
    "supportedLocales": [
        "tr",
        "pl",
        "fa",
        "da",
        "nl"
    ],
    "hasEvaluation": false,
    "createdDateTime": "2020-09-18T06:54:46.1930597Z",
    "lastModifiedDateTime": "2023-03-28T12:01:33.3568194Z",
    "createdBy": {
        "email": "yibsu",
        "id": null,
        "displayName": null
    },
    "lastModifiedBy": {
        "email": "yibsu",
        "id": null,
        "displayName": null
    }
}