‫Google משתמשת בטכנולוגיית AI כדי לתרגם תוכן לשפה המועדפת עליך. בתרגומים כאלו עשויות להיות שגיאות.

מודול `data_models`

המודול הזה מכיל מחלקות נתונים לייצוג של הפריטים הבאים:

מודלים של נתונים
התראות
מאגרי משתנים
פרמטרים כלליים
פרמטרים של מחברים

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)

בסיסים: object

‫AlertCard מייצג כרטיס סיכום של התראה, שכולל מטא-נתונים קריטיים ומחווני סטטוס שמשמשים להדמיה ולמעקב בפלטפורמה.

Methods

השיטות הבאות מאפשרות לבצע סריאליזציה ולשחזר כרטיסי התראות מנתונים מובְנים.

Methods

Methods
`from_json()`	`from_json(alert_card_json: dict[str, Any]) → AlertCard` ‫method של מחלקה שיוצר מופע `AlertCard` ממילון JSON.
`to_json()`	`to_json() → MutableMapping[str, Any]` הפונקציה ממירה את האובייקט `AlertCard` לפורמט מילון שניתן לסדר אותו ב-JSON.

from_json()

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

‫method של מחלקה שיוצר מופע AlertCard ממילון JSON.

to_json()

to_json() → MutableMapping[str, Any]

הפונקציה ממירה את האובייקט AlertCard לפורמט מילון שניתן לסדר אותו ב-JSON.

מאפיינים

בטבלה הבאה מפורטים מאפייני המבנה העיקריים ומודלים מורכבים של נתונים שקשורים להתראה.

מאפיינים

מאפיינים
`fields_groups`	`list[FieldsGroup]` רשימה של שדות מקובצים שמשויכים להתראה, שמשמשת להצגת נתונים מובנים בממשק המשתמש.
`sla`	`SLA` אובייקט הסכם רמת השירות (SLA) שמגדיר את מסגרות הזמן לתגובה ולפתרון של ההתראה.

fields_groups

list[FieldsGroup]

רשימה של שדות מקובצים שמשויכים להתראה, שמשמשת להצגת נתונים מובנים בממשק המשתמש.

sla

SLA

אובייקט הסכם רמת השירות (SLA) שמגדיר את מסגרות הזמן לתגובה ולפתרון של ההתראה.

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

בסיסים: object

‫AlertEvent מייצג אירוע בודד שמשויך להתראה, ומכיל נתוני טלמטריה ספציפיים, מאפייני שדות וישויות קשורות.

Methods

השיטה הבאה fƒconacilitates מאפשרת לשחזר אובייקטים של אירועים מנתוני JSON מובנים.

Methods

Methods
`from_json()`	`from_json(event_json: MutableMapping[str, Any]) → AlertEvent` ‫A class method that creates an `AlertEvent` instance from a JSON dictionary representing its attributes.

from_json()

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

‫A class method that creates an AlertEvent instance from a JSON dictionary representing its attributes.

מאפיינים

בטבלה הבאה מודגשים מאפייני המבנה העיקריים ומודלים מורכבים של נתונים שמשויכים לאירוע.

מאפיינים

מאפיינים
`fields`	`list[EventPropertyField]` רשימה של שדות נכס שספציפיים לאירוע, שמגדירים את נקודות הנתונים הייחודיות שלו.
`artifact_entities`	`list[str]` רשימה של מזהי ישויות שחולצו מהטלמטריה של האירוע.

fields

list[EventPropertyField]

רשימה של שדות נכס שספציפיים לאירוע, שמגדירים את נקודות הנתונים הייחודיות שלו.

artifact_entities

list[str]

רשימה של מזהי ישויות שחולצו מהטלמטריה של האירוע.

‫class TIPCommon.data_models.AlertPriority

class TIPCommon.data_models.AlertPriority(value)

בסיסים: Enum

AlertPriority מגדיר את רמות החומרה התקניות שמבוססות על מספרים שלמים, שמשמשות לסיווג ולתעדוף של התראות בפלטפורמה.

קבועים

הקבועים הבאים מייצגים את ערכי העדיפות הספציפיים שמוקצים להתראות.

