Siemplify 모듈

클래스 Siemplify.Siemplify

기본: SiemplifyBase

엔드포인트: external/v1/sdk/CaseFullDetails

add_agent_connector_logs

add_agent_connector_logs(agent_id, connector_id, logs_package)

원격 에이전트의 connector_id 커넥터 로그를 추가합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
agent_id {string} 에이전트 식별자 해당 사항 없음 해당 사항 없음
connector_id {string} 커넥터 인스턴스 식별자 해당 사항 없음 해당 사항 없음
logs_package {dict} ConnectorLogPackage 해당 사항 없음 해당 사항 없음

add_attachment

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

이 함수는 파일 첨부파일이 있는 케이스 월에 항목을 추가합니다 (클라이언트에서 사용자의 로컬 머신으로 다운로드할 수 있음). 이 기능은 케이스 개요 화면 하단에서 증거를 추가하는 것과 본질적으로 동일한 작업을 실행합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
file_path {string} 파일 경로 액세스 가능한 모든 경로 경로는 원격 위치일 수도 있습니다. 해당 파일에 대한 읽기 권한이 필요합니다.
case_id {string} 케이스 식별자 케이스 월에 첨부파일을 추가할 케이스 ID 기본값은 현재 케이스입니다.
alert_identifier {string} 알림 식별자 첨부파일을 연결할 알림의 알림 식별자 문자열 기본값은 현재 실행 중인 알림입니다.
설명 {string} 첨부파일 설명 모든 문자열 기본값은 없습니다.
선택적 파라미터입니다.
is_favorite {boolean} 즐겨찾기 첨부파일 참/거짓 기본값은 False입니다.
선택적 파라미터입니다.

반환

{long} attachment_id

예

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

결과 동작

이 예시에서는 로컬 머신 (서버 자체)의 C:/temp에서 investigation.txt를 케이스 월에 업로드합니다. 설명의 문자열과 함께 케이스 월의 해당 항목에 댓글이 추가됩니다. is_favorite 플래그가 True로 설정되었으므로 이 새 항목에도 별표표시(즐겨찾기)가 지정됩니다.

add_comment

add_comment(comment, case_id, alert_identifier)

특정 케이스에 새 댓글을 추가합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
댓글 {string} 케이스 월에 추가할 댓글 '이 알림의 이벤트가 의심스러워 보입니다.' 케이스와 관련된 댓글
case_id {string} 케이스 식별자 234 해당 사항 없음
alert_identifier {string} 알림 식별자 ad6879f1-b72d-419f-990c-011a2526b16d 해당 사항 없음

반환

NoneType

예

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)

결과 동작

제공된 댓글이 케이스 234에 추가됩니다.

결과 값

없음

add_entities_to_custom_list

add_entities_to_custom_list(custom_list_items)

추가된 항목과 함께 제공된 고객 목록을 고객 목록에 추가합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
custom_list_items {string} 맞춤 목록 항목의 목록 해당 사항 없음 해당 사항 없음

반환

{[CustomList]} 추가된 맞춤 목록 항목이 포함된 목록입니다.

결과 동작

항목이 맞춤 목록 카테고리에 추가됩니다.

add_entity_insight

add_entity_insight(domain_entity_info, message, case_id, alert_id)

항목 인사이트를 추가합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
domain_entity_info {string} 항목 식별자 "192.0.2.1" {DomainEntityInfo}
메시지 {string} 통계 메시지 This is Example DNS 해당 사항 없음
case_id {string} 항목 통계에 추가할 케이스 식별자 234 해당 사항 없음
alert_id {string} 항목 인사이트에 추가할 알림 식별자 ad6879f1-b72d-419f-990c-011a2526b16d 해당 사항 없음

반환

{boolean} 성공 시 True

예

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)

결과 동작

지정된 메시지가 케이스 234에서 지정된 알림 식별자의 항목 192.0.2.1에 대한 통계로 추가됩니다.

결과 값

참

통계가 추가되지 않은 경우 false입니다.

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)

