TIPCommon.rest

TIPCommon.rest.auth.build_credentials_from_sa

TIPCommon.rest.auth.build_credentials_from_sa(user_service_account: MutableMapping[str, Any] | None = None, target_principal: str | None = None, source_credentials: Credentials | None = None, quota_project_id: str | None = None, scopes: list[str] | None = None, verify_ssl: bool | None = True, **service_account_attr: Any)→ Credentials

根据服务账号、工作负载身份电子邮件地址或服务账号属性构建凭据对象。

注意 必须提供 user_service_account、target_principal 或 service_account_attr（使用 **kwargs）。否则，系统会引发 EmptyMandatoryValues 异常。

参数

参数
user_service_account SingleJson | None

用户服务账号 JSON。
target_principal str | None

工作负载身份电子邮件地址。
source_credentials google.auth.Credentials | None

用于获取模拟凭据的源凭据。

如果提供了 None，系统会尝试使用应用默认凭据。
quota_project_id str | None

用于配额和结算的项目 ID。
scopes list[str]

Google Cloud 凭据范围。默认值为 ['https://www.googleapis.com/auth/cloud-platform']。
verify_ssl bool

定义是否验证 SSL 证书。

默认值为 True。
service_account_attr dict[str, Any]

解构的服务账号字段的键值对。

可能引发的错误

EmptyMandatoryValues - 如果没有服务账号或工作负载身份电子邮件地址，或者服务账号的必需字段缺失。 google.auth.exceptions.RefreshError - 当凭据无法刷新时。

返回值

凭据对象。

返回类型

service_account.Credentials

TIPCommon.rest.auth.build_credentials_from_sa_attr

TIPCommon.rest.auth.build_credentials_from_sa_attr(account_type: str, project_id: str, private_key_id: str, private_key: str, client_email: str, client_id: str, auth_uri: str, token_uri: str, auth_provider_x509_url: str, client_x509_cert_url: str, scopes: list[str] | None = None, quota_project_id: str | None = None)→ Credentials

根据服务账号属性构建凭据对象。

参数

参数
account_type str

服务账号类型。
project_id str

服务账号项目 ID。
private_key_id str

服务账号私钥 ID。
private_key str

服务账号私钥。
client_email str

服务账号客户端电子邮件地址。
client_id str

服务账号客户端 ID。
auth_uri str

服务账号授权 URI。
token_uri str

服务账号令牌 URI。
auth_provider_x509_url str

服务账号身份验证提供方 x509 证书网址。
client_x509_cert_url str

服务账号客户端 x509 证书网址。
scopes list[str], optional

Google Cloud 凭据范围。默认值为 ['https://www.googleapis.com/auth/cloud-platform']。
quota_project_id str | None

用于配额和结算的项目 ID。

可能引发的错误

EmptyMandatoryValues - 当服务账号的必填字段缺失时。

返回值

凭据对象。

返回类型

service_account.Credentials

TIPCommon.rest.auth.generate_jwt_from_credentials

TIPCommon.rest.auth.generate_jwt_from_credentials(credentials: Credentials, verify_ssl: bool = True)→ bytes

生成 JSON Web 令牌，以使用 REST 访问 Google Cloud API 资源。

参数

参数
credentials google.oauth2.credentials.Credentials

google.oauth2.credentials.Credentials 对象。
verify_ssl bool

定义是否通过 SSL 刷新凭据令牌。

默认值为 True。

返回值

要在 Authorization 标头中使用的 JWT 令牌。

返回类型

bytes

TIPCommon.rest.auth.generate_jwt_from_sa

TIPCommon.rest.auth.generate_jwt_from_sa(service_account, expiry_length=3600, audience=None)

生成 JSON Web 令牌，以使用 REST 访问 Google Cloud API 资源。

参数
service_account str | dict

Google Cloud 具有必要 Identity and Access Management 角色的项目服务账号。
expiry_length int

