Google menggunakan teknologi AI untuk menerjemahkan konten ke dalam bahasa pilihan Anda. Terjemahan AI mungkin mengandung kesalahan.

Modul `data_models`

Modul ini berisi class data untuk merepresentasikan hal berikut:

Model data
Notifikasi
Penampung variabel
Parameter umum
Parameter konektor

class TIPCommon.data_models.AlertCard

class 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)

Dasar: object

AlertCard menampilkan kartu ringkasan untuk pemberitahuan, yang mencakup metadata penting dan indikator status yang digunakan untuk visualisasi dan pelacakan dalam platform.

Metode

Metode berikut memfasilitasi serialisasi dan rekonstruksi kartu pemberitahuan dari data terstruktur.

Metode

Metode
`from_json()`	`from_json(alert_card_json: dict[str, Any]) → AlertCard` Metode class yang membuat instance `AlertCard` dari kamus JSON.
`to_json()`	`to_json() → MutableMapping[str, Any]` Mengonversi objek `AlertCard` ke dalam format kamus yang dapat diserialisasi JSON.

from_json()

from_json(alert_card_json: dict[str, Any]) → AlertCard

Metode class yang membuat instance AlertCard dari kamus JSON.

to_json()

to_json() → MutableMapping[str, Any]

Mengonversi objek AlertCard ke dalam format kamus yang dapat diserialisasi JSON.

Atribut

Tabel berikut menunjukkan atribut struktural utama dan model data kompleks yang terkait dengan pemberitahuan.

Atribut

Atribut
`fields_groups`	`list[FieldsGroup]` Daftar kolom yang dikelompokkan yang terkait dengan pemberitahuan, digunakan untuk presentasi data terstruktur di UI.
`sla`	`SLA` Objek Perjanjian Tingkat Layanan yang menentukan jangka waktu respons dan penyelesaian untuk pemberitahuan.

fields_groups

list[FieldsGroup]

Daftar kolom yang dikelompokkan yang terkait dengan pemberitahuan, digunakan untuk presentasi data terstruktur di UI.

sla

SLA

Objek Perjanjian Tingkat Layanan yang menentukan jangka waktu respons dan penyelesaian untuk pemberitahuan.

class TIPCommon.data_models.AlertEvent

class 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])

Dasar: object

AlertEvent mewakili setiap peristiwa yang terkait dengan pemberitahuan, yang berisi data telemetri tertentu, properti kolom, dan hubungan entitas.

Metode

Metode berikut memfasilitasi rekonstruksi objek peristiwa dari data JSON terstruktur.

Metode

Metode
`from_json()`	`from_json(event_json: MutableMapping[str, Any]) → AlertEvent` Metode class yang membuat instance `AlertEvent` dari kamus JSON yang merepresentasikan atributnya.

from_json()

from_json(event_json: MutableMapping[str, Any]) → AlertEvent

Metode class yang membuat instance AlertEvent dari kamus JSON yang merepresentasikan atributnya.

Atribut

Tabel berikut menyoroti atribut struktural utama dan model data kompleks yang terkait dengan peristiwa.

Atribut

Atribut
`fields`	`list[EventPropertyField]` Daftar kolom properti khusus untuk peristiwa, yang menentukan titik data uniknya.
`artifact_entities`	`list[str]` Daftar ID entitas yang diekstrak dari telemetri peristiwa.

fields

list[EventPropertyField]

Daftar kolom properti khusus untuk peristiwa, yang menentukan titik data uniknya.

artifact_entities

list[str]

Daftar ID entitas yang diekstrak dari telemetri peristiwa.

class TIPCommon.data_models.AlertPriority

class TIPCommon.data_models.AlertPriority(value)

Dasar: Enum

AlertPriority menentukan tingkat keparahan berbasis bilangan bulat standar yang digunakan untuk mengategorikan dan memprioritaskan pemberitahuan dalam platform.

Konstanta

Konstanta berikut mewakili nilai prioritas spesifik yang ditetapkan ke pemberitahuan.

Konstanta
`CRITICAL`	`100`
`HIGH`	`80`
`MEDIUM`	`60`
`LOW`	`40`
`UNCHANGED`	`0`
`INFORMATIVE`	`-1`

class TIPCommon.data_models.AttachmentMetadata

class TIPCommon.data_models.AttachmentMetadata(raw_data: SingleJson)

Dasar: object

AttachmentMetadata merangkum data dan properti deskriptif yang terkait dengan lampiran file, yang menyediakan metode untuk konversi dan pengambilan data terstruktur.

Metode

Metode berikut menyediakan cara standar untuk merekonstruksi objek kasus dari payload JSON.

Metode

Metode
`from_json()`	`from_json(result_data: MutableMapping[str, Any]) → Self` Metode class yang menginisialisasi instance `AttachmentMetadata` baru menggunakan kamus properti metadata yang disediakan.
`to_json()`	`to_json() → MutableMapping[str, Any]` Menserialisasi objek `AttachmentMetadata` kembali ke format kamus yang kompatibel dengan JSON.

from_json()

from_json(result_data: MutableMapping[str, Any]) → Self

Metode class yang menginisialisasi instance AttachmentMetadata baru menggunakan kamus properti metadata yang disediakan.

to_json()

to_json() → MutableMapping[str, Any]

Menserialisasi objek AttachmentMetadata kembali ke format kamus yang kompatibel dengan JSON.

Atribut

Tabel berikut menyoroti struktur data utama yang digunakan untuk menyimpan properti metadata lampiran.

Atribut

Atribut
`raw_data`	`MutableMapping[str, Any]` Kamus pokok yang berisi atribut metadata mentah seperti yang diterima dari sumber.

raw_data

MutableMapping[str, Any]

Kamus pokok yang berisi atribut metadata mentah seperti yang diterima dari sumber.

class TIPCommon.data_models.BaseAlert

class TIPCommon.data_models.BaseAlert(raw_data, alert_id)

Dasar: object

BaseAlert adalah model dasar yang merepresentasikan pemberitahuan keamanan generik. Struktur ini menyediakan struktur standar untuk menyimpan telemetri mentah bersama dengan ID platform unik.

Metode

Metode berikut memungkinkan serialisasi pemberitahuan ke dalam format standar.

Metode

Metode
`to_json()`	`to_json() → dict[str, Any]` Mengonversi pemberitahuan menjadi kamus yang dapat diserialisasi JSON seperti yang ditampilkan oleh `json.loads()`.

to_json()

to_json() → dict[str, Any]

Mengonversi pemberitahuan menjadi kamus yang dapat diserialisasi JSON seperti yang ditampilkan oleh json.loads().

Atribut

Tabel berikut menyoroti titik data inti yang dikelola oleh model ini.

Atribut

Atribut
`raw_data`	`dict[str, Any]` Payload data mentah yang terkait dengan pemberitahuan.
`alert_id`	`Any` ID unik yang ditetapkan ke pemberitahuan.

raw_data

dict[str, Any]

Payload data mentah yang terkait dengan pemberitahuan.

alert_id

Any

ID unik yang ditetapkan ke pemberitahuan.

