Liking cljdoc? Tell your friends :D

COA Object

Course of Action. A corrective or preventative action to be taken in response to a threat

Property	Type	Description	Required?
id	String	Globally unique URI identifying this object.	✓
schema_version	String	CTIM schema version for this entity	✓
type	COATypeIdentifier String		✓
valid_time	ValidTime Object		✓
coa_type	COAType String	The type of this COA
cost	HighMedLow String	Characterizes the estimated cost for applying this course of action
description	Markdown String	A description of object, which may be detailed.
efficacy	HighMedLow String	Effectiveness of this course of action in achieving its targeted objective
external_ids	String List
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.
impact	ShortString String	Characterizes the estimated impact of applying this course of action
language	ShortString String	The human language this object is specified in.
objective	ShortString String List	Characterizes the objective of this course of action
open_c2_coa	OpenC2COA Object
related_COAs	RelatedCOA Object List	Identifies or characterizes relationships to one or more related courses of action
revision	Integer	A monotonically increasing revision, incremented each time the object is changed.
short_description	MedString String	A single line, short summary of the object.
source	MedString String
source_uri	String
stage	COAStage String	Specifies what stage in the cyber threat management lifecycle this Course Of Action is relevant to
structured_coa_type	OpenC2StructuredCOAType String
timestamp	Inst (Date)	The time this object was created at, or last modified.
title	ShortString String	A short title for this object, used as primary display and reference value
tlp	TLP String	Specification for how, and to whom, this object can be shared.

Reference: CourseOfActionType

Property coa_type ∷ COAType String

The type of this COA

This entry is optional
- Allowed Values:
  - Diplomatic Actions
  - Eradication
  - Hardening
  - Internal Blocking
  - Logical Access Restrictions
  - Monitoring
  - Other
  - Patching
  - Perimeter Blocking
  - Physical Access Restrictions
  - Policy Actions
  - Public Disclosure
  - Rebuilding
  - Redirection
  - Redirection (Honey Pot)
  - Training
- Reference: CourseOfActionTypeVocab

Property cost ∷ HighMedLow String

Characterizes the estimated cost for applying this course of action

This entry is optional
- Allowed Values:
  - High
  - Info
  - Low
  - Medium
  - None
  - Unknown
- Reference: HighMedLowVocab

Property description ∷ Markdown String

A description of object, which may be detailed.

This entry is optional
- Markdown string with at most 5000 characters

Property efficacy ∷ HighMedLow String

Effectiveness of this course of action in achieving its targeted objective

This entry is optional
- Allowed Values:
  - High
  - Info
  - Low
  - Medium
  - None
  - Unknown
- Reference: HighMedLowVocab

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)

ExternalReference Object Value
- Details: ExternalReference Object

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 impact ∷ ShortString String

Characterizes the estimated impact of applying this course of action

This entry is optional
- String with at most 1024 characters

Property language ∷ ShortString String

The human language this object is specified in.

This entry is optional
- String with at most 1024 characters

Property objective ∷ ShortString String List

Characterizes the objective of this course of action

This entry is optional
This entry's type is sequential (allows zero or more values)
Dev Notes: Squashed / simplified
- String with at most 1024 characters

Property open_c2_coa ∷ OpenC2COA Object

This entry is optional

OpenC2COA Object Value
- Details: OpenC2COA Object

Property related_COAs ∷ RelatedCOA Object List

Identifies or characterizes relationships to one or more related courses of action

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

RelatedCOA Object Value
- Details: RelatedCOA Object

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 short_description ∷ MedString String

A single line, short summary of the object.

This entry is optional
- String with at most 2048 characters

Property source ∷ MedString String

This entry is optional
- String with at most 2048 characters

Property stage ∷ COAStage String

Specifies what stage in the cyber threat management lifecycle this Course Of Action is relevant to

This entry is optional
- Allowed Values:
  - Remedy
  - Response
- Reference: COAStageVocab

Property structured_coa_type ∷ OpenC2StructuredCOAType String

This entry is optional
- Must equal: "openc2"

Property timestamp ∷ Inst (Date)

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

This entry is optional
- Schema definition for all date or timestamp values. Time is stored internally as a java.util.Date object. Serialized as a string, the field should follow the rules of the ISO8601 standard.

Property title ∷ ShortString String

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

This entry is optional
- String with at most 1024 characters

Property tlp ∷ TLP String

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