令牌到期前的时间（以秒为单位）。 默认值为 1 小时。
audience str

Google Cloud 范围。如果未提供，则回退到 https://www.googleapis.com/auth/cloud-platform。

返回值

要在授权标头中使用的 JWT 令牌。

返回类型

bytes

TIPCommon.rest.auth.get_adc

TIPCommon.rest.auth.get_adc(scopes: Sequence[str] | None = None, request: Request | None = None, quota_project_id: str | None = None)→ Tuple[Credentials, str | None]

获取运行时环境的应用默认凭据 (ADC)。 这是 google.auth.default 的封装容器函数。

参数

参数
scopes Sequence[str] | None

相应凭据的范围列表。

如果指定，凭据会在必要时自动确定范围。
request google.auth.transport.Request | None

用于发出 HTTP 请求的对象。此参数用于检测应用是否在 Compute Engine 上运行，或确定工作负载身份池资源（外部账号凭据）的关联项目 ID。

如果未指定，则使用标准库 HTTP 客户端（用于 Compute Engine 凭据）或 google.auth.transport.requests.Request 客户端（用于外部账号凭据）。
quota_project_id str | None

用于配额和结算的项目 ID。

返回值

当前环境的凭据和项目 ID。项目 ID 可能为 None，表示无法从环境中确定项目 ID。

返回类型

Tuple[google.auth.credentials.Credentials, str]

可能引发的错误

google.auth.exceptions.DefaultCredentialsError - 如果未找到凭据，或者找到的凭据无效。

TIPCommon.rest.auth.get_auth_request

TIPCommon.rest.auth.get_auth_request(verify_ssl: bool = True)→ Request

创建对 Google Cloud 资源 API 的授权 HTTP 请求。

参数

参数
verify_ssl bool, optional

验证 SSL 证书。默认值为 True。

返回值

已获授权的请求对象。

返回类型

google.auth.transport.requests.Request

TIPCommon.rest.auth.get_impersonated_credentials

TIPCommon.rest.auth.get_impersonated_credentials(target_principal: str, source_credentials: google.auth.Credentials | None = None, target_scopes: Sequence[str] | None = None, delegates: Sequence[str] | None = None, quota_project_id: str | None = None)→ impersonated_credentials.Credentials

使用 Google Cloud 服务账号模拟获取短期有效的 Credentials 对象。

参数

参数
target_principal str

要模拟的服务账号。
source_credentials google.auth.Credentials | None

用于获取模拟凭据的源凭据。

如果未提供任何凭据，系统会尝试使用应用默认凭据。
target_scopes Sequence[str] | None

在授权授予期间要请求的范围。

如果提供了 None，则使用默认的 https://www.googleapis.com/auth/cloud-platform 范围。
delegates Sequence[str] | None

授予最终访问令牌所需的委托链式列表。

如果设置，身份序列必须具有授予给前一个身份的 Service Account Token Creator 功能。

例如，如果设置为 [serviceAccountB, serviceAccountC]，则 source_credential 必须在 serviceAccountB 上具有 Token Creator 角色。serviceAccountB 必须在 serviceAccountC 上具有 Token Creator。最后，C 必须在 target_principal 上拥有 Token Creator 角色。

如果未设置，source_credential 必须在 target_principal 上具有该角色。
quota_project_id str | None

用于配额和结算的项目 ID。

注意：此项目可能与用于创建凭据的项目不同。

返回值

目标主账号的短期凭据对象。

返回类型

impersonated_credentials.Credentials

TIPCommon.rest.auth.get_secops_siem_tenant_credentials

TIPCommon.rest.auth.get_secops_siem_tenant_credentials(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, target_scopes: Sequence[str] | None = None, quota_project_id: str | None = None)→ Credentials

获取 Google SecOps 实例的 SIEM 租户短期有效的服务账号凭据。

参数

