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

Membangun objek kredensial dari akun layanan, email identitas workload, atau atribut akun layanan.

Catatan user_service_account, target_principal, atau service_account_attr (menggunakan **kwargs) harus diberikan. Jika tidak, pengecualian EmptyMandatoryValues akan dimunculkan.

Parameter

Parameter
user_service_account SingleJson | None

JSON akun layanan pengguna.
target_principal str | None

Email workload identity.
source_credentials google.auth.Credentials | None

Kredensial sumber yang digunakan untuk mendapatkan kredensial yang di-impersonate.

Jika None diberikan, sistem akan mencoba menggunakan kredensial default aplikasi.
quota_project_id str | None

ID project yang digunakan untuk kuota dan penagihan.
scopes list[str]

Cakupan kredensial Google Cloud . Nilai defaultnya adalah ['https://www.googleapis.com/auth/cloud-platform'].
verify_ssl bool

Tentukan apakah akan memverifikasi sertifikat SSL.

Nilai defaultnya adalah True.
service_account_attr dict[str, Any]

Pasangan nilai kunci dari kolom akun layanan yang di-destrukturisasi.

Meningkatkan

EmptyMandatoryValues – Jika tidak ada email akun layanan atau workload identity, atau jika kolom wajib diisi untuk akun layanan tidak ada. google.auth.exceptions.RefreshError – Saat kredensial tidak dapat diperbarui.

Hasil

Objek kredensial.

Jenis hasil yang ditampilkan

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

Membangun objek kredensial dari atribut akun layanan.

Parameter

Parameter
account_type str

Jenis akun layanan.
project_id str

Project ID akun layanan.
private_key_id str

ID kunci pribadi akun layanan.
private_key str

Kunci pribadi akun layanan.
client_email str

Email klien akun layanan.
client_id str

ID klien akun layanan.
auth_uri str

URI autentikasi akun layanan.
token_uri str

URI token akun layanan.
auth_provider_x509_url str

URL sertifikat x509 penyedia autentikasi akun layanan.
client_x509_cert_url str

URL sertifikat x509 klien akun layanan.
scopes list[str], optional

Cakupan kredensial Google Cloud . Nilai defaultnya adalah ['https://www.googleapis.com/auth/cloud-platform'].
quota_project_id str | None

ID project yang digunakan untuk kuota dan penagihan.

Meningkatkan

EmptyMandatoryValues – Jika kolom wajib diisi untuk akun layanan tidak ada.

Hasil

Objek kredensial.

Jenis hasil yang ditampilkan

service_account.Credentials

TIPCommon.rest.auth.generate_jwt_from_credentials

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

Membuat Token Web JSON untuk mengakses Google Cloud resource API menggunakan REST.

Parameter

Parameter
credentials google.oauth2.credentials.Credentials

Objek google.oauth2.credentials.Credentials.
verify_ssl bool

Menentukan apakah akan memperbarui token kredensial melalui SSL.

Nilai defaultnya adalah True.

Hasil

Token JWT yang akan digunakan di header Authorization.

Jenis hasil yang ditampilkan

bytes

TIPCommon.rest.auth.generate_jwt_from_sa

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

Membuat Token Web JSON untuk mengakses Google Cloud resource API menggunakan REST.

Parameter
service_account str | dict

Google Cloud akun layanan project dengan peran Identity and Access Management yang diperlukan.
expiry_length int

Waktu yang ditetapkan hingga masa berlaku token berakhir dalam detik. Nilai defaultnya adalah 1 jam.
audience str

Google Cloud cakupan. Jika tidak diberikan, akan kembali ke https://www.googleapis.com/auth/cloud-platform.

Hasil

Token JWT yang akan digunakan di header otorisasi.

Jenis hasil yang ditampilkan

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]

Mendapatkan Kredensial Default Aplikasi (ADC) dari lingkungan runtime. Ini adalah fungsi wrapper untuk google.auth.default.

Parameter

Parameter
scopes Sequence[str] | None

Daftar cakupan untuk kredensial.

Jika ditentukan, kredensial akan otomatis dicakup jika diperlukan.
request google.auth.transport.Request | None

Objek yang digunakan untuk membuat permintaan HTTP. Ini digunakan untuk mendeteksi apakah aplikasi berjalan di Compute Engine atau untuk menentukan ID project terkait untuk resource workload identity pool (kredensial akun eksternal).

