Fortinet white logo
Fortinet white logo

User Guide

Enriched object field types

Enriched object field types

A field that is of type object simply means the field is actually a collection of sub-fields. Some of those sub-fields could also be another collection of sub-fields. Think of an object as a JSON block, or a dictionary for the Python users, or a map for the C/C++ users. Sub-fields are then referenced using dot notation, (for example, dst.geo.country).

Some object types are very common and are used over and over again, such as an ip-object. An ip-object refers to a field with the structure shown in the ip-object table. These field types are used throughout the different event types, so you should be familiar with them.

Note
Deprecation notice:

The asn.isp and asn.org fields are no longer supported. Please use asn.asn_org or asn.asn fields instead. This change applies to all IP-related fields.

The following topics provide a description of each object field type and the sub-fields it contains:

Back to top.

IP-Objects

The following table describes the fields that contain enriched information for an IP address:

Field Type Description

asn

asn-object

ASN information for the IP address

Example: See table below

$device

synthetic field

Enables querying devices by hostname or MAC address. Note: this field is only available for the src and dst fields.

geo

geo-object

Geographic information for the IP address

Example: See table below

internal

Boolean

Indicates whether the IP address is internal to the network

Example: true

ip

ip

The IP address

Example: 10.10.10.10

ip_bytes

int

The number of bytes transmitted by the IP address within the flow (only populated in Flow events)

Example: 458 Bytes

pkts

int

The number of packets transmitted by the IP address within the flow (only populated in Flow events)

Example: 8

port

int

The port used by the IP address

Example: 52843

username

int

The user name from Zscaler used in device detections (only populated in DNS, Flow, HTTP, and SSL events).

Example: john.smith@fortinet.com

hostname

int

The host name from Zscaler used in device detections (only populated in DNS, Flow, HTTP, and SSL events).

Example: F09NQJM1ABC

The asn field contains the following subfields.

Field Type Description

asn

int

The Autonomous System Number

Example: 16509

asn.asn_org

string

The organization name associated with the ASN (they actually use the ASN)

Example: Amazon.com, Inc.

asn.asn

string

The upstream ISP for the ASN

Example: Amazon.com

org

string The upstream owner of the ASN - may differ from asn_org

Example: Amazon.com

The geo field contains the following subfields.

Field Type Description

city

string

The city of record

Example: Boardman

country

string

The country of record

Example: US

location

object

The longitude and latitude of record

Example: (45.8491,-119.7143)

subdivision

string

The segment of the country (states in the US)

Example: OR

Back to Enriched object field types.

Active Directory (AD) objects

Active Directory enrichment enhances device identification by collecting hostname information from Windows AD on a scheduled basis. See Device enrichment.

When Active Directory enrichments are enabled, IP addresses are enriched with the following fields:

IP_enrichments

The following table describes the fields that contain enriched information for IP_enrichments:

Property

Type

Description

annotations

annotations object User‑ and system‑generated metadata associated with an entity or event. Annotations are typically added during investigations to capture analyst notes, contextual observations, or links to related findings, and are used to enrich the interpretation of security data.

asn

asn object ASN information for the IP address

device_data_timestamp

string

Time which device enrichment data was determined

Example: 2025-01-16T23:26:28.000000Z

device_hostnames

array A collection of hostnames associated with a device, derived from observed network activity or integrated identity sources.

device_last_logoff

string

Timestamp device was last recorded logging out

Example: 2025-01-16T22:15:08.000000Z

device_last_logon

string

Timestamp device was last recorded logging in

Example: 2025-01-16T22:13:08.000000Z

device_os_name

string

Device operating system name

Example: Windows

device_os_name_with_version

string

Device operating system with version

Example: Windows 10 Pro

device_os_version

string

Device operating system version

Example: 10.0 (54983)

device_os_version_major

string

Device operating system major version number

Example: 10

device_os_version_minor

string

Device operating system minor version number

Example: 0

geo

geo object Geographic information associated with an IP address.

internal

boolean

Indicates whether the IP address is internal to the network

Example: true

ip_enriched_with_port 1

