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

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

יוצר אובייקט של פרטי כניסה מחשבון שירות, מכתובת אימייל של Workload Identity או ממאפיינים של חשבון שירות.

הערה חובה לציין את אחד מהערכים הבאים: user_service_account,‏ target_principal או service_account_attr (באמצעות **kwargs). אחרת, תופעל חריגה של EmptyMandatoryValues.

פרמטרים

פרמטרים
`user_service_account`	`SingleJson \| None` קובץ ה-JSON של חשבון השירות של המשתמש.
`target_principal`	`str \| None` האימייל של הזהות של עומס העבודה.
`source_credentials`	`google.auth.Credentials \| None` פרטי הכניסה של המקור ששימשו להשגת פרטי הכניסה של החשבון המזויף. אם מספקים את `None`, המערכת מנסה להשתמש בפרטי הכניסה שמוגדרים כברירת מחדל באפליקציה.
`quota_project_id`	`str \| None` מזהה הפרויקט שמשמש למכסות ולחיוב.
`scopes`	`list[str]` היקפי ההרשאות של פרטי הכניסה. Google Cloud ברירת המחדל היא `['https://www.googleapis.com/auth/cloud-platform']`.
`verify_ssl`	`bool` הגדרת אימות של אישור SSL. ברירת המחדל היא `True`.
`service_account_attr`	`dict[str, Any]` צמדים של מפתח/ערך של שדות בחשבון שירות שעברו פירוק.

העלאות

‫EmptyMandatoryValues – אם אין כתובת אימייל של חשבון שירות או של שירות משולב לזיהוי עומסי עבודה, או אם חסרים שדות חובה בחשבון השירות. ‫google.auth.exceptions.RefreshError – אם אי אפשר לרענן את פרטי הכניסה.

מחזירה

אובייקט של פרטי כניסה.

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

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

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

פרמטרים

פרמטרים
`account_type`	`str` סוג חשבון השירות.
`project_id`	`str` מזהה הפרויקט של חשבון השירות.
`private_key_id`	`str` המזהה של המפתח הפרטי של חשבון השירות.
`private_key`	`str` המפתח הפרטי של חשבון השירות.
`client_email`	`str` כתובת האימייל של הלקוח בחשבון השירות.
`client_id`	`str` מזהה הלקוח של חשבון השירות.
`auth_uri`	`str` כתובת ה-URI לאימות של חשבון השירות.
`token_uri`	`str` ה-URI של הטוקן של חשבון השירות.
`auth_provider_x509_url`	`str` כתובת ה-URL של אישור x509 של ספק האימות של חשבון השירות.
`client_x509_cert_url`	`str` כתובת ה-URL של אישור x509 של לקוח חשבון השירות.
`scopes`	`list[str], optional` היקפי ההרשאות של פרטי הכניסה. Google Cloud ברירת המחדל היא `['https://www.googleapis.com/auth/cloud-platform']`.
`quota_project_id`	`str \| None` מזהה הפרויקט שמשמש למכסות ולחיוב.

העלאות

‫EmptyMandatoryValues – כשחסרים שדות חובה בחשבון השירות.

מחזירה

אובייקט של פרטי כניסה.

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

service_account.Credentials

TIPCommon.rest.auth.generate_jwt_from_credentials

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

יצירת JSON Web Token לגישה למשאבי Google Cloud API באמצעות REST.

פרמטרים

פרמטרים
`credentials`	`google.oauth2.credentials.Credentials` אובייקט `google.oauth2.credentials.Credentials`.
`verify_ssl`	`bool` הגדרת רענון של אסימון פרטי הכניסה באמצעות SSL. ברירת המחדל היא `True`.

credentials

google.oauth2.credentials.Credentials

אובייקט google.oauth2.credentials.Credentials.

verify_ssl

bool

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

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

מחזירה

אסימון JWT לשימוש בכותרת Authorization.

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

bytes

TIPCommon.rest.auth.generate_jwt_from_sa

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

יצירת JSON Web Token לגישה למשאבי Google Cloud API באמצעות REST.

