Модель
Модель данных Message
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор сообщения |
| created_at | string time |
Required | Дата создания сообщения в формате: date-time |
| updated_at | string time |
Required | Дата изменения сообщения в формате: date-time |
| subject | string |
Required | Тема сообщения |
| body | string |
Required | Тело сообщения |
| service_asset_id | string |
Optional | Идентификатор связанного актива |
| service_asset_finding_id | string |
Optional | Идентификатор связанного инцидента |
| service_asset_finding_status_change_id | string |
Optional | Идентификатор связанного изменения статуса инцидента |
| automated | string |
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 | Идентификатор пользователя инициировавшего синхронизацию |
| trace_id | string |
Optional | Идентификатор трассировки действия пользователя для аудита и метрик |
| owner_id | string |
Required | Идентификатор владельца сообщения |
| from | string |
Required | Имя пользователя отправившего сообщение |
| recipient_names | Array<string> |
Required | Имена пользователей, которым адресовано сообщение |
| finding_display_id | integer |
Optional | Числовой идентификатор отображения связанной находки |
| finding_title | string |
Optional | Название связанного типа инцидента |
| finding_type | string |
Optional | Тип связанного типа инцидента. Допустимые значения: - network_anomaly - policy_violation - vulnerability |
| finding_risklevel | number |
Optional | Уровень риска связанного типа инцидента |
| service_asset_finding_risklevel | number |
Optional | Уровень риска связанного инцидента |
| service_asset_finding_title | string |
Optional | Название связанного инцидента |
| saf_service_asset_id | string |
Optional | Идентификатор связанного актива |
| service_asset_name | string |
Optional | Название связанного актива |
| incident_status | string |
Optional | Статус связанного инцидента. Допустимые значения: -assigned_customer - closed - feedback_required - invalid - new - risk_accepted - verify_close - working_customer |
| trace_id | string |
Optional | Идентификатор для отслеживания цепочки операций и аудита |
| read | boolean |
Required | Статус прочтения сообщения пользователем |
| notifications | Array<Notification> |
Required | Обьекты связанных нотификаций |
| service_asset | Object<ServiceAsset> |
Optional | Связанный актив |
| service_asset_finding | Object<ServiceAssetFinding> |
Optional | Связанный инцидент |
| service_asset_finding_status_change | Object<ServiceAssetFindingStatusChange> |
Optional | Обьект связанного изменения статуса инцидента |
| finding | Object<Finding> |
Optional | Объект связанного типа инцидента |
| sender | Object<Sender> |
Required | Пользователь, отправивший сообщение |
| _relations | Object |
Optional | Словарь, описывающий связанные модели через идентификаторы |
| _relations{notifications} | Array<string> |
Optional | Список идентификаторов связанных нотификаций |
Notifications
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор нотификации в формате: uuid |
| read | string |
Required | Время прочтения в формате: date-time |
| forwarded_at | string |
Required | Время пересылки в формате: date-time |
| message_id | string |
Required | Идентификатор сообщения в формате: uuid |
| user_id | string |
Required | Идентификатор пользователя, кому предназначена нотификация в формате: uuid |
Модель данных 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 | Кем изменён (не используется) |
Модель данных 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 | Идентификатор инцидента, созданный по алгоритму, который регулирует последовательность присвоения идентификаторов |
Модель данных ServiceAssetFindingStatusChange
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор |
| created_at | string |
Required | Дата создания |
| updated_at | string |
Required | Дата изменения |
| service_asset_finding_id | string |
Required | Идентификатор инцидента |
| status | string |
Required | Новый статус инцидента |
| revisit_at | string |
Required | Время для повторной проверки инцидента |
| itsm_sync_status | string |
Required | Статус синхронизации с внешними системами. Допустимые значения: - not_synced - scheduled - aborted - synced - waiting_confirmation |
| itsm_last_synced_at | string |
Required | Время синхронизации с внешними системами |
| itsm_sync_error | string |
Optional | Описание ошибки синхронизации |
| user_id | string |
Required | Идентификатор пользователя, который изменил статус |
Модель данных Finding
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| title | string |
Required | Наименование типа инцидента |
| description | string |
Required | Общее описание типа инцидента |
| risk_impact | string |
Required | Описание влияния инцидента на уровень риска |
| solution | string |
Required | Рекомендации по устранению инцидента |
| display_id | number |
Required | Идентификатор отображения инцидента, автоматически инкрементируется при добавлении новых |
| mitigation | string |
Required | Описание профилактики данного типа инцидента |
| synopsis | string |
Required | Краткое описание сути инцидентов данного типа |
| local | boolean |
Required | Флаг локальности типа инцидента |
| type | string |
Required | Типов уязвимости, к которому принадлежит тип инцидента. Допустимые значения:network_anomaly: сетевая аномалия - актив проявляет сетевую активность, которую проявлять не должен;policy_violation: нарушение политики - это наступление условий, нарушающих политику безопасности эксплуатации актива (задуманную службой безопасности);vulnerability: уязвимость - у злоумышленника есть возможность получить контроль (полный или частичный) над активом. |
| identifier | object |
Optional | Объект, хранящий связанные идентификаторы уязвимостей сторонних сканеров |
| comment | string |
Optional | Комментарий пользователя |
| fallback_raw_risklevel | number |
Required | Цифровое обозначение уровня риска. Допустимые значения от 0 до 10. |
| new_version | boolean |
Required | Допустимые значения: true, false. Значение по умолчанию: true. |
| client_note | string |
Optional | Заметки клиента |
| internal_note | string |
Optional | Внутренние заметки |
| cpes | Array<string> |
||
| category_id | string uuid |
Required | Идентификатор категории типов инцидентов в формате uuid |
| customer_created | boolean |
Required | Флаг характеризующий тип инцидента как созданный клиентом |
| software_compliance | boolean |
Required | Флаг соответствия программного обеспечения |
| itsm_last_synced_at | string time |
Required | Время последнего изменения статуса в системе |
| updated_by | string uuid |
Required | Идентификатор пользователя обновившего информацию о типе инцидента в формате uuid |
| created_by_customer | string uuid |
Required | Идентификатор пользователя создавшего тип инцидента в формате uuid |
| edited_by | string uuid |
Required | Идентификатор пользователя (в формате uuid) изменившего тип инцидента |
Модель данных Sender
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор пользователя |
string |
Required | Почта пользователя | |
| first_name | string |
Required | Имя пользователя |
| last_name | string |
Required | Фамилия пользователя |
| username | string |
Required | Логин пользователя |