קבועים
`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)

בסיסים: object

‫AttachmentMetadata כולל את הנתונים והמאפיינים התיאוריים שמשויכים לקובץ מצורף, ומספק שיטות להמרה ולאחזור של נתונים מובְנים.

Methods

השיטה הבאה מספקת דרך סטנדרטית לשחזר אובייקטים של בקשות מתשובות בפורמט JSON.

Methods

Methods
`from_json()`	`from_json(result_data: MutableMapping[str, Any]) → Self` שיטת מחלקה שמאתחלת מופע חדש של `AttachmentMetadata` באמצעות מילון שסופק של מאפייני מטא-נתונים.
`to_json()`	`to_json() → MutableMapping[str, Any]` מבצע סריאליזציה של האובייקט `AttachmentMetadata` בחזרה לפורמט מילון שתואם ל-JSON.

from_json()

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

שיטת מחלקה שמאתחלת מופע חדש של AttachmentMetadata באמצעות מילון שסופק של מאפייני מטא-נתונים.

to_json()

to_json() → MutableMapping[str, Any]

מבצע סריאליזציה של האובייקט AttachmentMetadata בחזרה לפורמט מילון שתואם ל-JSON.

מאפיינים

בטבלה הבאה מודגשים מבני הנתונים העיקריים שמשמשים לאחסון מאפייני המטא-נתונים של הקובץ המצורף.

מאפיינים

מאפיינים
`raw_data`	`MutableMapping[str, Any]` המילון הבסיסי שמכיל את מאפייני המטא נתונים הגולמיים כפי שהתקבלו מהמקור.

raw_data

MutableMapping[str, Any]

המילון הבסיסי שמכיל את מאפייני המטא נתונים הגולמיים כפי שהתקבלו מהמקור.

‫class TIPCommon.data_models.BaseAlert

class TIPCommon.data_models.BaseAlert(raw_data, alert_id)

בסיסים: object

‫BaseAlert הוא מודל בסיסי שמייצג התראת אבטחה גנרית. הוא מספק מבנה סטנדרטי לאחסון טלמטריה גולמית לצד מזהה פלטפורמה ייחודי.

Methods

השיטה הבאה מאפשרת לבצע סריאליזציה של ההתראה לפורמט סטנדרטי.

Methods

Methods
`to_json()`	`to_json() → dict[str, Any]` הפונקציה ממירה את ההתראה למילון שניתן לסריאליזציה של JSON, כמו שמוחזר על ידי `json.loads()`.

to_json()

to_json() → dict[str, Any]

הפונקציה ממירה את ההתראה למילון שניתן לסריאליזציה של JSON, כמו שמוחזר על ידי json.loads().

מאפיינים

בטבלה הבאה מודגשות נקודות הנתונים העיקריות שמנוהלות על ידי המודל הזה.

מאפיינים

מאפיינים
`raw_data`	`dict[str, Any]` מטען ייעודי (Payload) של נתונים גולמיים שמשויך להתראה.
`alert_id`	`Any` המזהה הייחודי שהוקצה להתראה.

raw_data

dict[str, Any]

מטען ייעודי (Payload) של נתונים גולמיים שמשויך להתראה.

alert_id

Any

המזהה הייחודי שהוקצה להתראה.

דוגמה

בדוגמה הבאה אפשר לראות איך מאתחלים BaseAlert, ניגשים לנתונים הגולמיים שלו ולפלט שעבר סריאליזציה.

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

‫class TIPCommon.data_models.BaseDataModel

class TIPCommon.data_models.BaseDataModel(raw_data)

בסיסים: object

‫BaseDataModel משמש כסוג האב למבני נתונים שונים בספרייה, ומבטיח טיפול עקבי בנתוני קלט גולמיים ובסריאליזציה.

Methods

השיטה הבאה מבטיחה שהנתונים הגולמיים יאוחזרו בפורמט שתואם לפעולות JSON.

Methods

Methods
`to_json()`	`to_json() → dict[str, Any]` הפונקציה מבצעת סריאליזציה של הנתונים הגולמיים שמאוחסנים במודל לפורמט מילון.

to_json()

to_json() → dict[str, Any]

הפונקציה מבצעת סריאליזציה של הנתונים הגולמיים שמאוחסנים במודל לפורמט מילון.

מאפיינים

בטבלה הבאה מתואר האחסון הראשי של הנתונים בדגם הבסיסי.

מאפיינים

מאפיינים
`raw_data`	`dict[str, Any]` מטען הנתונים הגולמי המקורי ששימש לאתחול המודל.

raw_data

dict[str, Any]

מטען הנתונים הגולמי המקורי ששימש לאתחול המודל.

דוגמה

בדוגמה הבאה מוצג האתחול הבסיסי של מודל הנתונים והשימוש בשיטת הסריאליזציה.

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

class TIPCommon.data_models.CaseDataStatus

class TIPCommon.data_models.CaseDataStatus(value)

בסיסים: Enum

CaseDataStatus מגדיר את סטטוסי התפעול הנתמכים לכרטיסים בפלטפורמה, החל מההוספה הראשונית ועד לסגירה או למיזוג הסופיים.

קבועים

הקבועים הבאים מייצגים את אינדיקטורי הסטטוס הספציפיים שמוקצים לנתוני פניות.

קבועים
`NEW`	`0`
`OPENED`	`1`
`CLOSED`	`2`
`ALL`	`3`
`MERGED`	`4`
`CREATION_PENDING`	`5`

‫class TIPCommon.data_models.CaseDetails

בסיסים: object

‫CaseDetails מספק תצוגה מקיפה של מקרה אבטחה, כולל מאפיינים ושיטות לבדיקת מצב לשחזור או לסריאליזציה של נתוני המקרה.

Methods

השיטות הבאות מנהלות את ההמרה של פרטי הפנייה בין מופעי אובייקטים לבין פורמטים מובנים של JSON.

Methods

Methods
`from_json()`	`from_json(case_details_json: MutableMapping[str, Any]) → CaseDetails` שיטת מחלקה שמאתחלת מופע `CaseDetails` ממילון של מאפייני פנייה.
`to_json()`	`to_json(include_activities: bool = False) → MutableMapping[str, Any]` הפונקציה ממירה את האובייקט `CaseDetails` למילון שניתן לסריאליזציה ב-JSON. מגדירים את `include_activities` ל-`True` כדי לכלול יומני פעילות של פניות.

from_json()

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

שיטת מחלקה שמאתחלת מופע CaseDetails ממילון של מאפייני פנייה.

to_json()

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

הפונקציה ממירה את האובייקט CaseDetails למילון שניתן לסריאליזציה ב-JSON. מגדירים את include_activities ל-True כדי לכלול יומני פעילות של פניות.

מאפיינים

המאפיינים הבאים מספקים אינדיקטורים לוגיים לגבי המצב הנוכחי של הבקשה.

מאפיינים

מאפיינים
`is_closed`	`bool` מאפיין בוליאני שמציין אם הפנייה נמצאת במצב סגור.
`is_open`	`bool` מאפיין בוליאני שמציין אם הפנייה פעילה או פתוחה.

is_closed

bool

מאפיין בוליאני שמציין אם הפנייה נמצאת במצב סגור.

is_open

bool

מאפיין בוליאני שמציין אם הפנייה פעילה או פתוחה.

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

בסיסים: object

‫CaseOverviewInfo מספק סיכום ברמה גבוהה של אירוע אבטחה, כולל מטא-נתונים, סטטוס הסכם רמת שירות (SLA) ופרטים ארגוניים שמשמשים ליצירת לוחות בקרה ולניהול תורים.

Methods

השיטה הבאה מאפשרת לשחזר אובייקטים של סקירת אירוע מנתוני JSON מובְנים.

Methods

Methods
`from_json()`	`from_json(json_data: MutableMapping[str, Any]) → CaseOverviewInfo` שיטת מחלקה שמאתחלת מופע של `CaseOverviewInfo` ממילון של מאפייני סיכום פנייה.

from_json()

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

שיטת מחלקה שמאתחלת מופע של CaseOverviewInfo ממילון של מאפייני סיכום פנייה.

מאפיינים

בטבלה הבאה מפורטים המאפיינים המבניים העיקריים, סוגי ה-enum והמדדים התפעוליים העיקריים שקשורים לסקירת האירוע.

מאפיינים
`priority`	`CasePriority` רמת החומרה שהוקצתה לבקשת התמיכה.
`status`	`CaseDataStatus \| None` הסטטוס התפעולי הנוכחי של נתוני הכרטיס.
`workflow_status`	`int \| None` השלב או המצב הנוכחיים במנוע של תהליך העבודה האוטומטי של הפלטפורמה.
`score`	`int \| None` ציון הסיכון או החשיבות שחושב והוקצה לכרטיס.
`case_sla`	`CaseSLAInfo \| None` מידע על מעקב אחר הסכם רמת שירות (SLA) שמתייחס באופן ספציפי למחזור החיים של פתרון הפנייה.
`alerts_sla`	`CaseSLAInfo \| None` מידע על מעקב אחר הסכמי רמת שירות (SLA) לגבי ההתראות הספציפיות שנכללות בפנייה.
`environment_data`	`EnvironmentData \| None` מטא-נתונים לגבי הסביבה הארגונית הספציפית שממנה הגיעה הפנייה.
`tags`	`list[str]` רשימה של תוויות שהוגדרו על ידי המשתמש או שהמערכת יצרה, שמשויכות לכרטיס.

class TIPCommon.data_models.CasePriority

class TIPCommon.data_models.CasePriority(value)

בסיסים: Enum

השדה CasePriority מגדיר את רמות החומרה התקניות שמבוססות על מספרים שלמים, שמשמשות לסיווג ולתעדוף של בקשות תמיכה בפלטפורמה.

קבועים

הקבועים הבאים מייצגים את ערכי העדיפות הספציפיים שמוקצים לבקשות.

קבועים
`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)

בסיסים: object

‫CaseSLAInfo מכיל נתוני מעקב של הסכם רמת שירות (SLA), כולל חותמות זמן של תפוגה ואינדיקטורים של סטטוס, כדי להבטיח תגובה בזמן לאירועים.

Methods

השיטה הבאה מאפשרת ליצור אובייקטים של פרטי SLA מנתוני JSON מובְנים.

Methods

Methods
`from_json()`	`from_json(json_data: MutableMapping[str, Any]) → CaseSLAInfo` ‫class method שיוצר מופע `CaseSLAInfo` ממילון של מאפייני SLA.

from_json()

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

‫class method שיוצר מופע CaseSLAInfo ממילון של מאפייני SLA.

מאפיינים

בטבלה הבאה מודגשים מאפייני התזמון והסטטוס העיקריים שמשמשים למעקב אחרי מועדים אחרונים של בקשות.

