data_models 모듈

이 모듈에는 다음을 나타내는 데이터 클래스가 포함되어 있습니다.

  • 데이터 모델
  • 알림
  • 변수 컨테이너
  • 일반 매개변수
  • 커넥터 매개변수

class TIPCommon.data_models.AlertCard

클래스 TIPCommon.data_models.AlertCard(id_: int, creation_time_unix_time_ms: int, modification_time_unix_time_ms: int, identifier: str, status: int, name: str, priority: int, workflow_status: int, sla_expiration_unix_time: int | None, sla_critical_expiration_unix_time: int | None, start_time: int, end_time: int, alert_group_identifier: str, events_count: int, title: str, rule_generator: str, device_product: str, playbook_attached: str | None, playbook_run_count: int, is_manual_alert: bool, sla: SLA, fields_groups: list[FieldsGroup], source_url: str | None, source_rule_url: str | None, siem_alert_id: str | None)

기본: object

주요 세부정보와 메타데이터가 포함된 알림의 요약 카드를 나타냅니다.

classmethod from_json(alert_card_json: Dict[str, Any])→ AlertCard

속성을 나타내는 JSON 딕셔너리에서 AlertCard 객체를 만듭니다.

class TIPCommon.data_models.AlertEvent

클래스 TIPCommon.data_models.AlertEvent(fields: list[EventPropertyField], identifier: str, case_id: int, alert_identifier: str, name: str, product: str, port: str | None, source_system_name: str, outcome: str | None, time: int, type_: str, artifact_entities: list[str])

기본: object

케이스 내 알림과 연결된 단일 이벤트를 나타냅니다.

classmethod from_json(event_json: MutableMapping[str, Any])→ AlertEvent

JSON 딕셔너리에서 AlertEvent 객체를 만듭니다.

class TIPCommon.data_models.AlertPriority

