TIPCommon.rest

TIPCommon.rest.auth.build_credentials_from_sa

TIPCommon.rest.auth.build_credentials_from_sa(user_service_account: MutableMapping[str, Any] | None = None, target_principal: str | None = None, source_credentials: Credentials | None = None, quota_project_id: str | None = None, scopes: list[str] | None = None, verify_ssl: bool | None = True, **service_account_attr: Any)→ Credentials

Erstellt ein Anmeldedatenobjekt aus einem Dienstkonto, einer E-Mail-Adresse für die Identitätsföderation von Arbeitslasten oder Dienstkontoattributen.

Hinweis: Es muss entweder user_service_account, target_principal oder service_account_attr (mit **kwargs) angegeben werden. Andernfalls wird eine EmptyMandatoryValues-Ausnahme ausgelöst.

Parameter

Parameter
user_service_account SingleJson | None

Die JSON-Datei des Nutzerdienstkontos.
target_principal str | None

Die E-Mail-Adresse der Workload Identity.
source_credentials google.auth.Credentials | None

Die Quellanmeldedaten, die zum Abrufen der imitierten Anmeldedaten verwendet wurden.

Wenn None angegeben ist, versucht das System, die Standardanmeldedaten für die Anwendung zu verwenden.
quota_project_id str | None

Die Projekt-ID, die für Kontingent und Abrechnung verwendet wird.
scopes list[str]

Die Google Cloud Anmeldedatenbereiche. Die Standardeinstellung ist ['https://www.googleapis.com/auth/cloud-platform'].
verify_ssl bool

Legen Sie fest, ob das SSL-Zertifikat geprüft werden soll.

Die Standardeinstellung ist True.
service_account_attr dict[str, Any]

Schlüssel/Wert-Paare der entstrukturierten Dienstkontofelder.

Löst aus

EmptyMandatoryValues: Wenn keine E-Mail-Adresse für das Dienstkonto oder die Workload Identity vorhanden ist oder Pflichtfelder für das Dienstkonto fehlen. google.auth.exceptions.RefreshError: Die Anmeldedaten konnten nicht aktualisiert werden.

Gibt Folgendes zurück:

Ein Anmeldedatenobjekt.

Rückgabetyp

service_account.Credentials

TIPCommon.rest.auth.build_credentials_from_sa_attr

TIPCommon.rest.auth.build_credentials_from_sa_attr(account_type: str, project_id: str, private_key_id: str, private_key: str, client_email: str, client_id: str, auth_uri: str, token_uri: str, auth_provider_x509_url: str, client_x509_cert_url: str, scopes: list[str] | None = None, quota_project_id: str | None = None)→ Credentials

Erstellt ein Anmeldedatenobjekt aus Dienstkontoattributen.

Parameter

Parameter
account_type str

Der Dienstkontotyp.
project_id str

Die Projekt-ID des Dienstkontos.
private_key_id str

Die ID des privaten Schlüssels des Dienstkontos.
private_key str

Der private Schlüssel des Dienstkontos.
client_email str

Die Client-E-Mail-Adresse des Dienstkontos.
client_id str

Die Client-ID des Dienstkontos.
auth_uri str

Der Auth-URI des Dienstkontos.
token_uri str

Die Dienstkonto-Token-URI.
auth_provider_x509_url str

Die X509-Zertifikats-URL des Dienstkonto-Authentifizierungsanbieters.
client_x509_cert_url str

Die URL des X509-Clientzertifikats des Dienstkontos.
scopes list[str], optional

Die Google Cloud Anmeldedatenbereiche. Die Standardeinstellung ist ['https://www.googleapis.com/auth/cloud-platform'].
quota_project_id str | None

Die Projekt-ID, die für Kontingent und Abrechnung verwendet wird.

Löst aus

EmptyMandatoryValues: Wenn Pflichtfelder für das Dienstkonto fehlen.

Gibt Folgendes zurück:

Ein Anmeldedatenobjekt.

Rückgabetyp

service_account.Credentials

TIPCommon.rest.auth.generate_jwt_from_credentials

TIPCommon.rest.auth.generate_jwt_from_credentials(credentials: Credentials, verify_ssl: bool = True)→ bytes

Generiert ein JSON-Webtoken für den Zugriff auf Google Cloud API-Ressourcen über REST.

Parameter

