Patch an incident in Private Intel - Cisco XDR APIs

{"type":"api","title":"Patch an incident in Private Intel","meta":{"id":"/apps/pubhub/media/cisco-xdr-api-docs/fa9197522b1e6452b6dbfc472555dcc7ceeb71bd/d7d3e58b-2412-342e-a80a-991bae0c0b01","info":{"title":"PrivateIntel Service","description":"A proxy to private-intel CTIA with various IROH hooks","contact":{"name":"Cisco Security Business Group -- Advanced Threat","email":"cisco-intel-api-support@cisco.com"},"license":{"name":"All Rights Reserved","url":"https://www.cisco.com"},"version":"1.0.107"},"security":[{"oAuth2":["integration:read","private-intel:read","profile:read","inspect:read","users:read","invite:read","enrich:read","oauth:read","response:read","global-intel:read","ao:read","playbook:read"]}],"tags":[{"name":"Private Intel","description":"Access private-intel"}],"x-parser-conf":{"serverConfig":"select","overview":{"markdownPath":"reference/incident-management/overview.md","uri":"incident-management-api-guide"},"disableAuthEditing":true,"exampleAsDefault":true,"oAuth2":{"clientId":"client-546e34fc-c6bf-4951-ac69-f6d7987a7814","clientSecret":"MYw4_E_tBdFwUwrX6WFYKVD5LQrG2k7XrJ5J046wWE0s1gAKCxJ8VA","proxyEnabled":false},"meta":{"useProxy":true}},"openapi":"3.0.1","servers":[{"url":"https://visibility.amp.cisco.com"}],"securitySchemes":{"oAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://visibility.amp.cisco.com/iroh/oauth2/token","scopes":{"telemetry":"Collect application data for analytics","integration:read":"Manage your modules","private-intel:read":"Access Private Intelligence","admin":"Provide admin privileges","cognitive":"Cognitive Integration","profile:read":"Get your profile information","inspect:read":"Extract Observables and data from text","asset":"Access and modify your assets","event":"Read IROH Events","feedback":"Submit Customer Feedback","sse":"SSE Integration. Manage your Devices.","registry":"Manage registry entries","users:read":"Manage users of your organization","investigation":"Perform threat analysis investigation","invite:read":"Invite users into your organization","casebook":"Access and modify your casebooks","playbook":"Access and modify your playbooks","orbital":"Orbital Integration.","enrich:read":"Query your configured modules for threat intelligence","oauth:read":"Manage OAuth2 Clients","vault":"Grants access to Module Vaults","response:read":"List and execute response actions using configured modules","notification":"Receive notifications from integrations","global-intel:read":"Access AMP Global Intelligence","webhook":"Manage your Webhooks","ao:read":"AO Integration."}}}}}},"spec":{"tags":["Private Intel"],"summary":"Patch an incident in Private Intel","description":"[required scopes](/iroh/doc/iroh-auth/#scopes): `private-intel/incident`\n\n","parameters":[{"name":"wait_for","in":"query","description":"wait for updated entity to be available for search","schema":{"type":"boolean"}},{"name":"incident-id","in":"path","description":"The identifier of the incident to patch.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"For submitting a new Incident.","content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","description":"A description of object, which may be detailed.","example":"string"},"assignees":{"type":"array","description":"A set of owners assigned to this incident.","example":["string"],"items":{"type":"string"}},"meta":{"type":"object","additionalProperties":{"type":"object","description":"custom field relevant to attach meta data to.","example":"string","x-oneOf":[{"example":"string","type":"string"},{"example":10,"type":"number","format":"double"},{"example":"2016-01-01T01:01:01.000Z","type":"string","format":"date-time"},{"example":"keyword","type":"string"},{"example":true,"type":"boolean"}]},"description":"metadata associated to the incident.","example":{"keyword":"string"},"$$ref":"#/components/schemas/MetaData"},"schema_version":{"type":"string","description":"CTIM schema version for this entity.","example":"1.3.18","enum":["1.3.18"]},"revision":{"type":"integer","description":"A monotonically increasing revision, incremented each time the object is changed.","format":"int64","example":10},"type":{"type":"string","example":"incident","enum":["incident"]},"source":{"type":"string","description":"Represents the source of the intelligence that led to the creation of the entity.","example":"string"},"external_ids":{"type":"array","description":"It is used to store a list of external identifiers that can be linked to the incident, providing a reliable and manageable way to correlate and group related events across multiple data sources. It is especially useful in larger organizations that rely on multiple security information and event management (SIEM) systems to detect security incidents. For instance, it can be used to track events across different network sensors, intrusion detection and prevention systems (IDPS), or log management platforms. \n The field can also be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. It can be used to cross-reference with other external tools such as threat intelligence feeds and vulnerability scanners.","example":["string"],"items":{"type":"string"}},"short_description":{"type":"string","description":"A single line, short summary of the object.","example":"string"},"title":{"type":"string","description":"A short title for this object, used as primary display and reference value.","example":"string"},"incident_time":{"type":"object","properties":{"opened":{"type":"string","description":"Time the incident was first opened.","format":"date-time","example":"2016-01-01T01:01:01Z"},"discovered":{"type":"string","description":"Time the incident was first discovered.","format":"date-time","example":"2016-01-01T01:01:01Z"},"reported":{"type":"string","description":"Time the incident was first reported.","format":"date-time","example":"2016-01-01T01:01:01Z"},"remediated":{"type":"string","description":"Time that the remediation of the damage from the incident was completed.","format":"date-time","example":"2016-01-01T01:01:01Z"},"closed":{"type":"string","description":"Time that the incident was last closed.","format":"date-time","example":"2016-01-01T01:01:01Z"},"rejected":{"type":"string","description":"Time that the incident was first rejected.","format":"date-time","example":"2016-01-01T01:01:01Z"}},"additionalProperties":false,"description":"Relevant time values associated with this Incident.","example":{"opened":"2016-01-01T01:01:01.000Z","discovered":"2016-01-01T01:01:01.000Z","reported":"2016-01-01T01:01:01.000Z","remediated":"2016-01-01T01:01:01.000Z","closed":"2016-01-01T01:01:01.000Z","rejected":"2016-01-01T01:01:01.000Z"},"$$ref":"#/components/schemas/IncidentTime"},"external_references":{"type":"array","description":"Specifies a list of external references which refers to non-CTIM information.\n\nSimilar to `external_ids` field with major differences:\n\n- `external_ids` field is used to store a list of external identifiers that can be used to link entities across different data sources. These identifiers are typically standardized and well-known, such as CVE IDs, US-CERT advisories, or other industry-standard threat intelligence feeds. The `external_ids` field can be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. \n\n- `external_references` field, on the other hand, is used to provide a more general mechanism for linking entities to external sources of information. The `external_references` field can include references to blog posts, articles, external documents, threat intelligence reports, and other sources of information that may not have a standardized format or identifier.","example":[{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"}],"items":{"type":"object","properties":{"source_name":{"type":"string","description":"The source within which the external-reference is defined (system, registry, organization, etc.)","example":"string"},"description":{"type":"string","description":"Markdown string with at most 5000 characters.","example":"string"},"url":{"type":"string","description":"A URL reference to an external resource.","example":"string"},"hashes":{"type":"array","description":"Specifies a dictionary of hashes for the contents of the url.","example":["string"],"items":{"type":"string"}},"external_id":{"type":"string","description":"An identifier for the external reference content.","example":"string"}},"additionalProperties":false,"description":"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.","example":{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"},"$$ref":"#/components/schemas/ExternalReference"}},"discovery_method":{"type":"string","description":"Identifies how the incident was discovered.","example":"Agent Disclosure"},"source_uri":{"type":"string","description":"URI of the source of the intelligence that led to the creation of the entity.","example":"string"},"intended_effect":{"type":"string","description":"Specifies the suspected intended effect of this incident","example":"Account Takeover"},"categories":{"type":"array","description":"A set of categories for this incident.","example":["Attrition"],"items":{"type":"string"}},"status":{"type":"string","description":"The `status` field represents the current state of an incident within the incident management process. Its values help in tracking and reporting the progress of the incident from its discovery to its resolution.","example":"Closed","enum":["New","Closed","Open: Recovered","Closed: Other","Hold: Internal","Hold: Legal","Closed: Under Review","Rejected","Open","Restoration Achieved","Incident Reported","Closed: Suspected","Stalled","Open: Contained","Closed: Near-Miss","Hold: External","Containment Achieved","New: Processing","Closed: Confirmed Threat","Closed: False Positive","Open: Reported","Open: Investigating","Hold","New: Presented"]},"language":{"type":"string","description":"The `language` field is used to specify the primary language of the affected system or the target of an attack. It can be used to provide additional context and information about the entity. The primary purpose of this field is to help analysts filter and prioritize entities based on their knowledge and expertise of different languages.\n\nFor example, if an incident involves an attack on a system in a country where a specific language is predominant, the `language` field can be used to indicate that language, which can help analysts to quickly identify and respond to incidents that may be geographically or culturally relevant. This information can be used to prioritize incidents based on their potential impact. The `language` field can also be used to help with correlation of incidents across different systems and regions, as well as to help with data analysis and reporting.","example":"string"},"id":{"type":"string","description":"IDs are URIs, for example `https://www.domain.com/ctia/judgement/judgement-de305d54-75b4-431b-adb2-eb6b9e546014` for a [Judgement](judgement.md). This _ID_ type compares to the STIX _id_ field. The optional STIX _idref_ field is not used.","example":"string"},"promotion_method":{"type":"string","description":"Describes method for promoting an Incident, whether manually or automatically. An Incident may be created manually by a SOAR analyst or SOC operator, or through an automated correlation or aggregation rule or engine that matches a specific set of events or alerts, and promotes them to Incident(s).","example":"Automated","enum":["Automated","Manual"]},"severity":{"type":"string","description":"Represents the potential impact of an incident on an organization's security posture and business operations. It helps organizations prioritize and allocate resources for incident response based on the severity level of the incident \nIt helps analysts and incident handlers prioritize incidents by indicating the level of risk and potential impact associated with the incident. This enables organizations to allocate resources efficiently and address the most critical incidents first.\nCan also be used to generate reports and metrics for measuring the effectiveness of the incident response process and to identify trends and patterns in the threat landscape.\nIt is important to note that the `severity` field is subjective and can be interpreted differently by different organizations or analysts. Therefore, it should be used in conjunction with other intelligence attributes, such as the `confidence` field, to provide a more comprehensive view of the incident.","example":"Critical","enum":["Medium","Info","Unknown","None","High","Critical","Low"]},"tlp":{"type":"string","description":"TLP stands for [Traffic Light Protocol](https://www.us-cert.gov/tlp), which indicates precisely how a resource is intended to be shared, replicated, copied, etc.\n\nIt is used to indicate the sensitivity of the information contained within the message. This allows recipients to determine the appropriate handling and dissemination of the information based on their clearance level and need-to-know.\n\nFor example, an entity containing information about a critical vulnerability in a widely-used software might be marked as `red`, indicating that it should only be shared with a small group of highly trusted individuals who need to know in order to take appropriate action. On the other hand, a message containing more general information about security threats might be marked as `amber` or `green`, indicating that it can be shared more broadly within an organization.","example":"green","enum":["white","green","red","amber"]},"scores":{"type":"object","properties":{"asset":{"type":"integer","description":"Integer value between 1 - 10","format":"int64"},"ttp":{"type":"integer","description":"Integer value between 1 - 100","format":"int64"},"global":{"type":"integer","description":"Integer value between 1 - 1000","format":"int64"}},"additionalProperties":false,"$$ref":"#/components/schemas/RiskScores"},"techniques":{"type":"array","description":"Represents the specific methods or actions used by an attacker to carry out an offensive maneuver or achieve their goals.","example":["string"],"items":{"type":"string"}},"timestamp":{"type":"string","description":"The time this object was created at, or last modified.","format":"date-time","example":"2016-01-01T01:01:01Z"},"confidence":{"type":"string","description":"Represents the level of certainty or trustworthiness associated with the incident. It denotes the reliability of the intelligence associated with the incident.\nThe `confidence` field can take on several values, including:\n- `info`: Indicates that the incident information is based on sources with no previous track record or there is no track record for the source reporting the incident.\n- `low`: Indicates that the incident information is based on sources with a questionable track record or there is limited information about the accuracy of the source.\n- `medium`: Indicates that the incident information is based on sources with a mixed track record or of uncertain reliability.\n- `high`: Indicates that the incident information is based on sources with a proven track record and high degree of reliability.\nThe `confidence` field can be used to indicate the level of trust and confidence that can be attributed to the incident, and it may impact how the incident is prioritized, analyzed and addressed. It can also help in the decision-making process associated with the incident response activities.\nIt is important to note that the `confidence` field is subjective and can be interpreted differently by different organizations or analysts. As such, it is often used in conjunction with other intelligence attributes, such as the `severity` field, to provide a more complete picture of the incident.","example":"High","enum":["Medium","Info","Unknown","None","High","Low"]},"tactics":{"type":"array","description":"Represents the offensive techniques, approaches, or procedures that an adversary may use to achieve their objectives during an attack. It helps in understanding the intent and capabilities of the adversary and can be used to identify indicators of attack (IoAs) or indicators of compromise (IoCs) that are associated with the adversary's tactics.","example":["string"],"items":{"type":"string"}}},"additionalProperties":false,"description":"For submitting a new Incident.","example":{"description":"string","assignees":["string"],"meta":{"keyword":"string"},"schema_version":"1.3.18","revision":10,"type":"incident","source":"string","external_ids":["string"],"short_description":"string","title":"string","incident_time":{"opened":"2016-01-01T01:01:01.000Z","discovered":"2016-01-01T01:01:01.000Z","reported":"2016-01-01T01:01:01.000Z","remediated":"2016-01-01T01:01:01.000Z","closed":"2016-01-01T01:01:01.000Z","rejected":"2016-01-01T01:01:01.000Z"},"external_references":[{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"}],"discovery_method":"Agent Disclosure","source_uri":"string","intended_effect":"Account Takeover","categories":["Attrition"],"status":"Closed","language":"string","id":"string","promotion_method":"Automated","severity":"Critical","tlp":"green","scores":{"asset":10},"techniques":["string"],"timestamp":"2016-01-01T01:01:01.000Z","confidence":"High","tactics":["string"]},"$$ref":"#/components/schemas/PatchIncident"}},"application/x-yaml":{"schema":{"type":"object","properties":{"description":{"type":"string","description":"A description of object, which may be detailed.","example":"string"},"assignees":{"type":"array","description":"A set of owners assigned to this incident.","example":["string"],"items":{"type":"string"}},"meta":{"type":"object","additionalProperties":{"type":"object","description":"custom field relevant to attach meta data to.","example":"string","x-oneOf":[{"example":"string","type":"string"},{"example":10,"type":"number","format":"double"},{"example":"2016-01-01T01:01:01.000Z","type":"string","format":"date-time"},{"example":"keyword","type":"string"},{"example":true,"type":"boolean"}]},"description":"metadata associated to the incident.","example":{"keyword":"string"},"$$ref":"#/components/schemas/MetaData"},"schema_version":{"type":"string","description":"CTIM schema version for this entity.","example":"1.3.18","enum":["1.3.18"]},"revision":{"type":"integer","description":"A monotonically increasing revision, incremented each time the object is changed.","format":"int64","example":10},"type":{"type":"string","example":"incident","enum":["incident"]},"source":{"type":"string","description":"Represents the source of the intelligence that led to the creation of the entity.","example":"string"},"external_ids":{"type":"array","description":"It is used to store a list of external identifiers that can be linked to the incident, providing a reliable and manageable way to correlate and group related events across multiple data sources. It is especially useful in larger organizations that rely on multiple security information and event management (SIEM) systems to detect security incidents. For instance, it can be used to track events across different network sensors, intrusion detection and prevention systems (IDPS), or log management platforms. \n The field can also be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. It can be used to cross-reference with other external tools such as threat intelligence feeds and vulnerability scanners.","example":["string"],"items":{"type":"string"}},"short_description":{"type":"string","description":"A single line, short summary of the object.","example":"string"},"title":{"type":"string","description":"A short title for this object, used as primary display and reference value.","example":"string"},"incident_time":{"type":"object","properties":{"opened":{"type":"string","description":"Time the incident was first opened.","format":"date-time","example":"2016-01-01T01:01:01Z"},"discovered":{"type":"string","description":"Time the incident was first discovered.","format":"date-time","example":"2016-01-01T01:01:01Z"},"reported":{"type":"string","description":"Time the incident was first reported.","format":"date-time","example":"2016-01-01T01:01:01Z"},"remediated":{"type":"string","description":"Time that the remediation of the damage from the incident was completed.","format":"date-time","example":"2016-01-01T01:01:01Z"},"closed":{"type":"string","description":"Time that the incident was last closed.","format":"date-time","example":"2016-01-01T01:01:01Z"},"rejected":{"type":"string","description":"Time that the incident was first rejected.","format":"date-time","example":"2016-01-01T01:01:01Z"}},"additionalProperties":false,"description":"Relevant time values associated with this Incident.","example":{"opened":"2016-01-01T01:01:01.000Z","discovered":"2016-01-01T01:01:01.000Z","reported":"2016-01-01T01:01:01.000Z","remediated":"2016-01-01T01:01:01.000Z","closed":"2016-01-01T01:01:01.000Z","rejected":"2016-01-01T01:01:01.000Z"},"$$ref":"#/components/schemas/IncidentTime"},"external_references":{"type":"array","description":"Specifies a list of external references which refers to non-CTIM information.\n\nSimilar to `external_ids` field with major differences:\n\n- `external_ids` field is used to store a list of external identifiers that can be used to link entities across different data sources. These identifiers are typically standardized and well-known, such as CVE IDs, US-CERT advisories, or other industry-standard threat intelligence feeds. The `external_ids` field can be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. \n\n- `external_references` field, on the other hand, is used to provide a more general mechanism for linking entities to external sources of information. The `external_references` field can include references to blog posts, articles, external documents, threat intelligence reports, and other sources of information that may not have a standardized format or identifier.","example":[{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"}],"items":{"type":"object","properties":{"source_name":{"type":"string","description":"The source within which the external-reference is defined (system, registry, organization, etc.)","example":"string"},"description":{"type":"string","description":"Markdown string with at most 5000 characters.","example":"string"},"url":{"type":"string","description":"A URL reference to an external resource.","example":"string"},"hashes":{"type":"array","description":"Specifies a dictionary of hashes for the contents of the url.","example":["string"],"items":{"type":"string"}},"external_id":{"type":"string","description":"An identifier for the external reference content.","example":"string"}},"additionalProperties":false,"description":"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.","example":{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"},"$$ref":"#/components/schemas/ExternalReference"}},"discovery_method":{"type":"string","description":"Identifies how the incident was discovered.","example":"Agent Disclosure"},"source_uri":{"type":"string","description":"URI of the source of the intelligence that led to the creation of the entity.","example":"string"},"intended_effect":{"type":"string","description":"Specifies the suspected intended effect of this incident","example":"Account Takeover"},"categories":{"type":"array","description":"A set of categories for this incident.","example":["Attrition"],"items":{"type":"string"}},"status":{"type":"string","description":"The `status` field represents the current state of an incident within the incident management process. Its values help in tracking and reporting the progress of the incident from its discovery to its resolution.","example":"Closed","enum":["New","Closed","Open: Recovered","Closed: Other","Hold: Internal","Hold: Legal","Closed: Under Review","Rejected","Open","Restoration Achieved","Incident Reported","Closed: Suspected","Stalled","Open: Contained","Closed: Near-Miss","Hold: External","Containment Achieved","New: Processing","Closed: Confirmed Threat","Closed: False Positive","Open: Reported","Open: Investigating","Hold","New: Presented"]},"language":{"type":"string","description":"The `language` field is used to specify the primary language of the affected system or the target of an attack. It can be used to provide additional context and information about the entity. The primary purpose of this field is to help analysts filter and prioritize entities based on their knowledge and expertise of different languages.\n\nFor example, if an incident involves an attack on a system in a country where a specific language is predominant, the `language` field can be used to indicate that language, which can help analysts to quickly identify and respond to incidents that may be geographically or culturally relevant. This information can be used to prioritize incidents based on their potential impact. The `language` field can also be used to help with correlation of incidents across different systems and regions, as well as to help with data analysis and reporting.","example":"string"},"id":{"type":"string","description":"IDs are URIs, for example `https://www.domain.com/ctia/judgement/judgement-de305d54-75b4-431b-adb2-eb6b9e546014` for a [Judgement](judgement.md). This _ID_ type compares to the STIX _id_ field. The optional STIX _idref_ field is not used.","example":"string"},"promotion_method":{"type":"string","description":"Describes method for promoting an Incident, whether manually or automatically. An Incident may be created manually by a SOAR analyst or SOC operator, or through an automated correlation or aggregation rule or engine that matches a specific set of events or alerts, and promotes them to Incident(s).","example":"Automated","enum":["Automated","Manual"]},"severity":{"type":"string","description":"Represents the potential impact of an incident on an organization's security posture and business operations. It helps organizations prioritize and allocate resources for incident response based on the severity level of the incident \nIt helps analysts and incident handlers prioritize incidents by indicating the level of risk and potential impact associated with the incident. This enables organizations to allocate resources efficiently and address the most critical incidents first.\nCan also be used to generate reports and metrics for measuring the effectiveness of the incident response process and to identify trends and patterns in the threat landscape.\nIt is important to note that the `severity` field is subjective and can be interpreted differently by different organizations or analysts. Therefore, it should be used in conjunction with other intelligence attributes, such as the `confidence` field, to provide a more comprehensive view of the incident.","example":"Critical","enum":["Medium","Info","Unknown","None","High","Critical","Low"]},"tlp":{"type":"string","description":"TLP stands for [Traffic Light Protocol](https://www.us-cert.gov/tlp), which indicates precisely how a resource is intended to be shared, replicated, copied, etc.\n\nIt is used to indicate the sensitivity of the information contained within the message. This allows recipients to determine the appropriate handling and dissemination of the information based on their clearance level and need-to-know.\n\nFor example, an entity containing information about a critical vulnerability in a widely-used software might be marked as `red`, indicating that it should only be shared with a small group of highly trusted individuals who need to know in order to take appropriate action. On the other hand, a message containing more general information about security threats might be marked as `amber` or `green`, indicating that it can be shared more broadly within an organization.","example":"green","enum":["white","green","red","amber"]},"scores":{"type":"object","properties":{"asset":{"type":"integer","description":"Integer value between 1 - 10","format":"int64"},"ttp":{"type":"integer","description":"Integer value between 1 - 100","format":"int64"},"global":{"type":"integer","description":"Integer value between 1 - 1000","format":"int64"}},"additionalProperties":false,"$$ref":"#/components/schemas/RiskScores"},"techniques":{"type":"array","description":"Represents the specific methods or actions used by an attacker to carry out an offensive maneuver or achieve their goals.","example":["string"],"items":{"type":"string"}},"timestamp":{"type":"string","description":"The time this object was created at, or last modified.","format":"date-time","example":"2016-01-01T01:01:01Z"},"confidence":{"type":"string","description":"Represents the level of certainty or trustworthiness associated with the incident. It denotes the reliability of the intelligence associated with the incident.\nThe `confidence` field can take on several values, including:\n- `info`: Indicates that the incident information is based on sources with no previous track record or there is no track record for the source reporting the incident.\n- `low`: Indicates that the incident information is based on sources with a questionable track record or there is limited information about the accuracy of the source.\n- `medium`: Indicates that the incident information is based on sources with a mixed track record or of uncertain reliability.\n- `high`: Indicates that the incident information is based on sources with a proven track record and high degree of reliability.\nThe `confidence` field can be used to indicate the level of trust and confidence that can be attributed to the incident, and it may impact how the incident is prioritized, analyzed and addressed. It can also help in the decision-making process associated with the incident response activities.\nIt is important to note that the `confidence` field is subjective and can be interpreted differently by different organizations or analysts. As such, it is often used in conjunction with other intelligence attributes, such as the `severity` field, to provide a more complete picture of the incident.","example":"High","enum":["Medium","Info","Unknown","None","High","Low"]},"tactics":{"type":"array","description":"Represents the offensive techniques, approaches, or procedures that an adversary may use to achieve their objectives during an attack. It helps in understanding the intent and capabilities of the adversary and can be used to identify indicators of attack (IoAs) or indicators of compromise (IoCs) that are associated with the adversary's tactics.","example":["string"],"items":{"type":"string"}}},"additionalProperties":false,"description":"For submitting a new Incident.","example":{"description":"string","assignees":["string"],"meta":{"keyword":"string"},"schema_version":"1.3.18","revision":10,"type":"incident","source":"string","external_ids":["string"],"short_description":"string","title":"string","incident_time":{"opened":"2016-01-01T01:01:01.000Z","discovered":"2016-01-01T01:01:01.000Z","reported":"2016-01-01T01:01:01.000Z","remediated":"2016-01-01T01:01:01.000Z","closed":"2016-01-01T01:01:01.000Z","rejected":"2016-01-01T01:01:01.000Z"},"external_references":[{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"}],"discovery_method":"Agent Disclosure","source_uri":"string","intended_effect":"Account Takeover","categories":["Attrition"],"status":"Closed","language":"string","id":"string","promotion_method":"Automated","severity":"Critical","tlp":"green","scores":{"asset":10},"techniques":["string"],"timestamp":"2016-01-01T01:01:01.000Z","confidence":"High","tactics":["string"]},"$$ref":"#/components/schemas/PatchIncident"}},"application/edn":{"schema":{"type":"object","properties":{"description":{"type":"string","description":"A description of object, which may be detailed.","example":"string"},"assignees":{"type":"array","description":"A set of owners assigned to this incident.","example":["string"],"items":{"type":"string"}},"meta":{"type":"object","additionalProperties":{"type":"object","description":"custom field relevant to attach meta data to.","example":"string","x-oneOf":[{"example":"string","type":"string"},{"example":10,"type":"number","format":"double"},{"example":"2016-01-01T01:01:01.000Z","type":"string","format":"date-time"},{"example":"keyword","type":"string"},{"example":true,"type":"boolean"}]},"description":"metadata associated to the incident.","example":{"keyword":"string"},"$$ref":"#/components/schemas/MetaData"},"schema_version":{"type":"string","description":"CTIM schema version for this entity.","example":"1.3.18","enum":["1.3.18"]},"revision":{"type":"integer","description":"A monotonically increasing revision, incremented each time the object is changed.","format":"int64","example":10},"type":{"type":"string","example":"incident","enum":["incident"]},"source":{"type":"string","description":"Represents the source of the intelligence that led to the creation of the entity.","example":"string"},"external_ids":{"type":"array","description":"It is used to store a list of external identifiers that can be linked to the incident, providing a reliable and manageable way to correlate and group related events across multiple data sources. It is especially useful in larger organizations that rely on multiple security information and event management (SIEM) systems to detect security incidents. For instance, it can be used to track events across different network sensors, intrusion detection and prevention systems (IDPS), or log management platforms. \n The field can also be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. It can be used to cross-reference with other external tools such as threat intelligence feeds and vulnerability scanners.","example":["string"],"items":{"type":"string"}},"short_description":{"type":"string","description":"A single line, short summary of the object.","example":"string"},"title":{"type":"string","description":"A short title for this object, used as primary display and reference value.","example":"string"},"incident_time":{"type":"object","properties":{"opened":{"type":"string","description":"Time the incident was first opened.","format":"date-time","example":"2016-01-01T01:01:01Z"},"discovered":{"type":"string","description":"Time the incident was first discovered.","format":"date-time","example":"2016-01-01T01:01:01Z"},"reported":{"type":"string","description":"Time the incident was first reported.","format":"date-time","example":"2016-01-01T01:01:01Z"},"remediated":{"type":"string","description":"Time that the remediation of the damage from the incident was completed.","format":"date-time","example":"2016-01-01T01:01:01Z"},"closed":{"type":"string","description":"Time that the incident was last closed.","format":"date-time","example":"2016-01-01T01:01:01Z"},"rejected":{"type":"string","description":"Time that the incident was first rejected.","format":"date-time","example":"2016-01-01T01:01:01Z"}},"additionalProperties":false,"description":"Relevant time values associated with this Incident.","example":{"opened":"2016-01-01T01:01:01.000Z","discovered":"2016-01-01T01:01:01.000Z","reported":"2016-01-01T01:01:01.000Z","remediated":"2016-01-01T01:01:01.000Z","closed":"2016-01-01T01:01:01.000Z","rejected":"2016-01-01T01:01:01.000Z"},"$$ref":"#/components/schemas/IncidentTime"},"external_references":{"type":"array","description":"Specifies a list of external references which refers to non-CTIM information.\n\nSimilar to `external_ids` field with major differences:\n\n- `external_ids` field is used to store a list of external identifiers that can be used to link entities across different data sources. These identifiers are typically standardized and well-known, such as CVE IDs, US-CERT advisories, or other industry-standard threat intelligence feeds. The `external_ids` field can be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. \n\n- `external_references` field, on the other hand, is used to provide a more general mechanism for linking entities to external sources of information. The `external_references` field can include references to blog posts, articles, external documents, threat intelligence reports, and other sources of information that may not have a standardized format or identifier.","example":[{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"}],"items":{"type":"object","properties":{"source_name":{"type":"string","description":"The source within which the external-reference is defined (system, registry, organization, etc.)","example":"string"},"description":{"type":"string","description":"Markdown string with at most 5000 characters.","example":"string"},"url":{"type":"string","description":"A URL reference to an external resource.","example":"string"},"hashes":{"type":"array","description":"Specifies a dictionary of hashes for the contents of the url.","example":["string"],"items":{"type":"string"}},"external_id":{"type":"string","description":"An identifier for the external reference content.","example":"string"}},"additionalProperties":false,"description":"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.","example":{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"},"$$ref":"#/components/schemas/ExternalReference"}},"discovery_method":{"type":"string","description":"Identifies how the incident was discovered.","example":"Agent Disclosure"},"source_uri":{"type":"string","description":"URI of the source of the intelligence that led to the creation of the entity.","example":"string"},"intended_effect":{"type":"string","description":"Specifies the suspected intended effect of this incident","example":"Account Takeover"},"categories":{"type":"array","description":"A set of categories for this incident.","example":["Attrition"],"items":{"type":"string"}},"status":{"type":"string","description":"The `status` field represents the current state of an incident within the incident management process. Its values help in tracking and reporting the progress of the incident from its discovery to its resolution.","example":"Closed","enum":["New","Closed","Open: Recovered","Closed: Other","Hold: Internal","Hold: Legal","Closed: Under Review","Rejected","Open","Restoration Achieved","Incident Reported","Closed: Suspected","Stalled","Open: Contained","Closed: Near-Miss","Hold: External","Containment Achieved","New: Processing","Closed: Confirmed Threat","Closed: False Positive","Open: Reported","Open: Investigating","Hold","New: Presented"]},"language":{"type":"string","description":"The `language` field is used to specify the primary language of the affected system or the target of an attack. It can be used to provide additional context and information about the entity. The primary purpose of this field is to help analysts filter and prioritize entities based on their knowledge and expertise of different languages.\n\nFor example, if an incident involves an attack on a system in a country where a specific language is predominant, the `language` field can be used to indicate that language, which can help analysts to quickly identify and respond to incidents that may be geographically or culturally relevant. This information can be used to prioritize incidents based on their potential impact. The `language` field can also be used to help with correlation of incidents across different systems and regions, as well as to help with data analysis and reporting.","example":"string"},"id":{"type":"string","description":"IDs are URIs, for example `https://www.domain.com/ctia/judgement/judgement-de305d54-75b4-431b-adb2-eb6b9e546014` for a [Judgement](judgement.md). This _ID_ type compares to the STIX _id_ field. The optional STIX _idref_ field is not used.","example":"string"},"promotion_method":{"type":"string","description":"Describes method for promoting an Incident, whether manually or automatically. An Incident may be created manually by a SOAR analyst or SOC operator, or through an automated correlation or aggregation rule or engine that matches a specific set of events or alerts, and promotes them to Incident(s).","example":"Automated","enum":["Automated","Manual"]},"severity":{"type":"string","description":"Represents the potential impact of an incident on an organization's security posture and business operations. It helps organizations prioritize and allocate resources for incident response based on the severity level of the incident \nIt helps analysts and incident handlers prioritize incidents by indicating the level of risk and potential impact associated with the incident. This enables organizations to allocate resources efficiently and address the most critical incidents first.\nCan also be used to generate reports and metrics for measuring the effectiveness of the incident response process and to identify trends and patterns in the threat landscape.\nIt is important to note that the `severity` field is subjective and can be interpreted differently by different organizations or analysts. Therefore, it should be used in conjunction with other intelligence attributes, such as the `confidence` field, to provide a more comprehensive view of the incident.","example":"Critical","enum":["Medium","Info","Unknown","None","High","Critical","Low"]},"tlp":{"type":"string","description":"TLP stands for [Traffic Light Protocol](https://www.us-cert.gov/tlp), which indicates precisely how a resource is intended to be shared, replicated, copied, etc.\n\nIt is used to indicate the sensitivity of the information contained within the message. This allows recipients to determine the appropriate handling and dissemination of the information based on their clearance level and need-to-know.\n\nFor example, an entity containing information about a critical vulnerability in a widely-used software might be marked as `red`, indicating that it should only be shared with a small group of highly trusted individuals who need to know in order to take appropriate action. On the other hand, a message containing more general information about security threats might be marked as `amber` or `green`, indicating that it can be shared more broadly within an organization.","example":"green","enum":["white","green","red","amber"]},"scores":{"type":"object","properties":{"asset":{"type":"integer","description":"Integer value between 1 - 10","format":"int64"},"ttp":{"type":"integer","description":"Integer value between 1 - 100","format":"int64"},"global":{"type":"integer","description":"Integer value between 1 - 1000","format":"int64"}},"additionalProperties":false,"$$ref":"#/components/schemas/RiskScores"},"techniques":{"type":"array","description":"Represents the specific methods or actions used by an attacker to carry out an offensive maneuver or achieve their goals.","example":["string"],"items":{"type":"string"}},"timestamp":{"type":"string","description":"The time this object was created at, or last modified.","format":"date-time","example":"2016-01-01T01:01:01Z"},"confidence":{"type":"string","description":"Represents the level of certainty or trustworthiness associated with the incident. It denotes the reliability of the intelligence associated with the incident.\nThe `confidence` field can take on several values, including:\n- `info`: Indicates that the incident information is based on sources with no previous track record or there is no track record for the source reporting the incident.\n- `low`: Indicates that the incident information is based on sources with a questionable track record or there is limited information about the accuracy of the source.\n- `medium`: Indicates that the incident information is based on sources with a mixed track record or of uncertain reliability.\n- `high`: Indicates that the incident information is based on sources with a proven track record and high degree of reliability.\nThe `confidence` field can be used to indicate the level of trust and confidence that can be attributed to the incident, and it may impact how the incident is prioritized, analyzed and addressed. It can also help in the decision-making process associated with the incident response activities.\nIt is important to note that the `confidence` field is subjective and can be interpreted differently by different organizations or analysts. As such, it is often used in conjunction with other intelligence attributes, such as the `severity` field, to provide a more complete picture of the incident.","example":"High","enum":["Medium","Info","Unknown","None","High","Low"]},"tactics":{"type":"array","description":"Represents the offensive techniques, approaches, or procedures that an adversary may use to achieve their objectives during an attack. It helps in understanding the intent and capabilities of the adversary and can be used to identify indicators of attack (IoAs) or indicators of compromise (IoCs) that are associated with the adversary's tactics.","example":["string"],"items":{"type":"string"}}},"additionalProperties":false,"description":"For submitting a new Incident.","example":{"description":"string","assignees":["string"],"meta":{"keyword":"string"},"schema_version":"1.3.18","revision":10,"type":"incident","source":"string","external_ids":["string"],"short_description":"string","title":"string","incident_time":{"opened":"2016-01-01T01:01:01.000Z","discovered":"2016-01-01T01:01:01.000Z","reported":"2016-01-01T01:01:01.000Z","remediated":"2016-01-01T01:01:01.000Z","closed":"2016-01-01T01:01:01.000Z","rejected":"2016-01-01T01:01:01.000Z"},"external_references":[{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"}],"discovery_method":"Agent Disclosure","source_uri":"string","intended_effect":"Account Takeover","categories":["Attrition"],"status":"Closed","language":"string","id":"string","promotion_method":"Automated","severity":"Critical","tlp":"green","scores":{"asset":10},"techniques":["string"],"timestamp":"2016-01-01T01:01:01.000Z","confidence":"High","tactics":["string"]},"$$ref":"#/components/schemas/PatchIncident"}},"application/transit+json":{"schema":{"type":"object","properties":{"description":{"type":"string","description":"A description of object, which may be detailed.","example":"string"},"assignees":{"type":"array","description":"A set of owners assigned to this incident.","example":["string"],"items":{"type":"string"}},"meta":{"type":"object","additionalProperties":{"type":"object","description":"custom field relevant to attach meta data to.","example":"string","x-oneOf":[{"example":"string","type":"string"},{"example":10,"type":"number","format":"double"},{"example":"2016-01-01T01:01:01.000Z","type":"string","format":"date-time"},{"example":"keyword","type":"string"},{"example":true,"type":"boolean"}]},"description":"metadata associated to the incident.","example":{"keyword":"string"},"$$ref":"#/components/schemas/MetaData"},"schema_version":{"type":"string","description":"CTIM schema version for this entity.","example":"1.3.18","enum":["1.3.18"]},"revision":{"type":"integer","description":"A monotonically increasing revision, incremented each time the object is changed.","format":"int64","example":10},"type":{"type":"string","example":"incident","enum":["incident"]},"source":{"type":"string","description":"Represents the source of the intelligence that led to the creation of the entity.","example":"string"},"external_ids":{"type":"array","description":"It is used to store a list of external identifiers that can be linked to the incident, providing a reliable and manageable way to correlate and group related events across multiple data sources. It is especially useful in larger organizations that rely on multiple security information and event management (SIEM) systems to detect security incidents. For instance, it can be used to track events across different network sensors, intrusion detection and prevention systems (IDPS), or log management platforms. \n The field can also be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. It can be used to cross-reference with other external tools such as threat intelligence feeds and vulnerability scanners.","example":["string"],"items":{"type":"string"}},"short_description":{"type":"string","description":"A single line, short summary of the object.","example":"string"},"title":{"type":"string","description":"A short title for this object, used as primary display and reference value.","example":"string"},"incident_time":{"type":"object","properties":{"opened":{"type":"string","description":"Time the incident was first opened.","format":"date-time","example":"2016-01-01T01:01:01Z"},"discovered":{"type":"string","description":"Time the incident was first discovered.","format":"date-time","example":"2016-01-01T01:01:01Z"},"reported":{"type":"string","description":"Time the incident was first reported.","format":"date-time","example":"2016-01-01T01:01:01Z"},"remediated":{"type":"string","description":"Time that the remediation of the damage from the incident was completed.","format":"date-time","example":"2016-01-01T01:01:01Z"},"closed":{"type":"string","description":"Time that the incident was last closed.","format":"date-time","example":"2016-01-01T01:01:01Z"},"rejected":{"type":"string","description":"Time that the incident was first rejected.","format":"date-time","example":"2016-01-01T01:01:01Z"}},"additionalProperties":false,"description":"Relevant time values associated with this Incident.","example":{"opened":"2016-01-01T01:01:01.000Z","discovered":"2016-01-01T01:01:01.000Z","reported":"2016-01-01T01:01:01.000Z","remediated":"2016-01-01T01:01:01.000Z","closed":"2016-01-01T01:01:01.000Z","rejected":"2016-01-01T01:01:01.000Z"},"$$ref":"#/components/schemas/IncidentTime"},"external_references":{"type":"array","description":"Specifies a list of external references which refers to non-CTIM information.\n\nSimilar to `external_ids` field with major differences:\n\n- `external_ids` field is used to store a list of external identifiers that can be used to link entities across different data sources. These identifiers are typically standardized and well-known, such as CVE IDs, US-CERT advisories, or other industry-standard threat intelligence feeds. The `external_ids` field can be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. \n\n- `external_references` field, on the other hand, is used to provide a more general mechanism for linking entities to external sources of information. The `external_references` field can include references to blog posts, articles, external documents, threat intelligence reports, and other sources of information that may not have a standardized format or identifier.","example":[{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"}],"items":{"type":"object","properties":{"source_name":{"type":"string","description":"The source within which the external-reference is defined (system, registry, organization, etc.)","example":"string"},"description":{"type":"string","description":"Markdown string with at most 5000 characters.","example":"string"},"url":{"type":"string","description":"A URL reference to an external resource.","example":"string"},"hashes":{"type":"array","description":"Specifies a dictionary of hashes for the contents of the url.","example":["string"],"items":{"type":"string"}},"external_id":{"type":"string","description":"An identifier for the external reference content.","example":"string"}},"additionalProperties":false,"description":"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.","example":{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"},"$$ref":"#/components/schemas/ExternalReference"}},"discovery_method":{"type":"string","description":"Identifies how the incident was discovered.","example":"Agent Disclosure"},"source_uri":{"type":"string","description":"URI of the source of the intelligence that led to the creation of the entity.","example":"string"},"intended_effect":{"type":"string","description":"Specifies the suspected intended effect of this incident","example":"Account Takeover"},"categories":{"type":"array","description":"A set of categories for this incident.","example":["Attrition"],"items":{"type":"string"}},"status":{"type":"string","description":"The `status` field represents the current state of an incident within the incident management process. Its values help in tracking and reporting the progress of the incident from its discovery to its resolution.","example":"Closed","enum":["New","Closed","Open: Recovered","Closed: Other","Hold: Internal","Hold: Legal","Closed: Under Review","Rejected","Open","Restoration Achieved","Incident Reported","Closed: Suspected","Stalled","Open: Contained","Closed: Near-Miss","Hold: External","Containment Achieved","New: Processing","Closed: Confirmed Threat","Closed: False Positive","Open: Reported","Open: Investigating","Hold","New: Presented"]},"language":{"type":"string","description":"The `language` field is used to specify the primary language of the affected system or the target of an attack. It can be used to provide additional context and information about the entity. The primary purpose of this field is to help analysts filter and prioritize entities based on their knowledge and expertise of different languages.\n\nFor example, if an incident involves an attack on a system in a country where a specific language is predominant, the `language` field can be used to indicate that language, which can help analysts to quickly identify and respond to incidents that may be geographically or culturally relevant. This information can be used to prioritize incidents based on their potential impact. The `language` field can also be used to help with correlation of incidents across different systems and regions, as well as to help with data analysis and reporting.","example":"string"},"id":{"type":"string","description":"IDs are URIs, for example `https://www.domain.com/ctia/judgement/judgement-de305d54-75b4-431b-adb2-eb6b9e546014` for a [Judgement](judgement.md). This _ID_ type compares to the STIX _id_ field. The optional STIX _idref_ field is not used.","example":"string"},"promotion_method":{"type":"string","description":"Describes method for promoting an Incident, whether manually or automatically. An Incident may be created manually by a SOAR analyst or SOC operator, or through an automated correlation or aggregation rule or engine that matches a specific set of events or alerts, and promotes them to Incident(s).","example":"Automated","enum":["Automated","Manual"]},"severity":{"type":"string","description":"Represents the potential impact of an incident on an organization's security posture and business operations. It helps organizations prioritize and allocate resources for incident response based on the severity level of the incident \nIt helps analysts and incident handlers prioritize incidents by indicating the level of risk and potential impact associated with the incident. This enables organizations to allocate resources efficiently and address the most critical incidents first.\nCan also be used to generate reports and metrics for measuring the effectiveness of the incident response process and to identify trends and patterns in the threat landscape.\nIt is important to note that the `severity` field is subjective and can be interpreted differently by different organizations or analysts. Therefore, it should be used in conjunction with other intelligence attributes, such as the `confidence` field, to provide a more comprehensive view of the incident.","example":"Critical","enum":["Medium","Info","Unknown","None","High","Critical","Low"]},"tlp":{"type":"string","description":"TLP stands for [Traffic Light Protocol](https://www.us-cert.gov/tlp), which indicates precisely how a resource is intended to be shared, replicated, copied, etc.\n\nIt is used to indicate the sensitivity of the information contained within the message. This allows recipients to determine the appropriate handling and dissemination of the information based on their clearance level and need-to-know.\n\nFor example, an entity containing information about a critical vulnerability in a widely-used software might be marked as `red`, indicating that it should only be shared with a small group of highly trusted individuals who need to know in order to take appropriate action. On the other hand, a message containing more general information about security threats might be marked as `amber` or `green`, indicating that it can be shared more broadly within an organization.","example":"green","enum":["white","green","red","amber"]},"scores":{"type":"object","properties":{"asset":{"type":"integer","description":"Integer value between 1 - 10","format":"int64"},"ttp":{"type":"integer","description":"Integer value between 1 - 100","format":"int64"},"global":{"type":"integer","description":"Integer value between 1 - 1000","format":"int64"}},"additionalProperties":false,"$$ref":"#/components/schemas/RiskScores"},"techniques":{"type":"array","description":"Represents the specific methods or actions used by an attacker to carry out an offensive maneuver or achieve their goals.","example":["string"],"items":{"type":"string"}},"timestamp":{"type":"string","description":"The time this object was created at, or last modified.","format":"date-time","example":"2016-01-01T01:01:01Z"},"confidence":{"type":"string","description":"Represents the level of certainty or trustworthiness associated with the incident. It denotes the reliability of the intelligence associated with the incident.\nThe `confidence` field can take on several values, including:\n- `info`: Indicates that the incident information is based on sources with no previous track record or there is no track record for the source reporting the incident.\n- `low`: Indicates that the incident information is based on sources with a questionable track record or there is limited information about the accuracy of the source.\n- `medium`: Indicates that the incident information is based on sources with a mixed track record or of uncertain reliability.\n- `high`: Indicates that the incident information is based on sources with a proven track record and high degree of reliability.\nThe `confidence` field can be used to indicate the level of trust and confidence that can be attributed to the incident, and it may impact how the incident is prioritized, analyzed and addressed. It can also help in the decision-making process associated with the incident response activities.\nIt is important to note that the `confidence` field is subjective and can be interpreted differently by different organizations or analysts. As such, it is often used in conjunction with other intelligence attributes, such as the `severity` field, to provide a more complete picture of the incident.","example":"High","enum":["Medium","Info","Unknown","None","High","Low"]},"tactics":{"type":"array","description":"Represents the offensive techniques, approaches, or procedures that an adversary may use to achieve their objectives during an attack. It helps in understanding the intent and capabilities of the adversary and can be used to identify indicators of attack (IoAs) or indicators of compromise (IoCs) that are associated with the adversary's tactics.","example":["string"],"items":{"type":"string"}}},"additionalProperties":false,"description":"For submitting a new Incident.","example":{"description":"string","assignees":["string"],"meta":{"keyword":"string"},"schema_version":"1.3.18","revision":10,"type":"incident","source":"string","external_ids":["string"],"short_description":"string","title":"string","incident_time":{"opened":"2016-01-01T01:01:01.000Z","discovered":"2016-01-01T01:01:01.000Z","reported":"2016-01-01T01:01:01.000Z","remediated":"2016-01-01T01:01:01.000Z","closed":"2016-01-01T01:01:01.000Z","rejected":"2016-01-01T01:01:01.000Z"},"external_references":[{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"}],"discovery_method":"Agent Disclosure","source_uri":"string","intended_effect":"Account Takeover","categories":["Attrition"],"status":"Closed","language":"string","id":"string","promotion_method":"Automated","severity":"Critical","tlp":"green","scores":{"asset":10},"techniques":["string"],"timestamp":"2016-01-01T01:01:01.000Z","confidence":"High","tactics":["string"]},"$$ref":"#/components/schemas/PatchIncident"}},"application/transit+msgpack":{"schema":{"type":"object","properties":{"description":{"type":"string","description":"A description of object, which may be detailed.","example":"string"},"assignees":{"type":"array","description":"A set of owners assigned to this incident.","example":["string"],"items":{"type":"string"}},"meta":{"type":"object","additionalProperties":{"type":"object","description":"custom field relevant to attach meta data to.","example":"string","x-oneOf":[{"example":"string","type":"string"},{"example":10,"type":"number","format":"double"},{"example":"2016-01-01T01:01:01.000Z","type":"string","format":"date-time"},{"example":"keyword","type":"string"},{"example":true,"type":"boolean"}]},"description":"metadata associated to the incident.","example":{"keyword":"string"},"$$ref":"#/components/schemas/MetaData"},"schema_version":{"type":"string","description":"CTIM schema version for this entity.","example":"1.3.18","enum":["1.3.18"]},"revision":{"type":"integer","description":"A monotonically increasing revision, incremented each time the object is changed.","format":"int64","example":10},"type":{"type":"string","example":"incident","enum":["incident"]},"source":{"type":"string","description":"Represents the source of the intelligence that led to the creation of the entity.","example":"string"},"external_ids":{"type":"array","description":"It is used to store a list of external identifiers that can be linked to the incident, providing a reliable and manageable way to correlate and group related events across multiple data sources. It is especially useful in larger organizations that rely on multiple security information and event management (SIEM) systems to detect security incidents. For instance, it can be used to track events across different network sensors, intrusion detection and prevention systems (IDPS), or log management platforms. \n The field can also be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. It can be used to cross-reference with other external tools such as threat intelligence feeds and vulnerability scanners.","example":["string"],"items":{"type":"string"}},"short_description":{"type":"string","description":"A single line, short summary of the object.","example":"string"},"title":{"type":"string","description":"A short title for this object, used as primary display and reference value.","example":"string"},"incident_time":{"type":"object","properties":{"opened":{"type":"string","description":"Time the incident was first opened.","format":"date-time","example":"2016-01-01T01:01:01Z"},"discovered":{"type":"string","description":"Time the incident was first discovered.","format":"date-time","example":"2016-01-01T01:01:01Z"},"reported":{"type":"string","description":"Time the incident was first reported.","format":"date-time","example":"2016-01-01T01:01:01Z"},"remediated":{"type":"string","description":"Time that the remediation of the damage from the incident was completed.","format":"date-time","example":"2016-01-01T01:01:01Z"},"closed":{"type":"string","description":"Time that the incident was last closed.","format":"date-time","example":"2016-01-01T01:01:01Z"},"rejected":{"type":"string","description":"Time that the incident was first rejected.","format":"date-time","example":"2016-01-01T01:01:01Z"}},"additionalProperties":false,"description":"Relevant time values associated with this Incident.","example":{"opened":"2016-01-01T01:01:01.000Z","discovered":"2016-01-01T01:01:01.000Z","reported":"2016-01-01T01:01:01.000Z","remediated":"2016-01-01T01:01:01.000Z","closed":"2016-01-01T01:01:01.000Z","rejected":"2016-01-01T01:01:01.000Z"},"$$ref":"#/components/schemas/IncidentTime"},"external_references":{"type":"array","description":"Specifies a list of external references which refers to non-CTIM information.\n\nSimilar to `external_ids` field with major differences:\n\n- `external_ids` field is used to store a list of external identifiers that can be used to link entities across different data sources. These identifiers are typically standardized and well-known, such as CVE IDs, US-CERT advisories, or other industry-standard threat intelligence feeds. The `external_ids` field can be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. \n\n- `external_references` field, on the other hand, is used to provide a more general mechanism for linking entities to external sources of information. The `external_references` field can include references to blog posts, articles, external documents, threat intelligence reports, and other sources of information that may not have a standardized format or identifier.","example":[{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"}],"items":{"type":"object","properties":{"source_name":{"type":"string","description":"The source within which the external-reference is defined (system, registry, organization, etc.)","example":"string"},"description":{"type":"string","description":"Markdown string with at most 5000 characters.","example":"string"},"url":{"type":"string","description":"A URL reference to an external resource.","example":"string"},"hashes":{"type":"array","description":"Specifies a dictionary of hashes for the contents of the url.","example":["string"],"items":{"type":"string"}},"external_id":{"type":"string","description":"An identifier for the external reference content.","example":"string"}},"additionalProperties":false,"description":"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.","example":{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"},"$$ref":"#/components/schemas/ExternalReference"}},"discovery_method":{"type":"string","description":"Identifies how the incident was discovered.","example":"Agent Disclosure"},"source_uri":{"type":"string","description":"URI of the source of the intelligence that led to the creation of the entity.","example":"string"},"intended_effect":{"type":"string","description":"Specifies the suspected intended effect of this incident","example":"Account Takeover"},"categories":{"type":"array","description":"A set of categories for this incident.","example":["Attrition"],"items":{"type":"string"}},"status":{"type":"string","description":"The `status` field represents the current state of an incident within the incident management process. Its values help in tracking and reporting the progress of the incident from its discovery to its resolution.","example":"Closed","enum":["New","Closed","Open: Recovered","Closed: Other","Hold: Internal","Hold: Legal","Closed: Under Review","Rejected","Open","Restoration Achieved","Incident Reported","Closed: Suspected","Stalled","Open: Contained","Closed: Near-Miss","Hold: External","Containment Achieved","New: Processing","Closed: Confirmed Threat","Closed: False Positive","Open: Reported","Open: Investigating","Hold","New: Presented"]},"language":{"type":"string","description":"The `language` field is used to specify the primary language of the affected system or the target of an attack. It can be used to provide additional context and information about the entity. The primary purpose of this field is to help analysts filter and prioritize entities based on their knowledge and expertise of different languages.\n\nFor example, if an incident involves an attack on a system in a country where a specific language is predominant, the `language` field can be used to indicate that language, which can help analysts to quickly identify and respond to incidents that may be geographically or culturally relevant. This information can be used to prioritize incidents based on their potential impact. The `language` field can also be used to help with correlation of incidents across different systems and regions, as well as to help with data analysis and reporting.","example":"string"},"id":{"type":"string","description":"IDs are URIs, for example `https://www.domain.com/ctia/judgement/judgement-de305d54-75b4-431b-adb2-eb6b9e546014` for a [Judgement](judgement.md). This _ID_ type compares to the STIX _id_ field. The optional STIX _idref_ field is not used.","example":"string"},"promotion_method":{"type":"string","description":"Describes method for promoting an Incident, whether manually or automatically. An Incident may be created manually by a SOAR analyst or SOC operator, or through an automated correlation or aggregation rule or engine that matches a specific set of events or alerts, and promotes them to Incident(s).","example":"Automated","enum":["Automated","Manual"]},"severity":{"type":"string","description":"Represents the potential impact of an incident on an organization's security posture and business operations. It helps organizations prioritize and allocate resources for incident response based on the severity level of the incident \nIt helps analysts and incident handlers prioritize incidents by indicating the level of risk and potential impact associated with the incident. This enables organizations to allocate resources efficiently and address the most critical incidents first.\nCan also be used to generate reports and metrics for measuring the effectiveness of the incident response process and to identify trends and patterns in the threat landscape.\nIt is important to note that the `severity` field is subjective and can be interpreted differently by different organizations or analysts. Therefore, it should be used in conjunction with other intelligence attributes, such as the `confidence` field, to provide a more comprehensive view of the incident.","example":"Critical","enum":["Medium","Info","Unknown","None","High","Critical","Low"]},"tlp":{"type":"string","description":"TLP stands for [Traffic Light Protocol](https://www.us-cert.gov/tlp), which indicates precisely how a resource is intended to be shared, replicated, copied, etc.\n\nIt is used to indicate the sensitivity of the information contained within the message. This allows recipients to determine the appropriate handling and dissemination of the information based on their clearance level and need-to-know.\n\nFor example, an entity containing information about a critical vulnerability in a widely-used software might be marked as `red`, indicating that it should only be shared with a small group of highly trusted individuals who need to know in order to take appropriate action. On the other hand, a message containing more general information about security threats might be marked as `amber` or `green`, indicating that it can be shared more broadly within an organization.","example":"green","enum":["white","green","red","amber"]},"scores":{"type":"object","properties":{"asset":{"type":"integer","description":"Integer value between 1 - 10","format":"int64"},"ttp":{"type":"integer","description":"Integer value between 1 - 100","format":"int64"},"global":{"type":"integer","description":"Integer value between 1 - 1000","format":"int64"}},"additionalProperties":false,"$$ref":"#/components/schemas/RiskScores"},"techniques":{"type":"array","description":"Represents the specific methods or actions used by an attacker to carry out an offensive maneuver or achieve their goals.","example":["string"],"items":{"type":"string"}},"timestamp":{"type":"string","description":"The time this object was created at, or last modified.","format":"date-time","example":"2016-01-01T01:01:01Z"},"confidence":{"type":"string","description":"Represents the level of certainty or trustworthiness associated with the incident. It denotes the reliability of the intelligence associated with the incident.\nThe `confidence` field can take on several values, including:\n- `info`: Indicates that the incident information is based on sources with no previous track record or there is no track record for the source reporting the incident.\n- `low`: Indicates that the incident information is based on sources with a questionable track record or there is limited information about the accuracy of the source.\n- `medium`: Indicates that the incident information is based on sources with a mixed track record or of uncertain reliability.\n- `high`: Indicates that the incident information is based on sources with a proven track record and high degree of reliability.\nThe `confidence` field can be used to indicate the level of trust and confidence that can be attributed to the incident, and it may impact how the incident is prioritized, analyzed and addressed. It can also help in the decision-making process associated with the incident response activities.\nIt is important to note that the `confidence` field is subjective and can be interpreted differently by different organizations or analysts. As such, it is often used in conjunction with other intelligence attributes, such as the `severity` field, to provide a more complete picture of the incident.","example":"High","enum":["Medium","Info","Unknown","None","High","Low"]},"tactics":{"type":"array","description":"Represents the offensive techniques, approaches, or procedures that an adversary may use to achieve their objectives during an attack. It helps in understanding the intent and capabilities of the adversary and can be used to identify indicators of attack (IoAs) or indicators of compromise (IoCs) that are associated with the adversary's tactics.","example":["string"],"items":{"type":"string"}}},"additionalProperties":false,"description":"For submitting a new Incident.","example":{"description":"string","assignees":["string"],"meta":{"keyword":"string"},"schema_version":"1.3.18","revision":10,"type":"incident","source":"string","external_ids":["string"],"short_description":"string","title":"string","incident_time":{"opened":"2016-01-01T01:01:01.000Z","discovered":"2016-01-01T01:01:01.000Z","reported":"2016-01-01T01:01:01.000Z","remediated":"2016-01-01T01:01:01.000Z","closed":"2016-01-01T01:01:01.000Z","rejected":"2016-01-01T01:01:01.000Z"},"external_references":[{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"}],"discovery_method":"Agent Disclosure","source_uri":"string","intended_effect":"Account Takeover","categories":["Attrition"],"status":"Closed","language":"string","id":"string","promotion_method":"Automated","severity":"Critical","tlp":"green","scores":{"asset":10},"techniques":["string"],"timestamp":"2016-01-01T01:01:01.000Z","confidence":"High","tactics":["string"]},"$$ref":"#/components/schemas/PatchIncident"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"required":["confidence","id","incident_time","schema_version","status","type"],"type":"object","properties":{"description":{"type":"string","description":"A description of object, which may be detailed.","example":"string"},"assignees":{"type":"array","description":"A set of owners assigned to this incident.","example":["string"],"items":{"type":"string"}},"meta":{"type":"object","additionalProperties":{"type":"object","description":"custom field relevant to attach meta data to.","example":"string","x-oneOf":[{"example":"string","type":"string"},{"example":10,"type":"number","format":"double"},{"example":"2016-01-01T01:01:01.000Z","type":"string","format":"date-time"},{"example":"keyword","type":"string"},{"example":true,"type":"boolean"}]},"description":"metadata associated to the incident.","example":{"keyword":"string"},"$$ref":"#/components/schemas/MetaData"},"schema_version":{"type":"string","description":"CTIM schema version for this entity.","example":"1.3.18"},"revision":{"type":"integer","description":"A monotonically increasing revision, incremented each time the object is changed.","format":"int64","example":10},"type":{"type":"string","example":"incident","enum":["incident"]},"created":{"type":"string","format":"date-time"},"source":{"type":"string","description":"Represents the source of the intelligence that led to the creation of the entity.","example":"string"},"external_ids":{"type":"array","description":"It is used to store a list of external identifiers that can be linked to the incident, providing a reliable and manageable way to correlate and group related events across multiple data sources. It is especially useful in larger organizations that rely on multiple security information and event management (SIEM) systems to detect security incidents. For instance, it can be used to track events across different network sensors, intrusion detection and prevention systems (IDPS), or log management platforms. \n The field can also be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. It can be used to cross-reference with other external tools such as threat intelligence feeds and vulnerability scanners.","example":["string"],"items":{"type":"string"}},"modified":{"type":"string","format":"date-time"},"short_description":{"type":"string","description":"A single line, short summary of the object.","example":"string"},"title":{"type":"string","description":"A short title for this object, used as primary display and reference value.","example":"string"},"incident_time":{"type":"object","properties":{"opened":{"type":"string","description":"Time the incident was first opened.","format":"date-time","example":"2016-01-01T01:01:01Z"},"discovered":{"type":"string","description":"Time the incident was first discovered.","format":"date-time","example":"2016-01-01T01:01:01Z"},"reported":{"type":"string","description":"Time the incident was first reported.","format":"date-time","example":"2016-01-01T01:01:01Z"},"remediated":{"type":"string","description":"Time that the remediation of the damage from the incident was completed.","format":"date-time","example":"2016-01-01T01:01:01Z"},"closed":{"type":"string","description":"Time that the incident was last closed.","format":"date-time","example":"2016-01-01T01:01:01Z"},"rejected":{"type":"string","description":"Time that the incident was first rejected.","format":"date-time","example":"2016-01-01T01:01:01Z"}},"additionalProperties":false,"description":"Relevant time values associated with this Incident.","example":{"opened":"2016-01-01T01:01:01.000Z","discovered":"2016-01-01T01:01:01.000Z","reported":"2016-01-01T01:01:01.000Z","remediated":"2016-01-01T01:01:01.000Z","closed":"2016-01-01T01:01:01.000Z","rejected":"2016-01-01T01:01:01.000Z"},"$$ref":"#/components/schemas/IncidentTime"},"external_references":{"type":"array","description":"Specifies a list of external references which refers to non-CTIM information.\n\nSimilar to `external_ids` field with major differences:\n\n- `external_ids` field is used to store a list of external identifiers that can be used to link entities across different data sources. These identifiers are typically standardized and well-known, such as CVE IDs, US-CERT advisories, or other industry-standard threat intelligence feeds. The `external_ids` field can be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. \n\n- `external_references` field, on the other hand, is used to provide a more general mechanism for linking entities to external sources of information. The `external_references` field can include references to blog posts, articles, external documents, threat intelligence reports, and other sources of information that may not have a standardized format or identifier.","example":[{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"}],"items":{"type":"object","properties":{"source_name":{"type":"string","description":"The source within which the external-reference is defined (system, registry, organization, etc.)","example":"string"},"description":{"type":"string","description":"Markdown string with at most 5000 characters.","example":"string"},"url":{"type":"string","description":"A URL reference to an external resource.","example":"string"},"hashes":{"type":"array","description":"Specifies a dictionary of hashes for the contents of the url.","example":["string"],"items":{"type":"string"}},"external_id":{"type":"string","description":"An identifier for the external reference content.","example":"string"}},"additionalProperties":false,"description":"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.","example":{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"},"$$ref":"#/components/schemas/ExternalReference"}},"discovery_method":{"type":"string","description":"Identifies how the incident was discovered.","example":"Agent Disclosure"},"source_uri":{"type":"string","description":"URI of the source of the intelligence that led to the creation of the entity.","example":"string"},"intended_effect":{"type":"string","description":"Specifies the suspected intended effect of this incident","example":"Account Takeover"},"categories":{"type":"array","description":"A set of categories for this incident.","example":["Attrition"],"items":{"type":"string"}},"status":{"type":"string","description":"The `status` field represents the current state of an incident within the incident management process. Its values help in tracking and reporting the progress of the incident from its discovery to its resolution.","example":"Closed","enum":["New","Closed","Open: Recovered","Closed: Other","Hold: Internal","Hold: Legal","Closed: Under Review","Rejected","Open","Restoration Achieved","Incident Reported","Closed: Suspected","Stalled","Open: Contained","Closed: Near-Miss","Hold: External","Containment Achieved","New: Processing","Closed: Confirmed Threat","Closed: False Positive","Open: Reported","Open: Investigating","Hold","New: Presented"]},"language":{"type":"string","description":"The `language` field is used to specify the primary language of the affected system or the target of an attack. It can be used to provide additional context and information about the entity. The primary purpose of this field is to help analysts filter and prioritize entities based on their knowledge and expertise of different languages.\n\nFor example, if an incident involves an attack on a system in a country where a specific language is predominant, the `language` field can be used to indicate that language, which can help analysts to quickly identify and respond to incidents that may be geographically or culturally relevant. This information can be used to prioritize incidents based on their potential impact. The `language` field can also be used to help with correlation of incidents across different systems and regions, as well as to help with data analysis and reporting.","example":"string"},"id":{"type":"string","description":"Globally unique URI identifying this object.","example":"string"},"promotion_method":{"type":"string","description":"Describes method for promoting an Incident, whether manually or automatically. An Incident may be created manually by a SOAR analyst or SOC operator, or through an automated correlation or aggregation rule or engine that matches a specific set of events or alerts, and promotes them to Incident(s).","example":"Automated","enum":["Automated","Manual"]},"severity":{"type":"string","description":"Represents the potential impact of an incident on an organization's security posture and business operations. It helps organizations prioritize and allocate resources for incident response based on the severity level of the incident \nIt helps analysts and incident handlers prioritize incidents by indicating the level of risk and potential impact associated with the incident. This enables organizations to allocate resources efficiently and address the most critical incidents first.\nCan also be used to generate reports and metrics for measuring the effectiveness of the incident response process and to identify trends and patterns in the threat landscape.\nIt is important to note that the `severity` field is subjective and can be interpreted differently by different organizations or analysts. Therefore, it should be used in conjunction with other intelligence attributes, such as the `confidence` field, to provide a more comprehensive view of the incident.","example":"Critical","enum":["Medium","Info","Unknown","None","High","Critical","Low"]},"tlp":{"type":"string","description":"TLP stands for [Traffic Light Protocol](https://www.us-cert.gov/tlp), which indicates precisely how a resource is intended to be shared, replicated, copied, etc.\n\nIt is used to indicate the sensitivity of the information contained within the message. This allows recipients to determine the appropriate handling and dissemination of the information based on their clearance level and need-to-know.\n\nFor example, an entity containing information about a critical vulnerability in a widely-used software might be marked as `red`, indicating that it should only be shared with a small group of highly trusted individuals who need to know in order to take appropriate action. On the other hand, a message containing more general information about security threats might be marked as `amber` or `green`, indicating that it can be shared more broadly within an organization.","example":"green","enum":["white","green","red","amber"]},"scores":{"type":"object","additionalProperties":{"type":"number","description":"Field is used to indicate the severity or impact of the threat represented by the incident.\nIt's an open-type dictionary object with score types and numeric value of the score.\n\nFor example, systems can have the following score types:\n\n- `asset` - assesses the potential damage or harm that the threat can cause to the affected asset(s). The scale ranges from 0 to 10, with 10 indicating the highest potential harm. \n\n- `global` - assesses the overall impact or significance of the threat to the organization or wider community. The scale ranges from 0 to 1000, with 1000 indicating the highest impact.\n\n- `ttp` - a measure of the threat actor's proficiency in utilizing TTPs. Typically, ranges from 0-100, with a higher score indicating a greater threat or concern.","format":"double","example":10},"description":"Used to indicate the severity or impact score of the threat represented by the incident.","example":{"asset":10},"$$ref":"#/components/schemas/IncidentScores"},"client_id":{"type":"string"},"techniques":{"type":"array","description":"Represents the specific methods or actions used by an attacker to carry out an offensive maneuver or achieve their goals.","example":["string"],"items":{"type":"string"}},"groups":{"type":"array","items":{"type":"string"}},"timestamp":{"type":"string","description":"The time this object was created at, or last modified.","format":"date-time","example":"2016-01-01T01:01:01Z"},"confidence":{"type":"string","description":"Represents the level of certainty or trustworthiness associated with the incident. It denotes the reliability of the intelligence associated with the incident.\nThe `confidence` field can take on several values, including:\n- `info`: Indicates that the incident information is based on sources with no previous track record or there is no track record for the source reporting the incident.\n- `low`: Indicates that the incident information is based on sources with a questionable track record or there is limited information about the accuracy of the source.\n- `medium`: Indicates that the incident information is based on sources with a mixed track record or of uncertain reliability.\n- `high`: Indicates that the incident information is based on sources with a proven track record and high degree of reliability.\nThe `confidence` field can be used to indicate the level of trust and confidence that can be attributed to the incident, and it may impact how the incident is prioritized, analyzed and addressed. It can also help in the decision-making process associated with the incident response activities.\nIt is important to note that the `confidence` field is subjective and can be interpreted differently by different organizations or analysts. As such, it is often used in conjunction with other intelligence attributes, such as the `severity` field, to provide a more complete picture of the incident.","example":"High","enum":["Medium","Info","Unknown","None","High","Low"]},"owner":{"type":"string"},"tactics":{"type":"array","description":"Represents the offensive techniques, approaches, or procedures that an adversary may use to achieve their objectives during an attack. It helps in understanding the intent and capabilities of the adversary and can be used to identify indicators of attack (IoAs) or indicators of compromise (IoCs) that are associated with the adversary's tactics.","example":["string"],"items":{"type":"string"}}},"additionalProperties":{"type":"object"},"$$ref":"#/components/schemas/Incident"}},"application/x-yaml":{"schema":{"required":["confidence","id","incident_time","schema_version","status","type"],"type":"object","properties":{"description":{"type":"string","description":"A description of object, which may be detailed.","example":"string"},"assignees":{"type":"array","description":"A set of owners assigned to this incident.","example":["string"],"items":{"type":"string"}},"meta":{"type":"object","additionalProperties":{"type":"object","description":"custom field relevant to attach meta data to.","example":"string","x-oneOf":[{"example":"string","type":"string"},{"example":10,"type":"number","format":"double"},{"example":"2016-01-01T01:01:01.000Z","type":"string","format":"date-time"},{"example":"keyword","type":"string"},{"example":true,"type":"boolean"}]},"description":"metadata associated to the incident.","example":{"keyword":"string"},"$$ref":"#/components/schemas/MetaData"},"schema_version":{"type":"string","description":"CTIM schema version for this entity.","example":"1.3.18"},"revision":{"type":"integer","description":"A monotonically increasing revision, incremented each time the object is changed.","format":"int64","example":10},"type":{"type":"string","example":"incident","enum":["incident"]},"created":{"type":"string","format":"date-time"},"source":{"type":"string","description":"Represents the source of the intelligence that led to the creation of the entity.","example":"string"},"external_ids":{"type":"array","description":"It is used to store a list of external identifiers that can be linked to the incident, providing a reliable and manageable way to correlate and group related events across multiple data sources. It is especially useful in larger organizations that rely on multiple security information and event management (SIEM) systems to detect security incidents. For instance, it can be used to track events across different network sensors, intrusion detection and prevention systems (IDPS), or log management platforms. \n The field can also be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. It can be used to cross-reference with other external tools such as threat intelligence feeds and vulnerability scanners.","example":["string"],"items":{"type":"string"}},"modified":{"type":"string","format":"date-time"},"short_description":{"type":"string","description":"A single line, short summary of the object.","example":"string"},"title":{"type":"string","description":"A short title for this object, used as primary display and reference value.","example":"string"},"incident_time":{"type":"object","properties":{"opened":{"type":"string","description":"Time the incident was first opened.","format":"date-time","example":"2016-01-01T01:01:01Z"},"discovered":{"type":"string","description":"Time the incident was first discovered.","format":"date-time","example":"2016-01-01T01:01:01Z"},"reported":{"type":"string","description":"Time the incident was first reported.","format":"date-time","example":"2016-01-01T01:01:01Z"},"remediated":{"type":"string","description":"Time that the remediation of the damage from the incident was completed.","format":"date-time","example":"2016-01-01T01:01:01Z"},"closed":{"type":"string","description":"Time that the incident was last closed.","format":"date-time","example":"2016-01-01T01:01:01Z"},"rejected":{"type":"string","description":"Time that the incident was first rejected.","format":"date-time","example":"2016-01-01T01:01:01Z"}},"additionalProperties":false,"description":"Relevant time values associated with this Incident.","example":{"opened":"2016-01-01T01:01:01.000Z","discovered":"2016-01-01T01:01:01.000Z","reported":"2016-01-01T01:01:01.000Z","remediated":"2016-01-01T01:01:01.000Z","closed":"2016-01-01T01:01:01.000Z","rejected":"2016-01-01T01:01:01.000Z"},"$$ref":"#/components/schemas/IncidentTime"},"external_references":{"type":"array","description":"Specifies a list of external references which refers to non-CTIM information.\n\nSimilar to `external_ids` field with major differences:\n\n- `external_ids` field is used to store a list of external identifiers that can be used to link entities across different data sources. These identifiers are typically standardized and well-known, such as CVE IDs, US-CERT advisories, or other industry-standard threat intelligence feeds. The `external_ids` field can be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. \n\n- `external_references` field, on the other hand, is used to provide a more general mechanism for linking entities to external sources of information. The `external_references` field can include references to blog posts, articles, external documents, threat intelligence reports, and other sources of information that may not have a standardized format or identifier.","example":[{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"}],"items":{"type":"object","properties":{"source_name":{"type":"string","description":"The source within which the external-reference is defined (system, registry, organization, etc.)","example":"string"},"description":{"type":"string","description":"Markdown string with at most 5000 characters.","example":"string"},"url":{"type":"string","description":"A URL reference to an external resource.","example":"string"},"hashes":{"type":"array","description":"Specifies a dictionary of hashes for the contents of the url.","example":["string"],"items":{"type":"string"}},"external_id":{"type":"string","description":"An identifier for the external reference content.","example":"string"}},"additionalProperties":false,"description":"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.","example":{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"},"$$ref":"#/components/schemas/ExternalReference"}},"discovery_method":{"type":"string","description":"Identifies how the incident was discovered.","example":"Agent Disclosure"},"source_uri":{"type":"string","description":"URI of the source of the intelligence that led to the creation of the entity.","example":"string"},"intended_effect":{"type":"string","description":"Specifies the suspected intended effect of this incident","example":"Account Takeover"},"categories":{"type":"array","description":"A set of categories for this incident.","example":["Attrition"],"items":{"type":"string"}},"status":{"type":"string","description":"The `status` field represents the current state of an incident within the incident management process. Its values help in tracking and reporting the progress of the incident from its discovery to its resolution.","example":"Closed","enum":["New","Closed","Open: Recovered","Closed: Other","Hold: Internal","Hold: Legal","Closed: Under Review","Rejected","Open","Restoration Achieved","Incident Reported","Closed: Suspected","Stalled","Open: Contained","Closed: Near-Miss","Hold: External","Containment Achieved","New: Processing","Closed: Confirmed Threat","Closed: False Positive","Open: Reported","Open: Investigating","Hold","New: Presented"]},"language":{"type":"string","description":"The `language` field is used to specify the primary language of the affected system or the target of an attack. It can be used to provide additional context and information about the entity. The primary purpose of this field is to help analysts filter and prioritize entities based on their knowledge and expertise of different languages.\n\nFor example, if an incident involves an attack on a system in a country where a specific language is predominant, the `language` field can be used to indicate that language, which can help analysts to quickly identify and respond to incidents that may be geographically or culturally relevant. This information can be used to prioritize incidents based on their potential impact. The `language` field can also be used to help with correlation of incidents across different systems and regions, as well as to help with data analysis and reporting.","example":"string"},"id":{"type":"string","description":"Globally unique URI identifying this object.","example":"string"},"promotion_method":{"type":"string","description":"Describes method for promoting an Incident, whether manually or automatically. An Incident may be created manually by a SOAR analyst or SOC operator, or through an automated correlation or aggregation rule or engine that matches a specific set of events or alerts, and promotes them to Incident(s).","example":"Automated","enum":["Automated","Manual"]},"severity":{"type":"string","description":"Represents the potential impact of an incident on an organization's security posture and business operations. It helps organizations prioritize and allocate resources for incident response based on the severity level of the incident \nIt helps analysts and incident handlers prioritize incidents by indicating the level of risk and potential impact associated with the incident. This enables organizations to allocate resources efficiently and address the most critical incidents first.\nCan also be used to generate reports and metrics for measuring the effectiveness of the incident response process and to identify trends and patterns in the threat landscape.\nIt is important to note that the `severity` field is subjective and can be interpreted differently by different organizations or analysts. Therefore, it should be used in conjunction with other intelligence attributes, such as the `confidence` field, to provide a more comprehensive view of the incident.","example":"Critical","enum":["Medium","Info","Unknown","None","High","Critical","Low"]},"tlp":{"type":"string","description":"TLP stands for [Traffic Light Protocol](https://www.us-cert.gov/tlp), which indicates precisely how a resource is intended to be shared, replicated, copied, etc.\n\nIt is used to indicate the sensitivity of the information contained within the message. This allows recipients to determine the appropriate handling and dissemination of the information based on their clearance level and need-to-know.\n\nFor example, an entity containing information about a critical vulnerability in a widely-used software might be marked as `red`, indicating that it should only be shared with a small group of highly trusted individuals who need to know in order to take appropriate action. On the other hand, a message containing more general information about security threats might be marked as `amber` or `green`, indicating that it can be shared more broadly within an organization.","example":"green","enum":["white","green","red","amber"]},"scores":{"type":"object","additionalProperties":{"type":"number","description":"Field is used to indicate the severity or impact of the threat represented by the incident.\nIt's an open-type dictionary object with score types and numeric value of the score.\n\nFor example, systems can have the following score types:\n\n- `asset` - assesses the potential damage or harm that the threat can cause to the affected asset(s). The scale ranges from 0 to 10, with 10 indicating the highest potential harm. \n\n- `global` - assesses the overall impact or significance of the threat to the organization or wider community. The scale ranges from 0 to 1000, with 1000 indicating the highest impact.\n\n- `ttp` - a measure of the threat actor's proficiency in utilizing TTPs. Typically, ranges from 0-100, with a higher score indicating a greater threat or concern.","format":"double","example":10},"description":"Used to indicate the severity or impact score of the threat represented by the incident.","example":{"asset":10},"$$ref":"#/components/schemas/IncidentScores"},"client_id":{"type":"string"},"techniques":{"type":"array","description":"Represents the specific methods or actions used by an attacker to carry out an offensive maneuver or achieve their goals.","example":["string"],"items":{"type":"string"}},"groups":{"type":"array","items":{"type":"string"}},"timestamp":{"type":"string","description":"The time this object was created at, or last modified.","format":"date-time","example":"2016-01-01T01:01:01Z"},"confidence":{"type":"string","description":"Represents the level of certainty or trustworthiness associated with the incident. It denotes the reliability of the intelligence associated with the incident.\nThe `confidence` field can take on several values, including:\n- `info`: Indicates that the incident information is based on sources with no previous track record or there is no track record for the source reporting the incident.\n- `low`: Indicates that the incident information is based on sources with a questionable track record or there is limited information about the accuracy of the source.\n- `medium`: Indicates that the incident information is based on sources with a mixed track record or of uncertain reliability.\n- `high`: Indicates that the incident information is based on sources with a proven track record and high degree of reliability.\nThe `confidence` field can be used to indicate the level of trust and confidence that can be attributed to the incident, and it may impact how the incident is prioritized, analyzed and addressed. It can also help in the decision-making process associated with the incident response activities.\nIt is important to note that the `confidence` field is subjective and can be interpreted differently by different organizations or analysts. As such, it is often used in conjunction with other intelligence attributes, such as the `severity` field, to provide a more complete picture of the incident.","example":"High","enum":["Medium","Info","Unknown","None","High","Low"]},"owner":{"type":"string"},"tactics":{"type":"array","description":"Represents the offensive techniques, approaches, or procedures that an adversary may use to achieve their objectives during an attack. It helps in understanding the intent and capabilities of the adversary and can be used to identify indicators of attack (IoAs) or indicators of compromise (IoCs) that are associated with the adversary's tactics.","example":["string"],"items":{"type":"string"}}},"additionalProperties":{"type":"object"},"$$ref":"#/components/schemas/Incident"}},"application/edn":{"schema":{"required":["confidence","id","incident_time","schema_version","status","type"],"type":"object","properties":{"description":{"type":"string","description":"A description of object, which may be detailed.","example":"string"},"assignees":{"type":"array","description":"A set of owners assigned to this incident.","example":["string"],"items":{"type":"string"}},"meta":{"type":"object","additionalProperties":{"type":"object","description":"custom field relevant to attach meta data to.","example":"string","x-oneOf":[{"example":"string","type":"string"},{"example":10,"type":"number","format":"double"},{"example":"2016-01-01T01:01:01.000Z","type":"string","format":"date-time"},{"example":"keyword","type":"string"},{"example":true,"type":"boolean"}]},"description":"metadata associated to the incident.","example":{"keyword":"string"},"$$ref":"#/components/schemas/MetaData"},"schema_version":{"type":"string","description":"CTIM schema version for this entity.","example":"1.3.18"},"revision":{"type":"integer","description":"A monotonically increasing revision, incremented each time the object is changed.","format":"int64","example":10},"type":{"type":"string","example":"incident","enum":["incident"]},"created":{"type":"string","format":"date-time"},"source":{"type":"string","description":"Represents the source of the intelligence that led to the creation of the entity.","example":"string"},"external_ids":{"type":"array","description":"It is used to store a list of external identifiers that can be linked to the incident, providing a reliable and manageable way to correlate and group related events across multiple data sources. It is especially useful in larger organizations that rely on multiple security information and event management (SIEM) systems to detect security incidents. For instance, it can be used to track events across different network sensors, intrusion detection and prevention systems (IDPS), or log management platforms. \n The field can also be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. It can be used to cross-reference with other external tools such as threat intelligence feeds and vulnerability scanners.","example":["string"],"items":{"type":"string"}},"modified":{"type":"string","format":"date-time"},"short_description":{"type":"string","description":"A single line, short summary of the object.","example":"string"},"title":{"type":"string","description":"A short title for this object, used as primary display and reference value.","example":"string"},"incident_time":{"type":"object","properties":{"opened":{"type":"string","description":"Time the incident was first opened.","format":"date-time","example":"2016-01-01T01:01:01Z"},"discovered":{"type":"string","description":"Time the incident was first discovered.","format":"date-time","example":"2016-01-01T01:01:01Z"},"reported":{"type":"string","description":"Time the incident was first reported.","format":"date-time","example":"2016-01-01T01:01:01Z"},"remediated":{"type":"string","description":"Time that the remediation of the damage from the incident was completed.","format":"date-time","example":"2016-01-01T01:01:01Z"},"closed":{"type":"string","description":"Time that the incident was last closed.","format":"date-time","example":"2016-01-01T01:01:01Z"},"rejected":{"type":"string","description":"Time that the incident was first rejected.","format":"date-time","example":"2016-01-01T01:01:01Z"}},"additionalProperties":false,"description":"Relevant time values associated with this Incident.","example":{"opened":"2016-01-01T01:01:01.000Z","discovered":"2016-01-01T01:01:01.000Z","reported":"2016-01-01T01:01:01.000Z","remediated":"2016-01-01T01:01:01.000Z","closed":"2016-01-01T01:01:01.000Z","rejected":"2016-01-01T01:01:01.000Z"},"$$ref":"#/components/schemas/IncidentTime"},"external_references":{"type":"array","description":"Specifies a list of external references which refers to non-CTIM information.\n\nSimilar to `external_ids` field with major differences:\n\n- `external_ids` field is used to store a list of external identifiers that can be used to link entities across different data sources. These identifiers are typically standardized and well-known, such as CVE IDs, US-CERT advisories, or other industry-standard threat intelligence feeds. The `external_ids` field can be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. \n\n- `external_references` field, on the other hand, is used to provide a more general mechanism for linking entities to external sources of information. The `external_references` field can include references to blog posts, articles, external documents, threat intelligence reports, and other sources of information that may not have a standardized format or identifier.","example":[{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"}],"items":{"type":"object","properties":{"source_name":{"type":"string","description":"The source within which the external-reference is defined (system, registry, organization, etc.)","example":"string"},"description":{"type":"string","description":"Markdown string with at most 5000 characters.","example":"string"},"url":{"type":"string","description":"A URL reference to an external resource.","example":"string"},"hashes":{"type":"array","description":"Specifies a dictionary of hashes for the contents of the url.","example":["string"],"items":{"type":"string"}},"external_id":{"type":"string","description":"An identifier for the external reference content.","example":"string"}},"additionalProperties":false,"description":"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.","example":{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"},"$$ref":"#/components/schemas/ExternalReference"}},"discovery_method":{"type":"string","description":"Identifies how the incident was discovered.","example":"Agent Disclosure"},"source_uri":{"type":"string","description":"URI of the source of the intelligence that led to the creation of the entity.","example":"string"},"intended_effect":{"type":"string","description":"Specifies the suspected intended effect of this incident","example":"Account Takeover"},"categories":{"type":"array","description":"A set of categories for this incident.","example":["Attrition"],"items":{"type":"string"}},"status":{"type":"string","description":"The `status` field represents the current state of an incident within the incident management process. Its values help in tracking and reporting the progress of the incident from its discovery to its resolution.","example":"Closed","enum":["New","Closed","Open: Recovered","Closed: Other","Hold: Internal","Hold: Legal","Closed: Under Review","Rejected","Open","Restoration Achieved","Incident Reported","Closed: Suspected","Stalled","Open: Contained","Closed: Near-Miss","Hold: External","Containment Achieved","New: Processing","Closed: Confirmed Threat","Closed: False Positive","Open: Reported","Open: Investigating","Hold","New: Presented"]},"language":{"type":"string","description":"The `language` field is used to specify the primary language of the affected system or the target of an attack. It can be used to provide additional context and information about the entity. The primary purpose of this field is to help analysts filter and prioritize entities based on their knowledge and expertise of different languages.\n\nFor example, if an incident involves an attack on a system in a country where a specific language is predominant, the `language` field can be used to indicate that language, which can help analysts to quickly identify and respond to incidents that may be geographically or culturally relevant. This information can be used to prioritize incidents based on their potential impact. The `language` field can also be used to help with correlation of incidents across different systems and regions, as well as to help with data analysis and reporting.","example":"string"},"id":{"type":"string","description":"Globally unique URI identifying this object.","example":"string"},"promotion_method":{"type":"string","description":"Describes method for promoting an Incident, whether manually or automatically. An Incident may be created manually by a SOAR analyst or SOC operator, or through an automated correlation or aggregation rule or engine that matches a specific set of events or alerts, and promotes them to Incident(s).","example":"Automated","enum":["Automated","Manual"]},"severity":{"type":"string","description":"Represents the potential impact of an incident on an organization's security posture and business operations. It helps organizations prioritize and allocate resources for incident response based on the severity level of the incident \nIt helps analysts and incident handlers prioritize incidents by indicating the level of risk and potential impact associated with the incident. This enables organizations to allocate resources efficiently and address the most critical incidents first.\nCan also be used to generate reports and metrics for measuring the effectiveness of the incident response process and to identify trends and patterns in the threat landscape.\nIt is important to note that the `severity` field is subjective and can be interpreted differently by different organizations or analysts. Therefore, it should be used in conjunction with other intelligence attributes, such as the `confidence` field, to provide a more comprehensive view of the incident.","example":"Critical","enum":["Medium","Info","Unknown","None","High","Critical","Low"]},"tlp":{"type":"string","description":"TLP stands for [Traffic Light Protocol](https://www.us-cert.gov/tlp), which indicates precisely how a resource is intended to be shared, replicated, copied, etc.\n\nIt is used to indicate the sensitivity of the information contained within the message. This allows recipients to determine the appropriate handling and dissemination of the information based on their clearance level and need-to-know.\n\nFor example, an entity containing information about a critical vulnerability in a widely-used software might be marked as `red`, indicating that it should only be shared with a small group of highly trusted individuals who need to know in order to take appropriate action. On the other hand, a message containing more general information about security threats might be marked as `amber` or `green`, indicating that it can be shared more broadly within an organization.","example":"green","enum":["white","green","red","amber"]},"scores":{"type":"object","additionalProperties":{"type":"number","description":"Field is used to indicate the severity or impact of the threat represented by the incident.\nIt's an open-type dictionary object with score types and numeric value of the score.\n\nFor example, systems can have the following score types:\n\n- `asset` - assesses the potential damage or harm that the threat can cause to the affected asset(s). The scale ranges from 0 to 10, with 10 indicating the highest potential harm. \n\n- `global` - assesses the overall impact or significance of the threat to the organization or wider community. The scale ranges from 0 to 1000, with 1000 indicating the highest impact.\n\n- `ttp` - a measure of the threat actor's proficiency in utilizing TTPs. Typically, ranges from 0-100, with a higher score indicating a greater threat or concern.","format":"double","example":10},"description":"Used to indicate the severity or impact score of the threat represented by the incident.","example":{"asset":10},"$$ref":"#/components/schemas/IncidentScores"},"client_id":{"type":"string"},"techniques":{"type":"array","description":"Represents the specific methods or actions used by an attacker to carry out an offensive maneuver or achieve their goals.","example":["string"],"items":{"type":"string"}},"groups":{"type":"array","items":{"type":"string"}},"timestamp":{"type":"string","description":"The time this object was created at, or last modified.","format":"date-time","example":"2016-01-01T01:01:01Z"},"confidence":{"type":"string","description":"Represents the level of certainty or trustworthiness associated with the incident. It denotes the reliability of the intelligence associated with the incident.\nThe `confidence` field can take on several values, including:\n- `info`: Indicates that the incident information is based on sources with no previous track record or there is no track record for the source reporting the incident.\n- `low`: Indicates that the incident information is based on sources with a questionable track record or there is limited information about the accuracy of the source.\n- `medium`: Indicates that the incident information is based on sources with a mixed track record or of uncertain reliability.\n- `high`: Indicates that the incident information is based on sources with a proven track record and high degree of reliability.\nThe `confidence` field can be used to indicate the level of trust and confidence that can be attributed to the incident, and it may impact how the incident is prioritized, analyzed and addressed. It can also help in the decision-making process associated with the incident response activities.\nIt is important to note that the `confidence` field is subjective and can be interpreted differently by different organizations or analysts. As such, it is often used in conjunction with other intelligence attributes, such as the `severity` field, to provide a more complete picture of the incident.","example":"High","enum":["Medium","Info","Unknown","None","High","Low"]},"owner":{"type":"string"},"tactics":{"type":"array","description":"Represents the offensive techniques, approaches, or procedures that an adversary may use to achieve their objectives during an attack. It helps in understanding the intent and capabilities of the adversary and can be used to identify indicators of attack (IoAs) or indicators of compromise (IoCs) that are associated with the adversary's tactics.","example":["string"],"items":{"type":"string"}}},"additionalProperties":{"type":"object"},"$$ref":"#/components/schemas/Incident"}},"application/transit+json":{"schema":{"required":["confidence","id","incident_time","schema_version","status","type"],"type":"object","properties":{"description":{"type":"string","description":"A description of object, which may be detailed.","example":"string"},"assignees":{"type":"array","description":"A set of owners assigned to this incident.","example":["string"],"items":{"type":"string"}},"meta":{"type":"object","additionalProperties":{"type":"object","description":"custom field relevant to attach meta data to.","example":"string","x-oneOf":[{"example":"string","type":"string"},{"example":10,"type":"number","format":"double"},{"example":"2016-01-01T01:01:01.000Z","type":"string","format":"date-time"},{"example":"keyword","type":"string"},{"example":true,"type":"boolean"}]},"description":"metadata associated to the incident.","example":{"keyword":"string"},"$$ref":"#/components/schemas/MetaData"},"schema_version":{"type":"string","description":"CTIM schema version for this entity.","example":"1.3.18"},"revision":{"type":"integer","description":"A monotonically increasing revision, incremented each time the object is changed.","format":"int64","example":10},"type":{"type":"string","example":"incident","enum":["incident"]},"created":{"type":"string","format":"date-time"},"source":{"type":"string","description":"Represents the source of the intelligence that led to the creation of the entity.","example":"string"},"external_ids":{"type":"array","description":"It is used to store a list of external identifiers that can be linked to the incident, providing a reliable and manageable way to correlate and group related events across multiple data sources. It is especially useful in larger organizations that rely on multiple security information and event management (SIEM) systems to detect security incidents. For instance, it can be used to track events across different network sensors, intrusion detection and prevention systems (IDPS), or log management platforms. \n The field can also be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. It can be used to cross-reference with other external tools such as threat intelligence feeds and vulnerability scanners.","example":["string"],"items":{"type":"string"}},"modified":{"type":"string","format":"date-time"},"short_description":{"type":"string","description":"A single line, short summary of the object.","example":"string"},"title":{"type":"string","description":"A short title for this object, used as primary display and reference value.","example":"string"},"incident_time":{"type":"object","properties":{"opened":{"type":"string","description":"Time the incident was first opened.","format":"date-time","example":"2016-01-01T01:01:01Z"},"discovered":{"type":"string","description":"Time the incident was first discovered.","format":"date-time","example":"2016-01-01T01:01:01Z"},"reported":{"type":"string","description":"Time the incident was first reported.","format":"date-time","example":"2016-01-01T01:01:01Z"},"remediated":{"type":"string","description":"Time that the remediation of the damage from the incident was completed.","format":"date-time","example":"2016-01-01T01:01:01Z"},"closed":{"type":"string","description":"Time that the incident was last closed.","format":"date-time","example":"2016-01-01T01:01:01Z"},"rejected":{"type":"string","description":"Time that the incident was first rejected.","format":"date-time","example":"2016-01-01T01:01:01Z"}},"additionalProperties":false,"description":"Relevant time values associated with this Incident.","example":{"opened":"2016-01-01T01:01:01.000Z","discovered":"2016-01-01T01:01:01.000Z","reported":"2016-01-01T01:01:01.000Z","remediated":"2016-01-01T01:01:01.000Z","closed":"2016-01-01T01:01:01.000Z","rejected":"2016-01-01T01:01:01.000Z"},"$$ref":"#/components/schemas/IncidentTime"},"external_references":{"type":"array","description":"Specifies a list of external references which refers to non-CTIM information.\n\nSimilar to `external_ids` field with major differences:\n\n- `external_ids` field is used to store a list of external identifiers that can be used to link entities across different data sources. These identifiers are typically standardized and well-known, such as CVE IDs, US-CERT advisories, or other industry-standard threat intelligence feeds. The `external_ids` field can be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. \n\n- `external_references` field, on the other hand, is used to provide a more general mechanism for linking entities to external sources of information. The `external_references` field can include references to blog posts, articles, external documents, threat intelligence reports, and other sources of information that may not have a standardized format or identifier.","example":[{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"}],"items":{"type":"object","properties":{"source_name":{"type":"string","description":"The source within which the external-reference is defined (system, registry, organization, etc.)","example":"string"},"description":{"type":"string","description":"Markdown string with at most 5000 characters.","example":"string"},"url":{"type":"string","description":"A URL reference to an external resource.","example":"string"},"hashes":{"type":"array","description":"Specifies a dictionary of hashes for the contents of the url.","example":["string"],"items":{"type":"string"}},"external_id":{"type":"string","description":"An identifier for the external reference content.","example":"string"}},"additionalProperties":false,"description":"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.","example":{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"},"$$ref":"#/components/schemas/ExternalReference"}},"discovery_method":{"type":"string","description":"Identifies how the incident was discovered.","example":"Agent Disclosure"},"source_uri":{"type":"string","description":"URI of the source of the intelligence that led to the creation of the entity.","example":"string"},"intended_effect":{"type":"string","description":"Specifies the suspected intended effect of this incident","example":"Account Takeover"},"categories":{"type":"array","description":"A set of categories for this incident.","example":["Attrition"],"items":{"type":"string"}},"status":{"type":"string","description":"The `status` field represents the current state of an incident within the incident management process. Its values help in tracking and reporting the progress of the incident from its discovery to its resolution.","example":"Closed","enum":["New","Closed","Open: Recovered","Closed: Other","Hold: Internal","Hold: Legal","Closed: Under Review","Rejected","Open","Restoration Achieved","Incident Reported","Closed: Suspected","Stalled","Open: Contained","Closed: Near-Miss","Hold: External","Containment Achieved","New: Processing","Closed: Confirmed Threat","Closed: False Positive","Open: Reported","Open: Investigating","Hold","New: Presented"]},"language":{"type":"string","description":"The `language` field is used to specify the primary language of the affected system or the target of an attack. It can be used to provide additional context and information about the entity. The primary purpose of this field is to help analysts filter and prioritize entities based on their knowledge and expertise of different languages.\n\nFor example, if an incident involves an attack on a system in a country where a specific language is predominant, the `language` field can be used to indicate that language, which can help analysts to quickly identify and respond to incidents that may be geographically or culturally relevant. This information can be used to prioritize incidents based on their potential impact. The `language` field can also be used to help with correlation of incidents across different systems and regions, as well as to help with data analysis and reporting.","example":"string"},"id":{"type":"string","description":"Globally unique URI identifying this object.","example":"string"},"promotion_method":{"type":"string","description":"Describes method for promoting an Incident, whether manually or automatically. An Incident may be created manually by a SOAR analyst or SOC operator, or through an automated correlation or aggregation rule or engine that matches a specific set of events or alerts, and promotes them to Incident(s).","example":"Automated","enum":["Automated","Manual"]},"severity":{"type":"string","description":"Represents the potential impact of an incident on an organization's security posture and business operations. It helps organizations prioritize and allocate resources for incident response based on the severity level of the incident \nIt helps analysts and incident handlers prioritize incidents by indicating the level of risk and potential impact associated with the incident. This enables organizations to allocate resources efficiently and address the most critical incidents first.\nCan also be used to generate reports and metrics for measuring the effectiveness of the incident response process and to identify trends and patterns in the threat landscape.\nIt is important to note that the `severity` field is subjective and can be interpreted differently by different organizations or analysts. Therefore, it should be used in conjunction with other intelligence attributes, such as the `confidence` field, to provide a more comprehensive view of the incident.","example":"Critical","enum":["Medium","Info","Unknown","None","High","Critical","Low"]},"tlp":{"type":"string","description":"TLP stands for [Traffic Light Protocol](https://www.us-cert.gov/tlp), which indicates precisely how a resource is intended to be shared, replicated, copied, etc.\n\nIt is used to indicate the sensitivity of the information contained within the message. This allows recipients to determine the appropriate handling and dissemination of the information based on their clearance level and need-to-know.\n\nFor example, an entity containing information about a critical vulnerability in a widely-used software might be marked as `red`, indicating that it should only be shared with a small group of highly trusted individuals who need to know in order to take appropriate action. On the other hand, a message containing more general information about security threats might be marked as `amber` or `green`, indicating that it can be shared more broadly within an organization.","example":"green","enum":["white","green","red","amber"]},"scores":{"type":"object","additionalProperties":{"type":"number","description":"Field is used to indicate the severity or impact of the threat represented by the incident.\nIt's an open-type dictionary object with score types and numeric value of the score.\n\nFor example, systems can have the following score types:\n\n- `asset` - assesses the potential damage or harm that the threat can cause to the affected asset(s). The scale ranges from 0 to 10, with 10 indicating the highest potential harm. \n\n- `global` - assesses the overall impact or significance of the threat to the organization or wider community. The scale ranges from 0 to 1000, with 1000 indicating the highest impact.\n\n- `ttp` - a measure of the threat actor's proficiency in utilizing TTPs. Typically, ranges from 0-100, with a higher score indicating a greater threat or concern.","format":"double","example":10},"description":"Used to indicate the severity or impact score of the threat represented by the incident.","example":{"asset":10},"$$ref":"#/components/schemas/IncidentScores"},"client_id":{"type":"string"},"techniques":{"type":"array","description":"Represents the specific methods or actions used by an attacker to carry out an offensive maneuver or achieve their goals.","example":["string"],"items":{"type":"string"}},"groups":{"type":"array","items":{"type":"string"}},"timestamp":{"type":"string","description":"The time this object was created at, or last modified.","format":"date-time","example":"2016-01-01T01:01:01Z"},"confidence":{"type":"string","description":"Represents the level of certainty or trustworthiness associated with the incident. It denotes the reliability of the intelligence associated with the incident.\nThe `confidence` field can take on several values, including:\n- `info`: Indicates that the incident information is based on sources with no previous track record or there is no track record for the source reporting the incident.\n- `low`: Indicates that the incident information is based on sources with a questionable track record or there is limited information about the accuracy of the source.\n- `medium`: Indicates that the incident information is based on sources with a mixed track record or of uncertain reliability.\n- `high`: Indicates that the incident information is based on sources with a proven track record and high degree of reliability.\nThe `confidence` field can be used to indicate the level of trust and confidence that can be attributed to the incident, and it may impact how the incident is prioritized, analyzed and addressed. It can also help in the decision-making process associated with the incident response activities.\nIt is important to note that the `confidence` field is subjective and can be interpreted differently by different organizations or analysts. As such, it is often used in conjunction with other intelligence attributes, such as the `severity` field, to provide a more complete picture of the incident.","example":"High","enum":["Medium","Info","Unknown","None","High","Low"]},"owner":{"type":"string"},"tactics":{"type":"array","description":"Represents the offensive techniques, approaches, or procedures that an adversary may use to achieve their objectives during an attack. It helps in understanding the intent and capabilities of the adversary and can be used to identify indicators of attack (IoAs) or indicators of compromise (IoCs) that are associated with the adversary's tactics.","example":["string"],"items":{"type":"string"}}},"additionalProperties":{"type":"object"},"$$ref":"#/components/schemas/Incident"}},"application/transit+msgpack":{"schema":{"required":["confidence","id","incident_time","schema_version","status","type"],"type":"object","properties":{"description":{"type":"string","description":"A description of object, which may be detailed.","example":"string"},"assignees":{"type":"array","description":"A set of owners assigned to this incident.","example":["string"],"items":{"type":"string"}},"meta":{"type":"object","additionalProperties":{"type":"object","description":"custom field relevant to attach meta data to.","example":"string","x-oneOf":[{"example":"string","type":"string"},{"example":10,"type":"number","format":"double"},{"example":"2016-01-01T01:01:01.000Z","type":"string","format":"date-time"},{"example":"keyword","type":"string"},{"example":true,"type":"boolean"}]},"description":"metadata associated to the incident.","example":{"keyword":"string"},"$$ref":"#/components/schemas/MetaData"},"schema_version":{"type":"string","description":"CTIM schema version for this entity.","example":"1.3.18"},"revision":{"type":"integer","description":"A monotonically increasing revision, incremented each time the object is changed.","format":"int64","example":10},"type":{"type":"string","example":"incident","enum":["incident"]},"created":{"type":"string","format":"date-time"},"source":{"type":"string","description":"Represents the source of the intelligence that led to the creation of the entity.","example":"string"},"external_ids":{"type":"array","description":"It is used to store a list of external identifiers that can be linked to the incident, providing a reliable and manageable way to correlate and group related events across multiple data sources. It is especially useful in larger organizations that rely on multiple security information and event management (SIEM) systems to detect security incidents. For instance, it can be used to track events across different network sensors, intrusion detection and prevention systems (IDPS), or log management platforms. \n The field can also be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. It can be used to cross-reference with other external tools such as threat intelligence feeds and vulnerability scanners.","example":["string"],"items":{"type":"string"}},"modified":{"type":"string","format":"date-time"},"short_description":{"type":"string","description":"A single line, short summary of the object.","example":"string"},"title":{"type":"string","description":"A short title for this object, used as primary display and reference value.","example":"string"},"incident_time":{"type":"object","properties":{"opened":{"type":"string","description":"Time the incident was first opened.","format":"date-time","example":"2016-01-01T01:01:01Z"},"discovered":{"type":"string","description":"Time the incident was first discovered.","format":"date-time","example":"2016-01-01T01:01:01Z"},"reported":{"type":"string","description":"Time the incident was first reported.","format":"date-time","example":"2016-01-01T01:01:01Z"},"remediated":{"type":"string","description":"Time that the remediation of the damage from the incident was completed.","format":"date-time","example":"2016-01-01T01:01:01Z"},"closed":{"type":"string","description":"Time that the incident was last closed.","format":"date-time","example":"2016-01-01T01:01:01Z"},"rejected":{"type":"string","description":"Time that the incident was first rejected.","format":"date-time","example":"2016-01-01T01:01:01Z"}},"additionalProperties":false,"description":"Relevant time values associated with this Incident.","example":{"opened":"2016-01-01T01:01:01.000Z","discovered":"2016-01-01T01:01:01.000Z","reported":"2016-01-01T01:01:01.000Z","remediated":"2016-01-01T01:01:01.000Z","closed":"2016-01-01T01:01:01.000Z","rejected":"2016-01-01T01:01:01.000Z"},"$$ref":"#/components/schemas/IncidentTime"},"external_references":{"type":"array","description":"Specifies a list of external references which refers to non-CTIM information.\n\nSimilar to `external_ids` field with major differences:\n\n- `external_ids` field is used to store a list of external identifiers that can be used to link entities across different data sources. These identifiers are typically standardized and well-known, such as CVE IDs, US-CERT advisories, or other industry-standard threat intelligence feeds. The `external_ids` field can be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. \n\n- `external_references` field, on the other hand, is used to provide a more general mechanism for linking entities to external sources of information. The `external_references` field can include references to blog posts, articles, external documents, threat intelligence reports, and other sources of information that may not have a standardized format or identifier.","example":[{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"}],"items":{"type":"object","properties":{"source_name":{"type":"string","description":"The source within which the external-reference is defined (system, registry, organization, etc.)","example":"string"},"description":{"type":"string","description":"Markdown string with at most 5000 characters.","example":"string"},"url":{"type":"string","description":"A URL reference to an external resource.","example":"string"},"hashes":{"type":"array","description":"Specifies a dictionary of hashes for the contents of the url.","example":["string"],"items":{"type":"string"}},"external_id":{"type":"string","description":"An identifier for the external reference content.","example":"string"}},"additionalProperties":false,"description":"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.","example":{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"},"$$ref":"#/components/schemas/ExternalReference"}},"discovery_method":{"type":"string","description":"Identifies how the incident was discovered.","example":"Agent Disclosure"},"source_uri":{"type":"string","description":"URI of the source of the intelligence that led to the creation of the entity.","example":"string"},"intended_effect":{"type":"string","description":"Specifies the suspected intended effect of this incident","example":"Account Takeover"},"categories":{"type":"array","description":"A set of categories for this incident.","example":["Attrition"],"items":{"type":"string"}},"status":{"type":"string","description":"The `status` field represents the current state of an incident within the incident management process. Its values help in tracking and reporting the progress of the incident from its discovery to its resolution.","example":"Closed","enum":["New","Closed","Open: Recovered","Closed: Other","Hold: Internal","Hold: Legal","Closed: Under Review","Rejected","Open","Restoration Achieved","Incident Reported","Closed: Suspected","Stalled","Open: Contained","Closed: Near-Miss","Hold: External","Containment Achieved","New: Processing","Closed: Confirmed Threat","Closed: False Positive","Open: Reported","Open: Investigating","Hold","New: Presented"]},"language":{"type":"string","description":"The `language` field is used to specify the primary language of the affected system or the target of an attack. It can be used to provide additional context and information about the entity. The primary purpose of this field is to help analysts filter and prioritize entities based on their knowledge and expertise of different languages.\n\nFor example, if an incident involves an attack on a system in a country where a specific language is predominant, the `language` field can be used to indicate that language, which can help analysts to quickly identify and respond to incidents that may be geographically or culturally relevant. This information can be used to prioritize incidents based on their potential impact. The `language` field can also be used to help with correlation of incidents across different systems and regions, as well as to help with data analysis and reporting.","example":"string"},"id":{"type":"string","description":"Globally unique URI identifying this object.","example":"string"},"promotion_method":{"type":"string","description":"Describes method for promoting an Incident, whether manually or automatically. An Incident may be created manually by a SOAR analyst or SOC operator, or through an automated correlation or aggregation rule or engine that matches a specific set of events or alerts, and promotes them to Incident(s).","example":"Automated","enum":["Automated","Manual"]},"severity":{"type":"string","description":"Represents the potential impact of an incident on an organization's security posture and business operations. It helps organizations prioritize and allocate resources for incident response based on the severity level of the incident \nIt helps analysts and incident handlers prioritize incidents by indicating the level of risk and potential impact associated with the incident. This enables organizations to allocate resources efficiently and address the most critical incidents first.\nCan also be used to generate reports and metrics for measuring the effectiveness of the incident response process and to identify trends and patterns in the threat landscape.\nIt is important to note that the `severity` field is subjective and can be interpreted differently by different organizations or analysts. Therefore, it should be used in conjunction with other intelligence attributes, such as the `confidence` field, to provide a more comprehensive view of the incident.","example":"Critical","enum":["Medium","Info","Unknown","None","High","Critical","Low"]},"tlp":{"type":"string","description":"TLP stands for [Traffic Light Protocol](https://www.us-cert.gov/tlp), which indicates precisely how a resource is intended to be shared, replicated, copied, etc.\n\nIt is used to indicate the sensitivity of the information contained within the message. This allows recipients to determine the appropriate handling and dissemination of the information based on their clearance level and need-to-know.\n\nFor example, an entity containing information about a critical vulnerability in a widely-used software might be marked as `red`, indicating that it should only be shared with a small group of highly trusted individuals who need to know in order to take appropriate action. On the other hand, a message containing more general information about security threats might be marked as `amber` or `green`, indicating that it can be shared more broadly within an organization.","example":"green","enum":["white","green","red","amber"]},"scores":{"type":"object","additionalProperties":{"type":"number","description":"Field is used to indicate the severity or impact of the threat represented by the incident.\nIt's an open-type dictionary object with score types and numeric value of the score.\n\nFor example, systems can have the following score types:\n\n- `asset` - assesses the potential damage or harm that the threat can cause to the affected asset(s). The scale ranges from 0 to 10, with 10 indicating the highest potential harm. \n\n- `global` - assesses the overall impact or significance of the threat to the organization or wider community. The scale ranges from 0 to 1000, with 1000 indicating the highest impact.\n\n- `ttp` - a measure of the threat actor's proficiency in utilizing TTPs. Typically, ranges from 0-100, with a higher score indicating a greater threat or concern.","format":"double","example":10},"description":"Used to indicate the severity or impact score of the threat represented by the incident.","example":{"asset":10},"$$ref":"#/components/schemas/IncidentScores"},"client_id":{"type":"string"},"techniques":{"type":"array","description":"Represents the specific methods or actions used by an attacker to carry out an offensive maneuver or achieve their goals.","example":["string"],"items":{"type":"string"}},"groups":{"type":"array","items":{"type":"string"}},"timestamp":{"type":"string","description":"The time this object was created at, or last modified.","format":"date-time","example":"2016-01-01T01:01:01Z"},"confidence":{"type":"string","description":"Represents the level of certainty or trustworthiness associated with the incident. It denotes the reliability of the intelligence associated with the incident.\nThe `confidence` field can take on several values, including:\n- `info`: Indicates that the incident information is based on sources with no previous track record or there is no track record for the source reporting the incident.\n- `low`: Indicates that the incident information is based on sources with a questionable track record or there is limited information about the accuracy of the source.\n- `medium`: Indicates that the incident information is based on sources with a mixed track record or of uncertain reliability.\n- `high`: Indicates that the incident information is based on sources with a proven track record and high degree of reliability.\nThe `confidence` field can be used to indicate the level of trust and confidence that can be attributed to the incident, and it may impact how the incident is prioritized, analyzed and addressed. It can also help in the decision-making process associated with the incident response activities.\nIt is important to note that the `confidence` field is subjective and can be interpreted differently by different organizations or analysts. As such, it is often used in conjunction with other intelligence attributes, such as the `severity` field, to provide a more complete picture of the incident.","example":"High","enum":["Medium","Info","Unknown","None","High","Low"]},"owner":{"type":"string"},"tactics":{"type":"array","description":"Represents the offensive techniques, approaches, or procedures that an adversary may use to achieve their objectives during an attack. It helps in understanding the intent and capabilities of the adversary and can be used to identify indicators of attack (IoAs) or indicators of compromise (IoCs) that are associated with the adversary's tactics.","example":["string"],"items":{"type":"string"}}},"additionalProperties":{"type":"object"},"$$ref":"#/components/schemas/Incident"}}}}},"x-no-doc":false,"x-codegen-request-body-name":"PatchIncident","security":[{"oAuth2":["integration:read","private-intel:read","profile:read","inspect:read","users:read","invite:read","enrich:read","oauth:read","response:read","global-intel:read","ao:read","playbook:read"]}],"method":"patch","path":"/iroh/private-intel/incident/{incident-id}"}}