The following table describes the fields that contain enriched information for ip_enriched_with_port 1:

Property

Type

Description

annotations

annotations object User‑ and system‑generated metadata associated with an entity or event. Annotations are typically added during investigations to capture analyst notes, contextual observations, or links to related findings, and are used to enrich the interpretation of security data.

asn

asn object ASN information for the IP address

device_data_timestamp

string

Time which device enrichment data was determined.

Example: 2025-01-16T23:26:28.000000Z

device_hostnames

array A collection of hostnames associated with a device, derived from observed network activity or integrated identity sources.

device_last_logoff

string

Timestamp device was last recorded logging out.

Example: 2025-01-16T22:15:08.000000Z

device_last_logon

string

Timestamp device was last recorded logging in.

Example: 2025-01-16T22:13:08.000000Z

device_os_name

string

Device operating system name.

Example: Windows

device_os_name_with_version

string

Device operating system with version.

Example: Windows 10 Pro

device_os_version

string

Device operating system version.

Example: 10.0 (54983)

device_os_version_major

string

Device operating system major version number.

Example: 10

device_os_version_minor

string

Device operating system minor version number.

Example: 0

geo

geo object Geographic information associated with an IP address.

internal

boolean

Indicates whether the IP address is internal to the network.

Example: true

ip

string

An IP address.

Example: 8.8.8.8

port

integer

A port number.

Example: 443

ip_enriched 1

The following table describes the fields that contain enriched information for ip_enriched 1:

Property

Type

Description

annotations

annotations object User‑ and system‑generated metadata associated with an entity or event. Annotations are typically added during investigations to capture analyst notes, contextual observations, or links to related findings, and are used to enrich the interpretation of security data.

asn

asn object ASN information for the IP address

device_data_timestamp

string

Time which device enrichment data was determined.

Example: 2025-01-16T23:26:28.000000Z

device_hostnames

array A collection of hostnames associated with a device, derived from observed network activity or integrated identity sources.

device_last_logoff

string

Timestamp device was last recorded logging out.

Example: 2025-01-16T22:15:08.000000Z

device_last_logon

string

Timestamp device was last recorded logging in.

Example: 2025-01-16T22:13:08.000000Z

device_os_name

string

Device operating system name.

Example: Windows

device_os_name_with_version

string

Device operating system with version.

Example: Windows 10 Pro

device_os_version

string

Device operating system version.

Example: 10.0 (54983)

device_os_version_major

string

Device operating system major version number.

Example: 10

device_os_version_minor

string

Device operating system minor version number.

Example: 0

geo

geo object Geographic information associated with an IP address.

internal

boolean

Indicates whether the IP address is internal to the network.

Example: true

ip

string

An IP address.

Example: 8.8.8.8

ip_enriched 2

The following table describes the fields that contain enriched information for ip_enriched 2:

Property

Type

Description

annotations

annotations object User‑ and system‑generated metadata associated with an entity or event. Annotations are typically added during investigations to capture analyst notes, contextual observations, or links to related findings, and are used to enrich the interpretation of security data.

asn

asn object ASN information for the IP address

device_data_timestamp

string

Time which device enrichment data was determined.

Example: 2025-01-16T23:26:28.000000Z

device_hostnames

array A collection of hostnames associated with a device, derived from observed network activity or integrated identity sources.

device_last_logoff

string

Timestamp device was last recorded logging out.

Example: 2025-01-16T22:15:08.000000Z

device_last_logon

string

Timestamp device was last recorded logging in.

Example: 2025-01-16T22:13:08.000000Z

device_os_name

string

Device operating system name.

Example: Windows

device_os_name_with_version

string

Device operating system with version.

Example: Windows 10 Pro

device_os_version

string

Device operating system version.

Example: 10.0 (54983)

device_os_version_major

string

Device operating system major version number.

Example: 10

device_os_version_minor

string

Device operating system minor version number.

Example: 0

geo

geo object Geographic information associated with an IP address.

internal

boolean

Indicates whether the IP address is internal to the network.

Example: true

ip

string

An IP address.

Example: 8.8.8.8

interface_enriched

