Partilhar via


Criar treinamentoCampaign

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.

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

Solicitação HTTP

POST /security/attackSimulation/trainingCampaigns

Cabeçalhos de solicitação

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

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON do objeto trainingCampaign .

Você pode especificar as propriedades a seguir ao criar um trainingCampaign.

Propriedade Tipo Descrição
createdBy emailIdentity A identidade do usuário que criou a campanha de treinamento. Opcional.
createdDateTime DateTimeOffset A data e a hora em que a campanha de treinamento foi criada. Opcional.
description Cadeia de caracteres A descrição da campanha de treinamento. Opcional.
displayName Cadeia de caracteres O nome de exibição da campanha de treinamento. Obrigatório.
endUserNotificationSetting endUserNotificationSetting Detalhes sobre a configuração de notificação do usuário final. Obrigatório.
excludeedAccountTarget accountTargetContent Os usuários excluídos da campanha de treinamento. Opcional.
includedAccountTarget accountTargetContent Os usuários que são alvo na campanha de treinamento. Obrigatório.
lastModifiedDateTime DateTimeOffset A identidade do usuário que mais recentemente modificou a campanha de treinamento. Opcional.
trainingSetting trainingSetting Detalhes sobre as configurações de treinamento para uma campanha de treinamento. Obrigatório.
campaignSchedule campaignSchedule Detalhes sobre a agenda e o status atual para uma campanha de treinamento. Obrigatório.

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

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns
Content-Type: application/json

{
    "displayName": "Graph Training Campaign",
    "description": "Graph Training Campaign Description",
    "createdBy": {
        "email": "john@contoso.com"
    },
    "lastModifiedBy": {
        "email": "john@contoso.com"
    },
    "includedAccountTarget": {
        "type": "addressBook",
        "accountTargetEmails": [
            "john@contoso.com"
        ]
    },
    "endUserNotificationSetting": {
        "notificationPreference": "microsoft",
        "settingType": "trainingSelected",
        "trainingReminder": {
            "deliveryFrequency": "weekly",
            "endUserNotification@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/endUserNotifications('fe521249-9901-4584-a987-026a9980c58e')",
            "defaultLanguage": "en"
        },
        "trainingAssignment": {
            "endUserNotification@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/endUserNotifications('36fb4dc1-7c37-4b96-9096-12e6d6014fae')",
            "defaultLanguage": "en"
        }
    },
    "trainingSetting": {
        "settingType": "microsoftCustom",
        "trainingAssignmentMappings": [
            {
                "assignedTo": [
                    "allUsers"
                ],
                "training@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/trainings('40454905-dc26-4f36-b854-3042a5362cb3')"
            },
            {
                "assignedTo": [
                    "allUsers"
                ],
                "training@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/trainings('ea70ae06-3859-4818-be9d-270ee81d80a4')"
            },
            {
                "assignedTo": [
                    "allUsers"
                ],
                "training@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/trainings('d733d88c-1b5a-48e3-a588-9910e41ac21d')"
            }
        ]
    },
    "campaignSchedule": {
        "launchDateTime": "2024-02-15T07:59:44Z",
        "completionDateTime": "2024-02-18T07:59:44Z",
        "status": "Scheduled"
    }
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 202 Accepted