Partilhar via

Obter treinamentoCampaign

  • Artigo

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.

Leia as propriedades e as relações de um objeto trainingCampaign .

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.Read.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application AttackSimulation.Read.All Indisponível.

Solicitação HTTP

GET /security/attackSimulation/trainingCampaigns/{trainingCampaignId}

Parâmetros de consulta opcionais

Este método dá suporte a alguns parâmetros de consulta OData para ajudar a personalizar a resposta. Para obter informações gerais, acesse Parâmetros de consulta OData.

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se for bem-sucedido, esse método retornará um 200 OK código de resposta e um objeto trainingCampaign no corpo da resposta.

Exemplos

Exemplo 1: Obter uma campanha de treinamento

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

Solicitação

GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": "81c59451-2929-5b39-86f0-5a2b15f1314f",
    "displayName": "graph toc update 2",
    "description": "Graph Test",
    "createdDateTime": "2024-02-18T08:36:07.6534871Z",
    "lastModifiedDateTime": "2024-02-19T08:00:01.9417887Z",
    "endUserNotificationSetting": null,
    "includedAccountTarget": null,
    "excludedAccountTarget": null,
    "trainingSetting": null,
    "report": null,
    "campaignSchedule": {
        "launchDateTime": "2024-02-18T08:37:44Z",
        "completionDateTime": "2024-02-19T07:59:44Z",
        "status": "completed"
    },
    "createdBy": {
        "email": "attacksim@a830edad9050849EQTPWBJZXODQ.onmicrosoft.com",
        "id": "478a22cd-aecc-41df-b995-88c8de17aaf5",
        "displayName": "attacksim"
    },
    "lastModifiedBy": {
        "email": "attacksim@a830edad9050849EQTPWBJZXODQ.onmicrosoft.com",
        "id": "478a22cd-aecc-41df-b995-88c8de17aaf5",
        "displayName": "attacksim"
    }
}

Exemplo 2: Obter destinos de conta incluídos

O exemplo a seguir mostra como obter destinos de conta incluídos (usuários) para uma campanha de treinamento para um locatário.

Solicitação

GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a/includedAccountTarget

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.addressBookAccountTargetContent",
  "type": "addressBook",
  "accountTargetEmails": [
    "john@contoso.com"
  ]
}

Exemplo 3: Obter destinos de conta excluídos

O exemplo a seguir mostra como obter os destinos da conta excluída (usuários) para uma campanha de treinamento para um locatário.

Solicitação

GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a/excludedAccountTarget

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.addressBookAccountTargetContent",
  "type": "addressBook",
  "accountTargetEmails": [
    "alie@contoso.com"
  ]
}

Exemplo 4: Obter configuração de treinamento

O exemplo a seguir mostra como obter detalhes da configuração de treinamento para uma campanha de treinamento.

Solicitação

GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a/trainingSetting

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "trainingCompletionDuration": "0",
  "completionDateTime": "2024-02-19T07:59:44Z",
  "settingType": "microsoftManaged"
}

Exemplo 5: Obter configuração de notificação do usuário final

O exemplo a seguir mostra como obter detalhes da configuração de notificação do usuário final para uma campanha de treinamento.

Solicitação

GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a/endUserNotificationSetting

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "settingType": "trainingSelected",
  "positiveReinforcement": null,
  "notificationPreference": "microsoft",
  "trainingAssignment" : {
    "deliveryFrequency": "unknown",
    "defaultLanguage": "en",
    "endUserNotification": {
        "id": "36fb4dc1-7c37-4b96-9096-12e6d6014fae",
        "displayName": "Microsoft default training only campaign-training assignment notification"
    }
  },
    "trainingReminder" : {
    "deliveryFrequency": "weekly",
    "defaultLanguage": "en",
    "endUserNotification": {
        "id": "fe521249-9901-4584-a987-026a9980c58e",
        "displayName": "Microsoft default training only campaign-training reminder notification"
      }
  }
}