Google verwendet KI-Technologie, um Inhalte in Ihre bevorzugte Sprache zu übersetzen. KI-Übersetzungen können Fehler enthalten.

Modul `data_models`

Dieses Modul enthält Datenklassen zur Darstellung der folgenden Elemente:

Datenmodelle
Benachrichtigungen
Variablencontainer
Allgemeine Parameter
Connector-Parameter

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)

Basiert auf: object

AlertCard stellt eine Zusammenfassungskarte für eine Benachrichtigung dar, die wichtige Metadaten und Statusindikatoren enthält, die für die Visualisierung und das Tracking auf der Plattform verwendet werden.

Methoden

Die folgenden Methoden erleichtern die Serialisierung und Rekonstruktion von Benachrichtigungskarten aus strukturierten Daten.

Methoden

Methoden
`from_json()`	`from_json(alert_card_json: dict[str, Any]) → AlertCard` Eine Klassenmethode, die eine `AlertCard`-Instanz aus einem JSON-Dictionary erstellt.
`to_json()`	`to_json() → MutableMapping[str, Any]` Konvertiert das `AlertCard`-Objekt in ein JSON-serialisierbares Wörterbuchformat.

from_json()

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

Eine Klassenmethode, die eine AlertCard-Instanz aus einem JSON-Dictionary erstellt.

to_json()

to_json() → MutableMapping[str, Any]

Konvertiert das AlertCard-Objekt in ein JSON-serialisierbares Wörterbuchformat.

Attribute

In der folgenden Tabelle werden die primären strukturellen Attribute und komplexen Datenmodelle für die Benachrichtigung aufgeführt.

Attribute

Attribute
`fields_groups`	`list[FieldsGroup]` Eine Liste der gruppierten Felder, die mit der Benachrichtigung verknüpft sind und zur strukturierten Darstellung von Daten in der Benutzeroberfläche verwendet werden.
`sla`	`SLA` Das Service Level Agreement-Objekt, das die Reaktions- und Lösungszeiträume für die Benachrichtigung definiert.

fields_groups

list[FieldsGroup]

Eine Liste der gruppierten Felder, die mit der Benachrichtigung verknüpft sind und zur strukturierten Darstellung von Daten in der Benutzeroberfläche verwendet werden.

sla

SLA

Das Service Level Agreement-Objekt, das die Reaktions- und Lösungszeiträume für die Benachrichtigung definiert.

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

Basiert auf: object

AlertEvent stellt ein einzelnes Ereignis dar, das mit einer Benachrichtigung verknüpft ist. Es enthält spezifische Telemetriedaten, Feldattribute und Entitätsbeziehungen.

Methoden

Die folgende Methode erleichtert die Rekonstruktion von Ereignisobjekten aus strukturierten JSON-Daten.

Methoden

Methoden
`from_json()`	`from_json(event_json: MutableMapping[str, Any]) → AlertEvent` Eine Klassenmethode, die eine `AlertEvent`-Instanz aus einem JSON-Wörterbuch erstellt, das ihre Attribute darstellt.

from_json()

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

Eine Klassenmethode, die eine AlertEvent-Instanz aus einem JSON-Wörterbuch erstellt, das ihre Attribute darstellt.

Attribute

In der folgenden Tabelle sind die primären strukturellen Attribute und komplexen Datenmodelle aufgeführt, die mit dem Ereignis verknüpft sind.

Attribute

Attribute
`fields`	`list[EventPropertyField]` Eine Liste von Attributfeldern, die für das Ereignis spezifisch sind und seine eindeutigen Datenpunkte definieren.
`artifact_entities`	`list[str]` Eine Liste von Entitäts-IDs, die aus der Ereignis-Telemetrie extrahiert wurden.

fields

list[EventPropertyField]

Eine Liste von Attributfeldern, die für das Ereignis spezifisch sind und seine eindeutigen Datenpunkte definieren.

artifact_entities

list[str]

Eine Liste von Entitäts-IDs, die aus der Ereignis-Telemetrie extrahiert wurden.

class TIPCommon.data_models.AlertPriority

class TIPCommon.data_models.AlertPriority(value)

Basis: Enum

AlertPriority definiert die standardisierten, ganzzahligen Schweregrade, die zum Kategorisieren und Priorisieren von Benachrichtigungen auf der Plattform verwendet werden.

Konstanten

Die folgenden Konstanten stellen die spezifischen Prioritätswerte dar, die Warnungen zugewiesen werden.

