מודול soar_ops

TIPCommon.soar_ops.create_slo_message

TIPCommon.soar_ops.create_slo_message(slo: int, interval_days: Iterable[int], existing_comments: Iterable[str])

מקבל הודעות אזהרה לגבי SLO על סמך מרווחי זמן ותגובות קיימות.

בפרמטר interval_days=[0, 1, 7, 14], הפונקציה שולחת הודעה עם אזהרה על הפרה של יעד ה-SLO לפי התזמון הבא:

  • ‫7-14 ימים לפני תאריך התפוגה.
  • ‫1-7 ימים עד לתאריך התפוגה.
  • מתי הייתה הפרה של ה-SLO.

אם תגובה כבר נשלחה במרווח הזמן הנוכחי שבו חל הפרת המדיניות, לא מוחזרת תגובה חדשה (מוחזר None).

פרמטרים
slo int

תאריך ההפרה של ה-SLO במיקרו-שניות של Unix (לדוגמה, 1_673_774_674_567)
interval_days Iterable[int]

אובייקט שאפשר לחזור עליו, שמכיל את מספר הימים שחלפו מאז שליחת אזהרות על הפרת תנאים (לדוגמה, [0, 1, 3, 7, 14])

existing_comments Iterable[int]

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

העלאות

‫ValueError – אם אחד ממרווחי הזמן הוא שלילי.

מחזירה

התגובה מוחזרת אם היא רלוונטית. אחרת, מוחזר הערך None.

TIPCommon.soar_ops.get_clean_comment_body

TIPCommon.soar_ops.get_clean_comment_body(comment: str | CaseComment, prefix: str)

מסיר קידומת ממחרוזת התגובה או מאובייקט התגובה.

פרמטרים
comment str | CaseComment

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

הקידומת שרוצים להסיר.

העלאות

‫TypeError– אם סוג התגובה הוא לא str או CaseComment.

מחזירה

התגובה בלי הקידומת.

סוג הערך שמוחזר

str

TIPCommon.soar_ops.get_file

TIPCommon.soar_ops.get_file(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, identifier: str)→ bytes | None

הפונקציה מחזירה את תוכן הקובץ בבייטים.

פרמטרים

פרמטרים
chronicle_soar ChronicleSOAR

אובייקט Google SecOps SDK.
identifier str

מזהה שם הקובץ יחד עם הנתיב המלא.

מחזירה

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

סוג הערך שמוחזר

bytes | None

TIPCommon.soar_ops.get_secops_mode

TIPCommon.soar_ops.get_secops_mode()→ str | None

מחזירה את משתנה הסביבה SECOPS_MODE.

מחזירה

משתנה הסביבה SECOPS_MODE.

סוג הערך שמוחזר

str | None

TIPCommon.soar_ops.get_soar_case_comments

TIPCommon.soar_ops.get_soar_case_comments(chronicle_soar: SiemplifyAction | SiemplifyJob, case_id: str | int)

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

פרמטרים
chronicle_soar SiemplifyAction | SiemplifyJob

אובייקט ה-SDK.
case_id str | int

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

מחזירה

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

סוג הערך שמוחזר

list[base.action.CaseComment]

TIPCommon.soar_ops.get_user_by_id

TIPCommon.soar_ops.get_user_by_id(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, user_id: str)→ UserProfileCard | None

מקבלים אובייקט Python של מודל נתונים UserProfileCard ממזהה משתמש.

פרמטרים

פרמטרים
chronicle_soar ChronicleSOAR

אובייקט Google SecOps SDK.
user_id str

מזהה המשתמש. לדוגמה, f6dc053c-58bb-4da5-95bb-739be7d297a2.

מחזירה

אובייקט מודל הנתונים UserProfileCard אם user_id קיים בפלטפורמה, אחרת מוחזר None.

המאפיין raw_data של האובייקט UserProfileCard מכיל את פרטי המשתמש בפורמט JSON.

דוגמה לתגובת JSON ב-user.raw_data:

בדוגמה הבאה מוצג מבנה תגובת ה-JSON של מאפיין raw_data:

{
    "name": "projects/project/locations/location/instances/instance/legacySoarUsers/1",
    "id": 1,
    "displayName": "84b44ee6-d372-43c9-8abe-ae14b8421492",
    "permissionGroups": [
        {
            "id": 1,
            "name": "Admins"
        }
    ],
    "lastLoginTime": 1769503546327,
    "userFullName": "Test Admin",
    "socRoles": [1],
    "email": "admin@example.com",
    "userType": "Internal",
    "environmentsJson": "[\"*\"]",
    "accountState": "Active",
    "providerName": "Internal",
    "allowedPlatforms": [0],
    "loginIdentifier": "admin@example.com",
    "firstName": "Test",
    "lastName": "Admin"
}

סוג הערך שמוחזר

UserProfileCard | None

TIPCommon.soar_ops.get_users_profile_cards_with_pagination

TIPCommon.soar_ops.get_users_profile_cards_with_pagination(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, search_term: str = '', page_size: int = 20, filter_by_role: bool = False, filter_disabled_users: bool = False, filter_support_users: bool = False, fetch_only_support_users: bool = False, filter_permission_types: list[int] | None = None)→ list[UserProfileCard]

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

פרמטרים

פרמטרים
chronicle_soar ChronicleSOAR

אובייקט Google SecOps SDK.
search_term str

מונחי החיפוש.

ברירת המחדל היא ''.
page_size int

מספר המשתמשים שיוחזרו.

ברירת המחדל היא 20.
filter_by_role bool

הגדרת סינון לפי תפקיד.

ברירת המחדל היא False.
filter_disabled_users bool

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

ברירת המחדל היא False.
filter_support_users bool

קובעים אם לסנן משתמשים שזקוקים לתמיכה.

ברירת המחדל היא False.
fetch_only_support_users bool

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

ברירת המחדל היא False.
filter_permission_types list[int] | None

רשימה של סוגי הרשאות סינון (לדוגמה, 0).

ברירת המחדל היא None.

מחזירה

רשימה של כל המשתמשים.

סוג הערך שמוחזר

list[UserProfileCard]

TIPCommon.soar_ops.is_slo_comment

TIPCommon.soar_ops.is_slo_comment(comment: str)

בודקת אם התגובה היא תגובת אזהרה לגבי SLO.

הערה על SLO היא אזהרה על SLO ('ה-SLO יופר תוך {int} ימים') או הודעה על הפרת SLO ('ה-SLO הופר').

פרמטרים
comment str

התגובה לבדיקה.

מחזירה

‫True אם התגובה היא תגובה על יעד רמת שירות. אחרת, מוחזר הערך False.

סוג הערך שמוחזר

bool

TIPCommon.soar_ops.remove_prefix_from_comments

TIPCommon.soar_ops.remove_prefix_from_comments(comments: list[str], prefix: str)

מסירה קידומת (אם יש כזו) מרשימת תגובות.

פרמטרים
comments list[str]

התגובות שרוצים להסיר מהן את הקידומת.
prefix str

הקידומת שרוצים להסיר.

מחזירה

רשימה של כל התגובות אחרי שהוסר מהן הקידומת

סוג הערך שמוחזר

list[str]

TIPCommon.soar_ops.save_file

TIPCommon.soar_ops.save_file(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, path: str, name: str, content: bytes)→ bytes | None

שמירת קובץ ב-bucket Google Cloud או בנתיב מקומי.

פרמטרים

פרמטרים
chronicle_soar ChronicleSOAR

אובייקט Google SecOps SDK.
path str

הנתיב של התיקייה שבה הקבצים אמורים להישמר.
name str

שם הקובץ שרוצים לשמור.
content bytes

תוכן הקובץ בפורמט בייט.

מחזירה

הנתיב לקבצים שהורדתם.

סוג הערך שמוחזר

str | None

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