HTTP v2

Este documento fornece orientações sobre como integrar o HTTP v2 ao módulo SOAR do Google Security Operations e trabalhar com a ação Executar solicitação HTTP.

Versão da integração: 5.0

Visão geral

Use o HTTP v2 para integrar com produtos de terceiros sem escrever código e resolver casos de uso, como executar solicitações de API, trabalhar com arquivos e gerenciar fluxos assíncronos.

Fluxos de autenticação

Dependendo do produto em que você faz a autenticação, o HTTP v2 é compatível com os seguintes fluxos de autenticação:

  • Fluxo de autenticação básica
  • Fluxo da chave de API
  • Fluxo de autenticação dedicado

Fluxo de autenticação básica

Com o fluxo de autenticação básica, autentique usando os parâmetros Test URL, Basic Auth Username e Basic Auth Password.

Fluxo da chave de API

Com o fluxo de chaves de API, autentique usando os parâmetros Test URL, API Key Field Name e API Key Field Value.

Fluxo de autenticação dedicado

No fluxo de autenticação dedicado, a seguinte autenticação em duas etapas é usada:

  1. Uma ação gera um token de acesso.

    Quando a ação Ping ou Executar solicitação HTTP é executada, a integração recupera os parâmetros necessários para autenticação.

  2. Uma ação usa o token de acesso gerado para autenticar solicitações de API.

O fluxo de autenticação dedicado exige os seguintes parâmetros de integração:

  • Dedicated Auth API Request Method
  • Dedicated Auth API Request URL
  • Dedicated Auth API Request Headers
  • Dedicated Auth API Request Body
  • Dedicated Auth API Request Token Field Name

Para mais detalhes sobre os parâmetros de integração, consulte Integrar o HTTP v2 ao Google SecOps.

Para usar o token da resposta, forneça o nome da chave no parâmetro Dedicated Auth API Request Token Field Name. No exemplo de resposta a seguir, o nome da chave é access_token:

{
   "access_token": "eyJhbGciOiJSUzI1NiIsImtpZCIO4",
   "expires_in": 1799,
   "token_type": "bearer"
}

Para aplicar o token, a integração requer o seguinte marcador de posição dedicado: {{integration.token}}. Quando você fornece esse marcador de posição no payload, a integração usa o token gerado.

Se a chave access_token na resposta JSON aparecer aninhada, forneça o local completo do token para o valor do parâmetro Dedicated Auth API Request Token Field Name. Por exemplo, em vez de access_token, forneça a chave data_access_token para a resposta aninhada, como a seguir:

{
   "data": {
       "access_token": "eyJhbGciOiJSUzI1NiIsImtpZCIZMI3DQAQsYibMpO4",
       "expires_in": 1799,
       "token_type": "bearer"
   }
}

O exemplo a seguir mostra a solicitação do fluxo de autenticação dedicado para a API Crowdstrike:

POST /falconx/entities/submissions/v1 HTTP/1.1
Host: api.crowdstrike.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6
Content-Length: 209

{
   "sandbox": [{
       "sha256": "9854c9dfded29d8442499daba01082ba5d164aa02e44",
       "environment_id": 100,
       "submit_name": "filename.pdf"
   }]
}

O exemplo usa o cabeçalho Authorization com um token Bearer para autenticar na API. Para preencher o cabeçalho com as informações corretas, a integração HTTP v2 exige a seguinte entrada: Authorization: Bearer {{integration.token}}.

Integrar o HTTP v2 ao Google SecOps

A integração requer os seguintes parâmetros:

Parâmetro Descrição
Test URL Opcional

Um URL de teste a ser usado para a autenticação básica ou o fluxo de autenticação da chave de API.

Basic Auth Username Opcional

Um parâmetro a ser adicionado como um cabeçalho de autenticação básica a cada execução de ação junto com o parâmetro Senha de autenticação básica.

