Модель
Модель данных ServiceAsset
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор актива |
| created_at | string |
Required | Дата создания в формате date-time |
| updated_at | string |
Required | Дата изменения в формате date-time |
| type | string |
Required | Тип актива |
| name | string |
Required | Название актива |
| description | string |
Optional | Описание актива |
| coordinates | string |
Optional | Координаты актива (не используется) |
| active | boolean |
Optional | Флаг активности |
| scan_id | string |
Optional | ID сканера активов (не используется) |
| value | integer |
Optional | Значимость актива В платформе значимость актива может принимать следующие значения: - 1 – ключевой; - 2 – важный; - 3 – некритичный; - 4 – распределенный; - 5 – тестовый. |
| client_note | string |
Optional | Клиентские заметки (не используется) |
| internal_note | string |
Optional | Внутренние заметки (не используется) |
| location | string |
Required | Расположение актива |
| network_exposure | integer |
Optional | Сетевая доступность актива. Тип сетевой видимости актива может принимать следующие значения: - 1 – актив напрямую подключен к сети Интернет; - 2 – актив располагается в демилитаризованной зоне (DMZ); - 3 – актив подключен к сети Интернет через Proxy-сервер; - 4 – актив имеет ограниченный доступ к сети Интернет и к ограниченному набору онлайн-сервисов. Например, тонкие клиенты, POS-терминалы, удаленные офисы; - 5 – актив не подключен к сети. |
| responsible_person | string |
Optional | Ответственное лицо |
| technical_specialist | string |
Optional | Технический специалист |
| responsible_group_id | string |
Optional | ID группы ответственных |
| edited_by | string |
Optional | Кем изменён (не используется) |
| hardware_informations | Array<HardwareInformation> |
Optional | Связанная информация по аппаратному обеспечению |
| logmule_go_results | Array<LogmuleGoResult> |
Optional | Связанные результаты сработки |
| messages | Array<Message> |
Optional | Связанные сообщения пользователей |
| network_interfaces | Array<Network_interfaces> |
Optional | Связанные сетевые интерфейсы |
| service_asset_findings | Array<Service_asset_finding> |
Optional | Связанные инциденты |
| service_asset_groups | Array<Service_asset_group> |
Optional | Связанные группы активов |
| software | Array<Software> |
Optional | Связанное ПО |
| vulnerabilities | Array<Vulnerability> |
Optional | Связанные уязвимости |
| vulnerability_hosts | Array<Vulnerability_host> |
Optional | Связанные уязвимые хосты |
| responsible_group | object<ResponsibleGroup> |
Optional | Группа ответственных пользователей |
| _relations | object<relations> |
Optional | Словарь идентификаторов связанных объектов |
| is_local | boolean |
Optional | Флаг, является ли актив локальным |
| risk | string |
Optional | Словесное описание критичности риска (вычисляется по связанным инцидентам). Доступные значения: - none - low - medium - high |
| risklevel | number |
Optional | Числовое выражение критичности риска (вычисляется по связанным инцидентам) |
| mac_ip | object<mac_ip> |
Optional | Список объектов описывающих IP и MAC связанных сетевых интерфейсов |
| os_list | Array<string> |
Optional | Список ОС, установленных на связанных сетевых интерфейсах |
| responsible_group_name | string |
Optional | Название группы ответственных пользователей |
| closed_count | number |
Optional | Кол-во закрытых инцидентов |
| risk_accepted_count | number |
Optional | Кол-во инцидентов со статусом “Риск принят” |
| all_open_count | number |
Optional | Кол-во открытых инцидентов |
| last_scan | string |
Optional | Дата и время последнего сканирования актива в формате date-time |
| authenticated | boolean |
Optional | Признак использования аутентификации при сканировании |
| authentication_info | object |
Optional | Объект содержащий метаинформацию об аутентификации при сканировании |
| network_interface_ids | Array<string> |
Optional | Список идентификаторов связанных сетевых интерфейсов |
Модель данных Hardware_Information
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| hardware_type | string |
Optional | Тип аппаратного обеспечения |
| name | string |
Optional | Наименование аппаратного обеспечение |
| manufacturer | string |
Optional | Производитель |
| serial_number | string |
Optional | Серийный номер |
| additional_info | string |
Optional | Дополнительные сведения |
| is_old | boolean |
Optional | Флаг, устаревшая ли информация о состоянии аппаратного обеспечения |
Модель данных LogmuleGoResult
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор результата сработки парвила |
| created_at | string time |
Required | Дата создания результата сработки в формате: date-time |
| updated_at | string time |
Required | Дата изменения результата сработки в формате: date-time |
| rule_id | string |
Required | Идентификатор правила |
| analysis_output | string |
Required | Результат анализа |
| event | object |
Required | Событие строкой |
| compressed_event | string array |
Required | Событие одной строкой в формате byte array |
| risklevel | number float |
Required | Уровень риска в формате float |
| occurred_at | string time |
Required | Дата и время происшествия в формате: date-time |
| occurrence_id | string |
Required | Идентификатор происшествия |
| error | string |
Required | Ошибка |
| service_asset_id | string |
Required | Идентификатор актива |
| asset_info | object<asset> |
Required | Данные актива |
| incident_identifier | string |
Required | Идентификатор инцидента |
| metadata | string map |
Required | Метаданные в формате map |
LogmuleGoResultsAsset
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| ip | string |
Required | IP-адрес актива |
| hostname | string |
Required | Хостнейм актива |
| fqdn | string |
Required | FQDN актива |
| mac | string |
Required | MAC-адрес актива |
Модель данных Message
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор сообщения пользователя |
| created_at | string |
Required | Дата создания в формате date-time |
| updated_at | string |
Required | Дата изменения в формате date-time |
| subject | string |
Optional | Тема (Предмет) сообщения |
| body | string |
Optional | Тело сообщения |
| service_asset_id | string |
Optional | Идентификатор связанного актива |
| service_asset_finding_id | string |
Optional | Идентификатор связанного инцидента |
| service_asset_finding_status_change_id | string |
Optional | Идентификатор связанного изменения статуса инцидента |
| automated | boolean |
Optional | Флаг автоматического создания |
| finding_id | string |
Optional | Идентификатор связанного типа инцидента |
| itsm_sync_status | string |
Optional | Статус синхронизации с внешними системами. Допустимые значения: - not_synced - scheduled - aborted - synced - waiting_confirmation |
| itsm_last_synced_at | string |
Optional | Время синхронизации с внешними системами |
| itsm_sync_error | string |
Optional | Описание ошибки синхронизации |
| sender_id | string |
Optional | Идентификатор пользователя инициировавшего синхронизацию |
Модель данных Network_Interface
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор сетевого интерфейса |
| created_at | string |
Required | Дата создания в формате date-time |
| updated_at | string |
Required | Дата изменения в формате date-time |
| name | string |
Required | Название сетевого интерфейса |
| ip | string |
Optional | IP адрес сетевого интерфейса |
| mac | string |
Optional | MAC адрес сетевого интефейса |
| fqdn | string |
Optional | FQDN |
| os | string |
Optional | Операционная система |
| service_asset_id | string |
Optional | Идентификатор связанного актива |
| edited_by | string |
Optional | Идентификатор пользователя внесшего изменения |
| service_asset_name | string |
Optional | Название связанного актива |
| service_asset_location | string |
Optional | Локация связанного актива |
| service_asset_value | integer |
Optional | Значение связанного актива |
| service_asset_network_exposure | integer |
Optional | Коэфициент сетевой видимости связанного актива |
| service_asset_group_names | Array<string> |
Optional | Список названий связанных групп активов |
| has_service_asset | boolean |
Optional | Флаг, является ли активом |
Модель данных ServiceAssetFinding
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор инцидента |
| created_at | string time |
Required | Дата создания в формате: date-time |
| updated_at | string time |
Required | Дата изменения в формате: date-time |
| trace_id | string |
Required | Идентификатор трассировки действия пользователя для аудита |
| description | string |
Required | Подробное описание инцидента |
| risk_impact | string |
Required | Описание последствий, которые могут возникнуть, если угроза была реализована |
| solution | string |
Required | Рекомендации по устранению инцидента |
| mitigation | integer |
Required | Описание профилактики данного типа инцидента |
| status | string |
Required | Cостояние инцидента в зависимости от того какая с ним работа была проведена оператором. Допустимые значения: - assigned_customer - назначен; - closed - закрыт; - feedback_required - запрошена информация; - invalid - недействительный; - new - новый; - risk_accepted - риск принят - verify_close - ожидает проверки; - working_customer - в работе. Подробнее см. раздел Инциденты |
| risklevel | number |
Required | Уровень риска. Допустимые значения от "0" до "10" |
| service_asset_id | string |
Required | Идентификатор актива, на котором обнаружен инцидент |
| finding_id | string |
Required | Идентификатор типа инцидента |
| analysis_output | string |
Required | Результат анализа. Заполняемое поле в правиле корреляции. Например: на активе {{ .event.IP}} произошло… |
| synopsis | string |
Required | Краткое описание сути инцидентов данного типа |
| title | string |
Required | Название инцидента |
| risk | string |
Required | Описание уровня риска инцидента. Допустимые значения: - none; - low; - medium; - high. |
| acknowledged_at | string |
Required | Дата выявления / обнаружения инцидента |
| alert_type | string |
Required | Политика поведения платформы над инцидентом при "сработке" правила корреляции |
| client_note | string |
Optional | Заметки клиента |
| internal_note | string |
Optional | Внутреннее примечание |
| external | boolean |
Required | Эксплуатируема ли удаленно уязвимость, на основе которой создан инцидент |
| immediate_action_score | number |
Required | Cрочность инцидента. Результат перемножения уровня риска, которое было присвоено по результату сработки правила корреляции и “значимости актива”. при этом значимость актива из 2х параметров. Значимость и сетевая видимость. |
| throughput_period | string |
Required | Cтатус инцидент в логике оповещений операторов о задержке в обработке. Допустимые значения: - grace; - delay; - unacceptable. |
| throughput_period_change | string format: date-time |
Required | Время изменения поля throughput_period |
| customer_created | boolean |
Optional | Флаг, что создан пользователем, а не автоматически |
| c_visible_since | string |
Optional | Дата и время с которой инцидент виден пользователям |
| c_visible_since_in_days | integer |
Optional | Количество дней, в течение которых инцидент виден пользователям |
| c_reopened_count | integer |
Optional | Количество повторных открытий инцидента |
| c_last_customer_status_change | string |
Optional | Дата и время последнего изменения статуса инцидента пользователем |
| logmule_identifier | string |
Optional | Идентификатор, который можно задать в правиле (текстовое), а потом использовать для фильтрации. |
| c_remote_exploitable | boolean |
Required | Возможность удаленного использования |
| c_occurrence_count | integer |
Required | Количество происшествий в инциденте |
| с_customer_retention_time | integer |
Required | Коэффициент задержки пользователя |
| last_occurrence_id | string |
Required | Идентификатор последнего происшествия |
| itsm_last_synced_at | string format: date-time |
Optional | Время последнего изменения статуса происшествия, который был отправлен в стороннюю систему |
| itsm_sync_status | string |
Optional | Статус происшествия, отправленного в стороннюю систему. Допустимые значения: - scheduled; - aborted; - synced; - not_synced; - waiting_confirmation |
| external_id | string |
Optional | Идентификатор инцидента во внешней клиентской системе |
| itsm_sync_error | string |
Optional | Ошибка синхронизации с внешней клиентской системой |
| user_id | string |
Optional | Идентификатор пользователя назначенного на инцидент |
| updated_by | string |
Optional | Идентификатор пользователя, который последний обновил инцидент |
| group_id | string |
Optional | Группа пользователей назначенных на инцидент |
| acknowledged_by | string |
Optional | Идентификатор пользователя, который подтвердил инцидент |
| created_by_customer | string |
Optional | Идентификатор пользователя, который вручную создал инцидент |
| edited_by | string |
Optional | Идентификатор пользователя, который последний отредактировал инцидент, созданный вручную |
| incident_group_id | string |
Optional | Идентификатор группы инцидентов, в которую входит инцидент |
| reopened_at | string |
Optional | Время когда данный инцидент был открыт заново |
| display_id | integer |
Required | Идентификатор инцидента, созданный по алгоритму, который регулирует последовательность присвоения идентификаторов |
Модель данных ServiceAssetGroup
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор группы активов |
| created_at | string |
Required | Дата создания в формате date-time |
| updated_at | string |
Required | Дата изменения в формате date-time |
| name | string |
Required | Название группы активов |
| network_ranges | Array<string> |
Optional | Список подсетей |
| domain | string |
Optional | Домен |
| itsm_synced | boolean |
Optional | Признак синхронизации с системой управления ИТ-услугами |
| regex | string |
Optional | Регулярное выражение |
| subject_id | string |
Optional | Идентификатор субъекта |
| object_id | string |
Optional | Идентификатор обьекта |
| is_kii | boolean |
Optional | Призкак принадлежности к обьктам критической инфраструктуры |
| is_fincert | boolean |
Optional | Признак вхождения в систему информационного обмена между участниками финансового рынка |
| responsible_person | string |
Optional | Имя отвественного пользователя |
| technical_specialist | string |
Optional | Технический специалист |
| system_id | string |
Optional | Идентификатор системы |
| responsible_group_id | string |
Optional | Идентификатор отвественной группы |
| edited_by | string |
Optional | Идентификатор пользователя, внесшего изменения |
Модель данных Software
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор |
| created_at | string |
Required | Дата создания |
| updated_at | string |
Required | Дата изменения |
| trace_id | string |
Required | Идентификатор трассировки действия пользователя для аудита |
| name | string |
Required | Название |
| raw_output_line | string |
Optional | Необработанная строка данных (уникальное значение) |
| version | string |
Optional | Версия |
| release | string |
Optional | Релиз При создании из результата сканирования, совпадает с version. При сканировании ПО, не заполняется. |
| os | string |
Optional | Операционная система |
| display_name | string |
Optional | Название клиента (отображается в деталях инцидента) |
| description | string |
Optional | Описание |
| software_group_id | string |
Optional | ID группы ПО |
| tsvector | string |
Optional | readonly Используется для оптимизации поиска, заполняется автоматически (при создании и изменении объекта) из полей raw_output_line, name, version, release. |
Модель данных Vulnerability
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор |
| created_at | string |
Required | Дата создания в формате: date-time |
| updated_at | string |
Required | Дата изменения в формате: date-time |
| plugin_id | integer |
Optional | ID плагина |
| plugin_name | string |
Optional | Название плагина |
| description | string |
Optional | Описание уязвимости |
| severity | integer |
Optional | Важность |
| additional_data | Array<object> |
Optional | Дополнительные данные в формате map<string,string> |
| protocol | string |
Optional | Тип протокола (tcp, udp и пр.). “-1”, если не определён |
| port | integer |
Optional | Порт |
| occurrence_id | string |
Optional | ID происшествия в формате uuid |
| synopsis | string |
Optional | Краткое описание |
| vulnerability_host_id | string |
Optional | ID хоста уязвимости |
| exploitable | boolean/null |
Optional | Флаг возможности использования |
| plugin_output | string |
Optional | Результат работы плагина, зависит от типа отчета (сканирования) |
| solution | string |
Optional | Алгоритм устранения уязвимости |
| compare_port | integer |
Optional | При создании из результата сканирования, совпадает с полем port |
| compare_protocol | string |
Optional | При создании из результата сканирования, совпадает с полем protocol |
| service_asset_id | string |
Optional | ID актива |
| vulnerability_scan_id | string |
Optional | ID результата сканирования (отчёта) |
| external | boolean |
Optional | Флаг внешней уязвимости |
| remote_exploitable | boolean |
Optional | Флаг возможности удалённого использования |
| cvss_vector | string |
Optional | Вектор метрик оценки по CVSS |
| cvss_temporal_vector | string |
Optional | Вектор временных метрик оценки по CVSS |
| cvss_base_score | number |
Optional | Оценка уязвимости по CVSS |
| cvss_temporal_score | number |
Optional | Временная оценка уязвимости по CVSS |
| risk_factor | string |
Optional | Текстовая степень важности (none, low, medium и т.д.) |
| plugin_modification_date | string |
Optional | Дата изменения плагина (не связано с изменениями в БД, заполняется из результата сканирования) в формате: date-time |
| publication_date | string |
Optional | Дата публикации в формате: date-time |
Модель данных VulnerabilityHost
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор |
| created_at | string |
Required | Дата создания в формате: date-time |
| updated_at | string |
Required | Дата изменения в формате: date-time |
| ip | string |
Optional | IP-адрес |
| mac | string |
Optional | MAC-адрес |
| fqdn | string |
Optional | Доменное имя |
| properties | string |
Optional | Дополнительные свойства (не используется) |
| scan_begin | null / string |
Optional | Начало сканирования в формате: date-time |
| scan_end | null / string |
Optional | Окончание сканирования в формате: date-time |
| service_asset_id | string |
Optional | Идентификатор актива |
| vulnerability_scan_id | string |
Optional | Идентификатор результата сканирования |
| os | string |
Optional | Операционная система |
| authenticated | boolean |
Optional | Флаг аутентификации |
| scan_error | string |
Optional | Ошибка при сканировании |
| name | string |
Required | Название |
| authentication_info | object |
Optional | Информация для аутентификации (не используется) Словарь (ключ-значение) - ключ: string - значение: любой тип |
Модель данных ResponsibleGroup
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор группы ответственных пользователей |
| name | string |
Required | Название группы |
| parent_group | string |
Required | Название родительской группы |
| realm_id | string |
Required | Идентификатор области |
string |
Required | Почта | |
| phone_number | string |
Required | Телефон |
| leader_id | string |
Required | Идентификатор руководителя группы |
| accept_risk | boolean |
Required | Флаг автоматического принятия риска |
| visible_scan_schedules | boolean |
Required | Флаг видимости расписания сканирования |
| stop_scans | boolean |
Required | Флаг прекращения сканирования |
| edited_by | string |
Required | Идентификатор пользователя, изменившего информацию о группе |
| user_ids | Array<string> |
Required | Список ID пользователей в группе |
Модель данных _relations
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| hardware_informations | Array<string> |
Optional | Список связанных идентификаторов моделей информации об аппаратном обеспечении |
| logmule_go_results | Array<string> |
Optional | Список связанных идентификаторов моделей сработок |
| messages | Array<string> |
Optional | Список связанных идентификаторов моделей сообщений пользователей |
| network_interfaces | Array<string> |
Optional | Список связанных идентификаторов моделей сетевых интерфейсов |
| service_asset_findings | Array<string> |
Optional | Список связанных идентификаторов моделей инцидентов |
| service_asset_groups | Array<string> |
Optional | Список связанных идентификаторов моделей групп активов |
| software | Array<string> |
Optional | Список связанных идентификаторов моделей ПО |
| vulnerabilities | Array<string> |
Optional | Список связанных идентификаторов моделей уязвимостей |
| vulnerability_hosts | Array<string> |
Optional | Список связанных идентификаторов моделей хостов уязвимостей |
Модель данных mac_ip
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| ip | string |
Optional | IP адрес |
| mac | string |
Optional | MAC адрес |
| service_asset_id | string |
Optional | Идентификатор связанного актива |