케이스에 항목을 추가합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
entity_identifier {string} 항목 식별자 192.0.2.1, example.com 해당 사항 없음
entity_type {string} 항목 식별자의 항목 유형 'ADDRESS' 해당 사항 없음
is_internal {boolean} 해당 사항 없음 참/거짓 해당 사항 없음
is_suspicious {boolean} 해당 사항 없음 참/거짓
is_enriched {boolean} 해당 사항 없음 참/거짓 기본적으로 False입니다.
is_vulnerable {boolean} 해당 사항 없음 참/거짓 기본적으로 False입니다.
속성 {dict} 항목의 속성 {"property":"value"} 해당 사항 없음

반환

NoneType

예

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)

결과 동작

제공된 정보가 있는 항목이 케이스 234 내의 지정된 알림에 추가됩니다.

결과 값

없음

add_or_update_case_task

add_or_update_case_task(task)

작업 케이스 추가 또는 업데이트: 작업 ID가 있으면 업데이트하고, 없으면 추가 (생성)합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
task {Task} 케이스에 추가하거나 업데이트해야 하는 작업 객체입니다. 해당 사항 없음 해당 사항 없음

반환

{int} 새 할 일 또는 업데이트된 할 일의 ID입니다.

add_tag

add_tag(tag, case_id, alert_identifier)

특정 케이스에 새 태그를 추가합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
태그 {string} 추가할 태그 해당 사항 없음 해당 사항 없음
case_id {string} 케이스 식별자 234 해당 사항 없음
alert_identifier {string} 알림 식별자 ad6879f1-b72d-419f-990c-011a2526b16d 해당 사항 없음

any_entity_in_custom_list

any_entity_in_custom_list(custom_list_items)

지정된 목록에 지정된 카테고리의 커스텀 목록 레코드가 있는 항목이 있는지 확인합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
custom_list_items {[CustomList]} 항목을 확인할 커스텀 목록 항목의 목록입니다. 해당 사항 없음 해당 사항 없음

반환

{boolean} 항목이 있으면 True, 그렇지 않으면 False입니다.

결과 값

True 또는 False

assign_case

assign_case(user, case_id, alert_identifier)

이 함수는 현재 케이스를 사용자에게 할당합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
사용자 {string} 사용자/역할 관리자, @Tier1 해당 사항 없음
case_id {string} 사용자에게 할당할 케이스 식별자 234 해당 사항 없음
alert_identifier {string} 사용자를 할당할 알림 식별자 ad6879f1-b72d-419f-990c-011a2526b16d 이 값은 작업 런타임 중에 가져옵니다.

반환

NoneType

결과 동작

케이스가 지정된 사용자에게 할당됩니다.

결과 값

없음

attach_workflow_to_case

attach_workflow_to_case(workflow_name, cyber_case_id, indicator_identifier)

케이스에 플레이북을 연결합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
workflow_name {string} 워크플로 이름 해당 사항 없음 해당 사항 없음
cyber_case_id {string} 케이스 식별자 234 해당 사항 없음
indicator_identifier {string} 알림 식별자 ad6879f1-b72d-419f-990c-011a2526b16d 해당 사항 없음

반환

서버 작업의 {string} 상태 코드

예

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)

결과 동작

워크플로 234가 케이스 234에 연결됩니다.

결과 값

없음

batch_update_case_id_matches

batch_update_case_id_matches(case_id_matches)

적절한 외부 케이스 ID를 사용하여 케이스를 일괄 업데이트합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
case_id_matches {list} SyncCaseIdMatch 객체 목록

반환

{list} 업데이트된 케이스 ID 목록입니다.

change_case_priority

change_case_priority(priority, case_id, alert_identifier)

케이스 우선순위를 변경합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
우선순위 {int} 변경할 케이스 우선순위 40/60/80/100 ApiSyncCasePriorityEnum을 참고하세요.
우선순위 매핑: {"Low": 40, "Medium": 60, "High": 80, "Critical": 100}
case_id {string} 케이스 식별자 234 해당 사항 없음
alert_identifier {string} 알림 식별자 ad6879f1-b72d-419f-990c-011a2526b16d 해당 사항 없음

반환

NoneType

예

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)

결과 동작

케이스 234의 우선순위가 40으로 변경되며, 이는 낮음으로 매핑됩니다.

결과 값

없음

change_case_stage

change_case_stage(stage, case_id, alert_identifier)