参数
chronicle_soar TIPCommon.types.ChronicleSOAR

Google Security Operations SOAR SDK 对象。
target_scopes Sequence[str] | None

在授权授予期间要请求的范围。
quota_project_id str | None

用于配额和结算的项目 ID。

注意：此项目可能与用于创建凭据的项目不同。

返回值

SIEM 租户的短期有效服务账号凭据。

返回类型

impersonated_credentials.Credentials

class TIPCommon.rest.gcp.GcpErrorReason

类 TIPCommon.rest.gcp.GcpErrorReason

代码库：对象

Google Cloud 错误原因常量命名空间。

常量

  • IAM_PERMISSION_DENIED = 'IAM_PERMISSION_DENIED'

类 TIPCommon.rest.gcp.GcpPermissions

类 TIPCommon.rest.gcp.GcpPermissions

代码库：对象

Google Cloud 权限常量命名空间。

常量

  • IAM_SA_GET_ACCESS_TOKEN = 'iam.serviceAccounts.getAccessToken'

TIPCommon.rest.gcp.extract_project_id_from_sa_email

TIPCommon.rest.gcp.extract_project_id_from_sa_email(service_account_email: str)→ str

从服务账号电子邮件地址中提取项目 ID。

参数

参数
service_account_email str

服务账号电子邮件地址。

返回值

项目 ID。

返回类型

str

可能引发的错误

NotFoundError - 当无法从服务账号电子邮件地址中解析出项目名称时。

TIPCommon.rest.gcp.extract_project_id_from_sa_key

TIPCommon.rest.gcp.extract_project_id_from_sa_key(service_account_json: MutableMapping[str, Any])→ str

从服务账号 JSON 密钥中提取项目 ID。

参数

参数
service_account_json SingleJson

服务账号 JSON 密钥。

返回值

服务账号密钥中的项目 ID 字段。

返回类型

str

可能引发的错误

NotFoundError - 当无法在服务账号密钥中找到“project_id”字段时。

TIPCommon.rest.gcp.get_http_client

TIPCommon.rest.gcp.get_http_client(credentials: Credentials, verify_ssl: bool = True)→ Http | AuthorizedHttp

获取已获授权的 HTTP 客户端。 Google Cloud

参数

参数
credentials service_account.Credentials

Google Cloud Credentials 对象。
verify_ssl bool，可选

验证 SSL 证书。默认值为 True。

返回值

已获授权的 HTTP 客户端。

返回类型

Union[httplib2.Http, google_auth_httplib2.AuthorizedHttp]

TIPCommon.rest.gcp.get_workload_sa_email

TIPCommon.rest.gcp.get_workload_sa_email(default_sa_to_return: str | None = None)→ str

从 Google Cloud 元数据服务器检索工作负载服务账号电子邮件地址。

参数

参数
default_sa_to_return str | None

如果未找到，则返回默认服务账号。

默认值为 None。

返回值

工作负载服务账号电子邮件地址。

返回类型

str

可能引发的错误

GoogleCloudException - 无法获取 GCP Workload 服务账号电子邮件地址时。

TIPCommon.rest.gcp.retrieve_project_id

TIPCommon.rest.gcp.retrieve_project_id(user_service_account: MutableMapping[str, Any] | None = None, service_account_email: str | None = None, default_project_id: str | None = None)→ str | None

从服务账号或工作负载身份电子邮件地址获取项目 ID。

参数

参数
user_service_account SingleJson | None

用户服务账号 JSON。
service_account_email str | None

工作负载身份电子邮件地址。
default_project_id str | None

如果未找到，则返回的默认项目 ID。

如果提供，此函数不会引发 NotFoundError。

默认值为 None。

返回值

服务账号或工作负载身份电子邮件地址的项目 ID。 如果未找到，则返回 None。

返回类型

str | None

可能引发的错误

NotFoundError - 无法从服务账号电子邮件地址中解析出项目名称时。

