Integrar o Microsoft Graph Mail ao Google SecOps

Este documento explica como integrar o Microsoft Graph Mail ao Google Security Operations (Google SecOps).

Antes de começar

Antes de configurar a integração delegada do Microsoft Graph Mail no Google SecOps, siga estas etapas:

  1. Crie o aplicativo do Microsoft Entra.

  2. Configure as permissões da API para seu aplicativo.

  3. Crie uma chave secreta do cliente.

Criar o aplicativo do Microsoft Entra

Para criar o app do Microsoft Entra, siga estas etapas:

  1. Faça login no portal do Azure como administrador de usuários ou de senhas.

  2. Selecione Microsoft Entra ID.

  3. Acesse Registros de apps > Novo registro.

  4. Digite o nome do aplicativo.

  5. Clique em Registrar.

    Este documento oferece um exemplo que usa uma configuração de locatário único. O fluxo do OAuth (credenciais do cliente) compatível com a integração não exige o URL de redirecionamento.

  6. Salve os valores de ID do aplicativo (cliente) e ID do diretório (locatário) para configurar os parâmetros de integração.

Configurar permissões da API

Para configurar as permissões de API da integração, siga estas etapas:

  1. No portal do Azure, acesse Permissões da API > Adicionar uma permissão.

  2. Selecione Microsoft Graph > Permissões do aplicativo.

  3. Na seção Selecionar permissões, escolha as seguintes permissões obrigatórias:

    • Mail.Read
    • Mail.ReadWrite
    • Mail.Send
    • User.Read
    • Directory.Read.All

  4. Clique em Adicionar permissões

  5. Clique em Conceder consentimento de administrador para ORGANIZATION_NAME.

    Quando a caixa de diálogo Confirmação de concessão de consentimento de administrador aparecer, clique em Sim.

Limitar o acesso do aplicativo a caixas de correio específicas

Por padrão, os aplicativos com permissões de Mail.ReadWrite ou Mail.Send têm acesso a todas as caixas de correio da organização. Para restringir o acesso do aplicativo a caixas de e-mail específicas, configure as Políticas de acesso a aplicativos no Microsoft Exchange Online.

Para configurar as Políticas de acesso a aplicativos, siga estas etapas:

  1. Conecte-se ao PowerShell do Exchange Online:

    1. Abra o PowerShell como administrador.

    2. Instale o módulo de gerenciamento do Exchange Online (se ainda não estiver instalado):

      Install-Module -Name ExchangeOnlineManagement

    3. Conecte-se ao Exchange Online:

      Connect-ExchangeOnline

  2. Identifique o ID do aplicativo e as caixas de correio de destino:

    1. Extraia o ID do cliente (ID do aplicativo) do aplicativo de e-mail do Microsoft Graph no Azure AD.

    2. Identifique os endereços de e-mail das caixas de correio que você quer que o aplicativo acesse. Para facilitar o gerenciamento, crie um grupo de segurança habilitado para e-mail no Azure AD e adicione essas caixas de correio como membros.

  3. Crie uma política de acesso ao aplicativo:

    1. Use o cmdlet New-ApplicationAccessPolicy para criar uma política que restringe o acesso a caixas de correio selecionadas.

    2. Opcional: restrinja o acesso a um grupo de segurança específico de caixas de correio:

      1. Substitua <Your_Application_ID> pelo ID do cliente do seu aplicativo.

      2. Substitua <Security_Group_Email_Address> pelo endereço de e-mail do grupo de segurança que contém as caixas de correio permitidas.

      New-ApplicationAccessPolicy -AppId "<Your_Application_ID>" -PolicyScopeGroupId "<Security_Group_Email_Address>" -AccessRight RestrictAccess -Description "SOAR Graph Mail Access Policy"

  4. Verifique a eficácia da política usando o cmdlet Test-ApplicationAccessPolicy:

       Test-ApplicationAccessPolicy -AppId "<Your_Application_ID>" -Identity "user_email_to_test@yourdomain.com"

    Esse comando indica se o aplicativo tem acesso à caixa de correio especificada com base nas políticas aplicadas.

Observação:

  • As permissões OrganizationManagement ou Security Administrator no Exchange Online são necessárias para criar essas políticas.

  • As mudanças na política geralmente entram em vigor em até 30 minutos.

  • Depois de aplicar a política, o aplicativo só poderá acessar as caixas de correio permitidas. As tentativas de acessar outros vão retornar um erro Access Denied.

Criar uma chave secreta do cliente

Para criar uma chave secreta do cliente, siga estas etapas:

  1. Acesse Certificados e chaves secretas > Nova chave secreta do cliente.

  2. Descreva uma chave secreta do cliente e defina o prazo de validade dela.

  3. Clique em Adicionar.

  4. Salve o valor da chave secreta do cliente (não o ID da chave secreta) para usá-lo como o valor do parâmetro ID da chave secreta ao configurar a integração. O valor da chave secreta do cliente é mostrado apenas uma vez.

Parâmetros de integração

A integração do Microsoft Graph Mail exige os seguintes parâmetros:
Parâmetro Descrição
Azure AD Endpoint

Obrigatório.

O endpoint do Microsoft Entra ID a ser usado na integração.

O valor pode ser diferente para tipos de locatário diferentes.

O valor padrão é https://login.microsoftonline.com.
Microsoft Graph Endpoint

Obrigatório.

O endpoint do Microsoft Graph a ser usado na integração.

O valor pode ser diferente para tipos de locatário diferentes.

O valor padrão é https://graph.microsoft.com.
Client ID

Obrigatório.

O ID do cliente (aplicativo) do aplicativo Microsoft Entra a ser usado na integração.
Secret ID

Obrigatório.

O valor da chave secreta do cliente do aplicativo Microsoft Entra a ser usado na integração.
Tenant

Obrigatório.

O valor do Microsoft Entra ID (ID do locatário).
Default Mailbox

Obrigatório.

A caixa de correio a ser usada na integração.
Mail Field Source

Opcional.

Se selecionada, a integração vai recuperar o endereço da caixa de correio do atributo mail dos detalhes do usuário. Se não estiver selecionada, a integração vai recuperar o endereço da caixa de correio do campo userPrincipalName.

Não selecionada por padrão.
Verify SSL

Obrigatório.

Se selecionada, a integração valida o certificado SSL ao se conectar ao Microsoft Graph.

Essa opção é selecionada por padrão.
Base64 Encoded Private Key

Opcional.

Especifique uma chave privada codificada em base64 que será usada para descriptografar o e-mail.
Base64 Encoded Certificate

Opcional.

Especifique um certificado codificado em base64 que será usado para descriptografar o e-mail.
Base64 Encoded CA certificate

Opcional.

Especifique um certificado de CA confiável codificado em base64 para verificação de assinatura.

Para instruções sobre como configurar uma integração no Google SecOps, consulte Configurar integrações.

É possível fazer mudanças mais tarde, se necessário. Depois de configurar uma instância de integração, você pode usá-la em playbooks. Para mais informações sobre como configurar e oferecer suporte a várias instâncias, consulte Suporte a várias instâncias.

Ações

Antes de configurar ações, conceda as permissões necessárias para a integração. Para mais detalhes, consulte a seção Configurar permissões da API deste documento.

Excluir e-mails

Use a ação Excluir e-mail para excluir uma ou mais mensagens de uma caixa de correio. Essa ação exclui e-mails com base nos seus critérios de pesquisa. Com as permissões adequadas, a ação Excluir e-mail pode mover e-mails para caixas de correio diferentes.

Essa ação é assíncrona. Ajuste o tempo limite da ação no ambiente de desenvolvimento integrado (IDE) do Google SecOps conforme necessário.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

A ação Excluir e-mail exige os seguintes parâmetros:

Parâmetro Descrição
Delete In Mailbox

Obrigatório.

A caixa de correio padrão em que a operação de exclusão será executada. Se as permissões permitirem, a ação também poderá pesquisar em outras caixas de correio. Esse parâmetro aceita vários valores como uma string separada por vírgulas.
Folder Name

Obrigatório.

Uma pasta da caixa de e-mails para pesquisar e-mails. Para especificar uma subpasta, use a barra /, como Inbox/Subfolder.
Mail IDs

Opcional.

Uma condição de filtro para pesquisar e-mails com IDs específicos.

Esse parâmetro aceita uma lista separada por vírgulas de IDs de e-mail para pesquisar.

Se esse parâmetro for fornecido, a pesquisa vai ignorar os parâmetros Subject Filter e Sender Filter.
Subject Filter

Opcional.