Parameter
credentials google.oauth2.credentials.Credentials

Ein google.oauth2.credentials.Credentials-Objekt.
verify_ssl bool

Geben Sie an, ob das Anmeldedaten-Token über SSL aktualisiert werden soll.

Die Standardeinstellung ist True.

Gibt Folgendes zurück:

Ein JWT-Token, das im Autorisierungsheader verwendet werden soll.

Rückgabetyp

bytes

TIPCommon.rest.auth.generate_jwt_from_sa

TIPCommon.rest.auth.generate_jwt_from_sa(service_account, expiry_length=3600, audience=None)

Generiert ein JSON-Webtoken für den Zugriff auf Google Cloud API-Ressourcen über REST.

Parameter
service_account str | dict

Google Cloud -Dienstkonto mit den erforderlichen IAM-Rollen (Identity and Access Management).
expiry_length int

Die Zeit in Sekunden, bis das Token abläuft. Die Standardeinstellung ist 1 Stunde.
audience str

Google Cloud -Bereich. Wenn nicht angegeben, wird https://www.googleapis.com/auth/cloud-platform verwendet.

Gibt Folgendes zurück:

Ein JWT-Token, das im Autorisierungsheader verwendet werden soll.

Rückgabetyp

bytes

TIPCommon.rest.auth.get_adc

TIPCommon.rest.auth.get_adc(scopes: Sequence[str] | None = None, request: Request | None = None, quota_project_id: str | None = None)→ Tuple[Credentials, str | None]

Ruft die Standardanmeldedaten für Anwendungen (Application Default Credentials, ADC) der Laufzeitumgebung ab. Dies ist eine Wrapper-Funktion für google.auth.default.

Parameter

Parameter
scopes Sequence[str] | None

Die Liste der Bereiche für die Anmeldedaten.

Wenn angegeben, werden die Anmeldedaten bei Bedarf automatisch auf den erforderlichen Umfang beschränkt.
request google.auth.transport.Request | None

Ein Objekt, das zum Stellen von HTTP-Anfragen verwendet wird. Damit wird entweder erkannt, ob die Anwendung in Compute Engine ausgeführt wird, oder die zugehörige Projekt-ID für eine Workload Identity-Pool-Ressource (Anmeldedaten für externe Konten) ermittelt.

Wenn nicht angegeben, wird entweder der HTTP-Client der Standardbibliothek für Compute Engine-Anmeldedaten oder ein google.auth.transport.requests.Request-Client für Anmeldedaten für externe Konten verwendet.
quota_project_id str | None

Die Projekt-ID, die für Kontingent und Abrechnung verwendet wird.

Gibt Folgendes zurück:

Die Anmeldedaten und die Projekt-ID der aktuellen Umgebung. Die Projekt-ID kann None sein. Das bedeutet, dass die Projekt-ID nicht aus der Umgebung ermittelt werden konnte.

Rückgabetyp

Tuple[google.auth.credentials.Credentials, str]

Löst aus

google.auth.exceptions.DefaultCredentialsError: Wenn keine Anmeldedaten gefunden wurden oder die gefundenen Anmeldedaten ungültig waren.

TIPCommon.rest.auth.get_auth_request

TIPCommon.rest.auth.get_auth_request(verify_ssl: bool = True)→ Request

Erstellt eine autorisierte HTTP-Anfrage an eine Google Cloud -Ressourcen-API.

Parameter

Parameter
verify_ssl bool, optional

Überprüft das SSL-Zertifikat. Die Standardeinstellung ist True.

Gibt Folgendes zurück:

Ein autorisiertes Anfrageobjekt.

Rückgabetyp

google.auth.transport.requests.Request

TIPCommon.rest.auth.get_impersonated_credentials

TIPCommon.rest.auth.get_impersonated_credentials(target_principal: str, source_credentials: google.auth.Credentials | None = None, target_scopes: Sequence[str] | None = None, delegates: Sequence[str] | None = None, quota_project_id: str | None = None)→ impersonated_credentials.Credentials

Ruft ein kurzlebiges Credentials-Objekt mithilfe der Google Cloud Dienstkonto-Identitätsübernahme ab.

Parameter

Parameter
target_principal str

Das Dienstkonto, dessen Identität übernommen werden soll.
source_credentials google.auth.Credentials | None

Die Quellanmeldedaten, die zum Abrufen der imitierten Anmeldedaten verwendet wurden.

