HTTP v2

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

Versão de integração: 5.0

Vista geral

Use o HTTP v2 para integrar com produtos de terceiros sem escrever código e resolver exemplos de utilização, como executar pedidos de API, trabalhar com ficheiros e gerir fluxos assíncronos.

Fluxos de autenticação

Consoante o produto para o qual se autentica, o HTTP v2 suporta os seguintes fluxos de autenticação:

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

Fluxo de autenticação básica

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

Fluxo da chave da API

Com o fluxo de chaves de API, autentique-se através dos parâmetros Test URL, API Key Field Name e API Key Field Value.

Fluxo de autenticação dedicado

No fluxo de autenticação dedicado, é usada a seguinte autenticação em dois passos:

  1. Uma ação gera uma chave de acesso.

    Quando a ação Ping ou Execute HTTP Request é executada, a integração obtém os parâmetros necessários para a autenticação.

  2. Uma ação usa o token de acesso gerado para autenticar os pedidos de API.

O fluxo de autenticação dedicado requer 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 o artigo Integre o HTTP v2 com o Google SecOps.

Para usar o token da resposta, indique o nome da chave no parâmetro Dedicated Auth API Request Token Field Name. No exemplo de resposta seguinte, 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 fornece este marcador de posição no payload, a integração usa o token gerado.

Se a chave access_token na resposta JSON aparecer aninhada, indique a localização completa 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 data_access_token chave para a resposta aninhada da seguinte forma:

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

O exemplo seguinte mostra o pedido do fluxo de autenticação dedicado à 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 requer a seguinte entrada: Authorization: Bearer {{integration.token}}.

Integre o HTTP v2 com o Google SecOps

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

Parâmetro Descrição
Test URL Opcional

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

Basic Auth Username Opcional

Um parâmetro a adicionar como um cabeçalho de autenticação básica a cada execução de ação juntamente com o parâmetro Palavra-passe de autenticação básica.

Forneça os parâmetros Basic Auth Username e Basic Auth Password.

Basic Auth Password Opcional

Um parâmetro a adicionar como um cabeçalho de autenticação básica a cada execução de ação juntamente com o parâmetro Nome de utilizador de autenticação básica.

Forneça os parâmetros Basic Auth Username e Basic Auth Password.

API Key Field Name Opcional

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

Indique os parâmetros API Key Field Name e API Key Secret para os adicionar a todas as execuções de ações.

API Key Secret Opcional

O valor secreto da chave da API.

Indique os parâmetros API Key Field Name e API Key Secret para os adicionar a todas as execuções de ações.

Dedicated Auth API Request Method Opcional

O método a usar no fluxo da API de autenticação dedicada para gerar o token de acesso.

O valor predefinido é POST.

Dedicated Auth API Request URL Opcional

O pedido da API a usar no fluxo da API de autenticação dedicada para gerar o token de acesso, como https://api.crowdstrike.com/oauth2/token.

Dedicated Auth API Request Headers Opcional