Uma condição de filtro que especifica o assunto do e-mail a ser pesquisado.
Sender Filter

Opcional.

Uma condição de filtro que especifica o remetente dos e-mails solicitados.
Timeframe (Minutes)

Opcional.

Uma condição de filtro que especifica o período em minutos para pesquisar e-mails.
Only Unread

Opcional.

Se selecionada, a ação pesquisa apenas e-mails não lidos.

Não selecionada por padrão.
How many mailboxes to process in a single batch

Opcional.

O número de caixas de correio a serem processadas em um único lote (uma única conexão com o servidor de e-mail).

O valor padrão é 25.

Saídas de ação

A tabela a seguir descreve os tipos de saída associados à ação Excluir e-mail:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Indisponível
Mensagens de saída Disponível
Resultado do script Disponível
Mensagens de saída

A ação Excluir e-mail fornece as seguintes mensagens de saída:

Mensagem de resposta Descrição da mensagem

Successfully deleted emails in the following mailboxes: MAILBOX_NAME: DELETED_EMAILS_NUMBER

Mailbox MAILBOX was not found.

 A ação foi concluída.

Action was not able to find any emails based on the specified search criteria.

Action failed to delete any emails because the provided mailbox folder name was not found in the mailbox(es): MAILBOX_NAME, MAILBOX_FOLDER

Failed to find any of the provided mailboxes: MAILBOX_LIST

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a conexão com o servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela a seguir descreve os valores da saída do resultado do script ao usar a ação Excluir e-mail:

Nome do resultado do script Valor
is_success True ou False

Baixar anexos de e-mail

Use a ação Fazer o download de anexos de e-mail para baixar anexos de e-mails com base nos critérios fornecidos.

Essa ação não é executada em entidades do Google SecOps.

Essa ação é assíncrona. Se necessário, ajuste o valor de tempo limite do script no IDE do Google SecOps.

A ação substitui o caractere de sublinhado \` forward slash or/backslash characters in the names of the downloaded attachments with the_`.

Entradas de ação

A ação Baixar anexos do e-mail exige os seguintes parâmetros:

Parâmetro Descrição
Search In Mailbox

Obrigatório.

A caixa de correio padrão em que a operação de pesquisa é executada. Se as permissões permitirem, a ação também poderá pesquisar em outras caixas de correio. Esse parâmetro aceita vários valores como uma string separada por vírgulas.
Folder Name

Obrigatório.

Uma pasta de caixa de e-mails em que a pesquisa será executada. Para especificar uma subpasta, use a barra /, como Inbox/Subfolder.
Download Destination

Obrigatório.

Um tipo de armazenamento para salvar os anexos baixados.

Por padrão, a ação tenta salvar o anexo no bucket do Cloud Storage. Salvar um anexo no sistema de arquivos local é uma opção alternativa.

Os valores possíveis são GCP Bucket e Local File System. O valor padrão é GCP Bucket.
Download Path

Obrigatório.

Um caminho para fazer o download de anexos.

Ao salvar anexos no bucket do Cloud Storage ou em um sistema de arquivos local, a ação espera que você especifique o caminho de download no formato semelhante ao Unix, como /tmp/test.
Mail IDs

Opcional.

Uma condição de filtro para pesquisar e-mails com IDs específicos.

Esse parâmetro aceita uma lista separada por vírgulas de IDs de e-mail para pesquisar.

Se esse parâmetro for fornecido, a pesquisa vai ignorar os parâmetros Subject Filter e Sender Filter.
Subject Filter

Opcional.

Uma condição de filtro que especifica o assunto do e-mail a ser pesquisado.

Esse filtro usa a lógica contains.
Sender Filter

Opcional.

Uma condição de filtro que especifica o remetente dos e-mails solicitados.

Esse filtro usa a lógica equals.
Download Attachments From EML

Opcional.

Se selecionada, a ação baixa anexos de arquivos EML.

Não selecionada por padrão.
Download attachments to unique path?

Opcional.

Se selecionada, a ação baixa anexos para o caminho exclusivo fornecido no campo de parâmetro Download Path para evitar a substituição de anexos baixados anteriormente.

Não selecionada por padrão.
How many mailboxes to process in a single batch

Opcional.

O número de caixas de correio a serem processadas em um único lote (uma única conexão com o servidor de e-mail).

O valor padrão é 25.

Saídas de ação

A ação Baixar anexos do e-mail fornece as seguintes saídas:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo a seguir descreve a saída de resultado JSON recebida ao usar a ação Baixar anexos do e-mail:

[
    {
        "attachment_name": "name1.png",
        "downloaded_path": "file_path/name1.png"
    },
    {
        "attachment_name": "name2.png",
        "downloaded_path": "file_path/name2.png"
    }
]
Mensagens de saída

A ação Fazer o download de anexos do e-mail fornece as seguintes mensagens de saída:

Mensagem de resposta Descrição da mensagem

Downloaded NUMBER_OF_ATTACHMENTS attachments. Files: PATHS.

Failed to find emails in MAILBOX with the following mail ids: EMAIL_IDS.

In the mailboxes listed below, emails were found, but there were no attachments to download. Affected mailboxes: MAILBOXES. Mail IDs without attachments to download: LIST_OF_EMAIL_IDS attachments.

 A ação foi concluída.

Failed to find any emails using the provided criteria!

Failed to find any of the provided mailboxes: MAILBOXES

Action failed to run because the provided mailbox folder name FOLDER_NAME was not found in the mailbox MAILBOX.

Error executing action. Reason: ERROR_REASON

Falha na ação.

Verifique a conexão com o servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela a seguir descreve os valores da saída do resultado do script ao usar a ação Baixar anexos de e-mail:

Nome do resultado do script Valor
is_success True ou False

Extrair dados de um EML anexado

Use a ação Extrair dados do EML anexado para recuperar dados dos anexos de e-mail EML e retorná-los nos resultados da ação. Essa ação é compatível com os formatos de arquivo .eml, .msg e .ics.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

A ação Extrair dados do EML anexado exige os seguintes parâmetros:

Parâmetro Descrição
Search In Mailbox

Obrigatório.

A caixa de correio padrão em que a operação de pesquisa é executada. Se as permissões permitirem, a ação também poderá pesquisar em outras caixas de correio. Esse parâmetro aceita vários valores como uma string separada por vírgulas.
Folder Name

Opcional.

Uma pasta de caixa de e-mails em que a pesquisa será executada. Para especificar uma subpasta, use a barra /, como Inbox/Subfolder.
Mail IDs

Obrigatório.

Uma condição de filtro para pesquisar e-mails com IDs específicos.

Esse parâmetro aceita uma lista separada por vírgulas de IDs de e-mail para pesquisar.
Regex Map JSON

Opcional.

Uma definição JSON que contém expressões regulares para aplicar ao arquivo de e-mail anexado e gerar valores de chave adicionais no resultado JSON da ação. O exemplo desse valor de parâmetro é o seguinte:

{ips: \\b\\\\d{1,3}\\\\.\\\\d{1,3}\\\\.\\\\d{1,3}\\\\.\\\\d{1,3}\\b}

Saídas de ação

A ação Extrair dados do EML anexado fornece as seguintes saídas:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo a seguir descreve a saída do resultado JSON recebida ao usar a ação Extrair dados do EML anexado:

[
    {
        "type": "EML",
        "subject": "examplesubject",
        "from": "sender@example.com",
        "to": "user1@example.com,user2@example.com",
        "date": "Thu,4Jul202412:11:29+0530",
        "text": "text",
        "html": "<p>example-html</p>",
        "regex": {},
        "regex_from_text_part": {},
        "id": "ID",
        "name": "example.eml"
    },
    {
        "type": "MSG",
        "subject": "examplesubject",
        "from": "user@example.com",
        "to": "user1@example.com,user2@example.com",
        "date": "Thu,4Jul202412:11:29+0530",
        "text": "text",
        "html": "<p>examplehtml</p>",
        "regex": {},
        "regex_from_text_part": {},
        "id": "ID",
        "name": "example.msg"
    },
    {
        "type": "ICS",
        "subject": "examplesubject",
        "from": "sender@example.com",
        "to": "user1@example.com,user2@example.com",
        "date": "Thu,4Jul202412:11:29+0530",
        "text": "text",
        "html": "<p>example-html</p>",
        "regex": {},
        "regex_from_text_part": {},
        "id": "ID",
        "name": "example.ics"
    }
]
Mensagens de saída

A ação Extrair dados do EML anexado fornece as seguintes mensagens de saída:

Mensagem de resposta Descrição da mensagem

Extracted data from ATTACHMENT_NAMES attached email files. Files: PATHS

Failed to find emails in MAILBOX with the following mail ids: MAIL_ID_LIST

 A ação foi concluída.

Failed to find any emails using the provided criteria!

Failed to find any of the provided mailboxes: MAILBOX_LIST

Action failed to run because the provided mailbox folder name MAILBOX_FOLDER was not found in the mailbox MAILBOX

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a conexão com o servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela a seguir descreve os valores da saída do resultado do script ao usar a ação Extrair dados do EML anexado:

Nome do resultado do script Valor
is_success True ou False

Encaminhar e-mail

Use a ação Encaminhar e-mail para encaminhar e-mails que incluem conversas anteriores. Com as permissões adequadas, essa ação pode enviar e-mails de uma caixa de correio diferente da especificada na configuração da integração.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

A ação Encaminhar e-mail exige os seguintes parâmetros:

Parâmetro Descrição
Send From

Obrigatório.

Um endereço de e-mail opcional de onde enviar um e-mail, se as permissões permitirem.

Por padrão, o e-mail é enviado da caixa de correio padrão especificada na configuração da integração.
Folder Name

Opcional.

Uma pasta da caixa de e-mails para pesquisar mensagens. Para especificar uma subpasta, use a barra /, como Inbox/Subfolder.
Mail ID

Obrigatório.

O ID do e-mail a ser encaminhado.
Subject

Obrigatório.

O assunto do e-mail.
Send to

Obrigatório.

Uma lista separada por vírgulas de endereços de e-mail dos destinatários, como user1@example.com, user2@example.com.
CC

Opcional.

Uma lista de endereços de e-mail separados por vírgula para o campo "Cc" do e-mail.

O formato é o mesmo do parâmetro Send to.
BCC

Opcional.

Uma lista de endereços de e-mail separados por vírgula para o campo CCO do e-mail.

O formato é o mesmo do parâmetro Send to.
Attachments Paths

Opcional.

Uma lista separada por vírgulas de caminhos para anexos de arquivos armazenados no servidor, como /FILE_DIRECTORY/file.pdf, /FILE_DIRECTORY/image.jpg.
Mail content

Obrigatório.

O corpo do e-mail.

Saídas de ação

A tabela a seguir descreve os tipos de saída associados à ação Encaminhar e-mail:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Indisponível
Mensagens de saída Disponível
Resultado do script Disponível
Mensagens de saída

A ação Encaminhar e-mail fornece as seguintes mensagens de saída:

Mensagem de resposta Descrição da mensagem
Email with message ID MAIL_ID was forwarded successfully. A ação foi concluída.

Error executing action "Forward Email" because the provided mail id EMAIL_ID was not found.

Action failed to delete any emails because the provided mailbox folder name was not found in the mailbox(es): MAILBOX: MAILBOX_FOLDER

Action failed to run because specified attachments were not found: ATTACHMENTS_LIST

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a conexão com o servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela a seguir descreve os valores da saída do resultado do script ao usar a ação Encaminhar e-mail:

Nome do resultado do script Valor
is_success True ou False

Get Mailbox Account Out Of Facility Settings

Use a ação Get Mailbox Account Out Of Facility Settings para recuperar as configurações de ausência do trabalho (OOF) da conta de caixa de correio da entidade User do Google SecOps fornecida.

A ação Get Mailbox Account Out Of Facility Settings usa a versão Beta da API Microsoft Graph.

Essa ação é executada na entidade User do Google SecOps.

Entradas de ação

Nenhuma.

Saídas de ação

A ação Get Mailbox Account Out Of Facility Settings fornece as seguintes saídas:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo a seguir mostra a saída do resultado JSON recebida ao usar a ação Get Mailbox Account Out Of Facility Settings:

{
   "@odata.context": "https://graph.microsoft.com/beta/$metadata#communications/presences/$entity",
   "id": "ID",
   "availability": "Offline",
   "activity": "Offline",
   "statusMessage": null,
   "outOfOfficeSettings": {
       "message": "\n\nOut Of Facility111\n",
       "isOutOfOffice": true
   }
}
Mensagens de saída

A ação Get Mailbox Account Out Of Facility Settings pode retornar as seguintes mensagens de saída:

Mensagem de resposta Descrição da mensagem

Successfully returned OOF settings for ENTITY_ID.

Failed to find the following usernames in Office 365 service: USERNAME_LIST.

 A ação foi concluída.

Error executing action "Add Identity Protection Detection Comment". Reason: ERROR_REASON

Action wasn't able to find OOF settings for ENTITY_ID.

A ação falhou.

Verifique a conexão com o servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela a seguir lista o valor da saída do resultado do script ao usar a ação Get Mailbox Account Out Of Facility Settings:

Nome do resultado do script Valor
is_success True ou False

Marcar e-mail como lixo eletrônico

Use a ação Marcar e-mail como lixo eletrônico para marcar e-mails como lixo eletrônico em uma caixa de correio especificada. Essa ação adiciona o remetente do e-mail à lista de remetentes bloqueados e move a mensagem para a pasta Lixo eletrônico.

A ação Marcar e-mail como lixo eletrônico usa a versão Beta da API Microsoft Graph.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

A ação Marcar e-mail como lixo eletrônico exige os seguintes parâmetros:

Parâmetro Descrição
Search In Mailbox

Obrigatório.

Uma caixa de correio em que pesquisar e-mails.

Por padrão, a ação tenta pesquisar o e-mail na caixa de correio padrão especificada na configuração de integração. Para executar uma pesquisa em outras caixas de correio, configure as permissões adequadas para a ação.

Esse parâmetro aceita vários valores como uma string separada por vírgulas.
Folder Name

Obrigatório.

Uma pasta de caixa de e-mails em que pesquisar e-mails. Para especificar uma subpasta, use a barra /, como Inbox/Subfolder.

O valor padrão é Inbox.
Mail IDs

Obrigatório.

Os IDs ou valores internetMessageId dos e-mails a serem marcados como lixo eletrônico.

Esse parâmetro aceita vários valores como uma string separada por vírgulas.

Saídas de ação

A ação Marcar e-mail como lixo eletrônico oferece as seguintes saídas:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Indisponível
Mensagens de saída Disponível
Resultado do script Disponível
Mensagens de saída

A ação Marcar e-mail como lixo eletrônico pode retornar as seguintes mensagens de saída:

Mensagem de resposta Descrição da mensagem

Successfully marked the email as junk.

Failed to find email with ID ID in MAILBOX.

Mailbox MAILBOX was not found.

 A ação foi concluída.

Error executing action "Mark Email as Junk". Reason: ERROR_REASON

Failed to find any emails based on provided parameters!

Action failed to run because the provided mailbox folder name MAILBOX_FOLDER was not found in the mailbox MAILBOX.

A ação falhou.

Verifique a conexão com o servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela a seguir lista o valor da saída do resultado do script quando você usa a ação Marcar e-mail como lixo eletrônico:

Nome do resultado do script Valor
is_success True ou False

Marcar e-mail como "Não é lixo eletrônico"

Use a ação Marcar e-mail como não sendo lixo eletrônico para marcar e-mails como não sendo lixo eletrônico em uma caixa de correio específica. Essa ação remove o remetente da lista de remetentes bloqueados e move a mensagem para a pasta Caixa de entrada.

A ação Marcar e-mail como não sendo lixo eletrônico usa a versão Beta da API Microsoft Graph.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

A ação Marcar e-mail como não sendo lixo eletrônico exige os seguintes parâmetros:

Parâmetro Descrição
Search In Mailbox

Obrigatório.

Uma caixa de correio em que pesquisar um e-mail.

Por padrão, a ação tenta pesquisar o e-mail na caixa de correio padrão especificada na configuração de integração. Para executar uma pesquisa em outras caixas de correio, configure as permissões adequadas para a ação.

Esse parâmetro aceita vários valores como uma string separada por vírgulas.
Folder Name

Obrigatório.

Uma pasta de caixa de e-mails em que pesquisar e-mails. Para especificar uma subpasta, use a barra /, como Inbox/Subfolder.
Mail IDs

Obrigatório.

Os IDs ou valores internetMessageId dos e-mails a serem marcados como lixo eletrônico.

Esse parâmetro aceita vários valores como uma string separada por vírgulas.

Saídas de ação

A ação Marcar e-mail como não sendo lixo eletrônico fornece as seguintes saídas:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Indisponível
Mensagens de saída Disponível
Resultado do script Disponível
Mensagens de saída