Forneça os parâmetros Nome de usuário da autenticação básica e Senha da autenticação básica.

Basic Auth Password Opcional

Um parâmetro a ser adicionado como um cabeçalho de autenticação básica a cada execução de ação junto com o parâmetro Nome de usuário de autenticação básica.

Forneça os parâmetros Nome de usuário da autenticação básica e Senha da autenticação básica.

API Key Field Name Opcional

O nome do cabeçalho que contém a chave de API.

Forneça os parâmetros Nome do campo da chave de API e Chave secreta da API para adicioná-los a todas as execuções de ações.

API Key Secret Opcional

O valor secreto da chave de API.

Forneça os parâmetros Nome do campo da chave de API e Chave secreta da API para adicioná-los a todas as execuções de ações.

Dedicated Auth API Request Method Opcional

O método a ser usado no fluxo dedicado da API de autenticação para gerar o token de acesso.

O valor padrão é POST.

Dedicated Auth API Request URL Opcional

A solicitação de API a ser usada no fluxo dedicado da API de autenticação para gerar o token de acesso, como https://api.crowdstrike.com/oauth2/token.

Dedicated Auth API Request Headers Opcional

Cabeçalhos a serem usados no fluxo dedicado da API de autenticação para gerar o token de acesso.

Forneça cabeçalhos como um objeto JSON, como o seguinte:

    {
    "Content-type": "application/x-www-form-urlencoded"
    }
    
Dedicated Auth API Request Body Opcional

O corpo da solicitação a ser usado no fluxo dedicado da API de autenticação para gerar o token de acesso. Forneça o valor do parâmetro como um objeto JSON, como este:

    {
    "client_id": "CLIENT_ID",
    "client_secret": "CLIENT_SECRET"
    }
    
Dedicated Auth API Request Token Field Name
Opcional

O nome do campo que contém o token de acesso gerado. Para usar o token de acesso em ações, use o seguinte marcador de posição: {{integration.token}}.

A resposta para a geração de token usa o sublinhado (_) como delimitador.

CA Certificate Opcional

O certificado da autoridade de certificação (CA) a ser usado para validar a conexão segura.

Se você usar um agente remoto para se conectar a um produto local, forneça uma camada extra de segurança ao fornecer a integração com o certificado da CA para garantir a integridade da conexão. Depois que você fornece um certificado de CA, todas as solicitações de API o usam.

Esse parâmetro aceita o certificado da CA na forma de uma string codificada em base64.

Verify SSL Obrigatório

Se selecionada, o sistema verifica se o certificado SSL de todas as conexões de integração é válido.

Essa opção é selecionada por padrão.

É recomendável criar uma instância separada da integração HTTP v2 para cada produto de terceiros integrado ao seu ambiente. Para mais informações sobre várias instâncias de integração, consulte Suporte a várias instâncias.

Como usar a integração HTTP v2

Esta seção explica como usar a integração HTTP v2 modificando os parâmetros da ação "Executar solicitação HTTP".

Trabalhar com o parâmetro "Payload do corpo"

Para garantir que o corpo seja construído corretamente, forneça o cabeçalho Content-Type correto no parâmetro Headers. A ação Executar solicitação HTTP gera payloads diferentes para a mesma entrada de parâmetro a seguir:

{
  "Id": "123123",
  "sorting": "asc"
}

Para o valor do cabeçalho "Content-Type:" "application/x-www-form-urlencoded", o payload gerado é Id=123123&sorting=asc.

Para o valor do cabeçalho "Content-Type": "application/json", a carga útil gerada é a seguinte:

{
  "Id": "123123",
  "sorting": "asc"
}

Ao trabalhar com XML, forneça uma entrada formatada em XML, como esta:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
 <soap:Body>
   <NumberToWords xmlns="http://www.dataaccess.com/webservicesserver/">
     <ubiNum>500</ubiNum>
   </NumberToWords>
 </soap:Body>