פרמטרים
`service_account`	`str \| dict` Google Cloud חשבון שירות בפרויקט עם התפקידים הנדרשים בניהול הזהויות והרשאות הגישה.
`expiry_length`	`int` הזמן שמוגדר עד שתוקף האסימון יפוג, בשניות. ברירת המחדל היא שעה אחת.
`audience`	`str` Google Cloud scope. אם לא מציינים ערך, ברירת המחדל היא `https://www.googleapis.com/auth/cloud-platform`.

מחזירה

אסימון JWT לשימוש בכותרת ההרשאה.

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

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]

קבלת Application Default Credentials‏ (ADC) של סביבת זמן הריצה. זוהי פונקציית wrapper עבור google.auth.default.

פרמטרים

פרמטרים
`scopes`	`Sequence[str] \| None` רשימת ההיקפים של פרטי הכניסה. אם מציינים פרטי כניסה, ההיקף שלהם מוגדר אוטומטית כשצריך.
`request`	`google.auth.transport.Request \| None` אובייקט שמשמש לשליחת בקשות HTTP. האובייקט הזה משמש כדי לזהות אם האפליקציה פועלת ב-Compute Engine או כדי לקבוע את מזהה הפרויקט המשויך למשאב של מאגר זהויות של עומסי עבודה (פרטי כניסה של חשבון חיצוני). אם לא מציינים, נעשה שימוש בלקוח HTTP של הספרייה הרגילה לפרטי כניסה של Compute Engine או בלקוח `google.auth.transport.requests.Request` לפרטי כניסה של חשבון חיצוני.
`quota_project_id`	`str \| None` מזהה הפרויקט שמשמש למכסות ולחיוב.

scopes

Sequence[str] | None

רשימת ההיקפים של פרטי הכניסה.

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

request

google.auth.transport.Request | None

אובייקט שמשמש לשליחת בקשות HTTP. האובייקט הזה משמש כדי לזהות אם האפליקציה פועלת ב-Compute Engine או כדי לקבוע את מזהה הפרויקט המשויך למשאב של מאגר זהויות של עומסי עבודה (פרטי כניסה של חשבון חיצוני).

אם לא מציינים, נעשה שימוש בלקוח HTTP של הספרייה הרגילה לפרטי כניסה של Compute Engine או בלקוח google.auth.transport.requests.Request לפרטי כניסה של חשבון חיצוני.

quota_project_id

str | None

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

מחזירה

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

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

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

העלאות

‫google.auth.exceptions.DefaultCredentialsError – אם לא נמצאו פרטי כניסה או אם פרטי הכניסה שנמצאו לא היו תקינים.

TIPCommon.rest.auth.get_auth_request

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

יוצר בקשת HTTP מורשית ל-API של משאב Google Cloud .

פרמטרים

פרמטרים
`verify_ssl`	`bool, optional` מאמת את אישור ה-SSL. ברירת המחדל היא `True`.

מחזירה

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

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

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

מקבל אובייקט Credentials לטווח קצר באמצעות Google Cloud התחזות לחשבון שירות.

פרמטרים

פרמטרים
`target_principal`	`str` חשבון השירות שצריך להתחזות אליו.
`source_credentials`	`google.auth.Credentials \| None` פרטי הכניסה של המקור ששימשו להשגת פרטי הכניסה של החשבון המזויף. אם לא מספקים פרטים, המערכת מנסה להשתמש בפרטי הכניסה שמוגדרים כברירת מחדל באפליקציה.
`target_scopes`	`Sequence[str] \| None` היקפי ההרשאות שצריך לבקש במהלך הענקת ההרשאה. אם לא מציינים את `None`, נעשה שימוש בהיקף ברירת המחדל `https://www.googleapis.com/auth/cloud-platform`.
`delegates`	`Sequence[str] \| None` רשימת הנציגים הנדרשים כדי להעניק את אסימון הגישה הסופי. אם מוגדר רצף של זהויות, הזהות הקודמת צריכה לקבל את היכולת `Service Account Token Creator`. לדוגמה, אם הערך הוא `[serviceAccountB, serviceAccountC]`, ל-`source_credential` צריך להיות התפקיד Token Creator ב-`serviceAccountB`. ל-`serviceAccountB` צריכה להיות הרשאת יצירת אסימונים ב-`serviceAccountC`. לבסוף, ל-`C` צריך להיות התפקיד 'יצירת אסימונים' ב-`target_principal`. אם לא מגדירים את התפקיד, לחשבון המשתמש `source_credential` צריך להיות התפקיד הזה ב-`target_principal`.
`quota_project_id`	`str \| None` מזהה הפרויקט שמשמש למכסות ולחיוב. הערה: יכול להיות שהפרויקט הזה שונה מהפרויקט שבו השתמשתם כדי ליצור את פרטי הכניסה.