Jika tidak ditentukan, library ini akan menggunakan klien HTTP library standar untuk kredensial Compute Engine atau klien google.auth.transport.requests.Request untuk kredensial akun eksternal.
quota_project_id str | None

ID project yang digunakan untuk kuota dan penagihan.

Hasil

Kredensial dan project ID lingkungan saat ini. Project ID mungkin berupa None, yang menunjukkan bahwa Project ID tidak dapat dipastikan dari lingkungan.

Jenis hasil yang ditampilkan

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

Meningkatkan

google.auth.exceptions.DefaultCredentialsError – Jika tidak ada kredensial yang ditemukan, atau jika kredensial yang ditemukan tidak valid.

TIPCommon.rest.auth.get_auth_request

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

Membuat permintaan HTTP yang sah ke API resource Google Cloud .

Parameter

Parameter
verify_ssl bool, optional

Memverifikasi sertifikat SSL. Nilai defaultnya adalah True.

Hasil

Objek permintaan yang sah.

Jenis hasil yang ditampilkan

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

Mendapatkan objek Kredensial berumur pendek menggunakan Peniruan Identitas Akun Layanan Google Cloud .

Parameter

Parameter
target_principal str

Akun layanan yang akan ditiru identitasnya.
source_credentials google.auth.Credentials | None

Kredensial sumber yang digunakan untuk mendapatkan kredensial yang di-impersonate.

Jika tidak ada yang diberikan, sistem akan mencoba menggunakan kredensial default aplikasi.
target_scopes Sequence[str] | None

Cakupan yang akan diminta selama pemberian otorisasi.

Jika None diberikan, cakupan https://www.googleapis.com/auth/cloud-platform default akan digunakan.
delegates Sequence[str] | None

Daftar berantai penerima yang diperlukan untuk memberikan token akses akhir.

Jika disetel, urutan identitas harus memiliki kemampuan Service Account Token Creator yang diberikan kepada identitas sebelumnya.

Misalnya, jika disetel ke [serviceAccountB, serviceAccountC], source_credential harus memiliki peran Pembuat Token di serviceAccountB. serviceAccountB harus memiliki Pembuat Token di serviceAccountC. Terakhir, C harus memiliki Pembuat Token di target_principal.

Jika tidak ditetapkan, source_credential harus memiliki peran tersebut di target_principal.
quota_project_id str | None

ID project yang digunakan untuk kuota dan penagihan.

Catatan: Project ini mungkin berbeda dengan project yang digunakan untuk membuat kredensial.

Hasil

Objek Kredensial dengan masa berlaku singkat dari prinsipal target.

Jenis hasil yang ditampilkan

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

Mendapatkan kredensial akun layanan berjangka pendek tenant SIEM dari instance Google SecOps.

Parameter

Parameter
chronicle_soar TIPCommon.types.ChronicleSOAR

Objek SDK Google Security Operations SOAR.
target_scopes Sequence[str] | None

Cakupan yang akan diminta selama pemberian otorisasi.
quota_project_id str | None

ID project yang digunakan untuk kuota dan penagihan.

Catatan: Project ini mungkin berbeda dengan project yang digunakan untuk membuat kredensial.

Hasil

Kredensial akun layanan berumur pendek tenant SIEM.

Jenis hasil yang ditampilkan

impersonated_credentials.Credentials

class TIPCommon.rest.gcp.GcpErrorReason

class TIPCommon.rest.gcp.GcpErrorReason

Dasar: object

Namespace konstanta Google Cloud Error Reason.

Konstanta

  • IAM_PERMISSION_DENIED = 'IAM_PERMISSION_DENIED'

class TIPCommon.rest.gcp.GcpPermissions

class TIPCommon.rest.gcp.GcpPermissions

Dasar: object

Namespace konstanta Google Cloud Permissions.

Konstanta

  • 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

Mengekstrak project ID dari email akun layanan.

Parameter

Parameter
service_account_email str

Email akun layanan.

Hasil

Project ID.

Jenis hasil yang ditampilkan

str

Meningkatkan

NotFoundError – Jika tidak dapat mengurai nama project dari email 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

Mengekstrak project ID dari kunci JSON akun layanan.

Parameter

Parameter
service_account_json SingleJson

Kunci JSON Akun Layanan.

Hasil

Kolom Project ID dari kunci akun layanan.

Jenis hasil yang ditampilkan

str

Meningkatkan