Konstanten
`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)

Basiert auf: object

AttachmentMetadata kapselt die beschreibenden Daten und Eigenschaften, die mit einer Dateianlage verknüpft sind, und bietet Methoden für die Konvertierung und den Abruf strukturierter Daten.

Methoden

Die folgende Methode bietet eine standardisierte Möglichkeit, Fallobjekte aus JSON-Nutzlasten zu rekonstruieren.

Methoden

Methoden
`from_json()`	`from_json(result_data: MutableMapping[str, Any]) → Self` Eine Klassenmethode, die eine neue `AttachmentMetadata`-Instanz mit einem bereitgestellten Dictionary von Metadateneigenschaften initialisiert.
`to_json()`	`to_json() → MutableMapping[str, Any]` Serialisiert das `AttachmentMetadata`-Objekt zurück in ein JSON-kompatibles Wörterbuchformat.

from_json()

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

Eine Klassenmethode, die eine neue AttachmentMetadata-Instanz mit einem bereitgestellten Dictionary von Metadateneigenschaften initialisiert.

to_json()

to_json() → MutableMapping[str, Any]

Serialisiert das AttachmentMetadata-Objekt zurück in ein JSON-kompatibles Wörterbuchformat.

Attribute

In der folgenden Tabelle sind die primären Datenstrukturen aufgeführt, die zum Speichern der Metadateneigenschaften des Anhangs verwendet werden.

Attribute

Attribute
`raw_data`	`MutableMapping[str, Any]` Das zugrunde liegende Dictionary mit den Rohmetadatenattributen, wie sie von der Quelle empfangen wurden.

raw_data

MutableMapping[str, Any]

Das zugrunde liegende Dictionary mit den Rohmetadatenattributen, wie sie von der Quelle empfangen wurden.

class TIPCommon.data_models.BaseAlert

class TIPCommon.data_models.BaseAlert(raw_data, alert_id)

Basiert auf: object

BaseAlert ist ein grundlegendes Modell, das eine allgemeine Sicherheitswarnung darstellt. Es bietet eine standardisierte Struktur zum Speichern von Rohdaten der Telemetrie zusammen mit einer eindeutigen Plattform-ID.

Methoden

Mit der folgenden Methode kann die Benachrichtigung in ein Standardformat serialisiert werden.

Methoden

Methoden
`to_json()`	`to_json() → dict[str, Any]` Konvertiert die Benachrichtigung in ein JSON-serialisierbares Dictionary, wie es von `json.loads()` zurückgegeben wird.

to_json()

to_json() → dict[str, Any]

Konvertiert die Benachrichtigung in ein JSON-serialisierbares Dictionary, wie es von json.loads() zurückgegeben wird.

Attribute

In der folgenden Tabelle sind die wichtigsten Datenpunkte aufgeführt, die von diesem Modell verwaltet werden.

Attribute

Attribute
`raw_data`	`dict[str, Any]` Die Nutzlast der Rohdaten, die mit der Benachrichtigung verknüpft ist.
`alert_id`	`Any` Die eindeutige Kennung, die der Benachrichtigung zugewiesen ist.

raw_data

dict[str, Any]

Die Nutzlast der Rohdaten, die mit der Benachrichtigung verknüpft ist.

alert_id

Any

Die eindeutige Kennung, die der Benachrichtigung zugewiesen ist.

Beispiel

Im folgenden Beispiel wird gezeigt, wie Sie ein BaseAlert initialisieren und auf die Rohdaten und die serialisierte Ausgabe zugreifen.

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

Basiert auf: object

BaseDataModel fungiert als übergeordnete Klasse für verschiedene Datenstrukturen in der Bibliothek und sorgt für eine einheitliche Verarbeitung von Rohdaten und Serialisierung.

Methoden

Mit der folgenden Methode werden Rohdaten in einem Format abgerufen, das mit JSON-Vorgängen kompatibel ist.

Methoden

Methoden
`to_json()`	`to_json() → dict[str, Any]` Serialisiert die im Modell gespeicherten Rohdaten in ein Dictionary-Format.

to_json()

to_json() → dict[str, Any]

Serialisiert die im Modell gespeicherten Rohdaten in ein Dictionary-Format.

Attribute

In der folgenden Tabelle wird der primäre Datenspeicher für das Basismodell beschrieben.

Attribute

Attribute
`raw_data`	`dict[str, Any]` Die ursprüngliche Rohdaten-Nutzlast, die zum Initialisieren des Modells verwendet wurde.

raw_data

dict[str, Any]

Die ursprüngliche Rohdaten-Nutzlast, die zum Initialisieren des Modells verwendet wurde.

Beispiel

Das folgende Beispiel zeigt die grundlegende Initialisierung des Datenmodells und die Verwendung der Serialisierungsmethode.

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

Basis: Enum

CaseDataStatus definiert die unterstützten Betriebsstatus für Fälle auf der Plattform, von der ersten Aufnahme bis zum endgültigen Schließen oder Zusammenführen.

Konstanten

Die folgenden Konstanten stellen die spezifischen Statusindikatoren dar, die Fall-Daten zugewiesen sind.

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

class TIPCommon.data_models.CaseDetails

Basiert auf: object

CaseDetails bietet eine umfassende Ansicht eines Sicherheitsfalls, einschließlich Eigenschaften zur Statusprüfung und Methoden zum Rekonstruieren oder Serialisieren von Falldaten.

Methoden

Die folgenden Methoden verwalten die Konvertierung von Falldetails zwischen Objektinstanzen und strukturierten JSON-Formaten.

Methoden

Methoden
`from_json()`	`from_json(case_details_json: MutableMapping[str, Any]) → CaseDetails` Eine Klassenmethode, die eine `CaseDetails`-Instanz aus einem Dictionary mit Fallattributen initialisiert.
`to_json()`	`to_json(include_activities: bool = False) → MutableMapping[str, Any]` Konvertiert das `CaseDetails`-Objekt in ein JSON-serialisierbares Dictionary. Setzen Sie `include_activities` auf `True`, um Fallaktivitätsprotokolle einzuschließen.

from_json()

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

Eine Klassenmethode, die eine CaseDetails-Instanz aus einem Dictionary mit Fallattributen initialisiert.

to_json()

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

Konvertiert das CaseDetails-Objekt in ein JSON-serialisierbares Dictionary. Setzen Sie include_activities auf True, um Fallaktivitätsprotokolle einzuschließen.

Attribute

Die folgenden Eigenschaften liefern logische Hinweise zum aktuellen Status des Falls.

Attribute

Attribute
`is_closed`	`bool` Ein boolesches Attribut, das angibt, ob der Fall geschlossen ist.
`is_open`	`bool` Ein boolesches Attribut, das angibt, ob der Fall aktiv oder offen ist.

is_closed

bool

Ein boolesches Attribut, das angibt, ob der Fall geschlossen ist.

is_open

bool

Ein boolesches Attribut, das angibt, ob der Fall aktiv oder offen ist.

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

Basiert auf: object

CaseOverviewInfo bietet eine allgemeine Zusammenfassung eines Sicherheitsvorfalls, in der Metadaten, der SLA-Status (Service Level Agreement) und Organisationsdetails für die Dashboard- und Warteschlangenverwaltung zusammengefasst werden.

Methoden

Die folgende Methode erleichtert die Rekonstruktion von Fallübersichtsobjekten aus strukturierten JSON-Daten.

Methoden

Methoden
`from_json()`	`from_json(json_data: MutableMapping[str, Any]) → CaseOverviewInfo` Eine Klassenmethode, die eine `CaseOverviewInfo`-Instanz aus einem Dictionary mit Attributen für Fallzusammenfassungen initialisiert.

from_json()

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

Eine Klassenmethode, die eine CaseOverviewInfo-Instanz aus einem Dictionary mit Attributen für Fallzusammenfassungen initialisiert.

Attribute

In der folgenden Tabelle sind die wichtigsten strukturellen Attribute, Enums und operativen Messwerte für die Fallübersicht aufgeführt.

Attribute
`priority`	`CasePriority` Der Schweregrad, der dem Fall zugewiesen ist.
`status`	`CaseDataStatus \| None` Der aktuelle Betriebsstatus der Falldaten.
`workflow_status`	`int \| None` Der aktuelle Schritt oder Status in der automatisierten Workflow-Engine der Plattform.
`score`	`int \| None` Die berechnete Risikobewertung oder Wichtigkeit, die dem Fall zugewiesen wurde.
`case_sla`	`CaseSLAInfo \| None` Informationen zum SLA-Tracking speziell für den Lebenszyklus der Fallbearbeitung.
`alerts_sla`	`CaseSLAInfo \| None` Informationen zum SLA-Tracking für die einzelnen Benachrichtigungen im Fall.
`environment_data`	`EnvironmentData \| None` Metadaten zur spezifischen Organisationsumgebung, in der der Fall entstanden ist.
`tags`	`list[str]` Eine Liste benutzerdefinierter oder vom System generierter Labels, die dem Fall zugeordnet sind.

class TIPCommon.data_models.CasePriority

class TIPCommon.data_models.CasePriority(value)

Basis: Enum

CasePriority definiert die standardisierten, ganzzahligen Schweregrade, die zum Kategorisieren und Priorisieren von Anfragen auf der Plattform verwendet werden.

Konstanten

Die folgenden Konstanten stellen die spezifischen Prioritätswerte dar, die Fällen zugewiesen sind.

Konstanten
`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)

Basiert auf: object

CaseSLAInfo enthält Daten zum Tracking von Service Level Agreements (SLAs) und bietet Zeitstempel für den Ablauf sowie Statusindikatoren, um eine zeitnahe Reaktion auf Vorfälle zu gewährleisten.

Methoden

Mit der folgenden Methode können SLA-Info-Objekte aus strukturierten JSON-Daten erstellt werden.

Methoden

Methoden
`from_json()`	`from_json(json_data: MutableMapping[str, Any]) → CaseSLAInfo` Eine Klassenmethode, die eine `CaseSLAInfo`-Instanz aus einem Dictionary mit SLA-Attributen initialisiert.

from_json()

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

Eine Klassenmethode, die eine CaseSLAInfo-Instanz aus einem Dictionary mit SLA-Attributen initialisiert.

Attribute

In der folgenden Tabelle werden die wichtigsten Zeit- und Statusattribute aufgeführt, die zum Überwachen von Fallfristen verwendet werden.

Attribute
`expiration_time_ms`	`int \| None` Der Unix-Zeitstempel (in Millisekunden), wenn die Standard-SLA abläuft.
`critical_expiration_time_ms`	`int \| None` Der Unix-Zeitstempel (in Millisekunden), wenn der kritische SLA-Schwellenwert erreicht wird.
`expiration_status`	`int \| None` Eine Ganzzahl, die den aktuellen Status der SLA darstellt.
`last_pause_remaining_time_ms`	`int \| None` Die verbleibende Zeit auf der SLA-Uhr zum Zeitpunkt der letzten Pause.