Contoh

Contoh berikut menunjukkan cara melakukan inisialisasi BaseAlert serta mengakses data mentah dan output berserialnya.

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

class TIPCommon.data_models.BaseDataModel(raw_data)

Dasar: object

BaseDataModel bertindak sebagai class induk untuk berbagai struktur data dalam library, sehingga memastikan penanganan yang konsisten terhadap data input mentah dan serialisasi.

Metode

Metode berikut memastikan bahwa data mentah diambil dalam format yang kompatibel dengan operasi JSON.

Metode

Metode
`to_json()`	`to_json() → dict[str, Any]` Menserialisasi data mentah yang disimpan dalam model ke dalam format kamus.

to_json()

to_json() → dict[str, Any]

Menserialisasi data mentah yang disimpan dalam model ke dalam format kamus.

Atribut

Tabel berikut menjelaskan penyimpanan data utama untuk model dasar.

Atribut

Atribut
`raw_data`	`dict[str, Any]` Payload data mentah asli yang digunakan untuk menginisialisasi model.

raw_data

dict[str, Any]

Payload data mentah asli yang digunakan untuk menginisialisasi model.

Contoh

Contoh berikut menunjukkan inisialisasi dasar model data dan penggunaan metode serialisasi.

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

class TIPCommon.data_models.CaseDataStatus

class TIPCommon.data_models.CaseDataStatus(value)

Dasar: Enum

CaseDataStatus menentukan status operasional yang didukung untuk kasus dalam platform, mulai dari penyerapan awal hingga penutupan atau penggabungan akhir.

Konstanta

Konstanta berikut mewakili indikator status tertentu yang ditetapkan ke data kasus.

Konstanta
`NEW`	`0`
`OPENED`	`1`
`CLOSED`	`2`
`ALL`	`3`
`MERGED`	`4`
`CREATION_PENDING`	`5`

class TIPCommon.data_models.CaseDetails

Dasar: object

CaseDetails memberikan tampilan ekstensif kasus keamanan, termasuk properti dan metode pemeriksaan status untuk merekonstruksi atau menyerialkan data kasus.

Metode

Metode berikut mengelola konversi detail kasus antara instance objek dan format JSON terstruktur.

Metode

Metode
`from_json()`	`from_json(case_details_json: MutableMapping[str, Any]) → CaseDetails` Metode class yang melakukan inisialisasi instance `CaseDetails` dari kamus atribut kasus.
`to_json()`	`to_json(include_activities: bool = False) → MutableMapping[str, Any]` Mengonversi objek `CaseDetails` menjadi kamus yang dapat diserialisasi JSON. Setel `include_activities` ke `True` untuk menyertakan log aktivitas kasus.

from_json()

from_json(case_details_json: MutableMapping[str, Any]) → CaseDetails

Metode class yang melakukan inisialisasi instance CaseDetails dari kamus atribut kasus.

to_json()

to_json(include_activities: bool = False) → MutableMapping[str, Any]

Mengonversi objek CaseDetails menjadi kamus yang dapat diserialisasi JSON. Setel include_activities ke True untuk menyertakan log aktivitas kasus.

Atribut

Properti berikut memberikan indikator logis terkait status kasus saat ini.

Atribut

Atribut
`is_closed`	`bool` Properti boolean yang menunjukkan apakah kasus dalam status tertutup.
`is_open`	`bool` Properti boolean yang menunjukkan apakah kasus aktif atau terbuka.

is_closed

bool

Properti boolean yang menunjukkan apakah kasus dalam status tertutup.

is_open

bool

Properti boolean yang menunjukkan apakah kasus aktif atau terbuka.

class TIPCommon.data_models.CaseOverviewInfo

class 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>)

Dasar: object

CaseOverviewInfo memberikan ringkasan umum kasus keamanan, menggabungkan metadata, status Perjanjian Tingkat Layanan (SLA), dan detail organisasi yang digunakan untuk pengelolaan dasbor dan antrean.

Metode

Metode berikut memfasilitasi rekonstruksi objek ringkasan kasus dari data JSON terstruktur.

Metode

Metode
`from_json()`	`from_json(json_data: MutableMapping[str, Any]) → CaseOverviewInfo` Metode class yang menginisialisasi instance `CaseOverviewInfo` dari kamus atribut ringkasan kasus.

from_json()

from_json(json_data: MutableMapping[str, Any]) → CaseOverviewInfo

Metode class yang menginisialisasi instance CaseOverviewInfo dari kamus atribut ringkasan kasus.

Atribut

Tabel berikut menunjukkan atribut struktural utama, enum, dan metrik operasional utama yang terkait dengan ringkasan kasus.

Atribut
`priority`	`CasePriority` Tingkat keparahan yang ditetapkan untuk kasus.
`status`	`CaseDataStatus \| None` Status operasional data kasus saat ini.
`workflow_status`	`int \| None` Langkah atau status saat ini dalam mesin alur kerja otomatis platform.
`score`	`int \| None` Skor risiko atau kepentingan yang dihitung dan ditetapkan untuk kasus tersebut.
`case_sla`	`CaseSLAInfo \| None` Informasi pelacakan SLA khusus untuk siklus proses penyelesaian kasus.
`alerts_sla`	`CaseSLAInfo \| None` Informasi pelacakan SLA untuk setiap pemberitahuan yang ada dalam kasus.
`environment_data`	`EnvironmentData \| None` Metadata terkait lingkungan organisasi tertentu tempat kasus berasal.
`tags`	`list[str]` Daftar label yang ditentukan pengguna atau dihasilkan sistem yang terkait dengan kasus.

class TIPCommon.data_models.CasePriority

class TIPCommon.data_models.CasePriority(value)

Dasar: Enum

CasePriority menentukan tingkat keparahan berbasis bilangan bulat standar yang digunakan untuk mengategorikan dan memprioritaskan kasus dalam platform.

Konstanta

Konstanta berikut mewakili nilai prioritas spesifik yang ditetapkan ke kasus.

Konstanta
`CRITICAL`	`100`
`HIGH`	`80`
`MEDIUM`	`60`
`LOW`	`40`
`UNCHANGED`	`0`
`INFORMATIVE`	`-1`

class TIPCommon.data_models.CaseSLAInfo

class 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)

Dasar: object

CaseSLAInfo merangkum data pelacakan Perjanjian Tingkat Layanan (SLA), dengan menyediakan stempel waktu untuk indikator status dan masa berlaku guna memastikan respons insiden yang tepat waktu.

Metode

Metode berikut memungkinkan pembuatan objek info SLA dari data JSON terstruktur.

Metode

Metode
`from_json()`	`from_json(json_data: MutableMapping[str, Any]) → CaseSLAInfo` Metode class yang melakukan inisialisasi instance `CaseSLAInfo` dari kamus atribut SLA.

from_json()

from_json(json_data: MutableMapping[str, Any]) → CaseSLAInfo

Metode class yang melakukan inisialisasi instance CaseSLAInfo dari kamus atribut SLA.

Atribut

Tabel berikut menandai atribut waktu dan status utama yang digunakan untuk memantau batas waktu kasus.

