מודול Siemplify

class Siemplify.Siemplify

בסיסים: SiemplifyBase

נקודות קצה: external/v1/sdk/CaseFullDetails

add_agent_connector_logs

add_agent_connector_logs(agent_id, connector_id, logs_package)

הוספת יומנים של מחבר connector_id של הסוכן המרוחק.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
agent_id {string} מזהה הסוכן לא רלוונטי לא רלוונטי
connector_id {string} מזהה מופע המחבר לא רלוונטי לא רלוונטי
logs_package {dict} ConnectorLogPackage לא רלוונטי לא רלוונטי

add_attachment

add_attachment(file_path, case_id, alert_identifier, description=None, is_favorite=False)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
file_path {string} הנתיב של הקובץ כל נתיב נגיש נתיב יכול להיות גם מיקום מרוחק. צריך הרשאות קריאה לקובץ הזה
case_id {string} מזהה הפנייה מספר פנייה שאליו רוצים להוסיף את הקובץ המצורף ברירת המחדל היא האותיות הקטנות והגדולות הנוכחיות
alert_identifier {string} מזהה התראה מחרוזת מזהה ההתראה שרוצים לשייך אליה את הקובץ המצורף ברירת המחדל היא ההתראה שמופעלת כרגע
description {string} תיאור הקובץ המצורף כל מחרוזת אין ברירת מחדל.
פרמטר אופציונלי.
is_favorite {boolean} קובץ מצורף מועדף נכון/לא נכון ‫False כברירת מחדל.
פרמטר אופציונלי.

מחזירה

‫{long} attachment_id

דוגמה

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
siemplify.add_attachment(r'C:/temp/investigation.txt', description='Deep investigation report by TIER3 team', is_favorite=True)

התנהגות התוצאה

בדוגמה הזו, נטען את investigation.txt מ-C:/temp במחשב המקומי (השרת עצמו) ללוח הבקשה. תגובה תתווסף לרשומה הזו בקיר של בקשת התמיכה, עם המחרוזת בתיאור. הדגל is_favorite הוגדר לערך True, ולכן גם הרשומה החדשה הזו תסומן בכוכב (מועדפת).

add_comment

add_comment(comment, case_id, alert_identifier)

הוספת תגובה חדשה לבקשת התמיכה הספציפית.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
תגובה {string} התגובה שרוצים להוסיף לקיר של בקשת תמיכה "האירועים האלה בהתראה נראים חשודים" הערות שקשורות לבקשה
case_id {string} מזהה הפנייה 234 לא רלוונטי
alert_identifier {string} מזהה התראה ad6879f1-b72d-419f-990c-011a2526b16d לא רלוונטי

מחזירה

NoneType

דוגמה

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
add_comment = "This alert is important"
alert_identifier = "ad6879f1-b72d-419f-990c-011a2526b16d"
case_id = "234"
siemplify.add_comment(comment, case_id, alert_identifier)

התנהגות התוצאה

התגובה שצוינה נוספת לפנייה מספר 234.

ערך התוצאה

ללא

add_entities_to_custom_list

add_entities_to_custom_list(custom_list_items)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
custom_list_items {string} רשימה של פריטים ברשימה בהתאמה אישית לא רלוונטי לא רלוונטי

מחזירה

‫{[CustomList]} רשימה עם הפריט הנוסף של הרשימה המותאמת אישית.

התנהגות התוצאה

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

add_entity_insight

add_entity_insight(domain_entity_info, message, case_id, alert_id)

הוספת תובנה לגבי ישות.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
domain_entity_info {string} מזהה ישות ‪"192.0.2.1" {DomainEntityInfo}
הודעה {string} הודעת תובנה זוהי דוגמה ל-DNS לא רלוונטי
case_id {string} מזהה הפנייה שרוצים להוסיף לתובנה לגבי ישות 234 לא רלוונטי
alert_id {string} מזהה ההתראה שרוצים להוסיף לתובנה לגבי ישות ad6879f1-b72d-419f-990c-011a2526b16d לא רלוונטי

מחזירה

‫{boolean} True אם הפעולה הצליחה

דוגמה

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
entity = "192.0.2.1"
alert_identifier = "ad6879f1-b72d-419f-990c-011a2526b16d"
case_id = "234"
siemplify.add_entity_insight(domain_entity_info=entity, message=message, case_id=case_id, alert_id=alert_identifier)

התנהגות התוצאה

ההודעה שצוינה נוספת כתובנה לישות 192.0.2.1 של מזהה ההתראה שצוין בפנייה 234.

ערך התוצאה

נכון.

‫False אם התובנה לא נוספה.

add_entity_to_case

add_entity_to_case(case_id, alert_identifier, entity_identifier, entity_type, is_internal, is_suspicious, is_enriched, is_vulnerable, properties, environment)