class TIPCommon.data_models.CaseWallAttachment

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

Basiert auf: object

CaseWallAttachment stellt eine Datei oder ein Datenobjekt dar, das an die Beweiswand eines Falls angehängt ist, einschließlich des Rohinhalts im Base64-Format und der zugehörigen Metadaten.

Attribute

In der folgenden Tabelle werden die primären Eigenschaften und Inhaltsdaten des Anhangs aufgeführt.

Attribute
`name`	`str` Der Dateiname oder Anzeigename des Anhangs.
`file_type`	`str` Der MIME-Typ oder die Dateiendung, die das Format der angehängten Daten angibt.
`base64_blob`	`str` Der tatsächliche Inhalt der Datei, codiert als Base64-String.
`is_important`	`bool` Ein Flag, das angibt, ob der Anhang als wichtiger Beweis für die Untersuchung markiert ist.

class TIPCommon.data_models.ConnectorCard

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

Basiert auf: object

ConnectorCard bietet eine Zusammenfassung der Konfiguration eines bestimmten Connectors und

aktuellen Betriebsstatus auf der Plattform.

Methoden

Die folgende Methode erleichtert die Erstellung von Connector-Karteninstanzen aus strukturierten JSON-Daten.

Methoden

Methoden
`from_json()`	`from_json(connector_card_json: MutableMapping[str, Any]) → ConnectorCard` Eine Klassenmethode, die eine `ConnectorCard`-Instanz aus einem Dictionary mit Connector-Attributen initialisiert.

from_json()

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

Eine Klassenmethode, die eine ConnectorCard-Instanz aus einem Dictionary mit Connector-Attributen initialisiert.

Attribute

In der folgenden Tabelle sind der Betriebsstatus und die Identifizierungseigenschaften des Connectors aufgeführt.

Attribute

Attribute
`status`	`ConnectorConnectivityStatusEnum` Der aktuelle Verbindungs- und Systemstatus des Connectors.
`is_enabled`	`bool` Gibt an, ob der Connector aktiv ist und Daten verarbeitet.

status

ConnectorConnectivityStatusEnum

Der aktuelle Verbindungs- und Systemstatus des Connectors.

is_enabled

bool

Gibt an, ob der Connector aktiv ist und Daten verarbeitet.

class TIPCommon.data_models.ConnectorConnectivityStatusEnum

class TIPCommon.data_models.ConnectorConnectivityStatusEnum(value)

Basis: Enum

ConnectorConnectivityStatusEnum definiert die möglichen Verbindungsstatus für einen Connector und gibt an, ob er erfolgreich mit der Zielintegration kommuniziert.

Konstanten

Die folgenden Konstanten stellen den Zustand der Verbindung des Connectors dar.

Konstanten
`LIVE`	`0`
`NO_CONNECTIVITY`	`1`

class TIPCommon.data_models.ConnectorParamTypes

class TIPCommon.data_models.ConnectorParamTypes(value)

Basis: Enum

ConnectorParamTypes definiert die unterstützten Datentypen für Parameter der Connector-Konfiguration. Diese Typen sorgen für eine korrekte Validierung und Darstellung der Benutzeroberfläche in den Einstellungen der Plattform.

Konstanten

Die folgenden Konstanten stellen die spezifischen Datentypen dar, die für Parameter verfügbar sind.

Konstanten
`BOOLEAN`	`0` (boolescher Schalter)
`INTEGER`	`1` (numerische Ganzzahl)
`STRING`	`2` (Standardtextstring)
`PASSWORD`	`3` (maskiertes Passwortfeld)
`IP`	`4` (IP-Adresse)
`HOST`	`5` (Hostname)
`URL`	`6` (URL-String)
`DOMAIN`	`7` (Domainname)
`EMAIL`	`8` (E-Mail-Adresse)
`SCRIPT`	`12` (Parameter für Legacy-Script)
`NULL`	`-1` (ungültiger Parametertyp)

class TIPCommon.data_models.ConnectorParameter

class TIPCommon.data_models.ConnectorParameter(raw_param)

Grundlagen: Parameter

ConnectorParameter stellt eine einzelne Konfigurationseinstellung für einen Connector dar. Es erweitert das Basisparametermodell um spezifische Metadaten wie Validierungstypen und obligatorische Anforderungen.

Attribute

Die folgenden Eigenschaften bieten Zugriff auf die Konfigurationsdetails und Einschränkungen des Connector-Parameters.

Attribute
`name`	`str` Der eindeutige Name, der zur Identifizierung des Parameters in der Connector-Konfiguration verwendet wird.
`value`	`Any` Der aktuelle Wert, der dem Parameter zugewiesen ist.
`type`	`ConnectorParamTypes` Der Datentyp des Parameters, der für die Validierung und das Rendern der Benutzeroberfläche verwendet wird.
`mode`	`int` Der Betriebsmodus oder die Sichtbarkeitseinstellung des Parameters.
`is_mandatory`	`bool` Gibt an, ob für diesen Parameter ein Wert angegeben werden muss, bevor der Connector gespeichert oder ausgeführt wird.

Beispiel

Das folgende Beispiel zeigt, wie Sie ein ConnectorParameter mit einem Rohwörterbuch initialisieren und auf seine Eigenschaften zugreifen.

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

Basiert auf: object

Container fungiert als generisches, dynamisches Objekt zum Speichern von Variablen als Attributen. Sie ist nützlich, um beliebige Datensammlungen zwischen verschiedenen Komponenten der Plattform zu übergeben.

Beispiel

Das folgende Beispiel zeigt, wie ein Container initialisiert und eine Variable dynamisch zugewiesen und abgerufen wird.

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

Basiert auf: object

CreateEntity enthält die Anweisungen, die zum Erstellen und Verknüpfen einer neuen Einheit mit einem vorhandenen Fall und einer vorhandenen Benachrichtigung erforderlich sind. Sie enthält Logik für die regexbasierte Zuordnung von Verbindungen und Beziehungen.

Methoden

Die folgende Methode verarbeitet die Konvertierung von Anleitungen zum Erstellen von Einheiten in ein plattformkompatibles Format.

Methoden

Methoden
`to_json()`	`to_json() → MutableMapping[str, Any]` Konvertiert das `CreateEntity`-Objekt in ein JSON-serialisierbares Dictionary.

to_json()

to_json() → MutableMapping[str, Any]

Konvertiert das CreateEntity-Objekt in ein JSON-serialisierbares Dictionary.

Attribute

In der folgenden Tabelle werden die wichtigsten Eigenschaften aufgeführt, die zum Definieren der neuen Einheit und ihrer Beziehungen innerhalb der Plattform verwendet werden.

Attribute
`case_id`	`int` Die eindeutige ID des Falls, in dem die Entität erstellt wird.
`alert_identifier`	`str` Die ID der Benachrichtigung, der diese Entität zugeordnet ist.
`entity_type`	`str` Die Klassifizierung der Entität.
`entity_identifier`	`str` Der spezifische Wert oder Name, der die Entität identifiziert.
`entity_to_connect_regex`	`str` Ein regulärer Ausdruck, mit dem andere Einheiten identifiziert werden, die mit dieser Einheit verknüpft werden sollen.
`types_to_connect`	`list[str] \| None` Eine bestimmte Liste von Entitätstypen, die basierend auf dem regulären Ausdruck für die Verbindung infrage kommen.
`is_primary_link`	`bool` Gibt an, ob diese Verbindung die primäre Beziehung zwischen den Entitäten darstellt.
`is_directional`	`bool` Gibt an, ob die Verbindung eine definierte Richtung (Quelle zu Ziel) hat oder wechselseitig ist.