TIPCommon.rest.gcp.validate_impersonation

TIPCommon.rest.gcp.validate_impersonation(content: dict, default_error_msg: str = 'Service Account Impersonation failed')→ None

验证来自 HTTP 授权响应的服务账号模拟。

参数

参数
content dict

HTTP 授权响应内容。
default_error_msg str, optional

如果未在响应内容中找到，则引发的错误消息。

默认值为 "Service Account Impersonation failed"。

返回值

如果服务账号模拟已获得授权，则为 None。

返回类型

None

可能引发的错误

ImpersonationUnauthorizedError - 当服务账号模拟未获授权时。

TIPCommon.rest.httplib.get_auth_session

TIPCommon.rest.httplib.get_auth_session(service_account, audience=None, verify_ssl=True)

创建与 Google Cloud 资源 API 的授权 HTTP 会话。

参数
service_account str | dict

具有必要 Identity and Access Management 角色的 Google Cloud 项目服务账号。
audience str

Google Cloud 范围。
verify_ssl bool

定义是否创建具有 SSL 加密的会话。

返回值

已获授权的会话对象。

返回类型

requests.Session

可能引发的错误

ValueError - 未提供凭据和服务账号时。

exception TIPCommon.rest.soar_api.SoarApiServerError

基类：Exception

Google Security Operations SOAR 的 API 调用服务器时出现的错误。

TIPCommon.rest.soar_api.batch_set_custom_field_values

TIPCommon.rest.soar_api.batch_set_custom_field_values(chronicle_soar, identifier: int, parent: str, custom_fields_values_mapping: dict[int, list[str]])→ list[CustomFieldValue]

批量设置自定义字段值。

参数

参数
chronicle_soar Google Security Operations SOAR SDK 对象。
identifier int

父标识符。
parent str

自定义字段值的父路径（例如 cases/1、cases/1/alerts/1）。
custom_fields_values_mapping dict[int, list[str]]

自定义字段 ID 到值的映射。

返回值

CustomFieldValue 对象的列表。

返回类型

list[CustomFieldValue]

TIPCommon.rest.soar_api.get_alert_events

TIPCommon.rest.soar_api.get_alert_events(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_id: str | int, alert_identifier: str)→ list[AlertEvent]

获取特定提醒的事件。

参数

参数
chronicle_soar ChronicleSOAR

Google Security Operations SOAR SDK 对象。
case_id str | int

支持请求 ID。示例：13、"41"。
alert_identifier str

提醒的标识符（例如，'{alert.name}_{alert.id}'）。

示例：alert.name=SERVICE_ACCOUNT_USED alert.id=c3b80f09-38d3-4328-bddb-b938ccee0256 identifier=SERVICE_ACCOUNT_USED_c3b80f09-38d3-4328-bddb-b938ccee0256。

返回值

请求的响应 JSON。事件的 JSON 列表。

返回类型

list[SingleJson]

可能引发的错误

requests.HTTPError - 当服务器返回非成功状态代码时。 json.JSONDecodeError - 当返回值不是有效的 JSON 时。

TIPCommon.rest.soar_api.get_case_attachments

TIPCommon.rest.soar_api.get_case_attachments(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_id: int)→ MutableMapping[str, Any]

获取支持请求附件。

参数

参数
chronicle_soar ChronicleSOAR

Google Security Operations SOAR SDK 对象。
case_id int

Google Security Operations SOAR 支持请求 ID。

返回值

表示支持大小写附件的可变映射。

返回类型

MutableMapping[str, Any]

TIPCommon.rest.soar_api.get_case_overview_details

TIPCommon.rest.soar_api.get_case_overview_details(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_id: int | str) → CaseDetails

按支持请求 ID 获取支持请求概览详细信息。

参数
chronicle_soar ChronicleSOAR

Google Security Operations SDK 对象。
case_id int | str

