{"type":"model","meta":{"id":"/apps/pubhub/media/cisco-xdr-api-docs/f4e065ff5977829c89df289df08411f83205f526/0aedfab1-f4ca-36de-85d5-679dbd7db871","info":{"title":"IROH-INT Enrich","description":"IROH Integrations: configure and query Threat Response modules","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":"Health","description":"This set of routes allow to check the health of your integrations setup Verify if your modules are setup correctly and if your credentials are correct."},{"name":"Deliberate","description":"This set of routes allow to quickly get answers from your integrations You might use them at the start of any investigation to quickly get answers from your modules if something is bad."},{"name":"Observe","description":"This set of routes allow to get in depth investigation data about a threat You might use them at the start of any investigation to get the full picture and get to know if something has been seen in your environment."},{"name":"Refer","description":"This set of routes allow to get relevant Reference links and quickly pivot pursuing your investigation on a specific product interface. "}],"x-parser-conf":{"serverConfig":"select","overview":{"markdownPath":"reference/enrich/overview.md","uri":"enrich-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","playbook:read":"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":{"required":["count","docs"],"type":"object","properties":{"count":{"type":"number","format":"double"},"docs":{"uniqueItems":true,"type":"array","items":{"required":["id","producer","schema_version","type","valid_time"],"type":"object","properties":{"description":{"type":"string","description":"A description of object, which may be detailed.","example":"string"},"tags":{"type":"array","description":"Descriptors for this indicator.","example":["string"],"items":{"type":"string"}},"valid_time":{"type":"object","properties":{"start_time":{"type":"string","description":"If not present, the valid time position of the indicator does not have an upper bound.","format":"date-time","example":"2016-01-01T01:01:01Z"},"end_time":{"type":"string","description":"If end_time is not present, then the valid time position of the object does not have an upper bound.","format":"date-time","example":"2016-01-01T01:01:01Z"}},"additionalProperties":false,"description":"The time range during which this Indicator is considered valid.","example":{"start_time":"2016-01-01T01:01:01.000Z","end_time":"2016-01-01T01:01:01.000Z"},"$$ref":"#/components/schemas/ValidTime"},"producer":{"type":"string","description":"String with at most 1024 characters.","example":"string"},"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","description":"The fixed value indicator","example":"indicator","enum":["indicator"]},"created":{"type":"string","format":"date-time"},"test_mechanisms":{"type":"array","description":"Test Mechanisms effective at identifying the cyber Observables specified in this cyber threat Indicator.","example":["string"],"items":{"type":"string"}},"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"},"composite_indicator_expression":{"required":["indicator_ids","operator"],"type":"object","properties":{"operator":{"type":"string","example":"and","enum":["not","or","and"]},"indicator_ids":{"type":"array","example":["string"],"items":{"type":"string"}}},"additionalProperties":false,"example":{"operator":"and","indicator_ids":["string"]},"$$ref":"#/components/schemas/CompositeIndicatorExpression"},"title":{"type":"string","description":"A short title for this object, used as primary display and reference value.","example":"string"},"likely_impact":{"type":"string","description":"Likely potential impact within the relevant context if this Indicator were to occur.","example":"string"},"indicator_type":{"type":"array","description":"Specifies the type or types for this Indicator.","example":["Anonymization"],"items":{"type":"string","enum":["File Hash Watchlist","Private Threat Feed","IMEI Watchlist","Malicious E-mail","Exfiltration","C2","URL Watchlist","IMSI Watchlist","Malware Artifacts","Domain Watchlist","Anonymization","Host Characteristics","IP Watchlist","Compromised PKI Certificate","Login Name"]}},"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":{"required":["source_name"],"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"}},"source_uri":{"type":"string","description":"URI of the source of the intelligence that led to the creation of the entity.","example":"string"},"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"},"severity":{"type":"string","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"]},"kill_chain_phases":{"type":"array","description":"Relevant kill chain phases indicated by this Indicator.","example":[{"kill_chain_name":"string","phase_name":"string"}],"items":{"required":["kill_chain_name","phase_name"],"type":"object","properties":{"kill_chain_name":{"type":"string","description":"The name of the kill chain.","example":"string"},"phase_name":{"type":"string","description":"The name of the phase in the kill chain.","example":"string"}},"additionalProperties":false,"description":"The kill-chain-phase represents a phase in a kill chain, which describes the various phases an attacker may undertake in order to achieve their objectives.","example":{"kill_chain_name":"string","phase_name":"string"},"$$ref":"#/components/schemas/KillChainPhase"}},"client_id":{"type":"string"},"negate":{"type":"boolean","description":"Specifies the absence of the pattern.","example":true},"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":"level of confidence held in the accuracy of this Indicator.","example":"High","enum":["Medium","Info","Unknown","None","High","Low"]},"specification":{"type":"object","example":{},"x-oneOf":[{"required":["judgements","required_judgements","type"],"type":"object","properties":{"type":{"type":"string","example":"Judgement","enum":["Judgement"]},"judgements":{"type":"array","example":["string"],"items":{"type":"string"}},"required_judgements":{"type":"array","example":[{"confidence":"High","source":"string","relationship":"string","judgement_id":"string"}],"items":{"required":["judgement_id"],"type":"object","properties":{"confidence":{"type":"string","example":"High","enum":["Medium","Info","Unknown","None","High","Low"]},"source":{"type":"string","example":"string"},"relationship":{"type":"string","example":"string"},"judgement_id":{"type":"string","description":"A URI leading to a judgement.","example":"string"}},"additionalProperties":false,"example":{"confidence":"High","source":"string","relationship":"string","judgement_id":"string"},"$$ref":"#/components/schemas/RelatedJudgement"}}},"additionalProperties":false,"description":"An indicator based on a list of judgements. If any of the Observables in it's judgements are encountered, than it may be matches against. If there are any required judgements, they all must be matched in order for the indicator to be considered a match.","example":{"type":"Judgement","judgements":["string"],"required_judgements":[{"confidence":"High","source":"string","relationship":"string","judgement_id":"string"}]},"$$ref":"#/components/schemas/JudgementSpecification"},{"required":["type","variables"],"type":"object","properties":{"type":{"type":"string","example":"ThreatBrain","enum":["ThreatBrain"]},"query":{"type":"string","example":"string"},"variables":{"type":"array","example":["string"],"items":{"type":"string"}}},"additionalProperties":false,"description":"An indicator which runs in threatbrain...","example":{"type":"ThreatBrain","query":"string","variables":["string"]},"$$ref":"#/components/schemas/ThreatBrainSpecification"},{"required":["snort_sig","type"],"type":"object","properties":{"type":{"type":"string","example":"Snort","enum":["Snort"]},"snort_sig":{"type":"string","example":"string"}},"additionalProperties":false,"description":"An indicator which runs in snort...","example":{"type":"Snort","snort_sig":"string"},"$$ref":"#/components/schemas/SnortSpecification"},{"required":["SIOC","type"],"type":"object","properties":{"type":{"type":"string","example":"SIOC","enum":["SIOC"]},"SIOC":{"type":"string","example":"string"}},"additionalProperties":false,"description":"An indicator which runs in snort...","example":{"type":"SIOC","SIOC":"string"},"$$ref":"#/components/schemas/SIOCSpecification"},{"required":["open_IOC","type"],"type":"object","properties":{"type":{"type":"string","example":"OpenIOC","enum":["OpenIOC"]},"open_IOC":{"type":"string","example":"string"}},"additionalProperties":false,"description":"An indicator which contains an XML blob of an openIOC indicator.","example":{"type":"OpenIOC","open_IOC":"string"},"$$ref":"#/components/schemas/OpenIOCSpecification"}]}},"additionalProperties":false,"$$ref":"#/components/schemas/Indicator"}}},"additionalProperties":false,"title":"ObserveEnvelopedObserveBundleDataDataIndicators"}}