class TIPCommon.data_models.CustomField

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

Basiert auf: object

CustomField steht für ein benutzerdefiniertes Datenfeld auf der Plattform. Damit können Standarddatenmodelle durch Hinzufügen spezifischer Metadaten erweitert werden, die auf die Anforderungen der Organisation zugeschnitten sind.

Methoden

Mit der folgenden Methode können benutzerdefinierte Feldobjekte aus strukturierten JSON-Daten rekonstruiert werden.

Methoden

Methoden
`from_json()`	`from_json(json_data: MutableMapping[str, Any]) → CustomField` Eine Klassenmethode, die eine `CustomField`-Instanz aus einem Dictionary mit Feldattributen initialisiert.

from_json()

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

Eine Klassenmethode, die eine CustomField-Instanz aus einem Dictionary mit Feldattributen initialisiert.

Attribute

In der folgenden Tabelle sind die primären Attribute und Bereichseinschränkungen des benutzerdefinierten Felds aufgeführt.

Attribute
`id`	`int` Die eindeutige Kennung für das benutzerdefinierte Feld.
`display_name`	`str` Das für Menschen lesbare Label, das auf der Benutzeroberfläche der Plattform angezeigt wird.
`type`	`str` Der Datentyp des Felds.
`scopes`	`list[CustomFieldScope]` Eine Liste der Anwendungsbereiche, in denen dieses Feld verfügbar ist

class TIPCommon.data_models.CustomFieldScope

class TIPCommon.data_models.CustomFieldScope(value)

Basis: Enum

Mit CustomFieldScope werden die gültigen Ziele definiert, auf die ein benutzerdefiniertes Feld innerhalb der Plattformhierarchie angewendet wird.

Methoden

Die folgende Methode bietet ein Hilfsmittel zum Auflösen des Pfads des bereichsbezogenen Objekts.

Methoden

Methoden
`build_parent_path()`	`build_parent_path(identifier: int) → str` Erstellt den internen Plattformpfad für die angegebene Kennung des übergeordneten Objekts.

build_parent_path()

build_parent_path(identifier: int) → str

Erstellt den internen Plattformpfad für die angegebene Kennung des übergeordneten Objekts.

Konstanten

Die folgenden Konstanten stellen die spezifischen Bereiche dar, die für benutzerdefinierte Felder verfügbar sind.

Konstanten
`ALERTS`	`'Alert'`
`CASE`	`'Case'`

class TIPCommon.data_models.CustomFieldValue

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

Basiert auf: object

CustomFieldValue steht für die spezifischen Daten, die einer benutzerdefinierten Feldinstanz zugewiesen sind. Sie verknüpft die Felddefinition mit den tatsächlichen Inhalten, die von einem Nutzer oder einem automatisierten Prozess bereitgestellt werden.

Methoden

Die folgende Methode erleichtert die Rekonstruktion benutzerdefinierter Feldwerte aus strukturierten JSON-Daten.

Methoden

Methoden
`from_json()`	`from_json(json_data: MutableMapping[str, Any]) → CustomFieldValue` Eine Klassenmethode, die eine `CustomFieldValue`-Instanz aus einem Dictionary mit Wertattributen initialisiert.

from_json()

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

Eine Klassenmethode, die eine CustomFieldValue-Instanz aus einem Dictionary mit Wertattributen initialisiert.

Attribute

In der folgenden Tabelle werden die primären Attribute und Kontextkennzeichnungen für den benutzerdefinierten Feldwert aufgeführt.

Attribute
`custom_field_id`	`int` Die Kennung der `CustomField`-Definition, zu der dieser Wert gehört.
`values`	`list[str]` Eine Liste von Strings, die die tatsächlichen Daten darstellen, die im Feld gespeichert sind.
`scope`	`CustomFieldScope` Der Anwendungsbereich, in dem dieser spezifische Wert angewendet wird.
`identifier`	`int` Die eindeutige Kennung für das spezifische Objekt, das diesen Wert enthält.

class TIPCommon.data_models.DataAccessContext

class TIPCommon.data_models.DataAccessContext(global_access, assigned_scopes)

Basiert auf: object

Mit DataAccessContext werden die Berechtigungen und Sichtbarkeitseinschränkungen für einen Nutzer oder Prozess definiert. Dadurch wird festgelegt, auf welche Datenbereiche während der Ausführung zugegriffen werden kann.

Methoden

Die folgenden Methoden verwalten die Konvertierung von Daten zum Zugriffskontext zwischen Objektinstanzen und JSON-Formaten.

Methoden

Methoden
`from_json()`	`from_json(json_data: MutableMapping[str, Any]) → DataAccessContext` Eine Klassenmethode, die eine `DataAccessContext`-Instanz aus einem Dictionary mit Zugriffseigenschaften initialisiert.
`to_json()`	`to_json() → dict` Konvertiert das `DataAccessContext`-Objekt in ein Dictionary-Format.

from_json()

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

Eine Klassenmethode, die eine DataAccessContext-Instanz aus einem Dictionary mit Zugriffseigenschaften initialisiert.

to_json()

to_json() → dict

Konvertiert das DataAccessContext-Objekt in ein Dictionary-Format.

Attribute

In der folgenden Tabelle werden die primären Zugriffskontrollen hervorgehoben, die im Kontext definiert sind.

Attribute

Attribute
`global_access`	`bool` Gibt an, ob der Kontext uneingeschränkten Zugriff auf alle Datenbereiche ermöglicht.
`assigned_scopes`	`list[Any]` Eine Liste der spezifischen Bereiche oder Organisationseinheiten, denen der Zugriff explizit gewährt wurde.

global_access

bool

Gibt an, ob der Kontext uneingeschränkten Zugriff auf alle Datenbereiche ermöglicht.

assigned_scopes

list[Any]

Eine Liste der spezifischen Bereiche oder Organisationseinheiten, denen der Zugriff explizit gewährt wurde.

class TIPCommon.data_models.DatabaseContextType

class TIPCommon.data_models.DatabaseContextType(value)

Basis: Enum

DatabaseContextType gibt den operativen Kontext für Datenbankinteraktionen an und sorgt dafür, dass Daten im richtigen logischen Segment der Plattform gespeichert oder abgerufen werden.

Konstanten

Die folgenden Konstanten stellen die spezifischen Bereiche der Plattform dar, in denen Datenbankvorgänge ausgeführt werden.

Konstanten
`GLOBAL`	`0` (globaler systemweiter Kontext)
`CASE`	`1` (Kontext für einen bestimmten Sicherheitsfall)
`ALERT`	`2` (Kontext der einzelnen Benachrichtigung)
`JOB`	`3` (geplanter Job oder Automatisierungskontext)
`CONNECTOR`	`4` (Kontext des Daten-Connectors)

class TIPCommon.data_models.DynamicParameter

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

Basiert auf: object

DynamicParameter stellt ein flexibles Schlüssel/Wert-Paar dar, das verwendet wird, um Laufzeitkonfigurationen oder benutzerdefinierte Metadaten zwischen Systemkomponenten zu übergeben.

Methoden

Die folgende Methode verarbeitet die Rekonstruktion dynamischer Parameter aus strukturierten JSON-Daten.

Methoden

Methoden
`from_json()`	`from_json(json_data: MutableMapping[str, Any]) → DynamicParameter` Eine Klassenmethode, die eine `DynamicParameter`-Instanz aus einem Dictionary mit Schlüssel- und Wertattributen initialisiert.

from_json()

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