케이스 단계를 변경합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
각 단계에서 {string} 케이스의 현재 단계입니다. 사고 해당 사항 없음
case_id {string} 케이스 식별자 해당 사항 없음 해당 사항 없음
alert_identifier {string} 알림 식별자 ad6879f1-b72d-419f-990c-011a2526b16d 해당 사항 없음

check_marketplace_status

check_marketplace_status()

마켓플레이스 상태를 확인합니다.
오류가 없으면 함수는 none를 반환합니다. 그렇지 않으면 예외가 반환됩니다.

매개변수

해당 사항 없음

반환

없음

close_alert

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

이 함수는 현재 알림을 닫습니다. 이는 케이스 개요에서 알림을 수동으로 종료하는 것과 동일합니다. 이 함수는 케이스 종료 알림과 마찬가지로 종료 이유, 근본 원인, 의견을 요구합니다.
알림을 종료하면 알림이 하나만 있는 새 케이스가 종료됩니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
root_cause {string} 케이스 종료 근본 원인 해당 사항 없음 해당 사항 없음
댓글 {string} 댓글 해당 사항 없음 해당 사항 없음
reason {ApiSyncAlertCloseReasonEnum} 해당 사항 없음 해당 사항 없음 SiemplifyDataModel.ApiSyncAlertCloseReasonEnum을 참조하세요.
case_id {string} 알림이 있는 케이스 식별자 234 해당 사항 없음
alert_id {string} 종료할 알림 식별자입니다. ad6879f1-b72d-419f-990c-011a2526b16d 해당 사항 없음

반환

{dict} 서버 작업 결과

close_case

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

케이스를 종료합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
root_cause {string} 케이스 종료 근본 원인 해당 사항 없음 해당 사항 없음
댓글 {string} 댓글 해당 사항 없음 해당 사항 없음
reason {ApiSyncAlertCloseReasonEnum} 케이스 종료 이유 SiemplifyDataModel.ApiSyncAlertCloseReasonEnum을 참조하세요.
case_id {string} 케이스 식별자 234 해당 사항 없음
alert_id {string} 알림 식별자 ad6879f1-b72d-419f-990c-011a2526b16d 해당 사항 없음

create_case

create_case(case_info)

이 함수는 case_info 사전에 포함된 알림 및 이벤트가 있는 케이스를 만듭니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
case_info {CaseInfo} 케이스 정보 객체 해당 사항 없음 SiemplifyConnectorsDataModel.CaseInfo 보기

반환

NoneType

결과 동작

제공된 케이스 데이터로 케이스가 생성됩니다.

결과 값

없음

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)

인사이트를 추가합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
case_id {string} 케이스 식별자 234 해당 사항 없음
alert_identifier {string} 알림 식별자 ad6879f1-b72d-419f-990c-011a2526b16d 해당 사항 없음
triggered_by {string} 통합 이름 해당 사항 없음 해당 사항 없음
제목 {string} 통계 제목 해당 사항 없음 해당 사항 없음
콘텐츠 {string} 통계 메시지 해당 사항 없음 해당 사항 없음
entity_identifier {string} 항목 식별자 해당 사항 없음 해당 사항 없음
severity {int} 심각도 식별자 0 = 정보,
1 = 경고,
2 = 오류		 해당 사항 없음
insight_type {int} 통계 유형 0 = 일반,
1 = 항목		 해당 사항 없음
additional_data 해당 사항 없음 해당 사항 없음 해당 사항 없음 해당 사항 없음
additional_data_type 해당 사항 없음 해당 사항 없음 해당 사항 없음 해당 사항 없음
additional_data_title 해당 사항 없음 해당 사항 없음 해당 사항 없음 해당 사항 없음
original_requesting_user 해당 사항 없음 해당 사항 없음 해당 사항 없음 해당 사항 없음
entity_type {string} 항목 유형 'ADDRESS' 해당 사항 없음

반환

{boolean} 성공하면 True입니다.

create_connector_package

create_connector_package(connector_package)

시스템에 커넥터 패키지를 만듭니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
connector_package {string} 커넥터 패키지(JSON) 해당 사항 없음 해당 사항 없음

dismiss_alert

dismiss_alert(alert_group_identifier, should_close_case_if_all_alerts_were_dismissed, case_id)

end

end(message, result_value, execution_state=0)

