Atualizar simulação

Namespace: microsoft.graph

Atualize uma campanha de simulação de ataque para um locatário.

Essa API está disponível nas seguintes implantações nacionais de nuvem.

Serviço global Governo dos EUA L4 GOVERNO DOS EUA L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões privilegiadas mais altas
Delegado (conta corporativa ou de estudante) AttackSimulation.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application AttackSimulation.ReadWrite.All Indisponível.

Solicitação HTTP

PATCH /security/attackSimulation/simulations/{simulationId}

Cabeçalhos de solicitação

Cabeçalho Valor
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json

Corpo da solicitação

No corpo da solicitação, forneça apenas os valores das propriedades que devem ser atualizadas. As propriedades existentes que não estão incluídas no corpo da solicitação mantêm seus valores anteriores ou são recalculadas com base em alterações em outros valores de propriedade.

A tabela a seguir especifica as propriedades que podem ser atualizadas.

Propriedade Tipo Descrição
attackTechnique simulationAttackTechnique A técnica de engenharia social usada na campanha de simulação e treinamento de ataque. Oferece suporte para $filter e $orderby. Os valores possíveis são: unknown, credentialHarvesting, attachmentMalware, driveByUrl, linkInAttachment, linkToMalwareFile, unknownFutureValue, oAuthConsentGrant. Observe que você deve usar o cabeçalho de Prefer: include-unknown-enum-members solicitação para obter os seguintes valores deste enumerável em evolução: oAuthConsentGrant. Para obter mais informações sobre os tipos de técnicas de ataque de engenharia social, confira simulações.
attackType simulationAttackType Tipo de ataque da campanha de simulação e treinamento de ataque. Oferece suporte para $filter e $orderby. Os valores possíveis são: unknown, social, cloud, endpoint, unknownFutureValue.
displayName Cadeia de caracteres Nome de exibição da campanha de simulação e treinamento de ataque. Oferece suporte para $filter e $orderby.
durationInDays Int32 Duração da simulação em dias.
excludeedAccountTarget accountTargetContent Usuários excluídos da simulação.
includedAccountTarget accountTargetContent Usuários direcionados na simulação.
payload Carga Carga associada à simulação.
status simulationStatus Status da simulação de ataque e da campanha de treinamento. Oferece suporte para $filter e $orderby. Os valores possíveis são: unknown, draft, running, scheduled, succeeded, failed, cancelled, excluded, unknownFutureValue.

Resposta

Se for bem-sucedido, esse método retornará um 202 Accepted código de resposta e um cabeçalho de rastreamento nomeado location na resposta.

Exemplos

Exemplo 1: atualizar uma campanha de simulação de ataque

O exemplo a seguir mostra como atualizar uma campanha de simulação de ataque para um locatário.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 202 Accepted

Exemplo 2: atualizar uma campanha de simulação de ataque do rascunho para o agendado

O exemplo a seguir mostra como agendar uma campanha de simulação de ataque. A solicitação de simulação é validada ao agendar uma simulação. Todos os parâmetros necessários precisam ser propagados nessa solicitação.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 202 Accepted

Exemplo 3: cancelar uma campanha de simulação de ataque

O exemplo a seguir mostra como cancelar uma campanha de simulação de ataque para um locatário. Você pode cancelar uma simulação quando o estado é scheduled ou running.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 202 Accepted

Exemplo 4: excluir uma campanha de simulação de ataque

O exemplo a seguir mostra como excluir uma campanha de simulação de ataque para um locatário. Você só pode excluir uma simulação de qualquer relatório quando seu estado for cancelled.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 202 Accepted