Wenn nichts angegeben ist, versucht das System, die Standardanmeldedaten der Anwendung zu verwenden.
target_scopes Sequence[str] | None

Die Bereiche, die während der Autorisierung angefordert werden sollen.

Wenn None angegeben ist, wird der Standardbereich https://www.googleapis.com/auth/cloud-platform verwendet.
delegates Sequence[str] | None

Die verkettete Liste der Delegierten, die zum Gewähren des endgültigen Zugriffstokens erforderlich sind.

Wenn festgelegt, muss der vorherigen Identität die Service Account Token Creator-Funktion gewährt werden.

Wenn sie beispielsweise auf [serviceAccountB, serviceAccountC] festgelegt ist, muss source_credential die Rolle „Ersteller von Dienstkonto-Tokens“ für serviceAccountB haben. serviceAccountB muss die Rolle „Token Creator“ (Token-Ersteller) für serviceAccountC haben. Schließlich muss C die Rolle „Ersteller von Dienstkonto-Tokens“ für target_principal haben.

Wenn der Parameter nicht festgelegt ist, muss source_credential diese Rolle für target_principal haben.
quota_project_id str | None

Die Projekt-ID, die für Kontingent und Abrechnung verwendet wird.

Hinweis: Dieses Projekt kann sich von dem Projekt unterscheiden, das zum Erstellen der Anmeldedaten verwendet wurde.

Gibt Folgendes zurück:

Ein kurzlebiges „Credentials“-Objekt des Zielprinzipals.

Rückgabetyp

impersonated_credentials.Credentials

TIPCommon.rest.auth.get_secops_siem_tenant_credentials

TIPCommon.rest.auth.get_secops_siem_tenant_credentials(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, target_scopes: Sequence[str] | None = None, quota_project_id: str | None = None)→ Credentials

Ruft die kurzlebigen Anmeldedaten für das SIEM-Mandanten-Dienstkonto der Google SecOps-Instanz ab.

Parameter

Parameter
chronicle_soar TIPCommon.types.ChronicleSOAR

Das Google Security Operations SOAR SDK-Objekt.
target_scopes Sequence[str] | None

Die Bereiche, die während der Autorisierung angefordert werden sollen.
quota_project_id str | None

Die Projekt-ID, die für Kontingent und Abrechnung verwendet wird.

Hinweis: Dieses Projekt kann sich von dem Projekt unterscheiden, das zum Erstellen der Anmeldedaten verwendet wurde.

Gibt Folgendes zurück:

Kurzlebige Anmeldedaten für das Dienstkonto des SIEM-Mandanten.

Rückgabetyp

impersonated_credentials.Credentials

class TIPCommon.rest.gcp.GcpErrorReason

class TIPCommon.rest.gcp.GcpErrorReason

Basiert auf: object

Der Namespace für die Konstanten für Google Cloud Error Reason.

Konstanten

  • IAM_PERMISSION_DENIED = 'IAM_PERMISSION_DENIED'

Klasse TIPCommon.rest.gcp.GcpPermissions

class TIPCommon.rest.gcp.GcpPermissions

Basiert auf: object

Der Namespace für Google Cloud Berechtigungen.

Konstanten

  • IAM_SA_GET_ACCESS_TOKEN = 'iam.serviceAccounts.getAccessToken'

TIPCommon.rest.gcp.extract_project_id_from_sa_email

TIPCommon.rest.gcp.extract_project_id_from_sa_email(service_account_email: str)→ str

Extrahiert die Projekt-ID aus der E‑Mail-Adresse des Dienstkontos.

Parameter

Parameter
service_account_email str

Die E-Mail-Adresse des Dienstkontos.

Gibt Folgendes zurück:

Die Projekt-ID.

Rückgabetyp

str

Löst aus

NotFoundError – Wenn der Projektname nicht aus der E-Mail-Adresse des Dienstkontos geparst werden kann.

TIPCommon.rest.gcp.extract_project_id_from_sa_key

TIPCommon.rest.gcp.extract_project_id_from_sa_key(service_account_json: MutableMapping[str, Any])→ str

Extrahiert die Projekt-ID aus dem JSON-Schlüssel des Dienstkontos.

Parameter

Parameter
service_account_json SingleJson

Der JSON-Schlüssel des Dienstkontos.