클래스 TIPCommon.data_models.AlertPriority(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

기본: 열거형

알림의 우선순위 수준을 나타냅니다.

상수

  • CRITICAL = 100

  • HIGH = 80

  • INFORMATIVE = -1

  • LOW = 40

  • MEDIUM = 60

  • UNCHANGED = 0

class TIPCommon.data_models.BaseAlert

클래스 TIPCommon.data_models.BaseAlert(raw_data, alert_id)

기본: object

기본 알림을 나타냅니다. 다음과 같은 속성이 있습니다.

속성

raw_data 알림의 원시 데이터입니다.
alert_id 알림의 ID입니다.

메서드

  • to_json()→ dict
예
>>> from data_models import BaseAlert
>>> alert = BaseAlert({'foo': 'bar'}, 100)
>>> alert.raw_data
{'foo': 'bar'}
>>> alert.alert_id
100
>>> alert.to_json()
{'foo': 'bar'}

class TIPCommon.data_models.BaseDataModel

클래스 TIPCommon.data_models.BaseDataModel(raw_data)

기본: object

기본 데이터 모델을 나타냅니다.

속성

속성 설명
raw_data 데이터 모델의 원시 데이터입니다.

메서드

  • to_json()→ dict
예
>>> from data_models import BaseDataModel
>>> data = BaseDataModel({'foo': 'bar'})
>>> data.raw_data
{'foo': 'bar'}
>>> data.to_json()
{'foo': 'bar'}

class TIPCommon.data_models.CaseDataStatus

클래스 TIPCommon.data_models.CaseDataStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

기본: 열거형

상수

  • ALL = 3

  • CLOSED = 2

  • CREATION_PENDING = 5

  • MERGED = 4

  • NEW = 0

  • OPENED = 1

class TIPCommon.data_models.CaseDetails

클래스 TIPCommon.data_models.CaseDetails(id_: int, creation_time_unix_time_ms: int, modification_time_unix_time_ms: int, name: str, priority: int, is_important: bool, is_incident: bool, start_time_unix_time_ms: int, end_time_unix_time_ms: int, assigned_user: str, description: str | None, is_test_case: bool, type_: int, stage: str, environment: str, status: CaseDataStatus, incident_id: int | None, tags: list[str], alerts: list[AlertCard], is_overflow_case: bool, is_manual_case: bool, sla_expiration_unix_time: int | None, sla_critical_expiration_unix_time: int | None, stage_sla_expiration_unix_time_ms: int | None, stage_sla__critical_expiration_unix_time_in_ms: int | None, can_open_incident: bool, sla:SLA, stage_sla: SLA)

기본: object

classmethod from_json(case_details_json: Dict[str, Any])→ CaseDetails

JSON 딕셔너리에서 CaseDetails 객체를 만듭니다.

property is_closed

property is_closed: bool

케이스가 종료되었는지 여부를 나타냅니다.

property is_open

property is_open: bool

케이스가 열려 있는지 여부를 나타냅니다.

class TIPCommon.data_models.CasePriority

클래스 TIPCommon.data_models.CasePriority(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

기본: 열거형

알림의 우선순위 수준을 나타냅니다.

상수

  • CRITICAL = 100

  • HIGH = 80

  • INFORMATIVE = -1

  • LOW = 40

  • MEDIUM = 60

  • UNCHANGED = 0

class TIPCommon.data_models.CaseWallAttachment

클래스 TIPCommon.data_models.CaseWallAttachment(name: 'str', file_type: 'str', base64_blob: 'str', is_important: 'bool', case_id: 'int | None' = None)

기본: object

케이스 월에 추가할 첨부파일을 나타냅니다.

속성

속성 설명 유형
base64_blob 첨부파일의 base64 인코딩 콘텐츠입니다. str
case_id 첨부파일이 속한 케이스의 ID입니다. int | None
file_type 첨부파일의 파일 형식입니다. str
is_important 첨부파일이 중요로 표시되었는지 여부를 나타냅니다. bool
name 첨부파일의 이름입니다. str

class TIPCommon.data_models.ConnectorCard

클래스 TIPCommon.data_models.ConnectorCard(integration: str, display_name: str, identifier: str, is_enabled: bool, is_remote: bool, status: ConnectorConnectivityStatusEnum)

기본: object

커넥터 인스턴스의 요약 카드를 나타냅니다.

classmethod from_json(connector_card_json: MutableMapping[str, Any])→ ConnectorCard

JSON 딕셔너리에서 ConnectorCard 객체를 만듭니다.

class TIPCommon.data_models.ConnectorConnectivityStatusEnum

클래스 TIPCommon.data_models.ConnectorConnectivityStatusEnum(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

기본: 열거형

커넥터의 연결 상태를 나타냅니다.

상수

  • LIVE = 0

  • NO_CONNECTIVITY = 1

class TIPCommon.data_models.ConnectorParamTypes

클래스 TIPCommon.data_models.ConnectorParamTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

기본: 열거형

상수

커넥터 매개변수의 유형을 나타냅니다.

  • BOOLEAN = 0

  • DOMAIN = 7

  • EMAIL = 8

  • HOST = 5

  • INTEGER = 1

  • IP = 4

  • NULL = -1

  • PASSWORD = 3

  • SCRIPT = 12

  • STRING = 2

  • URL = 6

class TIPCommon.data_models.ConnectorParameter

클래스 TIPCommon.data_models.ConnectorParameter(raw_param)

기반: Parameter

커넥터 매개변수를 나타냅니다.

속성

속성 설명
name 매개변수의 이름입니다.
value 매개변수의 값입니다.
type 매개변수의 유형입니다 (ConnectorParamTypes에 따름).
mode 매개변수의 모드입니다.
is_mandatory 매개변수가 필수인지 정의합니다.
예
>>> from data_models import ConnectorParameter, ConnectorParamTypes
>>> p = ConnectorParameter({
    'param_name': 'api_root',
    'type': ConnectorParamTypes.STRING,
    'param_value': 'http://foo.bar',
    'is_mandatory': True,
    'mode': 0
    })
>>> print(p)
ConnectorParameter(name='api_root', value='http://foo.bar', type=2, mode=0, is_mandatory=True)

class TIPCommon.data_models.Container

기본: object

변수 컨테이너를 나타냅니다.

예
>>> from data_models import Container
>>> container = Container()
>>> container.one = 1
>>> container.one
1

class TIPCommon.data_models.CustomField

클래스 TIPCommon.data_models.CustomField(id: 'int', display_name: 'str', description: 'str', type: 'str', scopes: 'list[CustomFieldScope]')

기본: object

플랫폼 내의 맞춤 필드 정의를 나타냅니다.

속성

속성 설명
description str

맞춤 입력란의 설명입니다.
display_name str

맞춤 필드의 표시 이름입니다.
id int

맞춤 필드의 고유 ID입니다.
scopes list[CustomFieldScope]

범위 (예: 맞춤 입력란이 적용되는 알림, 케이스)
type str

맞춤 필드의 데이터 유형입니다.

classmethod from_json(json_data: MutableMapping[str, Any])→ CustomField

JSON 딕셔너리에서 CustomField 객체를 만듭니다.

class TIPCommon.data_models.CustomFieldScope

클래스 TIPCommon.data_models.CustomFieldScope(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

기본: 열거형

맞춤 입력란을 적용할 수 있는 가능한 범위를 나타냅니다.

상수

  • ALERTS = 'Alert'

  • CASE = 'Case'

메서드

  • build_parent_path(identifier: int)→ str 식별자를 기반으로 맞춤 입력란 값의 상위 경로를 빌드합니다.

class TIPCommon.data_models.CustomFieldValue

클래스 TIPCommon.data_models.CustomFieldValue(custom_field_id: 'int', values: 'list[str]', scope: 'CustomFieldScope', identifier: 'int')

기본: object

특정 맞춤 입력란에 설정된 값을 나타냅니다.

속성

속성 설명
custom_field_id int

맞춤 입력란의 ID입니다.
identifier int

값이 속한 엔티티 (케이스/알림)의 ID입니다.
scope CustomFieldScope

범위 (예: 맞춤 입력란 값이 적용되는 항목(예: 알림, 케이스)을 선택합니다.
values list[str]

맞춤 입력란에 설정된 값 목록입니다.

classmethod from_json(json_data: MutableMapping[str, Any])→ CustomFieldValue

JSON 딕셔너리에서 CustomFieldValue 객체를 만듭니다.

class TIPCommon.data_models.DatabaseContextType

클래스 TIPCommon.data_models.DatabaseContextType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

기본: 열거형

데이터 저장소의 데이터베이스 컨텍스트 유형을 나타냅니다.

상수

  • ALERT = 2

  • CASE = 1

  • CONNECTOR = 4

  • GLOBAL = 0

  • JOB = 3

class TIPCommon.data_models.EventPropertyField

클래스 TIPCommon.data_models.EventPropertyField(order: int, group_name: str, is_integration: bool, is_highlight: bool, items: list[FieldItem])

기본: object

이벤트 속성 내의 필드 그룹을 나타냅니다.

classmethod from_json(event_property_field: MutableMapping[str, Any])→ EventPropertyField

JSON 딕셔너리에서 EventPropertyField 객체를 만듭니다.

class TIPCommon.data_models.FieldGroupItem

클래스 TIPCommon.data_models.FieldGroupItem(original_name: str, name: str, value: str)

기본: object

이벤트의 필드 그룹 내에 있는 단일 키-값 항목을 나타냅니다.

classmethod from_json(field_group_json: MutableMapping[str, Any])→ FieldGroupItem

JSON 딕셔너리에서 FieldGroupItem 객체를 만듭니다.

class TIPCommon.data_models.FieldItem

클래스 TIPCommon.data_models.FieldItem(original_name: str, name: str, value: str)

기본: object

필드 내의 단일 항목을 나타내며, 원래 이름, 형식화된 이름, 값을 포함합니다.

classmethod from_json(field_json: MutableMapping[str, Any])→ FieldItem

JSON 딕셔너리에서 FieldItem 객체를 만듭니다.

class TIPCommon.data_models.FieldsGroup

클래스 TIPCommon.data_models.FieldsGroup(order: int, group_name: str, is_integration: bool, is_highlight: bool, items: list[[FieldGroupItem]])

기본: object

더 큰 데이터 구조 내의 필드 그룹을 나타내며, 주로 표시용으로 사용됩니다.

classmethod from_json(field_group_json: Dict[str, Any])→ FieldsGroup

JSON 딕셔너리에서 FieldsGroup 객체를 만듭니다.

class TIPCommon.data_models.GoogleServiceAccount

클래스 TIPCommon.data_models.GoogleServiceAccount(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)

기본: object

Google 서비스 계정의 속성을 나타냅니다.

메서드

  • to_dict()→ dict 데이터 모델을 dict로 직렬화합니다.

반환

서비스 계정 JSON 사전입니다.

반환 유형

dict

class TIPCommon.data_models.InstalledIntegrationInstance

클래스 TIPCommon.data_models.InstalledIntegrationInstance(instance: MutableMapping[str, Any], identifier: str, integration_identifier: str, environment_identifier: str, instance_name: str)

기본: object

환경 내에 설치된 통합 인스턴스를 나타냅니다.

classmethod from_json(integration_env_json: MutableMapping[str, Any])→ InstalledIntegrationInstance

JSON 딕셔너리에서 InstalledIntegrationInstance 객체를 만듭니다.

매개변수
매개변수
integration_env_json SingleJson

통합 환경 정보가 포함된 JSON 데이터입니다.
반환

raw_data의 데이터로 초기화된 지정된 클래스의 인스턴스입니다.

반환 유형

InstalledIntegrationInstance

class TIPCommon.data_models.JobParamType

클래스 TIPCommon.data_models.JobParamType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

기본: 열거형

상수

  • BOOLEAN = 0

  • DOMAIN = 7

  • HOST = 5

  • INTEGER = 1

  • IP = 4

  • NULL = -1

  • PASSWORD = 3

  • STRING = 2

  • URL = 6

class TIPCommon.data_models.Parameter

클래스 TIPCommon.data_models.Parameter(raw_param)

기본: object

매개변수를 나타내는 상위 클래스입니다.

속성

속성 설명
raw_data 매개변수의 원시 데이터입니다.
예
>>> from data_models import Parameter
>>> p = Parameter({'foo': 'bar'})
>>> print(p)
Parameter(raw_data={'foo': 'bar'})

class TIPCommon.data_models.SLA

클래스 TIPCommon.data_models.SLA(sla_expiration_time: int | None, critical_expiration_time: int | None, expiration_status: int, remaining_time_since_last_pause: int | None)

기본: object

케이스 또는 알림의 서비스수준계약 (SLA) 세부정보를 나타냅니다.

classmethod from_json(sla_json: Dict[str, Any])→ SLA

JSON 딕셔너리에서 SLA 객체를 만듭니다.

class TIPCommon.data_models.ScriptContext

클래스 TIPCommon.data_models.ScriptContext(target_entities: 'str' = '', case_id: 'int | str | None' = None, alert_id: 'str' = '', environment: 'str' = '', workflow_id: 'str' = '', workflow_instance_id: 'str | None' = None, parameters: 'SingleJson' = <factory>, integration_identifier: 'str' = '', integration_instance: 'str' = '', action_definition_name: 'str' = '', original_requesting_user: 'str' = '', execution_deadline_unix_time_ms: 'int' = 0, async_polling_interval_in_sec: 'int' = 0, async_total_duration_deadline: 'int' = 0, script_timeout_deadline: 'int' = 0, default_result_value: 'str' = '', use_proxy_settings: 'bool' = False, max_json_result_size: 'int' = 15, vault_settings: 'SiemplifyVault | None' = None, environment_api_key: 'str | None' = None, unique_identifier: 'str' = '', job_api_key: 'str' = '', connector_context: 'ConnectorContext | None' = None)

기본: object

스크립트 또는 작업의 실행 컨텍스트를 나타내며 다양한 런타임 매개변수와 데이터에 대한 액세스를 제공합니다.

속성

속성 설명
action_definition_name str

실행 중인 작업 정의의 이름입니다.

기본값은 ''입니다.
alert_id str

현재 실행과 연결된 알림의 ID입니다.

기본값은 ''입니다.
async_polling_interval_in_sec int

비동기 폴링 간격(초)입니다.

기본값은 0입니다.
async_total_duration_deadline int

비동기 작업의 총 기간 기한입니다.

기본값은 0입니다.
case_id int | str | None

현재 실행과 연결된 케이스의 ID입니다.

기본값은 None입니다.
connector_context ConnectorContext | None

커넥터 실행과 관련된 컨텍스트입니다.

기본값은 None입니다.
default_result_value str

작업 결과의 기본값입니다.

기본값은 ''입니다.
environment str

실행 환경입니다.

기본값은 ''입니다.
environment_api_key str | None

환경의 API 키입니다.

기본값은 None입니다.
execution_deadline_unix_time_ms int

실행 기한을 나타내는 Unix 타임스탬프 (밀리초)입니다.

기본값은 0입니다.
integration_identifier str

사용 중인 통합의 식별자입니다.

기본값은 ''입니다.
integration_instance str

사용 중인 통합 인스턴스의 이름입니다.

기본값은 ''입니다.
job_api_key str

작업에 특정한 API 키입니다.

기본값은 ''입니다.
max_json_result_size int

JSON 결과에 허용되는 최대 크기입니다.

기본값은 15입니다.
original_requesting_user str

원래 요청을 시작한 사용자입니다.

기본값은 ''입니다.
parameters SingleJson

스크립트/작업의 매개변수가 포함된 JSON 객체입니다.
script_timeout_deadline int

스크립트 실행 제한 시간의 기한입니다.

기본값은 0입니다.
target_entities str

쉼표로 구분된 타겟 항목 문자열입니다.

기본값은 ''입니다.
unique_identifier str

실행 컨텍스트의 고유 식별자입니다.

기본값은 ''입니다.
use_proxy_settings bool

프록시 설정을 사용해야 하는지 여부를 나타냅니다.

기본값은 False입니다.
vault_settings SiemplifyVault | None

보안 사용자 인증 정보 검색을 위한 보관소 설정입니다.

기본값은 None입니다.
workflow_id str

워크플로의 ID입니다.

기본값은 ''입니다.
workflow_instance_id str | None

워크플로 인스턴스의 ID입니다.

기본값은 None입니다.

메서드

  • to_json()→ MutableMapping[str, Any] 컨텍스트 객체를 변경 가능한 매핑 (JSON 사전)으로 직렬화합니다.

  • update(attributes: MutableMapping[str, Any])→ None 변경 가능한 매핑의 새 속성으로 컨텍스트 객체를 업데이트합니다.

class TIPCommon.data_models.SmimeEmailConfig

클래스 TIPCommon.data_models.SmimeEmailConfig(email: 'email.message.Message', private_key_b64: 'str', certificate_b64: 'str', ca_certificate_b64: 'str')

기본: object

S/MIME 암호화 또는 서명된 이메일 전송을 위한 구성을 나타냅니다.

속성

속성 설명
ca_certificate_b64 str

base64로 인코딩된 CA 인증서입니다.
certificate_b64 str

base64로 인코딩된 인증서입니다.
email Message

이메일 메시지 객체입니다.
private_key_b64 str

base64로 인코딩된 비공개 키입니다.

class TIPCommon.data_models.SmimeType

클래스 TIPCommon.data_models.SmimeType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

기본: 열거형

S/MIME 작업 유형을 나타냅니다.

상수

  • ENCRYPTED = 'encrypted'

  • SIGNED = 'signed'

class TIPCommon.data_models.TypedContainer

클래스 TIPCommon.data_models.TypedContainer(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

기본: Generic[T]

타입 인텔리센스를 제공하는 특정 타입의 컨테이너입니다.

class TIPCommon.data_models.UserProfileCard

클래스 TIPCommon.data_models.UserProfileCard(raw_data: dict, first_name: str, last_name: str, user_name: str, account_state: int)

기본: object

사용자 프로필 요약 카드를 나타냅니다.

classmethod from_json(user_profile_card_response: dict)→ UserProfileCard

JSON 딕셔너리에서 UserProfileCard 객체를 만듭니다.

도움이 더 필요하신가요? 커뮤니티 회원 및 Google SecOps 전문가로부터 답변을 받으세요.