Google Cloud API

本文档提供了一些指导，可帮助您配置Google Cloud API 并将其与 Google Security Operations SOAR 集成。

集成版本：4.0

将 Google Cloud API 与 Google SecOps SOAR 集成

集成需要以下参数：

参数 说明
Test URL 可选

用于验证对 Google Cloud API 的身份验证的测试网址。此参数使用 GET 请求。
Service Account Json File Content 可选

服务账号密钥 JSON 文件的内容。

您可以配置此参数、Workload Identity Email 参数，也可以设置所有前面的集成参数。

如需配置此参数，请提供您在创建服务账号时下载的服务账号密钥 JSON 文件的完整内容。

如需详细了解如何将服务账号用作身份验证方法，请参阅服务账号概览和服务账号模拟。

在此集成中，使用服务账号密钥 JSON 文件进行身份验证的优先级高于工作负载身份电子邮件地址。
Organization ID 可选

要在集成中使用的组织 ID。

如需在执行操作期间从此参数检索值，请设置以下占位符：{{org_id}}。

Project ID 可选

集成中要使用的项目 ID。

如需在操作执行期间从此参数中检索值，请设置以下占位符：{{project_id}}。
Quota Project ID 可选

您用于 Google Cloud API 和结算的 Google Cloud 项目 ID。此形参要求您向服务账号授予 Service Usage Consumer 角色。

集成会将此参数值附加到所有 API 请求。

如果您未为此参数设置值，集成会从您的 Google Cloud 服务账号中检索项目 ID。
Workload Identity Email 可选

您的服务账号的客户端电子邮件地址。

您可以配置此参数或 Service Account Json File Content 参数。

在此集成中，使用服务账号密钥 JSON 文件进行身份验证的优先级高于工作负载身份电子邮件地址。

如需使用 Workload Identity 模拟服务账号，请向您的服务账号授予 Service Account Token Creator 角色。如需详细了解工作负载身份以及如何使用它们，请参阅工作负载的身份。
OAuth Scopes 可选

执行 Google Cloud API 请求所需的 OAuth 范围的逗号分隔列表。
Verify SSL 必需

如果选中此选项，集成会验证用于连接到 Google Cloud 服务的 SSL 证书是否有效。

此选项将会默认选中。

如需了解如何在 Google SecOps 中配置集成，请参阅配置集成。

如果需要，您可以在稍后阶段进行更改。配置集成实例后，您可以在剧本中使用该实例。如需详细了解如何配置和支持多个实例，请参阅支持多个实例。

操作

Google Cloud API 集成包含以下操作：

执行 HTTP 请求

使用执行 HTTP 请求操作来执行 HTTP 请求。

此操作不适用于 Google SecOps 实体。

操作输入

执行 HTTP 请求操作需要以下参数：

参数 说明
Method 可选

要在请求中使用的方法。

默认值为 GET。

可能的值包括：
  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
  • HEAD
  • OPTIONS
URL Path 可选

要执行的网址。

默认值为 https://。
URL Params 可选

网址参数。

该操作会使用与您在 网址 路径参数中直接提供的值一起提供的任何值。

此参数需要 JSON 对象格式的输入。默认值如下：

{
    "URL Field Name": "URL_FIELD_VALUE"
    }
Headers 可选

要在 HTTP 请求中使用的标头。

此参数需要 JSON 对象格式的输入。默认值如下：

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

要在 Cookie 标头中使用的参数。

此参数会覆盖 Headers 参数中提供的 Cookie。

此参数需要 JSON 对象格式的输入。默认值如下：

{
    "Cookie_1": "COOKIE_1_VALUE"
    }
Body Payload
 可选

HTTP 请求的正文。该操作会根据 Headers 参数中提供的 Content-Type 标头值构建不同的载荷。

此参数需要 JSON 对象格式的输入，除非第三方产品需要 XML 或 multipart/form-data 内容。如果您使用 API 请求提交或上传文件，请在 Body Payload 参数中提供文件的 base64 编码版本，并将标头设置为 "Content-type": "multipart/form-data"。

默认值为：

{
    "Body Field Name": "BODY_FIELD_VALUE"
    }
Expected Response Values 可选

预期响应值。

如果您配置此参数，相应操作将以异步模式运行，并一直执行，直到收到预期值或达到超时时间。
Save To Case Wall 可选

如果选择此选项，系统会保存文件并将保存的文件附加到支持请求墙上。该文件以 .zip 扩展名归档。.zip 文件未受密码保护。

默认情况下未选中。
Password Protect Zip 可选

如果选择此操作，则会使用 Save To Case Wall 参数为创建的 .zip 文件添加密码。密码如下：infected。

处理可疑文件时，请使用此参数。

此选项将会默认选中。
Follow Redirects 可选

如果选中，则操作会遵循重定向。

此选项将会默认选中。
Fail on 4xx/5xx 可选

如果选择此项，当响应的状态代码为 4xx 或 5xx 错误时，操作会失败。

此选项将会默认选中。
Base64 Output 可选

如果选择此项，相应操作会将响应转换为 base64 格式。

下载文件时使用此参数。

JSON 结果的大小不得超过 15 MB。

默认情况下未选中。
Fields To Return 必需

要返回的字段。可能的值如下：

  • response_data
  • redirects
  • response_code
  • response_cookies
  • response_headers
  • apparent_encoding
Request Timeout 必需

在操作失败之前等待服务器发送数据的时长。

默认值为 120 秒。

操作输出

执行 HTTP 请求操作提供以下输出：

操作输出类型 可用性
案例墙附件 不可用
案例墙链接 不可用
“支持请求墙”表格 不可用
丰富化表 不可用
JSON 结果 可用
输出消息 可用
脚本结果 可用
JSON 结果

以下示例描述了使用执行 HTTP 请求操作时收到的 JSON 结果输出：

{
   "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": "VALUE",
       "Date": "Fri, 03 Nov 2023 16:14:13 GMT",
       "Server": "Google Frontend",
       "Content-Length": "36084"
   },
   "apparent_encoding": "ascii"
}
输出消息

执行 HTTP 请求操作提供以下输出消息：

输出消息 消息说明

Successfully executed API request.

Successfully executed API request, but the status code {4xx/5xx} was returned. Please check the request or try again later.

 操作成功。
Failed to execute API request. Error: ERROR_REASON

操作失败。

检查与服务器的连接、输入参数或凭据。
脚本结果

下表介绍了使用执行 HTTP 请求操作时脚本结果输出的值：

脚本结果名称 值
is_success True 或 False

Ping

使用 Ping 操作测试与 Google Cloud的连接。

此操作不适用于 Google SecOps 实体。

操作输入

无。

操作输出

Ping 操作提供以下输出：

操作输出类型 可用性
案例墙附件 不可用
案例墙链接 不可用
“支持请求墙”表格 不可用
丰富化表 不可用
JSON 结果 可用
输出消息 可用
脚本结果 可用
JSON 结果

以下示例介绍了使用 Ping 操作时收到的 JSON 结果输出：

{
"endpoint": "TEST_URL"
}
输出消息

Ping 操作提供以下输出消息：

输出消息 消息说明
Successfully tested connectivity. 操作成功。
Failed to test connectivity.

操作失败。

检查与服务器的连接、输入参数或凭据。
脚本结果

下表介绍了使用 Ping 操作时脚本结果输出的值：

脚本结果名称 值
is_success True 或 False

需要更多帮助？从社区成员和 Google SecOps 专业人士那里获得解答。