Gibt Folgendes zurück:

Feld „Projekt-ID“ aus dem Dienstkontoschlüssel.

Rückgabetyp

str

Löst aus

NotFoundError: Wenn das Feld „project_id“ im Dienstkontoschlüssel nicht gefunden werden kann.

TIPCommon.rest.gcp.get_http_client

TIPCommon.rest.gcp.get_http_client(credentials: Credentials, verify_ssl: bool = True)→ Http | AuthorizedHttp

Ruft einen autorisierten Google Cloud HTTP-Client ab.

Parameter

Parameter
credentials service_account.Credentials

Ein Google Cloud Credentials-Objekt.
verify_ssl bool (optional)

Überprüft das SSL-Zertifikat. Die Standardeinstellung ist True.

Gibt Folgendes zurück:

Der autorisierte HTTP-Client.

Rückgabetyp

Union[httplib2.Http, google_auth_httplib2.AuthorizedHttp]

TIPCommon.rest.gcp.get_workload_sa_email

TIPCommon.rest.gcp.get_workload_sa_email(default_sa_to_return: str | None = None)→ str

Ruft die E‑Mail-Adresse des Workload-Dienstkontos vom Google Cloud Metadatenserver ab.

Parameter

Parameter
default_sa_to_return str | None

Standarddienstkonto, das zurückgegeben werden soll, wenn es nicht gefunden wird.

Die Standardeinstellung ist None.

Gibt Folgendes zurück:

Die E-Mail-Adresse des Dienstkontos für Arbeitslasten.

Rückgabetyp

str

Löst aus

GoogleCloudException – Wenn die E‑Mail-Adresse des GCP-Workload-Dienstkontos nicht abgerufen werden kann.

TIPCommon.rest.gcp.retrieve_project_id

TIPCommon.rest.gcp.retrieve_project_id(user_service_account: MutableMapping[str, Any] | None = None, service_account_email: str | None = None, default_project_id: str | None = None)→ str | None

Ruft die Projekt-ID aus der E‑Mail-Adresse eines Dienstkontos oder einer Arbeitslastidentität ab.

Parameter

Parameter
user_service_account SingleJson | None

Die JSON-Datei des Nutzerdienstkontos.
service_account_email str | None

Die E-Mail-Adresse der Workload Identity.
default_project_id str | None

Die Standardprojekt-ID, die zurückgegeben werden soll, wenn sie nicht gefunden wird.

Wenn dieser Parameter angegeben wird, löst diese Funktion NotFoundError nicht aus.

Die Standardeinstellung ist None.

Gibt Folgendes zurück:

Die Projekt-ID des Dienstkontos oder der E-Mail-Adresse der Workload Identity. Wenn nicht gefunden, wird None zurückgegeben.

Rückgabetyp

str | None

Löst aus

NotFoundError: Der Projektname konnte nicht aus der E-Mail-Adresse des Dienstkontos geparst werden.

TIPCommon.rest.gcp.validate_impersonation

TIPCommon.rest.gcp.validate_impersonation(content: dict, default_error_msg: str = 'Service Account Impersonation failed')→ None

Validiert die Dienstkonto-Identitätsübernahme anhand einer autorisierten HTTP-Antwort.

Parameter

Parameter
content dict

Der Inhalt der autorisierten HTTP-Antwort.
default_error_msg str, optional

Eine Fehlermeldung, die ausgelöst wird, wenn der Wert nicht im Antwortinhalt gefunden wird.

Die Standardeinstellung ist "Service Account Impersonation failed".

Gibt Folgendes zurück:

None, wenn die Identitätsübernahme des Dienstkontos autorisiert ist.

Rückgabetyp

None

Löst aus

ImpersonationUnauthorizedError – Wenn die Identitätsübertragung des Dienstkontos nicht autorisiert ist.

TIPCommon.rest.httplib.get_auth_session

TIPCommon.rest.httplib.get_auth_session(service_account, audience=None, verify_ssl=True)

Erstellt eine autorisierte HTTP-Sitzung für eine Google Cloud Ressourcen-API.

Parameter
service_account str | dict

Ein Google Cloud -Projekt-Dienstkonto mit den erforderlichen Rollen für Identity and Access Management.
audience str

Der Google Cloud Bereich.
verify_ssl bool

Gibt an, ob eine Sitzung mit SSL-Verschlüsselung erstellt werden soll.

