data_models モジュール

このモジュールには、次のものを表すデータクラスが含まれています。

• データモデル
• アラート
• 変数コンテナ
• 一般的なパラメータ
• コネクタ パラメータ

class TIPCommon.data_models.AlertCard

クラス TIPCommon.data_models.AlertCard(id_: int, creation_time_unix_time_ms: int, modification_time_unix_time_ms: int, identifier: str, status: int, name: str, priority: [AlertPriority](#TIPCommon.data_models.AlertPriority) | int | None, workflow_status: int | None, sla_expiration_unix_time: int | None, sla_critical_expiration_unix_time: int | None, start_time: int, end_time: int, alert_group_identifier: str, events_count: int, title: str, rule_generator: str, device_product: str, device_vendor: str, playbook_attached: bool | None, playbook_run_count: int | None, is_manual_alert: bool | None, sla: [SLA](#TIPCommon.data_models.SLA) | None, fields_groups: list[[FieldsGroup](#TIPCommon.data_models.FieldsGroup)], source_url: str | None, source_rule_url: str | None, siem_alert_id: str | None, additional_properties: str | None, case_id: int | None, ticket_id: str | None, closure_details: MutableMapping[str, Any] | None, event_count: int | None = None, product_families: list[str] | None = None, entity_cards: list[MutableMapping[str, Any]] | None = None, security_event_cards: list[MutableMapping[str, Any]] | None = None, involved_relations: list[MutableMapping[str, Any]] | None = None)

ベース: オブジェクト

AlertCard はアラートの概要カードを表し、プラットフォーム内の可視化と追跡に使用される重要なメタデータとステータス インジケーターをカプセル化します。

メソッド

次のメソッドは、構造化データからのアラートカードのシリアル化と再構築を容易にします。

メソッド
from_json()	from_json(alert_card_json: dict[str, Any]) → AlertCard JSON 辞書から AlertCard インスタンスを作成するクラスメソッド。
to_json()	to_json() → MutableMapping[str, Any] AlertCard オブジェクトを JSON シリアル化可能な辞書形式に変換します。

属性

次の表に、アラートに関連付けられた主な構造属性と複雑なデータモデルを示します。

属性
fields_groups	list[FieldsGroup] アラートに関連付けられたグループ化されたフィールドのリスト。UI での構造化データの表示に使用されます。
sla	SLA アラートの対応と解決のタイムフレームを定義するサービスレベル契約オブジェクト。

class TIPCommon.data_models.AlertEvent

クラス TIPCommon.data_models.AlertEvent(fields: list[EventPropertyField], identifier: str, case_id: int, alert_identifier: str, name: str, product: str, port: str | None, source_system_name: str, outcome: str | None, time: int, type_: str, artifact_entities: list[str])

ベース: オブジェクト

AlertEvent は、アラートに関連付けられた個々のイベントを表し、特定のテレメトリー データ、フィールド プロパティ、エンティティ関係が含まれます。

メソッド

次のメソッドは、構造化された JSON データからイベント オブジェクトを再構築するのに役立ちます。

メソッド
from_json()	from_json(event_json: MutableMapping[str, Any]) → AlertEvent 属性を表す JSON 辞書から AlertEvent インスタンスを作成するクラスメソッド。

属性

次の表に、イベントに関連付けられた主な構造属性と複雑なデータモデルを示します。

属性
fields	list[EventPropertyField] イベントに固有のプロパティ フィールドのリスト。固有のデータポイントを定義します。
artifact_entities	list[str] イベント テレメトリーから抽出されたエンティティ識別子のリスト。

class TIPCommon.data_models.AlertPriority

クラス TIPCommon.data_models.AlertPriority(value)

ベース: Enum

AlertPriority は、プラットフォーム内でアラートを分類して優先順位を付けるために使用される、標準化された整数ベースの重大度レベルを定義します。

定数

次の定数は、アラートに割り当てられた特定の優先度値を表します。

定数
CRITICAL	100
HIGH	80
MEDIUM	60
LOW	40
UNCHANGED	0
INFORMATIVE	-1

class TIPCommon.data_models.AttachmentMetadata

クラス TIPCommon.data_models.AttachmentMetadata(raw_data: SingleJson)

ベース: オブジェクト

AttachmentMetadata は、ファイル添付に関連付けられた説明データとプロパティをカプセル化し、構造化されたデータの変換と取得のためのメソッドを提供します。

メソッド

次のメソッドは、JSON ペイロードからケース オブジェクトを再構築する標準化された方法を提供します。

メソッド
from_json()	from_json(result_data: MutableMapping[str, Any]) → Self 提供されたメタデータ プロパティのディクショナリを使用して新しい AttachmentMetadata インスタンスを初期化するクラスメソッド。
to_json()	to_json() → MutableMapping[str, Any] AttachmentMetadata オブジェクトを JSON 互換の辞書形式にシリアル化します。

属性

次の表は、添付ファイルのメタデータ プロパティの保存に使用される主なデータ構造を示しています。

属性
raw_data	MutableMapping[str, Any] ソースから受信した未加工のメタデータ属性を含む基盤となる辞書。

class TIPCommon.data_models.BaseAlert

クラス TIPCommon.data_models.BaseAlert(raw_data, alert_id)

ベース: オブジェクト

BaseAlert は、一般的なセキュリティ アラートを表す基盤モデルです。この構造により、一意のプラットフォーム ID とともに未加工のテレメトリーを保存するための標準化された構造が提供されます。

メソッド

次のメソッドを使用すると、アラートを標準形式にシリアル化できます。

メソッド
to_json()	to_json() → dict[str, Any] アラートを json.loads() によって返される JSON シリアル化可能な辞書に変換します。

属性

次の表に、このモデルで管理されるコア データポイントを示します。

属性
raw_data	dict[str, Any] アラートに関連付けられた未加工のデータ ペイロード。
alert_id	Any アラートに割り当てられた一意の識別子。

例

次の例は、BaseAlert を初期化し、その生データとシリアル化された出力にアクセスする方法を示しています。

>>> from data_models import BaseAlert
>>> alert = BaseAlert({'foo': 'bar'}, 100)
>>> alert.raw_data
{'foo': 'bar'}
>>> alert.alert_id
100
>>> alert.to_json()
{'foo': 'bar'}

class TIPCommon.data_models.BaseDataModel

クラス TIPCommon.data_models.BaseDataModel(raw_data)

ベース: オブジェクト

BaseDataModel は、ライブラリ内のさまざまなデータ構造の親クラスとして機能し、未加工の入力データとシリアル化の一貫した処理を保証します。

メソッド

次のメソッドは、JSON オペレーションと互換性のある形式で元データが取得されるようにします。

メソッド
to_json()	to_json() → dict[str, Any] モデルに保存されている未加工データをディクショナリ形式にシリアル化します。

属性

次の表に、ベースモデルのプライマリ データ ストレージを示します。

属性
raw_data	dict[str, Any] モデルの初期化に使用された元の生データ ペイロード。

例

次の例は、データモデルの基本的な初期化とシリアル化メソッドの使用方法を示しています。

>>> from data_models import BaseDataModel
>>> data = BaseDataModel({'foo': 'bar'})
>>> data.raw_data
{'foo': 'bar'}
>>> data.to_json()
{'foo': 'bar'}

class TIPCommon.data_models.CaseDataStatus

クラス TIPCommon.data_models.CaseDataStatus(value)

ベース: Enum

CaseDataStatus は、プラットフォーム内のケースでサポートされている運用ステータスを定義します。これには、最初の取り込みから最終的なクローズまたは統合までの範囲が含まれます。

定数

次の定数は、ケースデータに割り当てられた特定のステータス インジケーターを表します。

定数
NEW	0
OPENED	1
CLOSED	2
ALL	3
MERGED	4
CREATION_PENDING	5

class TIPCommon.data_models.CaseDetails

ベース: オブジェクト

CaseDetails は、状態チェック プロパティやケースデータの再構築またはシリアル化のためのメソッドなど、セキュリティ ケースの包括的なビューを提供します。

メソッド

次のメソッドは、オブジェクト インスタンスと構造化 JSON 形式の間でケースの詳細の変換を管理します。

メソッド
from_json()	from_json(case_details_json: MutableMapping[str, Any]) → CaseDetails ケース属性のディクショナリから CaseDetails インスタンスを初期化するクラスメソッド。
to_json()	to_json(include_activities: bool = False) → MutableMapping[str, Any] CaseDetails オブジェクトを JSON シリアル化可能なディクショナリに変換します。ケース アクティビティ ログを含めるには、include_activities を True に設定します。

属性

次のプロパティは、ケースの現在の状態に関する論理インジケーターを提供します。

属性
is_closed	bool ケースが閉じている状態かどうかを示すブール値のプロパティ。
is_open	bool ケースがアクティブかオープンかを示すブール値のプロパティ。

class TIPCommon.data_models.CaseOverviewInfo

クラス TIPCommon.data_models.CaseOverviewInfo(id: 'int', create_time_ms: 'int', update_time_ms: 'int', display_id: 'str', display_name: 'str', alert_count: 'int', stage: 'str', priority: 'CasePriority', important: 'bool', description: 'str | None' = None, type: 'int | None' = None, assignee_full_name: 'str | None' = None, environment_data: 'EnvironmentData | None' = None, status: 'CaseDataStatus | None' = None, score: 'int | None' = None, case_sla: 'CaseSLAInfo | None' = None, alerts_sla: 'CaseSLAInfo | None' = None, incident: 'bool | None' = None, has_suspicious_entity: 'bool | None' = None, workflow_status: 'int | None' = None, tags: 'list[str]' = <factory>, products: 'list[str]' = <factory>, touched: 'bool | None' = None, merged: 'bool | None' = None, has_incident: 'bool | None' = None, alert_names: 'list[str]' = <factory>)

ベース: オブジェクト

CaseOverviewInfo は、セキュリティ ケースの概要を提供します。メタデータ、サービスレベル契約（SLA）のステータス、ダッシュボードとキュー管理に使用される組織の詳細を集約します。

メソッド

次のメソッドを使用すると、構造化された JSON データからケースの概要オブジェクトを簡単に再構築できます。

メソッド
from_json()	from_json(json_data: MutableMapping[str, Any]) → CaseOverviewInfo ケースの概要属性のディクショナリから CaseOverviewInfo インスタンスを初期化するクラスメソッド。

属性

次の表に、ケースの概要に関連する主な構造属性、列挙型、主要な運用指標を示します。

属性
priority	CasePriority ケースに割り当てられた重大度レベル。
status	CaseDataStatus | None ケースデータの現在の運用ステータス。
workflow_status	int | None プラットフォームの自動ワークフロー エンジン内の現在のステップまたは状態。
score	int | None ケースに割り当てられたリスクまたは重要度のスコア。
case_sla	CaseSLAInfo | None ケース解決ライフサイクルに固有の SLA 追跡情報。
alerts_sla	CaseSLAInfo | None ケースに含まれる個々のアラートの SLA 追跡情報。
environment_data	EnvironmentData | None ケースの発生元の特定の組織環境に関するメタデータ。
tags	list[str] ケースに関連付けられているユーザー定義ラベルまたはシステム生成ラベルのリスト。

class TIPCommon.data_models.CasePriority

クラス TIPCommon.data_models.CasePriority(value)

ベース: Enum

CasePriority は、プラットフォーム内でケースを分類して優先順位を付けるために使用される、標準化された整数ベースの重大度レベルを定義します。

定数

次の定数は、ケースに割り当てられた特定の優先度値を表します。

定数
CRITICAL	100
HIGH	80
MEDIUM	60
LOW	40
UNCHANGED	0
INFORMATIVE	-1

class TIPCommon.data_models.CaseSLAInfo

クラス TIPCommon.data_models.CaseSLAInfo(expiration_time_ms: int | None = None, critical_expiration_time_ms: int | None = None, expiration_status: int | None = None, last_pause_remaining_time_ms: int | None = None)

ベース: オブジェクト

CaseSLAInfo は、サービスレベル契約（SLA）の追跡データをカプセル化し、期限のタイムスタンプとステータス インジケーターを提供して、インシデントへのタイムリーな対応を保証します。

メソッド

次のメソッドを使用すると、構造化された JSON データから SLA 情報オブジェクトを作成できます。

メソッド
from_json()	from_json(json_data: MutableMapping[str, Any]) → CaseSLAInfo SLA 属性のディクショナリから CaseSLAInfo インスタンスを初期化するクラスメソッド。

属性

次の表に、ケースの期限をモニタリングするために使用される主なタイミングとステータスの属性を示します。

属性
expiration_time_ms	int | None 標準 SLA の有効期限が切れる UNIX タイムスタンプ（ミリ秒単位）。
critical_expiration_time_ms	int | None クリティカルな SLA しきい値に達したときの Unix タイムスタンプ（ミリ秒単位）。
expiration_status	int | None SLA の現在のステータスを表す整数インジケーター。
last_pause_remaining_time_ms	int | None 最後に一時停止された時点での SLA クロックの残り時間。

class TIPCommon.data_models.CaseWallAttachment

クラス TIPCommon.data_models.CaseWallAttachment(name, file_type, base64_blob, is_important, case_id=None, description=None)

ベース: オブジェクト

CaseWallAttachment は、ケースの証拠ウォールに添付されたファイルまたはデータ オブジェクトを表します。これには、base64 形式の未加工のコンテンツと関連するメタデータが含まれます。

属性

次の表に、添付ファイルに関連付けられた主なプロパティとコンテンツ データを示します。

属性
name	str 添付ファイルのファイル名または表示名。
file_type	str 添付データの形式を示す MIME タイプまたはファイル拡張子。
base64_blob	str ファイルの実際のコンテンツ（Base64 文字列としてエンコード）。
is_important	bool 添付ファイルが調査の重要な証拠としてマークされているかどうかを示すフラグ。

class TIPCommon.data_models.ConnectorCard

クラス TIPCommon.data_models.ConnectorCard(integration, display_name, identifier, is_enabled, is_remote, status)

ベース: オブジェクト

ConnectorCard は、特定のコネクタの構成の概要を提供します。

プラットフォーム内の現在の運用状態。

メソッド

次のメソッドを使用すると、構造化された JSON データからコネクタカード インスタンスを簡単に作成できます。

メソッド
from_json()	from_json(connector_card_json: MutableMapping[str, Any]) → ConnectorCard コネクタ属性のディクショナリから ConnectorCard インスタンスを初期化するクラスメソッド。

属性

次の表に、コネクタの運用ステータスと識別プロパティを示します。

属性
status	ConnectorConnectivityStatusEnum コネクタの現在の接続ステータスと健全性ステータス。
is_enabled	bool コネクタがアクティブでデータを処理しているかどうかを示します。

class TIPCommon.data_models.ConnectorConnectivityStatusEnum

クラス TIPCommon.data_models.ConnectorConnectivityStatusEnum(value)

ベース: Enum

ConnectorConnectivityStatusEnum は、コネクタの接続状態を定義し、ターゲット統合と正常に通信しているかどうかを示します。

定数

次の定数は、コネクタの接続の健全性ステータスを表します。

定数
LIVE	0
NO_CONNECTIVITY	1

class TIPCommon.data_models.ConnectorParamTypes

クラス TIPCommon.data_models.ConnectorParamTypes(value)

ベース: Enum

ConnectorParamTypes は、コネクタ構成パラメータでサポートされているデータ型を定義します。これらの型により、プラットフォームの設定内で適切な検証と UI レンダリングが保証されます。

定数

次の定数は、パラメータで使用可能な特定のデータ型を表します。

定数
BOOLEAN	0（ブール値の切り替え）
INTEGER	1（数値整数）
STRING	2（標準テキスト文字列）
PASSWORD	3（マスクされたパスワード フィールド）
IP	4（IP アドレス）
HOST	5（ホスト名）
URL	6（URL 文字列）
DOMAIN	7（ドメイン名）
EMAIL	8（メールアドレス）
SCRIPT	12（以前のスクリプト パラメータ）
NULL	-1（パラメータのタイプが無効）

class TIPCommon.data_models.ConnectorParameter

クラス TIPCommon.data_models.ConnectorParameter(raw_param)

ベース: パラメータ

ConnectorParameter は、コネクタの個々の構成設定を表します。ベース パラメータ モデルを拡張して、検証タイプや必須要件などの特定のメタデータを含めます。

属性

次のプロパティは、コネクタ パラメータの構成の詳細と制約へのアクセスを提供します。

属性
name	str コネクタ構成内でパラメータを識別するために使用される一意の名前。
value	Any パラメータに割り当てられている現在の値。
type	ConnectorParamTypes 検証と UI レンダリングに使用されるパラメータのデータ型。
mode	int パラメータの動作モードまたは可視性設定。
is_mandatory	bool コネクタを保存または実行する前に、このパラメータに値を指定する必要があるかどうかを示します。

例

次の例は、未加工の辞書を使用して ConnectorParameter を初期化し、そのプロパティにアクセスする方法を示しています。

>>> from data_models import ConnectorParameter, ConnectorParamTypes
>>> p = ConnectorParameter({
    'param_name': 'api_root',
    'type': ConnectorParamTypes.STRING,
    'param_value': '[http://foo.bar](http://foo.bar)',
    'is_mandatory': True,
    'mode': 0
    })
>>> print(p)
ConnectorParameter(name='api_root', value='[http://foo.bar](http://foo.bar)', type=2, mode=0, is_mandatory=True)

class TIPCommon.data_models.Container

クラス TIPCommon.data_models.Container()

ベース: オブジェクト

Container は、変数を属性として保存するための汎用的な動的オブジェクトとして機能します。プラットフォームのさまざまなコンポーネント間で任意のデータ コレクションを渡す場合に便利です。

例

次の例は、コンテナを初期化し、変数を動的に割り当てて取得する方法を示しています。

>>> from data_models import Container
>>> container = Container()
>>> container.one = 1
>>> container.one
1

class TIPCommon.data_models.CreateEntity

クラス TIPCommon.data_models.CreateEntity(case_id, alert_identifier, entity_type, entity_identifier, entity_to_connect_regex, types_to_connect=None, is_primary_link=False, is_directional=False)

ベース: オブジェクト

CreateEntity は、新しいエンティティを作成して既存のケースとアラートにリンクするために必要な手順をカプセル化します。これには、正規表現ベースの接続とリレーションシップのマッピングのロジックが含まれます。

メソッド

次のメソッドは、エンティティ作成手順をプラットフォーム互換形式に変換します。

メソッド
to_json()	to_json() → MutableMapping[str, Any] CreateEntity オブジェクトを JSON シリアル化可能なディクショナリに変換します。

属性

次の表に、新しいエンティティとそのプラットフォーム内の関係を定義するために使用される主なプロパティを示します。

属性
case_id	int エンティティが作成されるケースの一意の識別子。
alert_identifier	str このエンティティが関連付けられているアラートの ID。
entity_type	str エンティティの分類。
entity_identifier	str エンティティを識別する特定の値または名前。
entity_to_connect_regex	str このエンティティに接続する他のエンティティを識別するために使用される正規表現。
types_to_connect	list[str] | None 正規表現に基づいて接続可能なエンティティ タイプの特定のリスト。
is_primary_link	bool この接続がエンティティ間の主関係を表すかどうかを示します。
is_directional	bool 接続に定義された方向（送信元からターゲット）があるか、双方向であるかを判断します。

class TIPCommon.data_models.CustomField

クラス TIPCommon.data_models.CustomField(id, display_name, description, type, scopes)

ベース: オブジェクト

CustomField は、プラットフォーム内のユーザー定義のデータ フィールドを表します。組織の要件に合わせて調整された特定のメタデータを追加することで、標準データモデルを拡張できます。

メソッド

次のメソッドを使用すると、構造化された JSON データからカスタム フィールド オブジェクトを再構築できます。

メソッド
from_json()	from_json(json_data: MutableMapping[str, Any]) → CustomField フィールド属性のディクショナリから CustomField インスタンスを初期化するクラスメソッド。

属性

次の表に、カスタム フィールドの主なプロパティとスコープ制約を示します。

属性
id	int カスタム フィールドの固有識別子。
display_name	str プラットフォーム UI に表示される人が読める形式のラベル。
type	str フィールドのデータ型。
scopes	list[CustomFieldScope] このフィールドが使用可能なアプリケーション領域のリスト

class TIPCommon.data_models.CustomFieldScope

クラス TIPCommon.data_models.CustomFieldScope(value)

ベース: Enum

CustomFieldScope は、プラットフォーム階層内でカスタム フィールドが適用される有効なターゲットを定義します。

メソッド

次のメソッドは、スコープ付きオブジェクトのパスを解決するためのユーティリティを提供します。

メソッド
build_parent_path()	build_parent_path(identifier: int) → str 指定された親オブジェクト ID の内部プラットフォーム パスを構築します。

定数

次の定数は、カスタム フィールドで使用できる特定のスコープを表します。

定数
ALERTS	'Alert'
CASE	'Case'

class TIPCommon.data_models.CustomFieldValue

クラス TIPCommon.data_models.CustomFieldValue(custom_field_id, values, scope, identifier)

ベース: オブジェクト

CustomFieldValue は、カスタム フィールド インスタンスに割り当てられた特定のデータを表します。フィールド定義を、ユーザーまたは自動プロセスによって提供される実際のコンテンツにリンクします。

メソッド

次のメソッドは、構造化された JSON データからカスタム フィールド値を再構築するのに役立ちます。

メソッド
from_json()	from_json(json_data: MutableMapping[str, Any]) → CustomFieldValue 値属性のディクショナリから CustomFieldValue インスタンスを初期化するクラスメソッド。

属性

次の表に、カスタム フィールド値の主なプロパティとコンテキスト識別子を示します。

属性
custom_field_id	int この値が属する CustomField 定義の識別子。
values	list[str] フィールドに保存されている実際のデータを表す文字列のリスト。
scope	CustomFieldScope この特定の値が適用されるアプリケーション領域。
identifier	int この値を保持する特定のオブジェクトの一意の識別子。

class TIPCommon.data_models.DataAccessContext

クラス TIPCommon.data_models.DataAccessContext(global_access, assigned_scopes)

ベース: オブジェクト

DataAccessContext は、ユーザーまたはプロセスの権限と可視性の制約を定義し、実行中にアクセス可能なデータスコープを決定します。

メソッド

次のメソッドは、オブジェクト インスタンスと JSON 形式間のアクセス コンテキスト データの変換を管理します。

メソッド
from_json()	from_json(json_data: MutableMapping[str, Any]) → DataAccessContext アクセス プロパティのディクショナリから DataAccessContext インスタンスを初期化するクラスメソッド。
to_json()	to_json() → dict DataAccessContext オブジェクトを辞書形式に変換します。

属性

次の表に、コンテキスト内で定義されている主なアクセス制御を示します。

属性
global_access	bool コンテキストですべてのデータスコープにわたる無制限のアクセスが許可されているかどうかを示します。
assigned_scopes	list[Any] アクセス権が明示的に付与されている特定のスコープまたは組織部門のリスト。

class TIPCommon.data_models.DatabaseContextType

クラス TIPCommon.data_models.DatabaseContextType(value)

ベース: Enum

DatabaseContextType は、データベース インタラクションのオペレーション コンテキストを指定し、データがプラットフォームの正しい論理セグメントから永続化または取得されるようにします。

定数

次の定数は、データベース オペレーションが発生するプラットフォームの特定の領域を表します。

定数
GLOBAL	0（グローバル システム全体のコンテキスト）
CASE	1（特定のセキュリティ ケースのコンテキスト）
ALERT	2（個々のアラートのコンテキスト）
JOB	3（スケジュール設定されたジョブまたは自動化コンテキスト）
CONNECTOR	4（データコネクタ コンテキスト）

class TIPCommon.data_models.DynamicParameter

クラス TIPCommon.data_models.DynamicParameter(key: str, value: str)

ベース: オブジェクト

DynamicParameter は、システム コンポーネント間でランタイム構成やカスタム メタデータを渡すために使用される柔軟な Key-Value ペアを表します。

メソッド

次のメソッドは、構造化された JSON データからの動的パラメータの再構築を処理します。

メソッド
from_json()	from_json(json_data: MutableMapping[str, Any]) → DynamicParameter キーと値のプロパティのディクショナリから DynamicParameter インスタンスを初期化するクラスメソッド。

属性

次の表に、動的パラメータのプロパティを示します。

属性
key	str パラメータの名前または識別子。
value	str キーに関連付けられたデータ コンテンツ。

class TIPCommon.data_models.EmailTemplate

クラス TIPCommon.data_models.EmailTemplate(template_type, name, content, creator_user_name, for_migration, environments, _id, creation_time_unix_time_in_ms, modification_time_unix_time_in_ms)

ベース: オブジェクト

EmailTemplate は、プラットフォーム内の通知とレポートに使用される標準化された通信形式を表します。メッセージのコンテンツ、メタデータ、環境制約をカプセル化します。

メソッド

次のメソッドは、メール テンプレートのシリアル化と再構築を管理します。

メソッド
from_json()	from_json(data: MutableMapping[str, Any]) → EmailTemplate テンプレート データを含むディクショナリから EmailTemplate インスタンスを初期化するクラスメソッド。
to_json()	to_json() → dict EmailTemplate オブジェクトを JSON シリアル化可能な辞書形式に変換します。

属性

次の表に、メール テンプレートの主なプロパティと構造データを示します。

属性
content	str メール テンプレートの本文テキストまたは HTML 構造。
environments	list[str] このテンプレートを使用できる組織環境のリスト。
template_type	int | str テンプレートの分類またはカテゴリ。

class TIPCommon.data_models.Entity

クラス TIPCommon.data_models.Entity(raw_data, case_id, entity_type, enriched, artifact, vulnerable, suspicious, attacker, pivot, internal, manually_created, fields)

ベース: オブジェクト

エンティティは、セキュリティ ケース内の特定のオブザーバブルまたは対象オブジェクト（IP アドレス、ファイル ハッシュ、ユーザーなど）を表します。調査におけるエンティティの役割やリスクレベルを示す、未加工のテレメトリーとさまざまなブール値の「タグ」の両方を追跡します。

メソッド

次のメソッドは、エンティティ オブジェクトのシリアル化と再構築を管理します。

メソッド
from_json()	from_json(entity_response: MutableMapping[str, Any]) → Entity エンティティのテレメトリーとフラグを含むディクショナリから Entity インスタンスを初期化するクラスメソッド。
to_json()	to_json() → MutableMapping[str, Any] Entity オブジェクトを JSON シリアル化可能な辞書形式に変換します。

属性

次の表に、エンティティに関連付けられた主な分類フラグとデータ構造を示します。

属性
entity_type	str | None エンティティのカテゴリ。
suspicious	bool システム ロジックまたは外部インテリジェンスによってエンティティが潜在的に悪意のあるものとしてフラグ設定されているかどうかを示します。
vulnerable	bool エンティティに既存のセキュリティ上の脆弱性があることがわかっているかどうかを示します。
attacker	bool エンティティが悪意のあるアクティビティのソースとして特定された場合にフラグが設定されます。
internal	bool エンティティが組織の内部ネットワークまたはインフラストラクチャに属しているかどうかを示します。
fields	list[MutableMapping[str, Any]] エンティティに関連付けられた追加のプロパティまたは拡充されたデータポイントのリスト。

class TIPCommon.data_models.EntityCard

クラス TIPCommon.data_models.EntityCard(identifier, entity_type, is_suspicious, linked_entities)

ベース: オブジェクト

EntityCard は、エンティティの概要ビューを表します。通常、UI コンポーネントに使用されます。エンティティの識別、タイプ、他のエンティティとの関係を簡略化された構造で集約します。

メソッド

次のメソッドは、エンティティ カードのシリアル化と再構築を管理します。

メソッド
from_json()	from_json(entity_data: MutableMapping[str, Any]) → EntityCard エンティティの概要データのディクショナリから EntityCard インスタンスを初期化するクラスメソッド。
to_json()	to_json() → MutableMapping[str, Any] EntityCard オブジェクトを JSON シリアル化可能な辞書形式に変換します。

属性

次の表に、カード内のエンティティの識別とリンクに使用される主なプロパティを示します。

属性
identifier	str エンティティを識別する一意の値または名前。
entity_type	str エンティティの分類カテゴリ。
is_suspicious	str エンティティの不審なステータスを表す文字列インジケーター（通常は True または False）。
linked_entities	list[str] この特定のエンティティ カードに関連する他のエンティティの ID のリスト。

class TIPCommon.data_models.EnvironmentData

クラス TIPCommon.data_models.EnvironmentData(environment, dynamic_parameters=<factory>, base64_image=None, platform=None)

ベース: オブジェクト

EnvironmentData は、特定の組織環境の構成情報とブランディング情報をカプセル化します。これには、マルチテナントまたはマルチ環境のデプロイで使用される環境固有のパラメータとビジュアル アセットが含まれます。

メソッド

次のメソッドを使用すると、構造化された JSON データから環境データ オブジェクトを簡単に作成できます。

メソッド
from_json()	from_json(json_data: MutableMapping[str, Any]) → EnvironmentData 環境プロパティのディクショナリから EnvironmentData インスタンスを初期化するクラスメソッド。

属性

次の表に、環境に関連付けられている構成パラメータとブランディング アセットを示します。

属性
environment	str 組織環境の名前。
dynamic_parameters	list[DynamicParameter] この環境の構成に固有のカスタム Key-Value ペアのリスト。
base64_image	str | None 環境のロゴまたはアイコンを表す、base64 でエンコードされた文字列（省略可）。
platform	int | None 特定のプラットフォームまたはインフラストラクチャ プロバイダを表す整数識別子。

class TIPCommon.data_models.EventCard

クラス TIPCommon.data_models.EventCard(case_id, alert_identifier, event_id, name, time, product, port, outcome, artifact_entities, fields)

ベース: オブジェクト

EventCard は、特定のセキュリティ イベントの簡潔で視覚的にわかりやすい概要を表します。調査用ダッシュボードやイベントキューで使用するために、タイミング、ソース プロダクト、結果などの最も重要なテレメトリーを表面化するように設計されています。

メソッド

次のメソッドは、オブジェクト インスタンスと JSON 形式の間でイベントカード データの変換を管理します。

メソッド
from_json()	from_json(event_data: MutableMapping[str, Any]) → EventCard イベント属性のディクショナリから EventCard インスタンスを初期化するクラスメソッド。
to_json()	to_json() → MutableMapping[str, Any] EventCard オブジェクトを JSON シリアル化可能な辞書形式に変換します。

属性

次の表は、イベントカードに保存されている主なテレメトリーと組織 ID を示しています。

属性
event_id	str 特定のイベント レコードの一意の識別子。
time	int イベントが発生した日時を表す Unix タイムスタンプ。
product	str イベント テレメトリーを生成したセキュリティ プロダクトまたはツール。
outcome	str イベントの記録された結果。
artifact_entities	list[MutableMapping[str, Any]] イベント テレメトリー内で特定されたエンティティのリスト。ケースのアーティファクトとして機能します。
fields	list[MutableMapping[str, Any]] このイベントのデータ ペイロードに固有の追加の Key-Value プロパティのコレクション。

class TIPCommon.data_models.EventPropertyField

クラス TIPCommon.data_models.EventPropertyField(order, group_name, is_integration, is_highlight, items)

ベース: オブジェクト

EventPropertyField は、優先度とグループ化で整理されたイベント属性の構造化されたコレクションを定義します。テレメトリー データを分類して表示し、調査の焦点となる重要なフィールドをハイライト表示するために使用されます。

メソッド

次のメソッドは、構造化された JSON データからプロパティ フィールド オブジェクトの再構築を処理します。

メソッド
from_json()	from_json(event_property_field: MutableMapping[str, Any]) → EventPropertyField フィールド属性のディクショナリから EventPropertyField インスタンスを初期化するクラスメソッド。

属性

次の表に、イベント プロパティ フィールドを定義するメタデータとコンテンツ アイテムを示します。

属性
group_name	str これらのフィールドが属する論理グループの名前。
is_highlight	bool このフィールドをプラットフォーム UI で優先度の高いデータポイントとして視覚的に強調表示するかどうかを示します。
items	list[FieldItem] このプロパティ グループに含まれる特定のデータ項目のリスト。

class TIPCommon.data_models.FieldGroupItem

クラス TIPCommon.data_models.FieldGroupItem(original_name, name, value)

ベース: オブジェクト

FieldGroupItem は、フィールド グループ内の特定のデータポイントを表し、元のソース名と人間が読める表示名の間のマッピングを維持します。

メソッド

次のメソッドは、フィールド グループ アイテムのシリアル化と再構築を管理します。

メソッド
from_json()	from_json(field_group_json: MutableMapping[str, Any]) → FieldGroupItem JSON 辞書から FieldGroupItem インスタンスを初期化するクラスメソッド。
to_json()	to_json() → MutableMapping[str, Any] FieldGroupItem オブジェクトを JSON シリアル化可能な辞書形式に変換します。

class TIPCommon.data_models.FieldItem

クラス TIPCommon.data_models.FieldItem(original_name, name, value)

ベース: オブジェクト

FieldItem は、個々のプロパティの基本データ構造で、未加工のキー、マッピングされたラベル、関連する値を保存します。

メソッド

メソッド
from_json()	from_json(field_json: MutableMapping[str, Any]) → FieldItem フィールド プロパティの辞書から FieldItem インスタンスを作成するクラスメソッド。

class TIPCommon.data_models.FieldsGroup

クラス TIPCommon.data_models.FieldsGroup(order, group_name, is_integration, is_highlight, hide_options, items)

ベース: オブジェクト

FieldsGroup は、複数のフィールド項目を論理的なコレクションに整理するためのコンテナとして機能します。主に、プラットフォームのユーザー インターフェース内のデータのレイアウトと可視性を制御するために使用されます。

メソッド

次のメソッドは、オブジェクト インスタンスと構造化 JSON 間でのフィールド グループ データの変換を管理します。

メソッド
from_json()	from_json(field_group_json: MutableMapping[str, Any]) → FieldsGroup グループ属性のディクショナリから FieldsGroup インスタンスを初期化するクラスメソッド。
to_json()	to_json() → MutableMapping[str, Any] FieldsGroup オブジェクトを JSON シリアル化可能な辞書形式に変換します。

属性

次の表に、グループの表示動作とコンテンツを定義するプロパティを示します。

属性
group_name	str UI でグループを識別するために使用されるラベル。
is_highlight	bool グループを視覚的に強調表示するかどうかを決定します。
items	list[FieldGroupItem] グループに含まれる特定のデータポイントのリスト。

class TIPCommon.data_models.GoogleServiceAccount

クラス TIPCommon.data_models.GoogleServiceAccount(account_type, project_id, private_key_id, private_key, client_email, client_id, auth_uri, token_uri, auth_provider_x509_url, client_x509_cert_url)

ベース: オブジェクト

GoogleServiceAccount は、 Google Cloudサービス アカウントの認証情報の構造化された表現を提供します。これは、Google サービスとやり取りする統合の認証情報の管理に使用されます。

メソッド

次のメソッドを使用すると、クライアント ライブラリで必要な標準形式で認証情報データをエクスポートできます。

メソッド
to_dict()	to_dict() → dict[str, str] サービス アカウントのプロパティを標準の service-account-file.json 形式と互換性のあるディクショナリにシリアル化します。

class TIPCommon.data_models.Insight

クラス TIPCommon.data_models.Insight(raw_data)

ベース: オブジェクト

インサイトは、プラットフォームまたは統合によって生成された個別の分析結果または観測を表します。セキュリティ調査の追加のコンテキストや推奨されるアクションを提供する生データをカプセル化します。

メソッド

次のメソッドは、分析情報オブジェクトのシリアル化と再構築を管理します。

メソッド
from_json()	from_json(insights_response: MutableMapping[str, Any]) → Insight 未加工の分析情報テレメトリーのディクショナリから Insight インスタンスを作成するクラスメソッド。
to_json()	to_json() → MutableMapping[str, Any] Insight オブジェクトを JSON 互換の辞書形式にシリアル化します。

属性

属性
raw_data	MutableMapping[str, Any] 分析情報の特定の検出結果と指標を含む基盤となる未加工データのペイロード。

class TIPCommon.data_models.InstalledIntegrationInstance

クラス TIPCommon.data_models.InstalledIntegrationInstance(instance, identifier, integration_identifier, environment_identifier, instance_name)

ベース: オブジェクト

InstalledIntegrationInstance は、環境内にデプロイされた統合の特定の構成済みインスタンスを表します。一般的な統合定義を特定の環境デプロイと命名に関連付けます。

メソッド

次のメソッドは、オブジェクト インスタンスと構造化 JSON 間の統合インスタンス データの変換を管理します。

メソッド
from_json()	from_json(integration_env_json: MutableMapping[str, Any]) → InstalledIntegrationInstance JSON データを InstalledIntegrationInstance オブジェクトに解析するクラスメソッド。
to_json()	to_json() → MutableMapping[str, Any] 統合インスタンス データを JSON 互換の辞書形式にシリアル化します。

属性

次の表に、さまざまな組織環境で統合を追跡するために使用される識別子を示します。

属性
instance_name	str この特定の統合インスタンスのユーザー定義名。
integration_identifier	str 親インテグレーションの一意の識別子。
environment_identifier	str このインスタンスがインストールされている組織環境の識別子。

class TIPCommon.data_models.InternalDomain

クラス TIPCommon.data_models.InternalDomain(alias_name, id_, domain_display_name, environments_json, creation_time_unix_time_in_ms, modification_time_unix_time_in_ms)

ベース: オブジェクト

InternalDomain は、組織の内部インフラストラクチャの一部として認識されるドメイン識別子を表します。これらのレコードは、セキュリティ調査中に内部トラフィックと外部の脅威を区別するために不可欠です。

メソッド

次のメソッドは、内部ドメイン レコードのシリアル化と再構築を管理します。

メソッド
from_json()	from_json(json_data: MutableMapping[str, Any]) → InternalDomain JSON 辞書から InternalDomain オブジェクトを作成するクラスメソッド。
to_json()	to_json() → MutableMapping[str, Any] InternalDomain オブジェクトを JSON シリアル化可能な辞書形式に変換します。

属性

次の表に、内部ドメインの識別と分類に使用されるプロパティを示します。

属性
domain_display_name	str プライマリ ドメイン名。
alias_name	str プラットフォーム内でドメインを識別するために使用される代替名またはラベル。
environments_json	str このドメインが内部とみなされる環境を一覧表示する JSON 形式の文字列。

class TIPCommon.data_models.JobParamType

クラス TIPCommon.data_models.JobParamType(value)

ベース: Enum

JobParamType は、スケジュールされたジョブまたは自動化タスク内で使用されるパラメータでサポートされているデータ型を定義します。これらの型を使用すると、適切な入力検証とプラットフォーム レベルの処理が容易になります。

定数

次の定数は、ジョブ パラメータで使用可能な特定のデータ型を表します。

定数
BOOLEAN	0
INTEGER	1
STRING	2
PASSWORD	3
IP	4
HOST	5
URL	6
DOMAIN	7
EMAIL	8
NULL	-1

class TIPCommon.data_models.Parameter

クラス TIPCommon.data_models.Parameter(raw_param)

ベース: オブジェクト

Parameter は、ライブラリ内のすべてのパラメータ関連モデルのプライマリ ベースクラスとして機能します。これにより、未加工の構成データを処理するための整合性のあるインターフェースが提供されます。

属性

次のプロパティは、パラメータの初期化に使用される基盤となるデータへのアクセスを提供します。

属性
raw_data	dict[str, Any] パラメータの構成を含む元のディクショナリ ペイロード。

例

次の例は、基本の Parameter クラスを初期化して、その生データにアクセスする方法を示しています。

>>> from data_models import Parameter
>>> p = Parameter({'foo': 'bar'})
>>> print(p)
Parameter(raw_data={'foo': 'bar'})

class TIPCommon.data_models.SLA

クラス TIPCommon.data_models.SLA(sla_expiration_time, critical_expiration_time, expiration_status, remaining_time_since_last_pause)

ベース: オブジェクト

SLA（サービスレベル契約）は、アラートのタイミング制約とステータスをカプセル化します。標準の期限と重要な期限を高い精度で追跡し、処理された一時停止のロジックも含まれます。

メソッド

次のメソッドは、オブジェクト インスタンスと構造化 JSON 間での SLA データの変換を管理します。

メソッド
from_json()	from_json(sla_json: MutableMapping[str, Any]) → SLA JSON 辞書から SLA インスタンスを初期化するクラスメソッド。
to_json()	to_json() → MutableMapping[str, Any] SLA オブジェクトを JSON シリアル化可能な辞書形式に変換します。

属性

次の表に、アラートの有効期限を追跡するために使用されるコア タイミング属性を示します。

属性
sla_expiration_time	int | None 標準 SLA の有効期限を表す Unix タイムスタンプ。
critical_expiration_time	int | None クリティカルな SLA の有効期限を表す Unix タイムスタンプ。
expiration_status	int SLA の現在のステータス。

class TIPCommon.data_models.ScriptContext

クラス TIPCommon.data_models.ScriptContext(target_entities: 'str' = '', case_id: 'int | str | None' = None, alert_id: 'str' = '', environment: 'str' = '', workflow_id: 'str' = '', workflow_instance_id: 'str | None' = None, parameters: 'SingleJson' = <factory>, integration_identifier: 'str' = '', integration_instance: 'str' = '', action_definition_name: 'str' = '', original_requesting_user: 'str' = '', execution_deadline_unix_time_ms: 'int' = 0, async_polling_interval_in_sec: 'int' = 0, async_total_duration_deadline: 'int' = 0, script_timeout_deadline: 'int' = 0, default_result_value: 'str' = '', use_proxy_settings: 'bool' = False, max_json_result_size: 'int' = 15, vault_settings: 'SiemplifyVault | None' = None, environment_api_key: 'str | None' = None, unique_identifier: 'str' = '', job_api_key: 'str' = '', connector_context: 'ConnectorContext | None' = None)

ベース: オブジェクト

ScriptContext は、スクリプトの実行に必要な環境、識別子、パラメータを提供する包括的なコンテナです。ターゲット エンティティやワークフロー ID から、プロキシやボールト構成などのセキュリティ設定まで、すべてを追跡します。

メソッド

次のメソッドを使用すると、スクリプトの実行コンテキストを変更してシリアル化できます。

メソッド
to_json()	to_json() → MutableMapping[str, Any] ScriptContext を JSON 互換の辞書形式にシリアル化します。
update()	update(attributes: MutableMapping[str, Any]) → None 指定された辞書の値でコンテキスト属性を更新します。

属性

コンテキストは広範囲に及ぶため、次の表に最も重要な実行環境識別子を示します。

属性
case_id	int | str | None 現在のスクリプト実行に関連付けられているケースの識別子。
workflow_id	str 現在処理中のワークフローの ID。
parameters	SingleJson スクリプトに渡されるランタイム パラメータを含むディクショナリ。
execution_deadline_unix_time_ms	int スクリプトの実行を終了する必要がある時刻を示す UNIX タイムスタンプ。
vault_settings	SiemplifyVault | None プラットフォームの Vault に保存されている機密データにアクセスするための構成設定。

class TIPCommon.data_models.SmimeEmailConfig

クラス TIPCommon.data_models.SmimeEmailConfig(email, private_key_b64, certificate_b64, ca_certificate_b64)

ベース: オブジェクト

SmimeEmailConfig は、署名や暗号化などの S/MIME オペレーションの実行に必要な暗号アセットとメール メッセージをカプセル化します。これには、未加工のメールと base64 でエンコードされた鍵と証明書が格納されます。

属性

次の表に、この構成モデルで管理される暗号コンポーネントを示します。

属性
email	email.message.Message 処理する標準の Python メール メッセージ オブジェクト。
private_key_b64	str 署名または復号に使用される Base64 エンコードの秘密鍵。
certificate_b64	str 秘密鍵に関連付けられた base64 でエンコードされた公開証明書。
ca_certificate_b64	str 信頼チェーンの検証に使用される Base64 エンコードの認証局（CA）証明書。

class TIPCommon.data_models.SmimeType

クラス TIPCommon.data_models.SmimeType(value)

ベース: Enum

SmimeType は、S/MIME 処理のオペレーション モードを定義します。暗号化によるコンテンツの保護と、デジタル署名を使用した送信者の検証を区別します。

定数

次の定数は、サポートされている S/MIME メッセージ タイプを表します。

定数
SIGNED	'signed'（メッセージは、信頼性を確保するためにデジタル署名されています）
ENCRYPTED	'encrypted'（メッセージ本文は機密性のため暗号化されています）

class TIPCommon.data_models.TypedContainer

クラス TIPCommon.data_models.TypedContainer()

ベース: Generic[T]

TypedContainer は、特定の型のデータを保持するように設計された汎用ラッパーです。型ヒントとインテリセンスを提供することで、デベロッパーの生産性を向上させ、保存されたオブジェクトが IDE と静的分析ツールで正しく処理されるようにします。

class TIPCommon.data_models.UserDetails

クラス TIPCommon.data_models.UserDetails(id_: int, creation_time_unix_time_in_ms: int, modification_time_unix_time_in_ms: int, permission_group: str, permission_groups: list[str], soc_roles: list[str], is_disabled: bool, login_identifier: str, first_name: str, last_name: str, permission_type: int, role: int, soc_role_id: int, soc_role_ids: list[int], email: str, user_name: str, user_type: int, identity_provider: int, provider_name: str, advanced_reports_access: int, account_state: int, last_login_time: int, previous_login_time: int, last_password_change_time: int, last_password_change_notification_time: int, login_wrong_password_count: int, is_deleted: bool, deletion_time_unix_time_in_ms: int, environments: list[str], allowed_platforms: list[int], data_access_context: [DataAccessContext](#TIPCommon.data_models.DataAccessContext), soc_role: str | None, image_base64: str | None)

ベース: オブジェクト

UserDetails は、認証メタデータ、組織内のロール、きめ細かいデータアクセス権限など、プラットフォーム ユーザーの包括的なプロファイルを提供します。これは、ユーザー セッションの管理とロールベースのアクセス制御（RBAC）の適用に不可欠です。

メソッド

次のメソッドは、ユーザー プロファイル データの再構築とシリアル化を容易にします。

メソッド
from_json()	from_json(user_details_json: MutableMapping[str, Any]) → UserDetails ユーザー属性の JSON 辞書から UserDetails インスタンスを初期化するクラスメソッド。
to_json()	to_json() → MutableMapping[str, Any] UserDetails オブジェクトを JSON シリアル化可能な辞書形式に変換します。

属性

次の表に、ユーザーの主な識別と権限の構造を示します。

属性
user_name	str ログインと識別に使用される一意のシステム ユーザー名。
soc_roles	list[str] ユーザーに割り当てられた SOC ロールのリスト。オペレーション権限を定義します。
data_access_context	DataAccessContext ユーザーがアクセスを許可されているデータスコープと組織部門を定義するコンテキスト。
is_disabled	bool ユーザー アカウントが現在ログインを制限されているかどうかを示すブール値フラグ。

class TIPCommon.data_models.UserProfileCard

クラス TIPCommon.data_models.UserProfileCard(raw_data, first_name, last_name, user_name, account_state)

ベース: オブジェクト

UserProfileCard は、ユーザーのプロフィールの軽量な概要を提供します。これは、ヘッダーや連絡先カードなど、詳細な情報が不要な UI コンポーネントでの表示を目的としています。

メソッド

メソッド
from_json()	from_json(user_profile_card_response: dict) → UserProfileCard 基本プロファイル属性のディクショナリから UserProfileCard インスタンスを作成するクラスメソッド。

class TIPCommon.data_models.WallData

クラス TIPCommon.data_models.WallData(raw_data, case_id, activity_kind, activity_data_json, favorite)

ベース: オブジェクト

WallData は、ケースの [Wall] またはタイムラインのエントリを表します。このモデルは、調査のライフサイクル中に発生するアクティビティ ログ、メモ、システム アクションを追跡します。

メソッド

メソッド
from_json()	from_json(data: MutableMapping[str, Any]) → WallData ウォール アクティビティの JSON 辞書から WallData インスタンスを初期化するクラスメソッド。
to_json()	to_json() → MutableMapping[str, Any] WallData オブジェクトを JSON 互換の辞書形式にシリアル化します。

属性

属性
activity_kind	str | int | None アクティビティのカテゴリ。
activity_data_json	str | None アクティビティの具体的な詳細またはペイロードを含む JSON 形式の文字列。
favorite	bool アクティビティ エントリが固定されているか、クイック リファレンス用にマークされているかを示します。

さらにサポートが必要な場合 コミュニティ メンバーや Google SecOps のプロフェッショナルから回答を得ることができます。