Eine Klassenmethode, die eine DynamicParameter-Instanz aus einem Dictionary mit Schlüssel- und Wertattributen initialisiert.

Attribute

In der folgenden Tabelle werden die Attribute des dynamischen Parameters beschrieben.

Attribute

Attribute
`key`	`str` Der Name oder die Kennzeichnung des Parameters.
`value`	`str` Die mit dem Schlüssel verknüpften Dateninhalte.

key

str

Der Name oder die Kennzeichnung des Parameters.

value

str

Die mit dem Schlüssel verknüpften Dateninhalte.

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)

Basiert auf: object

EmailTemplate steht für ein standardisiertes Kommunikationsformat, das für Benachrichtigungen und Berichte auf der Plattform verwendet wird. Es enthält den Nachrichteninhalt, Metadaten und Umgebungsbeschränkungen.

Methoden

Die folgenden Methoden verwalten die Serialisierung und Rekonstruktion von E-Mail-Vorlagen.

Methoden

Methoden
`from_json()`	`from_json(data: MutableMapping[str, Any]) → EmailTemplate` Eine Klassenmethode, die eine `EmailTemplate`-Instanz aus einem Dictionary mit Vorlagendaten initialisiert.
`to_json()`	`to_json() → dict` Konvertiert das `EmailTemplate`-Objekt in ein JSON-serialisierbares Wörterbuchformat.

from_json()

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

Eine Klassenmethode, die eine EmailTemplate-Instanz aus einem Dictionary mit Vorlagendaten initialisiert.

to_json()

to_json() → dict

Konvertiert das EmailTemplate-Objekt in ein JSON-serialisierbares Wörterbuchformat.

Attribute

In der folgenden Tabelle sind die primären Eigenschaften und Strukturdaten der E-Mail-Vorlage aufgeführt.

Attribute

Attribute
`content`	`str` Der Text oder die HTML-Struktur der E‑Mail-Vorlage.
`environments`	`list[str]` Eine Liste der Organisationsumgebungen, in denen diese Vorlage verwendet werden kann.
`template_type`	`int \| str` Die Klassifizierung oder Kategorie der Vorlage.

content

str

Der Text oder die HTML-Struktur der E‑Mail-Vorlage.

environments

list[str]

Eine Liste der Organisationsumgebungen, in denen diese Vorlage verwendet werden kann.

template_type

int | str

Die Klassifizierung oder Kategorie der Vorlage.

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)

Basiert auf: object

Eine Entität stellt ein bestimmtes beobachtbares Element oder Objekt von Interesse in einem Sicherheitsfall dar, z. B. eine IP-Adresse, einen Dateihash oder einen Nutzer. Es werden sowohl die Rohdaten der Telemetrie als auch verschiedene boolesche „Tags“ erfasst, die die Rolle oder das Risikoniveau der Entität in der Untersuchung angeben.

Methoden

Mit den folgenden Methoden wird die Serialisierung und Rekonstruktion von Entitätsobjekten verwaltet.

Methoden

Methoden
`from_json()`	`from_json(entity_response: MutableMapping[str, Any]) → Entity` Eine Klassenmethode, die eine `Entity`-Instanz aus einem Dictionary initialisiert, das Telemetrie und Flags für Entitäten enthält.
`to_json()`	`to_json() → MutableMapping[str, Any]` Konvertiert das `Entity`-Objekt in ein JSON-serialisierbares Wörterbuchformat.

from_json()

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

Eine Klassenmethode, die eine Entity-Instanz aus einem Dictionary initialisiert, das Telemetrie und Flags für Entitäten enthält.

to_json()

to_json() → MutableMapping[str, Any]

Konvertiert das Entity-Objekt in ein JSON-serialisierbares Wörterbuchformat.

Attribute

In der folgenden Tabelle sind die primären Klassifizierungs-Flags und Datenstrukturen aufgeführt, die mit der Entität verknüpft sind.

Attribute
`entity_type`	`str \| None` Die Kategorie der Entität.
`suspicious`	`bool` Gibt an, ob die Entität von der Systemlogik oder externen Informationen als potenziell schädlich gekennzeichnet wurde.
`vulnerable`	`bool` Gibt an, ob für die Entität bekannte Sicherheitslücken bestehen.
`attacker`	`bool` Wird gekennzeichnet, wenn die Entität als Quelle schädlicher Aktivitäten identifiziert wird.
`internal`	`bool` Gibt an, ob die Einheit zum internen Netzwerk oder zur Infrastruktur der Organisation gehört.
`fields`	`list[MutableMapping[str, Any]]` Eine Liste zusätzlicher Attribute oder angereicherter Datenpunkte, die mit der Entität verknüpft sind.

class TIPCommon.data_models.EntityCard

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

Basiert auf: object

EntityCard stellt eine zusammengefasste Ansicht einer Entität dar, die in der Regel für UI-Komponenten verwendet wird. Darin werden die Identifizierung, der Typ und die Beziehungen der Entität zu anderen Entitäten in einer vereinfachten Struktur zusammengefasst.

Methoden

Die folgenden Methoden verwalten die Serialisierung und Rekonstruktion von Karten für Rechtssubjekte.

Methoden

Methoden
`from_json()`	`from_json(entity_data: MutableMapping[str, Any]) → EntityCard` Eine Klassenmethode, die eine `EntityCard`-Instanz aus einem Dictionary mit Zusammenfassungsdaten für Entitäten initialisiert.
`to_json()`	`to_json() → MutableMapping[str, Any]` Konvertiert das `EntityCard`-Objekt in ein JSON-serialisierbares Wörterbuchformat.

from_json()

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

Eine Klassenmethode, die eine EntityCard-Instanz aus einem Dictionary mit Zusammenfassungsdaten für Entitäten initialisiert.

to_json()

to_json() → MutableMapping[str, Any]

Konvertiert das EntityCard-Objekt in ein JSON-serialisierbares Wörterbuchformat.

Attribute

In der folgenden Tabelle werden die primären Attribute aufgeführt, die zum Identifizieren und Verknüpfen von Einheiten auf der Karte verwendet werden.

Attribute
`identifier`	`str` Der eindeutige Wert oder Name, der die Entität identifiziert.
`entity_type`	`str` Die Klassifizierungskategorie der Einheit.
`is_suspicious`	`str` Ein String-Indikator (oft `True` oder `False`), der den verdächtigen Status der Entität darstellt.
`linked_entities`	`list[str]` Eine Liste von IDs für andere Entitäten, die mit dieser bestimmten Entitätenkarte verknüpft sind.

class TIPCommon.data_models.EnvironmentData

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

Basiert auf: object

EnvironmentData enthält Konfigurations- und Brandinginformationen für eine bestimmte Organisationsumgebung. Dazu gehören umgebungsspezifische Parameter und visuelle Assets, die für Bereitstellungen mit mehreren Mandanten oder Umgebungen verwendet werden.

Methoden

Die folgende Methode erleichtert das Erstellen von Umgebungsdatenobjekten aus strukturierten JSON-Daten.

Methoden

Methoden
`from_json()`	`from_json(json_data: MutableMapping[str, Any]) → EnvironmentData` Eine Klassenmethode, die eine `EnvironmentData`-Instanz aus einem Dictionary mit Umgebungseigenschaften initialisiert.

from_json()

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

Eine Klassenmethode, die eine EnvironmentData-Instanz aus einem Dictionary mit Umgebungseigenschaften initialisiert.

Attribute

In der folgenden Tabelle sind die Konfigurationsparameter und Branding-Assets aufgeführt, die mit der Umgebung verknüpft sind.