NotFoundError – Jika tidak dapat menemukan kolom "project_id" di kunci Akun Layanan.

TIPCommon.rest.gcp.get_http_client

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

Mendapatkan klien HTTP yang Google Cloud Authorized.

Parameter

Parameter
credentials service_account.Credentials

Objek A Google Cloud Credentials.
verify_ssl bool, opsional

Memverifikasi sertifikat SSL. Nilai defaultnya adalah True.

Hasil

Klien HTTP yang diizinkan.

Jenis hasil yang ditampilkan

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

Mengambil email akun layanan Workload dari server metadata Google Cloud .

Parameter

Parameter
default_sa_to_return str | None

Akun layanan default yang akan ditampilkan jika tidak ditemukan.

Nilai defaultnya adalah None.

Hasil

Email akun layanan Workload.

Jenis hasil yang ditampilkan

str

Meningkatkan

GoogleCloudException – Jika tidak dapat memperoleh email Akun layanan GCP Workload.

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

Mendapatkan ID project dari email akun layanan atau Workload Identity.

Parameter

Parameter
user_service_account SingleJson | None

JSON akun layanan pengguna.
service_account_email str | None

Email workload identity.
default_project_id str | None

Project ID default yang akan ditampilkan jika tidak ditemukan.

Jika diberikan, fungsi ini tidak akan memunculkan NotFoundError.

Nilai defaultnya adalah None.

Hasil

Project ID akun layanan atau email identitas beban kerja. Jika tidak ditemukan, None akan ditampilkan.

Jenis hasil yang ditampilkan

str | None

Meningkatkan

NotFoundError – Jika nama project tidak dapat diuraikan dari email SA.

TIPCommon.rest.gcp.validate_impersonation

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

Memvalidasi peniruan identitas Akun Layanan dari respons yang diotorisasi HTTP.

Parameter

Parameter
content dict

Konten respons yang diberi otorisasi HTTP.
default_error_msg str, optional

Pesan error yang akan muncul jika tidak ditemukan dalam konten respons.

Nilai defaultnya adalah "Service Account Impersonation failed".

Hasil

None jika peniruan identitas Akun Layanan diizinkan.

Jenis hasil yang ditampilkan

None

Meningkatkan

ImpersonationUnauthorizedError – Jika peniruan identitas Akun Layanan tidak diotorisasi.

TIPCommon.rest.httplib.get_auth_session

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

Membuat sesi HTTP yang diotorisasi ke API resource Google Cloud .

Parameter
service_account str | dict

Akun layanan project Google Cloud dengan peran Identity and Access Management yang diperlukan.
audience str

Cakupan Google Cloud .
verify_ssl bool

Menentukan apakah akan membuat sesi dengan enkripsi SSL.

Hasil

Objek sesi yang sah.

Jenis hasil yang ditampilkan

requests.Session

Meningkatkan

ValueError - Jika kredensial dan akun layanan tidak diberikan.

exception TIPCommon.rest.soar_api.SoarApiServerError

Dasar: Pengecualian

Error dari panggilan API SOAR Google Security Operations ke 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]

Mengelompokkan nilai kolom kustom yang ditetapkan.

Parameter

Parameter
chronicle_soar Objek Google Security Operations SOAR SDK.
identifier int

ID induk.
parent str

Jalur induk untuk nilai kolom kustom (misalnya, cases/1, cases/1/alerts/1).
custom_fields_values_mapping dict[int, list[str]]

Pemetaan ID kolom kustom ke nilai.

Hasil

Daftar objek CustomFieldValue.

Jenis hasil yang ditampilkan

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]

Mendapatkan peristiwa pemberitahuan tertentu.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Objek Google Security Operations SOAR SDK.
case_id str | int

ID kasus. Contoh: 13, "41".
alert_identifier str

ID pemberitahuan (misalnya, '{alert.name}_{alert.id}').

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

Hasil

JSON respons permintaan. Daftar JSON acara.

Jenis hasil yang ditampilkan

list[SingleJson]

Meningkatkan

requests.HTTPError – Saat server menampilkan kode status yang tidak berhasil. json.JSONDecodeError – Jika nilai yang ditampilkan bukan JSON yang valid.

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]

Mendapatkan lampiran kasus.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Objek Google Security Operations SOAR SDK.
case_id int

ID kasus Google Security Operations SOAR.

Hasil

Pemetaan yang dapat diubah yang mewakili lampiran kasus.

