Skip to content

Class: KeyValueObject

A generic object allowing to define a {key:value} pair.

URI: ocsf:KeyValueObject

 classDiagram
    class KeyValueObject
    click KeyValueObject href "../KeyValueObject/"
      Object <|-- KeyValueObject
        click Object href "../Object/"

      KeyValueObject : name

      KeyValueObject : value

      KeyValueObject : values

Inheritance

Slots

Name Cardinality and Range Description Inheritance
name 1
String
The name of the key direct
value 0..1 recommended
String
The value associated to the key direct
values * recommended
String
Optional, the values associated to the key direct

Usages

used by used in type used
PermissionAnalysisResult condition_keys range KeyValueObject
RelatedEvent tags range KeyValueObject
Resource tags range KeyValueObject
AccessAnalysisResult condition_keys range KeyValueObject
Account tags range KeyValueObject
ApplicationObject tags range KeyValueObject
Compliance control_parameters range KeyValueObject
Container tags range KeyValueObject
Databucket tags range KeyValueObject
File tags range KeyValueObject
FindingInfo tags range KeyValueObject
Image tags range KeyValueObject
LdapPerson tags range KeyValueObject
Metadata tags range KeyValueObject
ResourceDetails tags range KeyValueObject
Service tags range KeyValueObject
WebResource tags range KeyValueObject
WinResource tags range KeyValueObject
WinService tags range KeyValueObject

Rules

Rule Applied Preconditions Postconditions Elseconditions
any_of [{'slot_conditions': {'value': {'required': True}}}, {'slot_conditions': {'values': {'required': True}}}]

In Subsets

Aliases

  • Key:Value object

Identifier and Mapping Information

Annotations

property value
ocsf_constraints {"at_least_one": ["value", "values"]}

Schema Source

Mappings

Mapping Type Mapped Value
self ocsf:KeyValueObject
native ocsf:KeyValueObject

LinkML Source

Direct

name: KeyValueObject
annotations:
  ocsf_constraints:
    tag: ocsf_constraints
    value: '{"at_least_one": ["value", "values"]}'
description: A generic object allowing to define a <code>{key:value}</code> pair.
in_subset:
- objects_subset
from_schema: https://w3id.org/lmodel/ocsf
aliases:
- Key:Value object
is_a: Object
slots:
- name
- value
- values
slot_usage:
  name:
    name: name
    description: The name of the key.
    required: true
  value:
    name: value
    description: The value associated to the key.
    recommended: true
  values:
    name: values
    description: 'Optional, the values associated to the key. You can populate this
      attribute,

      when you have multiple values for the same key.'
    recommended: true
rules:
- postconditions:
    any_of:
    - slot_conditions:
        value:
          name: value
          required: true
    - slot_conditions:
        values:
          name: values
          required: true
  description: 'OCSF at_least_one: at least one of [''value'', ''values''] must be
    set.'

Induced

name: KeyValueObject
annotations:
  ocsf_constraints:
    tag: ocsf_constraints
    value: '{"at_least_one": ["value", "values"]}'
description: A generic object allowing to define a <code>{key:value}</code> pair.
in_subset:
- objects_subset
from_schema: https://w3id.org/lmodel/ocsf
aliases:
- Key:Value object
is_a: Object
slot_usage:
  name:
    name: name
    description: The name of the key.
    required: true
  value:
    name: value
    description: The value associated to the key.
    recommended: true
  values:
    name: values
    description: 'Optional, the values associated to the key. You can populate this
      attribute,

      when you have multiple values for the same key.'
    recommended: true
attributes:
  name:
    name: name
    description: The name of the key.
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Name
    rank: 1000
    alias: name
    owner: KeyValueObject
    domain_of:
    - AnalysisTarget
    - Observable
    - Os
    - Osint
    - Package
    - Parameter
    - PrivilegeInfo
    - San
    - Scim
    - Script
    - ServicePrivilegeAnalysis
    - SoftwareComponent
    - Sso
    - StartupItem
    - ThreatActor
    - Token
    - Entity
    - Resource
    - Account
    - Agent
    - AiModel
    - Aircraft
    - Analytic
    - ApplicationObject
    - Assessment
    - AutonomousSystem
    - Campaign
    - Check
    - CisBenchmark
    - CisBenchmarkResult
    - CisControl
    - ClassifierDetails
    - Container
    - D3fTactic
    - D3fTechnique
    - Database
    - Databucket
    - DomainContact
    - Edge
    - Endpoint
    - Enrichment
    - EnvironmentVariable
    - Evidences
    - Extension
    - Feature
    - File
    - Graph
    - Group
    - HttpCookie
    - HttpHeader
    - Idp
    - Image
    - Job
    - Kernel
    - KeyValueObject
    - LoadBalancer
    - Logger
    - Malware
    - ManagedEntity
    - MessageContext
    - Metric
    - Mitigation
    - NetworkInterface
    - Node
    - Organization
    - PeripheralDevice
    - Policy
    - ProcessEntity
    - Product
    - QueryInfo
    - Reporter
    - ResourceDetails
    - Rule
    - Scan
    - Service
    - SubTechnique
    - Table
    - Tactic
    - Technique
    - Trait
    - TransformationInfo
    - UnmannedAerialSystem
    - User
    - WebResource
    - Device
    - FtpActivity
    - RegValue
    - WinResource
    - WinService
    - PrefetchQuery
    range: string
    required: true
  value:
    name: value
    description: The value associated to the key.
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Value
    rank: 1000
    alias: value
    owner: KeyValueObject
    domain_of:
    - Observable
    - Observation
    - Osint
    - Packet
    - DiscoveryDetails
    - Enrichment
    - EnvironmentVariable
    - Fingerprint
    - HttpCookie
    - HttpHeader
    - Ja4Fingerprint
    - KeyValueObject
    - LongString
    - Metric
    range: string
    recommended: true
  values:
    name: values
    description: 'Optional, the values associated to the key. You can populate this
      attribute,

      when you have multiple values for the same key.'
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Values
    rank: 1000
    alias: values
    owner: KeyValueObject
    domain_of:
    - KeyValueObject
    - Trait
    range: string
    recommended: true
    multivalued: true
rules:
- postconditions:
    any_of:
    - slot_conditions:
        value:
          name: value
          required: true
    - slot_conditions:
        values:
          name: values
          required: true
  description: 'OCSF at_least_one: at least one of [''value'', ''values''] must be
    set.'