스크립트를 종료합니다.
end() 함수 뒤에 있는 다른 코드는 실행되지 않습니다.
최종 결과 값이 stdout에 기록됩니다.
예약된 작업에는 종료 함수가 필수가 아닙니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
메시지 {string} 고객에게 표시할 출력 메시지 작업이 완료됨 해당 사항 없음
result_value {int/string/dict} 반환 값 해당 사항 없음 해당 사항 없음
execution_state {int} 현재 작업 상태의 표시기입니다. 주로 비동기 작업에서 작업이 완료되었는지 여부를 표시하는 데 사용됩니다. 0 (EXECUTION_STATE_COMPLETED),
1 (EXECUTION_STATE_INPROGRESS),
2 (EXECUTION_STATE_FAILED),
3 (EXECUTION_STATE_TIMEDOUT)		 기본값은 0입니다.

반환

호스트 프로세스에 결과 데이터 반환

end_script

end_script()

escalate_case

escalate_case(comment, case_id, alert_identifier)

케이스를 에스컬레이션합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
댓글 {string} 댓글 에스컬레이션 해당 사항 없음 해당 사항 없음
case_id {string} 케이스 식별자 234 해당 사항 없음
alert_identifier {string} 알림 식별자 ad6879f1-b72d-419f-990c-011a2526b16d 해당 사항 없음

extract_configuration_param

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

통합 인스턴스에서 구성 파라미터를 가져옵니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
provider_name {string} 통합 이름 해당 사항 없음 해당 사항 없음
param_name {string} 매개변수 이름 해당 사항 없음 해당 사항 없음
default_value {any} 매개변수가 전달되지 않으면 기본적으로 이 값을 사용합니다. 해당 사항 없음 기본값은 없음입니다 (선택사항).
input_type {obj} 파라미터를 다른 유형으로 변환 해당 사항 없음 예를 들어 int입니다. 기본값은
str입니다 (선택사항).
is_mandatory {bool} 매개변수가 비어 있으면 예외 발생 해당 사항 없음 기본값은 False입니다(선택사항).
print_value {bool} 로그에 값 출력 해당 사항 없음 기본값은 False입니다(선택사항).

반환

매개변수 값이며, input_type이 지정되지 않는 한 기본적으로 문자열입니다.

static generate_serialized_object

generate_serialized_object(object_filter)

get_agent_by_id

get_agent_by_id(agent_id)

ID로 에이전트 세부정보를 가져옵니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
agent_id {str} 에이전트의 ID입니다. 해당 사항 없음 해당 사항 없음

반환

{dict} 게시자 세부정보

get_alerts_ticket_ids_from_cases_closed_since_timestamp

get_alerts_ticket_ids_from_cases_closed_since_timestamp(timestamp_unix_ms, rule_generator)

타임스탬프 이후 종료된 케이스의 알림을 가져옵니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
timestamp_unix_ms {long} 타임스탬프 1550409785000L 해당 사항 없음
rule_generator {string} 해당 사항 없음 '피싱 이메일 감지기' 해당 사항 없음

반환

알림 {list}개

get_attachment

get_attachment(attachment_id)

식별자로 첨부파일 데이터를 가져옵니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
attachment_id {string} 첨부파일 식별자 해당 사항 없음 해당 사항 없음

반환

{BytesIO} 첨부파일 데이터

get_attachments

get_attachments(case_id)

케이스에서 첨부파일을 가져옵니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
case_id {string} 케이스 식별자 234 해당 사항 없음

반환

첨부파일 {dict}개

결과 값

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

_get_case_by_id

_get_case_by_id(case_id)

케이스 ID를 사용하여 케이스를 가져옵니다.

이 함수는 다음 엔드포인트와 상호작용합니다. external/v1/sdk/CaseFullDetails

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
case_id {[string]} 케이스 ID 해당 사항 없음 해당 사항 없음

반환

{dict} 케이스 데이터

get_case_closure_details

get_case_closure_details(case_id_list)

케이스 종료 세부정보를 가져옵니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
case_id_list {[string]} 케이스 ID 목록 해당 사항 없음 해당 사항 없음

반환

{[dict]} 케이스 종료 세부정보가 포함된 dict 목록입니다.

결과 값

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