Gibt Folgendes zurück:

Ein autorisiertes Sitzungsobjekt.

Rückgabetyp

requests.Session

Löst aus

ValueError – Wenn keine Anmeldedaten und kein Dienstkonto angegeben sind.

exception TIPCommon.rest.soar_api.SoarApiServerError

Basiert auf: Exception

Fehler bei API-Aufrufen von Google Security Operations SOAR an den Server.

TIPCommon.rest.soar_api.batch_set_custom_field_values

TIPCommon.rest.soar_api.batch_set_custom_field_values(chronicle_soar, identifier: int, parent: str, custom_fields_values_mapping: dict[int, list[str]])→ list[CustomFieldValue]

Mit Batches werden Werte für benutzerdefinierte Felder festgelegt.

Parameter

Parameter
chronicle_soar Ein Google Security Operations SOAR SDK-Objekt.
identifier int

Die übergeordnete Kennung.
parent str

Der übergeordnete Pfad für den Wert des benutzerdefinierten Felds (z.B. cases/1, cases/1/alerts/1).
custom_fields_values_mapping dict[int, list[str]]

Zuordnung von benutzerdefinierten Feld-IDs zu Werten.

Gibt Folgendes zurück:

Liste der CustomFieldValue-Objekte.

Rückgabetyp

list[CustomFieldValue]

TIPCommon.rest.soar_api.get_alert_events

TIPCommon.rest.soar_api.get_alert_events(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_id: str | int, alert_identifier: str)→ list[AlertEvent]

Ruft die Ereignisse einer bestimmten Benachrichtigung ab.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Ein Google Security Operations SOAR SDK-Objekt.
case_id str | int

Die Fall-ID. Beispiel: 13, "41".
alert_identifier str

Die ID der Benachrichtigung (z.B. '{alert.name}_{alert.id}').

Beispiel: alert.name=SERVICE_ACCOUNT_USED alert.id=c3b80f09-38d3-4328-bddb-b938ccee0256 identifier=SERVICE_ACCOUNT_USED_c3b80f09-38d3-4328-bddb-b938ccee0256.

Gibt Folgendes zurück:

Die JSON-Antwort der Anfrage. Eine Liste der JSON-Dateien für Ereignisse.

Rückgabetyp

list[SingleJson]

Löst aus

requests.HTTPError: Der Server gibt einen Statuscode zurück, der nicht auf Erfolg hinweist. json.JSONDecodeError: Wenn der zurückgegebene Wert kein gültiges JSON ist.

TIPCommon.rest.soar_api.get_case_attachments

TIPCommon.rest.soar_api.get_case_attachments(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_id: int)→ MutableMapping[str, Any]

Ruft Fallanhänge ab.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Ein Google Security Operations SOAR SDK-Objekt.
case_id int

Die Google Security Operations SOAR-Fall‑ID.

Gibt Folgendes zurück:

Eine veränderliche Zuordnung, die die Fallanhänge darstellt.

Rückgabetyp

MutableMapping[str, Any]

TIPCommon.rest.soar_api.get_case_overview_details

TIPCommon.rest.soar_api.get_case_overview_details(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_id: int | str) → CaseDetails

Rufen Sie Details zur Fallübersicht anhand der Fall-ID ab.

Parameter
chronicle_soar ChronicleSOAR

Ein Google Security Operations SDK-Objekt.
case_id int | str

Die Google Security Operations SOAR-Fall‑ID.

Gibt Folgendes zurück:

Das Falldetails-Objekt.

Rückgabetyp

(CaseDetails)

Löst aus

requests.HTTPError: Wenn eine Anfrage fehlschlägt oder der Anfragestatus nicht 200 ist. json.JSONDecoderError: Beim Parsen der Antwort ist ein Fehler aufgetreten.

TIPCommon.rest.soar_api.get_connector_cards

TIPCommon.rest.soar_api.get_connector_cards(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, integration_name: str | None = None, connector_identifier: str | None = None)→ list[ConnectorCard]

Ruft alle Connector-Karten ab.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Ein Google Security Operations SOAR SDK-Objekt.
integration_name str | None

Der Name der Integration.
connector_identifier str | None

Die Connector-ID.

Gibt Folgendes zurück:

Eine Liste aller Connector-Karten.

Rückgabetyp

list[ConnectorCard]