</soap:Envelope>

Trabalhar com o fluxo assíncrono

Fluxos de API assíncronos, como a criação e a execução de um job de pesquisa, exigem que se aguarde a conclusão do processamento do resultado antes de executar a próxima solicitação de API. Por exemplo, você pode criar um trabalho de pesquisa no Google SecOps SIEM, esperar que ele seja concluído e recuperar os resultados usando o parâmetro Expected Response Values.

No exemplo de resposta a seguir, a chave state pode conter o valor error, in_progress ou finished:

{
   "state": "in_progress",
   "percentage": "10"
}

Você pode solicitar que a ação "Executar solicitação HTTP" seja executada em um modo assíncrono até que a resposta contenha o estado finished definindo o parâmetro Expected Response Values com o seguinte valor:

{
   "state": "finished"
}

Para não esperar até o tempo limite quando um erro ocorrer, forneça uma condição adicional no valor do parâmetro. No exemplo de entrada a seguir, a ação para de ser executada quando o estado é finished ou error:

{
   "state": [
       "finished",
       "error"
   ]
}

No exemplo a seguir, a ação para de ser executada quando o estado é finished e o valor da chave de porcentagem é 100:

{
   "state": "finished",
   "percentage": "100"
}

É possível combinar várias condições de chave em uma entrada, como:

{
   "state": [
       "finished",
       "error"
   ],
   "percentage": "100"
}

É possível configurar o parâmetro Expected Response Values para esperar uma saída de um par de chave-valor específico. A ação "Executar solicitação HTTP" pesquisa em todo o objeto de resposta JSON uma chave específica e considera que a saída esperada é alcançada somente quando você define todos os nomes de chave correspondentes como um valor de chave esperado idêntico. Por exemplo, para que a ação procure a correspondência do estado finished na resposta JSON e ignore qualquer outro estado, defina todas as chaves state na entrada do parâmetro Expected Response Values como o valor finished:

{
"data": {
  "state": "finished"
  },
  "state": "finished"
}

O parâmetro Expected Response Values recupera o valor necessário do objeto JSON aninhado. No exemplo a seguir, forneça apenas a chave state, não data_state ou data-state:

{
   "data": {
       "state": [
           "finished",
           "error"
       ],
       "percentage": "100"
   }
}

Trabalhar com arquivos

Trabalhar com arquivos inclui dois fluxos de trabalho separados:

  • Baixar um arquivo
  • Como enviar um arquivo

Fazer o download de arquivos

A ação "Executar solicitação HTTP" pode retornar arquivos como saída base64 no objeto JSON ou salvar arquivos no painel de casos como arquivos zip.

Para retornar os dados como parte de um resultado JSON no formato base64, selecione o parâmetro Base64 Output. Para salvar arquivos no mural do caso, selecione o parâmetro Save To Case Wall.

Se você trabalha com arquivos sensíveis, como malware, selecione o parâmetro Password Protect Zip. Para todos os arquivos ZIP protegidos por senha, a ação define automaticamente a senha como infected.

Fazer upload de arquivos

Para fazer upload de arquivos, converta-os para o formato base64 e envie como parte do valor do parâmetro Body Payload. Este é um exemplo de arquivo de imagem convertido para o formato base64:

iVBORw0KGgoAAAANSUhEUgAAAOEAAADgCAMAAADCMfHtAAAAvVBMVEX////2yBctLS32xgAAAAASEhLPz8/2xwAfHx8qKiqTk5P1wwD2xw4XFxf///u9vb3w8PAlJSXi4uJBQUH++eb+++z//fP76rH99df98sz64qD64Y/523b41Vr53Hz39/f87bv878T989H3zjH634j76rL3zzz76Kj42GbZ2dn41FCvr68TExM6OjpRUVFmZmb40kiOjo6wsLB8fHxdXV3645j41V9ubm5ISEjGxsahoaFhYWGFhYX53Xn63oxSMwp1AAAMpUlEQVR4nO1da1fiOhemBmg7KWCV+00QBUQdmVHU8Z2Z//+zDpfxgn3SZKdJi+/q8+GctWZJk6fJvmY3u1DIkSNHjhw5cuTIkSNHjq+DZn08brVm3S1ardG4Xc96SqbQHs2GC4dxzj6Bc3c67806zaxnmADt1nDKNsyCwIEI3A1Td7AafUGane5iQ05A7RPRNU1neNnIes7qaLbmLlcjt8dysupkPXUVNLtLzlwSu3eW3B2OsyYgweWCunifwJh70c6ahRDtoaLgSUjy6ayaNReEyylnyeltsRbKi0Mzl9Wua2L53sH443nWpD6g2WOmlu8dAV8ejGq1we8fx4PQrDPXDr8dx0Hm8jh27PHbcexn6tHVB9yofkFgbJYdwZ59fluO04x8gPbE7gZ9R8AvsnABLtJZwB2Yk/oy1qfEBQy2weArXFHIKPw576VLcKbuwQTBhpAzWc77vd7laI1urzcfTHfxrzpRtkwxgKzOuSK7DYVFb3SOrFqjPW79mTjuhr/aw1Kz/3UlFbNhN+2NZRa7et6aO4pOLb9IhV9hrDCdYB0E/xkrb6v2bBmokGSDNHTqSr5DGZv0qJFBYzRQIMkc+15cX0ZwPc++XlDQmE2lPnzgWg6qqgPJFAKWKEBv9wMZRzYyxgagKrGCLlskjekaK0eyWXnLCBc8uhObRHPZwITnUe1K4hW+MjAKRMOJe7mBGX4byDjaohhPkE1N5hyqvdi42g7FWILMMS0c9cc4cbThpVYn4gEDZiMQH8e5TrxrerjqVKxk2MROUqw6jFlG4xo1xg6yvjVXqhOjcbjZ1zoXjuS6I6Mj7aMqHthhJoNisS9qPWoTR6KBY27okZjg0NggIrSFO9WdmhqjLhoiSCXR11yIxmdzMyMI7UTgpnSw0BdR5Gbe8KPg+UEKsdo/XAhX0UQs1RUIIZukmG7vCt9yckslEsJUCRYKLdE0kouiQAjZNOUDk5GAYmLfRiABKa/gBiKKLNlMzrEQBpMMzhFmmGKwSPRUHDEFTiZneitMMdE+7eFnuhkdzIpERv99C/Qoy6yCAJvmBPp0AfdohmeyAvdKO5AaQzWTgrMtRgMuYjDRfBxUM8HS6JSpGON9qretsKfkZlzsirWNq2O9qjAxYzenroIl2llMJ/cGXxbrG58xFVgUNSxGEz3IhCufGNC3YfTDU7iEhvNbmoBGjLyIUAoPYI9uAB0R8iJCH5DynspaONafHFWdwo1AsTrFkgaKNbWHI0vNaHn+S/CWaJ5D8UgDFUWG0NsKSAyR/0dTM1YZQqNIMtVt8I6CAYWgZYZwghR/EiUoOe2YwC7DwgBtMvWwtYqkkLaEthmiRSS4bkjPEJfQNkO4iK7yr4Eck4Mm2wzRIirrwkaSH6fFEC2Dss8FXFt6FG2dIcqfMsXfTsHbIQfR1hkit0uxArWJ1BQ5arLPEHinijkkoElder7OPsM6WAk1bTqPBk4aGVL7DJGuUbNpQILVDU2aDMFmUwowwGGMRooAMQw9GVSjpx2AwlAy20iANZIXUYbh/TcZflyRxgDpDBV7AX6msUkBwxJt+goAB8MqiwE0qU56BjAsazwmFsD5UhBE4O9pZYHTYAiyGQohEFh5rpPIT4UhSHnKJWoY+VHg6AyeCkNwTiMPg6MZGh1bkRJDYC/kIgXUk/Q3CKkwBIIoVTXA2SOkPz4gDWuBZErqQoOoSzXo2kc6axjVi9JINhr9BnpVnOkw7NAXJKp/Nc/t02EIVA2XVA5HU1hMryAnHTks0CM9YCz0vk2NMqzUTt5xfKb11AiiMaJM9euYUAgQPVXezpjC8PT70+/rK7XDtDj0I4so23NgX+sNLYmAfT/0Kje3T9cJSUYLRtjf2B8Ac6hnLNRifD+seE+1JBs2GudLkqbnhrxSQhYjLD2/6HOM2m9JNWbUvujWQBHyNH7llJS9+AiwJPH2G7wS4pnTK0iZKL/0pCmPUbGSbLooQ91CPWKuzTv6pTVMNMw/VIZH/s1PnWFAIiM+Bo56snrRoU6+tPSiMw7VvEUdb916WY2McElnFb8Uw6Oihm/+tRj6Pt0wUhlmKYdrePfWGWanS3coUiMssi61xND/gFiG4ffEDMn2UNunqVS20ZK3ZXX6hluv5IXmFpHs05jzS1+uf9XKb/HuB5yUX+7EHEOiJAK/NH7C5mKLWJzc34h2a4X2JHJsYS4+lOCXSCCJ+SpyfIiUr53i9SsBRY/mu5FjfHN5Gil+lbAg3pGeQs/TGMu1yXEH1Y1/S3pItLpJlmsD+VJbn6qV8SKWSA8B+VLJB+zGct4KwAyLlEcAl0aW8wZHHcZun/iM71DXkBhqnFsYO3tSwBMURBJDcJAkO3sydn6ogPvkDKOqVF6CZ+oMuCDX+g+QIUnTaJwBI/WrpWpqxQfZnxwhOfRPCYNoneObqsXwfe85Pgd6BkNIksUHWkOmSmHBn/xHUVxX1pO9jQ2FahXE0PtGGEWrngbVRF0SBt3hLNzswDC8jvmbZ2gsSAWYWjVRqK6NXiH84u2EqiLO1l/fIIJHRUJ6H0VCCgWmJmoTz7y3TXckWMYy3KM0txR8VKBSm6j5sz388N6nXHlGB4Q1z0DwpFlfimqEifbieM/j9G+eX072/+DkviIIgIsn+JEIujXCwF2nbtN7b3/avhc+fCuf7CTs+KT25HuY31EoNaIfoFvnnbxW/wTWeN/4p98fHh6+n4aVUJhSJOX1wZcvarX6ib+3wP7mtjohDGMTpqQl1P/eAn4zQyiiRUuoCIoUouuBVBUG+u6J8KE0zk6ooELxZ5C+UJUm9O2aum8qSE4oIHymEETfrqlqRPT9oXo+6ll3CX2fVK2AdpqyVQOWVD25f32jR9GvkI4s0D1r6p+BJvsO+OSuFH/AhAne0JLdyb4DTvotd+1W5LIIEd5S1KjgW27CLd/RMJj2MffZi0/jWPofsWIIfo9PiGMTX1lQOH65VZfHsEItNEl+6QNQVA6npffPfj4UBQHEJ37FJ9oOLeB7MWjzQ8aG/j331Y/bkoSkHxbv6DUmcHrEdBK8Yoh+0/tZ+fdp0RN52v7aCf+tU/0N76chnq/Ay9q0rmA8u3p5Oip53r7P7YeeV7y916uehRdWUu8YwvdE6V7BeHZ1/ePu1C+WSpVtAUPRu334fX2lWTiL74kiN4SAdzERlc0+zo6Py+Xaz5+1cvk4Uak+vpOOvL/wlXvB/9F9bYLbvrK/zwxfqqqjIgT3JtKzw4aBTLWGFG6AbyZmGbdAx3dfakoPvr/U2pGwEvCd15rfZonuoM1SFLEQat9BWxhgUTy8e4S1+weI7oLOrNMy7nSRZFcJ7ghnGd3nLehzkejiX7wrTHZ4IUBwfzpPZMBQpOkc1r36rmaJ7ysE7y2D3ggCgkl7IwhciAwoirqU8FHSJx9IjxIRQRPtglrCPjMpalSBUjdUoy1qDHYQvYLMdCYT93tKx/SLm68Z6vck7tmlk5uio7kUrqAxFxm74LsxrBvGjrC9q7m+a+KuVpuuSJaFcRXTO8+kNhd2PlsLo82ovylqibZZQpP9D0Ve/W4Z7e3UcUwPS+PdbmK6OTPHjk6t9uP6kI6MDxfTajVgcwsOziiu7bGN1tXN2H7AgWm7UR/E9gNOv+XxWqma3KrNCxbXAtxe2+q4UQO2NNW6vrqK7yFvr/V4M755fMAGJjjKe6tb9KSq8RQdly2T7tVGT8IvYdZCipjezv/WcTJLkMQ5n8f2VN8StO3u/xE6cG8cg7meMa53J0zGLzDsySDMZBTXepU5QyrJemsZxNmHf0+epJHl68gnsl5I5sxHyk75+WqqQG9N8DGdHF89rnH9x5UMpsOxbFM1O7PBWkMp0FuLoE7vMT305Tt1i/VSus5iOOq0gVfXOB9355PNi1B7mJtWC+ktLlWntaO5cVCmg3mv15uNRuv/9ufLyVpprP9d/TFskW7+si6xjIDohtEr3ECd2u7X9vwYIVacOMkkYBP7RiKKNnkZdRHoXpKTGKvYAMAYrOeCYtCY29+qzLUQ7BLQUbON2nD5MOPGp4VCS+or6yPg8+w26Ad0LXEM+CALDQrRVXS7KHD540H0BH3FzDHLkfH5wazfK0YLbmqzBsz9m3FxGUb7wshmZXyarX2IxehROVQQ0XN6B6E+xWi2Fkyai8AIGHcvDkq7iFC97LucuJTrEItPVwenXGLQnj2uWSrR3ERVfPJ3dAAF1lS0L/8uNzSZKBjcRozcmXfHX5DdG+rj2d/BxOWc7YNz7iz73db5Vya3h3q7M2q1Wt1ud7b+33hcz9yhzpEjR44cOXLkyJEjh0H8ByMJ8u+aLBzeAAAAAElFTkSuQmCC

