Skip to main content
Version: 4.3

System data mapping

This page describes how data retrieved from the source service is mapped into records generated by the connector.

For each record type, the following information is reported:

  • the property name exposed by the connector;
  • the path from which the value is obtained in the source service;
  • any additional note regarding transformations, enrichments or special behaviours.

Each record mapping section is titled {Source Object Name} ({_type}), combining the object name used by the source service with the internal record type produced by the connector.

Common properties​

Property nameSource pathNotes
_typeRecord type: sitegroup, site, device or networkinterface

Notes​

  • Dates are normalized to the ISO 8601 format.
  • Properties marked "joined with ," are lists of the source object converted to a single string, with the elements separated by a comma.

Site group (sitegroup)​

A group of sites, as returned by the site-groups/get API.

Property nameSource pathNotes
idid
namename
notenote
number_of_sitesnumber_of_sitesWhen number_of_sites is empty, the number of elements of sites is used

Site (site)​

A site (physical location) in which Claroty discovers the devices, as returned by the sites/get API.

Property nameSource pathNotes
idid
namenameUsed to identify the site in the relations from devices
locationlocation
timezonetimezone
country_codecountry_code
descriptiondescription
devices_countdevices_count
site_groupsite_group_idRecord Id of the related sitegroup

Device (device)​

A device (OT, IoT or IT asset) discovered by Claroty, as returned by the devices API.

Property nameSource pathNotes
idasset_id
namedevice_name
categorydevice_category
subcategorydevice_subcategory
uiduid
detector_namedetector_name
type_familydevice_type_family
typedevice_type
modelmodel
model_familymodel_family
serial_numberserial_number
retiredretired
retired_sinceretired_sinceISO date
labelslabelsJoined with ,
assigneesassigneesJoined with ,
hw_versionhw_version
local_namelocal_name
os_nameos_name
os_versionos_version
os_revisionos_revision
os_patch_levelos_patch_level
os_categoryos_category
os_subcategoryos_subcategory
os_eol_dateos_eol_dateISO date
combined_oscombined_os
management_servicesmanagement_servicesJoined with ,
last_domain_userlast_domain_user
last_domain_user_activitylast_domain_user_activityISO date
mobilitymobility
criticalitycriticality
purdue_levelpurdue_level
purdue_level_sourcepurdue_level_source
windows_hostnamewindows_last_seen_hostname
dhcp_hostnamedhcp_last_seen_hostname
http_hostnamehttp_last_seen_hostname
snmp_hostnamesnmp_last_seen_hostname
other_hostnamesother_hostnamesJoined with ,
notenote
domainsdomainsJoined with ,
internet_communicationinternet_communication
machine_typemachine_type
number_of_nicsnumber_of_nics
is_onlineis_online
manufacturermanufacturer
product_codeproduct_code
financial_costfinancial_cost
end_of_life_stateend_of_life_state
end_of_sale_dateend_of_sale_date
end_of_life_dateend_of_life_date
risk_scorerisk_score
software_or_firmware_versionsoftware_or_firmware_version
utilization_rateutilization_rate
activity_rateactivity_rate
sitesite_nameRecord Id of the related site, matched by site name (case insensitive)

Network interface (networkinterface)​

Calculated record: Claroty does not expose network interfaces as separate objects, but returns their data inside each device as parallel lists (the *_list fields), where the elements with the same index refer to the same interface. The connector generates one record for each index from 0 to number_of_nics - 1 of each device.

Property nameSource pathNotes
codemac_list, ip_listMAC address and IP address of the interface joined with - (empty values are skipped)
asset_idasset_idAsset id of the device
mac_addressmac_list
mac_oui_vendormac_oui_list
ip_addressip_list
ip_assignmentip_assignment_list
network_typenetwork_list
network_scopenetwork_scope_list
connection_typeconnection_type_list
wireless_network_namessid_list
access_point_nameap_name_list
access_point_macbssid_list
access_point_locationap_location_list
access_point_last_seenwifi_last_seen_listISO date
switch_nameswitch_name_list
switch_locationswitch_location_list
switch_macswitch_mac_list
switch_ipswitch_ip_list
switch_portswitch_port_list
switch_port_descriptionswitch_port_description_list
switch_last_seenlast_seen_on_switch_listISO date
vlan_idvlan_listConverted to string
vlan_namevlan_name_list
vlan_descriptionvlan_description_list
vlan_qualifiervlan_qualifier_list
first_seenfirst_seen_listISO date
last_seenlast_seen_listISO date
deviceasset_idRecord Id of the related device

Notes​

  • Each list field contributes the element at the index of the interface; when a list is missing or shorter, the property is empty.
  • No interface is generated for devices without asset_id or number_of_nics, and for the indexes where both the MAC address and the IP address are empty.