All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Remove empty
excludes
properties from schemas. - Fix HostAgent schema having a property defined outside the
properties
key.
- Updated README with versioning instructions
- Modular AJV instance construction with
registerSchemas
andregisterFormats
.
lastSeenOn
as a required property on both Devices and HostAgents.- Added ipCidr format
- Support for IP CIDR in Host class
- Add
KNOWS
class
- Removed
username
andactive
from required User properties.
- Reduced the minLength requirement of _type to 3 characters to accommodate
cve
,cwe
and other abbreviated types.
- Added
RelationshipClass.PUBLISHES
- Added
Workflow
entity class.
Host.ipAddress
now allows multiple values. All known IP addresses of a Host should be stored in this property.Host.ipAddresses
should no longer be submitted and all values currently stored there should be moved toHost.ipAddress
.Host.macAddress
now allows multiple values. All known MAC addresses of a Host should be stored in this property.Host.macAddresses
should no longer be submitted and all values currently stored there should be moved toHost.macAddress
.Host.hostname
is now a required property.
- Add
RelationshipClass.RUNS
- Add
RelationshipClass.EVALUATES
- Allow
null
to be assigned to the following requiredVulnerability
propertiescategory
severity
blocking
open
production
public
- Added deviceId as a nullable required property of Device. This property will be used in HostAgent PROTECTS DEVICE mapped relationships
- Updated
fqdn
property onHOST
entity to allow string or array type - Allow
null
to be assigned to the followingDevice
properties:category
make
model
serial
state
property added toHost
entity class
- Added
RelationshipClass.SENDS
- Warning was being thrown for usage of
format: string
for emailDomain property. Removed the format to silience the warning.
- Added
RelationshipClass.HOSTS
- Added
RelationshipClass.LOGS
- Added
RelationshipClass.VIOLATES
- Added
Issue
entity class.
- Added
Secret
entity class.
- Added
Question
entity class.
- Added
RelationshipClass.ENFORCES
- Added
Alert
class.
- Added
Problem
class.
- Changed
DomainRecord.value
to bestring | string[]
- Added
RelationshipClass.PUBLISHED
firstName
andlastName
properties toUser
entity class
- Added
COMPLETED
to theRelationshipClass
enum
- Added
exception
flag andexceptionReason
string property toRecordEntity
- Added
REPORTED
to theRelationshipClass
enum
- #104 - Introduce
Model
entity class
- Added required property
Service.function
description and example/recommended values to encourage consistency. - Added optional
boolean
propertiesService.fedrampModerate
andService.hipaaEligible
.
- Added
RESTRICTS
relationship class
- #96 - Introduce
DataCollection
entity class
- Added
LIMITS
relationship classes
- #90 -
DataObject
classification
field should acceptnull
- Stop requiring
ipAddress
onNetworkEndpoint
class. Azure private endpoints actually relate to aNetworkInterface
entity, where the IP address lives.
- #87 -
Control
entity class should allow an array offunction
- Added
REVIEWED
to theRelationshipClass
enum
- Fix #82 - Add
retentionPeriodDays
property toDataStore
class that represents the number of days that data will be retained for.
- Fixed additional log warnings by correcting schema structures to conform to strict settings.
- Fixed
validateEntityWithSchema()
emitting log warning for missing format"ip"
by adding a custom format. These properties will now be validated asipv4
oripv6
.
- Upgraded to
[email protected]
. This drove some schema structure changes that may impact JupiterOne where the schema is used to drive an entity editor UI.
- Fixed schema for
tag.*
properties to allownumber
andboolean
values.
NOTIFIES
relationship class
Vendor.category
now supportsstring
orstring[]
values.
- Added
RelationshipClass.INSTALLED
relationship class, which can be used to represent a device that has installed an application.
ThreatIntel
entity for collecting threat intelligence, typically related to aFinding
asFinding - HAS -> ThreatIntel
- Clarification and examples of use in documentation for
RelationshipClass.{HAS, CONTAINS}
.
- 0.16.1-4 were changes to fix the build
- BREAKING!
import { schemas } from '@jupiterone/data-model'
must be changed toimport { entitySchemas } from '@jupiterone/data-model'
- Added
backgroundCheckedOn
andbackgroundCheckedBy
properties toPerson
entity
- Added
APPROVED
to theRelationshipClass
enum - Added
numericSeverity
as a required property toFinding
entity
Finding.severity
providesexamples
Finding.category
may now be astring | string[]
, andexamples
have been added.
- Added
locked
as a common property toDomain
entity
- #48 - Allow array type for
publicIpAddress and privateIpAddress in
Host
class - #49 Allow
null
value forNetwork
classCIDR
property
- Added
Vault
schema, which should be used to classify a collection of secrets such as a key ring.
- Added
createdBy
,updatedBy
,deletedBy
,discoveredBy
toEntity
schema. - Added
RelationshipClass.SCANS
constant.
Entity.id
allowsstring | string[]
. This change will allowid
to capture values from each provider that tracks an Entity.
- Added
NS
as validDomainRecord
.type
value.
- Added
DENIES
relationship class.
- #30 - Remove requirement
for
hostname
property inHost
schema.