Para mais informações sobre como usar o parâmetro Body Payload, consulte a seção Trabalhar com o parâmetro "Payload do corpo" deste documento.

Blocos como código

É possível usar a integração HTTP v2 e o recurso de bloco de playbook no Google SecOps para criar conteúdo reutilizável. Por exemplo, é possível criar um bloco de playbook que contenha uma ação HTTP v2 e configurar uma integração para usar os resultados da ação como entradas de bloco. Para mais informações sobre blocos de playbook, consulte Como trabalhar com blocos de playbook.

Criar blocos de playbook

Para criar um bloco de playbook, siga estas etapas:

  1. No Google SecOps, acesse Resposta > Playbooks.
  2. Na barra de navegação da página Playbooks, selecione add Adicionar novo playbook ou bloco. A janela Criar novo é aberta.
  3. Na janela Criar novo, defina o parâmetro Type como Block.
  4. Para o parâmetro Choose Folder, selecione a pasta em que o novo bloco será salvo.
  5. Para o parâmetro Environment, selecione seu ambiente.
  6. Clique em Criar. A página Novo bloco é aberta. Configure o novo bloco de playbook para usá-lo em vários playbooks.

A seção a seguir é um exemplo de como configurar um bloco de playbook.

Exemplo de configuração de bloco do playbook