מאפיינים
`expiration_time_ms`	`int \| None` חותמת הזמן של מערכת Unix (באלפיות השנייה) שבה יפוג תוקף הסכם רמת השירות הרגיל.
`critical_expiration_time_ms`	`int \| None` חותמת הזמן של מערכת Unix (באלפיות השנייה) שבה מגיעים לסף הקריטי של הסכם רמת השירות.
`expiration_status`	`int \| None` אינדיקטור מספרי שמייצג את הסטטוס הנוכחי של ה-SLA.
`last_pause_remaining_time_ms`	`int \| None` משך הזמן שנותר בשעון ה-SLA ברגע ההשהיה האחרונה.

class TIPCommon.data_models.CaseWallAttachment

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

בסיסים: object

‫CaseWallAttachment מייצג קובץ או אובייקט נתונים שמצורף ללוח הראיות של תיק, כולל התוכן הגולמי בפורמט base64 ומטא-נתונים משויכים.

מאפיינים

בטבלה הבאה מודגשים המאפיינים העיקריים ונתוני התוכן שמשויכים לקובץ המצורף.

מאפיינים
`name`	`str` שם הקובץ או השם המוצג של הקובץ המצורף.
`file_type`	`str` סוג ה-MIME או סיומת הקובץ שמציינים את הפורמט של הנתונים המצורפים.
`base64_blob`	`str` התוכן בפועל של הקובץ, בקידוד מחרוזת base64.
`is_important`	`bool` דגל שמציין אם הקובץ המצורף סומן כראיה קריטית בחקירה.

class TIPCommon.data_models.ConnectorCard

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

בסיסים: object

‫ConnectorCard מספק סיכום של ההגדרות של מחבר ספציפי ושל

מצב הפעולה הנוכחי בפלטפורמה.

Methods

השיטה הבאה מאפשרת ליצור מופעים של כרטיסי מחבר מנתוני JSON מובנים.

Methods

Methods
`from_json()`	`from_json(connector_card_json: MutableMapping[str, Any]) → ConnectorCard` שיטת מחלקה שמאתחלת מופע `ConnectorCard` ממילון של מאפייני מחבר.

from_json()

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

שיטת מחלקה שמאתחלת מופע ConnectorCard ממילון של מאפייני מחבר.

מאפיינים

בטבלה הבאה מודגשים הסטטוס התפעולי ומאפייני הזיהוי של המחבר.

מאפיינים

מאפיינים
`status`	`ConnectorConnectivityStatusEnum` הסטטוס הנוכחי של החיבור והתקינות של המחבר.
`is_enabled`	`bool` מציין אם המחבר פעיל ומעבד נתונים.

status

ConnectorConnectivityStatusEnum

הסטטוס הנוכחי של החיבור והתקינות של המחבר.

is_enabled

bool

מציין אם המחבר פעיל ומעבד נתונים.

class TIPCommon.data_models.ConnectorConnectivityStatusEnum

class TIPCommon.data_models.ConnectorConnectivityStatusEnum(value)

בסיסים: Enum

‫ConnectorConnectivityStatusEnum מגדיר את מצבי הקישוריות האפשריים של מחבר, ומציין אם הוא מתקשר בהצלחה עם היעד של האינטגרציה.

קבועים

הקבועים הבאים מייצגים את סטטוס התקינות של החיבור של המחבר.

קבועים
`LIVE`	`0`
`NO_CONNECTIVITY`	`1`

class TIPCommon.data_models.ConnectorParamTypes

class TIPCommon.data_models.ConnectorParamTypes(value)

בסיסים: Enum

ConnectorParamTypes מגדיר את סוגי הנתונים הנתמכים לפרמטרים של הגדרת המחבר. הסוגים האלה מבטיחים אימות תקין ועיבוד של ממשק המשתמש בהגדרות של הפלטפורמה.

קבועים

הקבועים הבאים מייצגים את סוגי הנתונים הספציפיים שזמינים לפרמטרים.

קבועים
`BOOLEAN`	`0` (החלפת מצב בוליאני)
`INTEGER`	`1` (מספר שלם)
`STRING`	‫`2` (מחרוזת טקסט רגילה)
`PASSWORD`	‫`3` (שדה סיסמה מוסתר)
`IP`	‫`4` (כתובת IP)
`HOST`	`5` (שם המארח)
`URL`	`6` (מחרוזת של כתובת URL)
`DOMAIN`	‫`7` (שם הדומיין)
`EMAIL`	`8` (כתובת אימייל)
`SCRIPT`	`12` (פרמטר סקריפט מדור קודם)
`NULL`	`-1` (סוג פרמטר לא חוקי)

class TIPCommon.data_models.ConnectorParameter

class TIPCommon.data_models.ConnectorParameter(raw_param)

בסיסים: פרמטר

‫ConnectorParameter מייצג הגדרת תצורה פרטנית למחבר. הוא מרחיב את מודל הפרמטרים הבסיסי וכולל מטא-נתונים ספציפיים כמו סוגי אימות ודרישות חובה.

מאפיינים

המאפיינים הבאים מספקים גישה לפרטי ההגדרה ולמגבלות של פרמטר המחבר.

מאפיינים
`name`	`str` השם הייחודי שמשמש לזיהוי הפרמטר בהגדרות של מחבר.
`value`	`Any` הערך הנוכחי שמוקצה לפרמטר.
`type`	`ConnectorParamTypes` סוג הנתונים של הפרמטר, שמשמש לאימות ולעיבוד ממשק המשתמש.
`mode`	`int` מצב ההפעלה או הגדרת החשיפה של הפרמטר.
`is_mandatory`	`bool` מציין אם צריך לספק ערך לפרמטר הזה לפני שמירת המחבר או הפעלתו.

דוגמה

בדוגמה הבאה אפשר לראות איך מאתחלים ConnectorParameter באמצעות מילון גולמי וניגשים למאפיינים שלו.

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

class TIPCommon.data_models.Container

class TIPCommon.data_models.Container()

בסיסים: object

המאגר פועל כאובייקט גנרי ודינמי לאחסון משתנים כמאפיינים. הוא שימושי להעברת אוספים שרירותיים של נתונים בין רכיבים שונים של הפלטפורמה.

דוגמה

בדוגמה הבאה אפשר לראות איך מאתחלים קונטיינר ומקצים ומאחזרים משתנה באופן דינמי.

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

בסיסים: object

‫CreateEntity מכיל את ההוראות שנדרשות כדי ליצור ישות חדשה ולקשר אותה לתיק קיים ולהתראה קיימת. הוא כולל לוגיקה למיפוי של קשרים וחיבורים שמבוסס על ביטויים רגולריים.

Methods

השיטה הבאה מטפלת בהמרת הוראות ליצירת ישות לפורמט שתואם לפלטפורמה.

Methods

Methods
`to_json()`	`to_json() → MutableMapping[str, Any]` הפונקציה ממירה את האובייקט `CreateEntity` למילון שאפשר להמיר ל-JSON.

to_json()

to_json() → MutableMapping[str, Any]

הפונקציה ממירה את האובייקט CreateEntity למילון שאפשר להמיר ל-JSON.

מאפיינים

בטבלה הבאה מפורטים המאפיינים העיקריים שמשמשים להגדרת הישות החדשה והקשרים שלה בפלטפורמה.