case_closed_action_type 매개변수에 사용할 수 있는 값은 다음과 같습니다.

  • 0 = 자동
  • 1 = 수동

get_case_comments

get_case_comments(case_id)

이 함수는 제공된 케이스에서 댓글을 가져옵니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
case_id {string} 케이스 식별자 234 해당 사항 없음

반환

목록

예

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

결과 동작

케이스에 속한 모든 댓글을 가져옵니다.

결과 값

[
    {
             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)

케이스 ID로 모든 작업을 검색합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
case_id {int/str} 케이스 ID 234 함수는 int 또는 str을 수신할 수 있습니다.

반환

{[Task]} 케이스에 속하는 작업 객체의 목록입니다.
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)

요청된 필터로 케이스를 가져옵니다.

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

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
environments {[string]} 환경 이름 목록 (환경) 해당 사항 없음 환경이 제공되지 않으면 None가 사용됩니다 (선택사항).
역량 강화 {[string]} 분석가 이름 목록 (케이스 할당 사용자/역할) 해당 사항 없음 분석가가 제공되지 않으면 None가 사용됩니다 (선택사항).
상태 {[int]} 필터링할 상태 목록 해당 사항 없음

유효한 statuses 값은 다음과 같습니다.

1 = Open
2 = Closed

상태가 제공되지 않으면 None가 사용되며, 이 경우 진행 중인 케이스와 종료된 케이스가 모두 반환됩니다 (선택사항).
case_names {[string]} 케이스 이름 목록 해당 사항 없음 case_names가 제공되지 않으면 None가 사용됩니다 (선택사항).
tags {[string]} 케이스 태그 목록 해당 사항 없음 태그를 제공하지 않으면 None가 사용됩니다 (선택사항).
우선순위 {[int]} 우선순위 목록 ApiSyncAlertPriorityEnum을 참고하세요.
우선순위가 제공되지 않으면 None가 사용됩니다 (선택사항).
단계 {list} 단계 목록 (caseFilterValue 객체) 해당 사항 없음 스테이지가 제공되지 않으면 None가 사용됩니다 (선택사항).
case_types {list} 객체 유형 목록 (caseFilterValue 객체) 해당 사항 없음

유효한 case_types 값은 다음과 같습니다.

0 = Merged
1 = Important
2 = InvolvedSuspiciousEntity
3 = Manual
4 = Simulated

case_types가 제공되지 않으면 None가 사용됩니다(선택사항).
products {list} 제품 목록 (caseFilterValue 객체) 해당 사항 없음 제공된 제품이 없으면 None가 사용됩니다 (선택사항).
네트워크 {list} 네트워크 목록 (caseFilterValue 객체) 해당 사항 없음 네트워크가 제공되지 않으면 None가 사용됩니다 (선택사항).
ticked_ids_free_search {string} 티켓 식별자 해당 사항 없음 제공하지 않은 경우 기본값은 ''입니다(선택사항).
case_ids_free_search {string} 케이스 식별자 해당 사항 없음 제공하지 않은 경우 기본값은 ''입니다(선택사항).
wall_data_free_search {string} 검색할 문자열 해당 사항 없음 제공하지 않은 경우 기본값은 ''입니다(선택사항).
entities_free_search {string} 항목 식별자 해당 사항 없음 제공하지 않은 경우 기본값은 ''입니다(선택사항).
start_time_unix_time_in_ms {long} 해당 사항 없음 해당 사항 없음 기본값 -1
(선택사항)
end_time_unix_time_in_ms {long} 해당 사항 없음 해당 사항 없음 기본값 -1
(선택사항)

반환

케이스 ID ''

get_cases_by_ticket_id

get_cases_by_ticket_id(ticket_id)

티켓 식별자로 케이스를 가져옵니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
ticket_id {string} 티켓 식별자 해당 사항 없음 해당 사항 없음

반환

{[int]} 케이스 ID 목록입니다.

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)