A ação Marcar e-mail como não sendo lixo eletrônico pode retornar as seguintes mensagens de saída:

Mensagem de resposta Descrição da mensagem

Successfully marked the email as not junk.

Failed to find email with ID ID in MAILBOX.

Mailbox MAILBOX was not found.

 A ação foi concluída.

Error executing action "Mark Email as Not Junk". Reason: ERROR_REASON

Failed to find any emails based on provided parameters!

Action failed to run because the provided mailbox folder name MAILBOX_FOLDER was not found in the mailbox MAILBOX.

A ação falhou.

Verifique a conexão com o servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela a seguir lista o valor da saída do resultado do script quando você usa a ação Marcar e-mail como não sendo lixo eletrônico:

Nome do resultado do script Valor
is_success True ou False

Mover e-mail para pasta

Use a ação Mover e-mail para pasta para mover um ou vários e-mails da pasta de e-mail de origem para outra pasta na caixa de correio. Com as permissões adequadas, essa ação pode mover e-mails para outras caixas de correio diferentes da fornecida na configuração de integração.

Essa ação é assíncrona. Ajuste o tempo limite da ação no ambiente de desenvolvimento integrado (IDE) do Google SecOps conforme necessário.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

Para configurar a ação Mover e-mail para pasta, use os seguintes parâmetros:

Parâmetro Descrição
Move In Mailbox

Obrigatório.

A caixa de correio padrão em que a operação de movimentação é executada. Se as permissões permitirem, a ação também poderá pesquisar em outras caixas de correio. Esse parâmetro aceita vários valores como uma string separada por vírgulas.

Source Folder Name

Obrigatório.

Uma pasta de origem de onde mover o e-mail. Para especificar uma subpasta, use a barra /, como Inbox/Subfolder.
Destination Folder Name

Obrigatório.

Uma pasta de destino para mover o e-mail.

Forneça o valor do parâmetro no seguinte formato: Inbox/folder_name/subfolder_name. Esse parâmetro não diferencia maiúsculas de minúsculas.
Mail IDs

Opcional.

Uma condição de filtro para pesquisar e-mails com IDs específicos.

Esse parâmetro aceita uma lista separada por vírgulas de IDs de e-mail para pesquisar.

Se esse parâmetro for fornecido, a pesquisa vai ignorar os parâmetros Subject Filter e Sender Filter.
Subject Filter

Opcional.

Uma condição de filtro que especifica o assunto do e-mail a ser pesquisado.

Esse filtro usa a lógica contains.
Sender Filter

Opcional.

Uma condição de filtro que especifica o remetente dos e-mails solicitados.

Esse filtro usa a lógica equals.
Timeframe (Minutes)

Opcional.

Uma condição de filtro que especifica o período, em minutos, para pesquisar e-mails.
Only Unread

Opcional.

Se selecionada, a ação pesquisa apenas e-mails não lidos.

Não selecionada por padrão.
How many mailboxes to process in a single batch

Opcional.

O número de caixas de correio a serem processadas em um único lote (uma única conexão com o servidor de e-mail).

O valor padrão é 25.

Saídas de ação

A tabela a seguir descreve os tipos de saída associados à ação Mover e-mail para a pasta:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Indisponível
Mensagens de saída Disponível
Resultado do script Disponível
Mensagens de saída

A ação Mover e-mail para pasta fornece as seguintes mensagens de saída:

Mensagem de resposta Descrição da mensagem

Successfully moved emails in the following mailboxes: MAILBOX: MOVED_EMAILS_NUMBER

Mailbox MAILBOX was not found.

 A ação foi concluída.

Action was not able to find any emails based on the specified search criteria.

Action failed to move any emails because the provided source folder was not found in the mailbox(es): MAILBOX_NAME, MAILBOX_FOLDER

Action failed to move any emails because the provided destination folder was not found in the mailbox(es): MAILBOX_NAME, MAILBOX_FOLDER

Failed to find any of the provided mailboxes: MAILBOX_LIST

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a conexão com o servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela a seguir descreve os valores da saída do resultado do script ao usar a ação Mover e-mail para pasta:

Nome do resultado do script Valor
is_success True ou False

Ping

Use a ação Ping para testar a conectividade com o serviço de e-mail do Microsoft Graph.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

Nenhuma.

Saídas de ação

A tabela a seguir descreve os tipos de saída associados à ação Ping:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Indisponível
Mensagens de saída Disponível
Resultado do script Disponível
Mensagens de saída

A ação Ping fornece as seguintes mensagens de saída:

Mensagem de resposta Descrição da mensagem
Successfully connected to the Microsoft Graph mail service with the provided connection parameters! A ação foi concluída.
Failed to connect to the Microsoft Graph mail service! Error is ERROR_REASON

Falha na ação.

Verifique a conexão com o servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela a seguir descreve os valores da saída do resultado do script ao usar a ação Ping:

Nome do resultado do script Valor
is_success True ou False

Salvar e-mail no caso

Use a ação Salvar e-mail no caso para salvar e-mails ou anexos de e-mail no mural de casos do Google SecOps. Com as permissões adequadas, essa ação pode salvar e-mails de caixas de correio diferentes daquela fornecida na configuração de integração.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

A ação Salvar e-mail no caso exige os seguintes parâmetros:

Parâmetro Descrição
Search In Mailbox

Obrigatório.

A caixa de correio padrão em que a operação de pesquisa é executada. Se as permissões permitirem, a ação também poderá pesquisar em outras caixas de correio.
Folder Name

Opcional.

Uma pasta de caixa de e-mails em que pesquisar e-mails. Para especificar uma subpasta, use a barra /, como Inbox/Subfolder.
Mail ID

Obrigatório.

Uma lista separada por vírgulas de IDs de e-mail a serem pesquisados.

Se você usou a ação Enviar e-mail para enviar e-mails, defina o valor do parâmetro como o marcador de posição {SendEmail.JSONResult|id} ou {SendEmail.JSONResult|internetMessageId}.
Save Only Email Attachments

Opcional.

Se selecionada, a ação salva apenas os anexos do e-mail especificado.

Não selecionada por padrão.
Attachment To Save

Opcional.

Se o parâmetro Save Only Email Attachments estiver selecionado, a ação vai salvar apenas os anexos especificados por esse parâmetro.

Esse parâmetro aceita vários valores como uma string separada por vírgulas.
Base64 Encode

Opcional.

Se selecionada, a ação codifica o arquivo de e-mail no formato base64.

Não selecionada por padrão.

Saídas de ação

A tabela a seguir descreve os tipos de saída associados à ação Salvar e-mail no caso:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Disponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Anexo do Painel de Casos

Os anexos a seguir estão associados à ação Salvar e-mail no caso:

  • EMAIL_SUBJECT.eml, se a ação salvar o e-mail.

  • Se a ação salvar o anexo, o nome dele vai conter uma extensão de arquivo, se houver.

Resultado JSON

O exemplo a seguir descreve a saída do resultado JSON recebida ao usar a ação Salvar e-mail no caso:

{
    "id": "ID",
    "createdDateTime": "2024-02-16T14:10:34Z",
    "eml_info": "example_info",
    "lastModifiedDateTime": "2024-02-16T14:10:41Z",
    "changeKey": "cxsdjjh",
    "categories": [],
    "receivedDateTime": "2024-02-16T14:10:35Z",
    "sentDateTime": "2024-02-16T14:09:36Z",
    "hasAttachments": true,
    "internetMessageId": "INTERNET_MESSAGE_ID",
    "subject": "all attachments",
    "bodyPreview": "all the attachments",
    "importance": "normal",
    "parentFolderId": "PARENT_FOLDER_ID",
    "conversationId": "CONVERSATION_ID",
    "conversationIndex": "example-index",
    "isDeliveryReceiptRequested": false,
    "isReadReceiptRequested": false,
    "isRead": true,
    "isDraft": false,
    "webLink": "https://example.com/",
    "inferenceClassification": "focused",
    "body": {
        "contentType": "html",
        "content": "<html><head>example-html</head></html>"
    },
    "sender": {
        "emailAddress": {
            "name": "NAME",
            "address": "sender@example.com"
        }
    },
    "from": {
        "emailAddress": {
            "name": "NAME",
            "address": "user@example.com"
        }
    },
    "toRecipients": [
        {
            "emailAddress": {
                "name": "NAME",
                "address": "recipient@example.com"
            }
        }
    ],
    "ccRecipients": [],
    "bccRecipients": [],
    "replyTo": [],
    "flag": {
        "flagStatus": "notFlagged"
    }
}
Mensagens de saída

