Halaman ini diterjemahkan oleh Cloud Translation API.

Modul Siemplify

class `Siemplify.Siemplify`

Dasar: SiemplifyBase

Endpoint: external/v1/sdk/CaseFullDetails

add_agent_connector_logs

add_agent_connector_logs(agent_id, connector_id, logs_package)

Tambahkan log konektor connector_id remote agent.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
agent_id	{string}	ID agen	T/A	T/A
connector_id	{string}	ID instance konektor	T/A	T/A
logs_package	{dict}	ConnectorLogPackage	T/A	T/A

add_attachment

add_attachment(file_path, case_id, alert_identifier, description=None, is_favorite=False)

Fungsi ini menambahkan entri ke dinding kasus dengan lampiran file (yang kemudian dapat didownload dari klien ke komputer lokal pengguna). Fungsi ini pada dasarnya melakukan hal yang sama seperti menambahkan bukti (di bagian bawah layar ringkasan kasus).

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
file_path	{string}	Jalur untuk file	Jalur yang dapat diakses	Jalur juga dapat berupa lokasi jarak jauh. Anda memerlukan izin baca untuk file tersebut
case_id	{string}	ID kasus	ID kasus untuk menambahkan lampiran ke repositori kasusnya	Defaultnya adalah kasus saat ini
alert_identifier	{string}	ID notifikasi	String ID notifikasi yang ingin Anda kaitkan dengan lampiran	Defaultnya adalah peringatan yang sedang berjalan
deskripsi	{string}	Deskripsi lampiran	String apa pun	Tidak ada secara default. Parameter opsional.
is_favorite	{boolean}	Favorit lampiran	Benar/Salah	`False` secara default. Parameter opsional.

Hasil

{long} attachment_id

Contoh

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
siemplify.add_attachment(r'C:/temp/investigation.txt', description='Deep investigation report by TIER3 team', is_favorite=True)

Perilaku hasil

Dalam contoh ini, kita akan mengupload investigation.txt dari C:/temp di mesin lokal (server itu sendiri) ke dinding galeri. Komentar akan ditambahkan ke entri tersebut di dinding kasus, dengan string dalam deskripsi. Flag is_favorite ditetapkan ke True, sehingga entri baru ini juga akan dibintangi (favorit).

add_comment

add_comment(comment, case_id, alert_identifier)

Tambahkan komentar baru ke kasus tertentu.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
komentar	{string}	Komentar yang akan ditambahkan ke repositori kasus	"Peristiwa dalam notifikasi ini tampak mencurigakan"	Komentar terkait kasus
case_id	{string}	ID kasus	234	T/A
alert_identifier	{string}	ID notifikasi	ad6879f1-b72d-419f-990c-011a2526b16d	T/A

Hasil

NoneType

Contoh

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
add_comment = "This alert is important"
alert_identifier = "ad6879f1-b72d-419f-990c-011a2526b16d"
case_id = "234"
siemplify.add_comment(comment, case_id, alert_identifier)

Perilaku hasil

Komentar yang diberikan akan ditambahkan ke kasus 234.

Nilai hasil

Tidak ada

add_entities_to_custom_list

add_entities_to_custom_list(custom_list_items)

Tambahkan daftar kustom yang disediakan dengan entitas yang ditambahkan ke daftar kustom.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
custom_list_items	{string}	Daftar item daftar kustom	T/A	T/A

Hasil

{[CustomList]} daftar dengan item daftar kustom yang ditambahkan.

Perilaku hasil

Entitas ditambahkan ke kategori daftar kustom.

add_entity_insight

add_entity_insight(domain_entity_info, message, case_id, alert_id)

Tambahkan insight entitas.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
domain_entity_info	{string}	ID entitas	"192.0.2.1"	{DomainEntityInfo}
pesan	{string}	Pesan insight	Ini adalah DNS Contoh	T/A
case_id	{string}	ID kasus yang akan ditambahkan ke insight entitas	234	T/A
alert_id	{string}	ID pemberitahuan untuk ditambahkan ke insight entitas	ad6879f1-b72d-419f-990c-011a2526b16d	T/A

Hasil

{boolean} True jika berhasil

Contoh

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
entity = "192.0.2.1"
alert_identifier = "ad6879f1-b72d-419f-990c-011a2526b16d"
case_id = "234"
siemplify.add_entity_insight(domain_entity_info=entity, message=message, case_id=case_id, alert_id=alert_identifier)

Perilaku hasil

Pesan yang diberikan ditambahkan sebagai insight ke entitas 192.0.2.1 dari ID pemberitahuan yang diberikan dalam kasus 234.

Nilai hasil

Benar.

Salah (False) jika insight tidak ditambahkan.

add_entity_to_case

add_entity_to_case(case_id, alert_identifier, entity_identifier, entity_type, is_internal, is_suspicious, is_enriched, is_vulnerable, properties, environment)