מחזירה

אובייקט Credentials לטווח קצר של חשבון המשתמש של היעד.

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

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

קבלת פרטי הכניסה לטווח קצר של חשבון השירות של דייר SIEM במכונת Google SecOps.

פרמטרים

פרמטרים
`chronicle_soar`	`TIPCommon.types.ChronicleSOAR` אובייקט Google SecOps SDK.
`target_scopes`	`Sequence[str] \| None` היקפי ההרשאות שצריך לבקש במהלך הענקת ההרשאה.
`quota_project_id`	`str \| None` מזהה הפרויקט שמשמש למכסות ולחיוב. הערה: יכול להיות שהפרויקט הזה שונה מהפרויקט שבו השתמשתם כדי ליצור את פרטי הכניסה.

chronicle_soar

TIPCommon.types.ChronicleSOAR

אובייקט Google SecOps SDK.

target_scopes

Sequence[str] | None

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

quota_project_id

str | None

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

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

מחזירה

פרטי כניסה לחשבון שירות לטווח קצר של דייר SIEM.

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

impersonated_credentials.Credentials

class TIPCommon.rest.gcp.GcpErrorReason

class TIPCommon.rest.gcp.GcpErrorReason

בסיסים: object

מרחב השמות של הקבועים Google Cloud Error Reason.

קבועים

IAM_PERMISSION_DENIED = 'IAM_PERMISSION_DENIED'

‫class TIPCommon.rest.gcp.GcpPermissions

class TIPCommon.rest.gcp.GcpPermissions

בסיסים: object

מרחב השמות של הקבועים של Google Cloud Permissions.

קבועים

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

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

פרמטרים

פרמטרים
`service_account_email`	`str` כתובת האימייל בחשבון השירות.

מחזירה

מזהה הפרויקט.

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

str

העלאות

‫NotFoundError – כשהמערכת לא מצליחה לנתח את שם הפרויקט מכתובת האימייל של חשבון ה-SA.

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

מחולץ מזהה הפרויקט ממפתח ה-JSON של חשבון השירות.

פרמטרים

פרמטרים
`service_account_json`	`SingleJson` מפתח JSON של חשבון השירות.

מחזירה

שדה מזהה הפרויקט ממפתח חשבון השירות.

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

str

העלאות

‫NotFoundError – אם לא ניתן למצוא את השדה project_id במפתח של חשבון השירות.

TIPCommon.rest.gcp.get_http_client

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

קבלת Google Cloud לקוח HTTP מורשה.

פרמטרים

פרמטרים
`credentials`	`service_account.Credentials` אובייקט Google Cloud Credentials.
`verify_ssl`	‫`bool`, אופציונלי מאמת את אישור ה-SSL. ברירת המחדל היא `True`.

מחזירה

לקוח ה-HTTP המורשה.

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

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

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

פרמטרים

פרמטרים
`default_sa_to_return`	`str \| None` חשבון השירות שמוגדר כברירת מחדל שיוחזר אם לא נמצא חשבון שירות. ברירת המחדל היא `None`.

default_sa_to_return

str | None

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

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

מחזירה

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

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

str

העלאות

‫GoogleCloudException – אם לא ניתן לקבל את כתובת האימייל בחשבון השירות של עומס העבודה ב-GCP.

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

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

פרמטרים

user_service_account

SingleJson | None

קובץ ה-JSON של חשבון השירות של המשתמש.

service_account_email

str | None

האימייל של הזהות של עומס העבודה.

default_project_id

str | None

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

אם מספקים את הפונקציה הזו, היא לא תעלה את NotFoundError.

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

מחזירה

מזהה הפרויקט של חשבון השירות או של כתובת האימייל של Workload Identity. אם לא נמצא, מוחזרת הערך None.

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

str | None

העלאות