מאפיינים
`case_id`	`int` המזהה הייחודי של הפנייה שבה הישות תיווצר.
`alert_identifier`	`str` המזהה של ההתראה שהישות הזו משויכת אליה.
`entity_type`	`str` הסיווג של הישות.
`entity_identifier`	`str` הערך או השם הספציפיים שמזהים את הישות.
`entity_to_connect_regex`	`str` ביטוי רגולרי שמשמש לזיהוי ישויות אחרות שאפשר לקשר לישות הזו.
`types_to_connect`	`list[str] \| None` רשימה ספציפית של סוגי ישויות שעומדות בדרישות לחיבור על סמך הביטוי הרגולרי.
`is_primary_link`	`bool` מציין אם החיבור הזה מייצג את הקשר העיקרי בין הישויות.
`is_directional`	`bool` קובע אם לחיבור יש כיוון מוגדר (ממקור ליעד) או שהוא הדדי.

class TIPCommon.data_models.CustomField

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

בסיסים: object

‫CustomField מייצג שדה נתונים שהמשתמש הגדיר בפלטפורמה. הוא מאפשר להרחיב את מודלי הנתונים הרגילים על ידי הוספת מטא-נתונים ספציפיים שמותאמים לדרישות הארגון.

Methods

השיטה הבאה מאפשרת לשחזר אובייקטים של שדות בהתאמה אישית מנתוני JSON מובְנים.

Methods

Methods
`from_json()`	`from_json(json_data: MutableMapping[str, Any]) → CustomField` שיטה של מחלקה שמאתחלת מופע של `CustomField` ממילון של מאפייני שדה.

from_json()

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

שיטה של מחלקה שמאתחלת מופע של CustomField ממילון של מאפייני שדה.

מאפיינים

בטבלה הבאה מודגשים המאפיינים העיקריים והגבלות ההיקף של השדה המותאם אישית.

מאפיינים
`id`	`int` המזהה הייחודי של השדה המותאם אישית.
`display_name`	`str` התווית שמוצגת בממשק המשתמש של הפלטפורמה, שאנשים יכולים לקרוא.
`type`	`str` סוג הנתונים של השדה.
`scopes`	`list[CustomFieldScope]` רשימה של אזורי אפליקציה שבהם השדה הזה זמין

class TIPCommon.data_models.CustomFieldScope

class TIPCommon.data_models.CustomFieldScope(value)

בסיסים: Enum

התג CustomFieldScope מגדיר את היעדים התקפים שבהם שדה מותאם אישית חל בהיררכיית הפלטפורמה.

Methods

השיטה הבאה מספקת כלי לפתרון הבעיה של הנתיב של האובייקט המוגבל.

Methods

Methods
`build_parent_path()`	`build_parent_path(identifier: int) → str` יוצר את נתיב הפלטפורמה הפנימי למזהה של אובייקט האב שצוין.

build_parent_path()

build_parent_path(identifier: int) → str

יוצר את נתיב הפלטפורמה הפנימי למזהה של אובייקט האב שצוין.

קבועים

הקבועים הבאים מייצגים את ההיקפים הספציפיים שזמינים לשדות בהתאמה אישית.

קבועים
`ALERTS`	`'Alert'`
`CASE`	`'Case'`

class TIPCommon.data_models.CustomFieldValue

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

בסיסים: object

‫CustomFieldValue מייצג את הנתונים הספציפיים שהוקצו למופע של שדה מותאם אישית. הוא מקשר בין הגדרת השדה לבין התוכן בפועל שסופק על ידי משתמש או על ידי תהליך אוטומטי.

Methods

השיטה הבאה מאפשרת לשחזר ערכים של שדות מותאמים אישית מנתוני JSON מובנים.

Methods

Methods
`from_json()`	`from_json(json_data: MutableMapping[str, Any]) → CustomFieldValue` שיטת מחלקה שמאתחלת מופע `CustomFieldValue` ממילון של מאפייני ערך.

from_json()

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

שיטת מחלקה שמאתחלת מופע CustomFieldValue ממילון של מאפייני ערך.

מאפיינים

בטבלה הבאה מודגשים המאפיינים העיקריים והמזהים ההקשריים של הערך בשדה המותאם אישית.

מאפיינים
`custom_field_id`	`int` המזהה של הגדרת `CustomField` שאליה שייך הערך הזה.
`values`	`list[str]` רשימה של מחרוזות שמייצגות את הנתונים בפועל שמאוחסנים בשדה.
`scope`	`CustomFieldScope` האזור שבו הערך הספציפי הזה חל.
`identifier`	`int` המזהה הייחודי של האובייקט הספציפי שמכיל את הערך הזה.

class TIPCommon.data_models.DataAccessContext

class TIPCommon.data_models.DataAccessContext(global_access, assigned_scopes)

בסיסים: object

‫DataAccessContext מגדיר את ההרשאות ואת מגבלות החשיפה של משתמש או תהליך, וקובע לאילו היקפי נתונים יש גישה במהלך ההרצה.

Methods

השיטות הבאות מנהלות את ההמרה של נתוני הקשר הגישה בין מופעי אובייקט לבין פורמטים של JSON.

Methods

Methods
`from_json()`	`from_json(json_data: MutableMapping[str, Any]) → DataAccessContext` שיטת מחלקה שמאתחלת מופע של `DataAccessContext` ממילון של מאפייני גישה.
`to_json()`	`to_json() → dict` ממירה את האובייקט `DataAccessContext` לפורמט של מילון.

from_json()

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

שיטת מחלקה שמאתחלת מופע של DataAccessContext ממילון של מאפייני גישה.

to_json()

to_json() → dict

ממירה את האובייקט DataAccessContext לפורמט של מילון.

מאפיינים

בטבלה הבאה מודגשים אמצעי בקרת הגישה העיקריים שמוגדרים בהקשר.

מאפיינים

מאפיינים
`global_access`	`bool` מציין אם ההקשר מאפשר גישה בלתי מוגבלת לכל היקפי הנתונים.
`assigned_scopes`	`list[Any]` רשימה של היקפים או יחידות ארגוניות ספציפיים שניתנה להם גישה באופן מפורש.

global_access

bool

מציין אם ההקשר מאפשר גישה בלתי מוגבלת לכל היקפי הנתונים.

assigned_scopes

list[Any]

רשימה של היקפים או יחידות ארגוניות ספציפיים שניתנה להם גישה באופן מפורש.

class TIPCommon.data_models.DatabaseContextType

class TIPCommon.data_models.DatabaseContextType(value)

בסיסים: Enum

הפרמטר DatabaseContextType מציין את ההקשר התפעולי לאינטראקציות עם מסד הנתונים, כדי להבטיח שהנתונים יישמרו או יאוחזרו מהפלח הלוגי הנכון של הפלטפורמה.

קבועים

הקבועים הבאים מייצגים את האזורים הספציפיים בפלטפורמה שבהם מתבצעות פעולות במסד הנתונים.

קבועים
`GLOBAL`	`0` (הקשר גלובלי בכל המערכת)
`CASE`	`1` (הקשר של מקרה אבטחה ספציפי)
`ALERT`	`2` (הקשר של התראה ספציפית)
`JOB`	‫`3` (משימה מתוזמנת או הקשר של אוטומציה)
`CONNECTOR`	`4` (הקשר של מחבר הנתונים)

class TIPCommon.data_models.DynamicParameter

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

בסיסים: object

‫DynamicParameter מייצג צמד גמיש של מפתח/ערך שמשמש להעברת הגדרות של זמן ריצה או מטא-נתונים מותאמים אישית בין רכיבי המערכת.

Methods

השיטה הבאה מטפלת בשחזור של פרמטרים דינמיים מנתוני JSON מובְנים.

Methods