Menambahkan entitas ke kasus.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
case_id	{string}	ID kasus	234	T/A
alert_identifier	{string}	ID notifikasi	ad6879f1-b72d-419f-990c-011a2526b16d	T/A
entity_identifier	{string}	ID entitas	192.0.2.1, example.com	T/A
entity_type	{string}	Jenis entitas dari ID entitas	"ADDRESS"	T/A
is_internal	{boolean}	T/A	Benar/Salah	T/A
is_suspicious	{boolean}	T/A	Benar/Salah
is_enriched	{boolean}	T/A	Benar/Salah	Salah secara default
is_vulnerable	{boolean}	T/A	Benar/Salah	Salah secara default
properties	{dict}	Properti entitas	{"property":"value"}	T/A
lingkungan	{string}	Salah satu lingkungan yang ditentukan	Contoh lingkungan	T/A

Hasil

NoneType

Contoh

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
case_id = "234"
alert_identifier = "ad6879f1-b72d-419f-990c-011a2526b16d"
entity = "192.0.2.1"
entity_type = "ADDRESS"
properties = {"property": "value"}
siemplify.add_entity_to_case(case_id=case_id,
                                          alert_identifier = alert_identifier,
                                          entity_identifier = entity,
                                          entity_type = entity_type,
                                          is_internal = True,
                                          is_suspicious = False,
                                          is_enriched = False,
                                          is_vulnerable = False,
                                          properties = properties,
                                          environment=None)

Perilaku hasil

Entitas dengan informasi yang diberikan akan ditambahkan ke pemberitahuan yang diberikan dalam kasus 234.

Nilai hasil

Tidak ada

add_or_update_case_task

add_or_update_case_task(task)

Menambahkan atau memperbarui kasus tugas: perbarui jika ada ID tugas, tambahkan (buat) jika tidak ada.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
task	{Task}	Objek tugas yang harus ditambahkan ke atau diperbarui dalam kasus	T/A	T/A

Hasil

{int} ID tugas baru atau yang diperbarui.

add_tag

add_tag(tag, case_id, alert_identifier)

Menambahkan tag baru ke kasus tertentu.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
tag	{string}	Tag yang akan ditambahkan	T/A	T/A
case_id	{string}	ID kasus	234	T/A
alert_identifier	{string}	ID notifikasi	ad6879f1-b72d-419f-990c-011a2526b16d	T/A

any_entity_in_custom_list

any_entity_in_custom_list(custom_list_items)

Periksa apakah ada entity dari daftar yang diberikan, yang memiliki rekaman daftar kustom dengan kategori yang diberikan.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
custom_list_items	{[CustomList]}	Daftar item daftar kustom untuk memeriksa entitas	T/A	T/A

Hasil

{boolean} True jika ada entitas yang ditemukan, False jika tidak.

Nilai hasil

Benar atau Salah

assign_case

assign_case(user, case_id, alert_identifier)

Fungsi ini menetapkan kasus saat ini kepada pengguna.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
pengguna	{string}	Pengguna/peran	Admin, @Tier1	T/A
case_id	{string}	ID kasus untuk menetapkan pengguna	234	T/A
alert_identifier	{string}	ID pemberitahuan untuk menetapkan pengguna	ad6879f1-b72d-419f-990c-011a2526b16d	Nilai ini diambil selama waktu proses tindakan

Hasil

NoneType

Perilaku hasil

Kasus akan ditetapkan kepada pengguna yang ditentukan.

Nilai hasil

Tidak ada

attach_workflow_to_case

attach_workflow_to_case(workflow_name, cyber_case_id, indicator_identifier)

Lampirkan playbook ke kasus.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
workflow_name	{string}	Nama alur kerja	T/A	T/A
cyber_case_id	{string}	ID kasus	234	T/A
indicator_identifier	{string}	ID notifikasi	ad6879f1-b72d-419f-990c-011a2526b16d	T/A

Hasil

{string} kode status operasi server

Contoh

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
alert_identifier = "ad6879f1-b72d-419f-990c-011a2526b16d"
case_id = "234"
workflow_name = "Workflow 234"
siemplify.attach_workflow_to_case(workflow_name=workflow_name, cyber_case_id=case_id, indicator_identifier=alert_identifier)

Perilaku hasil

Alur kerja 234 akan dilampirkan ke kasus 234.

Nilai hasil

Tidak ada

batch_update_case_id_matches

batch_update_case_id_matches(case_id_matches)

Update massal kasus dengan ID kasus eksternal yang sesuai.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
case_id_matches	{list}	Daftar objek SyncCaseIdMatch

Hasil

{list} Daftar ID kasus yang berhasil diperbarui.

change_case_priority

change_case_priority(priority, case_id, alert_identifier)

Ubah prioritas kasus.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
priority	{int}	Prioritas kasus yang akan diubah	40/60/80/100	Lihat ApiSyncCasePriorityEnum. Pemetaan prioritas: {"Rendah": 40, "Sedang": 60, "Tinggi": 80, "Kritis": 100}
case_id	{string}	ID kasus	234	T/A
alert_identifier	{string}	ID notifikasi	ad6879f1-b72d-419f-990c-011a2526b16d	T/A