‫NotFoundError – כשאי אפשר לנתח את שם הפרויקט מכתובת האימייל של החשבון לשירותים.

TIPCommon.rest.gcp.validate_impersonation

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

מאמת התחזות לחשבון שירות מתגובה מורשית של HTTP.

פרמטרים

פרמטרים
`content`	`dict` תוכן התגובה המורשית של ה-HTTP.
`default_error_msg`	`str, optional` הודעת שגיאה שמוצגת אם לא נמצא תוכן בתגובה. ברירת המחדל היא `"Service Account Impersonation failed"`.

content

dict

תוכן התגובה המורשית של ה-HTTP.

default_error_msg

str, optional

הודעת שגיאה שמוצגת אם לא נמצא תוכן בתגובה.

ברירת המחדל היא "Service Account Impersonation failed".

מחזירה

‫None אם יש הרשאה להתחזות לחשבון שירות.

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

None

העלאות

‫ImpersonationUnauthorizedError – כשאין הרשאה להתחזות לחשבון שירות.

TIPCommon.rest.httplib.get_auth_session

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

יוצר סשן HTTP מורשה ל-API של משאב Google Cloud .

פרמטרים
`service_account`	`str \| dict` Google Cloud חשבון שירות בפרויקט עם התפקידים הנדרשים של ניהול זהויות והרשאות גישה (IAM).
`audience`	`str` היקף ההרשאות Google Cloud .
`verify_ssl`	`bool` ההגדרה קובעת אם ליצור סשן עם הצפנת SSL.

מחזירה

אובייקט של סשן מורשה.

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

requests.Session

העלאות

‫ValueError – כשלא מסופקים פרטי כניסה וחשבון שירות.

exception TIPCommon.rest.soar_api.SoarApiServerError

בסיסים: Exception

שגיאות מקריאות ל-API של Google SecOps לשרת.

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]

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

פרמטרים

פרמטרים
`chronicle_soar`	אובייקט Google SecOps SDK.
`identifier`	`int` מזהה ההורה.
`parent`	`str` נתיב ההורה של ערך השדה המותאם אישית (למשל, `cases/1`, `cases/1/alerts/1`).
`custom_fields_values_mapping`	`dict[int, list[str]]` מיפוי של מזהי שדות בהתאמה אישית לערכים.

מחזירה

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

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

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]

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

פרמטרים

chronicle_soar

ChronicleSOAR

אובייקט Google SecOps SDK.

case_id

str | int

מספר הפנייה. דוגמה: 13, "41".

alert_identifier

str

המזהה של ההתראה (למשל, '{alert.name}_{alert.id}').

דוגמה: alert.name=SERVICE_ACCOUNT_USED alert.id=c3b80f09-38d3-4328-bddb-b938ccee0256 identifier=SERVICE_ACCOUNT_USED_c3b80f09-38d3-4328-bddb-b938ccee0256

מחזירה

קובץ ה-JSON של התגובה לבקשה. רשימה של קובצי JSON של אירועים.

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

list[SingleJson]

העלאות

‫requests.HTTPError – כשהשרת מחזיר קוד סטטוס של אי-הצלחה. ‫json.JSONDecodeError – אם הערך המוחזר הוא לא JSON תקין.

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]

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

פרמטרים

פרמטרים
`chronicle_soar`	`ChronicleSOAR` אובייקט Google SecOps SDK.
`case_id`	`int` מספר הפנייה ב-Google SecOps.

מחזירה

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

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

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

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

פרמטרים
`chronicle_soar`	`ChronicleSOAR` אובייקט SDK של Google Security Operations.
`case_id`	`int \| str` מספר הפנייה ב-Google SecOps.

מחזירה

אובייקט פרטי הפנייה.

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

(CaseDetails)

העלאות

‫requests.HTTPError – אם הבקשה נכשלת או שהסטטוס שלה הוא לא 200. ‫json.JSONDecoderError – כשהניתוח של התגובה נכשל.

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]

מקבל את כל כרטיסי המחבר.

פרמטרים

פרמטרים
`chronicle_soar`	`ChronicleSOAR` אובייקט Google SecOps SDK.
`integration_name`	`str \| None` שם השילוב.
`connector_identifier`	`str \| None` מזהה המחבר.