This entry is optional
- 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 ∷ COATypeIdentifier String

This entry is required
- Must equal: "coa"

Property valid_time ∷ ValidTime Object

This entry is required

ValidTime Object Value
- Details: ValidTime Object

ExternalReference Object

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.

Property	Type	Description	Required?
source_name	MedString String	The source within which the external-reference is defined (system, registry, organization, etc.)	✓
description	Markdown String
external_id	String	An identifier for the external reference content.
hashes	String List	Specifies a dictionary of hashes for the contents of the url.
url	String	A URL reference to an external resource

Reference: External Reference

Property description ∷ Markdown String

This entry is optional
- 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 ∷ MedString String

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

This entry is required
- String with at most 2048 characters

Property url ∷ String

A URL reference to an external resource

This entry is optional
- A URI

ValidTime Object

Period of time when a cyber observation is valid.

Property	Type	Description	Required?
end_time	Inst (Date)	If end_time is not present, then the valid time position of the object does not have an upper bound.
start_time	Inst (Date)	If not present, the valid time position of the indicator does not have an upper bound

Reference: ValidTimeType

Property end_time ∷ Inst (Date)

If end_time is not present, then the valid time position of the object does not have an upper bound.

This entry is optional
- Schema definition for all date or timestamp values. Time is stored internally as a java.util.Date object. Serialized as a string, the field should follow the rules of the ISO8601 standard.

Property start_time ∷ Inst (Date)

If not present, the valid time position of the indicator does not have an upper bound

This entry is optional
- Schema definition for all date or timestamp values. Time is stored internally as a java.util.Date object. Serialized as a string, the field should follow the rules of the ISO8601 standard.

RelatedCOA Object

Property	Type	Required?
COA_id	String	✓
confidence	HighMedLow String
relationship	String
source	String

Property COA_id ∷ String

This entry is required
- A URI leading to a COA

Property confidence ∷ HighMedLow String

This entry is optional
- Allowed Values:
  - High
  - Info
  - Low
  - Medium
  - None
  - Unknown
- Reference: HighMedLowVocab

Property relationship ∷ String

This entry is optional

Property source ∷ String

This entry is optional

OpenC2COA Object

Property	Type	Required?
action	ActionType Object	✓
id	ShortString String	✓
type	StructuredCOAType String	✓
actuator	ActuatorType Object
modifiers	ModifierType Object
target	TargetType Object

Property action ∷ ActionType Object

This entry is required

ActionType Object Value
- Details: ActionType Object

Property actuator ∷ ActuatorType Object

This entry is optional

ActuatorType Object Value
- Details: ActuatorType Object

Property id ∷ ShortString String

This entry is required
- String with at most 1024 characters

Property modifiers ∷ ModifierType Object

This entry is optional

ModifierType Object Value
- Details: ModifierType Object

Property target ∷ TargetType Object

This entry is optional

TargetType Object Value
- Details: TargetType Object

Property type ∷ StructuredCOAType String

This entry is required
- Must equal: "structured_coa"

ModifierType Object

Property	Type	Description	Required?
additional_properties	AdditionalProperties Object
delay	Inst (Date)
destination	String
duration	Inst (Date)
frequency	ShortString String
id	ShortString String
location	String
method	String List
option	ShortString String
response	String
search	String
source	ShortString String
time	ValidTime Object

Property additional_properties ∷ AdditionalProperties Object

This entry is optional

AdditionalProperties Object Value
- Details: AdditionalProperties Object

Property delay ∷ Inst (Date)

This entry is optional
- Schema definition for all date or timestamp values. Time is stored internally as a java.util.Date object. Serialized as a string, the field should follow the rules of the ISO8601 standard.

Property destination ∷ String

This entry is optional
- Allowed Values:
  - copy-to
  - modify-to
  - move-to
  - report-to
  - restore-point
  - save-to
  - set-to

Property duration ∷ Inst (Date)

This entry is optional
- Schema definition for all date or timestamp values. Time is stored internally as a java.util.Date object. Serialized as a string, the field should follow the rules of the ISO8601 standard.

Property frequency ∷ ShortString String

This entry is optional
- String with at most 1024 characters

Property id ∷ ShortString String

This entry is optional
- String with at most 1024 characters

Property location ∷ String

This entry is optional
- Allowed Values:
  - internal
  - perimeter

Property method ∷ String List