Cabeçalhos a usar no fluxo da API de autenticação dedicada 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 do pedido a usar no fluxo da API de autenticação dedicada para gerar o token de acesso. Forneça o valor do parâmetro como um objeto JSON, como o seguinte:

    {
    "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 tokens usa o caráter de sublinhado (_) como delimitador.

CA Certificate Opcional

O certificado da autoridade de certificação (AC) a usar para validar a ligação segura.

Se usar um agente remoto para estabelecer ligação a um produto no local, forneça uma camada de segurança adicional ao fornecer à integração o certificado da AC para garantir a integridade da ligação. Depois de fornecer um certificado da AC, todos os pedidos da API usam-no.

Este parâmetro aceita o certificado da AC sob a forma de uma string codificada em base64.

Verify SSL Obrigatório

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

Selecionado por predefinição.

É uma boa prática criar uma instância separada da integração HTTP v2 para cada produto de terceiros que integrar no seu ambiente. Para mais informações sobre várias instâncias de integração, consulte o artigo Suporte de várias instâncias.

Como usar a integração HTTP v2

Esta secção explica como usar a integração HTTP v2 modificando os parâmetros da ação Executar pedido HTTP.

Trabalhe com o parâmetro de payload do corpo

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

{
  "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", o payload gerado é o seguinte:

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

Quando trabalhar com XML, forneça uma entrada formatada em XML, como a seguinte:

<?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>

Trabalhe com o fluxo assíncrono

Os fluxos de API assíncronos, como a criação e a execução de uma tarefa de pesquisa, requerem que se aguarde que o resultado conclua o processamento antes de executar o pedido de API seguinte. Por exemplo, pode criar uma tarefa de pesquisa no Google SecOps SIEM, aguardar que a tarefa de pesquisa conclua a execução e, em seguida, obter resultados através do parâmetro Expected Response Values.

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

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

Pode pedir que a ação Execute HTTP Request seja executada num 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é ao limite de tempo quando ocorre um erro, forneça uma condição adicional no valor do parâmetro. No exemplo de entrada seguinte, a ação deixa de ser executada quando o estado é finished ou error:

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

No exemplo seguinte, a ação deixa de ser executada quando o estado é finished e o valor da chave de percentagem é 100:

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

Pode combinar várias condições de chave numa única entrada, como as seguintes:

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

Pode configurar o parâmetro Expected Response Values para esperar um resultado para um par de chave-valor específico. A ação Executar pedido HTTP pesquisa a chave específica no objeto de resposta JSON completo e considera que o resultado esperado é alcançado apenas quando define todos os nomes de chaves correspondentes para um valor de chave esperado idêntico. Por exemplo, para que a ação procure a correspondência do estado na resposta JSON e ignore todos os outros estados, defina todas as chaves na entrada do parâmetro Expected Response Values para o valor finished:finishedstate

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

O parâmetro Expected Response Values obtém o valor necessário do objeto JSON aninhado. Para o exemplo seguinte, indique apenas a chave state, não data_state nem data-state:

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

Trabalhe com ficheiros

O trabalho com ficheiros inclui dois fluxos de trabalho separados:

  • Transferir um ficheiro
  • Carregar um ficheiro

Transfira ficheiros

A ação Executar pedido HTTP pode devolver ficheiros como saída base64 no objeto JSON ou guardar ficheiros no mural do registo como ficheiros ZIP.

Para devolver os dados como parte de um resultado JSON no formato base64, selecione o parâmetro Base64 Output. Para guardar ficheiros no mural do registo, selecione o parâmetro Save To Case Wall.

Se trabalhar com ficheiros confidenciais, como software malicioso, selecione o parâmetro Password Protect Zip. Para todos os ficheiros ZIP protegidos por palavra-passe, a ação define automaticamente a palavra-passe como infected.

Carregar ficheiros

Para carregar ficheiros, converta-os para o formato base64 e envie-os como parte do valor do parâmetro Body Payload. O exemplo de um ficheiro de imagem convertido para o formato base64 é o seguinte:

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 secção Trabalhe com o parâmetro de payload do corpo deste documento.

Blocos como código

Pode usar a integração HTTP v2 e a capacidade de bloco de guião de procedimentos no Google SecOps para criar conteúdo reutilizável. Por exemplo, pode criar um bloco de livro de jogadas que contenha uma ação HTTP v2 e configurar uma integração para usar os resultados da ação como entradas de blocos. Para mais informações sobre os blocos de manuais de jogos, consulte o artigo Trabalhar com blocos de manuais de jogos.

Crie blocos de guias interativos

Para criar um bloco de guião de soluções, conclua os seguintes passos:

  1. No Google SecOps, aceda a Resposta > Manuais de procedimentos.
  2. Na barra de navegação da página Guias interativos, selecione adicionar Adicionar novo guia interativo ou Bloquear. É apresentada a janela Criar novo.
  3. Na janela Criar novo, defina o parâmetro Type como Block.
  4. Para o parâmetro Choose Folder, selecione a pasta onde quer guardar o novo bloco.
  5. Para o parâmetro Environment, selecione o seu ambiente.
  6. Clique em Criar. É apresentada a página Novo bloqueio. Configure o novo bloco de livro de jogadas para o usar em vários livros de jogadas.

A secção seguinte é um exemplo de como configurar um bloco de guião.

Exemplo de configuração de bloqueio do Playbook

O exemplo seguinte é uma ação de pedido HTTP de execução personalizada que envia comentários para o ServiceNow. A ação usa os parâmetros comment, sys_id e table_name que o bloco de manual personalizado criou como parâmetros de entrada. Para configurar os parâmetros da ação, conclua os seguintes passos:

  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 blocos como marcadores de posição para a ação, os marcadores de posição têm de conter o prefixo Input. antes do nome do parâmetro. Se a entrada para o bloco for keyname, o marcador de posição para o mesmo é [Input.keyname].

Ações

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

Executar pedido HTTP

Execute um pedido HTTP através da integração HTTP v2.

Use esta ação para criar um pedido HTTP personalizado e devolver informações sobre o mesmo. Todos os parâmetros nesta ação são modificáveis.

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

Dados de ações

A ação Executar pedido HTTP requer os seguintes parâmetros:

Parâmetro Descrição
Method
Opcional

O método a usar no pedido.

O valor predefinido é GET.

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

O URL a executar.

URL Params Opcional

Os parâmetros de URL.

A ação usa qualquer valor fornecido juntamente com os valores que são fornecidos 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"
    }
    

Este parâmetro requer o formato de objeto JSON como entrada. O valor predefinido é o seguinte:

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

Cabeçalhos a usar no pedido HTTP.

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

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

Este parâmetro requer o formato de objeto JSON como entrada. O valor predefinido é o seguinte:

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

Os parâmetros a usar no cabeçalho Cookie.

Este parâmetro substitui o cookie fornecido no parâmetro Headers.

Por exemplo, para conter um cabeçalho de cookie com o valor PHPSESSID=298zf09hf012fh2; csrftoken=u32t4o3tb3gg43;, o pedido HTTP requer a seguinte entrada:

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

Este parâmetro requer o formato de objeto JSON como entrada. O valor predefinido é o seguinte:

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

O corpo do pedido HTTP. A ação cria payloads diferentes consoante o valor do cabeçalho Content-Type fornecido no parâmetro Headers.

Este parâmetro requer o formato de objeto JSON como entrada, exceto quando um produto de terceiros requer um XML ou o conteúdo multipart/form-data. Se enviar ou carregar um ficheiro através do pedido da API, forneça a versão codificada em base64 do ficheiro no parâmetro Body Payload e defina o cabeçalho como "Content-type": "multipart/form-data".

O valor predefinido é o seguinte:

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

Os valores de resposta esperados.

Se este parâmetro for fornecido, a ação funciona num modo assíncrono e é executada até receber os valores esperados ou até ao limite de tempo.

Save To Case Wall
Opcional

Se selecionada, a ação guarda o ficheiro e anexa-o ao mural do registo. O ficheiro está arquivado com a extensão .zip. O ficheiro .zip não está protegido por palavra-passe.

Não selecionado por predefinição.

Password Protect Zip
Opcional

Se selecionada, a ação adiciona uma palavra-passe ao ficheiro .zip criado através do parâmetro Save To Case Wall. A palavra-passe é a seguinte: infected.

Use este parâmetro quando trabalhar com ficheiros suspeitos.

Selecionado por predefinição.

Follow Redirects Opcional

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

Selecionado por predefinição.

Fail on 4xx/5xx Opcional

Se selecionada, a ação falha se o código de estado da resposta for 4xx ou 5xx erros.

Selecionado por predefinição.

Base64 Output
Opcional

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

Use este parâmetro quando transferir ficheiros.

O resultado JSON não pode exceder 15 MB.

Não selecionado por predefinição.

Fields To Return Obrigatório

Os campos a devolver. Os valores possíveis são os seguintes:

  • 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 de a ação falhar.

O valor predefinido é 120 segundos.

Resultados da ação

A ação Executar pedido HTTP fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo seguinte descreve o resultado JSON recebido quando usa a ação Execute HTTP Request:

{
   "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

Numa Case Wall, a ação Executar pedido HTTP fornece as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Successfully executed API request.

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

Ação efetuada com êxito.

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 ligação ao servidor, os parâmetros de entrada, o valor do ficheiro JSON ou as credenciais.

Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Execute HTTP Request:

Nome do resultado do script Valor
is_success True ou False

Tchim-tchim

Use esta ação para testar a conetividade.

Dados de ações

Nenhum.

Resultados da ação

A ação Ping fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Não disponível
Mensagens de saída Disponível
Resultado do script Disponível
Mensagens de saída

Num mural de registos, a ação Ping apresenta as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem
Successfully tested connectivity. Ação efetuada com êxito.
Failed to test connectivity.

Falha na ação.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.

Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa 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 da Google SecOps.