Hasil

NoneType

Contoh

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
priority = 40
alert_identifier = "ad6879f1-b72d-419f-990c-011a2526b16d"
case_id = "234"
siemplify.change_case_priority(priority=priority, case_id=case_id, alert_identifier=alert_identifier)

Perilaku hasil

Prioritas kasus 234 diubah menjadi 40, yang dipetakan ke rendah.

Nilai hasil

Tidak ada

change_case_stage

change_case_stage(stage, case_id, alert_identifier)

Ubah tahap kasus.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
tahap	{string}	Tahap kasus saat ini.	Insiden	T/A
case_id	{string}	ID kasus	T/A	T/A
alert_identifier	{string}	ID notifikasi	ad6879f1-b72d-419f-990c-011a2526b16d	T/A

check_marketplace_status

check_marketplace_status()

Periksa status marketplace.
Jika tidak ada error, fungsi akan menampilkan none. Jika tidak, pengecualian akan ditampilkan.

Parameter

T/A

Hasil

Tidak ada

close_alert

close_alert(root_cause, comment, reason, case_id, alert_id)

Fungsi ini menutup pemberitahuan saat ini. Tindakan ini sama dengan menutup pemberitahuan secara manual dari ringkasan kasus. Fungsi ini memerlukan alasan penutupan, penyebab utama, dan komentar, seperti halnya pemberitahuan penutupan kasus.
Menutup pemberitahuan akan menutup kasus baru dengan hanya satu pemberitahuan.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
root_cause	{string}	Penyebab utama penutupan kasus	T/A	T/A
komentar	{string}	Komentar	T/A	T/A
alasan	{ApiSyncAlertCloseReasonEnum}	T/A	T/A	Lihat SiemplifyDataModel.ApiSyncAlertCloseReasonEnum
case_id	{string}	ID kasus yang berisi pemberitahuan	234	T/A
alert_id	{string}	ID pemberitahuan yang akan ditutup	ad6879f1-b72d-419f-990c-011a2526b16d	T/A

Hasil

{dict} hasil operasi server

close_case

close_case(root_cause, comment, reason, case_id, alert_identifier)

Menutup kasus.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
root_cause	{string}	Penyebab utama penutupan kasus	T/A	T/A
komentar	{string}	Komentar	T/A	T/A
alasan	{ApiSyncAlertCloseReasonEnum}	Alasan penutupan kasus		Lihat SiemplifyDataModel.ApiSyncAlertCloseReasonEnum
case_id	{string}	ID kasus	234	T/A
alert_id	{string}	ID notifikasi	ad6879f1-b72d-419f-990c-011a2526b16d	T/A

create_case

create_case(case_info)

Fungsi ini membuat kasus dengan pemberitahuan dan peristiwa yang ada dalam kamus case_info.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
case_info	{CaseInfo}	Objek info kasus	T/A	Lihat `SiemplifyConnectorsDataModel.CaseInfo`

Hasil

NoneType

Perilaku hasil

Kasus dengan data kasus yang diberikan akan dibuat.

Nilai hasil

Tidak ada

create_case_insight_internal

create_case_insight_internal(case_id, alert_identifier, triggered_by, title, content, entity_identifier, severity, insight_type, additional_data=None, additional_data_type=None, additional_data_title=None, original_requesting_user=None, entity_type=None)

Tambahkan insight.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
case_id	{string}	ID kasus	234	T/A
alert_identifier	{string}	ID notifikasi	ad6879f1-b72d-419f-990c-011a2526b16d	T/A
triggered_by	{string}	Nama integrasi	T/A	T/A
title	{string}	Judul insight	T/A	T/A
konten	{string}	Pesan insight	T/A	T/A
entity_identifier	{string}	ID entitas	T/A	T/A
tingkat keseriusan,	{int}	ID tingkat keparahan	0 = info, 1 = peringatan, 2 = error	T/A
insight_type	{int}	Jenis insight	0 = umum, 1 = entitas	T/A
additional_data	T/A	T/A	T/A	T/A
additional_data_type	T/A	T/A	T/A	T/A
additional_data_title	T/A	T/A	T/A	T/A
original_requesting_user	T/A	T/A	T/A	T/A
entity_type	{string}	Jenis entitas	"ADDRESS"	T/A

Hasil

{boolean} True jika berhasil.

create_connector_package

create_connector_package(connector_package)

Buat paket konektor dalam sistem.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
connector_package	{string}	Paket konektor sebagai json	T/A	T/A

dismiss_alert

dismiss_alert(alert_group_identifier, should_close_case_if_all_alerts_were_dismissed, case_id)

selesai

end(message, result_value, execution_state=0)