Jenis hasil yang ditampilkan

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

Mendapatkan detail ringkasan kasus menurut ID kasus.

Parameter
chronicle_soar ChronicleSOAR

Objek Google Security Operations SDK.
case_id int | str

ID kasus Google Security Operations SOAR.

Hasil

Objek detail kasus.

Jenis hasil yang ditampilkan

(CaseDetails)

Meningkatkan

requests.HTTPError - Jika permintaan gagal atau status permintaan bukan 200. json.JSONDecoderError - Jika penguraian respons gagal.

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]

Mendapatkan semua kartu konektor.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Objek Google Security Operations SOAR SDK.
integration_name str | None

Nama integrasi.
connector_identifier str | None

ID konektor.

Hasil

Daftar semua kartu konektor.

Jenis hasil yang ditampilkan

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]

Mengambil data entitas.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Objek Google Security Operations SOAR SDK.
entity_identifier int

ID entitas.
entity_environment str

Lingkungan entity.
entity_type str

Jenis entitas.
last_case_type int

Jenis kasus terakhir.
case_distribution_type int

Jenis distribusi kasus.

Hasil

Pemetaan yang dapat diubah yang merepresentasikan data entity.

Jenis hasil yang ditampilkan

dict

Meningkatkan

requests.HTTPError – Saat server menampilkan kode status yang tidak berhasil.

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

Mengambil daftar file definisi tindakan lingkungan.

Parameter
chronicle_soar ChronicleSOAR

Objek Google SecOps SDK.

Hasil

Daftar objek SingleJson yang merepresentasikan file definisi tindakan.

Jenis hasil yang ditampilkan

(list[SingleJson])

Meningkatkan

requests.HTTPError - Saat server menampilkan kode status yang tidak berhasil. json.JSONDecodeError – Jika nilai yang ditampilkan bukan JSON yang valid.

TIPCommon.rest.soar_api.get_federation_cases

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

Mendapatkan kasus federasi.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Objek Google Security Operations SOAR SDK.

Hasil

Respons JSON.

Jenis hasil yang ditampilkan

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]

Mendapatkan detail kasus lengkap.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Objek Google Security Operations SOAR SDK.
case_id int

ID kasus Google Security Operations SOAR.

Hasil

Pemetaan yang dapat diubah yang merepresentasikan detail kasus lengkap.

Jenis hasil yang ditampilkan

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]

Mengambil semua integrasi yang diinstal untuk lingkungan yang disediakan.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Objek Google Security Operations SOAR SDK.
environment str

Daftar lingkungan instance.
integration_identifier str | None

ID integrasi.

Hasil

Daftar objek kamus yang merepresentasikan instance integrasi.

Jenis hasil yang ditampilkan

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

Mengambil daftar file definisi tindakan lingkungan.

Parameter
chronicle_soar ChronicleSOAR

Objek Google SecOps SDK.

Hasil

Daftar objek SingleJson yang merepresentasikan file definisi tindakan.

Jenis hasil yang ditampilkan

(list[SingleJson])

Meningkatkan

requests.HTTPError - Saat server menampilkan kode status yang tidak berhasil. json.JSONDecodeError – Jika nilai yang ditampilkan bukan JSON yang valid.

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]

Mengambil file detail lengkap integrasi.

Parameter
chronicle_soar ChronicleSOAR

Objek Google SecOps SDK.
integration_identifier str

ID integrasi.

Hasil

Respons JSON yang berisi detail lengkap integrasi.

Jenis hasil yang ditampilkan

(SingleJSON)

Meningkatkan

requests.HTTPError - Saat server menampilkan kode status yang tidak berhasil. json.JSONDecodeError – Jika nilai yang ditampilkan bukan JSON yang valid.

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]

Mengambil kartu profil pengguna menurut halaman dan filter.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Objek Google Security Operations SOAR SDK.
search_term str

Istilah penelusuran.
requested_page int

Offset awal untuk menampilkan halaman pengguna.
page_size int

Jumlah pengguna yang akan ditampilkan.
filter_by_role bool

Tentukan apakah akan mengecualikan menurut peran.
filter_disabled_users bool

Tentukan apakah pengguna yang dinonaktifkan akan difilter.
filter_support_users bool

Tentukan apakah pengguna dukungan harus difilter.
fetch_only_support_users bool

Menentukan apakah hanya pengguna dukungan yang akan ditampilkan.
filter_permission_types list[int] | None