Atribut
`expiration_time_ms`	`int \| None` Stempel waktu Unix (dalam milidetik) saat SLA standar ditetapkan untuk berakhir.
`critical_expiration_time_ms`	`int \| None` Stempel waktu Unix (dalam milidetik) saat nilai minimum SLA kritis tercapai.
`expiration_status`	`int \| None` Indikator bilangan bulat yang mewakili status SLA saat ini.
`last_pause_remaining_time_ms`	`int \| None` Sisa waktu pada timer SLA saat terakhir dijeda.

class TIPCommon.data_models.CaseWallAttachment

class TIPCommon.data_models.CaseWallAttachment(name, file_type, base64_blob, is_important, case_id=None, description=None)

Dasar: object

CaseWallAttachment merepresentasikan file atau objek data yang dilampirkan ke dinding bukti kasus, termasuk konten mentah dalam format base64 dan metadata terkait.

Atribut

Tabel berikut menunjukkan properti utama dan data konten yang terkait dengan lampiran.

Atribut
`name`	`str` Nama file atau nama tampilan lampiran.
`file_type`	`str` Jenis MIME atau ekstensi file yang menunjukkan format data yang dilampirkan.
`base64_blob`	`str` Konten sebenarnya dari file, dienkode sebagai string base64.
`is_important`	`bool` Tanda yang menunjukkan apakah lampiran ditandai sebagai bukti penting untuk penyelidikan.

class TIPCommon.data_models.ConnectorCard

class TIPCommon.data_models.ConnectorCard(integration, display_name, identifier, is_enabled, is_remote, status)

Dasar: object

ConnectorCard memberikan ringkasan konfigurasi konektor tertentu dan

status operasional saat ini dalam platform.

Metode

Metode berikut memfasilitasi pembuatan instance kartu konektor dari data JSON terstruktur.

Metode

Metode
`from_json()`	`from_json(connector_card_json: MutableMapping[str, Any]) → ConnectorCard` Metode class yang melakukan inisialisasi instance `ConnectorCard` dari kamus atribut konektor.

from_json()

from_json(connector_card_json: MutableMapping[str, Any]) → ConnectorCard

Metode class yang melakukan inisialisasi instance ConnectorCard dari kamus atribut konektor.

Atribut

Tabel berikut menunjukkan status operasional dan properti identifikasi konektor.

Atribut

Atribut
`status`	`ConnectorConnectivityStatusEnum` Status konektivitas dan kesehatan konektor saat ini.
`is_enabled`	`bool` Menunjukkan apakah konektor aktif dan memproses data.

status

ConnectorConnectivityStatusEnum

Status konektivitas dan kesehatan konektor saat ini.

is_enabled

bool

Menunjukkan apakah konektor aktif dan memproses data.

class TIPCommon.data_models.ConnectorConnectivityStatusEnum

class TIPCommon.data_models.ConnectorConnectivityStatusEnum(value)

Dasar: Enum

ConnectorConnectivityStatusEnum menentukan kemungkinan status konektivitas untuk konektor, yang menunjukkan apakah konektor berhasil berkomunikasi dengan target integrasinya.

Konstanta

Konstanta berikut mewakili status koneksi konektor.

Konstanta
`LIVE`	`0`
`NO_CONNECTIVITY`	`1`

class TIPCommon.data_models.ConnectorParamTypes

class TIPCommon.data_models.ConnectorParamTypes(value)

Dasar: Enum

ConnectorParamTypes menentukan jenis data yang didukung untuk parameter konfigurasi konektor. Jenis ini memastikan validasi dan rendering UI yang tepat dalam setelan platform.

Konstanta

Konstanta berikut mewakili jenis data spesifik yang tersedia untuk parameter.

Konstanta
`BOOLEAN`	`0` (tombol boolean)
`INTEGER`	`1` (bilangan bulat numerik)
`STRING`	`2` (string teks standar)
`PASSWORD`	`3` (kolom sandi yang disamarkan)
`IP`	`4` (alamat IP)
`HOST`	`5` (nama host)
`URL`	`6` (string URL)
`DOMAIN`	`7` (nama domain)
`EMAIL`	`8` (alamat email)
`SCRIPT`	`12` (parameter skrip lama)
`NULL`	`-1` (jenis parameter tidak valid)

class TIPCommon.data_models.ConnectorParameter

class TIPCommon.data_models.ConnectorParameter(raw_param)

Dasar: Parameter

ConnectorParameter merepresentasikan setelan konfigurasi individual untuk konektor. Model ini memperluas model parameter dasar untuk menyertakan metadata tertentu seperti jenis validasi dan persyaratan wajib.

Atribut

Properti berikut memberikan akses ke detail konfigurasi dan batasan parameter konektor.

Atribut
`name`	`str` Nama unik yang digunakan untuk mengidentifikasi parameter dalam konfigurasi konektor.
`value`	`Any` Nilai saat ini yang ditetapkan ke parameter.
`type`	`ConnectorParamTypes` Jenis data parameter, yang digunakan untuk validasi dan rendering UI.
`mode`	`int` Mode operasional atau setelan visibilitas parameter.
`is_mandatory`	`bool` Menunjukkan apakah nilai harus diberikan untuk parameter ini sebelum konektor disimpan atau dieksekusi.

Contoh

Contoh berikut menunjukkan cara menginisialisasi ConnectorParameter menggunakan kamus mentah dan mengakses propertinya.

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

class TIPCommon.data_models.Container()

Dasar: object

Container berfungsi sebagai objek dinamis generik untuk menyimpan variabel sebagai atribut. Hal ini berguna untuk meneruskan kumpulan data arbitrer di antara berbagai komponen platform.

Contoh

Contoh berikut menunjukkan cara menginisialisasi penampung dan menetapkan serta mengambil variabel secara dinamis.

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

class TIPCommon.data_models.CreateEntity

class 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)

Dasar: object

CreateEntity merangkum petunjuk yang diperlukan untuk membuat dan menautkan entitas baru ke kasus dan pemberitahuan yang ada. Hal ini mencakup logika untuk pemetaan koneksi dan hubungan berbasis regex.

Metode

Metode berikut menangani konversi petunjuk pembuatan entitas ke dalam format yang kompatibel dengan platform.

Metode

Metode
`to_json()`	`to_json() → MutableMapping[str, Any]` Mengonversi objek `CreateEntity` menjadi kamus yang dapat diserialisasi JSON.

to_json()

to_json() → MutableMapping[str, Any]

Mengonversi objek CreateEntity menjadi kamus yang dapat diserialisasi JSON.

Atribut

Tabel berikut menandai properti utama yang digunakan untuk menentukan entitas baru dan hubungannya dalam platform.