Akhiri skrip.
Tidak ada kode lain setelah fungsi end() yang dieksekusi.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
pesan	{string}	Pesan output yang akan ditampilkan kepada klien	Tindakan selesai	T/A
result_value	{int/string/dict}	Nilai yang ditampilkan	T/A	T/A
execution_state	{int}	Indikator untuk status tindakan saat ini. Terutama digunakan dalam tindakan asinkron untuk menandai apakah tindakan telah selesai atau belum.	0 (EXECUTION_STATE_COMPLETED), 1 (EXECUTION_STATE_INPROGRESS), 2 (EXECUTION_STATE_FAILED), 3 (EXECUTION_STATE_TIMEDOUT)	Defaultnya adalah 0

Hasil

Mengembalikan data hasil ke proses host.

Penting: Jika fungsi akhir tidak dipanggil, skrip akan menampilkan error berikut:

Script did not return expected data. Did you call
  build_result/end_script? Check DebugOutput for details.

end_script

end_script()

escalate_case

escalate_case(comment, case_id, alert_identifier)

Eskalasikan kasus.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
komentar	{string}	Mengirimkan komentar ke eskalasi	T/A	T/A
case_id	{string}	ID kasus	234	T/A
alert_identifier	{string}	ID notifikasi	ad6879f1-b72d-419f-990c-011a2526b16d	T/A

extract_configuration_param

extract_configuration_param(provider_name, param_name, default_value=None, input_type=<class 'str'>, is_mandatory=False, print_value=False)

Mendapatkan parameter konfigurasi dari instance integrasi.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
provider_name	{string}	Nama integrasi	T/A	T/A
param_name	{string}	Nama parameter	T/A	T/A
default_value	{any}	Jika parameter tidak diteruskan, gunakan nilai ini secara default	T/A	Tidak ada secara default (opsional)
input_type	{obj}	Mentransmisikan parameter ke jenis yang berbeda	T/A	Misalnya, int. str secara default (opsional)
is_mandatory	{bool}	Memunculkan pengecualian jika parameter kosong	T/A	`False` secara default (opsional)
print_value	{bool}	Mencetak nilai ke log	T/A	`False` secara default (opsional)

Hasil

Nilai parameter (string secara default), kecuali jika input_type ditentukan.

static generate_serialized_object

generate_serialized_object(object_filter)

get_agent_by_id

get_agent_by_id(agent_id)

Mendapatkan detail agen berdasarkan ID.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
agent_id	{str}	ID agen	T/A	T/A

Hasil

{dict} Detail penayang

get_alerts_ticket_ids_from_cases_closed_since_timestamp

get_alerts_ticket_ids_from_cases_closed_since_timestamp(timestamp_unix_ms, rule_generator)

Mendapatkan pemberitahuan dari kasus yang ditutup sejak stempel waktu.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
timestamp_unix_ms	{long}	Stempel waktu	1550409785000L	T/A
rule_generator	{string}	T/A	'Detektor email phishing'	T/A

Hasil

Pemberitahuan {list}

get_attachment

get_attachment(attachment_id)

Mendapatkan data lampiran berdasarkan ID.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
attachment_id	{string}	ID lampiran	T/A	T/A

Hasil

Data lampiran {BytesIO}

get_attachments

get_attachments(case_id)

Mendapatkan lampiran dari kasus.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
case_id	{string}	ID kasus	234	T/A

Hasil

{dict} lampiran

Nilai hasil

[{"is_favorite": False, "description": "", "type": ".txt", "id": 1, "name": "test.py"}]

get_case_by_id

get_case_by_id(case_id)

Mendapatkan kasus menggunakan ID kasusnya.

Fungsi ini berinteraksi dengan endpoint berikut: external/v1/sdk/CaseFullDetails

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
case_id	{[string]}	ID kasus	T/A	T/A

Hasil

Data kasus {dict}.

get_case_closure_details

get_case_closure_details(case_id_list)

Mendapatkan detail penutupan kasus.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
case_id_list	{[string]}	Daftar ID kasus	T/A	T/A

Hasil

Daftar {[dict]} dict yang berisi detail penutupan kasus.

Nilai hasil

