Liking cljdoc? Tell your friends :D

Incident Object

Incident Information about computer security incident response. A computer security incident is a violation or imminent threat of violation of computer security policies, acceptable use policies, or standard security practices. Incidents pertain to one or more adverse events, each of which is modeled as a sighting.

PropertyTypeDescriptionRequired?
confidenceHighMedLowStringlevel of confidence held in the characterization of this Incident
idStringGlobally unique URI identifying this object.
incident_timeIncidentTime Objectrelevant time values associated with this Incident
schema_versionStringCTIM schema version for this entity
statusStatusStringcurrent status of the incident
typeIncidentTypeIdentifierString
assigneesShortStringString Lista set of owners assigned to this incident
categoriesIncidentCategoryString Lista set of categories for this incident
descriptionMarkdownStringA description of object, which may be detailed.
discovery_methodDiscoveryMethodStringidentifies how the incident was discovered
external_idsString List
external_referencesExternalReference Object ListSpecifies a list of external references which refers to non-CTIM information. This property is used to provide one or more URLs, descriptions, or IDs to records in other systems.
intended_effectIntendedEffectStringspecifies the suspected intended effect of this incident
languageShortStringStringThe human language this object is specified in.
promotion_methodPromotionMethodStringidentifies how the incident was promoted
revisionIntegerA monotonically increasing revision, incremented each time the object is changed.
scoresScore Object Listthe scores associated to the incident
severitySeverityStringspecifies the severity level of an Incident
short_descriptionMedStringStringA single line, short summary of the object.
sourceMedStringString
source_uriString
tacticsShortStringString Listspecifies the list of tactic ids (ex: mitre tactic id) of an Incident
techniquesShortStringString Listspecifies the list of technique ids (ex: mitre technique id) of an Incident
timestampInst (Date)The time this object was created at, or last modified.
titleShortStringStringA short title for this object, used as primary display and reference value
tlpTLPStringSpecification for how, and to whom, this object can be shared.

Property assignees ∷ ShortStringString List

a set of owners assigned to this incident

  • This entry is optional

  • This entry's type is sequential (allows zero or more values)

    • ShortString String with at most 1024 characters

Property categories ∷ IncidentCategoryString List

a set of categories for this incident

  • This entry is optional

  • This entry's type is sequential (allows zero or more values)

    • Allowed Values:
      • Denial of Service
      • Exercise/Network Defense Testing
      • Improper Usage
      • Investigation
      • Malicious Code
      • Scans/Probes/Attempted Access
      • Unauthorized Access

Property confidence ∷ HighMedLowString

level of confidence held in the characterization of this Incident

  • This entry is required

Property description ∷ MarkdownString

A description of object, which may be detailed.

  • This entry is optional

    • Markdown Markdown string with at most 5000 characters

Property discovery_method ∷ DiscoveryMethodString

identifies how the incident was discovered

  • This entry is optional

    • Allowed Values:
      • Agent Disclosure
      • Antivirus
      • Audit
      • Customer
      • External - Fraud Detection
      • Financial Audit
      • HIPS
      • IT Audit
      • Incident Response
      • Internal - Fraud Detection
      • Law Enforcement
      • Log Review
      • Monitoring Service
      • NIDS
      • Security Alarm
      • Unknown
      • Unrelated Party
      • User

Property external_ids ∷ String List

  • This entry is optional
  • This entry's type is sequential (allows zero or more values)

Property external_references ∷ ExternalReference Object List

Specifies a list of external references which refers to non-CTIM information. This property is used to provide one or more URLs, descriptions, or IDs to records in other systems.

  • This entry is optional
  • This entry's type is sequential (allows zero or more values)

Property id ∷ String

Globally unique URI identifying this object.

  • This entry is required

    • IDs are URIs, for example https://www.domain.com/ctia/judgement/judgement-de305d54-75b4-431b-adb2-eb6b9e546014 for a Judgement. This ID type compares to the STIX id field. The optional STIX idref field is not used.

Property incident_time ∷ IncidentTime Object

relevant time values associated with this Incident

  • This entry is required
  • Dev Notes: Was 'time'; renamed for clarity

Property intended_effect ∷ IntendedEffectString

specifies the suspected intended effect of this incident

  • This entry is optional

    • Allowed Values:
      • Account Takeover
      • Advantage
      • Advantage - Economic
      • Advantage - Military
      • Advantage - Political
      • Brand Damage
      • Competitive Advantage
      • Degradation of Service
      • Denial and Deception
      • Destruction
      • Disruption
      • Embarrassment
      • Exposure
      • Extortion
      • Fraud
      • Harassment
      • ICS Control
      • Theft
      • Theft - Credential Theft
      • Theft - Identity Theft
      • Theft - Intellectual Property
      • Theft - Theft of Proprietary Information
      • Traffic Diversion
      • Unauthorized Access

Property language ∷ ShortStringString

The human language this object is specified in.

  • This entry is optional

    • ShortString String with at most 1024 characters

Property promotion_method ∷ PromotionMethodString

identifies how the incident was promoted

  • This entry is optional

    • Allowed Values:
      • Automated
      • Manual

Property revision ∷ Integer

A monotonically increasing revision, incremented each time the object is changed.

  • This entry is optional

    • Zero, or a positive integer

Property schema_version ∷ String

CTIM schema version for this entity

  • This entry is required

    • A semantic version matching the CTIM version against which this object should be valid.

Property scores ∷ Score Object List

the scores associated to the incident

  • This entry is optional
  • This entry's type is sequential (allows zero or more values)