Atribut
`case_id`	`int` ID unik kasus tempat entitas akan dibuat.
`alert_identifier`	`str` ID pemberitahuan yang terkait dengan entitas ini.
`entity_type`	`str` Klasifikasi entitas.
`entity_identifier`	`str` Nilai atau nama tertentu yang mengidentifikasi entitas.
`entity_to_connect_regex`	`str` Ekspresi reguler yang digunakan untuk mengidentifikasi entitas lain yang akan dihubungkan dengan entitas ini.
`types_to_connect`	`list[str] \| None` Daftar jenis entity tertentu yang memenuhi syarat untuk koneksi berdasarkan regex.
`is_primary_link`	`bool` Menunjukkan apakah koneksi ini merepresentasikan hubungan utama antar-entitas.
`is_directional`	`bool` Menentukan apakah koneksi memiliki arah yang ditentukan (sumber ke target) atau timbal balik.

class TIPCommon.data_models.CustomField

class TIPCommon.data_models.CustomField(id, display_name, description, type, scopes)

Dasar: object

CustomField merepresentasikan kolom data yang ditentukan pengguna dalam platform. Fitur ini memungkinkan perluasan model data standar dengan menambahkan metadata spesifik yang disesuaikan dengan persyaratan organisasi.

Metode

Metode berikut memungkinkan rekonstruksi objek kolom kustom dari data JSON terstruktur.

Metode

Metode
`from_json()`	`from_json(json_data: MutableMapping[str, Any]) → CustomField` Metode class yang melakukan inisialisasi instance `CustomField` dari kamus atribut kolom.

from_json()

from_json(json_data: MutableMapping[str, Any]) → CustomField

Metode class yang melakukan inisialisasi instance CustomField dari kamus atribut kolom.

Atribut

Tabel berikut menandai properti utama dan batasan cakupan kolom kustom.

Atribut
`id`	`int` ID unik untuk kolom kustom.
`display_name`	`str` Label yang dapat dibaca manusia yang ditampilkan di UI platform.
`type`	`str` Jenis data kolom.
`scopes`	`list[CustomFieldScope]` Daftar area aplikasi tempat kolom ini tersedia

class TIPCommon.data_models.CustomFieldScope

class TIPCommon.data_models.CustomFieldScope(value)

Dasar: Enum

CustomFieldScope menentukan target valid tempat kolom kustom diterapkan dalam hierarki platform.

Metode

Metode berikut menyediakan utilitas untuk menyelesaikan jalur objek yang tercakup.

Metode

Metode
`build_parent_path()`	`build_parent_path(identifier: int) → str` Membangun jalur platform internal untuk ID objek induk yang ditentukan.

build_parent_path()

build_parent_path(identifier: int) → str

Membangun jalur platform internal untuk ID objek induk yang ditentukan.

Konstanta

Konstanta berikut mewakili cakupan spesifik yang tersedia untuk kolom kustom.

Konstanta
`ALERTS`	`'Alert'`
`CASE`	`'Case'`

class TIPCommon.data_models.CustomFieldValue

class TIPCommon.data_models.CustomFieldValue(custom_field_id, values, scope, identifier)

Dasar: object

CustomFieldValue merepresentasikan data spesifik yang ditetapkan ke instance kolom kustom. Objek ini menautkan definisi kolom ke konten sebenarnya yang diberikan oleh pengguna atau proses otomatis.

Metode

Metode berikut memfasilitasi rekonstruksi nilai kolom kustom dari data JSON terstruktur.

Metode

Metode
`from_json()`	`from_json(json_data: MutableMapping[str, Any]) → CustomFieldValue` Metode class yang melakukan inisialisasi instance `CustomFieldValue` dari kamus atribut nilai.

from_json()

from_json(json_data: MutableMapping[str, Any]) → CustomFieldValue

Metode class yang melakukan inisialisasi instance CustomFieldValue dari kamus atribut nilai.

Atribut

Tabel berikut menandai properti utama dan ID kontekstual untuk nilai kolom kustom.

Atribut
`custom_field_id`	`int` ID definisi `CustomField` yang nilai ini termasuk di dalamnya.
`values`	`list[str]` Daftar string yang merepresentasikan data sebenarnya yang disimpan di kolom.
`scope`	`CustomFieldScope` Area aplikasi tempat nilai spesifik ini diterapkan.
`identifier`	`int` ID unik untuk objek tertentu yang menyimpan nilai ini.

class TIPCommon.data_models.DataAccessContext

class TIPCommon.data_models.DataAccessContext(global_access, assigned_scopes)

Dasar: object

DataAccessContext menentukan izin dan batasan visibilitas untuk pengguna atau proses, yang menentukan cakupan data mana yang dapat diakses selama eksekusi.

Metode

Metode berikut mengelola konversi data konteks akses antara instance objek dan format JSON.

Metode

Metode
`from_json()`	`from_json(json_data: MutableMapping[str, Any]) → DataAccessContext` Metode class yang menginisialisasi instance `DataAccessContext` dari kamus properti akses.
`to_json()`	`to_json() → dict` Mengonversi objek `DataAccessContext` menjadi format kamus.

from_json()

from_json(json_data: MutableMapping[str, Any]) → DataAccessContext

Metode class yang menginisialisasi instance DataAccessContext dari kamus properti akses.

to_json()

to_json() → dict

Mengonversi objek DataAccessContext menjadi format kamus.

Atribut

Tabel berikut menunjukkan kontrol akses utama yang ditentukan dalam konteks.

Atribut

Atribut
`global_access`	`bool` Menunjukkan apakah konteks mengizinkan akses tanpa batas di semua cakupan data.
`assigned_scopes`	`list[Any]` Daftar cakupan atau unit organisasi tertentu yang telah diberikan aksesnya secara eksplisit.

global_access

bool

Menunjukkan apakah konteks mengizinkan akses tanpa batas di semua cakupan data.

assigned_scopes

list[Any]

Daftar cakupan atau unit organisasi tertentu yang telah diberikan aksesnya secara eksplisit.

class TIPCommon.data_models.DatabaseContextType

class TIPCommon.data_models.DatabaseContextType(value)

Dasar: Enum

DatabaseContextType menentukan konteks operasional untuk interaksi database, memastikan bahwa data dipertahankan atau diambil dari segmen logis platform yang benar.

Konstanta

Konstanta berikut mewakili area spesifik platform tempat operasi database terjadi.

Konstanta
`GLOBAL`	`0` (konteks seluruh sistem global)
`CASE`	`1` (konteks kasus keamanan tertentu)
`ALERT`	`2` (konteks notifikasi individu)
`JOB`	`3` (tugas terjadwal atau konteks otomatisasi)
`CONNECTOR`	`4` (konteks penghubung data)

class TIPCommon.data_models.DynamicParameter

class TIPCommon.data_models.DynamicParameter(key: str, value: str)

Dasar: object

DynamicParameter merepresentasikan key-value pair fleksibel yang digunakan untuk meneruskan konfigurasi runtime atau metadata kustom antar-komponen sistem.

Metode

Metode berikut menangani rekonstruksi parameter dinamis dari data JSON terstruktur.

Metode

Metode
`from_json()`	`from_json(json_data: MutableMapping[str, Any]) → DynamicParameter` Metode class yang melakukan inisialisasi instance `DynamicParameter` dari kamus properti kunci dan nilai.

from_json()

from_json(json_data: MutableMapping[str, Any]) → DynamicParameter