TIPCommon.rest.soar_api.get_entity_data

TIPCommon.rest.soar_api.get_entity_data(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, entity_identifier: str, entity_environment: str, entity_type: str | None = None, last_case_type: int = 0, case_distribution_type: int = 0)→ MutableMapping[str, Any]

Ruft Entitätsdaten ab.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Ein Google Security Operations SOAR SDK-Objekt.
entity_identifier int

Die Entitäts-ID.
entity_environment str

Die Entitätsumgebung.
entity_type str

Der Entitätstyp.
last_case_type int

Der letzte Falltyp.
case_distribution_type int

Der Typ der Fallverteilung.

Gibt Folgendes zurück:

Eine veränderliche Zuordnung, die die Entitätsdaten darstellt.

Rückgabetyp

dict

Löst aus

requests.HTTPError: Der Server gibt einen Statuscode zurück, der nicht auf Erfolg hinweist.

TIPCommon.rest.soar_api.get_env_action_def_files

TIPCommon.rest.soar_api.get_env_action_def_files(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob)→ list[Dict[str, Any]]

Ruft eine Liste von Dateien mit Umgebungsaktionsdefinitionen ab.

Parameter
chronicle_soar ChronicleSOAR

Ein Google SecOps SDK-Objekt.

Gibt Folgendes zurück:

Eine Liste von SingleJson-Objekten, die die Aktionsdefinitionsdateien darstellen.

Rückgabetyp

(list[SingleJson])

Löst aus

requests.HTTPError: Wenn der Server einen Statuscode zurückgibt, der nicht auf Erfolg hinweist. json.JSONDecodeError: Der zurückgegebene Wert ist kein gültiges JSON.

TIPCommon.rest.soar_api.get_federation_cases

TIPCommon.rest.soar_api.get_federation_cases(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob)→ MutableMapping[str, Any]

Ruft Föderationsfälle ab.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Ein Google Security Operations SOAR SDK-Objekt.

Gibt Folgendes zurück:

Antwort-JSON.

Rückgabetyp

SingleJson

TIPCommon.rest.soar_api.get_full_case_details

TIPCommon.rest.soar_api.get_full_case_details(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_id: int)→ MutableMapping[str, Any]

Ruft vollständige Falldetails ab.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Ein Google Security Operations SOAR SDK-Objekt.
case_id int

Die Google Security Operations SOAR-Fall‑ID.

Gibt Folgendes zurück:

Eine veränderliche Zuordnung, die die vollständigen Falldetails enthält.

Rückgabetyp

MutableMapping[str, Any]

TIPCommon.rest.soar_api.get_installed_integrations_of_environment

TIPCommon.rest.soar_api.get_installed_integrations_of_environment(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, environment: str, integration_identifier: str | None = None)→ list[InstalledIntegrationInstance]

Ruft alle Integrationen ab, die für die angegebenen Umgebungen installiert sind.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Ein Google Security Operations SOAR SDK-Objekt.
environment str

Die Liste der Instanzumgebungen.
integration_identifier str | None

Die Integrations-ID.

Gibt Folgendes zurück:

Eine Liste von Dictionary-Objekten, die Integrationsinstanzen darstellen.

Rückgabetyp

list[InstalledIntegrationInstance]

TIPCommon.rest.soar_api.get_installed_jobs

TIPCommon.rest.soar_api.get_installed_jobs(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob)→ list[Dict[str, Any]]

Ruft eine Liste von Dateien mit Umgebungsaktionsdefinitionen ab.

Parameter
chronicle_soar ChronicleSOAR

Ein Google SecOps SDK-Objekt.

Gibt Folgendes zurück:

Eine Liste von SingleJson-Objekten, die die Aktionsdefinitionsdateien darstellen.

Rückgabetyp

(list[SingleJson])

Löst aus

requests.HTTPError: Wenn der Server einen Statuscode zurückgibt, der nicht auf Erfolg hinweist. json.JSONDecodeError: Der zurückgegebene Wert ist kein gültiges JSON.

TIPCommon.rest.soar_api.get_integration_full_details

TIPCommon.rest.soar_api.get_integration_full_details(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, integration_identifier: str)→ Dict[str, Any]

Ruft die Datei mit den vollständigen Details der Integration ab.

Parameter
chronicle_soar ChronicleSOAR

