Simulação de atualização

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Atualize uma campanha de simulação de ataque para um locatário. Só é possível atualizar simulações que estão no draft status.

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

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

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos 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 com privilégios mais elevados
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 a serem 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 nas alterações de 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 simulação de ataque e campanha de treinamento. Oferece suporte para $filter e $orderby. Os valores possíveis são: unknown, credentialHarvesting, attachmentMalware, driveByUrllinkInAttachment, linkToMalwareFile, , unknownFutureValue, , oAuthConsentGrant, . phishTraining Use o Prefer: include-unknown-enum-members cabeçalho da solicitação para obter os seguintes valores dessa enumeração evolutiva: oAuthConsentGrant, phishTraining. Para obter mais informações sobre os tipos de técnicas de ataque de engenharia social, consulte Simulações.
attackType simulationAttackType Tipo de ataque da campanha de simulação e treinamento de ataque. 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.
excludedAccountTarget accountTargetContent Usuários excluídos da simulação.
includedAccountTarget accountTargetContent Usuários direcionados na simulação.
payload carga útil Carga associada à simulação. Obrigatório.
status simulationStatus Status da simulação de ataque e da campanha de treinamento. Os valores possíveis são: unknown, draft, running, scheduledsucceeded, failed, , cancelled, , excluded, . unknownFutureValue

Resposta

Esse método retorna um 202 Accepted código de resposta e um cabeçalho de acompanhamento nomeado location na resposta que você deve sondar para determinar o resultado da operação.

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/beta/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/beta/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 de rascunho para agendada

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/beta/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/beta/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 seu estado for ou scheduledrunning.

Solicitação

O exemplo a seguir mostra uma solicitação.

PATCH https://graph.microsoft.com/beta/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/beta/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