O exemplo a seguir é uma ação personalizada "Executar solicitação HTTP" que envia comentários ao ServiceNow. A ação usa os parâmetros comment, sys_id e table_name que o bloco de playbook personalizado criou como parâmetros de entrada. Para configurar os parâmetros da ação, siga estas etapas:

  1. Defina o parâmetro Method como PUT.

  2. Defina o parâmetro URL Path com o seguinte valor:

    https://SERVICE_NOW_INSTANCE.service-now.com/api/now/table/[Input.table_name]/[Input.sys_id]
    
  3. Defina o parâmetro Headers com o seguinte valor:

    {"Content-type": "application/json; charset=utf-8",
    "Accept": "application/json", "User-Agent": "GoogleSecops"}
    
  4. Defina o parâmetro Body Payload com o seguinte valor:

    {
    "work_notes": "[Input.comment]"
    }
    

Para usar os valores fornecidos para as entradas de bloco como marcadores de posição para a ação, os marcadores precisam conter o prefixo Input. antes do nome do parâmetro. Se a entrada do bloco for keyname, o marcador de posição será [Input.keyname].

Ações

A integração HTTP v2 inclui as seguintes ações:

Executar solicitação HTTP

Execute uma solicitação HTTP usando a integração HTTP v2.

Use essa ação para criar uma solicitação HTTP personalizada e retornar informações sobre ela. Todos os parâmetros nessa ação podem ser modificados.