Property severity ∷ SeverityString

specifies the severity level of an Incident

  • This entry is optional

    • Allowed Values:
      • Critical
      • High
      • Info
      • Low
      • Medium
      • None
      • Unknown

Property short_description ∷ MedStringString

A single line, short summary of the object.

  • This entry is optional

    • MedString String with at most 2048 characters

Property source ∷ MedStringString

  • This entry is optional

    • MedString String with at most 2048 characters

Property source_uri ∷ String

  • This entry is optional

    • A URI

Property status ∷ StatusString

current status of the incident

  • This entry is required

    • Allowed Values:
      • Closed
      • Containment Achieved
      • Incident Reported
      • New
      • Open
      • Rejected
      • Restoration Achieved
      • Stalled

Property tactics ∷ ShortStringString List

specifies the list of tactic ids (ex: mitre tactic id) of an Incident

  • This entry is optional

  • This entry's type is sequential (allows zero or more values)

    • ShortString String with at most 1024 characters

Property techniques ∷ ShortStringString List

specifies the list of technique ids (ex: mitre technique id) of an Incident

  • This entry is optional

  • This entry's type is sequential (allows zero or more values)

    • ShortString String with at most 1024 characters

Property timestamp ∷ Inst (Date)

The time this object was created at, or last modified.

  • This entry is optional

    • ISO8601 Timestamp Schema definition for all date or timestamp values. Serialized as a string, the field should follow the rules of the ISO8601 standard.

Property title ∷ ShortStringString

A short title for this object, used as primary display and reference value

  • This entry is optional

    • ShortString String with at most 1024 characters

Property tlp ∷ TLPString

Specification for how, and to whom, this object can be shared.

  • This entry is optional

    • TLP TLP stands for Traffic Light Protocol, which indicates precisely how this resource is intended to be shared, replicated, copied, etc.
    • Default: green
    • Allowed Values:
      • amber
      • green
      • red
      • white

Property type ∷ IncidentTypeIdentifierString

  • This entry is required

    • Must equal: "incident"

ExternalReference Object

ExternalReference External references are used to describe pointers to information represented outside of CTIM. For example, a Malware object could use an external reference to indicate an ID for that malware in an external database or a report could use references to represent source material.

PropertyTypeDescriptionRequired?
source_nameMedStringStringThe source within which the external-reference is defined (system, registry, organization, etc.)
descriptionMarkdownString
external_idStringAn identifier for the external reference content.
hashesString ListSpecifies a dictionary of hashes for the contents of the url.
urlStringA URL reference to an external resource

Property description ∷ MarkdownString

  • This entry is optional

    • Markdown Markdown string with at most 5000 characters

Property external_id ∷ String

An identifier for the external reference content.

  • This entry is optional

Property hashes ∷ String List

Specifies a dictionary of hashes for the contents of the url.

  • This entry is optional
  • This entry's type is sequential (allows zero or more values)

Property source_name ∷ MedStringString

The source within which the external-reference is defined (system, registry, organization, etc.)

  • This entry is required

    • MedString String with at most 2048 characters

Property url ∷ String

A URL reference to an external resource

  • This entry is optional

    • A URI

IncidentTime Object

PropertyTypeDescriptionRequired?
openedInst (Date)Time the incident was first opened.
closedInst (Date)Time that the incident was last closed.
discoveredInst (Date)Time the incident was first discovered.
rejectedInst (Date)Time that the incident was first rejected.
remediatedInst (Date)Time that the remediation of the damage from the incident was completed.
reportedInst (Date)Time the incident was first reported.

Property closed ∷ Inst (Date)

Time that the incident was last closed.

  • This entry is optional

    • ISO8601 Timestamp Schema definition for all date or timestamp values. Serialized as a string, the field should follow the rules of the ISO8601 standard.

Property discovered ∷ Inst (Date)

Time the incident was first discovered.

  • This entry is optional

    • ISO8601 Timestamp Schema definition for all date or timestamp values. Serialized as a string, the field should follow the rules of the ISO8601 standard.

Property opened ∷ Inst (Date)

Time the incident was first opened.

  • This entry is required

    • ISO8601 Timestamp Schema definition for all date or timestamp values. Serialized as a string, the field should follow the rules of the ISO8601 standard.

Property rejected ∷ Inst (Date)

Time that the incident was first rejected.

  • This entry is optional

    • ISO8601 Timestamp Schema definition for all date or timestamp values. Serialized as a string, the field should follow the rules of the ISO8601 standard.

Property remediated ∷ Inst (Date)

Time that the remediation of the damage from the incident was completed.

  • This entry is optional

    • ISO8601 Timestamp Schema definition for all date or timestamp values. Serialized as a string, the field should follow the rules of the ISO8601 standard.

Property reported ∷ Inst (Date)

Time the incident was first reported.

  • This entry is optional

    • ISO8601 Timestamp Schema definition for all date or timestamp values. Serialized as a string, the field should follow the rules of the ISO8601 standard.

Score Object

Score A score that is assigned to an incident.

PropertyTypeDescriptionRequired?
scoreNumbera numeric score
typeStringa label representing the type of score

Property score ∷ Number

a numeric score

  • This entry is required

Property type ∷ String

a label representing the type of score

  • This entry is required

Can you improve this documentation? These fine people already did:
Stephen Sloan, Guillaume Erétéo, Ambrose Bonnaire-Sergeant, Yann Esposito (Yogsototh), Guillaume Buisson, Matthieu Sprunck, Ag Ibragimov, Craig Brozefsky, Yann Esposito & mcosta85
Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close