필터별로 케이스 ID를 가져옵니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
상태 {str} 검색할 케이스 상태 'OPEN', 'CLOSE', 'BOTH' 해당 사항 없음
start_time_from_unix_time_in_ms {int} 케이스 시작 시간 시작 범위(포함) 해당 사항 없음 기본값은 30일 전입니다 (선택사항).
start_time_to_unix_time_in_ms {int} 케이스 시작 시간 종료 범위(포함) 해당 사항 없음 기본값은 현재 시간입니다 (선택사항).
close_time_from_unix_time_in_ms {int} 케이스 종료 시간 시작 범위(포함) 해당 사항 없음 기본값은 30일 전입니다 (선택사항).
close_time_to_unix_time_in_ms {int} 케이스 종료 시간 종료 범위(포함)입니다. 해당 사항 없음 기본값은 현재 시간입니다 (선택사항).
update_time_from_unix_time_in_ms {int} 케이스 수정 시간 시작 범위(포함) 해당 사항 없음 기본값은 시작 시간입니다 (선택사항).
update_time_to_unix_time_in_ms {int} 케이스 수정 시간 종료 범위(포함) 해당 사항 없음 기본값은 현재 시간입니다 (선택사항).
연산자 {str} 시간 필터 연산자 OR, AND 선택사항
sort_by {str} 시간순으로 결과 정렬 START_TIME, UPDATE_TIME, CLOSE_TIME 선택사항
sort_order {str} 정렬 순서 ASC, DESC 기본값은 내림차순입니다 (선택사항).
max_results {int} 반환할 최대 결과 수 해당 사항 없음 기본값은 1000이고 최댓값은 10000입니다 (선택사항).

get_configuration

get_configuration(provider, environment, integration_instance)

통합 구성을 가져옵니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 설명
제공업체 {string} 통합 이름 'VirusTotal' 해당 사항 없음
환경 {string} 특정 환경 또는 '모두'에 대한 구성 해당 사항 없음 해당 사항 없음
integration_instance {string} 통합 인스턴스의 식별자 해당 사항 없음 해당 사항 없음

반환

구성 세부정보 {dict}개

get_configuration_by_provider

get_configuration_by_provider(identifier)

통합 구성을 가져옵니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 설명
제공업체 {string} 통합 이름 'VirusTotal' 해당 사항 없음

반환

{dict} 구성 세부정보

get_existing_custom_list_categories

get_existing_custom_list_categories()

기존의 모든 맞춤 목록 카테고리를 가져옵니다.
이 함수는 환경에 관계없이 CustomList 설정의 모든 카테고리에 대한 목록 객체를 반환합니다.

매개변수

해당 사항 없음

반환

{[unicode]} 기존 카테고리가 있는 유니코드 유형의 목록입니다.

예

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

결과 동작

기존의 모든 맞춤 목록이 반환됩니다.

결과 값

["DenyListed IPs", "AllowListed HOSTs"]

get_external_configuration

get_external_configuration(config_provider, config_name)

외부 통합 구성을 가져옵니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
config_provider {string} 해당 사항 없음 해당 사항 없음 해당 사항 없음
config_name {string} 해당 사항 없음 해당 사항 없음 해당 사항 없음

get_integration_version

get_integration_version(integration_identifier)

통합 버전을 가져옵니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
integration_identifier {string} 통합 식별자 해당 사항 없음 해당 사항 없음

반환

통합 버전 {float}

get_publisher_by_id

get_publisher_by_id(publisher_id)

ID로 게시자 세부정보를 가져옵니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
publisher_id {string} 게시자 ID 해당 사항 없음 해당 사항 없음

반환

{dict} 게시자 세부정보

get_remote_connector_keys_map

get_remote_connector_keys_map(publisher_id)

게시자 ID로 원격 커넥터 암호화 키를 가져옵니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
publisher_id {string} 게시자 ID 해당 사항 없음 해당 사항 없음

반환

{dict} 키 맵

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)

유사한 케이스를 가져옵니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
case_id {string} 케이스 식별자 234 해당 사항 없음
ports_filter {boolean} 참/거짓 포트 필터 사용 참/거짓 해당 사항 없음
category_outcome_filter {boolean} 참/거짓 category_outcome 필터 사용 참/거짓 해당 사항 없음
rule_generator_filter {boolean} 참/거짓 rule_generator 필터 사용 참/거짓 해당 사항 없음
entity_identifiers_filter {boolean} 참/거짓 entity_identifiers 필터 사용 참/거짓 해당 사항 없음
start_time_unix_ms 해당 사항 없음 해당 사항 없음 해당 사항 없음 해당 사항 없음
end_time_unix_ms 해당 사항 없음 해당 사항 없음 해당 사항 없음 해당 사항 없음