הוספת ישות לבקשת תמיכה.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
entity_identifier {string} מזהה ישות ‫192.0.2.1, example.com לא רלוונטי
entity_type {string} סוג הישות של מזהה הישות "ADDRESS" לא רלוונטי
is_internal {boolean} לא רלוונטי נכון/לא נכון לא רלוונטי
is_suspicious {boolean} לא רלוונטי נכון/לא נכון
is_enriched {boolean} לא רלוונטי נכון/לא נכון הערך שמוגדר כברירת מחדל הוא False
is_vulnerable {boolean} לא רלוונטי נכון/לא נכון הערך שמוגדר כברירת מחדל הוא False
נכסים {dict} מאפיין של הישות {"property":"value"} לא רלוונטי

מחזירה

NoneType

דוגמה

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
case_id = "234"
alert_identifier = "ad6879f1-b72d-419f-990c-011a2526b16d"
entity = "192.0.2.1"
entity_type = "ADDRESS"
properties = {"property": "value"}
siemplify.add_entity_to_case(case_id=case_id,
                                          alert_identifier = alert_identifier,
                                          entity_identifier = entity,
                                          entity_type = entity_type,
                                          is_internal = True,
                                          is_suspicious = False,
                                          is_enriched = False,
                                          is_vulnerable = False,
                                          properties = properties,
                                          environment=None)

התנהגות התוצאה

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

ערך התוצאה

ללא

add_or_update_case_task

add_or_update_case_task(task)

הוספה או עדכון של בקשה למשימה: עדכון אם יש מזהה משימה, הוספה (יצירה) אם אין מזהה משימה.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
משימה {Task} אובייקט המשימה שצריך להוסיף לכרטיס או לעדכן אותו לא רלוונטי לא רלוונטי

מחזירה

‫{int} מזהה המשימה החדשה או המעודכנת.

add_tag

add_tag(tag, case_id, alert_identifier)

הוספת תג חדש לבקשת תמיכה ספציפית.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
תג {string} התג להוספה לא רלוונטי לא רלוונטי
case_id {string} מזהה הפנייה 234 לא רלוונטי
alert_identifier {string} מזהה התראה ad6879f1-b72d-419f-990c-011a2526b16d לא רלוונטי

any_entity_in_custom_list

any_entity_in_custom_list(custom_list_items)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
custom_list_items {[CustomList]} רשימה של פריטים ברשימה מותאמת אישית שצריך לבדוק אם הם ישויות לא רלוונטי לא רלוונטי

מחזירה

‫{boolean} True אם נמצאה ישות, False אחרת.

ערך התוצאה

נכון או לא נכון

assign_case

assign_case(user, case_id, alert_identifier)

הפונקציה הזו מקצה את הפנייה הנוכחית למשתמש.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
משתמש {string} משתמש/תפקיד אדמין, @Tier1 לא רלוונטי
case_id {string} מזהה של כרטיסייה להקצאת משתמש 234 לא רלוונטי
alert_identifier {string} מזהה ההתראה להקצאת משתמש ad6879f1-b72d-419f-990c-011a2526b16d הערך הזה מאוחזר במהלך זמן הריצה של הפעולה

מחזירה

NoneType

התנהגות התוצאה

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

ערך התוצאה

ללא

attach_workflow_to_case

attach_workflow_to_case(workflow_name, cyber_case_id, indicator_identifier)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
workflow_name {string} שם תהליך העבודה לא רלוונטי לא רלוונטי
cyber_case_id {string} מזהה הפנייה 234 לא רלוונטי
indicator_identifier {string} מזהה התראה ad6879f1-b72d-419f-990c-011a2526b16d לא רלוונטי

מחזירה

{string} קוד הסטטוס של פעולת השרת

דוגמה

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
alert_identifier = "ad6879f1-b72d-419f-990c-011a2526b16d"
case_id = "234"
workflow_name = "Workflow 234"
siemplify.attach_workflow_to_case(workflow_name=workflow_name, cyber_case_id=case_id, indicator_identifier=alert_identifier)

התנהגות התוצאה

תהליך העבודה מספר 234 יצורף לפנייה מספר 234.

ערך התוצאה

ללא

batch_update_case_id_matches

batch_update_case_id_matches(case_id_matches)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
case_id_matches {list} רשימה של אובייקטים מסוג SyncCaseIdMatch

מחזירה

‫{list} רשימה של מספרי בקשות תמיכה שעודכנו בהצלחה.

change_case_priority

change_case_priority(priority, case_id, alert_identifier)

שינוי העדיפות של בקשת התמיכה.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
עדיפות {int} העדיפות של הבקשה שרוצים לשנות 40/60/80/100 מיפוי העדיפות: {"Low": 40, "Medium": 60, "High": 80, "Critical": 100}
case_id {string} מזהה הפנייה 234 לא רלוונטי
alert_identifier {string} מזהה התראה ad6879f1-b72d-419f-990c-011a2526b16d לא רלוונטי

מחזירה

NoneType

דוגמה

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
priority = 40
alert_identifier = "ad6879f1-b72d-419f-990c-011a2526b16d"
case_id = "234"
siemplify.change_case_priority(priority=priority, case_id=case_id, alert_identifier=alert_identifier)