Metode class yang melakukan inisialisasi instance DynamicParameter dari kamus properti kunci dan nilai.

Atribut

Tabel berikut menjelaskan properti parameter dinamis.

Atribut

Atribut
`key`	`str` Nama atau ID untuk parameter.
`value`	`str` Konten data yang terkait dengan kunci.

key

str

Nama atau ID untuk parameter.

value

str

Konten data yang terkait dengan kunci.

class TIPCommon.data_models.EmailTemplate

class 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)

Dasar: object

EmailTemplate merepresentasikan format komunikasi standar yang digunakan untuk notifikasi dan pelaporan dalam platform. Objek ini mencakup konten pesan, metadata, dan batasan lingkungan.

Metode

Metode berikut mengelola serialisasi dan rekonstruksi template email.

Metode

Metode
`from_json()`	`from_json(data: MutableMapping[str, Any]) → EmailTemplate` Metode class yang menginisialisasi instance `EmailTemplate` dari kamus yang berisi data template.
`to_json()`	`to_json() → dict` Mengonversi objek `EmailTemplate` menjadi format kamus yang dapat diserialisasi JSON.

from_json()

from_json(data: MutableMapping[str, Any]) → EmailTemplate

Metode class yang menginisialisasi instance EmailTemplate dari kamus yang berisi data template.

to_json()

to_json() → dict

Mengonversi objek EmailTemplate menjadi format kamus yang dapat diserialisasi JSON.

Atribut

Tabel berikut menyoroti properti utama dan data struktural template email.

Atribut

Atribut
`content`	`str` Teks isi atau struktur HTML template email.
`environments`	`list[str]` Daftar lingkungan organisasi tempat template ini tersedia untuk digunakan.
`template_type`	`int \| str` Klasifikasi atau kategori template.

content

str

Teks isi atau struktur HTML template email.

environments

list[str]

Daftar lingkungan organisasi tempat template ini tersedia untuk digunakan.

template_type

int | str

Klasifikasi atau kategori template.

class TIPCommon.data_models.Entity

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

Dasar: object

Entitas mewakili objek atau hal tertentu yang dapat diamati dalam kasus keamanan (seperti alamat IP, hash file, atau pengguna). Fitur ini melacak telemetri mentah dan berbagai "tag" boolean yang menunjukkan peran atau tingkat risiko entitas dalam penyelidikan.

Metode

Metode berikut mengelola serialisasi dan rekonstruksi objek entitas.

Metode

Metode
`from_json()`	`from_json(entity_response: MutableMapping[str, Any]) → Entity` Metode class yang menginisialisasi instance `Entity` dari kamus yang berisi telemetri dan flag entity.
`to_json()`	`to_json() → MutableMapping[str, Any]` Mengonversi objek `Entity` ke dalam format kamus yang dapat diserialisasi JSON.

from_json()

from_json(entity_response: MutableMapping[str, Any]) → Entity

Metode class yang menginisialisasi instance Entity dari kamus yang berisi telemetri dan flag entity.

to_json()

to_json() → MutableMapping[str, Any]

Mengonversi objek Entity ke dalam format kamus yang dapat diserialisasi JSON.

Atribut

Tabel berikut menyoroti tanda klasifikasi utama dan struktur data yang terkait dengan entitas.

Atribut
`entity_type`	`str \| None` Kategori entitas.
`suspicious`	`bool` Menunjukkan apakah entitas telah ditandai sebagai berpotensi berbahaya oleh logika sistem atau intelijen eksternal.
`vulnerable`	`bool` Menunjukkan apakah entity diketahui memiliki kerentanan keamanan yang ada.
`attacker`	`bool` Ditandai jika entitas diidentifikasi sebagai sumber aktivitas berbahaya.
`internal`	`bool` Menunjukkan apakah entitas termasuk dalam jaringan atau infrastruktur internal organisasi.
`fields`	`list[MutableMapping[str, Any]]` Daftar properti tambahan atau titik data yang diperkaya yang terkait dengan entity.

class TIPCommon.data_models.EntityCard

class TIPCommon.data_models.EntityCard(identifier, entity_type, is_suspicious, linked_entities)

Dasar: object

EntityCard menampilkan ringkasan tampilan entitas, yang biasanya digunakan untuk komponen UI. Objek ini menggabungkan identifikasi, jenis, dan hubungan entitas dengan entitas lain dalam struktur yang disederhanakan.

Metode

Metode berikut mengelola serialisasi dan rekonstruksi kartu entitas.

Metode

Metode
`from_json()`	`from_json(entity_data: MutableMapping[str, Any]) → EntityCard` Metode class yang menginisialisasi instance `EntityCard` dari kamus data ringkasan entity.
`to_json()`	`to_json() → MutableMapping[str, Any]` Mengonversi objek `EntityCard` ke dalam format kamus yang dapat diserialisasi JSON.

from_json()

from_json(entity_data: MutableMapping[str, Any]) → EntityCard

Metode class yang menginisialisasi instance EntityCard dari kamus data ringkasan entity.

to_json()

to_json() → MutableMapping[str, Any]

Mengonversi objek EntityCard ke dalam format kamus yang dapat diserialisasi JSON.

Atribut

Tabel berikut menandai properti utama yang digunakan untuk mengidentifikasi dan menautkan entitas dalam kartu.

Atribut
`identifier`	`str` Nilai atau nama unik yang mengidentifikasi entitas.
`entity_type`	`str` Kategori klasifikasi entity.
`is_suspicious`	`str` Indikator string (sering kali `True` atau `False`) yang menunjukkan status mencurigakan entitas.
`linked_entities`	`list[str]` Daftar ID untuk entitas lain yang terkait dengan kartu entitas spesifik ini.

class TIPCommon.data_models.EnvironmentData

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

Dasar: object

EnvironmentData merangkum informasi konfigurasi dan branding untuk lingkungan organisasi tertentu. Hal ini mencakup parameter khusus lingkungan dan aset visual yang digunakan untuk deployment multi-tenant atau multi-lingkungan.

Metode

Metode berikut memfasilitasi pembuatan objek data lingkungan dari data JSON terstruktur.

Metode

Metode
`from_json()`	`from_json(json_data: MutableMapping[str, Any]) → EnvironmentData` Metode class yang menginisialisasi instance `EnvironmentData` dari kamus properti lingkungan.

from_json()

from_json(json_data: MutableMapping[str, Any]) → EnvironmentData

Metode class yang menginisialisasi instance EnvironmentData dari kamus properti lingkungan.

Atribut

Tabel berikut menandai parameter konfigurasi dan aset branding yang terkait dengan lingkungan.

Atribut
`environment`	`str` Nama lingkungan organisasi.
`dynamic_parameters`	`list[DynamicParameter]` Daftar key-value pair kustom khusus untuk konfigurasi lingkungan ini.
`base64_image`	`str \| None` String berenkode base64 opsional yang merepresentasikan logo atau ikon lingkungan.
`platform`	`int \| None` ID bilangan bulat yang mewakili platform atau penyedia infrastruktur tertentu.