The following table describes the fields that contain enriched information for an interface_enriched:

Property

Type

Description

annotations

annotations object User‑ and system‑generated metadata associated with an entity or event. Annotations are typically added during investigations to capture analyst notes, contextual observations, or links to related findings, and are used to enrich the interpretation of security data.

asn

asn object ASN information for the IP address

device_data_timestamp

string

Time which device enrichment data was determined.

Example: 2025-01-16T23:26:28.000000Z

device_hostnames

array A collection of hostnames associated with a device, derived from observed network activity or integrated identity sources.

device_last_logoff

string

Timestamp device was last recorded logging out.

Example: 2025-01-16T22:15:08.000000Z

device_last_logon

string

Timestamp device was last recorded logging in.

Example: 2025-01-16T22:13:08.000000Z

device_os_name

string

Device operating system name.

Example: Windows

device_os_name_with_version

string

Device operating system with version.

Example: Windows 10 Pro

device_os_version

string

Device operating system version.

Example: 10.0 (54983)

device_os_version_major

string

Device operating system major version number.

Example: 10

device_os_version_minor

string

Device operating system minor version number.

Example: 0

geo

geo object Geographic information associated with an IP address.

internal

boolean

Indicates whether the IP address is internal to the network.

Example: true

ip

string

An IP address.

Example: 8.8.8.8

mac

string

A MAC address.

Example: 00:1A:2B:3C:4D:5E

port

integer

A port number.

Example: 443

device_hostname

The following table describes the fields that contain enriched information for an device_hostname:

Property

Type

Description

domain_name

string Domain of the device's fully qualified domain name. Example: apps.google.com

fqdn

string Device's fully qualified domain name. Example: server1.apps.google.com

name

string Hostname of the device's fully qualified domain name. Example: server1

secondary_level_domain_name

string Secondary level domain of the device's fully qualified domain name. Example: google.com

Domain-Objects

The following table describes the fields that contain enriched information for a domain:

Field Type Description

domain

string

The domain

Example: portal.fortindr.forticloud.com

domain_entropy

float

The computed Shannon entropy of the domain

Example: 3.5

Back to Enriched object field types

Host-Objects

Host-Objects fields contain enriched information for both IP addresses and domains because the field could be either one. For example an HTTP Host header or a DNS answer.

Host-Objects contain the combined sub-fields in:

Back to Enriched object field types

URI-Objects

Fields that contain a URI are broken up into its different components.

Field Type Description

fragment

string

The fragment identifier component

Example: #

host

host-object

The content of the Host header

Example: portal.fortindr.forticloud.com

params

object-array

The HTTP parameters as an array of key-value pairs

Example:

path

string

The path of the requested resource

Example: search

port

integer

The specified port

Example: 443

query

string

The full parameter string

Example: query=8.8.8.8&sort_dir=desc

scheme

string

The specified scheme

Example: https

uri

string

The full URI

Example: https://portal.fortindr.forticloud.com:443/search?query=8.8.8.8&sort_dir=desc#

URL-Objects

Fields that contain both a host-object and a uri-object are referred to as a url-object.

URL-Objects contain the combined sub-fields in:

Back to Enriched object field types

File-Objects

File-Objects fields contain enriched information for an observed file.

Field Type Description

bytes

int

The file's size in bytes

Example: 145922

md5

string

The computed MD5 hash

Example: 92a4d0aeede3ce110b4121342df48496

mime_type

string

The fingerprinted MIME-type

Example: application/x-dosexec

name

string

The observed name

Example: 2487ff63fb4e79.gif

sha1

string

The computed SHA1 hash

Example: e63932430d4028b51fa25dae13d9e0188e9a02a5

sha256

string

The computed SHA256 hash

Example: 227193160a2448dfa8bbbd2cf125afa9cca0d1a718b109a3adae5df8a24cdf6e

Back to Enriched object field types

Email-Objects

Email-Objects fields contain an email address broken up into its different components.

Field Type Description

domain

string

The domain

Example: gmail.com

email

string

The entire email address

Example: jdoe@gmail.com

name

string

The name

Example: jdoe