[{'case_closed_action_type': 1, 'reason': NotMalicious', 'root_cause': 'Other'}]

Untuk parameter case_closed_action_type, kemungkinan nilainya adalah sebagai berikut:

0 = Otomatis
1 = Manual

get_case_comments

get_case_comments(case_id)

Fungsi ini mendapatkan komentar dari kasus yang diberikan.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
case_id	{string}	ID kasus	234	T/A

Hasil

Daftar

Contoh

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
siemplify.get_case_comments(case_id)

Perilaku hasil

Semua komentar yang termasuk dalam kasus akan diambil.

Nilai hasil

[
    {
             u 'comment': u 'Test',
             u 'case_id': 10085,
             u 'is_favorite': False,
             u 'alert_identifier': None,
             u 'creator_user_id': u 'Admin',
             u 'type': 5,
             u 'id': 1,
             u 'modification_time_unix_time_in_ms': 1563272078332L
      }, {
             u 'comment': u 'jhfksdh',
             u 'case_id': 10085,
             u 'is_favorite': False,
             u 'alert_identifier': None,
             u 'creator_user_id': u 'Admin',
             u 'type': 5,
             u 'id': 2,
             u 'modification_time_unix_time_in_ms': 1563272079941L

       }, {
              u 'comment': u 'kjfhsdm',
              u 'case_id': 10085,
              u 'is_favorite': False,
              u 'alert_identifier': None,
              u 'creator_user_id': u 'Admin',
              u 'type': 5,
              u 'id': 3,
               u 'modification_time_unix_time_in_ms': 1563272080598L
       }
 ]

get_case_tasks

get_case_tasks(case_id)

Mengambil semua tugas berdasarkan ID Kasus.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
case_id	{int/str}	ID kasus	234	Fungsi dapat menerima int atau str

Hasil

{[Task]} daftar objek tugas yang termasuk dalam kasus.
Lihat SiemplifyDataModel.Task.

get_cases_by_filter

get_cases_by_filter(environments=None, analysts=None, statuses=None, case_names=None, tags=None, priorities=None, stages=None, case_types=None, products=None, networks=None, ticked_ids_free_search='', case_ids_free_search='', wall_data_free_search='', entities_free_search='', start_time_unix_time_in_ms=-1, end_time_unix_time_in_ms=-1)

Mendapatkan kasus berdasarkan filter yang diminta.

*caseFilterValue* object - { 'Title':'Merged Case', 'Value': 'Merged', 'Title':'Involved Suspicious Entity', 'Value': 'InvolvedSuspiciousEntity', 'Title':'Manual', 'Value': 'Manual', 'Title':'Simulated Alerts', 'Value': 'Simulated',}

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
lingkungan	{[string]}	Daftar nama lingkungan (environment)	T/A	Jika tidak ada lingkungan yang diberikan, `None` akan digunakan (opsional)
analis	{[string]}	Daftar nama analis (pengguna/peran yang ditetapkan untuk kasus),	T/A	Jika tidak ada analis yang diberikan, `None` akan digunakan (opsional)
status	{[int]}	Daftar status yang akan difilter	T/A	Lihat ApiSyncCaseStatusEnum. Jika tidak ada status yang diberikan, `None` akan digunakan (opsional)
case_names	{[string]}	Daftar nama kasus	T/A	Jika tidak ada `case_names` yang diberikan, `None` akan digunakan (opsional)
tags	{[string]}	Daftar tag kasus	T/A	Jika tidak ada tag yang diberikan, `None` akan digunakan (opsional)
prioritas	{[int]}	Daftar prioritas		Lihat ApiSyncAlertPriorityEnum. Jika tidak ada prioritas yang diberikan, `None` akan digunakan (opsional)
tahap	{list}	Daftar tahap (objek caseFilterValue)	T/A	Jika tidak ada tahap yang diberikan, `None` akan digunakan (opsional)
case_types	{list}	Daftar jenis objek (objek caseFilterValue)	T/A	Nilai `case_types` yang valid adalah: `0 = Merged` `1 = Important` `2 = InvolvedSuspiciousEntity` `3 = Manual` `4 = Simulated` Jika tidak ada `case_types` yang diberikan, `None` akan digunakan (opsional)
produk	{list}	Daftar produk (objek caseFilterValue)	T/A	Jika tidak ada produk yang diberikan, `None` akan digunakan (opsional)
networks	{list}	Daftar jaringan (objek caseFilterValue)	T/A	Jika tidak ada jaringan yang disediakan, `None` akan digunakan (opsional)
ticked_ids_free_search	{string}	ID tiket	T/A	Jika tidak diberikan, defaultnya adalah '' (opsional)
case_ids_free_search	{string}	ID kasus	T/A	Jika tidak diberikan, defaultnya adalah '' (opsional)
wall_data_free_search	{string}	String yang akan ditelusuri	T/A	Jika tidak diberikan, defaultnya adalah '' (opsional)
entities_free_search	{string}	ID entitas	T/A	Jika tidak diberikan, defaultnya adalah '' (opsional)
start_time_unix_time_in_ms	{long}	T/A	T/A	Default -1 (opsional)
end_time_unix_time_in_ms	{long}	T/A	T/A	Default -1 (opsional)

Hasil

Case_ids ''

get_cases_by_ticket_id

get_cases_by_ticket_id(ticket_id)

Mendapatkan kasus berdasarkan ID tiket.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
ticket_id	{string}	ID tiket	T/A	T/A

Hasil

Daftar ID kasus {[int]}.

get_cases_ids_by_filter

get_cases_ids_by_filter(status, start_time_from_unix_time_in_ms=None, start_time_to_unix_time_in_ms=None, close_time_from_unix_time_in_ms=None, close_time_to_unix_time_in_ms=None, update_time_from_unix_time_in_ms=None, update_time_to_unix_time_in_ms=None, operator=None, sort_by='START_TIME', sort_order='DESC', max_results=1000)

Mendapatkan ID kasus menurut filter.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
status	{str}	Status kasus yang akan diambil	'OPEN', 'CLOSE', 'BOTH'	T/A
start_time_from_unix_time_in_ms	{int}	Rentang awal waktu mulai kasus inklusif	T/A	Defaultnya adalah 30 hari sebelumnya (opsional)
start_time_to_unix_time_in_ms	{int}	Rentang akhir waktu mulai kasus inklusif	T/A	Default-nya adalah waktu saat ini (opsional)
close_time_from_unix_time_in_ms	{int}	Rentang awal waktu penutupan kasus inklusif	T/A	Defaultnya adalah 30 hari sebelumnya (opsional)
close_time_to_unix_time_in_ms	{int}	Rentang akhir waktu penutupan kasus inklusif.	T/A	Default-nya adalah waktu saat ini (opsional)
update_time_from_unix_time_in_ms	{int}	Rentang awal waktu modifikasi kasus inklusif	T/A	Defaultnya adalah waktu mulai (opsional)
update_time_to_unix_time_in_ms	{int}	Rentang akhir waktu modifikasi kasus inklusif	T/A	Default-nya adalah waktu saat ini (opsional)
operator	{str}	Operator untuk filter waktu	ATAU, DAN	Opsional
sort_by	{str}	Mengurutkan hasil menurut waktu	START_TIME, UPDATE_TIME, CLOSE_TIME	Opsional
sort_order	{str}	Tata urutan	ASC, DESC	Defaultnya adalah urutan menurun (opsional)
max_results	{int}	Jumlah hasil maksimum yang akan ditampilkan	T/A	Nilai default adalah 1.000, nilai maksimum adalah 10.000 (opsional)

get_configuration

get_configuration(provider, environment, integration_instance)

Mendapatkan konfigurasi integrasi.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
penyedia	{string}	Nama integrasi	"VirusTotal"	T/A
lingkungan	{string}	Konfigurasi untuk lingkungan tertentu atau 'semua'	T/A	T/A
integration_instance	{string}	ID instance integrasi	T/A	T/A

Hasil

Detail konfigurasi {dict}.

get_configuration_by_provider

get_configuration_by_provider(identifier)

Mendapatkan konfigurasi integrasi.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
penyedia	{string}	Nama integrasi	"VirusTotal"	T/A

Hasil

Detail konfigurasi {dict}

get_existing_custom_list_categories

get_existing_custom_list_categories()

Mendapatkan semua kategori daftar kustom yang ada.
Fungsi ini menampilkan objek daftar semua kategori dalam setelan CustomList terlepas dari lingkungannya.

Parameter

T/A

Hasil

Daftar {[unicode]} jenis unicode dengan kategori yang ada.

Contoh

from SiemplifyAction import SiemplifyAction siemplify = SiemplifyAction() result = siemplify.get_existing_custom_list_categories()

Perilaku hasil

Daftar semua daftar kustom yang ada akan ditampilkan.

Nilai hasil

["DenyListed IPs", "AllowListed HOSTs"]

get_external_configuration

get_external_configuration(config_provider, config_name)

Mendapatkan konfigurasi integrasi eksternal.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
config_provider	{string}	T/A	T/A	T/A
config_name	{string}	T/A	T/A	T/A

get_integration_version

get_integration_version(integration_identifier)

Mendapatkan versi integrasi.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
integration_identifier	{string}	ID integrasi	T/A	T/A

Hasil

Versi integrasi {float}

get_publisher_by_id

get_publisher_by_id(publisher_id)

Mendapatkan detail penayang menurut ID.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
publisher_id	{string}	ID penayang	T/A	T/A

Hasil

{dict} Detail penayang

get_remote_connector_keys_map

get_remote_connector_keys_map(publisher_id)

Mendapatkan kunci enkripsi konektor jarak jauh menurut ID penayang.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
publisher_id	{string}	ID penayang	T/A	T/A

Hasil

{dict} Peta kunci

get_similar_cases

get_similar_cases(case_id, ports_filter, category_outcome_filter, rule_generator_filter, entity_identifiers_filter, start_time_unix_ms, end_time_unix_ms)

Mendapatkan kasus serupa.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
case_id	{string}	ID kasus	234	T/A
ports_filter	{boolean}	Filter port penggunaan Benar/Salah	Benar/Salah	T/A
category_outcome_filter	{boolean}	Benar/Salah menggunakan filter category_outcome	Benar/Salah	T/A
rule_generator_filter	{boolean}	Benar/Salah menggunakan filter rule_generator	Benar/Salah	T/A
entity_identifiers_filter	{boolean}	Benar/Salah menggunakan filter entity_identifiers	Benar/Salah	T/A
start_time_unix_ms	T/A	T/A	T/A	T/A
end_time_unix_ms	T/A	T/A	T/A	T/A

Hasil

{dict}

get_sync_alerts

get_sync_alerts(alert_group_ids)

Mengambil informasi pemberitahuan yang diperlukan untuk sinkronisasi sistem.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
alert_group_ids	{list}	Daftar ID grup pemberitahuan yang akan diambil	T/A	T/A

Hasil

Daftar {[SyncAlert]} objek SyncAlert.

get_sync_cases

get_sync_cases(case_ids)

Mengambil informasi kasus yang diperlukan untuk sinkronisasi sistem.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
case_ids	{list}	Daftar ID kasus yang akan diambil	T/A	T/A

Hasil

{[SyncCase]} Daftar objek SyncCase.

get_system_info

get_system_info(start_time_unixtime_ms)

get_system_version

get_system_version()

Mendapatkan versi SOAR Google Security Operations saat ini.

Parameter

T/A

Hasil

{string} versi Google Security Operations SOAR saat ini

get_temp_folder_path

get_temp_folder_path()

Mendapatkan jalur ke folder sementara.

Parameter

T/A

Hasil

{string} jalur ke folder sementara

get_ticket_ids_for_alerts_dismissed_since_timestamp

get_ticket_ids_for_alerts_dismissed_since_timestamp(timestamp_unix_ms)

get_updated_sync_alerts_metadata

get_updated_sync_alerts_metadata(start_timestamp_unix_ms, count, allowed_environments=None, vendor=None)

Mengambil metadata pemberitahuan yang dilacak yang diperbarui.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
start_timestamp_unix_ms	{long}	Telusuri pemberitahuan yang diperbarui mulai dari `start_timestamp_unix_ms` atau yang lebih baru	T/A	Jika `end_timestamp_unix_ms` adalah `None`, waktu berakhir adalah waktu permintaan.
jumlah	{int}	Jumlah maksimum ID grup notifikasi yang akan diambil	T/A	T/A
allowed_environments	{[string]}	Lingkungan yang akan ditelusuri	T/A	Jika `allowed_environments` adalah None, telusuri di semua lingkungan
vendor	{string}	Memfilter pemberitahuan menurut vendor	T/A	T/A

Hasil

{[SyncAlertMetadata]} Daftar objek SyncAlertMetadata, diurutkan berdasarkan SyncAlertMetadata.tracking_time.

get_updated_sync_cases_metadata

get_updated_sync_cases_metadata(start_timestamp_unix_ms, count, allowed_environments=None, vendor=None)

Mengambil metadata kasus yang dilacak yang diperbarui.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
start_timestamp_unix_ms	{long}	Menelusuri kasus yang diperbarui mulai `start_timestamp_unix_ms` atau yang lebih baru	T/A	Jika `end_timestamp_unix_ms` adalah None, waktu berakhir akan menjadi waktu permintaan
jumlah	{int}	ID kasus maksimum yang akan diambil	T/A	T/A
allowed_environments	{[string]}	Lingkungan yang akan ditelusuri	T/A	Jika `allowed_environments` adalah None, telusuri di semua lingkungan
vendor	{string}	Hanya menampilkan kasus dengan pemberitahuan yang berasal dari `vendor`	T/A	T/A

Hasil

{[SyncCaseMetadata]} Daftar objek SyncCaseMetadata, diurutkan menurut SyncCaseMetadata.tracking_time.

init_proxy_settings

init_proxy_settings()

Parameter

T/A

is_existing_category

is_existing_category(category)

Memeriksa apakah kategori yang diberikan ada.
Dengan nama kategori, fungsi ini menampilkan True (Boolean) jika string nama kategori yang tepat ditentukan sebagai kategori dalam setelan CustomList.
Fungsi ini mengabaikan lingkungan dan menampilkan True jika item ada; jika tidak, fungsi ini akan menampilkan False.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
category	{string}	Kategori yang akan diperiksa keberadaannya	"DenyListed IPs"	T/A

Hasil

{bool} Benar jika kategori ada, Salah jika tidak.

Contoh 1

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
result = siemplify.is_existing_category("WhiteListed HOSTs")

Contoh 2

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
result = siemplify.is_existing_category("SpecialHosts")

Perilaku hasil

Hasil dalam Kode Contoh 1 menampilkan True, dan hasil dalam Kode Contoh 2 menampilkan False.

Nilai hasil

Benar atau Salah

mark_case_as_important

mark_case_as_important(case_id, alert_identifier)

Fungsi ini menandai kasus saat ini dengan ID pemberitahuan yang diberikan sebagai penting.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
case_id	{string}	ID kasus	234	T/A
alert_identifier	{string}	ID notifikasi	ad6879f1-b72d-419f-990c-011a2526b16d	T/A

Hasil

NoneType

Contoh

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
alert_identifier = "ad6879f1-b72d-419f-990c-011a2526b16d"
case_id = "234"
siemplify.mark_case_as_important(case_id=case_id, alert_identifier=alert_identifier)

Perilaku hasil

Kasus dengan ID pemberitahuan yang diberikan ditandai sebagai penting.

Nilai hasil

Tidak ada

raise_incident

raise_incident(case_id, alert_identifier)

Fungsi ini memunculkan kasus saat ini dengan ID pemberitahuan sebagai insiden.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
case_id	{string}	ID kasus	234	T/A
alert_identifier	{string}	ID notifikasi	ad6879f1-b72d-419f-990c-011a2526b16d	T/A

Hasil

NoneType

Contoh

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
alert_identifier = "ad6879f1-b72d-419f-990c-011a2526b16d"
case_id = "234"
siemplify.raise_incident(case_id=case_id, alert_identifier=alert_identifier)

Perilaku hasil

Kasus 234 akan dilaporkan sebagai insiden.

Nilai hasil

Tidak ada

remove_entities_from_custom_list

remove_entities_from_custom_list(custom_list_items)

Menghapus entity dari daftar kustom dengan kategori yang ditentukan.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
custom_list_items	{[CustomList]}	Daftar item daftar kustom	T/A	T/A

Hasil

Daftar {[CustomList]} objek CustomList yang dihapus.

remove_temp_folder

remove_temp_folder()

Menghapus folder sementara dan subfoldernya.

Parameter

T/A

Hasil properti

send_system_notification

send_system_notification(message, message_id='SDK_CUSTOM_NOTIFICATION')

Mengirim notifikasi sistem dengan ID pesan opsional.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
pesan	{string}	Pesan notifikasi	T/A	T/A
message_id	{string}	ID pesan notifikasi	T/A	T/A

send_system_notification_message

send_system_notification_message(message, message_id)

Contoh

Perilaku hasil

Nilai hasil

set_alert_sla

set_alert_sla(period_time, period_type, critical_period_time, critical_period_type, case_id, alert_identifier)

Menetapkan SLA alert_identifier case_id yang diberikan. SLA yang ditetapkan menggunakan API ini harus melampaui semua jenis SLA pemberitahuan lainnya.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
period_time	{int/str}	Mewakili total periode SLA	T/A	period_time > 0
period_type	{str}	Unit waktu period_time, diwakili oleh ApiPeriodTypeEnum	T/A	T/A
critical_period_time	{int/str}	Mewakili periode SLA kritis	T/A	critical_period_time >= 0 Periode penting (setelah penskalaan dengan unit waktunya) harus lebih kecil dari total periode
critical_period_type	{str}	Unit waktu critical_period_time, diwakili oleh ApiPeriodTypeEnum	T/A	T/A
case_id	{long}	ID kasus	T/A	T/A
alert_identifier	{str}	ID notifikasi	T/A	T/A

set_case_sla

set_case_sla(period_time, period_type, critical_period_time, critical_period_type, case_id)

Menetapkan SLA case_id yang diberikan. SLA yang ditetapkan menggunakan API ini harus melampaui semua jenis SLA kasus lainnya.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
period_time	{int/string}	Mewakili total periode SLA	T/A	period_time > 0
period_type	{string}	Unit waktu period_time, diwakili oleh ApiPeriodTypeEnum	T/A	T/a
critical_period_time	{int/string}	Mewakili periode SLA kritis	T/A	critical_period_time >= 0 Periode penting (setelah penskalaan dengan unit waktunya) harus lebih kecil dari total periode
critical_period_type	{string}	Unit waktu critical_period_time, diwakili oleh ApiPeriodTypeEnum	T/A	T/A
case_id	{long}	ID kasus	234	T/A

update_alerts_additional_data

update_alerts_additional_data(case_id, alerts_additional_data)

Memperbarui data tambahan pemberitahuan.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
case_id	{string}	ID kasus	234	T/A
alerts_additional_data	{dict}	Data tambahan apa pun dari notifikasi	T/A	T/A

update_entities

update_entities(updated_entities)

Fungsi ini memperbarui entity.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
updated_entities	{[{string:string}]}	T/A	T/A	T/A

Hasil

NoneType

Perilaku hasil

Dengan cakupan, pemberitahuan yang dipilih akan menambahkan entitas baru jika belum ada.

Nilai hasil

Tidak ada

Modul Siemplify

class Siemplify.Siemplify

add_agent_connector_logs

Parameter

add_attachment

Parameter

Hasil

Contoh

Perilaku hasil

add_comment

Parameter

Hasil

Contoh

Perilaku hasil

Nilai hasil

add_entities_to_custom_list

Parameter

Hasil

Perilaku hasil

add_entity_insight

Parameter

Hasil

Contoh

Perilaku hasil

Nilai hasil

add_entity_to_case

Parameter

Hasil

Contoh

Perilaku hasil

Nilai hasil

add_or_update_case_task

Parameter

Hasil

add_tag

Parameter

any_entity_in_custom_list

Parameter

Hasil

Nilai hasil

assign_case

Parameter

Hasil

Perilaku hasil

Nilai hasil

attach_workflow_to_case

Parameter

Hasil

Contoh

Perilaku hasil

Nilai hasil

batch_update_case_id_matches

Parameter

Hasil

change_case_priority

Parameter

Hasil

Contoh

Perilaku hasil

Nilai hasil

change_case_stage

Parameter

check_marketplace_status

Parameter

Hasil

close_alert

Parameter

Hasil

close_case

Parameter

create_case

Parameter

Hasil

Perilaku hasil

Nilai hasil

create_case_insight_internal

Parameter

Hasil

create_connector_package

Parameter

class `Siemplify.Siemplify`