Attribute
`environment`	`str` Der Name der Organisationsumgebung.
`dynamic_parameters`	`list[DynamicParameter]` Eine Liste benutzerdefinierter Schlüssel/Wert-Paare, die für die Konfiguration dieser Umgebung spezifisch sind.
`base64_image`	`str \| None` Ein optionaler base64-codierter String, der das Logo oder Symbol der Umgebung darstellt.
`platform`	`int \| None` Eine Ganzzahl-ID, die den jeweiligen Plattform- oder Infrastrukturanbieter darstellt.

class TIPCommon.data_models.EventCard

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

Basiert auf: object

EventCard ist eine kurze, visuell ansprechende Zusammenfassung eines bestimmten Sicherheitsereignisses. Sie wurde entwickelt, um die wichtigsten Telemetriedaten wie Timing, Quellprodukt und Ergebnis für die Verwendung in Untersuchungsdashboards und Ereigniswarteschlangen bereitzustellen.

Methoden

Die folgenden Methoden verwalten die Konvertierung von Eventkarten-Daten zwischen Objektinstanzen und JSON-Formaten.

Methoden

Methoden
`from_json()`	`from_json(event_data: MutableMapping[str, Any]) → EventCard` Eine Klassenmethode, die eine `EventCard`-Instanz aus einem Dictionary mit Ereignisattributen initialisiert.
`to_json()`	`to_json() → MutableMapping[str, Any]` Konvertiert das `EventCard`-Objekt in ein JSON-serialisierbares Wörterbuchformat.

from_json()

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

Eine Klassenmethode, die eine EventCard-Instanz aus einem Dictionary mit Ereignisattributen initialisiert.

to_json()

to_json() → MutableMapping[str, Any]

Konvertiert das EventCard-Objekt in ein JSON-serialisierbares Wörterbuchformat.

Attribute

In der folgenden Tabelle sind die primären Telemetrie- und Organisationskennzeichnungen aufgeführt, die auf der Ereigniskarte gespeichert sind.

Attribute
`event_id`	`str` Die eindeutige Kennung für den jeweiligen Ereignisdatensatz.
`time`	`int` Der UNIX-Zeitstempel, der angibt, wann das Ereignis aufgetreten ist.
`product`	`str` Das Sicherheitsprodukt oder ‑tool, das die Ereignis-Telemetrie generiert hat.
`outcome`	`str` Das aufgezeichnete Ergebnis des Ereignisses.
`artifact_entities`	`list[MutableMapping[str, Any]]` Eine Liste von Entitäten, die in der Ereignis-Telemetrie identifiziert wurden und als Artefakte für den Fall dienen.
`fields`	`list[MutableMapping[str, Any]]` Eine Sammlung zusätzlicher Schlüssel/Wert-Paare, die für die Daten-Payload dieses Ereignisses spezifisch sind.

class TIPCommon.data_models.EventPropertyField

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

Basiert auf: object

EventPropertyField definiert eine strukturierte Sammlung von Ereignisattributen, die nach Priorität und Gruppierung organisiert sind. Sie wird verwendet, um Telemetriedaten für die Anzeige zu kategorisieren und kritische Felder für die Untersuchung hervorzuheben.

Methoden

Die folgende Methode verarbeitet die Rekonstruktion von Attributfeldobjekten aus strukturierten JSON-Daten.

Methoden

Methoden
`from_json()`	`from_json(event_property_field: MutableMapping[str, Any]) → EventPropertyField` Eine Klassenmethode, die eine `EventPropertyField`-Instanz aus einem Wörterbuch mit Feldattributen initialisiert.

from_json()

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

Eine Klassenmethode, die eine EventPropertyField-Instanz aus einem Wörterbuch mit Feldattributen initialisiert.

Attribute

In der folgenden Tabelle werden die Metadaten und Inhaltselemente aufgeführt, die das Feld für die Ereigniseigenschaft definieren.

Attribute

Attribute
`group_name`	`str` Der Name der logischen Gruppe, zu der diese Felder gehören.
`is_highlight`	`bool` Gibt an, ob dieses Feld in der Benutzeroberfläche der Plattform als Datenpunkt mit hoher Priorität visuell hervorgehoben werden soll.
`items`	`list[FieldItem]` Eine Liste mit bestimmten Datenelementen, die in dieser Property-Gruppe enthalten sind.

group_name

str

Der Name der logischen Gruppe, zu der diese Felder gehören.

is_highlight

bool

Gibt an, ob dieses Feld in der Benutzeroberfläche der Plattform als Datenpunkt mit hoher Priorität visuell hervorgehoben werden soll.

items

list[FieldItem]

Eine Liste mit bestimmten Datenelementen, die in dieser Property-Gruppe enthalten sind.

class TIPCommon.data_models.FieldGroupItem

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

Basiert auf: object

FieldGroupItem stellt einen bestimmten Datenpunkt innerhalb einer Feldgruppe dar und enthält eine Zuordnung zwischen dem ursprünglichen Quellnamen und dem lesbaren Anzeigenamen.

Methoden

Die folgenden Methoden verwalten die Serialisierung und Rekonstruktion von Elementen der Feldgruppe.

Methoden

from_json()

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

Eine Klassenmethode, die eine FieldGroupItem-Instanz aus einem JSON-Wörterbuch initialisiert.

to_json()

to_json() → MutableMapping[str, Any]

Konvertiert das FieldGroupItem-Objekt in ein JSON-serialisierbares Wörterbuchformat.

class TIPCommon.data_models.FieldItem

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

Basiert auf: object

FieldItem ist eine Basisdatenstruktur für einzelne Attribute, in der der Rohschlüssel, das zugeordnete Label und der zugehörige Wert gespeichert werden.

Methoden

from_json()

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

Eine Klassenmethode, die eine FieldItem-Instanz aus einem Dictionary mit Feldeigenschaften erstellt.

class TIPCommon.data_models.FieldsGroup

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

Basiert auf: object

FieldsGroup dient als Container zum Organisieren mehrerer Feldelemente in einer logischen Sammlung. Sie wird hauptsächlich verwendet, um das Layout und die Sichtbarkeit von Daten in der Benutzeroberfläche der Plattform zu steuern.

Methoden

Die folgenden Methoden verwalten die Konvertierung von Feldgruppendaten zwischen Objektinstanzen und strukturiertem JSON.

Methoden

from_json()

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

Eine Klassenmethode, die eine FieldsGroup-Instanz aus einem Dictionary mit Gruppenattributen initialisiert.

to_json()

to_json() → MutableMapping[str, Any]

Konvertiert das FieldsGroup-Objekt in ein JSON-serialisierbares Wörterbuchformat.

Attribute

In der folgenden Tabelle werden die Eigenschaften beschrieben, die das Anzeige- und Inhaltsverhalten der Gruppe definieren.

Attribute

group_name

str

Das Label, mit dem die Gruppe in der Benutzeroberfläche identifiziert wird.

is_highlight

bool

Legt fest, ob die Gruppe visuell hervorgehoben werden soll.

items

list[FieldGroupItem]

Eine Liste mit spezifischen Datenpunkten, die in der Gruppe enthalten sind.

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)

Basiert auf: object

GoogleServiceAccount bietet eine strukturierte Darstellung von Google CloudDienstkonto-Anmeldedaten. Damit werden Authentifizierungsdetails für Integrationen verwaltet, die mit Google-Diensten interagieren.

Methoden

Die folgende Methode erleichtert den Export von Anmeldedaten in das Standardformat, das von Clientbibliotheken benötigt wird.

Methoden

to_dict()

to_dict() → dict[str, str]

Serialisiert die Dienstkonto-Attribute in ein Dictionary, das mit dem Standardformat service-account-file.json kompatibel ist.