Methods
`from_json()`	`from_json(json_data: MutableMapping[str, Any]) → DynamicParameter` שיטת מחלקה שמאתחלת מופע של `DynamicParameter` ממילון של מאפייני מפתח וערך.

from_json()

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

שיטת מחלקה שמאתחלת מופע של DynamicParameter ממילון של מאפייני מפתח וערך.

מאפיינים

בטבלה הבאה מפורטים המאפיינים של הפרמטר הדינמי.

מאפיינים

מאפיינים
`key`	`str` השם או המזהה של הפרמטר.
`value`	`str` תוכן הנתונים שמשויך למפתח.

key

str

השם או המזהה של הפרמטר.

value

str

תוכן הנתונים שמשויך למפתח.

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)

בסיסים: object

‫EmailTemplate מייצג פורמט תקשורת סטנדרטי שמשמש להודעות ולדיווחים בפלטפורמה. הוא כולל את תוכן ההודעה, המטא-נתונים והמגבלות הסביבתיות.

Methods

ה-methods הבאות מנהלות את הסריאליזציה והשחזור של תבניות אימייל.

Methods

Methods
`from_json()`	`from_json(data: MutableMapping[str, Any]) → EmailTemplate` מתודה של מחלקה שיוצרת מופע של `EmailTemplate` מתוך מילון שמכיל נתוני תבנית.
`to_json()`	`to_json() → dict` ממיר את האובייקט `EmailTemplate` לפורמט מילון שניתן לסדר אותו ב-JSON.

from_json()

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

מתודה של מחלקה שיוצרת מופע של EmailTemplate מתוך מילון שמכיל נתוני תבנית.

to_json()

to_json() → dict

ממיר את האובייקט EmailTemplate לפורמט מילון שניתן לסדר אותו ב-JSON.

מאפיינים

בטבלה הבאה מודגשים המאפיינים העיקריים והנתונים המבניים של תבנית האימייל.

מאפיינים

מאפיינים
`content`	`str` הטקסט של תוכן האימייל או מבנה ה-HTML של תבנית האימייל.
`environments`	`list[str]` רשימה של סביבות ארגוניות שבהן התבנית הזו זמינה לשימוש.
`template_type`	`int \| str` הסיווג או הקטגוריה של התבנית.

content

str

הטקסט של תוכן האימייל או מבנה ה-HTML של תבנית האימייל.

environments

list[str]

רשימה של סביבות ארגוניות שבהן התבנית הזו זמינה לשימוש.

template_type

int | str

הסיווג או הקטגוריה של התבנית.

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

בסיסים: object

Entity מייצג אובייקט ספציפי שניתן לצפייה או אובייקט מעניין בתוך מקרה אבטחה (כמו כתובת IP, גיבוב קובץ או משתמש). הוא עוקב אחרי טלמטריה גולמית ותגי בוליאן שונים שמציינים את התפקיד או את רמת הסיכון של הישות בחקירה.

Methods

ה-methods הבאות מנהלות את הסריאליזציה והשחזור של אובייקטים של ישויות.

Methods

Methods
`from_json()`	`from_json(entity_response: MutableMapping[str, Any]) → Entity` מתודה של מחלקה שמאתחלת מופע של `Entity` ממילון שמכיל טלמטריה ודגלים של ישות.
`to_json()`	`to_json() → MutableMapping[str, Any]` הפונקציה ממירה את האובייקט `Entity` לפורמט מילון שניתן לסדר אותו ב-JSON.

from_json()

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

מתודה של מחלקה שמאתחלת מופע של Entity ממילון שמכיל טלמטריה ודגלים של ישות.

to_json()

to_json() → MutableMapping[str, Any]

הפונקציה ממירה את האובייקט Entity לפורמט מילון שניתן לסדר אותו ב-JSON.

מאפיינים

בטבלה הבאה מודגשים דגלי הסיווג העיקריים ומבני הנתונים שמשויכים לישות.

מאפיינים
`entity_type`	`str \| None` הקטגוריה של הישות.
`suspicious`	`bool` מציין אם הישות סומנה כבעלת פוטנציאל זדוני על ידי לוגיקה של המערכת או על ידי מודיעין חיצוני.
`vulnerable`	`bool` מציין אם ידוע שיש לישות נקודות חולשה קיימות באבטחה.
`attacker`	`bool` הערך הוא True אם הישות מזוהה כמקור של פעילות זדונית.
`internal`	`bool` השדה מציין אם הישות שייכת לרשת או לתשתית הפנימית של הארגון.
`fields`	`list[MutableMapping[str, Any]]` רשימה של מאפיינים נוספים או נקודות נתונים מועשרות שמשויכות לישות.

class TIPCommon.data_models.EntityCard

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

בסיסים: object

‫EntityCard מייצג תצוגה מסוכמת של ישות, ובדרך כלל משמש לרכיבי ממשק משתמש. הוא צובר את הפרטים של הישות: המזהה, הסוג והקשרים שלה עם ישויות אחרות במבנה פשוט.

Methods

השיטות הבאות מנהלות את הסריאליזציה והשחזור של כרטיסי ישויות.

Methods

Methods
`from_json()`	`from_json(entity_data: MutableMapping[str, Any]) → EntityCard` שיטת מחלקה שמאתחלת מופע `EntityCard` ממילון של נתוני סיכום של ישות.
`to_json()`	`to_json() → MutableMapping[str, Any]` הפונקציה ממירה את האובייקט `EntityCard` לפורמט מילון שניתן לסדר אותו ב-JSON.

from_json()

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

שיטת מחלקה שמאתחלת מופע EntityCard ממילון של נתוני סיכום של ישות.

to_json()

to_json() → MutableMapping[str, Any]

הפונקציה ממירה את האובייקט EntityCard לפורמט מילון שניתן לסדר אותו ב-JSON.

מאפיינים

בטבלה הבאה מודגשים המאפיינים העיקריים שמשמשים לזיהוי ולקישור של ישויות בכרטיס.

מאפיינים
`identifier`	`str` הערך או השם הייחודי שמזהה את הישות.
`entity_type`	`str` קטגוריית הסיווג של הישות.
`is_suspicious`	`str` מחרוזת שמציינת (לרוב `True` או `False`) את הסטטוס החשוד של הישות.
`linked_entities`	`list[str]` רשימה של מזהים של ישויות אחרות שקשורות לכרטיס הישות הספציפי הזה.

class TIPCommon.data_models.EnvironmentData

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

בסיסים: object

‫EnvironmentData כולל מידע על ההגדרות והמיתוג של סביבה ארגונית ספציפית. זה כולל פרמטרים ספציפיים לסביבה ונכסים ויזואליים שמשמשים לפריסות של מספר דיירים או מספר סביבות.

Methods

השיטה הבאה מאפשרת ליצור אובייקטים של נתוני סביבה מנתוני JSON מובנים.

Methods

Methods
`from_json()`	`from_json(json_data: MutableMapping[str, Any]) → EnvironmentData` שיטת מחלקה שמאתחלת מופע של `EnvironmentData` ממילון של מאפייני סביבה.

from_json()

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

שיטת מחלקה שמאתחלת מופע של EnvironmentData ממילון של מאפייני סביבה.

מאפיינים

בטבלה הבאה מפורטים פרמטרי ההגדרה ונכסי המיתוג שמשויכים לסביבה.