반환

{dict}

get_sync_alerts

get_sync_alerts(alert_group_ids)

시스템 동기화에 필요한 알림 정보를 가져옵니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
alert_group_ids {list} 가져올 알림 그룹 ID 목록 해당 사항 없음 해당 사항 없음

반환

{[SyncAlert]} SyncAlert 객체 목록입니다.

get_sync_cases

get_sync_cases(case_ids)

시스템 동기화에 필요한 케이스 정보를 가져옵니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
case_ids {list} 가져올 케이스 ID 목록입니다. 해당 사항 없음 해당 사항 없음

반환

{[SyncCase]} SyncCase 객체 목록입니다.

get_system_info

get_system_info(start_time_unixtime_ms)

get_system_version

get_system_version()

현재 Google Security Operations SOAR 버전을 가져옵니다.

매개변수

해당 사항 없음

반환

{string} 현재 Google Security Operations SOAR 버전

get_temp_folder_path

get_temp_folder_path()

임시 폴더의 경로를 가져옵니다.

매개변수

해당 사항 없음

반환

임시 폴더의 {string} 경로

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)

업데이트된 추적 알림 메타데이터를 가져옵니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
start_timestamp_unix_ms {long}
start_timestamp_unix_ms 이후에 업데이트된 알림 검색		 해당 사항 없음 end_timestamp_unix_ms가 None이면
종료 시간은 요청 시간입니다.
개수 {int} 가져올 최대 알림 그룹 ID 수 해당 사항 없음 해당 사항 없음
allowed_environments {[string]} 검색할 환경 해당 사항 없음 allowed_environments가 None이면
모든 환경에서 검색합니다.
vendor {string} 공급업체별 알림 필터링 해당 사항 없음 해당 사항 없음

반환

{[SyncAlertMetadata]} SyncAlertMetadata.tracking_time를 기준으로 정렬된 SyncAlertMetadata 객체 목록입니다.

get_updated_sync_cases_metadata

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

업데이트된 추적 케이스 메타데이터를 가져옵니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
start_timestamp_unix_ms {long}
start_timestamp_unix_ms 이후에 업데이트된 케이스 검색		 해당 사항 없음 end_timestamp_unix_ms가 None이면
종료 시간은 요청 시간이 됩니다.
개수 {int} 가져올 최대 케이스 ID 수 해당 사항 없음 해당 사항 없음
allowed_environments {[string]} 검색할 환경 해당 사항 없음 allowed_environments가 None이면
모든 환경에서 검색합니다.
vendor {string} vendor에서 발생한 알림이 있는 케이스만 반환합니다. 해당 사항 없음 해당 사항 없음

반환

{[SyncCaseMetadata]} SyncCaseMetadata.tracking_time로 정렬된 SyncCaseMetadata 객체 목록입니다.

init_proxy_settings

init_proxy_settings()

매개변수

해당 사항 없음

is_existing_category

is_existing_category(category)

지정된 카테고리가 있는지 확인합니다.
카테고리 이름이 지정된 경우 이 함수는 정확한 카테고리 이름 문자열이 CustomList 설정에서 카테고리로 정의된 경우 True (불리언)를 반환합니다.
이 함수는 환경을 무시하고 항목이 있으면 True를 반환하고, 그렇지 않으면 False를 반환합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
카테고리 {string} 존재 여부를 확인할 카테고리입니다. thought '차단 목록에 추가된 IP' 해당 사항 없음

반환

{bool} 카테고리가 있으면 True, 그렇지 않으면 False입니다.

예 1

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

예 2

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

결과 동작

샘플 코드 1의 결과는 True을 반환하고 샘플 코드 2의 결과는 False를 반환합니다.

결과 값

True 또는 False

mark_case_as_important

mark_case_as_important(case_id, alert_identifier)

이 함수는 지정된 알림 식별자가 있는 현재 케이스를 중요로 표시합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
case_id {string} 케이스 식별자 234 해당 사항 없음
alert_identifier {string} 알림 식별자 ad6879f1-b72d-419f-990c-011a2526b16d 해당 사항 없음

반환

NoneType

예

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)