class TIPCommon.data_models.EventCard

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

Dasar: object

EventCard menampilkan ringkasan yang ringkas dan mudah dilihat dari peristiwa keamanan tertentu. Tabel ini dirancang untuk menampilkan telemetri paling penting—seperti waktu, produk sumber, dan hasil—untuk digunakan dalam dasbor investigasi dan antrean peristiwa.

Metode

Metode berikut mengelola konversi data kartu acara antara instance objek dan format JSON.

Metode

Metode
`from_json()`	`from_json(event_data: MutableMapping[str, Any]) → EventCard` Metode class yang melakukan inisialisasi instance `EventCard` dari kamus atribut peristiwa.
`to_json()`	`to_json() → MutableMapping[str, Any]` Mengonversi objek `EventCard` ke dalam format kamus yang dapat diserialisasi JSON.

from_json()

from_json(event_data: MutableMapping[str, Any]) → EventCard

Metode class yang melakukan inisialisasi instance EventCard dari kamus atribut peristiwa.

to_json()

to_json() → MutableMapping[str, Any]

Mengonversi objek EventCard ke dalam format kamus yang dapat diserialisasi JSON.

Atribut

Tabel berikut menandai telemetri utama dan ID organisasi yang disimpan dalam kartu acara.

Atribut
`event_id`	`str` ID unik untuk catatan peristiwa tertentu.
`time`	`int` Stempel waktu Unix yang menunjukkan kapan peristiwa terjadi.
`product`	`str` Produk atau alat keamanan yang menghasilkan telemetri peristiwa.
`outcome`	`str` Hasil yang direkam dari peristiwa.
`artifact_entities`	`list[MutableMapping[str, Any]]` Daftar entitas yang diidentifikasi dalam telemetri peristiwa yang berfungsi sebagai artefak untuk kasus ini.
`fields`	`list[MutableMapping[str, Any]]` Kumpulan properti nilai kunci tambahan yang khusus untuk payload data peristiwa ini.

class TIPCommon.data_models.EventPropertyField

class TIPCommon.data_models.EventPropertyField(order, group_name, is_integration, is_highlight, items)

Dasar: object

EventPropertyField menentukan kumpulan terstruktur atribut peristiwa, yang diatur berdasarkan prioritas dan pengelompokan. Fitur ini digunakan untuk mengategorikan data telemetri untuk ditampilkan, menyoroti kolom penting untuk fokus penyelidikan.

Metode

Metode berikut menangani rekonstruksi objek kolom properti dari data JSON terstruktur.

Metode

Metode
`from_json()`	`from_json(event_property_field: MutableMapping[str, Any]) → EventPropertyField` Metode class yang melakukan inisialisasi instance `EventPropertyField` dari kamus atribut kolom.

from_json()

from_json(event_property_field: MutableMapping[str, Any]) → EventPropertyField

Metode class yang melakukan inisialisasi instance EventPropertyField dari kamus atribut kolom.

Atribut

Tabel berikut menandai item metadata dan konten yang menentukan kolom properti peristiwa.

Atribut

Atribut
`group_name`	`str` Nama grup logis tempat kolom ini berada.
`is_highlight`	`bool` Menunjukkan apakah kolom ini harus ditekankan secara visual di UI platform sebagai titik data berprioritas tinggi.
`items`	`list[FieldItem]` Daftar item data tertentu yang terdapat dalam grup properti ini.

group_name

str

Nama grup logis tempat kolom ini berada.

is_highlight

bool

Menunjukkan apakah kolom ini harus ditekankan secara visual di UI platform sebagai titik data berprioritas tinggi.

items

list[FieldItem]

Daftar item data tertentu yang terdapat dalam grup properti ini.

class TIPCommon.data_models.FieldGroupItem

class TIPCommon.data_models.FieldGroupItem(original_name, name, value)

Dasar: object

FieldGroupItem merepresentasikan titik data tertentu dalam grup kolom, dengan mempertahankan pemetaan antara nama sumber asli dan nama tampilan yang mudah dibaca.

Metode

Metode berikut mengelola serialisasi dan rekonstruksi item grup kolom.

Metode

from_json()

from_json(field_group_json: MutableMapping[str, Any]) → FieldGroupItem

Metode class yang menginisialisasi instance FieldGroupItem dari kamus JSON.

to_json()

to_json() → MutableMapping[str, Any]

Mengonversi objek FieldGroupItem menjadi format kamus yang dapat diserialisasi JSON.

class TIPCommon.data_models.FieldItem

class TIPCommon.data_models.FieldItem(original_name, name, value)

Dasar: object

FieldItem adalah struktur data dasar untuk setiap properti, yang menyimpan kunci mentah, label yang dipetakan, dan nilai terkait.

Metode

from_json()

from_json(field_json: MutableMapping[str, Any]) → FieldItem

Metode class yang membuat instance FieldItem dari kamus properti kolom.

class TIPCommon.data_models.FieldsGroup

class TIPCommon.data_models.FieldsGroup(order, group_name, is_integration, is_highlight, hide_options, items)

Dasar: object

FieldsGroup berfungsi sebagai penampung untuk mengatur beberapa item kolom ke dalam kumpulan logis. Terutama digunakan untuk mengontrol tata letak dan visibilitas data dalam antarmuka pengguna platform.

Metode

Metode berikut mengelola konversi data grup kolom antara instance objek dan JSON terstruktur.

Metode

from_json()

from_json(field_group_json: MutableMapping[str, Any]) → FieldsGroup

Metode class yang melakukan inisialisasi instance FieldsGroup dari kamus atribut grup.

to_json()

to_json() → MutableMapping[str, Any]

Mengonversi objek FieldsGroup ke dalam format kamus yang dapat diserialisasi JSON.

Atribut

Tabel berikut menyoroti properti yang menentukan perilaku tampilan dan konten grup.

Atribut

group_name

str

Label yang digunakan untuk mengidentifikasi grup di UI.

is_highlight

bool

Menentukan apakah grup harus ditekankan secara visual.

items

list[FieldGroupItem]

Daftar titik data spesifik yang ada dalam grup.

class TIPCommon.data_models.GoogleServiceAccount

class 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)

Dasar: object

GoogleServiceAccount memberikan representasi terstruktur dari kredensial akun layanan Google Cloud. Digunakan untuk mengelola detail autentikasi untuk integrasi yang berinteraksi dengan layanan Google.

Metode

Metode berikut memfasilitasi ekspor data kredensial ke dalam format standar yang diperlukan oleh library klien.

Metode

to_dict()

to_dict() → dict[str, str]

Menserialisasi properti akun layanan ke dalam kamus yang kompatibel dengan format service-account-file.json standar.

class TIPCommon.data_models.Insight

class TIPCommon.data_models.Insight(raw_data)

Dasar: object

Insight mewakili temuan atau pengamatan analitis diskrit yang dihasilkan oleh platform atau integrasi. Objek ini merangkum data mentah yang memberikan konteks tambahan atau tindakan yang direkomendasikan untuk penyelidikan keamanan.

Metode

Metode berikut mengelola serialisasi dan rekonstruksi objek insight.