Ein Google SecOps SDK-Objekt.
integration_identifier str

Die Integrations-ID.

Gibt Folgendes zurück:

Eine JSON-Antwort mit allen Details der Integration.

Rückgabetyp

(SingleJSON)

Löst aus

requests.HTTPError: Wenn der Server einen Statuscode zurückgibt, der nicht auf Erfolg hinweist. json.JSONDecodeError: Der zurückgegebene Wert ist kein gültiges JSON.

TIPCommon.rest.soar_api.get_user_profile_cards

TIPCommon.rest.soar_api.get_user_profile_cards(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, search_term: str = '', requested_page: int = 0, 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)→ MutableMapping[str, Any]

Ruft Nutzerprofilkarten nach Seite und Filter ab.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Ein Google Security Operations SOAR SDK-Objekt.
search_term str

Die Suchbegriffe.
requested_page int

Der Start-Offset für die Rückgabe der Seite eines Nutzers.
page_size int

Die Anzahl der zurückzugebenden Nutzer.
filter_by_role bool

Legen Sie fest, ob nach Rolle gefiltert werden soll.
filter_disabled_users bool

Legen Sie fest, ob deaktivierte Nutzer herausgefiltert werden sollen.
filter_support_users bool

Legen Sie fest, ob Supportnutzer herausgefiltert werden sollen.
fetch_only_support_users bool

Gibt an, ob nur Supportnutzer zurückgegeben werden sollen.
filter_permission_types list[int] | None

Eine Liste mit Berechtigungstypen für Filter, z.B. 0.

Gibt Folgendes zurück:

Die Antwort vom SOAR-Server – die Nutzerprofilkarte.

Rückgabetyp

SingleJson

Löst aus

requests.HTTPError: Der Server gibt einen Statuscode zurück, der nicht auf Erfolg hinweist. json.JSONDecodeError: Der zurückgegebene Wert ist kein gültiges JSON.

Beispiel

Beispiel für die JSON-Antwort:

{
  "objectsList": [
    { "firstName": "string", "lastName": "string", "userName": "string", "accountState": 0 }
  ],
  "metadata": {
    "totalNumberOfPages": 0,
    "totalRecordsCount": 0,
    "pageSize": 0
  }
}

TIPCommon.rest.soar_api.get_workflow_instance_card

TIPCommon.rest.soar_api.get_workflow_instance_card(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_id: int, alert_identifier: str)→ MutableMapping[str, Any]

Ruft eine Workflow-Instanzkarte ab.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Ein Google Security Operations SOAR SDK-Objekt.
case_id int

Die Google Security Operations SOAR-Fall‑ID.
alert_identifier str

Die Google Security Operations SOAR-Benachrichtigungs-ID.

Gibt Folgendes zurück:

Eine veränderliche Zuordnung, die die Workflow-Instanzkarte darstellt.

Rückgabetyp

MutableMapping[str, Any]

TIPCommon.rest.soar_api.list_custom_field_values

TIPCommon.rest.soar_api.list_custom_field_values(chronicle_soar, parent: str)→ list[CustomFieldValue]

Ruft Werte für benutzerdefinierte Felder für einen Fall oder eine Benachrichtigung ab.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Ein Google Security Operations SOAR SDK-Objekt.
parent str

Der übergeordnete Pfad für den Wert des benutzerdefinierten Felds (z.B.: cases/1, cases/1/alerts/1).

Gibt Folgendes zurück:

Das Falldetails-Objekt.

Rückgabetyp

list[CustomFieldValue]

Löst aus

requests.HTTPError: Wenn die Anfrage fehlschlägt oder der Anfragestatus nicht 200 ist. json.JSONDecoderError: Beim Parsen der Antwort ist ein Fehler aufgetreten.

TIPCommon.rest.soar_api.list_custom_fields

TIPCommon.rest.soar_api.list_custom_fields(chronicle_soar, filter_: str | None = None)→ list[CustomField]

Listet benutzerdefinierte Felder auf.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Ein Google Security Operations SOAR SDK-Objekt.
filter_ str | None

Der Filterwert für die Suche.

Gibt Folgendes zurück:

Das Falldetails-Objekt.

Rückgabetyp

list[CustomField]

Löst aus

requests.HTTPError: Wenn die Anfrage fehlschlägt oder der Anfragestatus nicht 200 ist. json.JSONDecoderError: Beim Parsen der Antwort ist ein Fehler aufgetreten.

