シミュレーションの更新

名前空間: microsoft.graph

テナントの攻撃シミュレーション キャンペーンを更新します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください

アクセス許可の種類 最小特権アクセス許可 特権の高いアクセス許可
委任 (職場または学校のアカウント) AttackSimulation.ReadWrite.All 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション AttackSimulation.ReadWrite.All 注意事項なし。

HTTP 要求

PATCH /security/attackSimulation/simulations/{simulationId}

要求ヘッダー

ヘッダー
Authorization ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。
Content-Type application/json

要求本文

要求本文で、更新すべきプロパティの値のみを指定します。 要求本文に含まれていない既存のプロパティは、以前の値を維持するか、他のプロパティ値の変更に基づいて再計算されます。

次の表に、更新できるプロパティを示します。

プロパティ 説明
attackTechnique simulationAttackTechnique 攻撃シミュレーションとトレーニング キャンペーンで使用されるソーシャル エンジニアリング手法。 $filter$orderby をサポートします。 可能な値は、unknowncredentialHarvestingattachmentMalwaredriveByUrllinkInAttachmentlinkToMalwareFileunknownFutureValueoAuthConsentGrant です。 この進化可能な列挙型から次のPrefer: include-unknown-enum-members値を取得するには、要求ヘッダーを使用する必要があることに注意してください。 oAuthConsentGrant ソーシャル エンジニアリング攻撃手法の種類の詳細については、「 シミュレーション」を参照してください。
attackType simulationAttackType 攻撃シミュレーションとトレーニング キャンペーンの攻撃の種類。 $filter$orderby をサポートします。 可能な値は、unknownsocialcloudendpointunknownFutureValue です。
displayName String 攻撃シミュレーションとトレーニング キャンペーンの表示名。 $filter$orderby をサポートします。
durationInDays Int32 シミュレーション期間 (日数)。
excludedAccountTarget accountTargetContent シミュレーションから除外されたユーザー。
includedAccountTarget accountTargetContent シミュレーションの対象となるユーザー。
payload ペイロード シミュレーションに関連付けられたペイロード。
status simulationStatus 攻撃シミュレーションとトレーニング キャンペーンの状態。 $filter$orderby をサポートします。 可能な値は、unknowndraftrunningscheduledsucceededfailedcancelledexcludedunknownFutureValue です。

応答

成功した場合、このメソッドは 202 Accepted 応答コードと、応答で という名前 location の追跡ヘッダーを返します。

例 1: 攻撃シミュレーション キャンペーンを更新する

次の例は、テナントの攻撃シミュレーション キャンペーンを更新する方法を示しています。

要求

次の例は要求を示しています。

PATCH https://graph.microsoft.com/v1.0/security/attackSimulation/simulations/2f5548d1-0dd8-4cc8-9de0-e0d6ec7ea3dc
Content-type: application/json

{
  "@odata.etag": "\"0100aa9b-0000-0100-0000-6396fa270000\"",
  "displayName": "Graph Simulation",
  "payload@odata.bind":"https://graph.microsoft.com/v1.0/security/attacksimulation/payloads/12345678-9abc-def0-123456789a",
  "durationInDays": 7,
  "attackTechnique": "credentialHarvesting",
  "attackType": "social",
  "status": "scheduled",
  "includedAccountTarget": {
    "@odata.type": "#microsoft.graph.addressBookAccountTargetContent",
    "type" : "addressBook",
    "accountTargetEmails" : [
        "faiza@contoso.com"
    ]
  },
  "excludedAccountTarget": {
    "@odata.type": "#microsoft.graph.addressBookAccountTargetContent",
    "type" : "addressBook",
    "accountTargetEmails" : [
        "sam@contoso.com"
    ]
  }
}

応答

次の例は応答を示しています。

HTTP/1.1 202 Accepted

例 2: 攻撃シミュレーション キャンペーンを下書きからスケジュール済みに更新する

次の例は、攻撃シミュレーション キャンペーンをスケジュールする方法を示しています。 シミュレーション要求は、シミュレーションをスケジュールするときに検証されます。 必要なすべてのパラメーターをそのような要求に反映する必要があります。

要求

次の例は要求を示しています。

PATCH https://graph.microsoft.com/v1.0/security/attackSimulation/simulations/2f5548d1-0dd8-4cc8-9de0-e0d6ec7ea3dc
Content-type: application/json

{
  "@odata.etag": "\"0100aa9b-0000-0100-0000-6396fa270000\"",
  "id": "2f5548d1-0dd8-4cc8-9de0-e0d6ec7ea3dc",
  "displayName": "Graph Simulation",
  "payload@odata.bind":"https://graph.microsoft.com/v1.0/security/attacksimulation/payloads/12345678-9abc-def0-123456789a",
  "durationInDays": 7,
  "attackTechnique": "credentialHarvesting",
  "attackType": "social",
  "status": "scheduled",
  "includedAccountTarget": {
    "@odata.type": "#microsoft.graph.addressBookAccountTargetContent",
    "type" : "addressBook",
    "accountTargetEmails" : [
        "faiza@contoso.com"
    ]
  },
  "excludedAccountTarget": {
    "@odata.type": "#microsoft.graph.addressBookAccountTargetContent",
    "type" : "addressBook",
    "accountTargetEmails" : [
        "sam@contoso.com"
    ]
  }
}

応答

次の例は応答を示しています。

HTTP/1.1 202 Accepted

例 3: 攻撃シミュレーション キャンペーンをキャンセルする

次の例は、テナントの攻撃シミュレーション キャンペーンをキャンセルする方法を示しています。 シミュレーションの状態が または runningの場合はscheduled、シミュレーションを取り消すことができます。

要求

次の例は要求を示しています。

PATCH https://graph.microsoft.com/v1.0/security/attackSimulation/simulations/2f5548d1-0dd8-4cc8-9de0-e0d6ec7ea3dc
Content-type: application/json

{
  "@odata.etag": "\"0100aa9b-0000-0100-0000-6396fa270000\"",
  "id": "2f5548d1-0dd8-4cc8-9de0-e0d6ec7ea3dc",
  "status": "cancelled"
}

応答

次の例は応答を示しています。

HTTP/1.1 202 Accepted

例 4: 攻撃シミュレーション キャンペーンを除外する

次の例は、テナントの攻撃シミュレーション キャンペーンを除外する方法を示しています。 シミュレーションは、その状態 cancelledが である場合にのみ、レポートから除外できます。

要求

次の例は要求を示しています。

PATCH https://graph.microsoft.com/v1.0/security/attackSimulation/simulations/2f5548d1-0dd8-4cc8-9de0-e0d6ec7ea3dc
Content-type: application/json

{
  "@odata.etag": "\"0100aa9b-0000-0100-0000-6396fa270000\"",
  "id": "2f5548d1-0dd8-4cc8-9de0-e0d6ec7ea3dc",
  "status": "excluded"
}

応答

次の例は応答を示しています。

HTTP/1.1 202 Accepted