התנהגות התוצאה

העדיפות של בקשת התמיכה מספר 234 משתנה ל-40, שמוגדרת כנמוכה.

ערך התוצאה

ללא

change_case_stage

change_case_stage(stage, case_id, alert_identifier)

שינוי שלב הטיפול בבקשה.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
לאחסן נתונים במחסן ביניים (Stage) {string} השלב הנוכחי של בקשת התמיכה. אירוע לא רלוונטי
case_id {string} מזהה הפנייה לא רלוונטי לא רלוונטי
alert_identifier {string} מזהה התראה ad6879f1-b72d-419f-990c-011a2526b16d לא רלוונטי

check_marketplace_status

check_marketplace_status()

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

פרמטרים

לא רלוונטי

מחזירה

ללא

close_alert

close_alert(root_cause, comment, reason, case_id, alert_id)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
root_cause {string} סגירת בקשת התמיכה בנושא שורש הבעיה לא רלוונטי לא רלוונטי
תגובה {string} תגובה לא רלוונטי לא רלוונטי
reason {ApiSyncAlertCloseReasonEnum} לא רלוונטי לא רלוונטי מידע נוסף זמין במאמר SiemplifyDataModel.ApiSyncAlertCloseReasonEnum
case_id {string} מזהה בקשת התמיכה שההתראה שייכת אליה 234 לא רלוונטי
alert_id {string} מזהה ההתראה שרוצים לסגור ad6879f1-b72d-419f-990c-011a2526b16d לא רלוונטי

מחזירה

{dict} תוצאה של פעולת שרת

close_case

close_case(root_cause, comment, reason, case_id, alert_identifier)

סגירת בקשת תמיכה.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
root_cause {string} שורש הבעיה שגרם לסגירת הפנייה לא רלוונטי לא רלוונטי
תגובה {string} תגובה לא רלוונטי לא רלוונטי
reason {ApiSyncAlertCloseReasonEnum} הסיבה לסגירת בקשת התמיכה מידע נוסף זמין במאמר SiemplifyDataModel.ApiSyncAlertCloseReasonEnum
case_id {string} מזהה הפנייה 234 לא רלוונטי
alert_id {string} מזהה התראה ad6879f1-b72d-419f-990c-011a2526b16d לא רלוונטי

create_case

create_case(case_info)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
case_info {CaseInfo} אובייקט של פרטי פנייה לא רלוונטי ראו SiemplifyConnectorsDataModel.CaseInfo

מחזירה

NoneType

התנהגות התוצאה

הפנייה עם נתוני הפנייה שסופקו נוצרת.

ערך התוצאה

ללא

create_case_insight_internal

create_case_insight_internal(case_id, alert_identifier, triggered_by, title, content, entity_identifier, severity, insight_type, additional_data=None, additional_data_type=None, additional_data_title=None, original_requesting_user=None, entity_type=None)

מוסיפים תובנה.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
case_id {string} מזהה הפנייה 234 לא רלוונטי
alert_identifier {string} מזהה התראה ad6879f1-b72d-419f-990c-011a2526b16d לא רלוונטי
triggered_by {string} שם השילוב לא רלוונטי לא רלוונטי
כותרת {string} שם התובנה לא רלוונטי לא רלוונטי
תוכן {string} הודעת תובנה לא רלוונטי לא רלוונטי
entity_identifier {string} מזהה ישות לא רלוונטי לא רלוונטי
severity {int} מזהה רמת החומרה ‫0 = מידע,
‫1 = אזהרה,
‫2 = שגיאה		 לא רלוונטי
insight_type {int} סוג התובנה ‫0 = כללי,
‫1 = ישות		 לא רלוונטי
additional_data לא רלוונטי לא רלוונטי לא רלוונטי לא רלוונטי
additional_data_type לא רלוונטי לא רלוונטי לא רלוונטי לא רלוונטי
additional_data_title לא רלוונטי לא רלוונטי לא רלוונטי לא רלוונטי
original_requesting_user לא רלוונטי לא רלוונטי לא רלוונטי לא רלוונטי
entity_type {string} סוג ישות "ADDRESS" לא רלוונטי

מחזירה

‫{boolean} True אם הפעולה הצליחה.

create_connector_package

create_connector_package(connector_package)

יוצרים חבילת מחבר במערכת.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
connector_package {string} חבילת המחבר כ-JSON לא רלוונטי לא רלוונטי

dismiss_alert

‫
dismiss_alert(alert_group_identifier, should_close_case_if_all_alerts_were_dismissed, case_id)

מקש End

end(message, result_value, execution_state=0)

