soar_ops-Modul
TIPCommon.soar_ops.create_slo_message
TIPCommon.soar_ops.create_slo_message(slo: int, interval_days: Iterable[int], existing_comments: Iterable[str])
Ruft SLO-Warnmeldungen basierend auf Zeitintervallen und vorhandenen Kommentaren ab.
Für den Parameter interval_days=[0, 1, 7, 14]
sendet die Funktion eine Nachricht, in der gewarnt wird, dass das SLO gemäß dem nächsten Zeitplan überschritten wird:
- 7–14 Tage vor dem Ablaufdatum
- 1–7 Tage vor dem Ablaufdatum.
- Wann das SLO verletzt wurde.
Wenn im aktuellen Zeitraum, in dem gegen die Nutzungsbedingungen verstoßen wurde, bereits ein Kommentar gesendet wurde, wird kein neuer Kommentar zurückgegeben (None
wird zurückgegeben).
Parameter | |
---|---|
slo |
int Das Datum des SLO-Verstoßes in Unix-Mikrosekunden (z. B. 1_673_774_674_567) |
interval_days |
Iterable[int] Ein Iterable mit der Anzahl der Tage, ab denen Warnungen zu Zeitüberschreitungen gesendet werden sollen (z. B. [0, 1, 3, 7, 14]) |
existing_comments |
Iterable[int] Die vorhandenen Kommentare, um zu prüfen, ob ein Kommentar bereits gesendet wurde. |
Löst aus
ValueError
: Wenn eines der Zeitintervalle negativ ist.
Gibt Folgendes zurück:
Der Kommentar wird gegebenenfalls zurückgegeben. Andernfalls wird None
zurückgegeben.
TIPCommon.soar_ops.get_clean_comment_body
TIPCommon.soar_ops.get_clean_comment_body(comment: str | CaseComment, prefix: str)
Entfernt einen Präfix aus dem Kommentarstring oder Kommentarobjekt.
Parameter | |
---|---|
comment |
str | CaseComment Der Kommentarstring oder das Kommentarobjekt, aus dem das Präfix entfernt werden soll. |
prefix |
str Das zu entfernende Präfix. |
Löst aus
TypeError
: Wenn der Typ des Kommentars weder str
noch CaseComment
ist.
Gibt Folgendes zurück:
Der Kommentar ohne das Präfix.
Rückgabetyp
str
TIPCommon.soar_ops.get_file
TIPCommon.soar_ops.get_file(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, identifier: str)→ bytes | None
Gibt den Dateiinhalt in Byte zurück.
Parameter
Parameter | |
---|---|
chronicle_soar |
ChronicleSOAR Ein Google Security Operations SOAR SDK-Objekt. |
identifier |
str Die Dateinamen-ID zusammen mit dem vollständigen Pfad. |
Gibt Folgendes zurück:
Byte-Daten der angegebenen Kennung.
Rückgabetyp
bytes | None
TIPCommon.soar_ops.get_secops_mode
TIPCommon.soar_ops.get_secops_mode()→ str | None
Gibt die Umgebungsvariable SECOPS_MODE
zurück.
Gibt Folgendes zurück:
Die Umgebungsvariable SECOPS_MODE
.
Rückgabetyp
str | None
TIPCommon.soar_ops.get_soar_case_comments
TIPCommon.soar_ops.get_soar_case_comments(chronicle_soar: SiemplifyAction | SiemplifyJob, case_id: str | int)
Gibt eine Liste von Kommentarobjekten aus einem Fall anhand seiner ID zurück.
Parameter | |
---|---|
chronicle_soar |
SiemplifyAction | SiemplifyJob Das SDK-Objekt. |
case_id |
str | int Die ID des Falls, dessen Kommentare abgerufen werden. |
Gibt Folgendes zurück:
Eine Liste mit Kommentarobjekten.
Rückgabetyp
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
Ruft ein UserProfileCard-Objekt anhand einer Nutzer-ID ab.
Parameter
Parameter | |
---|---|
chronicle_soar |
ChronicleSOAR Ein Google Security Operations SOAR SDK-Objekt. |
user_id |
str Die Nutzer-ID, z.B. |
Gibt Folgendes zurück:
Das Nutzerobjekt, falls es gefunden wird; andernfalls None
.
Rückgabetyp
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]
Ruft alle Nutzerprofilkarten mithilfe der Seitennummerierung ab. Die Seitengröße dient als Limit für die Anzahl der Nutzer in jedem Durchlauf.
Parameter
Parameter | |
---|---|
chronicle_soar |
ChronicleSOAR Ein Google Security Operations SOAR SDK-Objekt. |
search_term |
str Die Suchbegriffe. Die Standardeinstellung ist |
page_size |
int Die Anzahl der zurückzugebenden Nutzer. Die Standardeinstellung ist |
filter_by_role |
bool Legen Sie fest, ob nach Rolle gefiltert werden soll. Die Standardeinstellung ist |
filter_disabled_users |
bool Legen Sie fest, ob deaktivierte Nutzer gefiltert werden sollen. Die Standardeinstellung ist |
filter_support_users |
bool Legen Sie fest, ob Supportnutzer gefiltert werden sollen. Die Standardeinstellung ist |
fetch_only_support_users |
bool Gibt an, ob nur Supportnutzer zurückgegeben werden sollen. Die Standardeinstellung ist |
filter_permission_types |
list[int] | None Eine Liste mit Berechtigungstypen für Filter, z.B. Die Standardeinstellung ist |
Gibt Folgendes zurück:
Eine Liste aller Nutzer.
Rückgabetyp
list[UserProfileCard]
TIPCommon.soar_ops.is_slo_comment
TIPCommon.soar_ops.is_slo_comment(comment: str)
Prüft, ob ein Kommentar eine SLO-Warnung ist.
Ein SLO-Kommentar ist entweder eine SLO-Warnung („SLO will be breached in {int} days“ [SLO wird in {int} Tagen überschritten]) oder eine Meldung über einen Verstoß gegen das SLO („SLO was breached“ [SLO wurde überschritten]).
Parameter | |
---|---|
comment |
str Der zu prüfende Kommentar. |
Gibt Folgendes zurück:
True
, wenn der Kommentar ein SLO-Kommentar ist. Andernfalls wird False
zurückgegeben.
Rückgabetyp
bool
TIPCommon.soar_ops.remove_prefix_from_comments
TIPCommon.soar_ops.remove_prefix_from_comments(comments: list[str], prefix: str)
Entfernt ein Präfix (sofern vorhanden) aus einer Liste von Kommentaren.
Parameter | |
---|---|
comments |
list[str] Die Kommentare, aus denen das Präfix entfernt werden soll. |
prefix |
str Das zu entfernende Präfix. |
Gibt Folgendes zurück:
Eine Liste aller Kommentare, nachdem das Präfix daraus entfernt wurde
Rückgabetyp
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
Speichert eine Datei in einem Google Cloud Bucket oder einem lokalen Pfad.
Parameter
Parameter | |
---|---|
chronicle_soar |
ChronicleSOAR Ein Google Security Operations SOAR SDK-Objekt. |
path |
str Der Pfad des Ordners, in dem Dateien gespeichert werden sollen. |
name |
str Der Dateiname, unter dem die Datei gespeichert werden soll. |
content |
bytes Der Dateiinhalt im Byteformat. |
Gibt Folgendes zurück:
Der Pfad zu den heruntergeladenen Dateien.
Rückgabetyp
str | None
Benötigen Sie weitere Hilfe? Antworten von Community-Mitgliedern und Google SecOps-Experten erhalten