Google Security Operations SOAR 支持请求 ID。

返回值

支持请求详情对象。

返回类型

(CaseDetails)

可能引发的错误

requests.HTTPError - 当请求失败或请求状态不是 200 时。 json.JSONDecoderError - 解析响应失败时。

TIPCommon.rest.soar_api.get_connector_cards

TIPCommon.rest.soar_api.get_connector_cards(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, integration_name: str | None = None, connector_identifier: str | None = None)→ list[ConnectorCard]

获取所有连接器卡片。

参数

参数
chronicle_soar ChronicleSOAR

Google Security Operations SOAR SDK 对象。
integration_name str | None

集成名称。
connector_identifier str | None

连接器 ID。

返回值

所有连接器卡的列表。

返回类型

list[ConnectorCard]

TIPCommon.rest.soar_api.get_entity_data

TIPCommon.rest.soar_api.get_entity_data(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, entity_identifier: str, entity_environment: str, entity_type: str | None = None, last_case_type: int = 0, case_distribution_type: int = 0)→ MutableMapping[str, Any]

提取实体数据。

参数

参数
chronicle_soar ChronicleSOAR

Google Security Operations SOAR SDK 对象。
entity_identifier int

实体标识符。
entity_environment str

实体环境。
entity_type str

实体类型。
last_case_type int

上一个诉求类型。
case_distribution_type int

支持请求分发类型。

返回值

表示实体数据的可变映射。

返回类型

dict

可能引发的错误

requests.HTTPError - 当服务器返回非成功状态代码时。

TIPCommon.rest.soar_api.get_env_action_def_files

TIPCommon.rest.soar_api.get_env_action_def_files(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob)→ list[Dict[str, Any]]

检索环境操作定义文件的列表。

参数
chronicle_soar ChronicleSOAR

Google SecOps SDK 对象。

返回值

表示操作定义文件的 SingleJson 对象列表。

返回类型

(list[SingleJson])

可能引发的错误

requests.HTTPError - 当服务器返回非成功状态代码时。 json.JSONDecodeError - 当返回值不是有效的 JSON 时。

TIPCommon.rest.soar_api.get_federation_cases

TIPCommon.rest.soar_api.get_federation_cases(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob)→ MutableMapping[str, Any]

获取联邦案例。

参数

参数
chronicle_soar ChronicleSOAR

Google Security Operations SOAR SDK 对象。

返回值

响应 JSON。

返回类型

SingleJson

TIPCommon.rest.soar_api.get_full_case_details

TIPCommon.rest.soar_api.get_full_case_details(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_id: int)→ MutableMapping[str, Any]

获取完整的支持请求详细信息。

参数

参数
chronicle_soar ChronicleSOAR

Google Security Operations SOAR SDK 对象。
case_id int

Google Security Operations SOAR 支持请求 ID。

返回值

表示完整案例详情的可变映射。

返回类型

MutableMapping[str, Any]

TIPCommon.rest.soar_api.get_installed_integrations_of_environment

TIPCommon.rest.soar_api.get_installed_integrations_of_environment(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, environment: str, integration_identifier: str | None = None)→ list[InstalledIntegrationInstance]

提取为所提供环境安装的所有集成。

参数

参数
chronicle_soar ChronicleSOAR

Google Security Operations SOAR SDK 对象。
environment str

实例环境列表。
integration_identifier str | None

集成 ID。

返回值

表示集成实例的字典对象列表。

返回类型

list[InstalledIntegrationInstance]

TIPCommon.rest.soar_api.get_installed_jobs

TIPCommon.rest.soar_api.get_installed_jobs(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob)→ list[Dict[str, Any]]

检索环境操作定义文件的列表。

参数
chronicle_soar ChronicleSOAR

Google SecOps SDK 对象。

返回值

表示操作定义文件的 SingleJson 对象列表。

返回类型

(list[SingleJson])

可能引发的错误