מאפיינים
`environment`	`str` השם של הסביבה הארגונית.
`dynamic_parameters`	`list[DynamicParameter]` רשימה של צמדי מפתח/ערך מותאמים אישית שספציפיים להגדרה של הסביבה הזו.
`base64_image`	`str \| None` מחרוזת אופציונלית בקידוד base64 שמייצגת את הלוגו או הסמל של הסביבה.
`platform`	`int \| None` מזהה מספרי שמייצג את הפלטפורמה הספציפית או את ספק התשתית.

class TIPCommon.data_models.EventCard

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

בסיסים: object

‫EventCard מייצג סיכום תמציתי וידידותי מבחינה ויזואלית של אירוע אבטחה ספציפי. הוא נועד להציג את נתוני הטלמטריה החשובים ביותר – כמו תזמון, מוצר המקור ותוצאה – לשימוש בלוחות בקרה של חקירות ובתורי אירועים.

Methods

השיטות הבאות מנהלות את ההמרה של נתוני כרטיסי אירועים בין מופעי אובייקטים לפורמטים של JSON.

Methods

Methods
`from_json()`	`from_json(event_data: MutableMapping[str, Any]) → EventCard` שיטת מחלקה שיוצרת מופע של `EventCard` ממילון של מאפייני אירוע.
`to_json()`	`to_json() → MutableMapping[str, Any]` הפונקציה ממירה את האובייקט `EventCard` לפורמט מילון שניתן לסדר אותו ב-JSON.

from_json()

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

שיטת מחלקה שיוצרת מופע של EventCard ממילון של מאפייני אירוע.

to_json()

to_json() → MutableMapping[str, Any]

הפונקציה ממירה את האובייקט EventCard לפורמט מילון שניתן לסדר אותו ב-JSON.

מאפיינים

בטבלה הבאה מפורטים נתוני הטלמטריה העיקריים והמזהים הארגוניים שמאוחסנים בכרטיס האירוע.

מאפיינים
`event_id`	`str` המזהה הייחודי של רשומת האירוע הספציפית.
`time`	`int` חותמת הזמן של מערכת Unix שמייצגת את הזמן שבו האירוע התרחש.
`product`	`str` מוצר או כלי האבטחה שיצרו את טלמטריית האירועים.
`outcome`	`str` התוצאה המתועדת של האירוע.
`artifact_entities`	`list[MutableMapping[str, Any]]` רשימה של ישויות שזוהו בטלמטריה של האירוע ומשמשות כארטיפקטים של המקרה.
`fields`	`list[MutableMapping[str, Any]]` אוסף של מאפיינים נוספים של מפתח/ערך שספציפיים למטען הייעודי (payload) של נתוני האירוע הזה.

class TIPCommon.data_models.EventPropertyField

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

בסיסים: object

‫EventPropertyField מגדיר אוסף מובנה של מאפייני אירועים, שמסודרים לפי עדיפות וקיבוץ. הוא משמש לסיווג נתוני טלמטריה לצורך הצגה, ומדגיש שדות קריטיים להתמקדות בחקירה.

Methods

השיטה הבאה מטפלת בשחזור של אובייקטים של שדות נכס מנתוני JSON מובנים.

Methods

Methods
`from_json()`	`from_json(event_property_field: MutableMapping[str, Any]) → EventPropertyField` שיטת מחלקה שמאתחלת מופע של `EventPropertyField` ממילון של מאפייני שדה.

from_json()

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

שיטת מחלקה שמאתחלת מופע של EventPropertyField ממילון של מאפייני שדה.

מאפיינים

בטבלה הבאה מודגשים המטא-נתונים ופריטי התוכן שמגדירים את שדה מאפיין האירוע.

מאפיינים

מאפיינים
`group_name`	`str` השם של הקבוצה הלוגית שאליה השדות האלה שייכים.
`is_highlight`	`bool` מציין אם צריך להדגיש את השדה הזה בממשק המשתמש של הפלטפורמה כנקודת נתונים בעדיפות גבוהה.
`items`	`list[FieldItem]` רשימה של פריטי נתונים ספציפיים שכלולים בקבוצת הנכסים הזו.

group_name

str

השם של הקבוצה הלוגית שאליה השדות האלה שייכים.

is_highlight

bool

מציין אם צריך להדגיש את השדה הזה בממשק המשתמש של הפלטפורמה כנקודת נתונים בעדיפות גבוהה.

items

list[FieldItem]

רשימה של פריטי נתונים ספציפיים שכלולים בקבוצת הנכסים הזו.

class TIPCommon.data_models.FieldGroupItem

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

בסיסים: object

‫FieldGroupItem מייצג נקודת נתונים ספציפית בתוך קבוצת שדות, ושומר על מיפוי בין שם המקור המקורי לבין שם התצוגה שקל לקרוא.

Methods

ה-methods הבאות מנהלות את הסריאליזציה והשחזור של פריטים בקבוצת שדות.

Methods

from_json()

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

שיטת מחלקה שמאתחלת מופע של FieldGroupItem ממילון JSON.

to_json()

to_json() → MutableMapping[str, Any]

ממיר את האובייקט FieldGroupItem לפורמט מילון שניתן לסדר אותו ב-JSON.

class TIPCommon.data_models.FieldItem

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

בסיסים: object

‫FieldItem הוא מבנה נתונים בסיסי למאפיינים בודדים, שבו מאוחסנים המפתח הגולמי, התווית הממופה והערך המשויך.

Methods

from_json()

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

‫A class method שיוצר מופע FieldItem ממילון של מאפייני שדות.

class TIPCommon.data_models.FieldsGroup

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

בסיסים: object

‫FieldsGroup משמש כמאגר לארגון של כמה פריטי שדה באוסף לוגי. הוא משמש בעיקר לשליטה בפריסה ובנראות של הנתונים בממשק המשתמש של הפלטפורמה.

Methods

השיטות הבאות מנהלות את ההמרה של נתוני קבוצת שדות בין מופעי אובייקט לבין JSON מובנה.

Methods

from_json()

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

שיטת מחלקה שמאתחלת מופע של FieldsGroup ממילון של מאפיינים קבוצתיים.

to_json()

to_json() → MutableMapping[str, Any]

הפונקציה ממירה את האובייקט FieldsGroup לפורמט מילון שניתן לסדר אותו ב-JSON.

מאפיינים

בטבלה הבאה מודגשים המאפיינים שמגדירים את אופן התצוגה והתוכן של הקבוצה.

מאפיינים

group_name

str

התווית שמשמשת לזיהוי הקבוצה בממשק המשתמש.

is_highlight

bool

קובע אם הקבוצה צריכה להיות מודגשת חזותית.

items

list[FieldGroupItem]

רשימה של נקודות נתונים ספציפיות שנכללות בקבוצה.

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)

בסיסים: object

‫GoogleServiceAccount מספק ייצוג מובנה של Google Cloudפרטי כניסה לחשבון שירות. הוא משמש לניהול פרטי אימות של שילובים שיוצרים אינטראקציה עם שירותי Google.

Methods

השיטה הבאה מאפשרת לייצא נתוני אישורים לפורמט הסטנדרטי שנדרש בספריות לקוח.

Methods

to_dict()

to_dict() → dict[str, str]

מבצע סריאליזציה של מאפייני חשבון השירות למילון שתואם לפורמט service-account-file.json הרגיל.

class TIPCommon.data_models.Insight

class TIPCommon.data_models.Insight(raw_data)

בסיסים: object

תובנה מייצגת ממצא או תצפית אנליטיים נפרדים שנוצרו על ידי הפלטפורמה או שילוב. היא כוללת נתונים גולמיים שמספקים הקשר נוסף או פעולות מומלצות לחקירת אבטחה.

Methods

