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: int, workflow_status: int, 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, playbook_attached: str | None, playbook_run_count: int, is_manual_alert: bool, sla: SLA, fields_groups: list[FieldsGroup], source_url: str | None, source_rule_url: str | None, siem_alert_id: str | None)

Basiert auf: object

Stellt eine Zusammenfassungskarte einer Benachrichtigung mit den wichtigsten Details und Metadaten dar.

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

Erstellt ein AlertCard-Objekt aus einem JSON-Wörterbuch, das seine Attribute darstellt.

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

Stellt ein einzelnes Ereignis dar, das mit einer Benachrichtigung in einem Fall verknüpft ist.

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

Erstellt ein AlertEvent-Objekt aus einem JSON-Wörterbuch.

class TIPCommon.data_models.AlertPriority

class TIPCommon.data_models.AlertPriority(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Basis: Enum

Stellt die Prioritätsstufen für eine Benachrichtigung dar.

Konstanten

  • CRITICAL = 100

  • HIGH = 80

  • INFORMATIVE = -1

  • LOW = 40

  • MEDIUM = 60

  • UNCHANGED = 0

class TIPCommon.data_models.BaseAlert

class TIPCommon.data_models.BaseAlert(raw_data, alert_id)

Basiert auf: object

Stellt eine Basisbenachrichtigung dar. Sie hat die folgenden Eigenschaften:

Attribute

raw_data Die Rohdaten für die Benachrichtigung.
alert_id Die ID der Benachrichtigung.

Methoden

  • to_json()→ dict
Beispiel
>>> 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

Stellt ein Basisdatenmodell dar.

Attribute

Attribut Beschreibung
raw_data Die Rohdaten für das Datenmodell.

Methoden

  • to_json()→ dict
Beispiel
>>> 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, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Basis: Enum

Konstanten

  • ALL = 3

  • CLOSED = 2

  • CREATION_PENDING = 5

  • MERGED = 4

  • NEW = 0

  • OPENED = 1

class TIPCommon.data_models.CaseDetails

class TIPCommon.data_models.CaseDetails(id_: int, creation_time_unix_time_ms: int, modification_time_unix_time_ms: int, name: str, priority: int, is_important: bool, is_incident: bool, start_time_unix_time_ms: int, end_time_unix_time_ms: int, assigned_user: str, description: str | None, is_test_case: bool, type_: int, stage: str, environment: str, status: CaseDataStatus, incident_id: int | None, tags: list[str], alerts: list[AlertCard], is_overflow_case: bool, is_manual_case: bool, sla_expiration_unix_time: int | None, sla_critical_expiration_unix_time: int | None, stage_sla_expiration_unix_time_ms: int | None, stage_sla__critical_expiration_unix_time_in_ms: int | None, can_open_incident: bool, sla:SLA, stage_sla: SLA)

Basiert auf: object

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

Erstellt ein CaseDetails-Objekt aus einem JSON-Wörterbuch.

Property is_closed

property is_closed: bool

Gibt an, ob der Fall geschlossen ist.

property is_open

property is_open: bool

Gibt an, ob das Case offen ist.

class TIPCommon.data_models.CasePriority

class TIPCommon.data_models.CasePriority(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Basis: Enum

Stellt die Prioritätsstufen für eine Benachrichtigung dar.

Konstanten

  • CRITICAL = 100

  • HIGH = 80

  • INFORMATIVE = -1

  • LOW = 40

  • MEDIUM = 60

  • UNCHANGED = 0

class TIPCommon.data_models.CaseWallAttachment

class TIPCommon.data_models.CaseWallAttachment(name: 'str', file_type: 'str', base64_blob: 'str', is_important: 'bool', case_id: 'int | None' = None)

Basiert auf: object

Stellt einen Anhang dar, der einem Fall‑Repository hinzugefügt werden soll.

Attribute

Attribut Beschreibung Typ
base64_blob Der base64-codierte Inhalt des Anhangs. str
case_id Die ID des Falls, zu dem die Anlage gehört. int | None
file_type Der Dateityp des Anhangs. str
is_important Gibt an, ob der Anhang als wichtig markiert ist. bool
name Der Name der Anhangdatei. str

class TIPCommon.data_models.ConnectorCard

class TIPCommon.data_models.ConnectorCard(integration: str, display_name: str, identifier: str, is_enabled: bool, is_remote: bool, status: ConnectorConnectivityStatusEnum)

Basiert auf: object

Stellt eine Zusammenfassungskarte für eine Connector-Instanz dar.

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

Erstellt ein ConnectorCard-Objekt aus einem JSON-Wörterbuch.

class TIPCommon.data_models.ConnectorConnectivityStatusEnum

class TIPCommon.data_models.ConnectorConnectivityStatusEnum(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Basis: Enum

Stellt den Verbindungsstatus eines Connectors dar.

Konstanten

  • LIVE = 0

  • NO_CONNECTIVITY = 1

class TIPCommon.data_models.ConnectorParamTypes

class TIPCommon.data_models.ConnectorParamTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Basis: Enum

Konstanten

Stellt die Typen von Connector-Parametern dar.

  • BOOLEAN = 0

  • DOMAIN = 7

  • EMAIL = 8

  • HOST = 5

  • INTEGER = 1

  • IP = 4

  • NULL = -1

  • PASSWORD = 3

  • SCRIPT = 12

  • STRING = 2

  • URL = 6

class TIPCommon.data_models.ConnectorParameter

class TIPCommon.data_models.ConnectorParameter(raw_param)

Grundlagen: Parameter

Stellt einen Connector-Parameter dar.

Attribute

Attribut Beschreibung
name Name des Parameters.
value Wert des Parameters.
type Der Typ des Parameters (gemäß ConnectorParamTypes).
mode Der Modus des Parameters.
is_mandatory Geben Sie an, ob der Parameter obligatorisch ist.
Beispiel
>>> from data_models import ConnectorParameter, ConnectorParamTypes
>>> p = ConnectorParameter({
    'param_name': 'api_root',
    'type': ConnectorParamTypes.STRING,
    'param_value': 'http://foo.bar',
    'is_mandatory': True,
    'mode': 0
    })
>>> print(p)
ConnectorParameter(name='api_root', value='http://foo.bar', type=2, mode=0, is_mandatory=True)

class TIPCommon.data_models.Container

Basiert auf: object

Stellt einen Container für Variablen dar.

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

class TIPCommon.data_models.CustomField

class TIPCommon.data_models.CustomField(id: 'int', display_name: 'str', description: 'str', type: 'str', scopes: 'list[CustomFieldScope]')

Basiert auf: object

Stellt eine benutzerdefinierte Felddefinition innerhalb der Plattform dar.

Attribute

Attribut Beschreibung
description str

Die Beschreibung des benutzerdefinierten Felds.

display_name str

Der Anzeigename des benutzerdefinierten Felds.

id int

Die eindeutige ID des benutzerdefinierten Felds.

scopes list[CustomFieldScope]

Die Bereiche (z.B. Benachrichtigung, Fall), in dem das benutzerdefinierte Feld anwendbar ist.

type str

Der Datentyp des benutzerdefinierten Felds.

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

Erstellt ein CustomField-Objekt aus einem JSON-Wörterbuch.

class TIPCommon.data_models.CustomFieldScope

class TIPCommon.data_models.CustomFieldScope(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Basis: Enum

Stellt die möglichen Bereiche dar, in denen ein benutzerdefiniertes Feld angewendet werden kann.

Konstanten

  • ALERTS = 'Alert'

  • CASE = 'Case'

Methoden

  • build_parent_path(identifier: int)→ str Erstellt den übergeordneten Pfad für den benutzerdefinierten Feldwert basierend auf der Kennung.

class TIPCommon.data_models.CustomFieldValue

class TIPCommon.data_models.CustomFieldValue(custom_field_id: 'int', values: 'list[str]', scope: 'CustomFieldScope', identifier: 'int')

Basiert auf: object

Stellt den für ein bestimmtes benutzerdefiniertes Feld festgelegten Wert dar.

Attribute

Attribut Beschreibung
custom_field_id int

Die ID des benutzerdefinierten Felds.

identifier int

Die ID der Entität (Fall/Benachrichtigung), zu der der Wert gehört.

scope CustomFieldScope

Der Umfang (z.B. Benachrichtigung, Fall), in dem der Wert des benutzerdefinierten Felds gilt.

values list[str]

Die Liste der für das benutzerdefinierte Feld festgelegten Werte.

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

Erstellt ein CustomFieldValue-Objekt aus einem JSON-Wörterbuch.

class TIPCommon.data_models.DatabaseContextType

class TIPCommon.data_models.DatabaseContextType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Basis: Enum

Stellt die Typen von Datenbankkontexten für die Datenspeicherung dar.

Konstanten

  • ALERT = 2

  • CASE = 1

  • CONNECTOR = 4

  • GLOBAL = 0

  • JOB = 3

class TIPCommon.data_models.EventPropertyField

class TIPCommon.data_models.EventPropertyField(order: int, group_name: str, is_integration: bool, is_highlight: bool, items: list[FieldItem])

Basiert auf: object

Stellt eine Feldgruppe in den Eigenschaften eines Ereignisses dar.

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

Erstellt ein EventPropertyField-Objekt aus einem JSON-Wörterbuch.

class TIPCommon.data_models.FieldGroupItem

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

Basiert auf: object

Stellt ein einzelnes Schlüssel/Wert-Element in der Feldgruppe eines Ereignisses dar.

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

Erstellt ein FieldGroupItem-Objekt aus einem JSON-Wörterbuch.

class TIPCommon.data_models.FieldItem

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

Basiert auf: object

Stellt ein einzelnes Element in einem Feld dar, das den ursprünglichen Namen, den formatierten Namen und den Wert enthält.

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

Erstellt ein FieldItem-Objekt aus einem JSON-Wörterbuch.

class TIPCommon.data_models.FieldsGroup

class TIPCommon.data_models.FieldsGroup(order: int, group_name: str, is_integration: bool, is_highlight: bool, items: list[[FieldGroupItem]])

Basiert auf: object

Stellt eine Gruppe von Feldern innerhalb einer größeren Datenstruktur dar, die häufig für die Anzeige verwendet wird.

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

Erstellt ein FieldsGroup-Objekt aus einem JSON-Wörterbuch.

class TIPCommon.data_models.GoogleServiceAccount

class TIPCommon.data_models.GoogleServiceAccount(account_type: str, project_id: str, private_key_id: str, private_key: str, client_email: str, client_id: str, auth_uri: str, token_uri: str, auth_provider_x509_url: str, client_x509_cert_url: str)

Basiert auf: object

Stellt die Attribute eines Google-Dienstkontos dar.

Methoden

  • to_dict()→ dict Serialisiert das Datenmodell in ein Dictionary.

Gibt Folgendes zurück:

Ein JSON-Dictionary für das Dienstkonto.

Rückgabetyp

dict

class TIPCommon.data_models.InstalledIntegrationInstance

class TIPCommon.data_models.InstalledIntegrationInstance(instance: MutableMapping[str, Any], identifier: str, integration_identifier: str, environment_identifier: str, instance_name: str)

Basiert auf: object

Stellt eine installierte Instanz einer Integration in einer Umgebung dar.

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

Erstellt ein InstalledIntegrationInstance-Objekt aus einem JSON-Wörterbuch.

Parameter
Parameter
integration_env_json SingleJson

JSON-Daten mit Informationen zur Integrationsumgebung.

Gibt Folgendes zurück:

Eine Instanz der angegebenen Klasse, die mit Daten aus raw_data initialisiert wurde.

Rückgabetyp

InstalledIntegrationInstance

class TIPCommon.data_models.JobParamType

class TIPCommon.data_models.JobParamType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Basis: Enum

Konstanten

  • BOOLEAN = 0

  • DOMAIN = 7

  • HOST = 5

  • INTEGER = 1

  • IP = 4

  • NULL = -1

  • PASSWORD = 3

  • STRING = 2

  • URL = 6

class TIPCommon.data_models.Parameter

class TIPCommon.data_models.Parameter(raw_param)

Basiert auf: object

Eine übergeordnete Klasse, die einen Parameter darstellt.

Attribute

Attribut Beschreibung
raw_data Die Rohdaten für den Parameter.
Beispiel
>>> 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: int | None, critical_expiration_time: int | None, expiration_status: int, remaining_time_since_last_pause: int | None)

Basiert auf: object

Stellt SLA-Details (Service Level Agreement) für einen Fall oder eine Benachrichtigung dar.

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

Erstellt ein SLA-Objekt aus einem JSON-Wörterbuch.

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

Stellt den Ausführungskontext für ein Script oder eine Aktion dar und bietet Zugriff auf verschiedene Laufzeitparameter und Daten.

Attribute

Attribut Beschreibung
action_definition_name str

Der Name der auszuführenden Aktionsdefinition.

Die Standardeinstellung ist ''.

alert_id str

Die ID der Benachrichtigung, die mit der aktuellen Ausführung verknüpft ist.

Die Standardeinstellung ist ''.

async_polling_interval_in_sec int

Das Intervall für das asynchrone Polling in Sekunden.

Die Standardeinstellung ist 0.

async_total_duration_deadline int

Die Frist für die Gesamtdauer asynchroner Vorgänge.

Die Standardeinstellung ist 0.

case_id int | str | None

Die ID des Testlaufs, der mit der aktuellen Ausführung verknüpft ist.

Die Standardeinstellung ist None.

connector_context ConnectorContext | None

Ein Kontext, der für die Connector-Ausführung spezifisch ist.

Die Standardeinstellung ist None.

default_result_value str

Der Standardwert für das Ergebnis der Aktion.

Die Standardeinstellung ist ''.

environment str

Die Ausführungsumgebung.

Die Standardeinstellung ist ''.

environment_api_key str | None

Der API-Schlüssel für die Umgebung.

Die Standardeinstellung ist None.

execution_deadline_unix_time_ms int

Der Unix-Zeitstempel (in Millisekunden), der die Ausführungsfrist angibt.

Die Standardeinstellung ist 0.

integration_identifier str

Die Kennung der verwendeten Integration.

Die Standardeinstellung ist ''.

integration_instance str

Der Name der verwendeten Integrationsinstanz.

Die Standardeinstellung ist ''.

job_api_key str

API-Schlüssel für den jeweiligen Job.

Die Standardeinstellung ist ''.

max_json_result_size int

Die maximal zulässige Größe für JSON-Ergebnisse.

Die Standardeinstellung ist 15.

original_requesting_user str

Der Nutzer, der die Anfrage ursprünglich initiiert hat.

Die Standardeinstellung ist ''.

parameters SingleJson

Ein JSON-Objekt mit den Parametern für das Script/die Aktion.

script_timeout_deadline int

Das Zeitlimit für die Ausführung von Skripts.

Die Standardeinstellung ist 0.

target_entities str

Durch Kommas getrennter String mit Zielentitäten.

Die Standardeinstellung ist ''.

unique_identifier str

Eine eindeutige Kennung für den Ausführungskontext.

Die Standardeinstellung ist ''.

use_proxy_settings bool

Gibt an, ob Proxy-Einstellungen verwendet werden sollen.

Die Standardeinstellung ist False.

vault_settings SiemplifyVault | None

Vault-Einstellungen für den sicheren Abruf von Anmeldedaten.

Die Standardeinstellung ist None.

workflow_id str

Die ID des Workflows.

Die Standardeinstellung ist ''.

workflow_instance_id str | None

Die ID der Workflow-Instanz.

Die Standardeinstellung ist None.

Methoden

  • to_json()→ MutableMapping[str, Any] Serialisiert das Kontextobjekt in eine veränderliche Zuordnung (JSON-Dictionary).

  • update(attributes: MutableMapping[str, Any])→ None Aktualisiert das Kontextobjekt mit neuen Attributen aus einer veränderlichen Zuordnung.

class TIPCommon.data_models.SmimeEmailConfig

class TIPCommon.data_models.SmimeEmailConfig(email: 'email.message.Message', private_key_b64: 'str', certificate_b64: 'str', ca_certificate_b64: 'str')

Basiert auf: object

Stellt die Konfiguration für das Senden von S/MIME-verschlüsselten oder ‑signierten E‑Mails dar.

Attribute

Attribut Beschreibung
ca_certificate_b64 str

Das base64-codierte CA-Zertifikat.

certificate_b64 str

Das base64-codierte Zertifikat.

email Message

Das E‑Mail-Nachrichtenobjekt.

private_key_b64 str

Der base64-codierte private Schlüssel.

class TIPCommon.data_models.SmimeType

class TIPCommon.data_models.SmimeType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Basis: Enum

Stellt die Arten von S/MIME-Vorgängen dar.

Konstanten

  • ENCRYPTED = 'encrypted'

  • SIGNED = 'signed'

class TIPCommon.data_models.TypedContainer

class TIPCommon.data_models.TypedContainer(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Basistypen: Generic[T]

Container für einen bestimmten Typ, der Typ-IntelliSense bietet.

class TIPCommon.data_models.UserProfileCard

class TIPCommon.data_models.UserProfileCard(raw_data: dict, first_name: str, last_name: str, user_name: str, account_state: int)

Basiert auf: object

Stellt eine Zusammenfassungskarte für ein Nutzerprofil dar.

classmethod from_json(user_profile_card_response: dict)→ UserProfileCard

Erstellt ein UserProfileCard-Objekt aus einem JSON-Wörterbuch.

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