Back to Enriched object field types

Enriched object field types

Enriched object field types

A field that is of type object simply means the field is actually a collection of sub-fields. Some of those sub-fields could also be another collection of sub-fields. Think of an object as a JSON block, or a dictionary for the Python users, or a map for the C/C++ users. Sub-fields are then referenced using dot notation, (for example, dst.geo.country).

Some object types are very common and are used over and over again, such as an ip-object. An ip-object refers to a field with the structure shown in the ip-object table. These field types are used throughout the different event types, so you should be familiar with them.

Note
Deprecation notice:

The asn.isp and asn.org fields are no longer supported. Please use asn.asn_org or asn.asn fields instead. This change applies to all IP-related fields.

The following topics provide a description of each object field type and the sub-fields it contains:

Back to top.

IP-Objects

The following table describes the fields that contain enriched information for an IP address:

Field Type Description

asn

asn-object

ASN information for the IP address

Example: See table below

$device

synthetic field

Enables querying devices by hostname or MAC address. Note: this field is only available for the src and dst fields.

geo

geo-object

Geographic information for the IP address

Example: See table below

internal

Boolean

Indicates whether the IP address is internal to the network

Example: true

ip

ip

The IP address

Example: 10.10.10.10

ip_bytes

int

The number of bytes transmitted by the IP address within the flow (only populated in Flow events)

Example: 458 Bytes

pkts

int

The number of packets transmitted by the IP address within the flow (only populated in Flow events)

Example: 8

port

int

The port used by the IP address

Example: 52843

username

int

The user name from Zscaler used in device detections (only populated in DNS, Flow, HTTP, and SSL events).

Example: john.smith@fortinet.com

hostname

int

The host name from Zscaler used in device detections (only populated in DNS, Flow, HTTP, and SSL events).

Example: F09NQJM1ABC

The asn field contains the following subfields.

Field Type Description

asn

int

The Autonomous System Number

Example: 16509

asn.asn_org

string

The organization name associated with the ASN (they actually use the ASN)

Example: Amazon.com, Inc.

asn.asn

string

The upstream ISP for the ASN

Example: Amazon.com

org

string The upstream owner of the ASN - may differ from asn_org

Example: Amazon.com

The geo field contains the following subfields.

Field Type Description

city

string

The city of record

Example: Boardman

country

string

The country of record

Example: US

location

object

The longitude and latitude of record

Example: (45.8491,-119.7143)

subdivision

string

The segment of the country (states in the US)

Example: OR

Back to Enriched object field types.

Active Directory (AD) objects

Active Directory enrichment enhances device identification by collecting hostname information from Windows AD on a scheduled basis. See Device enrichment.

When Active Directory enrichments are enabled, IP addresses are enriched with the following fields:

IP_enrichments

The following table describes the fields that contain enriched information for IP_enrichments:

Property

Type

Description

annotations

annotations object User‑ and system‑generated metadata associated with an entity or event. Annotations are typically added during investigations to capture analyst notes, contextual observations, or links to related findings, and are used to enrich the interpretation of security data.

asn

asn object ASN information for the IP address

device_data_timestamp

string

Time which device enrichment data was determined

Example: 2025-01-16T23:26:28.000000Z

device_hostnames

array A collection of hostnames associated with a device, derived from observed network activity or integrated identity sources.

device_last_logoff

string

Timestamp device was last recorded logging out

Example: 2025-01-16T22:15:08.000000Z

device_last_logon

string

Timestamp device was last recorded logging in

Example: 2025-01-16T22:13:08.000000Z

device_os_name

string

Device operating system name

Example: Windows

device_os_name_with_version

string

Device operating system with version

Example: Windows 10 Pro

device_os_version

string

Device operating system version

Example: 10.0 (54983)

device_os_version_major

string

Device operating system major version number

Example: 10

device_os_version_minor

string

Device operating system minor version number

Example: 0

geo

geo object Geographic information associated with an IP address.

internal

boolean

Indicates whether the IP address is internal to the network

Example: true

ip_enriched_with_port 1

The following table describes the fields that contain enriched information for ip_enriched_with_port 1:

Property

Type

Description

annotations

annotations object User‑ and system‑generated metadata associated with an entity or event. Annotations are typically added during investigations to capture analyst notes, contextual observations, or links to related findings, and are used to enrich the interpretation of security data.

asn

asn object ASN information for the IP address

device_data_timestamp

string

Time which device enrichment data was determined.

Example: 2025-01-16T23:26:28.000000Z

device_hostnames

array A collection of hostnames associated with a device, derived from observed network activity or integrated identity sources.

device_last_logoff

string

Timestamp device was last recorded logging out.

Example: 2025-01-16T22:15:08.000000Z

device_last_logon

string

Timestamp device was last recorded logging in.

Example: 2025-01-16T22:13:08.000000Z

device_os_name

string

Device operating system name.

Example: Windows

device_os_name_with_version

string

Device operating system with version.

Example: Windows 10 Pro

device_os_version

string

Device operating system version.

Example: 10.0 (54983)

device_os_version_major

string

Device operating system major version number.

Example: 10

device_os_version_minor

string

Device operating system minor version number.

Example: 0

geo

geo object Geographic information associated with an IP address.

internal

boolean

Indicates whether the IP address is internal to the network.

Example: true

ip

string

An IP address.

Example: 8.8.8.8

port

integer

A port number.

Example: 443

ip_enriched 1

The following table describes the fields that contain enriched information for ip_enriched 1:

Property

Type

Description

annotations

annotations object User‑ and system‑generated metadata associated with an entity or event. Annotations are typically added during investigations to capture analyst notes, contextual observations, or links to related findings, and are used to enrich the interpretation of security data.

asn

asn object ASN information for the IP address

device_data_timestamp

string

Time which device enrichment data was determined.

Example: 2025-01-16T23:26:28.000000Z

device_hostnames

array A collection of hostnames associated with a device, derived from observed network activity or integrated identity sources.

device_last_logoff

string

Timestamp device was last recorded logging out.

Example: 2025-01-16T22:15:08.000000Z

device_last_logon

string

Timestamp device was last recorded logging in.

Example: 2025-01-16T22:13:08.000000Z

device_os_name

string

Device operating system name.

Example: Windows

device_os_name_with_version

string

Device operating system with version.

Example: Windows 10 Pro

device_os_version

string

Device operating system version.

Example: 10.0 (54983)

device_os_version_major

string

Device operating system major version number.

Example: 10

device_os_version_minor

string

Device operating system minor version number.

Example: 0

geo

geo object Geographic information associated with an IP address.

internal

boolean

Indicates whether the IP address is internal to the network.

Example: true

ip

string

An IP address.

Example: 8.8.8.8

ip_enriched 2

The following table describes the fields that contain enriched information for ip_enriched 2:

Property

Type

Description

annotations

annotations object User‑ and system‑generated metadata associated with an entity or event. Annotations are typically added during investigations to capture analyst notes, contextual observations, or links to related findings, and are used to enrich the interpretation of security data.

asn

asn object ASN information for the IP address

device_data_timestamp

string

Time which device enrichment data was determined.

Example: 2025-01-16T23:26:28.000000Z

device_hostnames

array A collection of hostnames associated with a device, derived from observed network activity or integrated identity sources.

device_last_logoff

string

Timestamp device was last recorded logging out.

Example: 2025-01-16T22:15:08.000000Z

device_last_logon

string

Timestamp device was last recorded logging in.

Example: 2025-01-16T22:13:08.000000Z

device_os_name

string

Device operating system name.

Example: Windows

device_os_name_with_version

string

Device operating system with version.

Example: Windows 10 Pro

device_os_version

string

Device operating system version.

Example: 10.0 (54983)

device_os_version_major

string

Device operating system major version number.

Example: 10

device_os_version_minor

string

Device operating system minor version number.

Example: 0

geo

geo object Geographic information associated with an IP address.

internal

boolean

Indicates whether the IP address is internal to the network.

Example: true

ip

string

An IP address.

Example: 8.8.8.8

interface_enriched

The following table describes the fields that contain enriched information for an interface_enriched:

Property

Type

Description

annotations

annotations object User‑ and system‑generated metadata associated with an entity or event. Annotations are typically added during investigations to capture analyst notes, contextual observations, or links to related findings, and are used to enrich the interpretation of security data.

asn

asn object ASN information for the IP address

device_data_timestamp

string

Time which device enrichment data was determined.

Example: 2025-01-16T23:26:28.000000Z

device_hostnames

array A collection of hostnames associated with a device, derived from observed network activity or integrated identity sources.

device_last_logoff

string

Timestamp device was last recorded logging out.

Example: 2025-01-16T22:15:08.000000Z

device_last_logon

string

Timestamp device was last recorded logging in.

Example: 2025-01-16T22:13:08.000000Z

device_os_name

string

Device operating system name.

Example: Windows

device_os_name_with_version

string

Device operating system with version.

Example: Windows 10 Pro

device_os_version

string

Device operating system version.

Example: 10.0 (54983)

device_os_version_major

string

Device operating system major version number.

Example: 10

device_os_version_minor

string

Device operating system minor version number.

Example: 0

geo

geo object Geographic information associated with an IP address.

internal

boolean

Indicates whether the IP address is internal to the network.

Example: true

ip

string

An IP address.

Example: 8.8.8.8

mac

string

A MAC address.

Example: 00:1A:2B:3C:4D:5E

port

integer

A port number.

Example: 443

device_hostname

The following table describes the fields that contain enriched information for an device_hostname:

Property

Type

Description

domain_name

string Domain of the device's fully qualified domain name. Example: apps.google.com

fqdn

string Device's fully qualified domain name. Example: server1.apps.google.com

name

string Hostname of the device's fully qualified domain name. Example: server1

secondary_level_domain_name

string Secondary level domain of the device's fully qualified domain name. Example: google.com

Domain-Objects

The following table describes the fields that contain enriched information for a domain:

Field Type Description

domain

string

The domain

Example: portal.fortindr.forticloud.com

domain_entropy

float

The computed Shannon entropy of the domain

Example: 3.5

Back to Enriched object field types

Host-Objects

Host-Objects fields contain enriched information for both IP addresses and domains because the field could be either one. For example an HTTP Host header or a DNS answer.

Host-Objects contain the combined sub-fields in:

Back to Enriched object field types

URI-Objects

Fields that contain a URI are broken up into its different components.

Field Type Description

fragment

string

The fragment identifier component

Example: #

host

host-object

The content of the Host header

Example: portal.fortindr.forticloud.com

params

object-array

The HTTP parameters as an array of key-value pairs

Example:

path

string

The path of the requested resource

Example: search

port

integer

The specified port

Example: 443

query

string

The full parameter string

Example: query=8.8.8.8&sort_dir=desc

scheme

string

The specified scheme

Example: https

uri

string

The full URI

Example: https://portal.fortindr.forticloud.com:443/search?query=8.8.8.8&sort_dir=desc#

URL-Objects

Fields that contain both a host-object and a uri-object are referred to as a url-object.

URL-Objects contain the combined sub-fields in:

Back to Enriched object field types

File-Objects

File-Objects fields contain enriched information for an observed file.

Field Type Description

bytes

int

The file's size in bytes

Example: 145922

md5

string

The computed MD5 hash

Example: 92a4d0aeede3ce110b4121342df48496

mime_type

string

The fingerprinted MIME-type

Example: application/x-dosexec

name

string

The observed name

Example: 2487ff63fb4e79.gif

sha1

string

The computed SHA1 hash

Example: e63932430d4028b51fa25dae13d9e0188e9a02a5

sha256

string

The computed SHA256 hash

Example: 227193160a2448dfa8bbbd2cf125afa9cca0d1a718b109a3adae5df8a24cdf6e

Back to Enriched object field types

Email-Objects

Email-Objects fields contain an email address broken up into its different components.

Field Type Description

domain

string

The domain

Example: gmail.com

email

string

The entire email address

Example: jdoe@gmail.com

name

string

The name

Example: jdoe

Back to Enriched object field types