결과 동작

제공된 알림 식별자가 있는 케이스가 중요로 표시됩니다.

결과 값

없음

raise_incident

raise_incident(case_id, alert_identifier)

이 함수는 알림 식별자를 사용하여 현재 케이스를 사고로 제기합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
case_id {string} 케이스 식별자 234 해당 사항 없음
alert_identifier {string} 알림 식별자 ad6879f1-b72d-419f-990c-011a2526b16d 해당 사항 없음

반환

NoneType

예

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)

결과 동작

케이스 234가 이슈로 제기됩니다.

결과 값

없음

remove_entities_from_custom_list

remove_entities_from_custom_list(custom_list_items)

지정된 카테고리의 맞춤 목록에서 항목을 삭제합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
custom_list_items {[CustomList]} 맞춤 목록 항목의 목록 해당 사항 없음 해당 사항 없음

반환

삭제된 CustomList 객체의 {[CustomList]} 목록입니다.

remove_temp_folder

remove_temp_folder()

임시 폴더와 하위 폴더를 삭제합니다.

매개변수

해당 사항 없음

property result

send_system_notification

send_system_notification(message, message_id='SDK_CUSTOM_NOTIFICATION')

선택사항인 메시지 ID를 사용하여 시스템 알림을 전송합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
메시지 {string} 알림 메시지 해당 사항 없음 해당 사항 없음
message_id {string} 알림 메시지 식별자 해당 사항 없음 해당 사항 없음

send_system_notification_message

send_system_notification_message(message, message_id)

예

결과 동작

결과 값

set_alert_sla

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

case_id의 지정된 alert_identifier에 대한 SLA를 설정합니다. 이 API를 사용하여 설정된 SLA는 다른 모든 알림 SLA 유형보다 우선합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
period_time {int/str} 총 SLA 기간을 나타냅니다. 해당 사항 없음 period_time > 0
period_type {str} period_time의 시간 단위,
ApiPeriodTypeEnum으로 표시됨		 해당 사항 없음 해당 사항 없음
critical_period_time {int/str} 중요한 SLA 기간을 나타냅니다. 해당 사항 없음 critical_period_time >= 0
임계 기간 (시간 단위로 확장한 후)은
전체 기간보다 작아야 합니다.
critical_period_type {str} critical_period_time의 시간 단위로,
ApiPeriodTypeEnum으로 표시됩니다.		 해당 사항 없음 해당 사항 없음
case_id {long} 케이스 식별자 해당 사항 없음 해당 사항 없음
alert_identifier {str} 알림 식별자 해당 사항 없음 해당 사항 없음

set_case_sla

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

지정된 case_id의 SLA를 설정합니다. 이 API를 사용하여 설정된 SLA는 다른 모든 케이스 SLA 유형보다 우선 적용됩니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
period_time {int/string} 총 SLA 기간을 나타냅니다. 해당 사항 없음 period_time > 0
period_type {string} period_time의 시간 단위,
ApiPeriodTypeEnum으로 표시됨		 해당 사항 없음 해당 없음
critical_period_time {int/string} 중요한 SLA 기간을 나타냅니다. 해당 사항 없음 critical_period_time >= 0
임계 기간 (시간 단위로 확장한 후)은
전체 기간보다 작아야 합니다.
critical_period_type {string} critical_period_time의 시간 단위로,
ApiPeriodTypeEnum으로 표시됩니다.		 해당 사항 없음 해당 사항 없음
case_id {long} 케이스 식별자 234 해당 사항 없음

update_alerts_additional_data

update_alerts_additional_data(case_id, alerts_additional_data)

알림 추가 데이터를 업데이트합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
case_id {string} 케이스 식별자 234 해당 사항 없음
alerts_additional_data {dict} 알림의 추가 데이터 해당 사항 없음 해당 사항 없음

update_entities

update_entities(updated_entities)

이 함수는 항목을 업데이트합니다.

매개변수

매개변수 이름 매개변수 유형 정의 가능한 값 댓글
updated_entities {[{string:string}]} 해당 사항 없음 해당 사항 없음 해당 사항 없음

반환

NoneType

결과 동작

범위를 사용하면 선택한 알림이 아직 없는 경우 새 항목을 추가합니다.

결과 값

없음