Metode

from_json()

from_json(insights_response: MutableMapping[str, Any]) → Insight

Metode class yang membuat instance Insight dari kamus telemetri insight mentah.

to_json()

to_json() → MutableMapping[str, Any]

Menserialisasi objek Insight kembali ke format kamus yang kompatibel dengan JSON.

Atribut

raw_data

MutableMapping[str, Any]

Payload data mentah pokok yang berisi temuan dan metrik spesifik insight.

class TIPCommon.data_models.InstalledIntegrationInstance

class TIPCommon.data_models.InstalledIntegrationInstance(instance, identifier, integration_identifier, environment_identifier, instance_name)

Dasar: object

InstalledIntegrationInstance merepresentasikan instance integrasi yang dikonfigurasi dan spesifik yang telah di-deploy dalam lingkungan. Objek ini menghubungkan definisi integrasi umum ke deployment dan penamaan lingkungan tertentu.

Metode

Metode berikut mengelola konversi data instance integrasi antara instance objek dan JSON terstruktur.

Metode

from_json()

from_json(integration_env_json: MutableMapping[str, Any]) → InstalledIntegrationInstance

Metode class yang mengurai data JSON menjadi objek InstalledIntegrationInstance.

to_json()

to_json() → MutableMapping[str, Any]

Menserialkan data instance integrasi ke dalam format kamus yang kompatibel dengan JSON.

Atribut

Tabel berikut menyoroti ID yang digunakan untuk melacak integrasi di berbagai lingkungan organisasi.

Atribut

instance_name

str

Nama buatan pengguna untuk instance integrasi tertentu ini.

integration_identifier

str

ID unik untuk integrasi induk.

environment_identifier

str

ID untuk lingkungan organisasi tempat instance ini diinstal.

class TIPCommon.data_models.InternalDomain

class TIPCommon.data_models.InternalDomain(alias_name, id_, domain_display_name, environments_json, creation_time_unix_time_in_ms, modification_time_unix_time_in_ms)

Dasar: object

InternalDomain merepresentasikan ID domain yang dikenali sebagai bagian dari infrastruktur internal organisasi. Log ini sangat penting untuk membedakan traffic internal dan ancaman eksternal selama penyelidikan keamanan.

Metode

Metode berikut mengelola serialisasi dan rekonstruksi data domain internal.

Metode

from_json()

from_json(json_data: MutableMapping[str, Any]) → InternalDomain

Metode class yang membuat objek InternalDomain dari kamus JSON.

to_json()

to_json() → MutableMapping[str, Any]

Mengonversi objek InternalDomain menjadi format kamus yang dapat diserialisasi JSON.

Atribut

Tabel berikut menunjukkan properti yang digunakan untuk mengidentifikasi dan mengategorikan domain internal.

Atribut

domain_display_name

str

Nama domain utama.

alias_name

str

Nama atau label alternatif yang digunakan untuk mengidentifikasi domain dalam platform.

environments_json

str

String berformat JSON yang mencantumkan lingkungan tempat domain ini dianggap internal.

class TIPCommon.data_models.JobParamType

class TIPCommon.data_models.JobParamType(value)

Dasar: Enum

JobParamType menentukan jenis data yang didukung untuk parameter yang digunakan dalam tugas otomatis atau pekerjaan terjadwal. Jenis ini memfasilitasi validasi input yang tepat dan penanganan tingkat platform.

Konstanta

Konstanta berikut mewakili jenis data spesifik yang tersedia untuk parameter tugas.