Essa ação não é executada em entidades.

Entradas de ação

A ação "Executar solicitação HTTP" exige os seguintes parâmetros:

Parâmetro Descrição
Method
Opcional

O método a ser usado na solicitação.

O valor padrão é GET.

Os valores possíveis são:
  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
  • HEAD
  • OPTIONS
URL Path
Opcional

O URL a ser executado.

URL Params Opcional

Os parâmetros de URL.

A ação usa qualquer valor fornecido junto com os valores que são informados diretamente no parâmetro Caminho do URL.

Por exemplo, a string ?parameter=value&sorting=asc no back-end significa que a entrada é a seguinte:
    {
    "parameter": "value",
    "sorting": "asc"
    }
    

Esse parâmetro exige o formato de objeto JSON como entrada. O valor padrão é:

{
    "URL Field Name": "URL_FIELD_VALUE"
    }
Headers
Opcional

Cabeçalhos a serem usados na solicitação HTTP.

Por exemplo, a solicitação HTTP com os cabeçalhos Accept e User-Agent requer a seguinte entrada:

    {
    "Accept": "application/json",
    "User-Agent": "Google Secops"
    }
    

Esse parâmetro exige o formato de objeto JSON como entrada. O valor padrão é:

{
    "Content-Type": "application/json; charset=utf-8",
    "Accept": "application/json",
    "User-Agent" : "GoogleSecOps"
    }
Cookie Opcional

Os parâmetros a serem usados no cabeçalho "Cookie".

Esse parâmetro substitui o cookie fornecido no parâmetro Cabeçalhos.

Por exemplo, para conter um cabeçalho "Cookie" com o valor PHPSESSID=298zf09hf012fh2; csrftoken=u32t4o3tb3gg43;, a solicitação HTTP exige a seguinte entrada:

    {
    "PHPSESSID": "298zf09hf012fh2",
    "csrftoken": "u32t4o3tb3gg43"
    }
    

Esse parâmetro exige o formato de objeto JSON como entrada. O valor padrão é:

{
    "Cookie_1": "COOKIE_1_VALUE"
    }
Body Payload
Opcional

O corpo da solicitação HTTP. A ação cria payloads diferentes dependendo do valor do cabeçalho Content-Type fornecido no parâmetro Cabeçalhos.

