Asset - Cisco XDR APIs - Cisco DevNet

{"type":"model","meta":{"id":"/apps/pubhub/media/cisco-xdr-api-docs/fa9197522b1e6452b6dbfc472555dcc7ceeb71bd/2c61df32-bc97-34af-969d-a2ce06b8e459","info":{"title":"CTIA","description":"A Threat Intelligence API service\n\n This API provides a mechanism for making Judgements on the Disposition\n of Observables, which are then distilled into a final Verdict. A\n Disposition is a statement regarding the malicious, or otherwise,\n nature of an Observable.\n\n The Judgements can be grouped into Indicators, which can be associated\n with Campaigns, Actors and TTPs. Feedback can be given on specific\n Judgements, indicating agreement or disagreement, or clarification.\n\n When an Observable with a malicious Verdict is seen, it can be recorded as\n a Sighting, and the Relations that Observable had with other Observables can\n be recorded as well.\n\n We support a pre-defined set of Observable Types. Each Observable Type has a\n specific form of natural identifier, its ID, which is almost always\n the default way it is represented when observed in the wild.\n\n * Ipv4/IPv6 -- 192.168.1.1\n * Domain/Hostname -- foo.com, www.bar.com\n * SHA256 -- the sha256 checksum of a file, or other data blob\n * MD5 -- the md5 checksum of a file, or other data blob\n * SHA1 -- the sha1 checksum of a file, or other data blob\n * URL -- A minimal form of the URL\n\n The Verdict is derived from all of the Judgements on that Observable which\n have not yet expired. The highest priority Judgement becomes the\n active verdict. If there is more than one Judgement with that\n priority, than Clean disposition has priority over all others, then\n Malicious disposition, and so on down to Unknown.\n\n \u003ca href='/doc/README.md'\u003eCTIA Documentation\u003c/a\u003e","contact":{"name":"Cisco Security Business Group -- Advanced Threat ","url":"http://github.com/threatgrid/ctia","email":"cisco-intel-api-support@cisco.com"},"license":{"name":"All Rights Reserved","url":""},"version":"2.24.0"},"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":"Actor","description":"Actor operations"},{"name":"Asset","description":"Asset operations"},{"name":"Asset Mapping","description":"Asset Mapping operations"},{"name":"Asset Properties","description":"Asset Properties operations"},{"name":"Attack Pattern","description":"Attack Pattern operations"},{"name":"Campaign","description":"Campaign operations"},{"name":"Casebook","description":"Casebook operations"},{"name":"COA","description":"COA operations"},{"name":"Event","description":"Events operations"},{"name":"Feed","description":"Feed operations"},{"name":"Incident","description":"Incident operations"},{"name":"Indicator","description":"Indicator operations"},{"name":"Judgement","description":"Judgement operations"},{"name":"Malware","description":"Malware operations"},{"name":"Relationship","description":"Relationship operations"},{"name":"Sighting","description":"Sighting operations"},{"name":"Target Record","description":"Target Record operations"},{"name":"Tool","description":"Tool operations"}],"x-parser-conf":{"serverConfig":"select","overview":{"markdownPath":"reference/private-intel/overview.md","uri":"private-intel-ctia-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://private.intel.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: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":{"type":"object","properties":{"description":{"type":"string","description":"A description of object, which may be detailed.","example":"string"},"asset_type":{"type":"string","description":"Type of the Asset: Device, Person, Application, etc.","example":"application","enum":["device","network","application","person","data"]},"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":"Period of time when a cyber observation is valid.","example":{"start_time":"2016-01-01T01:01:01.000Z","end_time":"2016-01-01T01:01:01.000Z"},"$$ref":"#/components/schemas/ValidTime"},"schema_version":{"type":"string"},"revision":{"type":"integer","description":"A monotonically increasing revision, incremented each time the object is changed.","format":"int64","example":10},"type":{"type":"string","example":"asset","enum":["asset"]},"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"},"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"},"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"]},"timestamp":{"type":"string","description":"The time this object was created at, or last modified.","format":"date-time","example":"2016-01-01T01:01:01Z"}},"additionalProperties":false,"description":"Describes a protected resource. It could be a Device, User, Network, Application or Data.","example":{"description":"string","asset_type":"application","valid_time":{"start_time":"2016-01-01T01:01:01.000Z","end_time":"2016-01-01T01:01:01.000Z"},"schema_version":"1.3.18","revision":10,"type":"asset","source":"string","external_ids":["string"],"short_description":"string","title":"string","external_references":[{"source_name":"string","description":"string","url":"string","hashes":["string"],"external_id":"string"}],"source_uri":"string","language":"string","id":"string","tlp":"green","timestamp":"2016-01-01T01:01:01.000Z"},"$$ref":"#/components/schemas/Asset","title":"Asset"}}