מסיימים את הסקריפט.
לא מבוצע קוד אחר אחרי הפונקציה end().
ערך התוצאה הסופית נכתב ב-stdout.
הפונקציה end לא נדרשת לעבודות מתוזמנות.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
הודעה {string} הודעת הפלט שתוצג ללקוח פעולה הושלמה לא רלוונטי
result_value {int/string/dict} הערך שמוחזר לא רלוונטי לא רלוונטי
execution_state {int} אינדיקטור למצב של הפעולה הנוכחית. משמש בעיקר בפעולות אסינכרוניות כדי לציין אם הפעולה הושלמה או לא. ‫0 (EXECUTION_STATE_COMPLETED), ‏
‫1 (EXECUTION_STATE_INPROGRESS), ‏
‫2 (EXECUTION_STATE_FAILED), ‏
‫3 (EXECUTION_STATE_TIMEDOUT)		 ברירת המחדל היא 0.

מחזירה

החזרת נתוני התוצאה לתהליך המארח.

end_script

end_script()

escalate_case

escalate_case(comment, case_id, alert_identifier)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
תגובה {string} העברת התגובה לטיפול ברמה גבוהה יותר לא רלוונטי לא רלוונטי
case_id {string} מזהה הפנייה 234 לא רלוונטי
alert_identifier {string} מזהה התראה ad6879f1-b72d-419f-990c-011a2526b16d לא רלוונטי

extract_configuration_param

extract_configuration_param(provider_name, param_name, default_value=None, input_type=<class 'str'>, is_mandatory=False, print_value=False)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
provider_name {string} שם השילוב לא רלוונטי לא רלוונטי
param_name {string} שם הפרמטר לא רלוונטי לא רלוונטי
default_value {any} אם הפרמטר לא מועבר, המערכת תשתמש בערך הזה כברירת מחדל לא רלוונטי אין ברירת מחדל (אופציונלי)
input_type {obj} המרת הפרמטר לסוג אחר לא רלוונטי לדוגמה, int.
str כברירת מחדל (אופציונלי)
is_mandatory {bool} העלאת חריגה אם הפרמטר ריק לא רלוונטי ‫False כברירת מחדל (אופציונלי)
print_value {bool} הדפסת הערך ביומן לא רלוונטי ‫False כברירת מחדל (אופציונלי)

מחזירה

ערך הפרמטר (מחרוזת כברירת מחדל), אלא אם מצוין input_type.

‫static generate_serialized_object

generate_serialized_object(object_filter)

get_agent_by_id

get_agent_by_id(agent_id)

אחזור פרטי הסוכן לפי מזהה.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
agent_id {str} המזהה של הנציג לא רלוונטי לא רלוונטי

מחזירה

‫{dict} פרטי בעל האפליקציה

get_alerts_ticket_ids_from_cases_closed_since_timestamp

get_alerts_ticket_ids_from_cases_closed_since_timestamp(timestamp_unix_ms, rule_generator)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
timestamp_unix_ms {long} חותמת הזמן 1550409785000L לא רלוונטי
rule_generator {string} לא רלוונטי 'כלי לזיהוי הודעות פישינג באימייל' לא רלוונטי

מחזירה

{list} התראות

get_attachment

get_attachment(attachment_id)

קבלת נתוני קובץ מצורף לפי מזהה.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
attachment_id {string} מזהה הקובץ המצורף לא רלוונטי לא רלוונטי

מחזירה

נתוני קובץ מצורף {BytesIO}

get_attachments

get_attachments(case_id)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
case_id {string} מזהה הפנייה 234 לא רלוונטי

מחזירה

‫{dict} קבצים מצורפים

ערך התוצאה

[{"is_favorite": False, "description": "", "type": ".txt", "id": 1, "name": "test.py"}]

_get_case_by_id

_get_case_by_id(case_id)

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

הפונקציה מקיימת אינטראקציה עם נקודת הקצה הבאה: external/v1/sdk/CaseFullDetails

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
case_id {[string]} מספר פנייה לא רלוונטי לא רלוונטי

מחזירה

נתוני פנייה {dict}.

get_case_closure_details

get_case_closure_details(case_id_list)

קבלת פרטים על סגירת בקשת תמיכה.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
case_id_list {[string]} רשימת מספרי פניות לא רלוונטי לא רלוונטי

מחזירה

‫{[dict]} רשימה של מילון שמכיל פרטים על סגירת הפנייה.

ערך התוצאה