Em um Painel de Casos, a ação Salvar e-mail no caso fornece as seguintes mensagens de saída:

Mensagem de resposta Descrição da mensagem

Email successfully saved!

Successfully saved the following attachments: ATTACHMENTS_LIST

The following attachments were not found in email with mail id: EMAIL_ID: ATTACHMENTS_LIST

 A ação foi concluída.

Mailbox MAILBOX_NAME was not found.

Action failed to run because the provided mailbox folder name MAILBOX_FOLDER was not found in the mailbox MAILBOX_NAME

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a conexão com o servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela a seguir descreve os valores da saída do resultado do script ao usar a ação Salvar e-mail no caso:

Nome do resultado do script Valor
is_success True ou False

Pesquisar e-mails

Use a ação Pesquisar e-mails para executar a pesquisa na caixa de correio padrão com base nos critérios fornecidos. Com as permissões adequadas, essa ação pode executar uma pesquisa em outras caixas de correio.

Essa ação é assíncrona. Ajuste o tempo limite da ação no IDE do Google SecOps conforme necessário.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

A ação Pesquisar e-mails exige os seguintes parâmetros:

Parâmetro Descrição
Search In Mailbox

Obrigatório.

A caixa de correio padrão em que a operação de pesquisa é executada. Se as permissões permitirem, a ação também poderá pesquisar em outras caixas de correio. Esse parâmetro aceita vários valores como uma string separada por vírgulas.

Para pesquisas complexas em um número significativo de caixas de correio, use a integração do Exchange Extension Pack.
Folder Name

Obrigatório.

Uma pasta de caixa de e-mails para pesquisar e-mails. Para especificar uma subpasta, use a barra /, como Inbox/Subfolder.
Subject Filter

Opcional.

Uma condição de filtro que especifica o assunto do e-mail a ser pesquisado.

Esse filtro usa a lógica contains.
Sender Filter

Opcional.

Uma condição de filtro que especifica o remetente dos e-mails solicitados.

Esse filtro usa a lógica equals.
Timeframe (Minutes)

Opcional.

Uma condição de filtro que especifica o período em minutos para pesquisar e-mails.
Max Emails To Return

Opcional.

O número de e-mails que a ação vai retornar.

Se você não definir um valor, o padrão da API será usado.

O valor padrão é 10.
Only Unread

Opcional.

Se selecionada, a ação pesquisa apenas e-mails não lidos.

Não selecionada por padrão.
All Fields To Return

Opcional.

Se selecionada, a ação vai retornar todos os campos disponíveis para o e-mail obtido.

Não selecionada por padrão.
How many mailboxes to process in a single batch

Opcional.

O número de caixas de correio a serem processadas em um único lote (uma única conexão com o servidor de e-mail).

O valor padrão é 25.

Saídas de ação

A tabela a seguir descreve os tipos de saída associados à ação Pesquisar e-mails:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Disponível
Tabela de enriquecimento Indisponível
Resultado JSON Indisponível
Mensagens de saída Disponível
Resultado do script Disponível
Tabela do painel de casos

Em um quadro de casos, a ação Pesquisar e-mails fornece a seguinte tabela:

Título da tabela: Correspondências

Colunas:

  • ID do e-mail
  • Assunto
  • Remetente
  • Receptores
  • Data de recebimento
Mensagens de saída

A ação Pesquisar e-mails fornece as seguintes mensagens de saída:

Action was not able to find any emails based on the specified search criteria.

Mensagem de resposta Descrição da mensagem

Successfully found emails in the following mailboxes: MAILBOX: FOUND_EMAILS_NUMBER

Mailbox MAILBOX was not found.

 A ação foi concluída.

Failed to find any of the provided mailboxes: MAILBOX_LIST

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a conexão com o servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela a seguir descreve os valores da saída do resultado do script ao usar a ação Pesquisar e-mails:

Nome do resultado do script Valor
is_success True ou False

Enviar e-mail

Use a ação Enviar e-mail para enviar e-mails de uma caixa de e-mails específica para uma lista arbitrária de destinatários.

Essa ação pode enviar e-mails em texto simples ou formatados em HTML. Com as permissões adequadas, a ação pode enviar e-mails de uma caixa de correio diferente da especificada na configuração da integração.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

A ação Enviar e-mail exige os seguintes parâmetros:

Parâmetro Descrição
Send From

Obrigatório.

Um endereço de e-mail opcional de onde enviar e-mails, se as permissões permitirem.

Por padrão, a ação envia e-mails da caixa de correio padrão especificada na configuração da integração.
Subject

Obrigatório.

O assunto do e-mail.
Send to

Obrigatório.

Uma lista separada por vírgulas de endereços de e-mail dos destinatários, como user1@example.com, user2@example.com.
CC

Opcional.

Uma lista de endereços de e-mail separados por vírgula para o campo "Cc" do e-mail.

O formato é o mesmo do parâmetro Send to.
BCC

Opcional.

Uma lista de endereços de e-mail separados por vírgula para o campo CCO do e-mail.

O formato é o mesmo do parâmetro Send to.
Attachments Paths

Opcional.

Uma lista separada por vírgulas de caminhos para anexos de arquivos armazenados no servidor, como /FILE_DIRECTORY/file.pdf, /FILE_DIRECTORY/image.jpg.
Attachments Location

Obrigatório.

Um local onde os anexos são armazenados.

Por padrão, a ação tenta fazer upload de anexos do bucket do Cloud Storage.

Os valores possíveis são GCP Bucket ou Local File System. O valor padrão é GCP Bucket.
Mail Content Type

Opcional.

O tipo de conteúdo do e-mail.

Os valores possíveis são:

  • Text
  • HTML

O valor padrão é Text.
Mail Content

Obrigatório.

O corpo do e-mail.
Reply-To Recipients

Opcional.

Uma lista separada por vírgulas de destinatários a serem usados no cabeçalho Reply-To.

Use o cabeçalho Responder para para redirecionar e-mails de resposta ao endereço especificado em vez do endereço do remetente no campo De.

Saídas de ação

A tabela a seguir descreve os tipos de saída associados à ação Enviar e-mail:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Indisponível
Mensagens de saída Disponível
Resultado do script Disponível
Mensagens de saída

A ação Enviar e-mail fornece as seguintes mensagens de saída:

Mensagem de resposta Descrição da mensagem

Email was sent successfully.

 A ação foi concluída.

Action failed to run because specified attachments were not found: ATTACHMENTS_LIST

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a conexão com o servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela a seguir descreve os valores da saída do resultado do script ao usar a ação Enviar e-mail:

Nome do resultado do script Valor
is_success True ou False

Enviar HTML de e-mail

Use a ação Enviar e-mail HTML para enviar e-mails usando o modelo HTML do Google SecOps de uma caixa de correio específica para uma lista arbitrária de destinatários. Com as permissões adequadas, a ação pode enviar e-mails de uma caixa de correio diferente da padrão.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

A ação Enviar e-mail HTML exige os seguintes parâmetros:

Parâmetro Descrição
Send From

Obrigatório.

Um endereço de e-mail opcional de onde enviar e-mails, se as permissões permitirem.

Por padrão, a ação envia e-mails da caixa de correio padrão especificada na configuração da integração.
Subject

Obrigatório.

O assunto do e-mail.
Send to

Obrigatório.

Uma lista separada por vírgulas de endereços de e-mail dos destinatários, como user1@example.com, user2@example.com.
CC

Opcional.

Uma lista de endereços de e-mail separados por vírgula para o campo "Cc" do e-mail.

O formato é o mesmo do parâmetro Send to.
BCC

Opcional.

Uma lista de endereços de e-mail separados por vírgula para o campo CCO do e-mail.

O formato é o mesmo do parâmetro Send to.
Attachments Paths

Opcional.

Um caminho completo para o anexo a ser fornecido, como /FILE_DIRECTORY/file.pdf, /FILE_DIRECTORY/image.jpg.

É possível fornecer vários valores em uma string separada por vírgulas.
Email HTML Template

Obrigatório.

O tipo de modelo HTML a ser usado.

Os valores possíveis são Email HTML Template e Dynamically generated list of available templates.

O valor padrão é Email HTML Template.
Mail Content

Obrigatório.

O corpo do e-mail.
Reply-To Recipients

Opcional.

Uma lista separada por vírgulas de destinatários a serem usados no cabeçalho Reply-To.