Esse parâmetro exige o formato de objeto JSON como entrada, exceto quando um produto de terceiros exige um XML ou o conteúdo multipart/form-data. Se você enviar ou fazer upload de um arquivo usando a solicitação de API, forneça a versão codificada em base64 do arquivo no parâmetro Payload do corpo e defina o cabeçalho como "Content-type": "multipart/form-data".

O valor padrão é:

{
    "Body Field Name": "BODY_FIELD_VALUE"
    }
Expected Response Values
Opcional

Os valores de resposta esperados.

Se esse parâmetro for fornecido, a ação vai funcionar em um modo assíncrono e será executada até receber os valores esperados ou até o tempo limite.

Save To Case Wall
Opcional

Se selecionada, a ação salva o arquivo e o anexa ao Painel de Casos. O arquivo é arquivado com a extensão .zip. O arquivo .zip não é protegido por senha.

Não selecionada por padrão.

Password Protect Zip
Opcional

Se selecionada, a ação adiciona uma senha ao arquivo .zip criado usando o parâmetro Salvar no mural de casos. A senha é: infected.

Use esse parâmetro ao trabalhar com arquivos suspeitos.

Essa opção é selecionada por padrão.

Follow Redirects Opcional

Se selecionada, a ação segue os redirecionamentos.

Essa opção é selecionada por padrão.

Fail on 4xx/5xx Opcional

Se selecionada, a ação vai falhar se o código de status da resposta for um erro 4xx ou 5xx.

Essa opção é selecionada por padrão.

Base64 Output
Opcional

Se selecionada, a ação converte a resposta para o formato base64.

Use esse parâmetro ao fazer o download de arquivos.

O resultado JSON não pode exceder 15 MB.

Não selecionada por padrão.

Fields To Return Obrigatório

Os campos a serem retornados. Os valores possíveis são:

  • response_data
  • redirects
  • response_code
  • response_cookies
  • response_headers
  • apparent_encoding
Request Timeout Obrigatório

O tempo de espera para o servidor enviar dados antes da falha da ação.

O valor padrão é de 120 segundos.

Saídas de ação

A ação "Executar solicitação HTTP" 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 "Executar solicitação HTTP":

{
   "response_data": {
       "data": {
           "relationships": {
               "comment": [
                   {
                       "name": "item",
                       "description": "Object to which the comment belongs to."
                   },
                   {
                       "name": "author",
                       "description": "User who wrote the comment."
                   }
               ]
           }
       }
   },
   "redirects": [],
   "response_code": 200,
   "cookies": {},
   "response_headers": {
       "Content-Type": "application/json",
       "X-Cloud-Trace-Context": "1ca450b35c66634a2ae01248cca50b19",
       "Date": "Fri, 03 Nov 2023 16:14:13 GMT",
       "Server": "Google Frontend",
       "Content-Length": "36084"
   },
   "apparent_encoding": "ascii"
}
Mensagens de saída

Em um painel de casos, a ação "Executar solicitação HTTP" fornece as seguintes mensagens de saída:

Mensagem de resposta Descrição da mensagem

Successfully executed API request.

Successfully executed API request, but status code STATUS_CODE was in response.

A ação foi concluída.

Failed to execute API request. Error: ERROR_REASON

Failed to execute API request. Error: Invalid parameter "PARAMETER_NAME".

The JSON structure is invalid. Wrong value provided: VALUE

Falha na ação.

Verifique a conexão com o servidor, os parâmetros de entrada, o valor do arquivo JSON 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 "Executar solicitação HTTP":

Nome do resultado do script Valor
is_success True ou False

Ping

Use essa ação para testar a conectividade.

Entradas de ação

Nenhuma.

Saídas de ação

A ação "Ping" 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

Em um quadro de casos, a ação "Ping" fornece as seguintes mensagens de saída:

Mensagem de resposta Descrição da mensagem
Successfully tested connectivity. A ação foi concluída.
Failed to test connectivity.

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

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