This entry is optional
This entry's type is sequential (allows zero or more values)
- Allowed Values:
  - acl
  - authenticated
  - blackhole
  - blacklist
  - graceful
  - hibernate
  - honeypot
  - immediate
  - segmentation
  - spawn
  - suspend
  - unauthenticated
  - whitelist

Property option ∷ ShortString String

This entry is optional
- String with at most 1024 characters

Property response ∷ String

This entry is optional
- Allowed Values:
  - acknowledge
  - command-ref
  - query
  - status

Property search ∷ String

This entry is optional
- Allowed Values:
  - cve
  - patch
  - signature
  - vendor_bulletin

Property source ∷ ShortString String

This entry is optional
- String with at most 1024 characters

Property time ∷ ValidTime Object

This entry is optional

ValidTime Object Value
- Details: ValidTime Object

AdditionalProperties Object

Property	Type	Description	Required?
context	ShortString String		✓

Property context ∷ ShortString String

This entry is required
- String with at most 1024 characters

ValidTime Object

Period of time when a cyber observation is valid.

Property	Type	Description	Required?
end_time	Inst (Date)	If end_time is not present, then the valid time position of the object does not have an upper bound.
start_time	Inst (Date)	If not present, the valid time position of the indicator does not have an upper bound

Reference: ValidTimeType

Property end_time ∷ Inst (Date)

If end_time is not present, then the valid time position of the object does not have an upper bound.

This entry is optional
- Schema definition for all date or timestamp values. Time is stored internally as a java.util.Date object. Serialized as a string, the field should follow the rules of the ISO8601 standard.

Property start_time ∷ Inst (Date)

If not present, the valid time position of the indicator does not have an upper bound

This entry is optional
- Schema definition for all date or timestamp values. Time is stored internally as a java.util.Date object. Serialized as a string, the field should follow the rules of the ISO8601 standard.

ActuatorType Object

Property	Type	Description	Required?
type	ActuatorType String		✓
specifiers	ShortString String List	list of additional properties describing the actuator

Property specifiers ∷ ShortString String List

list of additional properties describing the actuator

This entry is optional
This entry's type is sequential (allows zero or more values)
- String with at most 1024 characters

Property type ∷ ActuatorType String

This entry is required
- Allowed Values:
  - endpoint
  - endpoint.digital-telephone-handset
  - endpoint.laptop
  - endpoint.pos-terminal
  - endpoint.printer
  - endpoint.sensor
  - endpoint.server
  - endpoint.smart-meter
  - endpoint.smart-phone
  - endpoint.tablet
  - endpoint.workstation
  - network
  - network.bridge
  - network.firewall
  - network.gateway
  - network.guard
  - network.hips
  - network.hub
  - network.ids
  - network.ips
  - network.modem
  - network.nic
  - network.proxy
  - network.router
  - network.security_manager
  - network.sense_making
  - network.sensor
  - network.switch
  - network.vpn
  - network.wap
  - other
  - process
  - process.aaa-server
  - process.anti-virus-scanner
  - process.connection-scanner
  - process.directory-service
  - process.dns-server
  - process.email-service
  - process.file-scanner
  - process.location-service
  - process.network-scanner
  - process.remediation-service
  - process.reputation-service
  - process.sandbox
  - process.virtualization-service
  - process.vulnerability-scanner

TargetType Object

Property	Type	Description	Required?
type	ShortString String		✓
specifiers	ShortString String	Cybox object representing the target

Property specifiers ∷ ShortString String

Cybox object representing the target

This entry is optional
- String with at most 1024 characters

Property type ∷ ShortString String

This entry is required
- String with at most 1024 characters

ActionType Object

Property	Type	Description	Required?
type	COAType String		✓

Property type ∷ COAType String

This entry is required
- Allowed Values:
  - alert
  - allow
  - augment
  - contain
  - delete
  - deny
  - detonate
  - distill
  - get
  - investigate
  - locate
  - mitigate
  - modify
  - move
  - notify
  - other
  - pause
  - query
  - redirect
  - remediate
  - report
  - response
  - restart
  - restore
  - resume
  - save
  - scan
  - set
  - snapshot
  - start
  - stop
  - substitute
  - sync
  - throttle
  - update
- Reference: OpenC2/STIX COA XML schema

❮*Casebook* Object *Feedback* Object❯

Can you improve this documentation?Edit on GitHub

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

Keyboard shortcuts Report a problem cljdoc on GitHub

× close