class TIPCommon.data_models.Insight

class TIPCommon.data_models.Insight(raw_data)

Basiert auf: object

Ein Insight ist eine einzelne Analyseerkenntnis oder Beobachtung, die von der Plattform oder einer Integration generiert wird. Es enthält Rohdaten, die zusätzlichen Kontext oder empfohlene Aktionen für eine Sicherheitsüberprüfung liefern.

Methoden

Mit den folgenden Methoden werden die Serialisierung und Rekonstruktion von Insight-Objekten verwaltet.

Methoden

from_json()

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

Eine Klassenmethode, die eine Insight-Instanz aus einem Wörterbuch mit Rohdaten zur Telemetrie von Statistiken erstellt.

to_json()

to_json() → MutableMapping[str, Any]

Serialisiert das Insight-Objekt zurück in ein JSON-kompatibles Wörterbuchformat.

Attribute

raw_data

MutableMapping[str, Any]

Die zugrunde liegende Rohdatennutzlast mit den spezifischen Ergebnissen und Messwerten der Statistik.

class TIPCommon.data_models.InstalledIntegrationInstance

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

Basiert auf: object

InstalledIntegrationInstance stellt eine bestimmte, konfigurierte Instanz einer Integration dar, die in einer Umgebung bereitgestellt wurde. Sie verknüpft die allgemeine Integrationsdefinition mit der spezifischen Bereitstellung und Namensgebung in der Umgebung.

Methoden

Die folgenden Methoden verwalten die Konvertierung von Daten der Integrationsinstanz zwischen Objektinstanzen und strukturiertem JSON.

Methoden

from_json()

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

Eine Klassenmethode, die JSON-Daten in ein InstalledIntegrationInstance-Objekt parst.

to_json()

to_json() → MutableMapping[str, Any]

Serialisiert die Daten der Integrationsinstanz in ein JSON-kompatibles Wörterbuchformat.

Attribute

In der folgenden Tabelle werden die Kennungen aufgeführt, die verwendet werden, um die Integration in verschiedenen Organisationsumgebungen zu verfolgen.

Attribute

instance_name

str

Der benutzerdefinierte Name für diese bestimmte Integrationsinstanz.

integration_identifier

str

Die eindeutige Kennung für die übergeordnete Integration.

environment_identifier

str

Die Kennung für die Organisationsumgebung, in der diese Instanz installiert ist.

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)

Basiert auf: object

InternalDomain steht für eine Domain-ID, die als Teil der internen Infrastruktur der Organisation erkannt wird. Diese Datensätze sind wichtig, um bei Sicherheitsuntersuchungen zwischen internem Traffic und externen Bedrohungen zu unterscheiden.

Methoden

Die folgenden Methoden verwalten die Serialisierung und Rekonstruktion interner Domaindatensätze.

Methoden

from_json()

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

Eine Klassenmethode, die ein InternalDomain-Objekt aus einem JSON-Wörterbuch erstellt.

to_json()

to_json() → MutableMapping[str, Any]

Konvertiert das InternalDomain-Objekt in ein JSON-serialisierbares Wörterbuchformat.

Attribute

In der folgenden Tabelle werden die Attribute aufgeführt, die zum Identifizieren und Kategorisieren interner Domains verwendet werden.

Attribute

domain_display_name

str

Der primäre Domainname.

alias_name

str

Ein alternativer Name oder ein alternatives Label, das verwendet wird, um die Domain auf der Plattform zu identifizieren.

environments_json

str

Ein JSON-formatierter String mit den Umgebungen, in denen diese Domain als intern gilt.

class TIPCommon.data_models.JobParamType

class TIPCommon.data_models.JobParamType(value)

Basis: Enum

JobParamType definiert die unterstützten Datentypen für Parameter, die in geplanten Jobs oder Automatisierungsaufgaben verwendet werden. Diese Typen erleichtern die ordnungsgemäße Eingabevalidierung und die Verarbeitung auf Plattformebene.

Konstanten

Die folgenden Konstanten stellen die spezifischen Datentypen dar, die für Jobparameter verfügbar sind.