ה-methods הבאות מנהלות את הסריאליזציה והשחזור של אובייקטים של תובנות.

Methods

from_json()

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

שיטת מחלקה שיוצרת מופע Insight ממילון של נתוני טלמטריה גולמיים של תובנות.

to_json()

to_json() → MutableMapping[str, Any]

מבצע סריאליזציה של האובייקט Insight בחזרה לפורמט מילון שתואם ל-JSON.

מאפיינים

raw_data

MutableMapping[str, Any]

המטען הייעודי (Payload) של נתוני המקור שכולל את הממצאים הספציפיים ואת המדדים של התובנה.

‫class TIPCommon.data_models.InstalledIntegrationInstance

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

בסיסים: object

‫InstalledIntegrationInstance מייצג מכונה ספציפית של שילוב שהוגדרה ונפרסה בסביבה מסוימת. הוא מקשר בין ההגדרה הכללית של השילוב לבין הפריסה והשמות הספציפיים שלו בסביבה.

Methods

השיטות הבאות מנהלות את ההמרה של נתוני מופע השילוב בין מופעי אובייקט לבין JSON מובנה.

Methods

from_json()

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

שיטה של מחלקה שמנתחת נתוני JSON לאובייקט InstalledIntegrationInstance.

to_json()

to_json() → MutableMapping[str, Any]

הפונקציה מבצעת סריאליזציה של נתוני מופע האינטגרציה לפורמט מילון שתואם ל-JSON.

מאפיינים

בטבלה הבאה מודגשים המזהים שמשמשים למעקב אחר השילוב בסביבות ארגוניות שונות.

מאפיינים

instance_name

str

השם שהמשתמש נתן למופע הספציפי הזה של השילוב.

integration_identifier

str

המזהה הייחודי של השילוב הראשי.

environment_identifier

str

המזהה של הסביבה הארגונית שבה המופע הזה מותקן.

class TIPCommon.data_models.InternalDomain

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)

בסיסים: object

‫InternalDomain מייצג מזהה דומיין שמזוהה כחלק מהתשתית הפנימית של הארגון. הרשומות האלה חשובות כדי להבחין בין תנועה פנימית לבין איומים חיצוניים במהלך חקירות אבטחה.

Methods

ה-methods הבאות מנהלות את הסריאליזציה והשחזור של רשומות פנימיות של דומיין.

Methods

from_json()

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

‫method של מחלקה שיוצרת אובייקט InternalDomain ממילון JSON.

to_json()

to_json() → MutableMapping[str, Any]

ממיר את האובייקט InternalDomain לפורמט מילון שניתן לסדר אותו ב-JSON.

מאפיינים

בטבלה הבאה מודגשים המאפיינים שמשמשים לזיהוי ולסיווג של דומיינים פנימיים.

מאפיינים

domain_display_name

str

שם הדומיין הראשי.

alias_name

str

שם או תווית חלופיים שמשמשים לזיהוי הדומיין בפלטפורמה.

environments_json

str

מחרוזת בפורמט JSON שמפרטת את הסביבות שבהן הדומיין הזה נחשב פנימי.

class TIPCommon.data_models.JobParamType

class TIPCommon.data_models.JobParamType(value)

בסיסים: Enum

‫JobParamType מגדיר את סוגי הנתונים הנתמכים לפרמטרים שמשמשים בתוך משימות אוטומציה או משימות מתוזמנות. הסוגים האלה מאפשרים אימות תקין של הקלט וטיפול ברמת הפלטפורמה.

קבועים

הקבועים הבאים מייצגים את סוגי הנתונים הספציפיים שזמינים לפרמטרים של משימות.

קבועים
`BOOLEAN`	`0`
`INTEGER`	`1`
`STRING`	`2`
`PASSWORD`	`3`
`IP`	`4`
`HOST`	`5`
`URL`	`6`
`DOMAIN`	`7`
`EMAIL`	`8`
`NULL`	`-1`

‫class TIPCommon.data_models.Parameter

class TIPCommon.data_models.Parameter(raw_param)

בסיסים: object

הפרמטר משמש כמחלקה בסיסית ראשית לכל המודלים שקשורים לפרמטרים בספרייה. הוא מספק ממשק עקבי לטיפול בנתוני תצורה גולמיים.

מאפיינים

המאפיין הבא מספק גישה לנתונים הבסיסיים שמשמשים לאתחול הפרמטר.

מאפיינים

raw_data

dict[str, Any]

המטען הייעודי (Payload) של המילון המקורי שמכיל את ההגדרה של הפרמטר.

דוגמה

בדוגמה הבאה אפשר לראות איך מאתחלים את מחלקת הבסיס Parameter וניגשים לנתונים הגולמיים שלה.

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

בסיסים: object

הסכם רמת שירות (SLA) כולל את מגבלות הזמן והסטטוס של התראה. היא מספקת מעקב מדויק מאוד אחר מועדים רגילים וקריטיים, כולל לוגיקה להשהיות בטיפול.

Methods

השיטות הבאות מנהלות את ההמרה של נתוני SLA בין מופעי אובייקט לבין JSON מובנה.

Methods

from_json()

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

שיטת מחלקה שמאתחלת מופע של SLA ממילון JSON.

to_json()

to_json() → MutableMapping[str, Any]

הפונקציה ממירה את האובייקט SLA לפורמט מילון שניתן לסדר אותו ב-JSON.

מאפיינים

בטבלה הבאה מודגשים מאפייני התזמון העיקריים שמשמשים למעקב אחרי תפוגת ההתראות.

מאפיינים

sla_expiration_time

int | None

חותמת הזמן של מערכת Unix שמייצגת את תאריך היעד לתפוגה של הסכם רמת השירות הרגיל.

critical_expiration_time

int | None

חותמת הזמן של מערכת Unix שמייצגת את תאריך היעד לפקיעת תוקף הסכם רמת השירות.

expiration_status

int

הסטטוס הנוכחי של ה-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)

בסיסים: object

‫ScriptContext הוא מאגר מקיף שמספק את הסביבה, המזהים והפרמטרים הדרושים להרצת סקריפט. הוא עוקב אחרי כל דבר, החל מישויות יעד ומזהים של תהליכי עבודה ועד להגדרות אבטחה כמו הגדרות של שרת proxy וכספת.

Methods

השיטות הבאות מאפשרות לשנות את הקשר של ביצוע הסקריפט ולבצע בו סריאליזציה.

Methods

to_json()

to_json() → MutableMapping[str, Any]

מבצע המרה של ScriptContext לפורמט מילון שתואם ל-JSON.

update()

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

מעדכנת את מאפייני ההקשר עם ערכים ממילון שסופק.

מאפיינים

בהתחשב בהיקף הרחב של ההקשר, בטבלה הבאה מודגשים המזהים הקריטיים ביותר של הביצוע והסביבה.

מאפיינים
`case_id`	`int \| str \| None` המזהה של הפנייה שמשויכת להרצת הסקריפט הנוכחית.
`workflow_id`	`str` המזהה של תהליך העבודה שנמצא כרגע בעיבוד.
`parameters`	`SingleJson` מילון שמכיל פרמטרים של זמן ריצה שמועברים לסקריפט.
`execution_deadline_unix_time_ms`	`int` חותמת הזמן של מערכת Unix שמציינת מתי הרצת הסקריפט צריכה להסתיים.
`vault_settings`	`SiemplifyVault \| None` הגדרות הגישה למידע אישי רגיש שמאוחסן בכספת של הפלטפורמה.