TIPCommon.rest.soar_api.remove_case_tag

TIPCommon.rest.soar_api.remove_case_tag(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_id: int, tag: str, alert_identifier: str | None = None)→ None

Entfernt ein Fall-Tag.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Ein Google Security Operations SOAR SDK-Objekt.
case_id int

Die Google Security Operations SOAR-Fall‑ID.
tag str

Ein Tag, das entfernt werden soll.
alert_identifier str | None

Die ID der {google_secops_soar_name}-Benachrichtigung.

Gibt Folgendes zurück:

Keine.

Rückgabetyp

None

Löst aus

requests.HTTPError: Der Server gibt einen Statuscode zurück, der nicht auf Erfolg hinweist.

TIPCommon.rest.soar_api.save_attachment_to_case_wall

TIPCommon.rest.soar_api.save_attachment_to_case_wall(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, attachment_data: CaseWallAttachment)→ MutableMapping[str, Any]

Speichert eine Datei direkt auf der Gehäusewand.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Ein Google Security Operations SOAR SDK-Objekt.
attachment_data CaseWallAttachment

Ein CaseWallAttachment-Objekt.

Gibt Folgendes zurück:

Eine veränderliche Zuordnung, die die API-Antwort darstellt.

Rückgabetyp

MutableMapping[str, Any]

TIPCommon.rest.soar_api.set_alert_priority

TIPCommon.rest.soar_api.set_alert_priority(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_id: int, alert_identifier: str, alert_name: str, priority: int)→ None

Legt die Priorität von Benachrichtigungen fest.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Ein Google Security Operations SOAR SDK-Objekt.
case_id int

Die Google Security Operations SOAR-Fall‑ID.
alert_identifier str

Die Google Security Operations SOAR-Benachrichtigungs-ID.
alert_name str

Der Name der Google Security Operations SOAR-Benachrichtigung.
priority int

Der Enumerationswert für die Priorität von Google Security Operations SOAR.

Gibt Folgendes zurück:

Keine.

Rückgabetyp

None

Löst aus

requests.HTTPError: Der Server gibt einen Statuscode zurück, der nicht auf Erfolg hinweist.

TIPCommon.rest.soar_api.set_case_score_bulk

TIPCommon.rest.soar_api.set_case_score_bulk(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_score_mapping: list[dict[str, int | float]])→ MutableMapping[str, Any]

Legt Fallbewertungen im Bulk fest.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Ein Google Security Operations SOAR SDK-Objekt.
case_score_mapping list[dict[str, int | float]]

Eine Zuordnung der Google Security Operations SOAR-Fall‑ID zum Score.

Gibt Folgendes zurück:

Eine JSON-Antwort mit dem Erfolgsstatus und gegebenenfalls Listen mit fehlgeschlagenen Fällen.

Rückgabetyp

MutableMapping[str, Any]

Löst aus

requests.HTTPError: Der Server gibt einen Statuscode zurück, der nicht auf Erfolg hinweist.

Beispiel

{
  case_score_mapping = [
  {
    "caseId": 1, "score": 1.0
  }

]
}

TIPCommon.rest.soar_api.set_custom_field_values

TIPCommon.rest.soar_api.set_custom_field_values(chronicle_soar: ChronicleSOAR, parent: str, custom_field_id: int, values: list[str])→ CustomFieldValue

Legt Werte für benutzerdefinierte Felder fest.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Ein Google Security Operations SOAR SDK-Objekt.
parent str

Der übergeordnete Pfad für den Wert des benutzerdefinierten Felds, z.B.: cases/1, cases/1/alerts/1.
custom_field_id int

Die ID des benutzerdefinierten Felds.
values list[str]

Eine Liste der benutzerdefinierten Feldwerte, die festgelegt werden sollen.

Gibt Folgendes zurück:

Ein CustomFieldValue-Objekt.

Rückgabetyp

CustomFieldValue

TIPCommon.rest.soar_api.validate_response

TIPCommon.rest.soar_api.validate_response(response: Response, validate_json: bool = False) → None

Validiert die Antwort und gibt sie als JSON zurück.

Parameter
response requests.Response

Die zu validierende Antwort.

Löst aus

HTTPError: Wenn der Antwortstatuscode einen Fehler angibt.

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