requests.HTTPError - 当服务器返回非成功状态代码时。 json.JSONDecodeError - 当返回值不是有效的 JSON 时。

TIPCommon.rest.soar_api.get_integration_full_details

TIPCommon.rest.soar_api.get_integration_full_details(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, integration_identifier: str)→ Dict[str, Any]

检索集成的完整详细信息文件。

参数
chronicle_soar ChronicleSOAR

Google SecOps SDK 对象。
integration_identifier str

集成 ID。

返回值

包含集成完整详细信息的 JSON 响应。

返回类型

(SingleJSON)

可能引发的错误

requests.HTTPError - 当服务器返回非成功状态代码时。 json.JSONDecodeError - 当返回值不是有效的 JSON 时。

TIPCommon.rest.soar_api.get_user_profile_cards

TIPCommon.rest.soar_api.get_user_profile_cards(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, search_term: str = '', requested_page: int = 0, page_size: int = 20, filter_by_role: bool = False, filter_disabled_users: bool = False, filter_support_users: bool = False, fetch_only_support_users: bool = False, filter_permission_types: list[int] = None)→ MutableMapping[str, Any]

按网页和过滤条件检索用户个人资料卡片。

参数

参数
chronicle_soar ChronicleSOAR

Google Security Operations SOAR SDK 对象。
search_term str

搜索字词。
requested_page int

返回用户网页的起始偏移量。
page_size int

要返回的用户数量。
filter_by_role bool

定义是否按角色过滤。
filter_disabled_users bool

定义是否过滤掉已停用的用户。
filter_support_users bool

定义是否过滤掉支持用户。
fetch_only_support_users bool

定义是否仅返回支持用户。
filter_permission_types list[int] | None

过滤条件权限类型列表（例如 0）。

返回值

来自 SOAR 服务器的响应 - 用户个人资料卡片。

返回类型

SingleJson

可能引发的错误

requests.HTTPError - 当服务器返回非成功状态代码时。 json.JSONDecodeError - 当返回值不是有效的 JSON 时。

示例

响应 JSON 的示例：

{
  "objectsList": [
    { "firstName": "string", "lastName": "string", "userName": "string", "accountState": 0 }
  ],
  "metadata": {
    "totalNumberOfPages": 0,
    "totalRecordsCount": 0,
    "pageSize": 0
  }
}

TIPCommon.rest.soar_api.get_workflow_instance_card

TIPCommon.rest.soar_api.get_workflow_instance_card(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_id: int, alert_identifier: str)→ MutableMapping[str, Any]

获取工作流实例卡片。

参数

参数
chronicle_soar ChronicleSOAR

Google Security Operations SOAR SDK 对象。
case_id int

Google Security Operations SOAR 支持请求 ID。
alert_identifier str

Google Security Operations SOAR 提醒 ID。

返回值

表示工作流实例卡的 MutableMapping。

返回类型

MutableMapping[str, Any]

TIPCommon.rest.soar_api.list_custom_field_values

TIPCommon.rest.soar_api.list_custom_field_values(chronicle_soar, parent: str)→ list[CustomFieldValue]

获取支持请求或提醒的自定义字段值。

参数

参数
chronicle_soar ChronicleSOAR

Google Security Operations SOAR SDK 对象。
parent str

自定义字段值的父级路径（例如：cases/1、cases/1/alerts/1）。

返回值

支持请求详情对象。

返回类型

list[CustomFieldValue]

可能引发的错误

requests.HTTPError - 当请求失败或请求状态不是 200 时。 json.JSONDecoderError - 解析响应失败时。

TIPCommon.rest.soar_api.list_custom_fields

TIPCommon.rest.soar_api.list_custom_fields(chronicle_soar, filter_: str | None = None)→ list[CustomField]

列出自定义字段。

参数

参数
chronicle_soar ChronicleSOAR

Google Security Operations SOAR SDK 对象。
filter_ str | None

