Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Application

Top Level Fieldset: True

This field set refers to any integration to an application, including connections to an API.

Application Fields

application.domain

Required Field: False
Type: STRING
Example: example.com
Detection Supported Field: True

The domain name of the application.


application.id

Required Field: False
Type: STRING
Example: 5A4232E1
Detection Supported Field: True

Unique ID of the application.


application.name

Required Field: False
Type: STRING
Example: User Activity API
Detection Supported Field: True

The name or description of the application.


application.path

Required Field: False
Type: STRING
Example: /users/active?pageSize=100
Detection Supported Field: True

The URI of the application or API endpoint, which can include parameters.


application.scopes

Required Field: False
Type: ARRAY
Example: ['create users', 'edit users']
Detection Supported Field: True

The scopes required by the application.


application.version

Required Field: False
Type: STRING
Example: 2.01
Detection Supported Field: True

The raw version of the application as a string.


application.version_normalized

Required Field: False
Type: FLOAT
Example: 2.01
Detection Supported Field: True

A numerical representation of the application’s version. Useful for sorting or numerical comparisons.