Use o cabeçalho Responder a para redirecionar e-mails de resposta para o endereço de e-mail específico em vez do endereço do remetente indicado no campo De.
Attachment Location

Obrigatório.

Um local onde os anexos são armazenados.

Por padrão, a ação tenta fazer upload de anexos do bucket do Cloud Storage.

Os valores possíveis são GCP Bucket ou Local File System. O valor padrão é GCP Bucket.

Saídas de ação

A ação Enviar e-mail HTML fornece as seguintes saídas:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo a seguir descreve a saída do resultado JSON recebida ao usar a ação Enviar e-mail HTML:

{
    "createdDateTime": "2024-01-30T16:50:27Z",
    "lastModifiedDateTime": "2024-01-30T16:50:27Z",
    "changeKey": "example-key",
    "categories": [],
    "receivedDateTime": "2024-01-30T16:50:27Z",
    "sentDateTime": "2024-01-30T16:50:27Z",
    "hasAttachments": false,
    "internetMessageId": "outlook.com",
    "subject": "Testing",
    "bodyPreview": "example",
    "importance": "normal",
    "parentFolderId": "ID",
    "conversationId": "ID",
    "conversationIndex": "INDEX",
    "isDeliveryReceiptRequested": false,
    "isReadReceiptRequested": false,
    "isRead": true,
    "isDraft": false,
    "webLink": "https://example.com",
    "inferenceClassification": "focused",
    "body": {
        "contentType": "html",
        "content": "content"
    },
    "sender": {
        "emailAddress": {
            "name": "NAME",
            "address": "sender@example.com"
        }
    },
    "from": {
        "emailAddress": {
            "name": "NAME",
            "address": "user@example.com"
        }
    },
    "toRecipients": [
        {
            "emailAddress": {
                "name": "NAME",
                "address": "recipient@example.com"
            }
        }
    ],
    "ccRecipients": [],
    "bccRecipients": [],
    "replyTo": [],
    "uniqueBody": {
        "contentType": "html",
        "content": "content"
    },
    "flag": {
        "flagStatus": "notFlagged"
    },
    "id": "ID"
}
Mensagens de saída

Em um mural de casos, a ação Enviar e-mail HTML fornece as seguintes mensagens de saída:

Mensagem de resposta Descrição da mensagem
Email was sent successfully. A ação foi concluída.

Action failed to run because the HTML template was not specified.

Action failed to run because the following specified attachments were not found: ATTACHMENT_LIST

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a conexão com o servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela a seguir descreve os valores da saída do resultado do script ao usar a ação Enviar e-mail HTML:

Nome do resultado do script Valor
is_success True ou False

Enviar resposta na conversa

Use a ação Enviar resposta na conversa para enviar uma mensagem como resposta à conversa por e-mail. Com as permissões adequadas, a ação pode enviar e-mails de uma caixa de correio diferente da especificada na configuração da integração.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

A ação Enviar resposta de conversa exige os seguintes parâmetros:

Parâmetro Descrição
Send From

Obrigatório.

Um endereço de e-mail opcional de onde enviar e-mails, se as permissões permitirem.

Por padrão, a ação envia e-mails da caixa de correio padrão especificada na configuração da integração.
Mail ID

Obrigatório.

O ID do e-mail a ser pesquisado.
Folder Name

Opcional.

Uma pasta de caixa de e-mails em que pesquisar e-mails. Para especificar uma subpasta, use a barra /, como Inbox/Subfolder.

O valor padrão é Inbox.
Attachments Paths

Opcional.

Uma lista separada por vírgulas de caminhos para anexos de arquivos armazenados no servidor, como /FILE_DIRECTORY/file.pdf, /FILE_DIRECTORY/image.jpg.
Mail Content

Obrigatório.

O corpo do e-mail.
Reply All

Opcional.

Se selecionada, a ação envia uma resposta a todos os destinatários relacionados ao e-mail original.

Não selecionada por padrão.

Esse parâmetro tem prioridade sobre o Reply To.
Reply To

Opcional.

Uma lista de e-mails separados por vírgulas para enviar a resposta.

Se você não informar nenhum valor e a caixa de seleção Reply All estiver desmarcada, a ação vai enviar uma resposta apenas ao remetente original do e-mail.

Se a caixa de seleção Reply All estiver marcada, a ação vai ignorar esse parâmetro.
Attachments Location

Obrigatório.

Um local onde os anexos são armazenados.

Por padrão, a ação tenta fazer upload de anexos do bucket do Cloud Storage.

Os valores possíveis são GCP Bucket ou Local File System. O valor padrão é GCP Bucket.

Saídas de ação

A tabela a seguir descreve os tipos de saída associados à ação Enviar resposta de conversa:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Indisponível
Mensagens de saída Disponível
Resultado do script Disponível
Mensagens de saída

A ação Enviar resposta da conversa fornece as seguintes mensagens de saída:

Mensagem de resposta Descrição da mensagem
Successfully sent reply to the mail with ID: EMAIL_ID A ação foi concluída.
Error executing action "Send Thread Reply". Reason: if you want to send a reply only to your own email address, you need to work with "Reply To" parameter.

Falha na ação.

Verifique o valor do parâmetro Reply To.

Error executing action "Send Thread Reply" because the provided mail id EMAIL_ID was not found.

Action failed to run because specified attachments were not found: ATTACHMENTS_LIST

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a conexão com o servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela a seguir descreve os valores da saída do resultado do script ao usar a ação Enviar resposta da conversa:

Nome do resultado do script Valor
is_success True ou False

Enviar e-mail de votação

Use a ação Enviar e-mail de votação para enviar e-mails com as opções de resposta predefinidas. Essa ação usa modelos HTML do Google SecOps para formatar o e-mail. Com as permissões adequadas, a ação Enviar e-mail de votação pode enviar e-mails de uma caixa de correio diferente da padrão.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

A ação Enviar e-mail de voto exige os seguintes parâmetros:

Parâmetro Descrição
Send From

Obrigatório.

Um endereço de e-mail opcional de onde enviar e-mails, se as permissões permitirem.

Por padrão, a ação envia e-mails da caixa de correio padrão especificada na configuração da integração.
Subject

Obrigatório.

O assunto do e-mail.
Send to

Obrigatório.

Uma lista separada por vírgulas de endereços de e-mail dos destinatários, como user1@example.com, user2@example.com.
CC

Opcional.

Uma lista de endereços de e-mail separados por vírgula para o campo "Cc" do e-mail.

O formato é o mesmo do parâmetro Send to.
BCC

Opcional.

Uma lista de endereços de e-mail separados por vírgula para o campo CCO do e-mail.

O formato é o mesmo do parâmetro Send to.
Attachments Paths

Opcional.

Um caminho completo para o anexo a ser fornecido, como /FILE_DIRECTORY/file.pdf, /FILE_DIRECTORY/image.jpg.

É possível fornecer vários valores em uma string separada por vírgulas.
Email HTML Template

Obrigatório.

O tipo de modelo HTML a ser usado.

Os valores possíveis são Email HTML Template e Dynamically generated list of available templates.

O valor padrão é Email HTML Template.
Reply-To Recipients

Opcional.

Uma lista separada por vírgulas de destinatários a serem usados no cabeçalho Reply-To.

Use o cabeçalho Responder para para redirecionar e-mails de resposta ao endereço especificado em vez do endereço do remetente indicado no campo De.
Structure of voting options

Obrigatório.

A estrutura do voto a ser enviada aos destinatários.

Os valores possíveis são Yes/No ou Approve/Reject. O valor padrão é Yes/No.

Attachment Location

Obrigatório.

Um local onde os anexos são armazenados.

Por padrão, a ação tenta fazer upload do anexo do bucket do Cloud Storage.

Os valores possíveis são GCP Bucket ou Local File System. O valor padrão é GCP Bucket.

Saídas de ação

A ação Enviar e-mail de voto fornece as seguintes saídas:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo a seguir descreve a saída do resultado JSON recebida ao usar a ação Enviar e-mail de voto:

{
    "createdDateTime": "2024-01-30T16:50:27Z",
    "lastModifiedDateTime": "2024-01-30T16:50:27Z",
    "changeKey": "KEY",
    "categories": [],
    "receivedDateTime": "2024-01-30T16:50:27Z",
    "sentDateTime": "2024-01-30T16:50:27Z",
    "hasAttachments": false,
    "internetMessageId": "<example-message-ID>",
    "subject": "Testing",
    "bodyPreview": "example",
    "importance": "normal",
    "parentFolderId": "FOLDER_ID",
    "conversationId": "CONVERSATION_ID",
    "conversationIndex": "CONVERSATION_INDEX",
    "isDeliveryReceiptRequested": false,
    "isReadReceiptRequested": false,
    "isRead": true,
    "isDraft": false,
    "webLink": "https://www.example.com/about",
    "inferenceClassification": "focused",
    "body": {
        "contentType": "html",
        "content": "content"
    },
    "sender": {
        "emailAddress": {
            "name": "NAME",
            "address": "sender@example.com"
        }
    },
    "from": {
        "emailAddress": {
            "name": "NAME",
            "address": "user@example.com"
        }
    },
    "toRecipients": [
        {
            "emailAddress": {
                "name": "NAME",
                "address": "recipient@example.com"
            }
        }
    ],
    "ccRecipients": [],
    "bccRecipients": [],
    "replyTo": [],
    "uniqueBody": {
        "contentType": "html",
        "content": "content"
    },
    "flag": {
        "flagStatus": "notFlagged"
    },
    "id": "ID"
}
Mensagens de saída

Em um mural de casos, a ação Enviar e-mail de voto fornece as seguintes mensagens de saída:

Mensagem de resposta Descrição da mensagem
Email was sent successfully. A ação foi concluída.

Action failed to run because the HTML template was not specified.

Action failed to run because the following specified attachments were not found: ATTACHMENT_LIST

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a conexão com o servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela a seguir descreve os valores da saída do resultado do script ao usar a ação Enviar e-mail de voto:

Nome do resultado do script Valor
is_success True ou False

Aguardar e-mail do usuário

Use a ação Aguardar e-mail do usuário para esperar a resposta do usuário com base em um e-mail enviado usando a ação Enviar e-mail.

Essa ação é assíncrona. Ajuste o tempo limite da ação no IDE do Google SecOps conforme necessário.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

A ação Aguardar e-mail do usuário exige os seguintes parâmetros:

Parâmetro Descrição
Mail ID

Obrigatório.

O ID do e-mail.

Se você usou a ação Enviar e-mail para enviar e-mails, defina o valor do parâmetro como o marcador de posição {SendEmail.JSONResult|id} ou {SendEmail.JSONResult|internetMessageId}.
Wait for All Recipients To Reply?

Opcional.

Se selecionada, a ação aguarda respostas de todos os destinatários até atingir o tempo limite ou prosseguir com a primeira resposta.

Essa opção é selecionada por padrão.
Wait Stage Exclude Pattern

Opcional.

Uma expressão regular para excluir respostas específicas da etapa de espera. Esse parâmetro funciona com o corpo do e-mail.

Por exemplo, se você configurar a expressão regular Out of Office.*, a ação não vai considerar as mensagens automáticas de ausência do trabalho como respostas do destinatário e vai aguardar a resposta de um usuário real.
Folder To Check For Reply

Opcional.

Uma pasta de e-mail da caixa de correio para pesquisar a resposta do usuário. A pesquisa é executada na caixa de correio de onde o e-mail com uma pergunta foi enviado.

Esse parâmetro diferencia maiúsculas de minúsculas.

O valor padrão é Inbox.
Fetch Response Attachments

Opcional.

Se selecionada e a resposta do destinatário contiver anexos, a ação vai buscar a resposta e adicioná-la como um anexo ao resultado da ação.

Não selecionada por padrão.

Saídas de ação

A tabela a seguir descreve os tipos de saída associados à ação Aguardar e-mail do usuário:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Disponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Disponível
Tabela de enriquecimento Indisponível
Resultado JSON Indisponível
Mensagens de saída Disponível
Resultado do script Disponível
Anexo do Painel de Casos

O anexo a seguir do Painel de casos está associado à ação Aguardar e-mail do usuário:

Tipo: Entity

Conteúdo do anexo: título, nome do arquivo (incluindo extensões, se houver), fileContent.

  • Título: RECIPIENT_EMAIL reply attachment.
  • Nome do arquivo: ATTACHMENT_FILENAME + FILE_EXTENSION
  • fileContent: CONTENT_OF_THE_ATTACHED_FILE
Tabela do painel de casos

A ação Aguardar e-mail do usuário pode gerar a seguinte tabela:

Título da tabela: Correspondências

Colunas:

  • ID do e-mail
  • Data de recebimento
  • Remetente
  • Destinatários
  • Assunto
Mensagens de saída

A ação Aguardar e-mail do usuário fornece as seguintes mensagens de saída:

Mensagem de resposta Descrição da mensagem

Found the user EMAIL_RECIPIENT reply: USER_REPLY

Timeout getting reply from user: EMAIL_RECIPIENT.

 A ação foi concluída.

Action failed to receive any replies until timeout.

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a conexão com o servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela a seguir descreve os valores da saída do resultado do script ao usar a ação Aguardar e-mail do usuário:

Nome do resultado do script Valor
is_success True ou False

Aguardar os resultados do e-mail de votação

Use a ação Aguardar resultados do e-mail de votação para esperar a resposta do usuário com base no e-mail de votação enviado usando a ação Enviar e-mail de votação.

Essa ação é assíncrona. Ajuste o tempo limite da ação no IDE do Google SecOps conforme necessário.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

A ação Aguardar resultados do e-mail de votação exige os seguintes parâmetros:

Parâmetro Descrição
Vote Mail Sent From

Obrigatório.

A caixa de correio de onde a ação Enviar e-mail de votação enviou um e-mail.

O valor padrão é a caixa de correio especificada na configuração da integração.

Se quiser, você pode definir um valor diferente para esse parâmetro se a mensagem de voto for enviada de outra caixa de correio.
Mail ID

Obrigatório.

O ID do e-mail.

Se o e-mail for enviado usando a ação Send Vote Email, defina o valor do parâmetro como o marcador de posição SendVoteEmail.JSONResult|id ou SendEmail.JSONResult|internetMessageId.

Para retornar IDs de e-mail, use a ação Search Emails.
Wait for All Recipients To Reply?

Opcional.

Se selecionada, a ação aguarda respostas de todos os destinatários até atingir o tempo limite ou prosseguir com a primeira resposta.

Essa opção é selecionada por padrão.
Wait Stage Exclude Pattern

Opcional.

Uma expressão regular para excluir respostas específicas da etapa de espera.

Esse parâmetro funciona com o corpo do e-mail.

Por exemplo, a ação não considera as mensagens automáticas de ausência do trabalho como respostas do destinatário, mas aguarda uma resposta real do usuário.
Folder To Check For Reply

Opcional.

Uma pasta de e-mail da caixa de correio para pesquisar a resposta do usuário. A pesquisa é executada na caixa de e-mails de onde a mensagem com uma pergunta foi enviada.

Esse parâmetro aceita uma lista separada por vírgulas de pastas para verificar a resposta do usuário em várias pastas.

Esse parâmetro diferencia maiúsculas de minúsculas.

O valor padrão é Inbox.
Folder To Check For Sent Mail

Opcional.

Uma pasta da caixa de e-mails para pesquisar o e-mail enviado. É uma caixa de entrada de onde você enviou o e-mail com uma pergunta.

Esse parâmetro aceita uma lista separada por vírgulas de pastas para verificar a resposta do usuário em várias pastas.

Esse parâmetro diferencia maiúsculas de minúsculas. Para especificar uma subpasta, use a barra inclinada /, como Inbox/Subfolder.

O valor padrão é Sent Items.
Fetch Response Attachments

Opcional.

Se selecionada e a resposta do destinatário tiver anexos, a ação vai buscar a resposta e adicioná-la como um anexo ao mural de casos.

Não selecionada por padrão.

Saídas de ação

A ação Aguardar resultados do e-mail de votação fornece as seguintes saídas:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Disponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Disponível
Tabela de enriquecimento Indisponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Anexo do Painel de Casos

O anexo do Painel de casos a seguir está associado à ação Wait For Vote Email Results:

Tipo: Entity

Conteúdo do anexo: título, nome do arquivo (incluindo extensões, se houver), fileContent.

  • Título: RECIPIENT_EMAIL reply attachment.
  • Nome do arquivo: ATTACHMENT_FILENAME + FILE_EXTENSION
  • fileContent: CONTENT_OF_THE_ATTACHED_FILE
Tabela do painel de casos

Em um painel de casos, a ação Aguardar resultados por e-mail gera a seguinte tabela:

Título da tabela: Correspondências

Colunas:

  • ID do e-mail
  • Data de recebimento
  • Remetente
  • Destinatários
  • Assunto
Resultado JSON