Daftar jenis izin filter (misalnya, 0).

Hasil

Respons dari server SOAR - kartu profil pengguna.

Jenis hasil yang ditampilkan

SingleJson

Meningkatkan

requests.HTTPError – Saat server menampilkan kode status yang tidak berhasil. json.JSONDecodeError – Jika nilai yang ditampilkan bukan JSON yang valid.

Contoh

Contoh JSON respons:

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

Mendapatkan kartu instance alur kerja.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Objek Google Security Operations SOAR SDK.
case_id int

ID kasus Google Security Operations SOAR.
alert_identifier str

ID pemberitahuan Google Security Operations SOAR.

Hasil

Pemetaan yang dapat diubah yang merepresentasikan kartu instance alur kerja.

Jenis hasil yang ditampilkan

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]

Mendapatkan nilai kolom kustom untuk kasus atau pemberitahuan.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Objek Google Security Operations SOAR SDK.
parent str

Jalur induk untuk nilai kolom kustom (misalnya: cases/1, cases/1/alerts/1).

Hasil

Objek detail kasus.

Jenis hasil yang ditampilkan

list[CustomFieldValue]

Meningkatkan

requests.HTTPError – Jika permintaan gagal atau status permintaan bukan 200. json.JSONDecoderError – Jika penguraian respons gagal.

TIPCommon.rest.soar_api.list_custom_fields

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

Mencantumkan kolom kustom.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Objek Google Security Operations SOAR SDK.
filter_ str | None

Nilai filter untuk penelusuran.

Hasil

Objek detail kasus.

Jenis hasil yang ditampilkan

list[CustomField]

Meningkatkan

requests.HTTPError – Jika permintaan gagal atau status permintaan bukan 200. json.JSONDecoderError – Jika penguraian respons gagal.

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

Menghapus tag kasus.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Objek Google Security Operations SOAR SDK.
case_id int

ID kasus Google Security Operations SOAR.
tag str

Tag yang akan dihapus.
alert_identifier str | None

ID pemberitahuan {google_secops_soar_name}.

Hasil

Tidak ada.

Jenis hasil yang ditampilkan

None

Meningkatkan

requests.HTTPError – Saat server menampilkan kode status yang tidak berhasil.

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]

Menyimpan file langsung ke dinding casing.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Objek Google Security Operations SOAR SDK.
attachment_data CaseWallAttachment

Objek CaseWallAttachment.

Hasil

Pemetaan yang dapat diubah yang merepresentasikan respons API.

Jenis hasil yang ditampilkan

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

Menetapkan prioritas pemberitahuan.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Objek Google Security Operations SOAR SDK.
case_id int

ID kasus Google Security Operations SOAR.
alert_identifier str

ID pemberitahuan Google Security Operations SOAR.
alert_name str

Nama pemberitahuan Google Security Operations SOAR.
priority int

Nilai enum prioritas Google Security Operations SOAR.

Hasil

Tidak ada.

Jenis hasil yang ditampilkan

None

Meningkatkan

requests.HTTPError – Saat server menampilkan kode status yang tidak berhasil.

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]

Menetapkan skor kasus secara massal.

Parameter

Parameter
chronicle_soar ChronicleSOAR

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

Pemetaan ID kasus Google Security Operations SOAR ke Skor.

Hasil

JSON respons yang berisi status keberhasilan dan, jika berlaku, daftar kasus yang gagal.

Jenis hasil yang ditampilkan

MutableMapping[str, Any]

Meningkatkan

requests.HTTPError – Saat server menampilkan kode status yang tidak berhasil.

Contoh

{
  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

Menetapkan nilai kolom kustom.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Objek Google Security Operations SOAR SDK.
parent str

Jalur induk untuk nilai kolom kustom, misalnya: cases/1, cases/1/alerts/1.
custom_field_id int

ID kolom kustom.
values list[str]

Daftar nilai kolom kustom yang akan ditetapkan.

Hasil

Objek CustomFieldValue.

Jenis hasil yang ditampilkan

CustomFieldValue

TIPCommon.rest.soar_api.validate_response

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

Memvalidasi respons dan menampilkannya sebagai JSON.

Parameter
response requests.Response

Respons yang akan divalidasi.

Meningkatkan

HTTPError - Saat kode status respons menunjukkan kegagalan.

Perlu bantuan lain? Dapatkan jawaban dari anggota Komunitas dan profesional Google SecOps.