Konstanten
`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)

Basiert auf: object

Parameter dient als primäre Basisklasse für alle parameterbezogenen Modelle in der Bibliothek. Sie bietet eine einheitliche Schnittstelle für die Verarbeitung von Rohkonfigurationsdaten.

Attribute

Die folgende Property bietet Zugriff auf die zugrunde liegenden Daten, die zum Initialisieren des Parameters verwendet werden.

Attribute

raw_data

dict[str, Any]

Die ursprüngliche Nutzlast des Dictionarys mit der Konfiguration des Parameters.

Beispiel

Das folgende Beispiel zeigt, wie die Basisklasse Parameter initialisiert und auf ihre Rohdaten zugegriffen wird.

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

Basiert auf: object

Das SLA (Service Level Agreement) umfasst die Zeitbeschränkungen und den Status für eine Benachrichtigung. Es bietet eine hochpräzise Nachverfolgung für Standard- und kritische Fristen, einschließlich der Logik für Pausen.

Methoden

Die folgenden Methoden verwalten die Konvertierung von SLA-Daten zwischen Objektinstanzen und strukturiertem JSON.

Methoden

from_json()

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

Eine Klassenmethode, die eine SLA-Instanz aus einem JSON-Wörterbuch initialisiert.

to_json()

to_json() → MutableMapping[str, Any]

Konvertiert das SLA-Objekt in ein JSON-serialisierbares Wörterbuchformat.

Attribute

In der folgenden Tabelle werden die wichtigsten Zeitattribute für die Nachverfolgung des Ablaufs von Benachrichtigungen aufgeführt.

Attribute

sla_expiration_time

int | None

Der UNIX-Zeitstempel für die Standardablaufzeit des SLA.

critical_expiration_time

int | None

Der Unix-Zeitstempel, der die Ablauf-Deadline für das kritische SLA darstellt.

expiration_status

int

Der aktuelle Status der SLA.

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)

Basiert auf: object

ScriptContext ist ein umfassender Container, der die erforderliche Umgebung, Kennungen und Parameter für die Skriptausführung bereitstellt. Es werden alle Informationen erfasst, von Zielentitäten und Workflow-IDs bis hin zu Sicherheitseinstellungen wie Proxy- und Tresorkonfigurationen.

Methoden

Mit den folgenden Methoden kann der Ausführungskontext des Skripts geändert und serialisiert werden.

Methoden

to_json()

to_json() → MutableMapping[str, Any]

Serialisiert ScriptContext in ein JSON-kompatibles Dictionary-Format.

update()

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

Aktualisiert die Kontextattribute mit Werten aus einem bereitgestellten Dictionary.

Attribute

Angesichts des umfangreichen Kontexts werden in der folgenden Tabelle die wichtigsten Ausführungs- und Umgebungs-IDs aufgeführt.

Attribute
`case_id`	`int \| str \| None` Die Kennung des Falls, der mit der aktuellen Skriptausführung verknüpft ist.
`workflow_id`	`str` Die ID des Workflows, der gerade verarbeitet wird.
`parameters`	`SingleJson` Ein Dictionary mit Laufzeitparametern, die an das Skript übergeben werden.
`execution_deadline_unix_time_ms`	`int` Der UNIX-Zeitstempel, der angibt, wann die Skriptausführung abgeschlossen sein muss.
`vault_settings`	`SiemplifyVault \| None` Konfigurationseinstellungen für den Zugriff auf sensible Daten, die im Tresor der Plattform gespeichert sind.

class TIPCommon.data_models.SmimeEmailConfig

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

Basiert auf: object

SmimeEmailConfig kapselt die erforderlichen kryptografischen Assets und die E‑Mail-Nachricht, die für S/MIME-Vorgänge wie Signieren oder Verschlüsseln erforderlich sind. Sie enthält die Roh-E-Mail sowie die base64-codierten Schlüssel und Zertifikate.

Attribute

In der folgenden Tabelle werden die kryptografischen Komponenten beschrieben, die von diesem Konfigurationsmodell verwaltet werden.

Attribute
`email`	`email.message.Message` Das zu verarbeitende Standard-E-Mail-Nachrichtenobjekt von Python.
`private_key_b64`	`str` Der base64-codierte private Schlüssel, der zum Signieren oder Entschlüsseln verwendet wird.
`certificate_b64`	`str` Das base64-codierte öffentliche Zertifikat, das dem privaten Schlüssel zugeordnet ist.
`ca_certificate_b64`	`str` Das base64-codierte Zertifikat der Zertifizierungsstelle (Certificate Authority, CA), das zum Überprüfen der Vertrauenskette verwendet wird.

class TIPCommon.data_models.SmimeType

class TIPCommon.data_models.SmimeType(value)

Basis: Enum

SmimeType definiert den Betriebsmodus für die S/MIME-Verarbeitung und unterscheidet zwischen der Sicherung des Inhalts durch Verschlüsselung und der Validierung des Absenders mithilfe einer digitalen Signatur.

Konstanten

Die folgenden Konstanten stellen die unterstützten S/MIME-Nachrichtentypen dar.

Konstanten
`SIGNED`	`'signed'` (Die Nachricht ist digital signiert, um die Authentizität zu gewährleisten.)
`ENCRYPTED`	`'encrypted'` (Der Nachrichtentext ist verschlüsselt, um die Vertraulichkeit zu gewährleisten.)

class TIPCommon.data_models.TypedContainer

class TIPCommon.data_models.TypedContainer()

Bases: Generic[T]

TypedContainer ist ein generischer Wrapper, der Daten eines bestimmten Typs enthält. Sie steigert die Produktivität von Entwicklern, da sie Typ-Hinweise und IntelliSense bietet. So wird sichergestellt, dass das gespeicherte Objekt von IDEs und Tools für die statische Analyse korrekt behandelt wird.

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)

Basiert auf: object

UserDetails bietet ein umfassendes Profil eines Plattformnutzers, das Authentifizierungsmetadaten, Organisationsrollen und detaillierte Berechtigungen für den Datenzugriff umfasst. Sie ist für die Verwaltung von Nutzersitzungen und die Durchsetzung der rollenbasierten Zugriffssteuerung (Role-Based Access Control, RBAC) unerlässlich.

Methoden

Die folgenden Methoden erleichtern die Rekonstruktion und Serialisierung von Nutzerprofildaten.

Methoden

from_json()

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

Eine Klassenmethode, die eine UserDetails-Instanz aus einem JSON-Wörterbuch mit Nutzerattributen initialisiert.

to_json()

to_json() → MutableMapping[str, Any]

Konvertiert das UserDetails-Objekt in ein JSON-serialisierbares Wörterbuchformat.

Attribute

In der folgenden Tabelle sind die primären Identifikations- und Berechtigungsstrukturen für den Nutzer aufgeführt.

Attribute
`user_name`	`str` Der eindeutige Systemnutzername, der für die Anmeldung und Identifizierung verwendet wird.
`soc_roles`	`list[str]` Eine Liste der SOC-Rollen, die dem Nutzer zugewiesen sind und seine betrieblichen Berechtigungen definieren.
`data_access_context`	`DataAccessContext` Der Kontext, der definiert, auf welche Datenbereiche und Organisationseinheiten der Nutzer zugreifen darf.
`is_disabled`	`bool` Ein boolesches Flag, das angibt, ob die Anmeldung für das Nutzerkonto derzeit eingeschränkt ist.

class TIPCommon.data_models.UserProfileCard

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

Basiert auf: object

UserProfileCard bietet eine kurze Zusammenfassung des Profils eines Nutzers, die für die Anzeige in UI-Komponenten wie Headern oder Kontaktkarten vorgesehen ist, in denen nicht alle Details erforderlich sind.

Methoden

from_json()

from_json(user_profile_card_response: dict) → UserProfileCard

Eine Klassenmethode, mit der eine UserProfileCard-Instanz aus einem Dictionary mit grundlegenden Profilattributen erstellt wird.

class TIPCommon.data_models.WallData

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

Basiert auf: object

WallData steht für einen Eintrag in der „Pinnwand“ oder Zeitachse eines Falls. In diesem Modell werden Aktivitätsprotokolle, Notizen und Systemaktionen erfasst, die während des Lebenszyklus einer Untersuchung auftreten.

Methoden

from_json()

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

Eine Klassenmethode, die eine WallData-Instanz aus einem JSON-Wörterbuch mit Wandaktivitäten initialisiert.

to_json()

to_json() → MutableMapping[str, Any]

Serialisiert das WallData-Objekt zurück in ein JSON-kompatibles Wörterbuchformat.

Attribute

activity_kind

str | int | None

Die Kategorie der Aktivität.

activity_data_json

str | None

Ein JSON-formatierter String mit den spezifischen Details oder der Nutzlast der Aktivität.

favorite

bool

Gibt an, ob der Aktivitätseintrag angepinnt oder als Favorit markiert wurde, damit Sie ihn schnell wiederfinden.

Benötigen Sie weitere Hilfe? Antworten von Community-Mitgliedern und Google SecOps-Experten erhalten

Modul data_models

class TIPCommon.data_models.AlertCard

Methoden

Attribute

class TIPCommon.data_models.AlertEvent

Methoden

Attribute

class TIPCommon.data_models.AlertPriority

Konstanten

class TIPCommon.data_models.AttachmentMetadata

Methoden

Attribute

class TIPCommon.data_models.BaseAlert

Methoden

Attribute

Beispiel

class TIPCommon.data_models.BaseDataModel

Methoden

Attribute

Beispiel

class TIPCommon.data_models.CaseDataStatus

Konstanten

class TIPCommon.data_models.CaseDetails

Methoden

Attribute

class TIPCommon.data_models.CaseOverviewInfo

Methoden

Attribute

class TIPCommon.data_models.CasePriority

Konstanten

class TIPCommon.data_models.CaseSLAInfo

Methoden

Attribute

class TIPCommon.data_models.CaseWallAttachment

Attribute

class TIPCommon.data_models.ConnectorCard

Methoden

Attribute

class TIPCommon.data_models.ConnectorConnectivityStatusEnum

Konstanten

class TIPCommon.data_models.ConnectorParamTypes

Konstanten

class TIPCommon.data_models.ConnectorParameter

Attribute

Beispiel

class TIPCommon.data_models.Container

Beispiel

class TIPCommon.data_models.CreateEntity

Methoden

Attribute

class TIPCommon.data_models.CustomField

Methoden

Attribute

class TIPCommon.data_models.CustomFieldScope

Methoden

Konstanten

class TIPCommon.data_models.CustomFieldValue

Methoden

Attribute

class TIPCommon.data_models.DataAccessContext

Methoden

Attribute

class TIPCommon.data_models.DatabaseContextType

Konstanten

class TIPCommon.data_models.DynamicParameter

Methoden

Attribute

class TIPCommon.data_models.EmailTemplate

Methoden

Attribute

class TIPCommon.data_models.Entity

Methoden

Attribute

class TIPCommon.data_models.EntityCard

Methoden

Attribute

class TIPCommon.data_models.EnvironmentData

Methoden

Attribute

class TIPCommon.data_models.EventCard

Modul `data_models`