[{'case_closed_action_type': 1, 'reason': NotMalicious', 'root_cause': 'Other'}]

הערכים האפשריים של הפרמטר case_closed_action_type הם:

  • ‫0 = אוטומטי
  • ‫1 = ידני

get_case_comments

get_case_comments(case_id)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
case_id {string} מזהה הפנייה 234 לא רלוונטי

מחזירה

רשימה

דוגמה

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
siemplify.get_case_comments(case_id)

התנהגות התוצאה

כל התגובות שמשויכות לפנייה יאוחזרו.

ערך התוצאה

[
    {
             u 'comment': u 'Test',
             u 'case_id': 10085,
             u 'is_favorite': False,
             u 'alert_identifier': None,
             u 'creator_user_id': u 'Admin',
             u 'type': 5,
             u 'id': 1,
             u 'modification_time_unix_time_in_ms': 1563272078332L
      }, {
             u 'comment': u 'jhfksdh',
             u 'case_id': 10085,
             u 'is_favorite': False,
             u 'alert_identifier': None,
             u 'creator_user_id': u 'Admin',
             u 'type': 5,
             u 'id': 2,
             u 'modification_time_unix_time_in_ms': 1563272079941L

       }, {
              u 'comment': u 'kjfhsdm',
              u 'case_id': 10085,
              u 'is_favorite': False,
              u 'alert_identifier': None,
              u 'creator_user_id': u 'Admin',
              u 'type': 5,
              u 'id': 3,
               u 'modification_time_unix_time_in_ms': 1563272080598L
       }
 ]

get_case_tasks

get_case_tasks(case_id)

אחזור של כל המשימות לפי מזהה בקשת התמיכה.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
case_id {int/str} מספר פנייה 234 הפונקציה יכולה לקבל int או str

מחזירה

‫{[Task]} רשימת אובייקטים של משימות ששייכים לתיק.
מידע נוסף זמין במאמר SiemplifyDataModel.Task.

get_cases_by_filter

get_cases_by_filter(environments=None, analysts=None, statuses=None, case_names=None, tags=None, priorities=None, stages=None, case_types=None, products=None, networks=None, ticked_ids_free_search='', case_ids_free_search='', wall_data_free_search='', entities_free_search='', start_time_unix_time_in_ms=-1, end_time_unix_time_in_ms=-1)

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

*caseFilterValue* object - { 'Title':'Merged Case', 'Value': 'Merged', 'Title':'Involved Suspicious Entity', 'Value': 'InvolvedSuspiciousEntity', 'Title':'Manual', 'Value': 'Manual', 'Title':'Simulated Alerts', 'Value': 'Simulated',}

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
environments {[string]} רשימה של שמות סביבות (environment) לא רלוונטי אם לא מציינים סביבות, נעשה שימוש ב-None (אופציונלי)
מנתחי נתונים {[string]} רשימה של שמות אנליסטים (משתמש/תפקיד שהוקצה לטיפול בפנייה), לא רלוונטי אם לא מציינים אנליסט, נעשה שימוש ב-None (אופציונלי)
סטטוסים {[int]} רשימת סטטוסים לסינון לא רלוונטי מידע נוסף זמין במאמר בנושא ApiSyncCaseStatusEnum.
אם לא מצוין סטטוס, נעשה שימוש ב-None (אופציונלי)
case_names {[string]} רשימת שמות בקשות התמיכה לא רלוונטי אם לא מציינים case_names, המערכת משתמשת ב-None (אופציונלי)
תגים {[string]} רשימה של תגי בקשות תמיכה לא רלוונטי אם לא מציינים תגים, המערכת משתמשת בערך None (אופציונלי)
עדיפויות {[int]} רשימת העדיפויות ראו ApiSyncAlertPriorityEnum.
אם לא צוינו עדיפויות, נעשה שימוש בערך None (אופציונלי)
שלבים {list} רשימת שלבים (אובייקט caseFilterValue) לא רלוונטי אם לא מציינים שלבים, נעשה שימוש ב-None (אופציונלי)
case_types {list} רשימה של סוגי אובייקטים (אובייקט caseFilterValue) לא רלוונטי

הערכים התקינים של case_types הם:

0 = Merged
1 = Important
2 = InvolvedSuspiciousEntity
3 = Manual
4 = Simulated

אם לא מציינים case_types, המערכת משתמשת ב-None (אופציונלי)
מוצרים {list} רשימת מוצרים (אובייקט caseFilterValue) לא רלוונטי אם לא מציינים מוצרים, המערכת משתמשת בערך None (אופציונלי)
רשתות {list} רשימת רשתות (אובייקט caseFilterValue) לא רלוונטי אם לא צוינו רשתות, נעשה שימוש ב-None (אופציונלי)
ticked_ids_free_search {string} מזהה הכרטיס לא רלוונטי אם לא מציינים ערך, ברירת המחדל היא '' (אופציונלי)
case_ids_free_search {string} מזהה הפנייה לא רלוונטי אם לא מציינים ערך, ברירת המחדל היא '' (אופציונלי)
wall_data_free_search {string} מחרוזת לחיפוש לא רלוונטי אם לא מציינים ערך, ברירת המחדל היא '' (אופציונלי)
entities_free_search {string} מזהה ישות לא רלוונטי אם לא מציינים ערך, ברירת המחדל היא '' (אופציונלי)
start_time_unix_time_in_ms {long} לא רלוונטי לא רלוונטי ברירת מחדל -1
(אופציונלי)
end_time_unix_time_in_ms {long} לא רלוונטי לא רלוונטי ברירת מחדל -1
(אופציונלי)

מחזירה

Case_ids ''

get_cases_by_ticket_id

get_cases_by_ticket_id(ticket_id)

קבלת פנייה לפי מזהה כרטיס.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
ticket_id {string} מזהה הכרטיס לא רלוונטי לא רלוונטי

מחזירה

‫{[int]} רשימה של מספרי פניות.

get_cases_ids_by_filter

get_cases_ids_by_filter(status, start_time_from_unix_time_in_ms=None, start_time_to_unix_time_in_ms=None, close_time_from_unix_time_in_ms=None, close_time_to_unix_time_in_ms=None, update_time_from_unix_time_in_ms=None, update_time_to_unix_time_in_ms=None, operator=None, sort_by='START_TIME', sort_order='DESC', max_results=1000)

קבלת מספרי פניות לפי מסנן.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
סטטוס {str} סטטוס בקשת התמיכה לאחזור ‫'OPEN',‏ 'CLOSE',‏ 'BOTH' לא רלוונטי
start_time_from_unix_time_in_ms {int} טווח התחלה של שעת ההתחלה של הטיפול בפנייה, כולל לא רלוונטי ברירת המחדל היא 30 ימים לפני (אופציונלי)
start_time_to_unix_time_in_ms {int} שעת ההתחלה של המקרה, כולל לא רלוונטי ברירת המחדל היא השעה הנוכחית (אופציונלי)
close_time_from_unix_time_in_ms {int} תאריך ההתחלה של טווח הזמן לסגירת הפנייה, כולל לא רלוונטי ברירת המחדל היא 30 ימים לפני (אופציונלי)
close_time_to_unix_time_in_ms {int} טווח הזמן לסגירת בקשת התמיכה, כולל. לא רלוונטי ברירת המחדל היא השעה הנוכחית (אופציונלי)
update_time_from_unix_time_in_ms {int} התאריך והשעה שבהם התחיל טווח הזמן של שינוי הכרטיס, כולל לא רלוונטי ברירת המחדל היא שעת ההתחלה (אופציונלי)
update_time_to_unix_time_in_ms {int} טווח הזמן של השינוי האחרון בתיק, כולל לא רלוונטי ברירת המחדל היא השעה הנוכחית (אופציונלי)
אופרטור {str} אופרטור למסנני זמן או, וגם אופציונלי
sort_by {str} מיון התוצאות לפי זמן START_TIME, ‏ UPDATE_TIME, ‏ CLOSE_TIME אופציונלי
sort_order {str} סדר מיון ASC, ‏ DESC ברירת המחדל היא סדר יורד (אופציונלי)
max_results {int} המספר המקסימלי של תוצאות להחזרה לא רלוונטי ערך ברירת המחדל הוא 1,000, הערך המקסימלי הוא 10,000 (אופציונלי)

get_configuration

get_configuration(provider, environment, integration_instance)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
ספק {string} שם השילוב ‫"VirusTotal" לא רלוונטי
environment {string} הגדרה לסביבה ספציפית או ל 'הכול' לא רלוונטי לא רלוונטי
integration_instance {string} מזהה של מופע השילוב לא רלוונטי לא רלוונטי

מחזירה

פרטי ההגדרות האישיות של {dict}.

get_configuration_by_provider

get_configuration_by_provider(identifier)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
ספק {string} שם השילוב ‫"VirusTotal" לא רלוונטי

מחזירה

פרטי ההגדרות האישיות של {dict}

get_existing_custom_list_categories

get_existing_custom_list_categories()

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

פרמטרים

לא רלוונטי

מחזירה

‫{[unicode]} רשימה של סוג Unicode עם קטגוריות קיימות.

דוגמה

from SiemplifyAction import SiemplifyAction siemplify = SiemplifyAction() result = siemplify.get_existing_custom_list_categories()

התנהגות התוצאה

מוחזרת רשימה של כל הרשימות הקיימות בהתאמה אישית.

ערך התוצאה

‪["DenyListed IPs", "AllowListed HOSTs"]

get_external_configuration

get_external_configuration(config_provider, config_name)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
config_provider {string} לא רלוונטי לא רלוונטי לא רלוונטי
config_name {string} לא רלוונטי לא רלוונטי לא רלוונטי

get_integration_version

get_integration_version(integration_identifier)

קבלת גרסת שילוב.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
integration_identifier {string} מזהה השילוב לא רלוונטי לא רלוונטי

מחזירה

גרסת השילוב {float}

get_publisher_by_id

get_publisher_by_id(publisher_id)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
publisher_id {string} המזהה של בעל האתר לא רלוונטי לא רלוונטי

מחזירה

‫{dict} פרטי בעל האפליקציה

get_remote_connector_keys_map

get_remote_connector_keys_map(publisher_id)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
publisher_id {string} המזהה של בעל האתר לא רלוונטי לא רלוונטי

מחזירה

‫{dict} מיפוי המקשים

get_similar_cases

get_similar_cases(case_id, ports_filter, category_outcome_filter, rule_generator_filter, entity_identifiers_filter, start_time_unix_ms, end_time_unix_ms)

קבלת בקשות תמיכה דומות.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
case_id {string} מזהה הפנייה 234 לא רלוונטי
ports_filter {boolean} שימוש במסנן יציאות True/False נכון/לא נכון לא רלוונטי
category_outcome_filter {boolean} True/False use category_outcome filter נכון/לא נכון לא רלוונטי
rule_generator_filter {boolean} True/False use rule_generator filter נכון/לא נכון לא רלוונטי
entity_identifiers_filter {boolean} True/False use entity_identifiers filter נכון/לא נכון לא רלוונטי
start_time_unix_ms לא רלוונטי לא רלוונטי לא רלוונטי לא רלוונטי
end_time_unix_ms לא רלוונטי לא רלוונטי לא רלוונטי לא רלוונטי

מחזירה

{dict}

get_sync_alerts

get_sync_alerts(alert_group_ids)

אחזור מידע על התראות שנדרש לסנכרון מערכות.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
alert_group_ids {list} רשימה של מזהי קבוצות התראות לאחזור לא רלוונטי לא רלוונטי

מחזירה

‫{[SyncAlert]} רשימה של אובייקטים מסוג SyncAlert.

get_sync_cases

get_sync_cases(case_ids)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
case_ids {list} רשימה של מספרי פניות לאחזור לא רלוונטי לא רלוונטי

מחזירה

‫{[SyncCase]} רשימה של SyncCase אובייקטים.

get_system_info

get_system_info(start_time_unixtime_ms)

get_system_version

get_system_version()

קבלת הגרסה הנוכחית של Google Security Operations SOAR.

פרמטרים

לא רלוונטי

מחזירה

‫{string} הגרסה הנוכחית של Google Security Operations SOAR

get_temp_folder_path

get_temp_folder_path()

מחזירה את הנתיב לתיקיית הטמפ.

פרמטרים

לא רלוונטי

מחזירה

‫{string} נתיב לתיקייה זמנית

get_ticket_ids_for_alerts_dismissed_since_timestamp

‫
get_ticket_ids_for_alerts_dismissed_since_timestamp(timestamp_unix_ms)

get_updated_sync_alerts_metadata

get_updated_sync_alerts_metadata(start_timestamp_unix_ms, count, allowed_environments=None, vendor=None)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
start_timestamp_unix_ms {long} חיפוש התראות מעודכנות החל מ
start_timestamp_unix_ms או ממועד מאוחר יותר		 לא רלוונטי אם הערך של end_timestamp_unix_ms הוא None,
שעת הסיום היא השעה שבה נשלחה הבקשה.
ספירה {int} מספר מקסימלי של מזהי קבוצות של התראות לאחזור לא רלוונטי לא רלוונטי
allowed_environments {[string]} סביבות לחיפוש לא רלוונטי אם הערך של allowed_environments הוא None,
החיפוש יתבצע בכל הסביבות
ספק {string} סינון התראות לפי ספק לא רלוונטי לא רלוונטי

מחזירה

‫{[SyncAlertMetadata]} רשימה של אובייקטים מסוג SyncAlertMetadata, ממוינים לפי SyncAlertMetadata.tracking_time.

get_updated_sync_cases_metadata

get_updated_sync_cases_metadata(start_timestamp_unix_ms, count, allowed_environments=None, vendor=None)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
start_timestamp_unix_ms {long} חיפוש בקשות תמיכה מעודכנות החל מ
start_timestamp_unix_ms או מאוחר יותר		 לא רלוונטי אם end_timestamp_unix_ms הוא None,
זמן הסיום יהיה הזמן של הבקשה
ספירה {int} מספר מקסימלי של מספרי פניות לאחזור לא רלוונטי לא רלוונטי
allowed_environments {[string]} סביבות לחיפוש לא רלוונטי אם הערך של allowed_environments הוא None,
החיפוש יתבצע בכל הסביבות
ספק {string} החזרת מקרים רק עם התראות שמקורן ב-vendor לא רלוונטי לא רלוונטי

מחזירה

{[SyncCaseMetadata]} רשימה של SyncCaseMetadata אובייקטים, ממוינת לפי SyncCaseMetadata.tracking_time.

init_proxy_settings

init_proxy_settings()

פרמטרים

לא רלוונטי

is_existing_category

is_existing_category(category)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
קטגוריה {string} הקטגוריה שרוצים לבדוק אם היא קיימת ‫"DenyListed IPs" ‏(כתובות IP ברשימת דחייה) לא רלוונטי

מחזירה

‫{bool} הערך True אם הקטגוריה קיימת, אחרת הערך False.

דוגמה 1

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
result = siemplify.is_existing_category("WhiteListed HOSTs")

דוגמה 2

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
result = siemplify.is_existing_category("SpecialHosts")

התנהגות התוצאה

התוצאה בקוד לדוגמה 1 היא True, והתוצאה בקוד לדוגמה 2 היא False.

ערך התוצאה

נכון או לא נכון

mark_case_as_important

mark_case_as_important(case_id, alert_identifier)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
case_id {string} מזהה הפנייה 234 לא רלוונטי
alert_identifier {string} מזהה התראה ad6879f1-b72d-419f-990c-011a2526b16d לא רלוונטי

מחזירה

NoneType

דוגמה

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
alert_identifier = "ad6879f1-b72d-419f-990c-011a2526b16d"
case_id = "234"
siemplify.mark_case_as_important(case_id=case_id, alert_identifier=alert_identifier)

התנהגות התוצאה

האירוע עם מזהה ההתראה שצוין מסומן כחשוב.

ערך התוצאה

ללא

raise_incident

raise_incident(case_id, alert_identifier)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
case_id {string} מזהה הפנייה 234 לא רלוונטי
alert_identifier {string} מזהה התראה ad6879f1-b72d-419f-990c-011a2526b16d לא רלוונטי

מחזירה

NoneType

דוגמה

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
alert_identifier = "ad6879f1-b72d-419f-990c-011a2526b16d"
case_id = "234"
siemplify.raise_incident(case_id=case_id, alert_identifier=alert_identifier)

התנהגות התוצאה

פנייה מספר 234 תוגדר כאירוע.

ערך התוצאה

ללא

remove_entities_from_custom_list

remove_entities_from_custom_list(custom_list_items)

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
custom_list_items {[CustomList]} רשימה של פריטים ברשימה בהתאמה אישית לא רלוונטי לא רלוונטי

מחזירה

רשימת {[CustomList]} של CustomList אובייקטים שהוסרו.

remove_temp_folder

remove_temp_folder()

מחיקת תיקיית ה-temp ותיקיות המשנה שלה.

פרמטרים

לא רלוונטי

תוצאה של property

send_system_notification

send_system_notification(message, message_id='SDK_CUSTOM_NOTIFICATION')

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

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
הודעה {string} הודעה לידיעה לא רלוונטי לא רלוונטי
message_id {string} מזהה הודעת ההתראה לא רלוונטי לא רלוונטי

send_system_notification_message

send_system_notification_message(message, message_id)

דוגמה

התנהגות התוצאה

ערך התוצאה

set_alert_sla

set_alert_sla(period_time, period_type, critical_period_time, critical_period_type, case_id, alert_identifier)

מגדירים את הסכם רמת השירות של alert_identifier שצוין מתוך case_id. ה-SLA שמוגדר באמצעות ה-API הזה צריך להיות גבוה יותר מכל סוגי ה-SLA האחרים של ההתראות.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
period_time {int/str} מייצג את תקופת ה-SLA הכוללת לא רלוונטי period_time > 0
period_type {str} יחידות הזמן של period_time,
מיוצגות על ידי ApiPeriodTypeEnum		 לא רלוונטי לא רלוונטי
critical_period_time {int/str} מייצג את תקופת ה-SLA הקריטית לא רלוונטי ‫critical_period_time >= 0
התקופה הקריטית (אחרי שינוי קנה המידה עם יחידות הזמן שלה)
צריכה להיות קצרה מהתקופה הכוללת
critical_period_type {str} יחידות הזמן של critical_period_time,
מיוצגות על ידי ApiPeriodTypeEnum		 לא רלוונטי לא רלוונטי
case_id {long} מזהה הפנייה לא רלוונטי לא רלוונטי
alert_identifier {str} מזהה התראה לא רלוונטי לא רלוונטי

set_case_sla

set_case_sla(period_time, period_type, critical_period_time, critical_period_type, case_id)

מגדיר את ה-SLA של case_id. ה-SLA שמוגדר באמצעות ה-API הזה צריך להיות גבוה יותר מכל סוגי ה-SLA האחרים של בקשות התמיכה.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
period_time {int/string} מייצג את תקופת ה-SLA הכוללת לא רלוונטי period_time > 0
period_type {string} יחידות הזמן של period_time,
מיוצגות על ידי ApiPeriodTypeEnum		 לא רלוונטי לא רלוונטי
critical_period_time {int/string} מייצג את תקופת ה-SLA הקריטית לא רלוונטי ‫critical_period_time >= 0
התקופה הקריטית (אחרי שינוי קנה המידה עם יחידות הזמן שלה)
צריכה להיות קצרה מהתקופה הכוללת
critical_period_type {string} יחידות הזמן של critical_period_time,
מיוצגות על ידי ApiPeriodTypeEnum		 לא רלוונטי לא רלוונטי
case_id {long} מזהה הפנייה 234 לא רלוונטי

update_alerts_additional_data

update_alerts_additional_data(case_id, alerts_additional_data)

עדכון נתונים נוספים בהתראות.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
case_id {string} מזהה הפנייה 234 לא רלוונטי
alerts_additional_data {dict} נתונים נוספים של ההתראה לא רלוונטי לא רלוונטי

update_entities

update_entities(updated_entities)

הפונקציה הזו מעדכנת ישויות.

פרמטרים

שם הפרמטר סוג הפרמטר הגדרה ערכים אפשריים תגובות
updated_entities {[{string:string}]} לא רלוונטי לא רלוונטי לא רלוונטי

מחזירה

NoneType

התנהגות התוצאה

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

ערך התוצאה

ללא