מחזירה

רשימה של כל כרטיסי המחברים.

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

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]

מאחזר נתוני ישות.

פרמטרים

פרמטרים
`chronicle_soar`	`ChronicleSOAR` אובייקט Google SecOps SDK.
`entity_identifier`	`int` מזהה היישות.
`entity_environment`	`str` הסביבה של הישות.
`entity_type`	`str` סוג הישות.
`last_case_type`	`int` סוג הבקשה האחרון.
`case_distribution_type`	`int` סוג ההפצה של הפנייה.

מחזירה

מיפוי שניתן לשינוי שמייצג את נתוני הישות.

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

dict

העלאות

‫requests.HTTPError – כשהשרת מחזיר קוד סטטוס של אי-הצלחה.

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

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

פרמטרים
`chronicle_soar`	`ChronicleSOAR` אובייקט Google SecOps SDK.

מחזירה

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

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

(list[SingleJson])

העלאות

‫requests.HTTPError – כשהשרת מחזיר קוד סטטוס שלא מציין הצלחה. ‫json.JSONDecodeError – כשהערך שמוחזר הוא לא JSON תקין.

TIPCommon.rest.soar_api.get_federation_cases

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

מקבל את הפניות בנושא איחוד.

פרמטרים

פרמטרים
`chronicle_soar`	`ChronicleSOAR` אובייקט Google SecOps SDK.

מחזירה

תגובת JSON.

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

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]

קבלת פרטים מלאים על פנייה.

פרמטרים

פרמטרים
`chronicle_soar`	`ChronicleSOAR` אובייקט Google SecOps SDK.
`case_id`	`int` מספר הפנייה ב-Google SecOps.

מחזירה

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

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

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]

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

פרמטרים

פרמטרים
`chronicle_soar`	`ChronicleSOAR` אובייקט Google SecOps SDK.
`environment`	`str` רשימת סביבות המופעים.
`integration_identifier`	`str \| None` מזהה השילוב.

מחזירה

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

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

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

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

פרמטרים
`chronicle_soar`	`ChronicleSOAR` אובייקט Google SecOps SDK.

מחזירה

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

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

(list[SingleJson])

העלאות

‫requests.HTTPError – כשהשרת מחזיר קוד סטטוס שלא מציין הצלחה. ‫json.JSONDecodeError – כשהערך שמוחזר הוא לא 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]

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

פרמטרים
`chronicle_soar`	`ChronicleSOAR` אובייקט Google SecOps SDK.
`integration_identifier`	`str` מזהה השילוב.

מחזירה

תגובת JSON שמכילה את כל פרטי השילוב.

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

(SingleJSON)

העלאות

‫requests.HTTPError – כשהשרת מחזיר קוד סטטוס שלא מציין הצלחה. ‫json.JSONDecodeError – כשהערך שמוחזר הוא לא 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]

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

פרמטרים

פרמטרים
`chronicle_soar`	`ChronicleSOAR` אובייקט Google SecOps SDK.
`search_term`	`str` מונחי החיפוש.
`requested_page`	`int` ההיסטארט שבו מתחילים להחזיר את הדף של המשתמש.
`page_size`	`int` מספר המשתמשים שיוחזרו.
`filter_by_role`	`bool` הגדרת סינון לפי תפקיד.
`filter_disabled_users`	`bool` הגדרה של סינון משתמשים מושבתים.
`filter_support_users`	`bool` מגדירים אם לסנן משתמשים של תמיכה.
`fetch_only_support_users`	`bool` הגדרה אם להחזיר רק משתמשי תמיכה.
`filter_permission_types`	`list[int] \| None` רשימה של סוגי הרשאות סינון (לדוגמה, `0`).

מחזירה

התגובה משרת SOAR – כרטיס פרופיל המשתמש.

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

SingleJson

העלאות

‫requests.HTTPError – כשהשרת מחזיר קוד סטטוס של שגיאה. ‫json.JSONDecodeError – כשהערך שמוחזר הוא לא JSON תקין.

דוגמה

דוגמה ל-JSON של התגובה:

{
  "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]

מקבל כרטיס של מופע של תהליך עבודה.

פרמטרים

פרמטרים
`chronicle_soar`	`ChronicleSOAR` אובייקט Google SecOps SDK.
`case_id`	`int` מספר הפנייה ב-Google SecOps.
`alert_identifier`	`str` מזהה ההתראה ב-Google SecOps.

מחזירה

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

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

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]

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

פרמטרים

פרמטרים
`chronicle_soar`	`ChronicleSOAR` אובייקט Google SecOps SDK.
`parent`	`str` נתיב ההורה של הערך של השדה המותאם אישית (לדוגמה: `cases/1`, `cases/1/alerts/1`).

מחזירה

אובייקט פרטי הפנייה.

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

list[CustomFieldValue]

העלאות

‫requests.HTTPError – כשהבקשה נכשלת או שהסטטוס שלה הוא לא 200. ‫json.JSONDecoderError – כשניתוח התשובה נכשל.

TIPCommon.rest.soar_api.list_custom_fields

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

רשימת שדות מותאמים אישית.

פרמטרים

פרמטרים
`chronicle_soar`	`ChronicleSOAR` אובייקט Google SecOps SDK.
`filter_`	`str \| None` ערך המסנן לחיפוש.

מחזירה

אובייקט פרטי הפנייה.

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

list[CustomField]

העלאות

‫requests.HTTPError – כשהבקשה נכשלת או שהסטטוס שלה הוא לא 200. ‫json.JSONDecoderError – כשניתוח התשובה נכשל.

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

הסרת תג של פנייה.

פרמטרים

פרמטרים
`chronicle_soar`	`ChronicleSOAR` אובייקט Google SecOps SDK.
`case_id`	`int` מספר הפנייה ב-Google SecOps.
`tag`	`str` תג להסרה.
`alert_identifier`	`str \| None` מזהה ההתראה של {The {google_secops_soar_name}}.

מחזירה

אין.

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

None

העלאות

‫requests.HTTPError – כשהשרת מחזיר קוד סטטוס של אי-הצלחה.

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]

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

פרמטרים

פרמטרים
`chronicle_soar`	`ChronicleSOAR` אובייקט Google SecOps SDK.
`attachment_data`	`CaseWallAttachment` אובייקט `CaseWallAttachment`.

מחזירה

מיפוי שניתן לשינוי שמייצג את תגובת ה-API.

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

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

הגדרת העדיפות של ההתראה.

פרמטרים

פרמטרים
`chronicle_soar`	`ChronicleSOAR` אובייקט Google SecOps SDK.
`case_id`	`int` מספר הפנייה ב-Google SecOps.
`alert_identifier`	`str` מזהה ההתראה ב-Google SecOps.
`alert_name`	`str` שם ההתראה ב-Google SecOps.
`priority`	`int` ערך ה-enum של העדיפות ב-Google SecOps.

מחזירה

אין.

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

None

העלאות

‫requests.HTTPError – כשהשרת מחזיר קוד סטטוס של אי-הצלחה.

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]

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

פרמטרים

פרמטרים
`chronicle_soar`	`ChronicleSOAR` אובייקט Google SecOps SDK.
`case_score_mapping`	`list[dict[str, int \| float]]` מיפוי של מספר תיק ב-Google SecOps לציון.

מחזירה

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

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

MutableMapping[str, Any]

העלאות

‫requests.HTTPError – כשהשרת מחזיר קוד סטטוס של אי-הצלחה.

דוגמה

{
  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

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

פרמטרים

פרמטרים
`chronicle_soar`	`ChronicleSOAR` אובייקט Google SecOps SDK.
`parent`	`str` נתיב ההורה של ערך השדה בהתאמה אישית, לדוגמה: ‫`cases/1`, ‏`cases/1/alerts/1`.
`custom_field_id`	`int` מזהה השדה המותאם אישית.
`values`	`list[str]` רשימה של ערכים של שדות מותאמים אישית להגדרה.

מחזירה

אובייקט CustomFieldValue.

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

CustomFieldValue

TIPCommon.rest.soar_api.validate_response

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

הפונקציה מאמתת את התגובה ומחזירה אותה כ-JSON.

פרמטרים
`response`	`requests.Response` התשובה לאימות.

העלאות

‫HTTPError – כשקוד הסטטוס של התגובה מציין כשל.

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