class TIPCommon.data_models.SmimeEmailConfig

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

בסיסים: object

‫SmimeEmailConfig מכיל את הנכסים הקריפטוגרפיים הנדרשים ואת הודעת האימייל שנדרשת לביצוע פעולות S/MIME, כמו חתימה או הצפנה. הוא מכיל את האימייל הגולמי ואת המפתחות והאישורים בקידוד base64.

מאפיינים

בטבלה הבאה מתוארים הרכיבים הקריפטוגרפיים שמנוהלים על ידי מודל ההגדרה הזה.

מאפיינים
`email`	`email.message.Message` אובייקט הודעת האימייל הרגיל של Python לעיבוד.
`private_key_b64`	`str` המפתח הפרטי בקידוד base64 שמשמש לחתימה או לפענוח.
`certificate_b64`	`str` האישור הציבורי בקידוד Base64 שמשויך למפתח הפרטי.
`ca_certificate_b64`	`str` אישור רשות האישורים (CA) בקידוד base64 שמשמש לאימות שרשרת האמון.

class TIPCommon.data_models.SmimeType

class TIPCommon.data_models.SmimeType(value)

בסיסים: Enum

‫SmimeType מגדיר את מצב הפעולה לעיבוד S/MIME, ומבחין בין אבטחת התוכן באמצעות הצפנה לבין אימות השולח באמצעות חתימה דיגיטלית.

קבועים

הקבועים הבאים מייצגים את סוגי ההודעות הנתמכים של S/MIME.

קבועים
`SIGNED`	`'signed'` (ההודעה חתומה דיגיטלית כדי לוודא את האותנטיות שלה)
`ENCRYPTED`	`'encrypted'` (גוף ההודעה מוצפן כדי לשמור על הסודיות)

‫class TIPCommon.data_models.TypedContainer

class TIPCommon.data_models.TypedContainer()

בסיסים: Generic[T]

‫TypedContainer הוא עטיפה גנרית שנועדה להכיל נתונים מסוג ספציפי. הוא משפר את הפרודוקטיביות של המפתחים באמצעות מתן רמזים לגבי סוגים ו-IntelliSense, ומוודא שכלי IDE וניתוח סטטי יטפלו באובייקט המאוחסן בצורה נכונה.

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)

בסיסים: object

‫UserDetails מספק פרופיל מקיף של משתמש בפלטפורמה, שכולל מטא-נתונים של אימות, תפקידים ארגוניים והרשאות גישה לנתונים פרטניות. הוא חיוני לניהול סשנים של משתמשים ולאכיפה של בקרת גישה מבוססת-תפקידים (RBAC).

Methods

השיטות הבאות מאפשרות לשחזר ולבצע סריאליזציה של נתוני פרופיל המשתמשים.

Methods

from_json()

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

שיטת מחלקה שמאתחלת מופע UserDetails ממילון JSON של מאפייני משתמש.

to_json()

to_json() → MutableMapping[str, Any]

הפונקציה ממירה את האובייקט UserDetails לפורמט מילון שניתן לסדר אותו ב-JSON.

מאפיינים

בטבלה הבאה מודגשים מבני הזיהוי וההרשאות העיקריים של המשתמש.

מאפיינים
`user_name`	`str` שם המשתמש הייחודי במערכת שמשמש לכניסה ולזיהוי.
`soc_roles`	`list[str]` רשימה של תפקידי SOC שהוקצו למשתמש, שקובעים את ההרשאות התפעוליות שלו.
`data_access_context`	`DataAccessContext` ההקשר שמגדיר לאילו היקפי נתונים ויחידות ארגוניות מותר למשתמש לגשת.
`is_disabled`	`bool` סימון בוליאני שמציין אם הגישה לחשבון המשתמש מוגבלת כרגע.

class TIPCommon.data_models.UserProfileCard

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

בסיסים: object

‫UserProfileCard מספק סיכום קל משקל של פרופיל המשתמש, שנועד להצגה ברכיבי ממשק משתמש כמו כותרות או כרטיסי איש קשר, שבהם לא נדרשים הפרטים המלאים.

Methods

from_json()

from_json(user_profile_card_response: dict) → UserProfileCard

שיטה של מחלקה שיוצרת מופע UserProfileCard ממילון של מאפייני פרופיל בסיסיים.

class TIPCommon.data_models.WallData

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

בסיסים: object

‫WallData מייצג רשומה ב'קיר' או בציר הזמן של תיק. המודל הזה עוקב אחרי יומני פעילות, הערות ופעולות מערכת שמתרחשות במהלך מחזור החיים של חקירה.

Methods

from_json()

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

‫ method של מחלקה שיוצרת מופע WallData ממילון JSON של פעילות בלוח.

to_json()

to_json() → MutableMapping[str, Any]

מבצע סריאליזציה של האובייקט WallData בחזרה לפורמט מילון שתואם ל-JSON.

מאפיינים

activity_kind

str | int | None

הקטגוריה של הפעילות.

activity_data_json

str | None

מחרוזת בפורמט JSON שמכילה את הפרטים הספציפיים או את המטען הייעודי (payload) של הפעילות.

favorite

bool

מציין אם רשומת הפעילות הוצמדה או סומנה כמועדפת לצורך עיון מהיר.

הבעיה עדיין לא נפתרה? קבלת תשובות מחברי הקהילה וממומחי Google SecOps.

מודול data_models

class TIPCommon.data_models.AlertCard

Methods

מאפיינים

class TIPCommon.data_models.AlertEvent

Methods

מאפיינים

‫class TIPCommon.data_models.AlertPriority

קבועים

class TIPCommon.data_models.AttachmentMetadata

Methods

מאפיינים

‫class TIPCommon.data_models.BaseAlert

Methods

מאפיינים

דוגמה

‫class TIPCommon.data_models.BaseDataModel

Methods

מאפיינים

דוגמה

class TIPCommon.data_models.CaseDataStatus

קבועים

‫class TIPCommon.data_models.CaseDetails

Methods

מאפיינים

class TIPCommon.data_models.CaseOverviewInfo

Methods

מאפיינים

class TIPCommon.data_models.CasePriority

קבועים

class TIPCommon.data_models.CaseSLAInfo

Methods

מאפיינים

class TIPCommon.data_models.CaseWallAttachment

מאפיינים

class TIPCommon.data_models.ConnectorCard

Methods

מאפיינים

class TIPCommon.data_models.ConnectorConnectivityStatusEnum

קבועים

class TIPCommon.data_models.ConnectorParamTypes

קבועים

class TIPCommon.data_models.ConnectorParameter

מאפיינים

דוגמה

class TIPCommon.data_models.Container

דוגמה

‫class TIPCommon.data_models.CreateEntity

Methods

מאפיינים

class TIPCommon.data_models.CustomField

Methods

מאפיינים

class TIPCommon.data_models.CustomFieldScope

Methods

קבועים

class TIPCommon.data_models.CustomFieldValue

Methods

מאפיינים

class TIPCommon.data_models.DataAccessContext

Methods

מאפיינים

class TIPCommon.data_models.DatabaseContextType

קבועים

class TIPCommon.data_models.DynamicParameter

Methods

מאפיינים

class TIPCommon.data_models.EmailTemplate

Methods

מאפיינים

‫class TIPCommon.data_models.Entity

Methods

מאפיינים

class TIPCommon.data_models.EntityCard

Methods

מאפיינים

class TIPCommon.data_models.EnvironmentData

Methods

מאפיינים

class TIPCommon.data_models.EventCard

מודול `data_models`