O exemplo a seguir descreve a saída de resultado JSON recebida ao usar a ação Aguardar resultados do e-mail de votação:

{
    "Responses": [
        {
            "recipient": "user@example.com",
            "vote": "Approve"
        }
    ]
}
Mensagens de saída

A ação Aguardar resultados do e-mail de votação fornece as seguintes mensagens de saída:

Mensagem de resposta Descrição da mensagem

Found the user EMAIL_RECIPIENT reply: USER_REPLY.

Exceeded timeout to get a reply from user: EMAIL_RECIPIENT.

 A ação foi concluída.

Action failed to receive any replies until timeout.

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a conexão com o servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela a seguir descreve os valores da saída do resultado do script ao usar a ação Aguardar resultados do e-mail de votação:

Nome do resultado do script Valor
is_success True ou False

Conectores

Para instruções detalhadas sobre como configurar um conector no Google SecOps, consulte Ingerir seus dados (conectores).

Conector de e-mail do Microsoft Graph

Use o Microsoft Graph Mail Connector para recuperar e-mails do serviço de e-mail do Microsoft Graph.

Use a lista dinâmica para filtrar os valores especificados do corpo e do assunto do e-mail usando expressões regulares. Por padrão, o conector usa uma expressão regular para filtrar os URLs do e-mail.

Entradas do conector

O conector delegado de e-mail do Microsoft Graph exige os seguintes parâmetros:
Parâmetro Descrição
Product Field Name

Obrigatório.

O nome do campo em que o nome do produto é armazenado.

O valor padrão é device_product.

O nome do produto afeta principalmente o mapeamento. Para simplificar e melhorar o processo de mapeamento do conector, o valor padrão device_product é resolvido como um valor substituto referenciado no código. Qualquer entrada inválida para esse parâmetro é resolvida como um valor de substituição por padrão.
Event Field Name

Obrigatório.

O nome do campo usado para determinar o nome do evento (subtipo).

O valor padrão é event_name.
Environment Field Name

Opcional.

O nome do campo em que o nome do ambiente é armazenado.

Se o campo de ambiente não for encontrado, ele será definido como "".

Environment Regex Pattern

Opcional.

Um padrão de expressão regular a ser executado no valor encontrado no campo Environment Field Name. Com esse parâmetro, é possível manipular o campo "environment" usando a lógica de expressão regular.

Use o valor padrão .* para extrair o valor Environment Field Name bruto necessário.

Se o padrão de expressão regular for nulo ou vazio, ou se o valor do ambiente for nulo, o resultado final do ambiente será "".
Email Exclude Pattern

Opcional.

Uma expressão regular para excluir e-mails específicos da ingestão, como spam ou notícias.

Esse parâmetro funciona com o assunto e o corpo do e-mail.
PythonProcessTimeout

Obrigatório.

O limite de tempo limite, em segundos, para o processo do Python que executa o script atual.

O valor padrão é 300.
Azure AD Endpoint

Obrigatório.

O endpoint do Microsoft Entra a ser usado na integração.

O valor padrão é https://login.microsoftonline.com.
Microsoft Graph Endpoint

Obrigatório.

O endpoint do Microsoft Graph a ser usado na integração.

O valor padrão é https://graph.microsoft.com.
Mail Address

Obrigatório.

Um endereço de e-mail para o conector usar.
Client ID

Obrigatório.

Um ID do aplicativo (cliente) do aplicativo Microsoft Entra.
Secret ID

Obrigatório.

O valor da chave secreta do cliente do aplicativo Microsoft Entra.
Tenant (Directory) ID

Obrigatório.

O valor do Microsoft Entra ID (ID do locatário).
Folder to check for emails

Obrigatório.

Uma pasta de e-mail para pesquisar as mensagens. Esse parâmetro aceita uma lista separada por vírgulas de pastas para pesquisar a resposta do usuário em várias pastas. Para especificar uma subpasta, use a barra inclinada /, como Inbox/Subfolder.

Esse parâmetro diferencia maiúsculas de minúsculas.

O valor padrão é Inbox.
Offset Time In Hours

Obrigatório.

O número de horas antes da primeira iteração do conector para recuperar e-mails. Esse parâmetro se aplica à iteração inicial do conector depois que você o ativa pela primeira vez. O conector pode usar esse parâmetro como um valor substituto quando o carimbo de data/hora da iteração mais recente do conector expirar.

O valor padrão é 24.
Max Emails Per Cycle

Obrigatório.

O número de e-mails a serem buscados em cada iteração do conector.

O valor padrão é 10.
Unread Emails Only

Opcional.

Se selecionado, o conector cria casos apenas com base em e-mails não lidos.

Não selecionada por padrão.
Mark Emails as Read

Opcional.

Se selecionado, o conector marca os e-mails como lidos após a ingestão.

Não selecionada por padrão.
Disable Overflow

Opcional.

Se selecionada, o conector ignora o mecanismo de estouro do Google SecOps.

Não selecionada por padrão.
Verify SSL

Obrigatório.

Se selecionada, a integração valida o certificado SSL ao se conectar ao Microsoft Graph.

Essa opção é selecionada por padrão.
Original Received Mail Prefix

Opcional.

Um prefixo a ser adicionado às chaves de evento extraídas (por exemplo, to, from ou subject) do e-mail original recebido na caixa de correio monitorada.

O valor padrão é orig.
Attached Mail File Prefix

Opcional.

Um prefixo a ser adicionado às chaves de evento extraídas (por exemplo, to, from ou subject) do arquivo de e-mail anexado recebido na caixa de correio monitorada.

O valor padrão é attach.
Create a Separate Google Secops Alert per Attached Mail File

Opcional.

Se selecionado, o conector cria vários alertas, um para cada arquivo de e-mail anexado.

Esse comportamento é útil ao processar e-mails com vários arquivos anexados e definir o mapeamento de eventos do Google SecOps para criar entidades com base em arquivos de e-mail anexados.

Não selecionada por padrão.
Attach Original EML

Opcional.

Se selecionado, o conector anexa o e-mail original às informações do caso como um arquivo EML.

Não selecionada por padrão.
Headers to add to events

Opcional.

Uma string separada por vírgulas de cabeçalhos de e-mail a serem adicionados aos eventos do Google SecOps, como DKIM-Siganture, Received ou From.

É possível configurar uma correspondência exata para cabeçalhos ou definir esse valor de parâmetro como uma expressão regular.

O conector filtra os valores configurados da lista internetMessageHeaders e os adiciona ao evento do Google SecOps.

Para evitar que o conector adicione cabeçalhos ao evento, defina o valor do parâmetro da seguinte maneira: None.

Por padrão, o conector adiciona todos os cabeçalhos disponíveis.
Case Name Template

Opcional.

Um nome de caso personalizado.

Ao configurar esse parâmetro, o conector adiciona uma nova chave chamada custom_case_name ao evento do SOAR do Google SecOps.

É possível fornecer marcadores de posição no seguinte formato: [name of the field].

Exemplo: Phishing - [event_mailbox].

Para marcadores de posição, o conector usa o primeiro evento SOAR do Google SecOps. O conector só processa chaves que contêm o valor de string.
Alert Name Template

Opcional.

Um nome de alerta personalizado.

É possível fornecer marcadores de posição no seguinte formato: [name of the field].

Exemplo: Phishing - [event_mailbox].

Para marcadores de posição, o conector usa o primeiro evento SOAR do Google SecOps. O conector só processa chaves que contêm o valor de string. Se você não fornecer um valor ou um modelo inválido, o conector vai usar o nome de alerta padrão.
Proxy Server Address

Opcional.

O endereço do servidor proxy a ser usado.
Proxy Username

Opcional.

O nome de usuário do proxy para autenticação.
Proxy Password

Opcional.

A senha do proxy para autenticação.
Mail Field Source

Opcional.

Se selecionada, a integração vai recuperar o endereço da caixa de correio do atributo mail dos detalhes do usuário. Se não estiver selecionada, a integração vai recuperar o endereço da caixa de correio do campo userPrincipalName.

Não selecionada por padrão.
Base64 Encoded Private Key

Opcional.

Especifique uma chave privada codificada em base64 que será usada para descriptografar o e-mail.
Base64 Encoded Certificate

Opcional.

Especifique um certificado codificado em base64 que será usado para descriptografar o e-mail.
Base64 Encoded CA certificate

Opcional.

Especifique um certificado de CA confiável codificado em base64 para verificação de assinatura.

Regras do conector

O conector é compatível com proxies.

Precisa de mais ajuda? Receba respostas de membros da comunidade e profissionais do Google SecOps.