Konstanta
`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

class TIPCommon.data_models.Parameter(raw_param)

Dasar: object

Parameter berfungsi sebagai class dasar utama untuk semua model terkait parameter di library. Fitur ini menyediakan antarmuka yang konsisten untuk menangani data konfigurasi mentah.

Atribut

Properti berikut memberikan akses ke data pokok yang digunakan untuk menginisialisasi parameter.

Atribut

raw_data

dict[str, Any]

Payload kamus asli yang berisi konfigurasi parameter.

Contoh

Contoh berikut menunjukkan cara menginisialisasi class Parameter dasar dan mengakses data mentahnya.

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

class TIPCommon.data_models.SLA

class TIPCommon.data_models.SLA(sla_expiration_time, critical_expiration_time, expiration_status, remaining_time_since_last_pause)

Dasar: object

SLA (Perjanjian Tingkat Layanan) mencakup batasan waktu dan status untuk pemberitahuan. Fitur ini menyediakan pelacakan presisi tinggi untuk tenggat waktu standar dan penting, termasuk logika untuk jeda yang ditangani.

Metode

Metode berikut mengelola konversi data SLA antara instance objek dan JSON terstruktur.

Metode

from_json()

from_json(sla_json: MutableMapping[str, Any]) → SLA

Metode class yang menginisialisasi instance SLA dari kamus JSON.

to_json()

to_json() → MutableMapping[str, Any]

Mengonversi objek SLA ke dalam format kamus yang dapat diserialisasi JSON.

Atribut

Tabel berikut menandai atribut waktu inti yang digunakan untuk melacak masa berlaku pemberitahuan.

Atribut

sla_expiration_time

int | None

Stempel waktu Unix yang merepresentasikan batas waktu habis masa berlaku SLA standar.

critical_expiration_time

int | None

Stempel waktu Unix yang menunjukkan batas waktu habis masa berlaku SLA penting.

expiration_status

int

Status SLA saat ini.

class TIPCommon.data_models.ScriptContext

class 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)

Dasar: object

ScriptContext adalah penampung komprehensif yang menyediakan lingkungan, ID, dan parameter yang diperlukan untuk eksekusi skrip. Log ini melacak semuanya mulai dari entitas target dan ID alur kerja hingga setelan keamanan seperti konfigurasi proxy dan vault.

Metode

Metode berikut memungkinkan modifikasi dan serialisasi konteks eksekusi skrip.

Metode

to_json()

to_json() → MutableMapping[str, Any]

Menserialisasi ScriptContext ke dalam format kamus yang kompatibel dengan JSON.

update()

update(attributes: MutableMapping[str, Any]) → None

Memperbarui atribut konteks dengan nilai dari kamus yang diberikan.

Atribut

Mengingat luasnya konteks, tabel berikut menyoroti ID eksekusi dan lingkungan yang paling penting.

Atribut
`case_id`	`int \| str \| None` ID kasus yang terkait dengan eksekusi skrip saat ini.
`workflow_id`	`str` ID alur kerja yang sedang diproses.
`parameters`	`SingleJson` Kamus yang berisi parameter runtime yang diteruskan ke skrip.
`execution_deadline_unix_time_ms`	`int` Stempel waktu Unix yang menunjukkan kapan eksekusi skrip harus berakhir.
`vault_settings`	`SiemplifyVault \| None` Setelan konfigurasi untuk mengakses data sensitif yang disimpan di vault platform.

class TIPCommon.data_models.SmimeEmailConfig

class TIPCommon.data_models.SmimeEmailConfig(email, private_key_b64, certificate_b64, ca_certificate_b64)

Dasar: object

SmimeEmailConfig merangkum aset kriptografi yang diperlukan dan pesan email yang diperlukan untuk melakukan operasi S/MIME, seperti penandatanganan atau enkripsi. Objek ini menyimpan email mentah serta kunci dan sertifikat berenkode base64.

Atribut

Tabel berikut menjelaskan komponen kriptografi yang dikelola oleh model konfigurasi ini.

Atribut
`email`	`email.message.Message` Objek pesan email Python standar untuk diproses.
`private_key_b64`	`str` Kunci pribadi berenkode base64 yang digunakan untuk penandatanganan atau dekripsi.
`certificate_b64`	`str` Sertifikat publik berenkode base64 yang terkait dengan kunci pribadi.
`ca_certificate_b64`	`str` Sertifikat Certificate Authority (CA) berenkode base64 yang digunakan untuk memverifikasi rantai kepercayaan.

class TIPCommon.data_models.SmimeType

class TIPCommon.data_models.SmimeType(value)

Dasar: Enum

SmimeType menentukan mode operasional untuk pemrosesan S/MIME, yang membedakan antara mengamankan konten melalui enkripsi atau memvalidasi pengirim menggunakan tanda tangan digital.

Konstanta

Konstanta berikut mewakili jenis pesan S/MIME yang didukung.

Konstanta
`SIGNED`	`'signed'` (Pesan ditandatangani secara digital untuk memastikan keaslian)
`ENCRYPTED`	`'encrypted'` (Isi pesan dienkripsi untuk menjaga kerahasiaan)

class TIPCommon.data_models.TypedContainer

class TIPCommon.data_models.TypedContainer()

Basis: Generic[T]

TypedContainer adalah wrapper generik yang dirancang untuk menyimpan data dari jenis tertentu. Fitur ini meningkatkan produktivitas developer dengan memberikan petunjuk jenis dan intellisense, sehingga memastikan bahwa objek yang disimpan ditangani dengan benar oleh IDE dan alat analisis statis.

class TIPCommon.data_models.UserDetails

class 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)

Dasar: object

UserDetails menyediakan profil lengkap pengguna platform, yang mencakup metadata autentikasi, peran organisasi, dan izin akses data terperinci. Hal ini penting untuk mengelola sesi pengguna dan menerapkan role-based access control (RBAC).

Metode

Metode berikut memfasilitasi rekonstruksi dan serialisasi data profil pengguna.

Metode

from_json()

from_json(user_details_json: MutableMapping[str, Any]) → UserDetails

Metode class yang melakukan inisialisasi instance UserDetails dari kamus JSON atribut pengguna.

to_json()

to_json() → MutableMapping[str, Any]

Mengonversi objek UserDetails ke dalam format kamus yang dapat diserialisasi JSON.

Atribut

Tabel berikut menyoroti struktur identifikasi dan izin utama untuk pengguna.

Atribut
`user_name`	`str` Nama pengguna sistem unik yang digunakan untuk login dan identifikasi.
`soc_roles`	`list[str]` Daftar peran SOC yang ditetapkan kepada pengguna, yang menentukan izin operasionalnya.
`data_access_context`	`DataAccessContext` Konteks yang menentukan cakupan data dan unit organisasi yang diizinkan untuk diakses pengguna.
`is_disabled`	`bool` Flag boolean yang menunjukkan apakah akun pengguna saat ini dibatasi untuk login.

class TIPCommon.data_models.UserProfileCard

class TIPCommon.data_models.UserProfileCard(raw_data, first_name, last_name, user_name, account_state)

Dasar: object

UserProfileCard memberikan ringkasan ringan profil pengguna, yang dimaksudkan untuk ditampilkan dalam komponen UI seperti header atau kartu kontak yang tidak memerlukan detail lengkap.

Metode

from_json()

from_json(user_profile_card_response: dict) → UserProfileCard

Metode class yang membuat instance UserProfileCard dari kamus atribut profil dasar.

class TIPCommon.data_models.WallData

class TIPCommon.data_models.WallData(raw_data, case_id, activity_kind, activity_data_json, favorite)

Dasar: object

WallData merepresentasikan entri di "Dinding" atau linimasa kasus. Model ini melacak log aktivitas, catatan, dan tindakan sistem yang terjadi selama siklus proses penyelidikan.

Metode

from_json()

from_json(data: MutableMapping[str, Any]) → WallData

Metode class yang menginisialisasi instance WallData dari kamus JSON aktivitas dinding.

to_json()

to_json() → MutableMapping[str, Any]

Menserialisasi objek WallData kembali ke format kamus yang kompatibel dengan JSON.

Atribut

activity_kind

str | int | None

Kategori aktivitas.

activity_data_json

str | None

String berformat JSON yang berisi detail atau payload spesifik dari aktivitas.

favorite

bool

Menunjukkan apakah entri aktivitas telah disematkan atau ditandai sebagai favorit untuk referensi cepat.

Perlu bantuan lain? Dapatkan jawaban dari anggota Komunitas dan profesional Google SecOps.

Modul data_models

class TIPCommon.data_models.AlertCard

Metode

Atribut

class TIPCommon.data_models.AlertEvent

Metode

Atribut

class TIPCommon.data_models.AlertPriority

Konstanta

class TIPCommon.data_models.AttachmentMetadata

Metode

Atribut

class TIPCommon.data_models.BaseAlert

Metode

Atribut

Contoh

class TIPCommon.data_models.BaseDataModel

Metode

Atribut

Contoh

class TIPCommon.data_models.CaseDataStatus

Konstanta

class TIPCommon.data_models.CaseDetails

Metode

Atribut

class TIPCommon.data_models.CaseOverviewInfo

Metode

Atribut

class TIPCommon.data_models.CasePriority

Konstanta

class TIPCommon.data_models.CaseSLAInfo

Metode

Atribut

class TIPCommon.data_models.CaseWallAttachment

Atribut

class TIPCommon.data_models.ConnectorCard

Metode

Atribut

class TIPCommon.data_models.ConnectorConnectivityStatusEnum

Konstanta

class TIPCommon.data_models.ConnectorParamTypes

Konstanta

class TIPCommon.data_models.ConnectorParameter

Atribut

Contoh

class TIPCommon.data_models.Container

Contoh

class TIPCommon.data_models.CreateEntity

Metode

Atribut

class TIPCommon.data_models.CustomField

Metode

Atribut

class TIPCommon.data_models.CustomFieldScope

Metode

Konstanta

class TIPCommon.data_models.CustomFieldValue

Metode

Atribut

class TIPCommon.data_models.DataAccessContext

Metode

Atribut

class TIPCommon.data_models.DatabaseContextType

Konstanta

class TIPCommon.data_models.DynamicParameter

Metode

Atribut

class TIPCommon.data_models.EmailTemplate

Metode

Atribut

class TIPCommon.data_models.Entity

Metode

Atribut

class TIPCommon.data_models.EntityCard

Metode

Atribut

class TIPCommon.data_models.EnvironmentData

Metode

Atribut

class TIPCommon.data_models.EventCard

Modul `data_models`