搜索的过滤条件值。

返回值

支持请求详情对象。

返回类型

list[CustomField]

可能引发的错误

requests.HTTPError - 当请求失败或请求状态不是 200 时。 json.JSONDecoderError - 解析响应失败时。

TIPCommon.rest.soar_api.remove_case_tag

TIPCommon.rest.soar_api.remove_case_tag(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_id: int, tag: str, alert_identifier: str | None = None)→ None

移除支持请求标记。

参数

参数
chronicle_soar ChronicleSOAR

Google Security Operations SOAR SDK 对象。
case_id int

Google Security Operations SOAR 支持请求 ID。
tag str

要移除的标记。
alert_identifier str | None

{The {google_secops_soar_name}} 提醒 ID。

返回值

无。

返回类型

None

可能引发的错误

requests.HTTPError - 当服务器返回非成功状态代码时。

TIPCommon.rest.soar_api.save_attachment_to_case_wall

TIPCommon.rest.soar_api.save_attachment_to_case_wall(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, attachment_data: CaseWallAttachment)→ MutableMapping[str, Any]

将文件直接保存到支持请求墙。

参数

参数
chronicle_soar ChronicleSOAR

Google Security Operations SOAR SDK 对象。
attachment_data CaseWallAttachment

CaseWallAttachment 对象。

返回值

表示 API 响应的可变映射。

返回类型

MutableMapping[str, Any]

TIPCommon.rest.soar_api.set_alert_priority

TIPCommon.rest.soar_api.set_alert_priority(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_id: int, alert_identifier: str, alert_name: str, priority: int)→ None

设置提醒优先级。

参数

参数
chronicle_soar ChronicleSOAR

Google Security Operations SOAR SDK 对象。
case_id int

Google Security Operations SOAR 支持请求 ID。
alert_identifier str

Google Security Operations SOAR 提醒 ID。
alert_name str

Google Security Operations SOAR 提醒名称。
priority int

Google Security Operations SOAR 优先级枚举值。

返回值

无。

返回类型

None

可能引发的错误

requests.HTTPError - 当服务器返回非成功状态代码时。

TIPCommon.rest.soar_api.set_case_score_bulk

TIPCommon.rest.soar_api.set_case_score_bulk(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_score_mapping: list[dict[str, int | float]])→ MutableMapping[str, Any]

批量设置支持请求得分。

参数

参数
chronicle_soar ChronicleSOAR

Google Security Operations SOAR SDK 对象。
case_score_mapping list[dict[str, int | float]]

Google Security Operations SOAR 案例 ID 到得分的映射。

返回值

包含成功状态的 JSON 响应，以及（如果适用）失败的测试用例列表。

返回类型

MutableMapping[str, Any]

可能引发的错误

requests.HTTPError - 当服务器返回非成功状态代码时。

示例

{
  case_score_mapping = [
  {
    "caseId": 1, "score": 1.0
  }

]
}

TIPCommon.rest.soar_api.set_custom_field_values

TIPCommon.rest.soar_api.set_custom_field_values(chronicle_soar: ChronicleSOAR, parent: str, custom_field_id: int, values: list[str])→ CustomFieldValue

设置自定义字段值。

参数

参数
chronicle_soar ChronicleSOAR

Google Security Operations SOAR SDK 对象。
parent str

自定义字段值的父路径，例如：cases/1、cases/1/alerts/1。
custom_field_id int

自定义字段 ID。
values list[str]

要设置的自定义字段值列表。

返回值

CustomFieldValue 对象。

返回类型

CustomFieldValue

TIPCommon.rest.soar_api.validate_response

TIPCommon.rest.soar_api.validate_response(response: Response, validate_json: bool = False) → None

验证响应并以 JSON 格式返回。

参数
response requests.Response

要验证的响应。

可能引发的错误

HTTPError - 当响应状态代码指示失败时。

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