{"components":{"parameters":{"AttributesParameter":{"description":"Comma-separated list of attributes to be returned. Nested attributes are separated by dots - e.g. `data.title`","example":["field_1","field_2"],"explode":false,"in":"query","name":"attributes","required":false,"schema":{"type":"string"}},"CursorParameter":{"description":"\nThe page[cursor] parameter is used to retrieve the next page of resources with a few\nadvantages compare to offset strategy:\n\n1. Faster to run as the already returned resources are skipped\n2. The guarantee that a previous resource will not be returned again\n3. The capacity to fetch all the results without a depth limit imposed by the system\n\nUsing page[cursor] requires multiple requests with the same query and sort values. The\nfirst step is to run an initial request without any cursor value. For each request, the\ncursor value to use for the next page is returned as part of the response body.\n","example":"WyIyMDI0LTAxLTIyVDIwOjI4OjQxLjIxNTk0NiswMDowMCJdCg==","in":"query","name":"page[cursor]","required":false,"schema":{"type":"string"}},"DataParameter":{"description":"Set this parameter to false if you want to only retrieve the number of objects matching the query","in":"query","name":"data","required":false,"schema":{"type":"boolean"}},"FilterAttackNodeTypeParameter":{"description":"Filter by type: `matrix`, `subtechnique`, `tactic`, `technique`","in":"query","name":"filter[type]","required":false,"schema":{"type":"string"}},"FilterDefenseInnerRelTypeParameter":{"description":"Filter by type: `analytic-references`, `log-source-references`","in":"query","name":"filter[type]","required":false,"schema":{"type":"string"}},"FilterDefenseRelTypeParameter":{"description":"Filter by type: `detects`, `mitigates`","in":"query","name":"filter[type]","required":false,"schema":{"type":"string"}},"FilterDefenseTypeParameter":{"description":"Filter by type: `analytic`, `data-component`, `detection-strategy`, `mitigation`","in":"query","name":"filter[type]","required":false,"schema":{"type":"string"}},"FilterDomainParameter":{"description":"Filter by domain: `DISARM`, `enterprise-attack`, `ics-attack`, `mobile-attack`","in":"query","name":"filter[domains]","required":false,"schema":{"type":"string"}},"FilterMatrixParameter":{"description":"Filter by matrix: `DISARM`, `enterprise-attack`, `ics-attack`, `mobile-attack`","in":"query","name":"filter[matrix]","required":false,"schema":{"type":"string"}},"LimitParameter":{"description":"Maximum number of items to be returned","in":"query","name":"limit","required":false,"schema":{"format":"int32","minimum":1,"type":"integer"}},"ObjectIDParameter":{"description":"Main object ID.<br>Pattern \"[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}|[0-9]+|TA[0-9]+:T[0-9]+(.[0-9]+)?\"","in":"path","name":"object_id","required":true,"schema":{"pattern":"[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}|[0-9]+|TA[0-9]+:T[0-9]+(.[0-9]+)?","type":"string"}},"ObjectTypeParameter":{"description":"Main object type.<br>Pattern \"[a-zA-Z_-]+\"","in":"path","name":"object_type","required":true,"schema":{"enum":["entities","entity_rules","groups","knowledge-packs","observables","outgoing-feeds","roles","taxonomies","tickets","users","workspaces"],"pattern":"[a-zA-Z_-]+","type":"string"}},"OffsetParameter":{"description":"Return results starting from the specified (zero-based) index","in":"query","name":"offset","required":false,"schema":{"format":"int32","minimum":0,"type":"integer"}},"RelationIDParameter":{"description":"Related object ID.<br>Pattern \"[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}|[0-9]+|TA[0-9]+:T[0-9]+(.[0-9]+)?\"","in":"path","name":"relation_id","required":true,"schema":{"pattern":"[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}|[0-9]+|TA[0-9]+:T[0-9]+(.[0-9]+)?","type":"string"}},"RelationTypeParameter":{"description":"Related object type. These are valid values for specific object types: <br>entities: taxonomies, attacks, datasets, observables, attachments <br>outgoing-feeds: whitelist_sources, datasets, whitelist_taxonomy_nodes <br>groups: sources, users <br>knowledge-packs: datasets, incoming_feeds, workspaces <br>observables: entities <br>roles: permissions, users <br>taxonomies: children <br>tickets: entities, stakeholders, workspaces <br>users: groups, roles <br>workspaces: datasets, entities, discovery_tasks, files, tickets, collaborators, groups <br>entity_rules: taxonomies, datasets<br>Pattern [a-zA-Z_-]+","in":"path","name":"relation_type","required":true,"schema":{"pattern":"[a-zA-Z_-]+","type":"string"}},"SortParameter":{"description":"Comma-separated list of fields to sort on. Prefix a field with the minus \"-\" sign if you intend to apply descending sorting to it","example":["field_1","-field_2"],"explode":false,"in":"query","name":"sort","required":false,"schema":{"type":"string"}},"TotalResourcesAggregatedParameter":{"description":"Define the approximation count of resources that have been aggregated. By default, the count is capped at `10'000`. `0` can be usedto have the exact count.","in":"query","name":"meta[total_resources_aggregated]","required":false,"schema":{"type":"integer"}}},"responses":{"BadRequest":{"content":{"application/json":{"schema":{"items":{"properties":{"detail":{"example":"Bad Request","type":"string"},"status":{"enum":[400],"type":"integer"},"title":{"example":"Bad Request","type":"string"}},"type":"object"},"type":"array"}}},"description":"Invalid request"},"Conflict":{"content":{"application/json":{"schema":{"items":{"properties":{"detail":{"example":"Conflict","type":"string"},"status":{"enum":[409],"type":"integer"},"title":{"example":"Conflict","type":"string"}},"type":"object"},"type":"array"}}},"description":"The element already exists"},"ExpectationFailed":{"content":{"application/json":{"schema":{"items":{"properties":{"detail":{"example":"Expectation failed","type":"string"},"status":{"enum":[417],"type":"integer"},"title":{"example":"Expectation Failed","type":"string"}},"type":"object"},"type":"array"}}},"description":"Expectation failed"},"Forbidden":{"content":{"application/json":{"schema":{"items":{"properties":{"detail":{"example":"Missing permissions: [modify <permission>]","type":"string"},"status":{"enum":[403],"type":"integer"},"title":{"example":"Forbidden","type":"string"}},"type":"object"},"type":"array"}}},"description":"Missing permissions"},"Gone":{"content":{"application/json":{"schema":{"items":{"properties":{"detail":{"example":"Gone","type":"string"},"status":{"enum":[410],"type":"integer"},"title":{"example":"Gone","type":"string"}},"type":"object"},"type":"array"}}},"description":"Requested resource no longer exists"},"NotFound":{"content":{"application/json":{"schema":{"items":{"properties":{"detail":{"example":"The resource '<id>' does not exist.","type":"string"},"status":{"enum":[404],"type":"integer"},"title":{"example":"Not Found","type":"string"}},"type":"object"},"type":"array"}}},"description":"An individual resource was not found."},"Unauthorized":{"content":{"application/json":{"schema":{"items":{"properties":{"detail":{"example":"Unauthorized","type":"string"},"status":{"enum":[401],"type":"integer"},"title":{"example":"Unauthorized","type":"string"}},"type":"object"},"type":"array"}}},"description":"Unauthorized request"},"UnprocessableEntity":{"content":{"application/json":{"schema":{"items":{"properties":{"detail":{"example":"Unprocessable Entity","type":"string"},"status":{"enum":[422],"type":"integer"},"title":{"example":"Unprocessable Entity","type":"string"}},"type":"object"},"type":"array"}}},"description":"Tighten your filters"}},"schemas":{"AIConfigurationSchema":{"properties":{"data":{"description":"This object will be validated with a schema selected based on the value of the \"type\" property.","discriminator":{"mapping":{"ai-features":"#/components/schemas/ApiAiFeaturesConfigSchema","ai-provider-ollama":"#/components/schemas/ApiAiProviderOllamaConfigSchema","ai-provider-openai":"#/components/schemas/ApiAiProviderOpenaiConfigSchema","ai-provider-openai-like":"#/components/schemas/ApiAiProviderOpenaiLikeConfigSchema","ai-provider-perplexity":"#/components/schemas/ApiAiProviderPerplexityConfigSchema"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ApiAiFeaturesConfigSchema"},{"$ref":"#/components/schemas/ApiAiProviderOpenaiLikeConfigSchema"},{"$ref":"#/components/schemas/ApiAiProviderOllamaConfigSchema"},{"$ref":"#/components/schemas/ApiAiProviderOpenaiConfigSchema"},{"$ref":"#/components/schemas/ApiAiProviderPerplexityConfigSchema"}],"properties":{"type":{"enum":["ai-features","ai-provider-openai-like","ai-provider-ollama","ai-provider-openai","ai-provider-perplexity"],"type":"string"}},"required":["type"],"type":"object"}},"required":["data"],"type":"object"},"AIEntityExtractionRequestSchema":{"properties":{"entity_id":{"nullable":true,"type":"string"},"model":{"nullable":true,"type":"string"},"provider":{"enum":["ai-provider-openai","ai-provider-perplexity","ai-provider-ollama","ai-provider-openai-like",null],"nullable":true,"type":"string"},"refresh":{"default":false,"type":"boolean"},"text":{"additionalProperties":{"type":"string"},"type":"object"}},"required":["text"],"type":"object"},"ActionSchema":{"properties":{"add_tags":{"description":"List of tags that should be added to the matched entities if `add_tags` is included in the list of actions","items":{"type":"string"},"type":"array"},"add_taxonomies":{"description":"List of taxonomies that should be added to the matched entities if `add_tags` is included in the list of actions","example":["http://localhost/api/v2/taxonomies/1"],"items":{"description":"Taxonomy ID, URL or path expressed as a lists of strings","example":"http://localhost/api/v2/taxonomies/1"},"type":"array"},"add_to_datasets":{"description":"List of the static datasets that matching intelligence should be added to","example":["http://localhost/api/v2/datasets/1"],"items":{"description":"Dataset ID/URL","example":"http://localhost/api/v2/datasets/1"},"type":"array"},"remove_tags":{"description":"List of tags that should be removed from the matched entities if `remove_tags` is included in the list of actions","items":{"type":"string"},"type":"array"},"remove_taxonomies":{"description":"List of taxonomies that should be removed from the matched entities if `remove_tags` is included in the list of actions","example":["http://localhost/api/v2/taxonomies/1"],"items":{"description":"Taxonomy ID, URL or path expressed as a lists of strings","example":"http://localhost/api/v2/taxonomies/1"},"type":"array"}},"type":"object"},"AffectedAssetsSchema":{"properties":{"asset_type":{"enum":["ATM","Access reader","Administrator","Auditor","Auth token","Backup","Broadband","Call center","Camera","Cashier","Customer","DCS","DHCP","DNS","Database","Desktop","Developer","Directory","Disk drive","Disk media","Documents","End-user","Executive","File","Finance","Firewall","Flash drive","Former employee","Gas terminal","Guard","HSM","Helpdesk","Human resources","IDS","Kiosk","LAN","Laptop","Log","Mail","Mainframe","Maintenance","Manager","Media","Mobile phone","Network","PBX","PED pad","PLC","POS controller","POS terminal","Partner","Payment card","Payment switch","Peripheral","Person","Print","Private WAN","Proxy","Public WAN","RTU","Remote access","Router or switch","SAN","SCADA","Server","Smart card","Tablet","Tapes","Telephone","Unknown","User Device","VoIP adapter","VoIP phone","WLAN","Web application"],"type":"string"},"business_function_or_role":{"type":"string"},"description":{"minLength":1,"type":"string"},"location_class":{"enum":["Co-Located","Externally-Located","Internally-Located","Mobile","Unknown"],"type":"string"},"management_class":{"enum":["Co-Management","Externally-Management","Internally-Managed","Unknown"],"type":"string"},"nature_of_security_effect_properties_affected":{"items":{"$ref":"#/components/schemas/PropertiesAffectedSchema"},"type":"array"},"ownership_class":{"enum":["Customer-Owned","Employee-Owned","Internally-Owned","Partner-Owned","Unknown"],"type":"string"},"type":{"default":"affected-asset","description":"Constant field, must have a value of \"affected-asset\"","type":"string"}},"required":["asset_type","description","location_class","management_class","ownership_class"],"type":"object"},"Aggregation":{"properties":{"key":{"description":"The name of the field used to group-by."},"values":{"items":{"items":{},"maxItems":2,"minItems":2,"type":"array"},"minItems":1,"type":"array"}},"type":"object"},"AggregationsResponse":{"properties":{"aggregations":{"description":"Each grouped by field is represented by a different object.","items":{"$ref":"#/components/schemas/Aggregation"},"minItems":1,"type":"array"}},"type":"object"},"AggregationsWithMappingResponse":{"properties":{"aggregations":{"description":"Each grouped by field is represented by a different object.","items":{"$ref":"#/components/schemas/Aggregation"},"minItems":1,"type":"array"},"group_by_value_mappings":{"additionalProperties":{"additionalProperties":{"description":"The mapped value","type":"string"},"description":"Only set if the mapping for a group is requested, keys are original values.","type":"object"},"description":"The keys are group names or '_single' when anonymous","type":"object"},"split_by_value_mapping":{"additionalProperties":{"description":"The mapped value","type":"string"},"description":"Only set if the mapping for split-by is requested, keys are original values.","nullable":true,"type":"object"}},"type":"object"},"AiFeatureItemSchema":{"properties":{"is_provider_configured":{"readOnly":true,"type":"boolean"},"model":{"nullable":true,"type":"string"},"provider":{"enum":["ai-provider-openai","ai-provider-perplexity","ai-provider-ollama","ai-provider-openai-like",null],"nullable":true,"type":"string"},"rag_state":{"description":"Only present for AI features using a RAG index.","enum":["success","error","indexing","not-configured"],"readOnly":true,"type":"string"}},"required":["model","provider"],"type":"object"},"AiProviderFeatureAvailabilitySchema":{"properties":{"settings":{"additionalProperties":{"items":{"enum":["ai_assistant","ai_content_generation","ai_entity_extraction","ai_intel_summary","ai_translation","ai_web_enrichment","ai_writing_assistant","ai_contextual_relevancy","nlp_to_search"],"type":"string"},"type":"array"},"description":"Mapping of an AI provider to a list of features it supports.","type":"object"},"type":{"type":"string"}},"required":["type"],"type":"object"},"AllowedObservableStateAPISchema":{"properties":{"classification":{"enum":["good","bad","unknown"],"type":"string"},"confidence":{"enum":["low","medium","high"],"type":"string"}},"type":"object"},"AnalyticMutableElement":{"properties":{"description":{"type":"string"},"field":{"type":"string"}},"type":"object"},"AnonimizeReplaceActionSchema":{"properties":{"path":{"type":"string"},"pattern":{"type":"string"},"value":{"type":"string"}},"required":["path","pattern","value"],"type":"object"},"ApiAccountPolicySchema":{"properties":{"account_policy_enabled":{},"last_updated_at":{"format":"date-time","readOnly":true,"type":"string"},"lockout_attempts":{"default":5,"maximum":1000,"minimum":0,"type":"integer"},"password_min_length":{"default":10,"maximum":64,"minimum":8,"type":"integer"},"password_requires_capital_letters":{"default":true,"type":"boolean"},"password_requires_numbers":{"default":true,"type":"boolean"},"password_requires_special_chars":{"default":true,"type":"boolean"},"password_reset_link_expiry_in_seconds":{"default":604800,"maximum":31536000,"minimum":3600,"type":"integer"},"two_factor_authn_enforced":{"type":"boolean"},"two_factor_suspension_min":{"maximum":525600,"minimum":0,"type":"integer"},"type":{"type":"string"}},"required":["type"],"type":"object"},"ApiAiFeaturesConfigSchema":{"properties":{"ai_assistant":{"$ref":"#/components/schemas/AiFeatureItemSchema"},"ai_content_generation":{"$ref":"#/components/schemas/AiFeatureItemSchema"},"ai_contextual_relevancy":{"$ref":"#/components/schemas/AiFeatureItemSchema"},"ai_entity_extraction":{"$ref":"#/components/schemas/AiFeatureItemSchema"},"ai_intel_summary":{"$ref":"#/components/schemas/AiFeatureItemSchema"},"ai_translation":{"$ref":"#/components/schemas/AiFeatureItemSchema"},"ai_web_enrichment":{"$ref":"#/components/schemas/AiFeatureItemSchema"},"ai_writing_assistant":{"$ref":"#/components/schemas/AiFeatureItemSchema"},"last_updated_at":{"format":"date-time","readOnly":true,"type":"string"},"nlp_to_search":{"$ref":"#/components/schemas/AiFeatureItemSchema"},"type":{"type":"string"}},"required":["type"],"type":"object"},"ApiAiProviderOllamaConfigSchema":{"properties":{"api_key":{"description":"If set, the key is put in the `Authorization` header like `Bearer {api_key}`.\n\n\nThe field is only capable to modify the value, not to read\nthe original one for security reason.\n\nThe field use a pass-through token: `this_is_not_a_password_a1d83358-25d4-438f-a33d-b956df0d548d`. When the field receives such\nvalue, it is not updated but the validation won't complain that it is missing. If a\ndifferent value is provided, it would become the new secret value.\n\nThat same pass-through token is always returned to comply with the schema but without\nleaking the secret.\n","type":"string"},"base_url":{"type":"string"},"basic_auth":{"description":"The 1st entry is the username and the 2nd the password.","items":{"type":"string"},"maxItems":2,"minItems":2,"readOnly":true,"type":"array"},"ca_path":{"description":"A path to a custom CA to use to verify the SSL connection.","readOnly":true,"type":"string"},"enabled":{"default":false,"type":"boolean"},"error_detail":{"readOnly":true,"type":"string"},"features_count":{"readOnly":true,"type":"integer"},"integration_status":{"enum":["success","error","no key","not configured"],"readOnly":true,"type":"string"},"last_updated_at":{"format":"date-time","readOnly":true,"type":"string"},"models":{"items":{"$ref":"#/components/schemas/ModelSchema"},"readOnly":true,"type":"array"},"proxy":{"readOnly":true,"type":"string"},"read_only":{"description":"When set to `False`, the parameters can be changed from the API\nendpoint. If `True`, the parameters are set through the backend internal settings. In\nthat case, the API response is showing the values but it is not possible to modify them.\nFor changes, it must be done at the internal settings level.","readOnly":true,"type":"boolean"},"type":{"type":"string"},"verify_ssl":{"description":"When not defined, the default is to always verify the SSL connection.","readOnly":true,"type":"boolean"}},"required":["base_url","read_only","type"],"type":"object"},"ApiAiProviderOpenaiConfigSchema":{"properties":{"api_key":{"default":"this_is_not_a_password_a1d83358-25d4-438f-a33d-b956df0d548d","description":"\nThe field is only capable to modify the value, not to read\nthe original one for security reason.\n\nThe field use a pass-through token: `this_is_not_a_password_a1d83358-25d4-438f-a33d-b956df0d548d`. When the field receives such\nvalue, it is not updated but the validation won't complain that it is missing. If a\ndifferent value is provided, it would become the new secret value.\n\nThat same pass-through token is always returned to comply with the schema but without\nleaking the secret.\n","nullable":true,"type":"string"},"base_url":{"default":null,"nullable":true,"type":"string"},"enabled":{"default":false,"type":"boolean"},"error_detail":{"readOnly":true,"type":"string"},"features_count":{"readOnly":true,"type":"integer"},"integration_status":{"enum":["success","error","no key","not configured"],"readOnly":true,"type":"string"},"last_updated_at":{"format":"date-time","readOnly":true,"type":"string"},"models":{"items":{"$ref":"#/components/schemas/ModelSchema"},"readOnly":true,"type":"array"},"type":{"type":"string"}},"required":["type"],"type":"object"},"ApiAiProviderOpenaiLikeConfigSchema":{"properties":{"api_key":{"default":"this_is_not_a_password_a1d83358-25d4-438f-a33d-b956df0d548d","description":"\nThe field is only capable to modify the value, not to read\nthe original one for security reason.\n\nThe field use a pass-through token: `this_is_not_a_password_a1d83358-25d4-438f-a33d-b956df0d548d`. When the field receives such\nvalue, it is not updated but the validation won't complain that it is missing. If a\ndifferent value is provided, it would become the new secret value.\n\nThat same pass-through token is always returned to comply with the schema but without\nleaking the secret.\n","type":"string"},"base_url":{"type":"string"},"embedding_models":{"items":{"$ref":"#/components/schemas/ModelSchema"},"readOnly":true,"type":"array"},"enabled":{"default":false,"type":"boolean"},"error_detail":{"readOnly":true,"type":"string"},"features_count":{"readOnly":true,"type":"integer"},"integration_status":{"enum":["success","error","no key","not configured"],"readOnly":true,"type":"string"},"last_updated_at":{"format":"date-time","readOnly":true,"type":"string"},"models":{"items":{"$ref":"#/components/schemas/ModelSchema"},"readOnly":true,"type":"array"},"selected_embedding_model":{"default":null,"description":"Selected embedding model for a provider.","nullable":true,"type":"string"},"type":{"type":"string"}},"required":["base_url","type"],"type":"object"},"ApiAiProviderPerplexityConfigSchema":{"properties":{"api_key":{"default":"this_is_not_a_password_a1d83358-25d4-438f-a33d-b956df0d548d","description":"\nThe field is only capable to modify the value, not to read\nthe original one for security reason.\n\nThe field use a pass-through token: `this_is_not_a_password_a1d83358-25d4-438f-a33d-b956df0d548d`. When the field receives such\nvalue, it is not updated but the validation won't complain that it is missing. If a\ndifferent value is provided, it would become the new secret value.\n\nThat same pass-through token is always returned to comply with the schema but without\nleaking the secret.\n","nullable":true,"type":"string"},"base_url":{"default":null,"nullable":true,"type":"string"},"enabled":{"default":false,"type":"boolean"},"error_detail":{"readOnly":true,"type":"string"},"features_count":{"readOnly":true,"type":"integer"},"integration_status":{"enum":["success","error","no key","not configured"],"readOnly":true,"type":"string"},"last_updated_at":{"format":"date-time","readOnly":true,"type":"string"},"models":{"items":{"$ref":"#/components/schemas/ModelSchema"},"readOnly":true,"type":"array"},"type":{"type":"string"}},"required":["type"],"type":"object"},"ApiConfigurationBundlesProducerConfigSchema":{"properties":{"api_url":{"nullable":true,"readOnly":true,"type":"string"},"last_updated_at":{"format":"date-time","readOnly":true,"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"required":["name","type"],"type":"object"},"ApiEmailSchema":{"properties":{"from_email":{"type":"string"},"last_updated_at":{"format":"date-time","readOnly":true,"type":"string"},"reply_to":{"type":"string"},"type":{"type":"string"}},"required":["from_email","reply_to","type"],"type":"object"},"ApiIntelReportSchema":{"properties":{"contact":{"type":"string"},"last_updated_at":{"format":"date-time","readOnly":true,"type":"string"},"logo_url":{"format":"url","type":"string"},"terms":{"type":"string"},"type":{"type":"string"}},"required":["type"],"type":"object"},"ApiLicenseSchema":{"properties":{"last_updated_at":{"format":"date-time","readOnly":true,"type":"string"},"license_key":{"type":"string"},"type":{"type":"string"}},"required":["type"],"type":"object"},"ApiPrivateKeySchema":{"properties":{"fingerprint":{"readOnly":true,"type":"string"},"key":{"default":null,"nullable":true,"type":"string"},"keyid":{"readOnly":true,"type":"string"},"last_updated_at":{"format":"date-time","readOnly":true,"type":"string"},"type":{"type":"string"}},"required":["type"],"type":"object"},"ApiPublicKeysSchema":{"properties":{"keys":{"items":{"$ref":"#/components/schemas/PublicKeyDetailsSchema"},"type":"array"},"last_updated_at":{"format":"date-time","readOnly":true,"type":"string"},"type":{"type":"string"}},"required":["type"],"type":"object"},"ApiServerSchema":{"properties":{"ai_providers_usage_consented":{"default":false,"type":"boolean"},"feature_flags":{"$ref":"#/components/schemas/FeatureFlagSchema"},"jwt_expiration_delta":{"maximum":1324512000,"minimum":60,"type":"integer"},"last_updated_at":{"format":"date-time","readOnly":true,"type":"string"},"organization_logo":{"type":"string"},"organization_name":{"type":"string"},"server_name":{"type":"string"},"session_inactivity_timeout":{"maximum":86400,"minimum":60,"type":"integer"},"taxii_server_name":{"type":"string"},"timezone":{"description":"A timezone identifier.","example":"Europe/Amsterdam","type":"string"},"tlp_amber_strict_downgrade":{"default":"RED","enum":["RED","AMBER"],"type":"string"},"type":{"type":"string"},"ui_theme":{"default":"user","enum":["user","teal","lavender","dutch-blue","ruby-red"],"type":"string"}},"required":["server_name","timezone","type"],"type":"object"},"ApiStixSchema":{"properties":{"alias":{"type":"string"},"last_updated_at":{"format":"date-time","readOnly":true,"type":"string"},"namespace":{"format":"url","type":"string"},"producer":{"type":"string"},"type":{"type":"string"}},"required":["type"],"type":"object"},"ApplicabilityConfidenceSchema":{"properties":{"type":{"default":"confidence","description":"Constant field, must have a value of \"confidence\"","type":"string"},"value":{"enum":["High","Low","Medium","None","Unknown"],"type":"string"}},"type":"object"},"AttackAnalysisAPISchema":{"properties":{"attack_matrix":{"description":"MITRE ATT&CK ID/URL","example":"http://localhost/api/v2/attacks/TA0001:T1078.001"},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"description":{"default":"","type":"string"},"id":{"type":"integer"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"last_updated_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"name":{"type":"string"},"scope_datasets":{"description":"[Collection of] Dataset ID/URL","example":["http://localhost/api/v2/datasets/1"],"items":{"description":"Dataset ID/URL","example":"http://localhost/api/v2/datasets/1"},"maxItems":1,"minItems":0,"type":"array"},"scope_entities":{"description":"[Collection of] Entity ID/URL","example":["http://localhost/api/v2/entities/6bae2237-eda8-4a3c-b734-e9dd3b4fa756"],"items":{"description":"Entity ID/URL","example":"http://localhost/api/v2/entities/6bae2237-eda8-4a3c-b734-e9dd3b4fa756"},"maxItems":1000,"minItems":0,"type":"array"},"ui_metadata":{"description":"The parameters to configure the user interface.","type":"object"}},"required":["name"],"type":"object"},"AttackAnalysisAnnotationAPISchema":{"properties":{"attack_analysis":{"description":"ATT&CK Analysis ID/URL","example":"http://localhost/api/v2/attack_analyses/10"},"attack_node":{"description":"MITRE ATT&CK ID/URL","example":"http://localhost/api/v2/attacks/TA0001:T1078.001"},"content":{"type":"string"},"id":{"type":"integer"}},"required":["attack_analysis","attack_node","content"],"type":"object"},"AttackDefenseAPISchema":{"properties":{"description":{"type":"string"},"domains":{"items":{"enum":["mobile-attack","enterprise-attack","ics-attack","DISARM"],"type":"string"},"readOnly":true,"type":"array"},"external_references":{"items":{"$ref":"#/components/schemas/AttackReferenceSchema"},"readOnly":true,"type":"array"},"id":{"type":"string"},"mitre_platforms":{"description":"The field is only present for `analytic` type objects.","items":{"type":"string"},"readOnly":true,"type":"array"},"mutable_elements":{"description":"The field is only present for `analytic` type objects.","items":{"$ref":"#/components/schemas/AnalyticMutableElement"},"readOnly":true,"type":"array"},"name":{"type":"string"},"related_defenses":{"description":"The ATTACK defense objects that are linked by a defense object","example":["http://localhost/api/v2/attack-defenses/DS0026"],"items":{"description":"MITRE ATT&CK Defense ID/URL","example":"http://localhost/api/v2/attack-defenses/DS0026"},"type":"array"},"related_techniques":{"description":"[Collection of] MITRE ATT&CK ID/URL","example":["http://localhost/api/v2/attacks/TA0001:T1078.001"],"items":{"description":"MITRE ATT&CK ID/URL","example":"http://localhost/api/v2/attacks/TA0001:T1078.001","writeOnly":true},"type":"array","writeOnly":true},"source_defenses":{"description":"The ATTACK defense objects that definea link to a defense object","example":["http://localhost/api/v2/attack-defenses/DS0026"],"items":{"description":"MITRE ATT&CK Defense ID/URL","example":"http://localhost/api/v2/attack-defenses/DS0026","writeOnly":true},"type":"array","writeOnly":true},"type":{"enum":["analytic","data-component","detection-strategy","mitigation"],"type":"string"}},"required":["name","type"],"type":"object"},"AttackDefenseInnerRelationshipAPISchema":{"properties":{"channel":{"description":"The field is only present for `log-source-references` type objects.","type":"string"},"from_defense":{"description":"MITRE ATT&CK Defense ID/URL","example":"http://localhost/api/v2/attack-defenses/DS0026"},"id":{"type":"string"},"name":{"description":"The field is only present for `log-source-references` type objects.","type":"string"},"to_defense":{"description":"MITRE ATT&CK Defense ID/URL","example":"http://localhost/api/v2/attack-defenses/DS0026"},"type":{"enum":["analytic-references","log-source-references"],"type":"string"}},"required":["from_defense","to_defense","type"],"type":"object"},"AttackDefenseRelationshipAPISchema":{"properties":{"defense":{"description":"MITRE ATT&CK Defense ID/URL","example":"http://localhost/api/v2/attack-defenses/DS0026"},"description":{"type":"string"},"id":{"type":"string"},"technique":{"description":"MITRE ATT&CK ID/URL","example":"http://localhost/api/v2/attacks/TA0001:T1078.001"},"type":{"enum":["mitigates","detects"],"type":"string"}},"required":["defense","technique","type"],"type":"object"},"AttackDefenseV2APISchema":{"properties":{"description":{"type":"string"},"external_references":{"items":{"$ref":"#/components/schemas/AttackReferenceSchema"},"readOnly":true,"type":"array"},"id":{"type":"string"},"matrix":{"deprecated":true,"description":"Return one of the matrix the defense is part of. However, a defense may belong to more than one.","enum":["mobile-attack","enterprise-attack","ics-attack","DISARM"],"type":"string"},"name":{"type":"string"},"related_defenses":{"description":"The ATTACK defense objects that are linked by a defense object","example":["http://localhost/api/v2/attack-defenses/DS0026"],"items":{"description":"MITRE ATT&CK Defense ID/URL","example":"http://localhost/api/v2/attack-defenses/DS0026"},"type":"array"},"related_techniques":{"description":"[Collection of] MITRE ATT&CK ID/URL","example":["http://localhost/api/v2/attacks/TA0001:T1078.001"],"items":{"description":"MITRE ATT&CK ID/URL","example":"http://localhost/api/v2/attacks/TA0001:T1078.001","writeOnly":true},"type":"array","writeOnly":true},"source_defenses":{"description":"The ATTACK defense objects that definea link to a defense object","example":["http://localhost/api/v2/attack-defenses/DS0026"],"items":{"description":"MITRE ATT&CK Defense ID/URL","example":"http://localhost/api/v2/attack-defenses/DS0026","writeOnly":true},"type":"array","writeOnly":true},"type":{"enum":["analytic","data-component","detection-strategy","mitigation"],"type":"string"}},"required":["name","type"],"type":"object"},"AttackMotivationVocabSchema":{"properties":{"value":{"enum":["accidental","coercion","dominance","ideology","notoriety","organizational-gain","personal-gain","personal-satisfaction","revenge","unpredictable"],"type":"string"},"vocab":{"default":"attack-motivation-ov","description":"Constant field, must have a value of \"attack-motivation-ov\"","type":"string"}},"required":["value"],"type":"object"},"AttackNodeAPISchema":{"properties":{"description":{"type":"string"},"external_references":{"items":{"$ref":"#/components/schemas/AttackReferenceSchema"},"type":"array"},"full_path":{"items":{"$ref":"#/components/schemas/AttackPathElementSchema"},"type":"array"},"id":{"type":"string"},"matrix":{"enum":["mobile-attack","enterprise-attack","ics-attack","DISARM"],"type":"string"},"name":{"type":"string"},"parent":{"description":"MITRE ATT&CK ID/URL","example":"http://localhost/api/v2/attacks/TA0001:T1078.001"},"type":{"enum":["matrix","tactic","technique","subtechnique"],"type":"string"}},"required":["name","type"],"type":"object"},"AttackPathElementSchema":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"type":"object"},"AttackReferenceSchema":{"properties":{"description":{"type":"string"},"external_id":{"type":"string"},"source_name":{"type":"string"},"url":{"format":"url","type":"string"}},"type":"object"},"AttackResourceLevelVocabSchema":{"properties":{"value":{"enum":["individual","club","contest","team","organization","government"],"type":"string"},"vocab":{"default":"attack-resource-level-ov","description":"Constant field, must have a value of \"attack-resource-level-ov\"","type":"string"}},"required":["value"],"type":"object"},"AttackerInfrastructureTypeVocabSchema":{"properties":{"value":{"enum":["Anonymization","Anonymization - Proxy","Anonymization - TOR Network","Anonymization - VPN","Communications","Communications - Blogs","Communications - Forums","Communications - Internet Relay Chat","Communications - Micro-Blogs","Communications - Mobile Communications","Communications - Social Networks","Communications - User-Generated Content Websites","Domain Registration","Domain Registration - Dynamic DNS Services","Domain Registration - Legitimate Domain Registration Services","Domain Registration - Malicious Domain Registrars","Domain Registration - Top-Level Domain Registrars","Hosting","Hosting - Bulletproof / Rogue Hosting","Hosting - Cloud Hosting","Hosting - Compromised Server","Hosting - Fast Flux Botnet Hosting","Hosting - Legitimate Hosting","Electronic Payment Methods"],"type":"string"},"vocab":{"default":"{http://stix.mitre.org/default_vocabularies-1}AttackerInfrastructureTypeVocab-1.0","description":"Constant field, must have a value of \"{http://stix.mitre.org/default_vocabularies-1}AttackerInfrastructureTypeVocab-1.0\"","type":"string"}},"required":["value"],"type":"object"},"AttackerToolInformationSchema":{"properties":{"description":{"type":"string"},"description_structuring_format":{"type":"string"},"hashes":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"hash_type_vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"CyboxHashSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/CyboxHashSchema","{http://cybox.mitre.org/default_vocabularies-2}HashNameVocab-1.0":"#/components/schemas/CyboxHashNameVocabSchema"},"propertyName":"hash_type_vocab"},"oneOf":[{"$ref":"#/components/schemas/CyboxHashNameVocabSchema"},{"$ref":"#/components/schemas/CyboxHashSchema"}],"properties":{"hash_type_vocab":{"enum":["{http://cybox.mitre.org/default_vocabularies-2}HashNameVocab-1.0","*"],"type":"string"}},"type":"object"},"type":"array"},"id":{"type":"string"},"idref":{"type":"string"},"name":{"type":"string"},"service_pack":{"type":"string"},"type":{"default":"tool-information","description":"Constant field, must have a value of \"tool-information\"","type":"string"},"types":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"CyboxControlledVocabularySchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/CyboxControlledVocabularySchema","{http://stix.mitre.org/default_vocabularies-1}AttackerToolTypeVocab-1.0":"#/components/schemas/AttackerToolTypeVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/AttackerToolTypeVocabSchema"},{"$ref":"#/components/schemas/CyboxControlledVocabularySchema"}],"properties":{"vocab":{"enum":["{http://stix.mitre.org/default_vocabularies-1}AttackerToolTypeVocab-1.0","*"],"type":"string"}},"type":"object"},"type":"array"},"vendor":{"type":"string"},"version":{"type":"string"}},"required":["type"],"type":"object"},"AttackerToolTypeVocabSchema":{"properties":{"apply_condition":{"enum":["ALL","ANY","NONE"],"type":"string"},"bit_mask":{"pattern":"([0-9a-fA-F]{2})+","type":"string"},"condition":{"enum":["Equals","DoesNotEqual","Contains","DoesNotContain","StartsWith","EndsWith","GreaterThan","GreaterThanOrEqual","LessThan","LessThanOrEqual","InclusiveBetween","ExclusiveBetween","FitsPattern","BitwiseAnd","BitwiseOr","BitwiseXor"],"type":"string"},"delimiter":{"type":"string"},"has_changed":{"type":"boolean"},"is_case_sensitive":{"type":"boolean"},"pattern_type":{"enum":["Regex","Binary","XPath"],"type":"string"},"regex_syntax":{"type":"string"},"trend":{"type":"boolean"},"value":{"enum":["Malware","Penetration Testing","Port Scanner","Traffic Scanner","Vulnerability Scanner","Application Scanner","Password Cracking"],"type":"string"},"vocab":{"default":"{http://stix.mitre.org/default_vocabularies-1}AttackerToolTypeVocab-1.0","description":"Constant field, must have a value of \"{http://stix.mitre.org/default_vocabularies-1}AttackerToolTypeVocab-1.0\"","type":"string"}},"required":["value"],"type":"object"},"BaseAutomationAPISchema":{"properties":{"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"description":{"nullable":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"is_active":{"type":"boolean"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"name":{"type":"string"}},"required":["is_active","name"],"type":"object"},"BatchRunAPISchema":{"properties":{"enrichers":{"description":"List of active enricher IDs or URLs","example":["http://localhost/api/v2/enrichers/1"],"items":{"description":"Enricher ID/URL","example":"http://localhost/api/v2/enrichers/1"},"type":"array"},"entities":{"description":"[Collection of] Entity ID/URL","example":["http://localhost/api/v2/entities/499e4f60-8fac-4fd6-8144-7bc00a9809f0"],"items":{"description":"Entity ID/URL","example":"http://localhost/api/v2/entities/499e4f60-8fac-4fd6-8144-7bc00a9809f0"},"type":"array"},"observables":{"description":"[Collection of] Observable ID/URL","example":["http://localhost/api/v2/observables/1"],"items":{"description":"Observable ID/URL","example":"http://localhost/api/v2/observables/1"},"type":"array"}},"type":"object"},"BundleObjectReferenceAPISchema":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"removed":{"type":"boolean"},"type":{"type":"string"}},"type":"object"},"CIQIdentitySchema":{"properties":{"id":{"type":"string"},"identity_type":{"type":"string"},"idref":{"type":"string"},"name":{"type":"string"},"roles":{"items":{"type":"string"},"type":"array"},"specification_xml":{"type":"string"},"specification_xml_type":{"type":"string"},"type":{"default":"identity","description":"Constant field, must have a value of \"identity\"","type":"string"}},"required":["type"],"type":"object"},"CSVColumnMappingSchema":{"properties":{"column_name":{"type":"string"},"eiq_fields":{"items":{"type":"string"},"type":"array"},"parameters":{"$ref":"#/components/schemas/ColumnParametersSchema"}},"required":["column_name"],"type":"object"},"CSVMappingAPISchema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"config":{"$ref":"#/components/schemas/CSVMappingConfig"},"created_at":{"description":"CSV Mapping creation date (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"csv_url":{"type":"string"},"default_field_values":{"additionalProperties":{},"type":"object"},"description":{"nullable":true,"type":"string"},"id":{"description":"CSV Mapping ID","readOnly":true,"type":"integer"},"incoming_feeds":{"description":"URLs of the incoming feeds using this CSV Mapping","example":["http://localhost/api/v2/incoming-feeds/1"],"items":{"description":"Incoming feed ID/URL","example":"http://localhost/api/v2/incoming-feeds/1","readOnly":true},"readOnly":true,"type":"array"},"last_updated_at":{"description":"CSV Mapping last update date (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"last_updated_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"mappings":{"items":{"$ref":"#/components/schemas/CSVColumnMappingSchema"},"type":"array"},"name":{"description":"CSV Mapping name","example":"malware report","minLength":1,"type":"string"}},"required":["id","mappings","name"],"type":"object"},"CSVMappingConfig":{"properties":{"comment_character":{"default":"#","maxLength":1,"minLength":1,"type":"string"},"delimiter":{"default":",","maxLength":1,"minLength":1,"type":"string"},"first_row_is_header":{"type":"boolean"},"ignore_comment_lines":{"default":false,"type":"boolean"},"ignore_lines_without_delimiter":{"default":false,"type":"boolean"},"parse_tags":{"default":false,"type":"boolean"},"quote_character":{"default":"\"","maxLength":2,"type":"string"},"tags_delimiter":{"default":";","maxLength":1,"minLength":1,"type":"string"}},"type":"object"},"CSVMappingInlineSchema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"config":{"$ref":"#/components/schemas/CSVMappingConfig"},"csv_url":{"type":"string"},"default_field_values":{"additionalProperties":{},"type":"object"},"mappings":{"items":{"$ref":"#/components/schemas/CSVColumnMappingSchema"},"type":"array"}},"required":["mappings"],"type":"object"},"CampaignDataSchema":{"additionalProperties":true,"properties":{"confidence":{"enum":["unknown","none","high","low","medium"],"type":"string"},"custom_attributes":{},"description":{"type":"string"},"description_structuring_format":{"type":"string"},"id":{"description":"STIX ID to uniquely identify the object. If none is specified on an entity payload then the platform will automatically generate a STIX ID in the format `{platform-namespace-url}type-UUID`.","example":"{https://example.com}indicator-da747dd9-5564-44e1-aa24-8b527dfb8868","minLength":1,"type":"string"},"information_source":{"$ref":"#/components/schemas/InformationSourceAPISchema"},"intended_effects":{"items":{"$ref":"#/components/schemas/IntendedEffectSchema"},"type":"array"},"names":{"items":{"$ref":"#/components/schemas/ValueRequiredSchema"},"type":"array"},"short_description":{"type":"string"},"status":{"enum":["Future","Historic","Ongoing"],"type":"string"},"timestamp":{"description":"Entity timestamp (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"title":{"type":"string"},"type":{"enum":["attack-pattern","campaign","course-of-action","exploit-target","identity","incident","indicator","infrastructure","intrusion-set","location","malware","malware-analysis","report","eclecticiq-sighting","threat-actor","tool","ttp","custom-entity"],"type":"string"}},"required":["title","type"],"type":"object"},"CapecExternalReferenceSchema":{"properties":{"description":{"type":"string"},"external_id":{"pattern":"^CAPEC-\\d+$","type":"string"},"source_name":{"default":"capec","description":"Constant field, must have a value of \"capec\"","type":"string"},"url":{"type":"string"}},"required":["external_id","source_name"],"type":"object"},"ChatHistoryItemSchema":{"properties":{"content":{"type":"string"},"role":{"enum":["assistant","user"],"type":"string"}},"type":"object"},"ChatHistoryItemSchema1":{"properties":{"content":{"type":"string"},"role":{"enum":["assistant","user"],"type":"string"}},"type":"object"},"ChatPromptApiSchema":{"properties":{"chat_history":{"items":{"$ref":"#/components/schemas/ChatHistoryItemSchema"},"type":"array"},"query":{"type":"string"}},"required":["query"],"type":"object"},"ColumnParametersSchema":{"properties":{"column_delimiter":{"type":"string"},"maliciousness":{"enum":["low","medium","high","unknown","safe"],"type":"string"},"time_format":{"type":"string"},"title_before_description":{"type":"string"},"title_heading":{"type":"string"}},"type":"object"},"ConfidenceHighMediumLowVocabSchema":{"properties":{"description":{"type":"string"},"description_structuring_format":{"type":"string"},"source":{"$ref":"#/components/schemas/InformationSourceSchema"},"timestamp":{"format":"date-time","nullable":true,"type":"string"},"timestamp_precision":{"enum":["year","month","day","hour","minute","second"],"type":"string"},"type":{"default":"confidence","description":"Constant field, must have a value of \"confidence\"","type":"string"},"value":{"enum":["High","Medium","Low","None","Unknown"],"type":"string"},"value_vocab":{"default":"{http://stix.mitre.org/default_vocabularies-1}HighMediumLowVocab-1.0","description":"Constant field, must have a value of \"{http://stix.mitre.org/default_vocabularies-1}HighMediumLowVocab-1.0\"","type":"string"}},"required":["type","value"],"type":"object"},"ConfidenceSchema":{"properties":{"description":{"type":"string"},"description_structuring_format":{"type":"string"},"source":{"$ref":"#/components/schemas/InformationSourceSchema"},"timestamp":{"format":"date-time","nullable":true,"type":"string"},"timestamp_precision":{"enum":["year","month","day","hour","minute","second"],"type":"string"},"type":{"default":"confidence","description":"Constant field, must have a value of \"confidence\"","type":"string"},"value":{"type":"string"},"value_vocab":{"type":"string"},"value_vocab_name":{"type":"string"},"value_vocab_reference":{"type":"string"}},"required":["type","value"],"type":"object"},"ConfidenceSchema1":{"properties":{"type":{"default":"confidence","description":"Constant field, must have a value of \"confidence\"","type":"string"},"value":{"enum":["None","Low","Medium","High","Unknown"],"type":"string"}},"required":["type"],"type":"object"},"ConfigurationBundleProducerAPISchema":{"properties":{"api_url":{"format":"url","type":"string"},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"URL of the creator","example":"http://localhost/api/v2/users/1","readOnly":true},"id":{"type":"integer"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"name":{"readOnly":true,"type":"string"}},"required":["api_url"],"type":"object"},"ConfigurationSchema":{"properties":{"cce_id":{"type":"string"},"description":{"minLength":1,"type":"string"},"type":{"default":"configuration","description":"Constant field, must have a value of \"configuration\"","type":"string"}},"required":["cce_id","description"],"type":"object"},"ConsolidationPolicyAPISchema":{"properties":{"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"id":{"readOnly":true,"type":"integer"},"is_active":{"type":"boolean"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"last_updated_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"merge_group":{"description":"Group ID/URL","example":"http://localhost/api/v2/groups/1"},"task":{"description":"Task associated to this policy","example":"http://localhost/api/v2/tasks/1","readOnly":true}},"required":["is_active"],"type":"object"},"ConsolidationPolicyConfigurationAPISchema":{"properties":{"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"entity_types":{"items":{"enum":["identity","infrastructure","indicator","intrusion-set","location","tool","threat-actor","exploit-target","malware"],"type":"string"},"type":"array"},"half_life_choice":{"type":"string"},"id":{"type":"integer"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"last_updated_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"policy_id":{"description":"DeduplcationPolicy ID/URL","example":"http://localhost/api/v2/consolidation-rules/1","readOnly":true},"preferred_source":{"description":"Source associated to this object. (ID/URL)","example":"http://localhost/api/v2/sources/54a79630-61e3-4680-b294-52759b6b8547","nullable":true},"sources":{"description":"List of sources matched by the rule","example":["http://localhost/api/v2/sources/93ba674b-b821-45e8-b3ee-a13364518b8f"],"items":{"description":"Source associated to this object. (ID/URL)","example":"http://localhost/api/v2/sources/93ba674b-b821-45e8-b3ee-a13364518b8f"},"type":"array"},"tlp_choice":{"type":"string"}},"required":["entity_types","half_life_choice","tlp_choice"],"type":"object"},"ContentBlockAPISchema":{"properties":{"content_type":{"type":"string"},"created_at":{"format":"date-time","readOnly":true,"type":"string"},"delivery_status":{"readOnly":true,"type":"string"},"filename":{"readOnly":true,"type":"string"},"id":{"type":"integer"},"items_count":{"readOnly":true,"type":"integer"},"meta":{"allOf":[{"$ref":"#/components/schemas/ContentBlockMetaSchema"}],"readOnly":true},"outgoing_feed":{"description":"Outgoing feed ID/URL","example":"http://localhost/api/v2/outgoing-feeds/1","readOnly":true},"run_id":{"readOnly":true,"type":"string"},"size":{"readOnly":true,"type":"integer"}},"required":["content_type"],"type":"object"},"ContentBlockMetaSchema":{"properties":{"destination":{"format":"uuid","readOnly":true,"type":"string"},"original_content_type":{"readOnly":true,"type":"string"},"signed_with_key_id":{"readOnly":true,"type":"string"}},"type":"object"},"ContentGenerationPromptAPISchema":{"properties":{"content_length":{"type":"integer"},"content_prompt":{"type":"string"},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"description":{"type":"string"},"entity_fields":{"items":{"enum":["title","type","description","observed_time","tags","taxonomy","attack","references"],"type":"string"},"type":"array"},"entity_types":{"items":{"enum":["attack-pattern","campaign","course-of-action","exploit-target","identity","incident","indicator","infrastructure","intrusion-set","location","malware","malware-analysis","report","eclecticiq-sighting","threat-actor","tool","ttp","custom-entity"],"type":"string"},"type":"array"},"formatting_prompt":{"type":"string"},"id":{"readOnly":true,"type":"integer"},"include_related_entities":{"type":"boolean"},"is_enabled":{"type":"boolean"},"is_pinned":{"type":"boolean"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"last_updated_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"limit_content_length":{"type":"boolean"},"max_related_entities":{"type":"integer"},"name":{"type":"string"},"target_language":{"enum":["Albanian","Arabic","Bosnian","Bulgarian","Chinese(Simplified)","Chinese(Traditional)","Croatian","Czech","Danish","Dutch","English","Estonian","Farsi(Persian)","Finnish","French","German","Greek","Hebrew","Hindi","Hungarian","Icelandic","Italian","Japanese","Korean","Latvian","Lithuanian","Macedonian","Norwegian","Polish","Portuguese","Romanian","Russian","Serbian","Slovak","Slovenian","Spanish","Swedish","Turkish","Ukrainian"],"type":"string"}},"required":["content_prompt","description","entity_types","formatting_prompt","include_related_entities","is_enabled","is_pinned","limit_content_length","name","target_language"],"type":"object"},"ControlledVocabularyStringSchema":{"properties":{"value":{"type":"string"},"value_vocab":{"type":"string"},"vocab":{"type":"string"},"vocab_name":{"type":"string"},"vocab_reference":{"type":"string"}},"required":["value"],"type":"object"},"CopyFieldSchema":{"properties":{"excluded_values":{"items":{"type":"string"},"type":"array"},"field":{"enum":["tlp","tags","taxonomies","half_life","intelligence_requirements","mitre_attack"],"type":"string"},"included_values":{"items":{"type":"string"},"type":"array"},"type":{"enum":["all","selected"],"type":"string"}},"required":["field","type"],"type":"object"},"CountsPerFieldValuesAggregationSchema":{"properties":{"count":{"type":"integer"},"field":{"type":"string"},"value":{"type":"string"}},"type":"object"},"CourseOfActionDataSchema":{"additionalProperties":true,"properties":{"coa_type":{"enum":["Diplomatic Actions","Eradication","Hardening","Internal Blocking","Logical Access Restrictions","Monitoring","Other","Patching","Perimeter Blocking","Physical Access Restrictions","Policy Actions","Public Disclosure","Rebuilding","Redirection","Redirection (Honey Pot)","Training"],"type":"string"},"confidence":{"enum":["unknown","none","high","low","medium"],"type":"string"},"cost":{"$ref":"#/components/schemas/ImpactOrCostOrEfficacySchema"},"custom_attributes":{},"description":{"type":"string"},"description_structuring_format":{"type":"string"},"efficacy":{"$ref":"#/components/schemas/ImpactOrCostOrEfficacySchema"},"id":{"description":"STIX ID to uniquely identify the object. If none is specified on an entity payload then the platform will automatically generate a STIX ID in the format `{platform-namespace-url}type-UUID`.","example":"{https://example.com}indicator-da747dd9-5564-44e1-aa24-8b527dfb8868","minLength":1,"type":"string"},"impact":{"$ref":"#/components/schemas/ImpactOrCostOrEfficacySchema"},"information_source":{"$ref":"#/components/schemas/InformationSourceAPISchema"},"objective":{"$ref":"#/components/schemas/ObjectiveSchema"},"short_description":{"type":"string"},"stage":{"enum":["Remedy","Response"],"type":"string"},"timestamp":{"description":"Entity timestamp (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"title":{"type":"string"},"type":{"enum":["attack-pattern","campaign","course-of-action","exploit-target","identity","incident","indicator","infrastructure","intrusion-set","location","malware","malware-analysis","report","eclecticiq-sighting","threat-actor","tool","ttp","custom-entity"],"type":"string"}},"required":["title","type"],"type":"object"},"CoverPageContainerSchema":{"properties":{"background_color":{"type":"string"},"header_sections":{"items":{"$ref":"#/components/schemas/HeaderFooterSectionSchema"},"type":"array"},"is_different_header_enabled":{"type":"boolean"},"is_enabled":{"type":"boolean"},"is_show_header_enabled":{"type":"boolean"},"is_show_image_enabled":{"type":"boolean"},"meta":{"type":"object"},"url":{"nullable":true,"type":"string"}},"type":"object"},"CustomAttributeMappingSchema":{"properties":{"custom_attribute_name":{"type":"string"},"custom_entity_types":{"$ref":"#/components/schemas/EntityDefinitionSummarySchema"}},"type":"object"},"CustomAttributeSchema":{"properties":{"allowed_values":{"items":{"type":"string"},"nullable":true,"type":"array"},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"data_type":{"type":"string"},"description":{"maxLength":500,"nullable":true,"type":"string"},"display_name":{"nullable":true,"type":"string"},"id":{"type":"integer"},"is_used_in_entity_schema":{"readOnly":true,"type":"boolean"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"last_updated_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"name":{"type":"string"}},"required":["data_type","name"],"type":"object"},"CustomEntityDataSchema":{"additionalProperties":true,"properties":{"confidence":{"$ref":"#/components/schemas/ConfidenceSchema1"},"custom_attributes":{},"custom_entity_type":{"type":"string"},"description":{"type":"string"},"description_structuring_format":{"type":"string"},"external_references":{"items":{"$ref":"#/components/schemas/ExternalReferenceSchema"},"type":"array"},"handling":{"items":{"$ref":"#/components/schemas/MarkingSpecificationSchema"},"type":"array"},"id":{"description":"STIX ID to uniquely identify the object. If none is specified on an entity payload then the platform will automatically generate a STIX ID in the format `{platform-namespace-url}type-UUID`.","example":"{https://example.com}indicator-da747dd9-5564-44e1-aa24-8b527dfb8868","minLength":1,"type":"string"},"information_source":{"$ref":"#/components/schemas/InformationSourceSchema"},"timestamp":{"format":"date-time","nullable":true,"type":"string"},"title":{"type":"string"},"type":{"default":"custom-entity","description":"Constant field, must have a value of \"custom-entity\"","type":"string"}},"required":["custom_entity_type","title","type"],"type":"object"},"CvssScoreSchema":{"properties":{"base_score":{"type":"string"},"base_vector":{"type":"string"},"environmental_score":{"type":"string"},"environmental_vector":{"type":"string"},"overall_score":{"type":"string"},"temporal_score":{"type":"string"},"temporal_vector":{"type":"string"},"type":{"default":"cvss-vector","description":"Constant field, must have a value of \"cvss-vector\"","type":"string"}},"type":"object"},"CyboxControlledVocabularySchema":{"properties":{"apply_condition":{"enum":["ALL","ANY","NONE"],"type":"string"},"bit_mask":{"pattern":"([0-9a-fA-F]{2})+","type":"string"},"condition":{"enum":["Equals","DoesNotEqual","Contains","DoesNotContain","StartsWith","EndsWith","GreaterThan","GreaterThanOrEqual","LessThan","LessThanOrEqual","InclusiveBetween","ExclusiveBetween","FitsPattern","BitwiseAnd","BitwiseOr","BitwiseXor"],"type":"string"},"delimiter":{"type":"string"},"has_changed":{"type":"boolean"},"is_case_sensitive":{"type":"boolean"},"pattern_type":{"enum":["Regex","Binary","XPath"],"type":"string"},"regex_syntax":{"type":"string"},"trend":{"type":"boolean"},"value":{"type":"string"},"value_vocab":{"type":"string"},"vocab":{"type":"string"},"vocab_name":{"type":"string"},"vocab_reference":{"type":"string"}},"required":["value"],"type":"object"},"CyboxHashNameVocabSchema":{"properties":{"hash_type":{"enum":["MD5","MD6","SHA1","SHA224","SHA256","SHA384","SHA512","SSDEEP"],"type":"string"},"hash_type_apply_condition":{"enum":["ALL","ANY","NONE"],"type":"string"},"hash_type_bit_mask":{"pattern":"([0-9a-fA-F]{2})+","type":"string"},"hash_type_condition":{"enum":["Equals","DoesNotEqual","Contains","DoesNotContain","StartsWith","EndsWith","GreaterThan","GreaterThanOrEqual","LessThan","LessThanOrEqual","InclusiveBetween","ExclusiveBetween","FitsPattern","BitwiseAnd","BitwiseOr","BitwiseXor"],"type":"string"},"hash_type_delimiter":{"type":"string"},"hash_type_has_changed":{"type":"boolean"},"hash_type_is_case_sensitive":{"type":"boolean"},"hash_type_pattern_type":{"enum":["Regex","Binary","XPath"],"type":"string"},"hash_type_regex_syntax":{"type":"string"},"hash_type_trend":{"type":"boolean"},"hash_type_value_vocab":{"type":"string"},"hash_type_vocab":{"default":"{http://cybox.mitre.org/default_vocabularies-2}HashNameVocab-1.0","description":"Constant field, must have a value of \"{http://cybox.mitre.org/default_vocabularies-2}HashNameVocab-1.0\"","type":"string"},"hash_type_vocab_name":{"type":"string"},"hash_type_vocab_reference":{"type":"string"},"type":{"default":"hash","description":"Constant field, must have a value of \"hash\"","type":"string"},"value":{"type":"string"}},"required":["hash_type","hash_type_vocab","type"],"type":"object"},"CyboxHashSchema":{"properties":{"hash_type":{"type":"string"},"hash_type_apply_condition":{"enum":["ALL","ANY","NONE"],"type":"string"},"hash_type_bit_mask":{"pattern":"([0-9a-fA-F]{2})+","type":"string"},"hash_type_condition":{"enum":["Equals","DoesNotEqual","Contains","DoesNotContain","StartsWith","EndsWith","GreaterThan","GreaterThanOrEqual","LessThan","LessThanOrEqual","InclusiveBetween","ExclusiveBetween","FitsPattern","BitwiseAnd","BitwiseOr","BitwiseXor"],"type":"string"},"hash_type_delimiter":{"type":"string"},"hash_type_has_changed":{"type":"boolean"},"hash_type_is_case_sensitive":{"type":"boolean"},"hash_type_pattern_type":{"enum":["Regex","Binary","XPath"],"type":"string"},"hash_type_regex_syntax":{"type":"string"},"hash_type_trend":{"type":"boolean"},"hash_type_value_vocab":{"type":"string"},"hash_type_vocab":{"type":"string"},"hash_type_vocab_name":{"type":"string"},"hash_type_vocab_reference":{"type":"string"},"type":{"default":"hash","description":"Constant field, must have a value of \"hash\"","type":"string"},"value":{"type":"string"}},"required":["hash_type","type"],"type":"object"},"DashboardAPISchema":{"properties":{"collaborators":{"description":"List of users dashboard has been shared with. Does not include users in groups that the dashboard has been shared with.","example":["http://localhost/api/v2/users/1"],"items":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1"},"type":"array"},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"description":{"default":"","type":"string"},"groups":{"description":"List of user groups the dashboard has been shared with","example":["http://localhost/api/v2/groups/1"],"items":{"description":"Group ID/URL","example":"http://localhost/api/v2/groups/1"},"type":"array"},"id":{"readOnly":true,"type":"integer"},"is_pinned":{},"is_protected":{"type":"boolean"},"is_shared_with_all":{"type":"boolean"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"last_updated_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"name":{"type":"string"},"ui_metadata":{"description":"The parameters to configure the user interface.","type":"object"},"widgets":{"description":"List of widgets added to the dashboard","example":["http://localhost/api/v2/widgets/1"],"items":{"description":"Widget ID/URL","example":"http://localhost/api/v2/widgets/1"},"type":"array"}},"required":["name"],"type":"object"},"DatasetAPISchema":{"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"description":{"nullable":true,"type":"string"},"entities":{"description":"[Collection of] Entity ID/URL","example":["http://localhost/api/v2/entities/2a9f0dcd-6582-4374-ba0e-8a661da984ea"],"items":{"description":"Entity ID/URL","example":"http://localhost/api/v2/entities/2a9f0dcd-6582-4374-ba0e-8a661da984ea","writeOnly":true},"type":"array","writeOnly":true},"entities_count":{"readOnly":true,"type":"integer"},"id":{"readOnly":true,"type":"integer"},"is_dynamic":{"readOnly":true,"type":"boolean"},"is_favorite":{},"is_relational":{"readOnly":true,"type":"boolean"},"last_updated_at":{"format":"date-time","readOnly":true,"type":"string"},"name":{"type":"string"},"relational_query":{"allOf":[{"$ref":"#/components/schemas/SimplifiedRelationalQueryAPISchema"}],"description":"Relational query allowing users to find entities which have *relations* to other entities, while both `entity sets`(query_1 and query2)  have specific lucene-based search criteria.","nullable":true},"search_query":{"nullable":true,"type":"string"},"workspaces":{"description":"[Collection of] Workspace ID/URL","example":["http://localhost/api/v2/workspaces/1"],"items":{"description":"Workspace ID/URL","example":"http://localhost/api/v2/workspaces/1"},"type":"array"}},"required":["name"],"type":"object"},"DatasetEntitiesByQuerySchema":{"properties":{"entities_query":{"description":"\nFull-text or faceted search with logic operators\nlike `AND` and `OR`.\n\nThe language of the search queries is Lucene and the\ncapability is the same as the one in Intelligence Center\nUI. Read more in [its documentation](\nhttps://docs.eclecticiq.com/ic/3.1.0/get-to-know-the-ic/search/).\n","example":"data.title:malware OR data.description:APT17","nullable":true,"type":"string"},"relational_query":{"allOf":[{"$ref":"#/components/schemas/SimplifiedRelationalQueryAPISchema"}],"nullable":true},"time_zone":{"description":"Timezone in Coordinated Universal Time (UTC) offset format","example":"+01:00 or -08:00","pattern":"[\\+,-][0-9][0-9]:[0-9][0-9]"}},"type":"object"},"DefaultValuesSchema":{"properties":{"entity":{"allOf":[{"$ref":"#/components/schemas/EntityDefaultValuesSchema"}],"description":"The default values to be used when the user creates or updates an entity."},"language":{"enum":["Albanian","Arabic","Bosnian","Bulgarian","Chinese(Simplified)","Chinese(Traditional)","Croatian","Czech","Danish","Dutch","English","Estonian","Farsi(Persian)","Finnish","French","German","Greek","Hebrew","Hindi","Hungarian","Icelandic","Italian","Japanese","Korean","Latvian","Lithuanian","Macedonian","Norwegian","Polish","Portuguese","Romanian","Russian","Serbian","Slovak","Slovenian","Spanish","Swedish","Turkish","Ukrainian"],"type":"string"}},"type":"object"},"DeleteUploadedBlobAPISchema":{"properties":{"delete_entities":{"type":"boolean"},"delete_extracts":{"type":"boolean"},"ids":{"items":{"type":"integer"},"type":"array"}},"type":"object"},"DetonationMitreAttackSchema":{"properties":{"tactic_id":{"nullable":true,"type":"string"},"technique_id":{"nullable":true,"type":"string"}},"type":"object"},"DetonationResultEntitySchema":{"properties":{"entity_id":{"description":"ID of entity, present if the entity has been created","nullable":true,"type":"string"},"entity_type":{"type":"string"},"meta_stix_id":{"description":"Meta ID of entity, present if the entity has been created","nullable":true,"type":"string"},"value":{"type":"string"}},"type":"object"},"DetonationResultExtractSchema":{"properties":{"classification":{"nullable":true,"type":"string"},"confidence":{"nullable":true,"type":"string"},"kind":{"type":"string"},"link_type":{"nullable":true,"type":"string"},"value":{"type":"string"}},"type":"object"},"DetonatorTaskSchema":{"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"string"},"description":{"type":"string"},"detonation_per_day_limit":{"nullable":true,"type":"integer"},"id":{"type":"integer"},"is_active":{"type":"boolean"},"is_installed":{},"last_updated_at":{"format":"date-time","readOnly":true,"type":"string"},"name":{"readOnly":true,"type":"string"},"parameters":{},"selected_extract_types":{"items":{"type":"string"},"type":"array"},"source":{"description":"Source associated to the Detonator","example":"http://localhost/api/v2/sources/07d9a093-6a9b-457e-9190-2959d657cba8","nullable":true,"readOnly":true},"supported_detonation_types":{"items":{"type":"string"},"readOnly":true,"type":"array"},"task_name":{"type":"string"},"task_type":{"readOnly":true,"type":"string"},"terms":{"items":{"$ref":"#/components/schemas/TermsItemSchema"},"readOnly":true,"type":"array"},"today_detonation_count":{"readOnly":true,"type":"integer"},"ui_form_schema":{"items":{"type":"object"},"readOnly":true,"type":"array"}},"required":["name"],"type":"object"},"DiscoveryRuleAPISchema":{"properties":{"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"description":{"nullable":true,"type":"string"},"discovered_count":{"readOnly":true,"type":"integer"},"entity_types":{"description":"Types of entities matched by the keywords based rule","items":{"enum":["attack-pattern","campaign","course-of-action","exploit-target","identity","incident","indicator","infrastructure","intrusion-set","location","malware","malware-analysis","report","eclecticiq-sighting","threat-actor","tool","ttp","custom-entity"],"type":"string"},"type":"array"},"external_url":{"description":"External URL for this rule","format":"url","readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"is_active":{"type":"boolean"},"keywords":{"description":"List of keywords to search.","items":{"type":"string"},"type":"array"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"match_keywords_in":{"description":"List of entity fields to search for keywords. Supported: ['title', 'tags', 'description']","enum":["title","tags","description"],"items":{"type":"string"},"type":"array"},"name":{"type":"string"},"search_query":{"description":"ElasticSearch entities query associated to the discovery rule","example":"data.title:Some title","type":"string"},"sources":{"description":"List of sources matched by the keywords-based rule","example":["http://localhost/api/v2/sources/750d3ff2-867e-4761-a6d0-45815a8ff214"],"items":{"description":"Source associated to this object. (ID/URL)","example":"http://localhost/api/v2/sources/750d3ff2-867e-4761-a6d0-45815a8ff214"},"type":"array"},"status":{"description":"Status of the latest rule task execution","enum":["PENDING","SENT","STARTED","RETRY","FAILURE","REVOKED","CAP_REACHED","WARNING","SUCCESS",null],"nullable":true,"readOnly":true,"type":"string"},"task":{"description":"Task associated to this rule","example":"http://localhost/api/v2/tasks/1"},"workspaces":{"description":"Workspaces associated to the discovery rule","example":["http://localhost/api/v2/workspaces/1","http://localhost/api/v2/workspaces/2","http://localhost/api/v2/workspaces/3","http://localhost/api/v2/workspaces/4"]}},"required":["is_active","name"],"type":"object"},"EclecticIqAttachmentSchema":{"properties":{"content":{"type":"string"},"content_type":{"type":"string"},"name":{"type":"string"},"type":{"default":"eclecticiq-attachment","description":"Constant field, must have a value of \"eclecticiq-attachment\"","type":"string"}},"required":["content","name","type"],"type":"object"},"ElasticSearchQuerySchema":{"additionalProperties":true,"properties":{"query_string":{"$ref":"#/components/schemas/ElasticSearchQueryStringSchema"}},"type":"object"},"ElasticSearchQueryStringSchema":{"additionalProperties":true,"properties":{"lenient":{"type":"boolean"},"query":{"description":"\nFull-text or faceted search with logic operators\nlike `AND` and `OR`.\n\nThe language of the search queries is Lucene and the\ncapability is the same as the one in Intelligence Center\nUI. Read more in [its documentation](\nhttps://docs.eclecticiq.com/ic/3.1.0/get-to-know-the-ic/search/).\n","example":"data.title:malware OR data.description:APT17","type":"string"}},"required":["query"],"type":"object"},"EnricherAPISchema":{"additionalProperties":true,"properties":{"cache_validity":{"description":"Cache the enriched observables for the specified amount of seconds.","type":"integer"},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"description":{"type":"string"},"enricher":{"description":"Fully qualified name of the module that contains the enrichment function. An enrichment function must be a Python function that takes at least two arguments (observable `type` and `value`) as input parameters. Example enricher function name: `eiq.extensions.my_module.my_function`","example":"eiq.extensions.my_module.my_function"},"execution_cap":{"description":"Maximum number of executions per month.","type":"integer"},"id":{"readOnly":true,"type":"integer"},"is_active":{"type":"boolean"},"name":{"description":"It must be unique and only include alphanumeric characters and underscores. By default the name of the `enricher` will be used.","type":"string"},"parameters":{"description":"Enrichment task parameters."},"rate_limit":{"description":"The maximum allowed number of executions per second.","type":"integer"},"source":{"description":"Source associated to the enricher","example":"http://localhost/api/v2/sources/e34e9631-6e03-49ba-a936-0c5d271d294e","nullable":true,"readOnly":true},"source_reliability":{"description":"Source reliability assigned to the entities created by the enricher.","enum":["A","B","C","D","E","F",null],"nullable":true,"type":"string"},"source_urls":{"description":"`observable_type` -> `url` mapping. You can refer to the observable value in the URL as `${input}`."},"supported_observable_types":{"description":"List of observable types this enricher applies to.","items":{"enum":["ja3-full","hash-md5","ipv4-cidr","certificate-hash","malware-key","hash-sha384","inetnum","cwe","ipv4","hash-sha224","snort","certificate-serial-number","account-id","handle","certificate-subject","user-agent","person","hash-imphash","process","country","street","name","mutex","container-image-name","certificate-issuer","card","ipv6","organization","host","hash-ssdeep","city","cpu-architecture","uri-hash-sha256","bank-account","domain","ja3s-hash","card-owner","process-name","address","netname","email-subject","jarm","hash-rich-pe-header","geo-long","asn","registrar","email","product","forum-room","ja3-hash","rule","container-registry-account-name","country-code","file","yara","port","industry","forum-thread","winregistry","user-account","region","telephone","hash-vhash","container-cluster-name","device-fingerprint","hash-authentihash","hash-sha256","cloud-storage-bucket","cce","ipv6-cidr","ssh-public-key","nationality","eui-64","ja3s-full","cve","actor-id","geo-lat","hash-sha512","postcode","company","forum-name","geo","hash-sha1","mac-48","file-size","fox-it-portal-uri","uri","malware","crypto-address"],"type":"string"},"type":"array"},"task":{"description":"URL of the task associated to this enricher","example":"http://localhost/api/v2/tasks/1","readOnly":true},"tlp_color":{"description":"TLP color for the processed entities\n\nThe values `CLEAR` and `AMBER_STRICT` are also accepted as an input but converted to TLP v1 on the response side.","enum":["NONE","WHITE","GREEN","AMBER","RED"],"nullable":true,"type":"string"},"version":{"minimum":1,"type":"integer","writeOnly":true}},"required":["enricher","is_active","supported_observable_types"],"type":"object"},"EnrichmentRuleAPISchema":{"properties":{"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"criteria":{"description":"Filtering criteria for this rule","items":{"$ref":"#/components/schemas/EnrichmentRuleCriterionAPISchema"},"type":"array"},"description":{"nullable":true,"type":"string"},"enrichers":{"description":"Enrichers associated to this rule","example":["http://localhost/api/v2/enrichers/1","http://localhost/api/v2/enrichers/2","http://localhost/api/v2/enrichers/3","http://localhost/api/v2/enrichers/4"]},"execution_schedule":{"allOf":[{"$ref":"#/components/schemas/TaskExecutionScheduleSchema"}],"nullable":true},"id":{"readOnly":true,"type":"integer"},"is_active":{"type":"boolean"},"is_retroactive":{"type":"boolean"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"name":{"type":"string"},"status":{"description":"Status of the latest rule run","enum":["PENDING","SENT","STARTED","RETRY","FAILURE","REVOKED","CAP_REACHED","WARNING","SUCCESS",null],"nullable":true,"readOnly":true,"type":"string"},"task":{"description":"Task associated to this rule","example":"http://localhost/api/v2/tasks/1","readOnly":true},"time_field":{"enum":["ingestion","start","observed",null],"nullable":true,"type":"string"},"time_period":{"description":"Filter intelligence to be less days than 'time_field'","nullable":true,"type":"integer"}},"required":["is_active","name"],"type":"object"},"EnrichmentRuleCriterionAPISchema":{"properties":{"entity_type":{"description":"Filter entities with this type","enum":["attack-pattern","campaign","course-of-action","exploit-target","identity","incident","indicator","infrastructure","intrusion-set","location","malware","malware-analysis","report","eclecticiq-sighting","threat-actor","tool","ttp","custom-entity"],"type":"string"},"source":{"description":"Filter objects with this source","example":"http://localhost/api/v2/sources/e6c2ca5c-78cb-4f62-940d-3ca1002d9589"},"tlp":{"description":"Filter entities with this TLP\n\nThe values `CLEAR` and `AMBER_STRICT` are also accepted as an input but converted to TLP v1 on the response side.","enum":["NONE","WHITE","GREEN","AMBER","RED"],"nullable":true,"type":"string"},"without_tlp":{"description":"Disable TLP filter","type":"boolean"}},"type":"object"},"EntitiesActionByQueryBaseSchema":{"properties":{"entities_query":{"description":"\nFull-text or faceted search with logic operators\nlike `AND` and `OR`.\n\nThe language of the search queries is Lucene and the\ncapability is the same as the one in Intelligence Center\nUI. Read more in [its documentation](\nhttps://docs.eclecticiq.com/ic/3.1.0/get-to-know-the-ic/search/).\n","example":"data.title:malware OR data.description:APT17","nullable":true,"type":"string"},"relational_query":{"allOf":[{"$ref":"#/components/schemas/SimplifiedRelationalQueryAPISchema"}],"nullable":true},"time_zone":{"description":"Timezone in Coordinated Universal Time (UTC) offset format","example":"+01:00 or -08:00","pattern":"[\\+,-][0-9][0-9]:[0-9][0-9]"}},"type":"object"},"EntitiesConsolidateByQueryAPISchema":{"properties":{"entities_query":{"description":"\nFull-text or faceted search with logic operators\nlike `AND` and `OR`.\n\nThe language of the search queries is Lucene and the\ncapability is the same as the one in Intelligence Center\nUI. Read more in [its documentation](\nhttps://docs.eclecticiq.com/ic/3.1.0/get-to-know-the-ic/search/).\n","example":"data.title:malware OR data.description:APT17","nullable":true,"type":"string"},"relational_query":{"allOf":[{"$ref":"#/components/schemas/SimplifiedRelationalQueryAPISchema"}],"nullable":true},"time_zone":{"description":"Timezone in Coordinated Universal Time (UTC) offset format","example":"+01:00 or -08:00","pattern":"[\\+,-][0-9][0-9]:[0-9][0-9]"}},"type":"object"},"EntitiesDeconsolidateByQueryAPISchema":{"properties":{"entities_query":{"description":"\nFull-text or faceted search with logic operators\nlike `AND` and `OR`.\n\nThe language of the search queries is Lucene and the\ncapability is the same as the one in Intelligence Center\nUI. Read more in [its documentation](\nhttps://docs.eclecticiq.com/ic/3.1.0/get-to-know-the-ic/search/).\n","example":"data.title:malware OR data.description:APT17","nullable":true,"type":"string"},"relational_query":{"allOf":[{"$ref":"#/components/schemas/SimplifiedRelationalQueryAPISchema"}],"nullable":true},"time_zone":{"description":"Timezone in Coordinated Universal Time (UTC) offset format","example":"+01:00 or -08:00","pattern":"[\\+,-][0-9][0-9]:[0-9][0-9]"}},"type":"object"},"EntitiesDeleteByQueryAPISchema":{"properties":{"entities_query":{"description":"\nFull-text or faceted search with logic operators\nlike `AND` and `OR`.\n\nThe language of the search queries is Lucene and the\ncapability is the same as the one in Intelligence Center\nUI. Read more in [its documentation](\nhttps://docs.eclecticiq.com/ic/3.1.0/get-to-know-the-ic/search/).\n","example":"data.title:malware OR data.description:APT17","nullable":true,"type":"string"},"ignore_exemptions":{"type":"boolean"},"relational_query":{"allOf":[{"$ref":"#/components/schemas/SimplifiedRelationalQueryAPISchema"}],"nullable":true},"time_zone":{"description":"Timezone in Coordinated Universal Time (UTC) offset format","example":"+01:00 or -08:00","pattern":"[\\+,-][0-9][0-9]:[0-9][0-9]"}},"type":"object"},"EntitiesEnrichByQueryAPISchema":{"properties":{"enrichers":{"description":"List of active enricher IDs or URLs","example":["http://localhost/api/v2/enrichers/1"],"items":{"description":"Enricher ID/URL","example":"http://localhost/api/v2/enrichers/1"},"type":"array"},"entities_query":{"description":"\nFull-text or faceted search with logic operators\nlike `AND` and `OR`.\n\nThe language of the search queries is Lucene and the\ncapability is the same as the one in Intelligence Center\nUI. Read more in [its documentation](\nhttps://docs.eclecticiq.com/ic/3.1.0/get-to-know-the-ic/search/).\n","example":"data.title:malware OR data.description:APT17","nullable":true,"type":"string"},"relational_query":{"allOf":[{"$ref":"#/components/schemas/SimplifiedRelationalQueryAPISchema"}],"nullable":true},"time_zone":{"description":"Timezone in Coordinated Universal Time (UTC) offset format","example":"+01:00 or -08:00","pattern":"[\\+,-][0-9][0-9]:[0-9][0-9]"}},"type":"object"},"EntitiesUpdateByQueryAPISchema":{"properties":{"added_attacks":{"description":"[Collection of] MITRE ATT&CK ID/URL","example":["http://localhost/api/v2/attacks/TA0001:T1078.001"],"items":{"description":"MITRE ATT&CK ID/URL","example":"http://localhost/api/v2/attacks/TA0001:T1078.001"},"type":"array"},"added_tags":{"items":{"type":"string"},"type":"array"},"added_taxonomies":{"description":"[Collection of] Taxonomy ID, URL or path expressed as a lists of strings","example":["http://localhost/api/v2/taxonomies/1"],"items":{"description":"Taxonomy ID, URL or path expressed as a lists of strings","example":"http://localhost/api/v2/taxonomies/1"},"type":"array"},"confidence":{"enum":["None","Low","Medium","High","Unknown"],"type":"string"},"entities_query":{"description":"\nFull-text or faceted search with logic operators\nlike `AND` and `OR`.\n\nThe language of the search queries is Lucene and the\ncapability is the same as the one in Intelligence Center\nUI. Read more in [its documentation](\nhttps://docs.eclecticiq.com/ic/3.1.0/get-to-know-the-ic/search/).\n","example":"data.title:malware OR data.description:APT17","nullable":true,"type":"string"},"relational_query":{"allOf":[{"$ref":"#/components/schemas/SimplifiedRelationalQueryAPISchema"}],"nullable":true},"removed_attacks":{"description":"[Collection of] MITRE ATT&CK ID/URL","example":["http://localhost/api/v2/attacks/TA0001:T1078.001"],"items":{"description":"MITRE ATT&CK ID/URL","example":"http://localhost/api/v2/attacks/TA0001:T1078.001"},"type":"array"},"removed_tags":{"items":{"type":"string"},"type":"array"},"removed_taxonomies":{"description":"[Collection of] Taxonomy ID, URL or path expressed as a lists of strings","example":["http://localhost/api/v2/taxonomies/1"],"items":{"description":"Taxonomy ID, URL or path expressed as a lists of strings","example":"http://localhost/api/v2/taxonomies/1"},"type":"array"},"time_zone":{"description":"Timezone in Coordinated Universal Time (UTC) offset format","example":"+01:00 or -08:00","pattern":"[\\+,-][0-9][0-9]:[0-9][0-9]"},"tlp_color":{"description":"The values `CLEAR` and `AMBER_STRICT` are also accepted as an input but converted to TLP v1 on the response side.","enum":["NONE","WHITE","GREEN","AMBER","RED"],"nullable":true,"type":"string"}},"type":"object"},"EntityAPISchema":{"properties":{"attachments":{"description":"[Collection of] Entity attachment ID/URL","example":["http://localhost/api/v2/entities/attachments/1"],"items":{"description":"Entity attachment ID/URL","example":"http://localhost/api/v2/entities/attachments/1"},"type":"array"},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"data":{"description":"This object will be validated with a schema selected based on the value of the \"type\" property. If the value doesn't match a specific schema, the schema named \"EntityDataAPISchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/EntityDataAPISchema","attack-pattern":"#/components/schemas/PublicAttackPatternDataSchema","campaign":"#/components/schemas/CampaignDataSchema","course-of-action":"#/components/schemas/CourseOfActionDataSchema","custom-entity":"#/components/schemas/CustomEntityDataSchema","eclecticiq-sighting":"#/components/schemas/SightingDataSchema","exploit-target":"#/components/schemas/ExploitTargetDataSchema","identity":"#/components/schemas/PublicIdentityDataSchema","incident":"#/components/schemas/IncidentDataSchema","indicator":"#/components/schemas/IndicatorDataSchema","infrastructure":"#/components/schemas/PublicInfrastructureDataSchema","intrusion-set":"#/components/schemas/PublicIntrusionSetDataSchema","location":"#/components/schemas/PublicLocationDataSchema","malware":"#/components/schemas/PublicMalwareDataSchema","malware-analysis":"#/components/schemas/PublicMalwareAnalysisDataSchema","note":"#/components/schemas/PublicNoteDataSchema","report":"#/components/schemas/ReportDataSchema","threat-actor":"#/components/schemas/PublicThreatActorV2DataSchema","tool":"#/components/schemas/PublicToolDataSchema","ttp":"#/components/schemas/PublicTTPDataSchema"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/PublicAttackPatternDataSchema"},{"$ref":"#/components/schemas/CampaignDataSchema"},{"$ref":"#/components/schemas/CourseOfActionDataSchema"},{"$ref":"#/components/schemas/SightingDataSchema"},{"$ref":"#/components/schemas/ExploitTargetDataSchema"},{"$ref":"#/components/schemas/PublicIdentityDataSchema"},{"$ref":"#/components/schemas/IncidentDataSchema"},{"$ref":"#/components/schemas/IndicatorDataSchema"},{"$ref":"#/components/schemas/PublicInfrastructureDataSchema"},{"$ref":"#/components/schemas/PublicIntrusionSetDataSchema"},{"$ref":"#/components/schemas/PublicLocationDataSchema"},{"$ref":"#/components/schemas/PublicMalwareDataSchema"},{"$ref":"#/components/schemas/PublicMalwareAnalysisDataSchema"},{"$ref":"#/components/schemas/PublicNoteDataSchema"},{"$ref":"#/components/schemas/ReportDataSchema"},{"$ref":"#/components/schemas/PublicThreatActorV2DataSchema"},{"$ref":"#/components/schemas/PublicToolDataSchema"},{"$ref":"#/components/schemas/PublicTTPDataSchema"},{"$ref":"#/components/schemas/CustomEntityDataSchema"},{"$ref":"#/components/schemas/EntityDataAPISchema"}],"properties":{"type":{"enum":["attack-pattern","campaign","course-of-action","eclecticiq-sighting","exploit-target","identity","incident","indicator","infrastructure","intrusion-set","location","malware","malware-analysis","note","report","threat-actor","tool","ttp","custom-entity","*"],"type":"string"}},"required":["type"],"type":"object"},"datasets":{"description":"[Collection of] Dataset ID/URL","example":["http://localhost/api/v2/datasets/1"],"items":{"description":"Dataset ID/URL","example":"http://localhost/api/v2/datasets/1"},"type":"array"},"id":{"description":"Internal EclecticIQ entity UUID","format":"uuid","type":"string"},"incoming_feed":{"description":"Incoming feed ID/URL","example":"http://localhost/api/v2/incoming-feeds/1","readOnly":true},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"meta":{"$ref":"#/components/schemas/EntityMetaAPISchema"},"observables":{"description":"Observables are always returned as list of API URLs, but it is also possible to provide them as objects with `type` and `value` attributes - if such objects do not exist, they will be created","example":["http://localhost/api/v2/observables/1"],"items":{"description":"Observable ID/URL","example":"http://localhost/api/v2/observables/1"},"type":"array"},"outgoing_feeds":{"description":"[Collection of] Outgoing feed ID/URL","example":["http://localhost/api/v2/outgoing-feeds/1"],"items":{"description":"Outgoing feed ID/URL","example":"http://localhost/api/v2/outgoing-feeds/1","readOnly":true},"readOnly":true,"type":"array"},"relevancy":{"description":"Entity relevancy, between 0 and 1. It is calculated as 1 / (2 ** (seconds_since_threat_start / half_life_per_day))","maximum":1,"minimum":0,"readOnly":true,"type":"number"},"sources":{"description":"[Collection of] Source associated to this object. (ID/URL) Only the source of type {'group'} can be assigned. But any source types may be returned if assigned by the system, like an incoming feed source.","example":["http://localhost/api/v2/sources/a86de6e0-af20-4a57-93d9-826e1ef4a47a"],"items":{"description":"Source associated to this object. (ID/URL) Only the source of type {'group'} can be assigned. But any source types may be returned if assigned by the system, like an incoming feed source.","example":"http://localhost/api/v2/sources/a86de6e0-af20-4a57-93d9-826e1ef4a47a"},"maxItems":1,"minItems":1,"type":"array"}},"required":["data"],"type":"object"},"EntityAttachmentAPISchema":{"properties":{"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"data":{"description":"Base64 encoded content","writeOnly":true},"download_url":{"description":"The download URL permits to download the binary attachment content directly. It is hard-coded by the server, any value provided is ignored. Deprecation: In the future, this field will be marked as read-only.","format":"url","type":"string"},"entities":{"description":"[Collection of] Entity ID/URL","example":["http://localhost/api/v2/entities/59878720-9dd0-4be3-998f-d667b1b80452"],"items":{"description":"Entity ID/URL","example":"http://localhost/api/v2/entities/59878720-9dd0-4be3-998f-d667b1b80452"},"type":"array"},"filename":{"default":"","type":"string"},"id":{"description":"If no id is provided, a random one is generated.","format":"uuid","type":"string"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"meta":{"type":"object"},"size":{"readOnly":true,"type":"integer"}},"required":["data"],"type":"object"},"EntityConsolidationEventAPISchema":{"properties":{"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"entity_id":{"description":"Entity ID/URL","example":"http://localhost/api/v2/entities/e991ea6f-2a5a-437c-a8d8-00f657c339eb"},"id":{"readOnly":true,"type":"integer"},"method":{"enum":["rule-based","user-assigned"],"type":"string"},"unified_entity_id":{"description":"Entity ID/URL","example":"http://localhost/api/v2/entities/e17c46c0-4a78-444c-a6e1-046fd0484a2b"}},"required":["entity_id","method","unified_entity_id"],"type":"object"},"EntityContentGenerationRefinementSchema":{"properties":{"entity_info":{"type":"string"},"user_query":{"type":"string"}},"required":["entity_info","user_query"],"type":"object"},"EntityContentGenerationRequestSchema":{"properties":{"content_prompt":{"$ref":"#/components/schemas/ContentGenerationPromptAPISchema"},"entities":{"description":"The entities to be used for content generation.","example":["http://localhost/api/v2/entities/b7753b40-704b-446b-a602-e4b2d8c42440"],"items":{"description":"Entity ID/URL","example":"http://localhost/api/v2/entities/b7753b40-704b-446b-a602-e4b2d8c42440"},"maxItems":10,"minItems":1,"type":"array"}},"required":["entities"],"type":"object"},"EntityContentGenerationResponseSchema":{"properties":{"content":{"type":"string"},"title":{"type":"string"}},"type":"object"},"EntityContentRefinementResponseSchema":{"properties":{"refined_content":{"type":"string"}},"type":"object"},"EntityContextualSummarisationSchema":{"properties":{"entities":{"description":"The entity ids to summarize.","example":["http://localhost/api/v2/entities/3c5fdb4e-f737-4b81-a279-705d85c485ea"],"items":{"description":"Entity ID/URL","example":"http://localhost/api/v2/entities/3c5fdb4e-f737-4b81-a279-705d85c485ea"},"maxItems":10,"minItems":1,"type":"array"},"summary_context_question":{"description":"If provided it is used to summarise given entities in the context of the question. It is only applicable to the contextual 'summary_type'.","type":"string"},"summary_type":{"enum":["contextual","strategic","technical","custom"]}},"required":["entities","summary_type"],"type":"object"},"EntityDataAPISchema":{"additionalProperties":true,"properties":{"confidence":{"enum":["unknown","none","high","low","medium"],"type":"string"},"description":{"type":"string"},"description_structuring_format":{"type":"string"},"id":{"description":"STIX ID to uniquely identify the object. If none is specified on an entity payload then the platform will automatically generate a STIX ID in the format `{platform-namespace-url}type-UUID`.","example":"{https://example.com}indicator-da747dd9-5564-44e1-aa24-8b527dfb8868","minLength":1,"type":"string"},"short_description":{"type":"string"},"timestamp":{"description":"Entity timestamp (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"title":{"type":"string"},"type":{"enum":["attack-pattern","campaign","course-of-action","exploit-target","identity","incident","indicator","infrastructure","intrusion-set","location","malware","malware-analysis","report","eclecticiq-sighting","threat-actor","tool","ttp","custom-entity"],"type":"string"}},"required":["title","type"],"type":"object"},"EntityDefaultValuesSchema":{"properties":{"confidence":{"enum":["None","Low","Medium","High","Unknown",null],"nullable":true,"type":"string"},"tlp":{"description":"The values `CLEAR` and `AMBER_STRICT` are also accepted as an input but converted to TLP v1 on the response side.","enum":["NONE","WHITE","GREEN","AMBER","RED"],"nullable":true,"type":"string"}},"type":"object"},"EntityDefinitionAttributeSchema":{"properties":{"attribute":{"allOf":[{"$ref":"#/components/schemas/CustomAttributeSchema"}],"readOnly":true},"custom_attribute_id":{"type":"integer"},"default_value":{"nullable":true},"id":{"type":"integer"}},"required":["custom_attribute_id"],"type":"object"},"EntityDefinitionSchema":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/EntityDefinitionAttributeSchema"},"type":"array"},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"description":{"maxLength":500,"nullable":true,"type":"string"},"has_instances":{"readOnly":true,"type":"boolean"},"id":{"readOnly":true,"type":"integer"},"is_custom":{"readOnly":true,"type":"boolean"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"last_updated_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"name":{"type":"string"},"type":{"type":"string"}},"required":["name","type"],"type":"object"},"EntityDefinitionSummarySchema":{"properties":{"name":{"type":"string"},"type":{"type":"string"}},"type":"object"},"EntityExportByQueryAPISchema":{"properties":{"content_configuration":{"nullable":true},"content_type":{"enum":["urn:stix.mitre.org:xml:1.2","urn:eclecticiq.com:json:3.2","urn:oasis:stix:json:2.1","urn:eclecticiq.com:advanced-csv-entities:1.0","urn:eclecticiq.com:attachments-zip:1.0"],"type":"string"},"entities_query":{"description":"\nFull-text or faceted search with logic operators\nlike `AND` and `OR`.\n\nThe language of the search queries is Lucene and the\ncapability is the same as the one in Intelligence Center\nUI. Read more in [its documentation](\nhttps://docs.eclecticiq.com/ic/3.1.0/get-to-know-the-ic/search/).\n","example":"data.title:malware OR data.description:APT17","nullable":true,"type":"string"},"relational_query":{"allOf":[{"$ref":"#/components/schemas/SimplifiedRelationalQueryAPISchema"}],"nullable":true},"time_zone":{"description":"Timezone in Coordinated Universal Time (UTC) offset format","example":"+01:00 or -08:00","pattern":"[\\+,-][0-9][0-9]:[0-9][0-9]"}},"required":["content_type"],"type":"object"},"EntityMetaAPISchema":{"additionalProperties":true,"properties":{"alias":{"description":"User defined title.","type":"string"},"attacks":{"description":"[Collection of] \nMITRE ATT&CK ID/URL. The parent ATT&CK like a tactic for a technique are not\nincluded except if specifically classified.\n","example":["http://localhost/api/v2/attacks/TA0001:T1078.001"],"items":{"description":"\nMITRE ATT&CK ID/URL. The parent ATT&CK like a tactic for a technique are not\nincluded except if specifically classified.\n","example":"http://localhost/api/v2/attacks/TA0001:T1078.001"},"type":"array"},"estimated_observed_time":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"estimated_threat_end_time":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"estimated_threat_start_time":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"first_ingest_time":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"half_life":{"maximum":10000000,"minimum":1,"type":"integer"},"ingest_time":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"is_contributor_to":{"description":"If set, this entity contributes to the unified entity specified by the STIX ID","readOnly":true,"type":"string"},"is_exempt_from_consolidation":{"description":"Set to True if this entity is exempt from automatic consolidation","readOnly":true,"type":"boolean"},"is_outdated_version":{"description":"Set to true if a newer version exists for this entity","readOnly":true,"type":"boolean"},"is_unified_entity":{"description":"Set to True if this entity is a result of consolidation rule run","readOnly":true,"type":"boolean"},"is_unresolved_idref":{"readOnly":true,"type":"boolean"},"report_template":{"allOf":[{"$ref":"#/components/schemas/ReportTemplateSummarySchema"}],"description":"Basic metadata of the associated report template","nullable":true},"source_reliability":{"enum":["A","B","C","D","E","F",null],"nullable":true,"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"taxonomies":{"description":"[Collection of] Taxonomy ID, URL or path expressed as a lists of strings","example":["http://localhost/api/v2/taxonomies/1"],"items":{"description":"Taxonomy ID, URL or path expressed as a lists of strings","example":"http://localhost/api/v2/taxonomies/1"},"type":"array"},"title":{"description":"Displayable title computed between multiple candidate fields: ``data.title`` and ``meta.alias``.","readOnly":true,"type":"string"},"tlp_color":{"description":"The current TLP value.\n\nThe values `CLEAR` and `AMBER_STRICT` are also accepted as an input but converted to TLP v1 on the response side.","enum":["NONE","WHITE","GREEN","AMBER","RED"],"nullable":true,"type":"string"}},"type":"object"},"EntityQuickSummaryResponseSchema":{"properties":{"summary":{"type":"string"}},"required":["summary"],"type":"object"},"EntityQuickSummarySchema":{"properties":{"entity":{"description":"The entity id to summarize.","example":"http://localhost/api/v2/entities/814c5d00-e382-4a34-abbf-50e8937646b9"}},"required":["entity"],"type":"object"},"EntityReportGenerationRequestSchema":{"properties":{"custom_report_template":{"description":"\nWhen the `report_type` is custom, you must provide the report template in HTML format.\nElse you must not provide it.\n\nAn example:\n\n```html\n<html><body>\n<h1>Summary:</h1>\n<Overall summary of all entities>\n(Example: Threat actor APT29 uses malware ALPHV to attack organisations\nin the healthcare industry. ALPHV is known to use vulnerabilities in\ntechnologies X, Y, and Z.\n\n<h2>Risks and mitigations:</h2>\n<List of risks and mitigations>\n(Example: The ALPHV\nmalware is known to use vulnerabilities in support ticket systems\nto gain access to networks. These systems should be kept up to date\nand their access heavily restricted.)\n\n<h2>MITRE ATT&CK Techniques:</h2>\n<List of ATT&CK techniques>\n(Example: Defense Evasion: Modify Registry (T1112)Lateral Movement:\nLateral Tool Transfer (T1570)) (If no ATT&CK techniques are available,\njust say \"Unknown\")\n\n<h2>Indicators</h2>\nType: Value\nType: Value\nType: Value\n</body> </html>\n```\n","type":"string"},"custom_summary_content_instruction":{"description":"\nWhen the `report_type` is custom, you must provide the instruction.\nElse you must not provide it.\n\nExample:\n\n```\nYou must summarise the intelligence entity data delimited by triple commas into a single\nreport written for a strategic audience such as a CISO or other non-technical decision\nmaker.\n\nProvide four to five paragraphs summarising the provided intelligence information. Do\nnot list or describe the quantities of the entities. The report must focus on describing\nthe overall picture from the data, including a summary of the risk and possible\nmitigations.\n\nIf any of the provided entities include MITRE ATT&CK techniques or indicators of\ncompromise, or vulnerabilities, list these after the summary.\n\nAssume that all the entities provided to you are related to each other. For example if\nyou are provided with a threat actor and a malware, assume that the malware is used by\nthat threat actor. If a threat actor or malware has metadata including industry tags,\nassume that actor or malware targets that industry. If a malware is provided with one or\nmore vulnerabilities, assume that the malware exploits those vulnerabilities.\n\nIf threat report entities are provided, they may provide additional similar insights.\n\nWhen summarising entities, be concise. As an example, if a report describes a threat\nactor, summarise the malware and tools they use, their victims, the vulnerabilities they\nexploit, and recent activity.\n\nOnly use intelligence information provided when summarising, do not add new information.\nDo not make overly generic statements such as \"implement better security\", use specifics\nif available.\n\nIf you are not provided with sufficient data to summarise, briefly summarise the\navailable data as a single paragraph and any lists of IOCs or ATT&CK techniques, and\ncomment that further investigation is required. For example if a threat actor entity is\nprovided but has no description, comment that further research is required.\n```\n","type":"string"},"entities":{"description":"The entity ids to summarize in the report.","example":["http://localhost/api/v2/entities/b39be349-76fd-4d9c-bb65-5c51bd0b4566"],"items":{"description":"Entity ID/URL","example":"http://localhost/api/v2/entities/b39be349-76fd-4d9c-bb65-5c51bd0b4566"},"maxItems":10,"minItems":1,"type":"array"},"observables":{"description":"The observable ids to summarize in the report.","example":["http://localhost/api/v2/observables/1"],"items":{"description":"Observable ID/URL","example":"http://localhost/api/v2/observables/1"},"maxItems":20,"minItems":0,"type":"array"},"report_title":{"description":"Define manually the report title instead of using the one generated by the AI.","type":"string"},"summary_type":{"enum":["strategic","technical","custom"],"type":"string"}},"required":["entities","summary_type"],"type":"object"},"EntityRuleAPISchema":{"properties":{"actions":{"description":"List of actions that the rule should perform on each entity. Supported: ['add_tags', 'add_to_set', 'override_tlp', 'set_alias', 'convert_to_eiqjson2', 'remove_tags']","enum":["add_tags","add_to_set","override_tlp","set_alias","convert_to_eiqjson2","remove_tags"],"items":{"type":"string"},"type":"array"},"add_tags":{"description":"List of tags that should be added to the matched entities if `add_tags` is included in the list of actions","items":{"type":"string"},"type":"array"},"add_taxonomies":{"description":"List of taxonomies that should be added to the matched entities if `add_tags` is included in the list of actions","example":["http://localhost/api/v2/taxonomies/1"],"items":{"description":"Taxonomy ID, URL or path expressed as a lists of strings","example":"http://localhost/api/v2/taxonomies/1"},"type":"array"},"alias_formatting_template":{"description":"Template to be applied to the entity meta.alias field, e.g. `malware={malware}, url={url}, ip={ip}`","nullable":true,"type":"string"},"content_criteria":{"nullable":true},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"datasets":{"description":"List of the datasets associated to this rule","example":["http://localhost/api/v2/datasets/1"],"items":{"description":"Dataset ID/URL","example":"http://localhost/api/v2/datasets/1"},"type":"array"},"description":{"nullable":true,"type":"string"},"eiqjson2_entity_type":{"description":"Target type for `convert_to_eiqjson2` action. Supported: ('attack-pattern', 'identity', 'infrastructure', 'intrusion-set', 'malware', 'malware-family', 'tool')","enum":["attack-pattern","identity","infrastructure","intrusion-set","malware","malware-family","tool",null],"nullable":true,"type":"string"},"entity_types":{"description":"Types of entities matched by the rule","items":{"enum":["attack-pattern","campaign","course-of-action","exploit-target","identity","incident","indicator","infrastructure","intrusion-set","location","malware","malware-analysis","report","eclecticiq-sighting","threat-actor","tool","ttp","custom-entity"],"type":"string"},"type":"array"},"id":{"readOnly":true,"type":"integer"},"is_active":{"type":"boolean"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"master_entity":{"description":"URL of the rule master entity","example":"http://localhost/api/v2/entities/ff4f1956-76af-44b6-9713-8635b3f55020","nullable":true},"name":{"type":"string"},"override_tlp":{"description":"The values `CLEAR` and `AMBER_STRICT` are also accepted as an input but converted to TLP v1 on the response side.","enum":["NONE","WHITE","GREEN","AMBER","RED"],"nullable":true,"type":"string"},"remove_tags":{"description":"List of tags that should be removed from the matched entities if `remove_tags` is included in the list of actions","items":{"type":"string"},"type":"array"},"remove_taxonomies":{"description":"List of taxonomies that should be removed from the matched entities if `remove_tags` is included in the list of actions","example":["http://localhost/api/v2/taxonomies/1"],"items":{"description":"Taxonomy ID, URL or path expressed as a lists of strings","example":"http://localhost/api/v2/taxonomies/1"},"type":"array"},"sources":{"description":"List of sources matched by the rule","example":["http://localhost/api/v2/sources/78063112-fe91-4db8-ac0a-58b6e095d75a"],"items":{"description":"Source associated to this object. (ID/URL)","example":"http://localhost/api/v2/sources/78063112-fe91-4db8-ac0a-58b6e095d75a"},"type":"array"},"status":{"description":"Status of the latest rule task execution","enum":["PENDING","SENT","STARTED","RETRY","FAILURE","REVOKED","CAP_REACHED","WARNING","SUCCESS",null],"nullable":true,"readOnly":true,"type":"string"},"task":{"description":"Task associated to this rule","example":"http://localhost/api/v2/tasks/1","readOnly":true},"tlps":{"description":"List of TLPs that the rule should match","items":{"description":"The values `CLEAR` and `AMBER_STRICT` are also accepted as an input but converted to TLP v1 on the response side.","enum":["NONE","WHITE","GREEN","AMBER","RED"],"nullable":true,"type":"string"},"type":"array"}},"required":["actions","is_active","name"],"type":"object"},"EntitySummaryGenerationResponseSchema":{"properties":{"description":{"type":"string"},"title":{"type":"string"}},"type":"object"},"EntityWebEnrichmentOutputSchema":{"properties":{"description":{"items":{"type":"string"},"type":"array"},"key_highlights":{"items":{"$ref":"#/components/schemas/KeyHighlightSchema"},"type":"array"},"related_entities":{"items":{"$ref":"#/components/schemas/RelatedEntitySchema"},"type":"array"},"sources":{"items":{"$ref":"#/components/schemas/WebEnrichmentSourceSchema"},"type":"array"},"title":{"type":"string"}},"type":"object"},"EntityWebEnrichmentRefinementResponseSchema":{"properties":{"refinement_output":{"type":"string"}},"type":"object"},"EntityWebEnrichmentRefinementSchema":{"properties":{"chat_history":{"description":"Chat history for enrichment refinement.","items":{"$ref":"#/components/schemas/ChatHistoryItemSchema1"},"type":"array"},"enrichment_output":{"$ref":"#/components/schemas/EntityWebEnrichmentOutputSchema"},"user_query":{"type":"string"}},"required":["chat_history","enrichment_output","user_query"],"type":"object"},"EntityWebEnrichmentResponseSchema":{"properties":{"description":{"items":{"type":"string"},"type":"array"},"key_highlights":{"items":{"$ref":"#/components/schemas/KeyHighlightSchema"},"type":"array"},"related_entities":{"items":{"$ref":"#/components/schemas/RelatedEntitySchema"},"type":"array"},"sources":{"items":{"$ref":"#/components/schemas/WebEnrichmentSourceSchema"},"type":"array"},"title":{"type":"string"}},"type":"object"},"EntityWebEnrichmentSchema":{"properties":{"entity":{"description":"The entity id to enrich.","example":"http://localhost/api/v2/entities/beb29516-77de-412f-a784-f02743794023"}},"required":["entity"],"type":"object"},"ExploitTargetDataSchema":{"additionalProperties":true,"properties":{"confidence":{"enum":["unknown","none","high","low","medium"],"type":"string"},"configurations":{"items":{"$ref":"#/components/schemas/ConfigurationSchema"},"type":"array"},"custom_attributes":{},"description":{"type":"string"},"description_structuring_format":{"type":"string"},"id":{"description":"STIX ID to uniquely identify the object. If none is specified on an entity payload then the platform will automatically generate a STIX ID in the format `{platform-namespace-url}type-UUID`.","example":"{https://example.com}indicator-da747dd9-5564-44e1-aa24-8b527dfb8868","minLength":1,"type":"string"},"information_source":{"$ref":"#/components/schemas/InformationSourceAPISchema"},"short_description":{"type":"string"},"timestamp":{"description":"Entity timestamp (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"title":{"type":"string"},"type":{"enum":["attack-pattern","campaign","course-of-action","exploit-target","identity","incident","indicator","infrastructure","intrusion-set","location","malware","malware-analysis","report","eclecticiq-sighting","threat-actor","tool","ttp","custom-entity"],"type":"string"},"vulnerabilities":{"items":{"$ref":"#/components/schemas/VulnerabilitiesSchema"},"type":"array"},"weaknesses":{"items":{"$ref":"#/components/schemas/WeaknessSchema"},"type":"array"}},"required":["title","type"],"type":"object"},"ExportBlockSchema":{"properties":{"content_type":{"type":"string"},"created_at":{"format":"date-time","readOnly":true,"type":"string"},"filename":{"readOnly":true,"type":"string"},"id":{"type":"integer"},"run_id":{"readOnly":true,"type":"string"},"size":{"readOnly":true,"type":"integer"}},"required":["content_type"],"type":"object"},"ExternalReferenceSchema":{"properties":{"description":{"type":"string"},"external_id":{"type":"string"},"hashes":{"additionalProperties":{"type":"string"},"type":"object"},"source_name":{"type":"string"},"url":{"type":"string"}},"required":["source_name"],"type":"object"},"ExtractCsvSchema":{"properties":{"include_fields":{"items":{"type":"string"},"type":"array"}},"type":"object"},"FeatureFlagSchema":{"properties":{"inactive_entities_enabled":{"default":false,"type":"boolean"},"is_terminology_customization_enabled":{"default":false,"type":"boolean"},"property_propagation":{"default":false,"type":"boolean"}},"type":"object"},"FeedAPISchema":{"properties":{"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"last_triggered_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"name":{"type":"string"},"status":{"description":"Status of the latest feed run","enum":["PENDING","SENT","STARTED","RETRY","FAILURE","REVOKED","CAP_REACHED","WARNING","SUCCESS"],"readOnly":true,"type":"string"},"tlp_color_override":{"description":"The values `CLEAR` and `AMBER_STRICT` are also accepted as an input but converted to TLP v1 on the response side.","enum":["NONE","WHITE","GREEN","AMBER","RED"],"nullable":true,"type":"string"},"transport_access_details":{"readOnly":true,"type":"string"}},"required":["name"],"type":"object"},"FileAPISchema":{"properties":{"content_type":{"default":"application/octet-stream","description":"MIME type or platform content type for this file","example":"application/octet-stream","type":"string"},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"URL of the user that created this workspace","example":"http://localhost/api/v2/users/1","readOnly":true},"data":{"description":"Base64-encoded representation of the file content. If the content type is associated to structured intelligence on the platform then any entities and observables included in the file will be processed by the platform.","example":"hSRyRN1chKKWPA==\n"},"download_url":{"description":"Download link for the file","format":"url","readOnly":true,"type":"string"},"filename":{"type":"string"},"hash":{"description":"File content hash (it must be unique for each workspace)","readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"is_public":{"description":"Public files in public workspaces can be accessed by any user with `read files` permissions","type":"boolean"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"size":{"description":"File size in bytes","readOnly":true,"type":"integer"},"workspace":{"description":"Workspace ID/URL","example":"http://localhost/api/v2/workspaces/1"}},"required":["data","filename","hash"],"type":"object"},"FilteringCriteriaSchema":{"properties":{"entity_types":{"description":"Types of entities matched by the rule","items":{"enum":["malware","threat-actor","report"],"type":"string"},"type":"array"},"sources":{"description":"List of sources matched by the rule","example":["http://localhost/api/v2/sources/36eeecc3-5328-4171-ad1e-9fd86e6898b2"],"items":{"description":"Source associated to this object. (ID/URL)","example":"http://localhost/api/v2/sources/36eeecc3-5328-4171-ad1e-9fd86e6898b2"},"type":"array"},"tags":{"description":"List of tags that the rule should match","items":{"type":"string"},"type":"array"},"taxonomies":{"description":"List of taxonomies that the rule should match","example":["http://localhost/api/v2/taxonomies/1"],"items":{"description":"Taxonomy ID, URL or path expressed as a lists of strings","example":"http://localhost/api/v2/taxonomies/1"},"type":"array"},"tlps":{"description":"List of TLPs that the rule should match","items":{"description":"The values `CLEAR` and `AMBER_STRICT` are also accepted as an input but converted to TLP v1 on the response side.","enum":["NONE","WHITE","GREEN","AMBER","RED"],"nullable":true,"type":"string"},"type":"array"}},"type":"object"},"FilteringCriteriaSchema1":{"properties":{"content_criteria":{"nullable":true},"entity_types":{"description":"Types of entities matched by the rule","items":{"enum":["identity","observable-wrapper","infrastructure","location","course-of-action","intrusion-set","eclecticiq-sighting","campaign","note","malware-analysis","custom-entity","exploit-target","indicator","package","report","tool","threat-actor","incident","malware","ttp","attack-pattern"],"type":"string"},"minItems":1,"type":"array"},"related_entity_sources":{"description":"List of sources matched by the related entity","example":["http://localhost/api/v2/sources/fcad1414-30b9-40ee-99f2-64c5308b9690"],"items":{"description":"Source associated to this object. (ID/URL)","example":"http://localhost/api/v2/sources/fcad1414-30b9-40ee-99f2-64c5308b9690"},"type":"array"},"related_entity_tlps":{"description":"List of TLPs that the related entity should match","items":{"description":"The values `CLEAR` and `AMBER_STRICT` are also accepted as an input but converted to TLP v1 on the response side.","enum":["NONE","WHITE","GREEN","AMBER","RED"],"nullable":true,"type":"string"},"type":"array"},"related_entity_types":{"description":"Types of related entities matched by the rule","items":{"enum":["identity","observable-wrapper","infrastructure","location","course-of-action","intrusion-set","eclecticiq-sighting","campaign","note","malware-analysis","custom-entity","exploit-target","indicator","package","report","tool","threat-actor","incident","malware","ttp","attack-pattern"],"type":"string"},"minItems":1,"type":"array"},"related_observable_types":{"description":"Types of observable types for getting related entities","items":{"enum":["ja3-full","hash-md5","ipv4-cidr","certificate-hash","malware-key","hash-sha384","inetnum","cwe","ipv4","hash-sha224","snort","certificate-serial-number","account-id","handle","certificate-subject","user-agent","person","hash-imphash","process","country","street","name","mutex","container-image-name","certificate-issuer","card","ipv6","organization","host","hash-ssdeep","city","cpu-architecture","uri-hash-sha256","bank-account","domain","ja3s-hash","card-owner","process-name","address","netname","email-subject","jarm","hash-rich-pe-header","geo-long","asn","registrar","email","product","forum-room","ja3-hash","rule","container-registry-account-name","country-code","file","yara","port","industry","forum-thread","winregistry","user-account","region","telephone","hash-vhash","container-cluster-name","device-fingerprint","hash-authentihash","hash-sha256","cloud-storage-bucket","cce","ipv6-cidr","ssh-public-key","nationality","eui-64","ja3s-full","cve","actor-id","geo-lat","hash-sha512","postcode","company","forum-name","geo","hash-sha1","mac-48","file-size","fox-it-portal-uri","uri","malware","crypto-address"],"type":"string"},"type":"array"},"related_through_entities_entity_types":{"description":"Filter for related through entities","items":{"enum":["identity","observable-wrapper","infrastructure","location","course-of-action","intrusion-set","eclecticiq-sighting","campaign","note","malware-analysis","custom-entity","exploit-target","indicator","package","report","tool","threat-actor","incident","malware","ttp","attack-pattern"],"type":"string"},"type":"array"},"sources":{"description":"List of sources matched by the rule","example":["http://localhost/api/v2/sources/90c2ed53-78fa-4bbd-97a3-e100be39d351"],"items":{"description":"Source associated to this object. (ID/URL)","example":"http://localhost/api/v2/sources/90c2ed53-78fa-4bbd-97a3-e100be39d351"},"type":"array"},"tags":{"description":"List of tags that the rule should match","items":{"type":"string"},"type":"array"},"taxonomies":{"description":"List of taxonomies that the rule should match","example":["http://localhost/api/v2/taxonomies/1"],"items":{"description":"Taxonomy ID, URL or path expressed as a lists of strings","example":"http://localhost/api/v2/taxonomies/1"},"type":"array"},"tlps":{"description":"List of TLPs that the rule should match","items":{"description":"The values `CLEAR` and `AMBER_STRICT` are also accepted as an input but converted to TLP v1 on the response side.","enum":["NONE","WHITE","GREEN","AMBER","RED"],"nullable":true,"type":"string"},"type":"array"}},"type":"object"},"FontFamilySchema":{"properties":{"category":{"readOnly":true,"type":"string"},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"fonts":{"items":{"$ref":"#/components/schemas/FontSchema"},"type":"array"},"id":{"readOnly":true,"type":"integer"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"last_updated_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"name":{"readOnly":true,"type":"string"}},"type":"object"},"FontSchema":{"properties":{"data":{"type":"string","writeOnly":true},"id":{"readOnly":true,"type":"integer"},"name":{"readOnly":true,"type":"string"},"style":{"readOnly":true,"type":"string"},"url":{"readOnly":true},"weight":{"readOnly":true,"type":"string"}},"type":"object"},"GenericTestMechanismTypeSchema":{"properties":{"description":{"type":"string"},"efficacy":{"$ref":"#/components/schemas/TestMechanismEfficacySchema"},"generic_test_mechanism_type":{"enum":["pcre","sigma","stix","suricata"],"type":"string"},"producer":{"$ref":"#/components/schemas/ProducerSchema"},"specification":{"$ref":"#/components/schemas/ValueSchema"},"test_mechanism_type":{"enum":["generic","snort","yara"],"type":"string"},"type":{"default":"test-mechanism","description":"Constant field, must have a value of \"test-mechanism\"","type":"string"}},"required":["generic_test_mechanism_type","test_mechanism_type"],"type":"object"},"GenericVocabSchema":{"properties":{"value":{"type":"string"},"vocab":{"type":"string"}},"required":["value"],"type":"object"},"GroupAPISchema":{"properties":{"created_at":{"description":"User group creation date (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"description":{"type":"string"},"id":{"description":"Group ID","readOnly":true,"type":"integer"},"last_updated_at":{"description":"User group last update date (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"name":{"description":"Group name","example":"admin","type":"string"},"sources":{"description":"List of sources this group is allowed to access. Possible TLP values: ('NONE', 'WHITE', 'CLEAR', 'GREEN', 'AMBER', 'AMBER_STRICT', 'RED')","example":["http://localhost/api/v2/sources/c2e100ba-4aa5-442a-b041-b71407b09421?allowed_tlp=RED"],"items":{"description":"Allowed source with (optional) TLP color filter","example":"http://localhost/api/v2/sources/c2e100ba-4aa5-442a-b041-b71407b09421?allowed_tlp=RED"},"type":"array"},"users":{"description":"List of users associated to this group. This is only visible if you have the \"read users\" permission or if you are an administrator of the group.","example":["http://localhost/api/v2/users/1?role=member"],"items":{"description":"User ID/URL associated to a group,together with its role. Possible values: ('member', 'admin'))","example":"http://localhost/api/v2/users/1?role=member","readOnly":true},"readOnly":true,"type":"array"}},"required":["id","name"],"type":"object"},"HeaderFooterSectionSchema":{"properties":{"id":{"type":"integer"},"meta":{"type":"object"},"position":{"enum":["left","center","right"],"type":"string"},"type":{"enum":["do_not_display","date","page_no","tlp","image"],"type":"string"},"value":{"nullable":true,"type":"string"}},"required":["id"],"type":"object"},"IdentityClassVocabSchema":{"properties":{"value":{"enum":["individual","group","system","organization","class","unknown"],"type":"string"},"vocab":{"default":"identity-class-ov","description":"Constant field, must have a value of \"identity-class-ov\"","type":"string"}},"required":["value"],"type":"object"},"IdentitySchema":{"properties":{"id":{"type":"string"},"idref":{"type":"string"},"name":{"type":"string"},"type":{"default":"identity","description":"Constant field, must have a value of \"identity\"","type":"string"}},"required":["type"],"type":"object"},"IdentitySchema1":{"properties":{"identity_type":{"default":"ciq","description":"Constant field, must have a value of \"ciq\"","type":"string"},"name":{"nullable":true,"type":"string"},"specification_xml":{"type":"string"},"specification_xml_type":{"default":"{http://stix.mitre.org/extensions/Identity#CIQIdentity3.0-1}STIXCIQIdentity3.0Type","description":"Constant field, must have a value of \"{http://stix.mitre.org/extensions/Identity#CIQIdentity3.0-1}STIXCIQIdentity3.0Type\"","type":"string"},"type":{"default":"identity","description":"Constant field, must have a value of \"identity\"","type":"string"}},"type":"object"},"ImpactAssessmentEffectsSchema":{"properties":{"value":{"enum":["Brand or Image Degradation","Data Breach or Compromise","Degradation of Service","Destruction","Disruption of Service / Operations","Financial Loss","Loss of Competitive Advantage","Loss of Competitive Advantage - Economic","Loss of Competitive Advantage - Military","Loss of Competitive Advantage - Political","Loss of Confidential / Proprietary Information or Intellectual Property","Regulatory, Compliance or Legal Impact","Unintended Access","User Data Loss"],"type":"string"},"value_vocab":{"default":"{http://stix.mitre.org/default_vocabularies-1}IncidentEffectVocab-1.0","description":"Constant field, must have a value of \"{http://stix.mitre.org/default_vocabularies-1}IncidentEffectVocab-1.0\"","type":"string"}},"type":"object"},"ImpactAssessmentSchema":{"properties":{"direct_impact_summary_asset_losses":{"enum":["Major","Minor","Moderate","None"],"type":"string"},"direct_impact_summary_business_mission_disruption":{"enum":["Major","Minor","Moderate","None"],"type":"string"},"direct_impact_summary_response_and_recovery_costs":{"enum":["Major","Minor","Moderate","None"],"type":"string"},"effects":{"items":{"$ref":"#/components/schemas/ImpactAssessmentEffectsSchema"},"type":"array"},"impact_qualification":{"enum":["Insignificant","Distracting","Painful","Damaging","Catastrophic","Unknown"],"type":"string"},"indirect_impact_summary_brand_and_market_damage":{"enum":["No","Suspected","Unknown","Yes"],"type":"string"},"indirect_impact_summary_increased_operating_costs":{"enum":["No","Suspected","Unknown","Yes"],"type":"string"},"indirect_impact_summary_legal_and_regulatory_costs":{"enum":["No","Suspected","Unknown","Yes"],"type":"string"},"indirect_impact_summary_loss_of_competitive_advantage":{"enum":["No","Suspected","Unknown","Yes"],"type":"string"},"total_loss_estimation_actual_amount":{"type":"string"},"total_loss_estimation_actual_iso_currency_code":{"type":"string"},"total_loss_estimation_initial_reported_amount":{"type":"string"},"total_loss_estimation_initial_reported_iso_currency_code":{"type":"string"},"type":{"default":"impact-assessment","description":"Constant field, must have a value of \"impact-assessment\"","type":"string"}},"type":"object"},"ImpactOrCostOrEfficacySchema":{"properties":{"confidence":{"enum":["unknown","none","high","low","medium"],"type":"string"},"description":{"type":"string"},"type":{"default":"statement","description":"Constant field, must have a value of \"statement\"","type":"string"},"value":{"enum":["High","Low","Medium","None","Unknown"],"type":"string"}},"required":["value"],"type":"object"},"ImplementationLanguageVocabSchema":{"properties":{"value":{"enum":["applescript","bash","c","c++","c#","go","java","javascript","lua","objective-c","perl","php","powershell","python","ruby","scala","swift","typescript","visual-basic","x86-32","x86-64"],"type":"string"},"vocab":{"default":"implementation-language-ov","description":"Constant field, must have a value of \"implementation-language-ov\"","type":"string"}},"required":["value"],"type":"object"},"IncidentCategoriesSchema":{"properties":{"value":{"enum":["Denial of Service","Exercise/Network Defense Testing","Improper Usage","Investigation","Malicious Code","Scans/Probes/Attempted Access","Unauthorized Access"],"type":"string"}},"required":["value"],"type":"object"},"IncidentDataSchema":{"additionalProperties":true,"properties":{"affected_assets":{"items":{"$ref":"#/components/schemas/AffectedAssetsSchema"},"type":"array"},"categories":{"items":{"$ref":"#/components/schemas/IncidentCategoriesSchema"},"type":"array"},"confidence":{"enum":["unknown","none","high","low","medium"],"type":"string"},"contacts":{"items":{"$ref":"#/components/schemas/IncidentInformationSourceSchema"},"type":"array"},"coordinators":{"items":{"$ref":"#/components/schemas/IncidentInformationSourceSchema"},"type":"array"},"custom_attributes":{},"description":{"type":"string"},"description_structuring_format":{"type":"string"},"discovery_methods":{"items":{"$ref":"#/components/schemas/IncidentDiscoveryMethods"},"type":"array"},"id":{"description":"STIX ID to uniquely identify the object. If none is specified on an entity payload then the platform will automatically generate a STIX ID in the format `{platform-namespace-url}type-UUID`.","example":"{https://example.com}indicator-da747dd9-5564-44e1-aa24-8b527dfb8868","minLength":1,"type":"string"},"impact_assessment":{"$ref":"#/components/schemas/ImpactAssessmentSchema"},"information_source":{"$ref":"#/components/schemas/InformationSourceAPISchema"},"intended_effects":{"items":{"$ref":"#/components/schemas/IntendedEffectSchema"},"type":"array"},"reporter":{"$ref":"#/components/schemas/IncidentInformationSourceSchema"},"responders":{"items":{"$ref":"#/components/schemas/IncidentInformationSourceSchema"},"type":"array"},"security_compromise":{"enum":["No","Suspected","Unknown","Yes"],"type":"string"},"short_description":{"type":"string"},"status":{"enum":["Closed","Containment Achieved","Deleted","Incident Reported","New","Open","Rejected","Restoration Achieved","Stalled"],"type":"string"},"time_containment_achieved":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"time_containment_achieved_precision":{"type":"string"},"time_first_data_exfiltration":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"time_first_data_exfiltration_precision":{"type":"string"},"time_first_malicious_action":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"time_first_malicious_action_precision":{"type":"string"},"time_incident_closed":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"time_incident_closed_precision":{"type":"string"},"time_incident_discovery":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"time_incident_discovery_precision":{"type":"string"},"time_incident_opened":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"time_incident_opened_precision":{"type":"string"},"time_incident_reported":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"time_incident_reported_precision":{"type":"string"},"time_initial_compromise":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"time_initial_compromise_precision":{"type":"string"},"time_restoration_achieved":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"time_restoration_achieved_precision":{"type":"string"},"timestamp":{"description":"Entity timestamp (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"title":{"type":"string"},"type":{"enum":["attack-pattern","campaign","course-of-action","exploit-target","identity","incident","indicator","infrastructure","intrusion-set","location","malware","malware-analysis","report","eclecticiq-sighting","threat-actor","tool","ttp","custom-entity"],"type":"string"},"victims":{"items":{"$ref":"#/components/schemas/IdentitySchema1"},"type":"array"}},"required":["title","type"],"type":"object"},"IncidentDiscoveryMethods":{"properties":{"value":{"enum":["Agent Disclosure","Antivirus","Audit","Customer","Financial Audit","Fraud Detection","HIPS","IT Audit","Incident Response","Law Enforcement","Log Review","Monitoring Service","NIDS","Security Alarm","Unknown","Unrelated Party","User"],"type":"string"},"value_vocab":{"default":"{http://stix.mitre.org/default_vocabularies-1}DiscoveryMethodVocab-1.0","description":"Constant field, must have a value of \"{http://stix.mitre.org/default_vocabularies-1}DiscoveryMethodVocab-1.0\"","type":"string"}},"type":"object"},"IncidentInformationSourceRolesSchema":{"properties":{"value":{"enum":["Aggregator","Content Enhancer/Refiner","Initial Author","Transformer/Translator"],"type":"string"},"value_vocab":{"default":"{http://stix.mitre.org/default_vocabularies-1}InformationSourceRoleVocab-1.0","description":"Constant field, must have a value of \"{http://stix.mitre.org/default_vocabularies-1}InformationSourceRoleVocab-1.0\"","type":"string"}},"type":"object"},"IncidentInformationSourceSchema":{"properties":{"description":{"type":"string"},"identity":{"$ref":"#/components/schemas/IdentitySchema1"},"roles":{"items":{"$ref":"#/components/schemas/IncidentInformationSourceRolesSchema"},"minItems":1,"type":"array"},"type":{"default":"information-source","description":"Constant field, must have a value of \"information-source\"","type":"string"}},"required":["roles"],"type":"object"},"IncomingFeedAPISchema":{"properties":{"archive_password":{"default":null,"nullable":true,"type":"string"},"content_type":{"enum":["urn:spycloud.io:json:1.0","urn:spycloud.io:data-json:1.0","urn:eclecticiq.com:advanced-csv-entities:1.0"],"type":"string"},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"execution_schedule":{"allOf":[{"$ref":"#/components/schemas/TaskExecutionScheduleSchema"}],"nullable":true},"half_life":{"type":"object"},"id":{"readOnly":true,"type":"integer"},"is_being_purged":{"readOnly":true,"type":"boolean"},"last_triggered_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"n_blobs_error":{"readOnly":true,"type":"integer"},"n_blobs_pending":{"readOnly":true,"type":"integer"},"n_blobs_success":{"readOnly":true,"type":"integer"},"n_ingested_entities":{"readOnly":true,"type":"integer"},"name":{"type":"string"},"organisation":{"nullable":true,"type":"string"},"require_content_validation":{"type":"boolean"},"require_link_types":{"type":"boolean"},"require_valid_signature":{"type":"boolean"},"source":{"description":"Source associated to this feed","example":"http://localhost/api/v2/sources/25e5cebc-6cd5-4b0f-a485-5aa96ee86c90","readOnly":true},"status":{"description":"Status of the latest feed run","enum":["PENDING","SENT","STARTED","RETRY","FAILURE","REVOKED","CAP_REACHED","WARNING","SUCCESS"],"readOnly":true,"type":"string"},"task":{"description":"Task associated to this feed","example":"http://localhost/api/v2/tasks/1","readOnly":true},"tlp_color_override":{"description":"The values `CLEAR` and `AMBER_STRICT` are also accepted as an input but converted to TLP v1 on the response side.","enum":["NONE","WHITE","GREEN","AMBER","RED"],"nullable":true,"type":"string"},"transport_access_details":{"readOnly":true,"type":"string"},"transport_configuration":{"description":"Configuration specific for the selected feed transport","nullable":true},"transport_error":{"readOnly":true},"transport_type":{"enum":["eiq.incoming-transports.spycloud","eiq.incoming-transports.fetch_spycloud_data","eiq.incoming-transports.advanced_csv_provider"],"type":"string"}},"required":["content_type","name","transport_configuration","transport_type"],"type":"object"},"IndicatorDataSchema":{"additionalProperties":true,"properties":{"confidence":{"enum":["unknown","none","high","low","medium"],"type":"string"},"custom_attributes":{},"description":{"type":"string"},"description_structuring_format":{"type":"string"},"id":{"description":"STIX ID to uniquely identify the object. If none is specified on an entity payload then the platform will automatically generate a STIX ID in the format `{platform-namespace-url}type-UUID`.","example":"{https://example.com}indicator-da747dd9-5564-44e1-aa24-8b527dfb8868","minLength":1,"type":"string"},"likely_impact":{"$ref":"#/components/schemas/IndicatorLikelyImpactSchema"},"producer":{"$ref":"#/components/schemas/InformationSourceAPISchema"},"short_description":{"type":"string"},"sightings_count":{"minimum":0,"type":"integer"},"test_mechanisms":{"description":"If no \"Test mechanism\" is populated, and if this indicator isn't linked to an observable that is included or allowed when creating an outgoing feed, this indicator won't have a \"Pattern\", and will be skipped when exporting in STIX 2.1 format.","items":{"description":"This object will be validated with a schema selected based on the value of the \"test_mechanism_type\" property.","discriminator":{"mapping":{"generic":"#/components/schemas/GenericTestMechanismTypeSchema","snort":"#/components/schemas/SnortTestMechanismTypeSchema","yara":"#/components/schemas/YaraTestMechanismTypeSchema"},"propertyName":"test_mechanism_type"},"oneOf":[{"$ref":"#/components/schemas/SnortTestMechanismTypeSchema"},{"$ref":"#/components/schemas/YaraTestMechanismTypeSchema"},{"$ref":"#/components/schemas/GenericTestMechanismTypeSchema"}],"properties":{"test_mechanism_type":{"enum":["snort","yara","generic"],"type":"string"}},"required":["test_mechanism_type"],"type":"object"},"type":"array"},"timestamp":{"description":"Entity timestamp (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"title":{"type":"string"},"type":{"enum":["attack-pattern","campaign","course-of-action","exploit-target","identity","incident","indicator","infrastructure","intrusion-set","location","malware","malware-analysis","report","eclecticiq-sighting","threat-actor","tool","ttp","custom-entity"],"type":"string"},"types":{"items":{"$ref":"#/components/schemas/IndicatorTypesSchema"},"type":"array"},"valid_time_positions":{"items":{"$ref":"#/components/schemas/TimeWindowSchema"},"type":"array"}},"required":["title","type"],"type":"object"},"IndicatorLikelyImpactSchema":{"properties":{"type":{"default":"statement","description":"Constant field, must have a value of \"statement\"","type":"string"},"value":{"enum":["High","Low","Medium","None","Unknown"],"type":"string"}},"type":"object"},"IndicatorTypesSchema":{"properties":{"value":{"enum":["Anonymization","C2","Compromised PKI Certificate","Domain Watchlist","Exfiltration","File Hash Watchlist","Host Characteristics","IMEI Watchlist","IMSI Watchlist","IP Watchlist","Login Name","Malicious E-mail","Malware Artifacts","URL Watchlist"],"type":"string"}},"type":"object"},"IndustrySectorVocabSchema":{"properties":{"value":{"enum":["agriculture","aerospace","automotive","chemical","commercial","communications","construction","defense","education","energy","entertainment","financial-services","government","emergency-services","government-local","government-national","government-public-services","government-regional","healthcare","hospitality-leisure","infrastructure","dams","nuclear","water","insurance","manufacturing","mining","non-profit","pharmaceuticals","retail","technology","telecommunications","transportation","utilities"],"type":"string"},"vocab":{"default":"industry-sector-ov","description":"Constant field, must have a value of \"industry-sector-ov\"","type":"string"}},"required":["value"],"type":"object"},"InformationSourceAPISchema":{"properties":{"description":{"type":"string"},"identity":{"$ref":"#/components/schemas/InformationSourceIdentitySchema"},"references":{"items":{"format":"url","type":"string"},"type":"array"},"roles":{"items":{"$ref":"#/components/schemas/RolesSchema"},"type":"array"},"type":{"default":"information-source","description":"Constant field, must have a value of \"information-source\"","type":"string"}},"type":"object"},"InformationSourceIdentitySchema":{"properties":{"name":{"type":"string"},"type":{"default":"identity","description":"Constant field, must have a value of \"identity\"","type":"string"}},"type":"object"},"InformationSourceRoleVocabSchema":{"properties":{"value":{"enum":["Initial Author","Content Enhancer/Refiner","Aggregator","Transformer/Translator"],"type":"string"},"vocab":{"default":"{http://stix.mitre.org/default_vocabularies-1}InformationSourceRoleVocab-1.0","description":"Constant field, must have a value of \"{http://stix.mitre.org/default_vocabularies-1}InformationSourceRoleVocab-1.0\"","type":"string"}},"required":["value"],"type":"object"},"InformationSourceSchema":{"properties":{"description":{"type":"string"},"description_structuring_format":{"type":"string"},"identity":{"$ref":"#/components/schemas/IdentitySchema"},"references":{"items":{"type":"string"},"type":"array"},"roles":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"ControlledVocabularyStringSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/ControlledVocabularyStringSchema","{http://stix.mitre.org/default_vocabularies-1}InformationSourceRoleVocab-1.0":"#/components/schemas/InformationSourceRoleVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/InformationSourceRoleVocabSchema"},{"$ref":"#/components/schemas/ControlledVocabularyStringSchema"}],"properties":{"vocab":{"enum":["{http://stix.mitre.org/default_vocabularies-1}InformationSourceRoleVocab-1.0","*"],"type":"string"}},"type":"object"},"type":"array"},"time_end":{"format":"date-time","nullable":true,"type":"string"},"time_produced":{"format":"date-time","nullable":true,"type":"string"},"time_received":{"format":"date-time","nullable":true,"type":"string"},"time_start":{"format":"date-time","nullable":true,"type":"string"},"tools":{"items":{"$ref":"#/components/schemas/ToolInformationSchema"},"type":"array"},"type":{"default":"information-source","description":"Constant field, must have a value of \"information-source\"","type":"string"}},"required":["type"],"type":"object"},"InformationTypeVocabSchema":{"properties":{"value":{"enum":["Information Assets","Information Assets - Corporate Employee Information","Information Assets - Customer PII","Information Assets - Email Lists / Archives","Information Assets - Financial Data","Information Assets - Intellectual Property","Information Assets - Mobile Phone Contacts","Information Assets - User Credentials","Authentication Cookies"],"type":"string"},"vocab":{"default":"{http://stix.mitre.org/default_vocabularies-1}InformationTypeVocab-1.0","description":"Constant field, must have a value of \"{http://stix.mitre.org/default_vocabularies-1}InformationTypeVocab-1.0\"","type":"string"}},"required":["value"],"type":"object"},"InfrastructureTypeVocabSchema":{"properties":{"value":{"enum":["amplification","anonymization","botnet","command-and-control","control-system","exfiltration","firewall","hosting-malware","hosting-target-lists","phishing","reconnaissance","routers-switches","staging","workstation","unknown"],"type":"string"},"vocab":{"default":"infrastructure-type-ov","description":"Constant field, must have a value of \"infrastructure-type-ov\"","type":"string"}},"required":["value"],"type":"object"},"IntelRequirementAPISchema":{"properties":{"actions":{"$ref":"#/components/schemas/ActionSchema"},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"custom_id":{"type":"string"},"description":{"nullable":true,"type":"string"},"filtering_criteria":{"$ref":"#/components/schemas/FilteringCriteriaSchema"},"id":{"readOnly":true,"type":"integer"},"is_active":{"type":"boolean"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"last_updated_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"matching_criteria":{"$ref":"#/components/schemas/MatchingCriteriaSchema"},"matching_method":{"enum":["keyword-based","ai-based"],"type":"string"},"name":{"type":"string"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettingsSchema"},"owner":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1"},"priority":{"type":"string"},"task":{"description":"Task associated to this rule","example":"http://localhost/api/v2/tasks/1","readOnly":true},"watcher_groups":{"description":"[Collection of] Group ID/URL","example":["http://localhost/api/v2/groups/1"],"items":{"description":"Group ID/URL","example":"http://localhost/api/v2/groups/1"},"type":"array"},"watchers":{"description":"[Collection of] User ID/URL","example":["http://localhost/api/v2/users/1"],"items":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1"},"type":"array"}},"required":["actions","custom_id","filtering_criteria","is_active","matching_method","name","priority"],"type":"object"},"IntelRequirementMatchAPISchema":{"properties":{"accuracy":{"enum":["None","Low","Medium","High"],"readOnly":true,"type":"string"},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"entity_id":{"description":"Entity ID/URL","example":"http://localhost/api/v2/entities/b9fd19c3-e2ea-4b3b-bc08-ee8162cd9021"},"id":{"readOnly":true,"type":"integer"},"intel_requirement_id":{"description":"IntelRequirement ID/URL","example":"http://localhost/api/v2/intel-requirement/1"},"matching_method":{"enum":["keyword-based","ai-based","user-assigned"],"type":"string"},"reason":{"items":{"$ref":"#/components/schemas/ReasonSchema"},"type":"array"}},"required":["entity_id","intel_requirement_id","matching_method"],"type":"object"},"IntendedEffectSchema":{"properties":{"type":{"default":"statement","description":"Constant field, must have a value of \"statement\"","type":"string"},"value":{"enum":["Account Takeover","Advantage","Advantage - Economic","Advantage - Military","Advantage - Political","Brand Damage","Competitive Advantage","Degradation of Service","Denial and Deception","Destruction","Disruption","Embarrassment","Exposure","Extortion","Fraud","Harassment","ICS Control","Theft","Theft - Credential Theft","Theft - Identity Theft","Theft - Intellectual Property","Theft - Theft of Proprietary Information","Traffic Diversion","Unauthorized Access"],"type":"string"},"value_vocab":{"default":"{http://stix.mitre.org/default_vocabularies-1}IntendedEffectVocab-1.0","description":"Constant field, must have a value of \"{http://stix.mitre.org/default_vocabularies-1}IntendedEffectVocab-1.0\"","type":"string"}},"required":["value"],"type":"object"},"IntendedEffectStatementSchema":{"properties":{"confidence":{"description":"This object will be validated with a schema selected based on the value of the \"value_vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"ConfidenceSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/ConfidenceSchema","{http://stix.mitre.org/default_vocabularies-1}HighMediumLowVocab-1.0":"#/components/schemas/ConfidenceHighMediumLowVocabSchema"},"propertyName":"value_vocab"},"oneOf":[{"$ref":"#/components/schemas/ConfidenceHighMediumLowVocabSchema"},{"$ref":"#/components/schemas/ConfidenceSchema"}],"properties":{"value_vocab":{"enum":["{http://stix.mitre.org/default_vocabularies-1}HighMediumLowVocab-1.0","*"],"type":"string"}},"type":"object"},"description":{"type":"string"},"description_structuring_format":{"type":"string"},"id":{"type":"string"},"idref":{"type":"string"},"timestamp":{"format":"date-time","nullable":true,"type":"string"},"timestamp_precision":{"enum":["year","month","day","hour","minute","second"],"type":"string"},"type":{"default":"statement","description":"Constant field, must have a value of \"statement\"","type":"string"},"value":{"enum":["Advantage","Advantage - Economic","Advantage - Military","Advantage - Political","Theft","Theft - Intellectual Property","Theft - Credential Theft","Theft - Identity Theft","Theft - Theft of Proprietary Information","Account Takeover","Brand Damage","Competitive Advantage","Degradation of Service","Denial and Deception","Destruction","Disruption","Embarrassment","Exposure","Extortion","Fraud","Harassment","ICS Control","Traffic Diversion","Unauthorized Access"],"type":"string"},"value_vocab":{"default":"{http://stix.mitre.org/default_vocabularies-1}IntendedEffectVocab-1.0","description":"Constant field, must have a value of \"{http://stix.mitre.org/default_vocabularies-1}IntendedEffectVocab-1.0\"","type":"string"}},"required":["type","value"],"type":"object"},"IntendedEffectVocabSchema":{"properties":{"value":{"enum":["Advantage","Advantage - Economic","Advantage - Military","Advantage - Political","Theft","Theft - Intellectual Property","Theft - Credential Theft","Theft - Identity Theft","Theft - Theft of Proprietary Information","Account Takeover","Brand Damage","Competitive Advantage","Degradation of Service","Denial and Deception","Destruction","Disruption","Embarrassment","Exposure","Extortion","Fraud","Harassment","ICS Control","Traffic Diversion","Unauthorized Access"],"type":"string"},"vocab":{"default":"{http://stix.mitre.org/default_vocabularies-1}IntendedEffectVocab-1.0","description":"Constant field, must have a value of \"{http://stix.mitre.org/default_vocabularies-1}IntendedEffectVocab-1.0\"","type":"string"}},"required":["value"],"type":"object"},"JSONIDsSchema":{"properties":{"data":{"example":["id"],"items":{"type":"string"},"type":"array"}},"type":"object"},"JSONIntIDsSchema":{"properties":{"data":{"example":[1],"items":{"type":"integer"},"type":"array"}},"type":"object"},"KeyHighlightSchema":{"properties":{"date":{"type":"string"},"highlight":{"type":"string"},"source_ids":{"items":{"type":"string"},"type":"array"}},"type":"object"},"KillChainPhaseReferenceSchema":{"properties":{"kill_chain_id":{"type":"string"},"kill_chain_name":{"type":"string"},"name":{"type":"string"},"ordinality":{"type":"integer"},"phase_id":{"type":"string"},"type":{"default":"kill-chain-phase-reference","description":"Constant field, must have a value of \"kill-chain-phase-reference\"","type":"string"}},"required":["type"],"type":"object"},"KillChainPhaseSchema":{"properties":{"name":{"type":"string"},"ordinality":{"type":"integer"},"phase_id":{"type":"string"},"type":{"default":"kill-chain-phase","description":"Constant field, must have a value of \"kill-chain-phase\"","type":"string"}},"required":["type"],"type":"object"},"KillChainSchema":{"properties":{"definer":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"number_of_phases":{"type":"integer"},"phases":{"items":{"$ref":"#/components/schemas/KillChainPhaseSchema"},"type":"array"},"reference":{"type":"string"},"type":{"default":"kill-chain","description":"Constant field, must have a value of \"kill-chain\"","type":"string"}},"required":["type"],"type":"object"},"KnowledgePackAPISchema":{"properties":{"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"URL of the user that created this knowledge pack","example":"http://localhost/api/v2/users/1","readOnly":true},"datasets":{"description":"[Collection of] Dataset ID/URL","example":["http://localhost/api/v2/datasets/1"],"items":{"description":"Dataset ID/URL","example":"http://localhost/api/v2/datasets/1"},"type":"array"},"description":{"type":"string"},"id":{"format":"uuid","nullable":true,"type":"string"},"incoming_feeds":{"description":"[Collection of] Incoming feed ID/URL","example":["http://localhost/api/v2/incoming-feeds/1"],"items":{"description":"Incoming feed ID/URL","example":"http://localhost/api/v2/incoming-feeds/1"},"type":"array"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"last_updated_by":{"description":"URL of the user that created this knowledge pack","example":"http://localhost/api/v2/users/1","readOnly":true},"name":{"type":"string"},"objects_list":{"items":{"$ref":"#/components/schemas/BundleObjectReferenceAPISchema"},"readOnly":true,"type":"array"},"producer":{"description":"Configuration bundle producer ID/URL","example":"http://localhost/api/v2/knowledge-packs-producer/1","readOnly":true},"state":{"enum":["NEW","PUBLISHED","UNINSTALLED","INSTALLED"],"type":"string"},"task":{"description":"Knowledge pack task ID/URL","example":"http://localhost/api/v2/tasks/1"},"workspaces":{"description":"[Collection of] Workspace ID/URL","example":["http://localhost/api/v2/workspaces/1"],"items":{"description":"Workspace ID/URL","example":"http://localhost/api/v2/workspaces/1"},"type":"array"}},"required":["description","name"],"type":"object"},"LuceneQueryGenerationRequestSchema":{"properties":{"question":{"type":"string"}},"required":["question"],"type":"object"},"LuceneQueryGenerationResponseSchema":{"properties":{"lucene_query":{"description":"\nFull-text or faceted search with logic operators\nlike `AND` and `OR`.\n\nThe language of the search queries is Lucene and the\ncapability is the same as the one in Intelligence Center\nUI. Read more in [its documentation](\nhttps://docs.eclecticiq.com/ic/3.1.0/get-to-know-the-ic/search/).\n","example":"data.title:malware OR data.description:APT17","type":"string"}},"required":["lucene_query"],"type":"object"},"MalwareCapabilityVocabSchema":{"properties":{"value":{"enum":["accesses-remote-machines","anti-debugging","anti-disassembly","anti-emulation","anti-memory-forensics","anti-sandbox","anti-vm","captures-input-peripherals","captures-output-peripherals","captures-system-state-data","cleans-traces-of-infection","commits-fraud","communicates-with-c2","compromises-data-availability","compromises-data-integrity","compromises-system-availability","controls-local-machine","degrades-security-software","degrades-system-updates","determines-c2-server","emails-spam","escalates-privileges","evades-av","exfiltrates-data","fingerprints-host","hides-artifacts","hides-executing-code","infects-files","infects-remote-machines","installs-other-components","persists-after-system-reboot","prevents-artifact-access","prevents-artifact-deletion","probes-network-environment","self-modifies","steals-authentication-credentials","violates-system-operational-integrity"],"type":"string"},"vocab":{"default":"malware-capabilities-ov","description":"Constant field, must have a value of \"malware-capabilities-ov\"","type":"string"}},"required":["value"],"type":"object"},"MalwareResultVocabSchema":{"properties":{"value":{"enum":["malicious","suspicious","benign","unknown"],"type":"string"},"vocab":{"default":"malware-result-ov","description":"Constant field, must have a value of \"malware-result-ov\"","type":"string"}},"required":["value"],"type":"object"},"MalwareTypeVocabSchema":{"properties":{"value":{"enum":["adware","backdoor","bot","bootkit","ddos","downloader","dropper","exploit-kit","keylogger","ransomware","remote-access-trojan","resource-exploitation","rogue-security-software","rootkit","screen-capture","spyware","trojan","unknown","virus","webshell","wiper","worm"],"type":"string"},"vocab":{"default":"malware-type-ov","description":"Constant field, must have a value of \"malware-type-ov\"","type":"string"}},"required":["value"],"type":"object"},"MalwareTypeVocabSchema1":{"properties":{"value":{"enum":["Automated Transfer Scripts","Adware","Dialer","Bot","Bot - Credential Theft","Bot - DDoS","Bot - Loader","Bot - Spam","DoS / DDoS","DoS / DDoS - Participatory","DoS / DDoS - Script","DoS / DDoS - Stress Test Tools","Exploit Kits","POS / ATM Malware","Ransomware","Remote Access Trojan","Rogue Antivirus","Rootkit"],"type":"string"},"vocab":{"default":"{http://stix.mitre.org/default_vocabularies-1}MalwareTypeVocab-1.0","description":"Constant field, must have a value of \"{http://stix.mitre.org/default_vocabularies-1}MalwareTypeVocab-1.0\"","type":"string"}},"required":["value"],"type":"object"},"MarkingSpecificationSchema":{"properties":{"controlled_structure":{"type":"string"},"id":{"type":"string"},"idref":{"type":"string"},"information_source":{"$ref":"#/components/schemas/InformationSourceSchema"},"marking_structures":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"marking_structure_type\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"MarkingStructureGenericSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/MarkingStructureGenericSchema","eiq-attachments":"#/components/schemas/MarkingStructureEiqAttachmentsSchema","eiq-labels":"#/components/schemas/MarkingStructureEiqLabelsSchema","eiq-overrides":"#/components/schemas/MarkingStructureEiqOverridesSchema","eiq-timestamps":"#/components/schemas/MarkingStructureEiqTimestampsSchema","simple":"#/components/schemas/MarkingStructureSimpleSchema","terms-of-use":"#/components/schemas/MarkingStructureTermsOfUseSchema","tlp":"#/components/schemas/MarkingStructureTlpSchema"},"propertyName":"marking_structure_type"},"oneOf":[{"$ref":"#/components/schemas/MarkingStructureTlpSchema"},{"$ref":"#/components/schemas/MarkingStructureSimpleSchema"},{"$ref":"#/components/schemas/MarkingStructureTermsOfUseSchema"},{"$ref":"#/components/schemas/MarkingStructureEiqTimestampsSchema"},{"$ref":"#/components/schemas/MarkingStructureEiqOverridesSchema"},{"$ref":"#/components/schemas/MarkingStructureEiqLabelsSchema"},{"$ref":"#/components/schemas/MarkingStructureEiqAttachmentsSchema"},{"$ref":"#/components/schemas/MarkingStructureGenericSchema"}],"properties":{"marking_structure_type":{"enum":["tlp","simple","terms-of-use","eiq-timestamps","eiq-overrides","eiq-labels","eiq-attachments","*"],"type":"string"}},"type":"object"},"type":"array"},"type":{"default":"marking-specification","description":"Constant field, must have a value of \"marking-specification\"","type":"string"},"version":{"type":"string"}},"required":["type"],"type":"object"},"MarkingStructureEiqAttachmentsSchema":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/EclecticIqAttachmentSchema"},"type":"array"},"marking_structure_type":{"default":"eiq-attachments","description":"Constant field, must have a value of \"eiq-attachments\"","type":"string"},"type":{"default":"marking-structure","description":"Constant field, must have a value of \"marking-structure\"","type":"string"}},"required":["marking_structure_type","type"],"type":"object"},"MarkingStructureEiqLabelsSchema":{"properties":{"marking_structure_type":{"default":"eiq-labels","description":"Constant field, must have a value of \"eiq-labels\"","type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"taxonomy_nodes":{"items":{"type":"string"},"type":"array"},"type":{"default":"marking-structure","description":"Constant field, must have a value of \"marking-structure\"","type":"string"}},"required":["marking_structure_type","type"],"type":"object"},"MarkingStructureEiqOverridesSchema":{"properties":{"half_life":{"type":"integer"},"marking_structure_type":{"default":"eiq-overrides","description":"Constant field, must have a value of \"eiq-overrides\"","type":"string"},"title":{"type":"string"},"tlp_color":{"enum":["WHITE","GREEN","AMBER","RED"],"type":"string"},"type":{"default":"marking-structure","description":"Constant field, must have a value of \"marking-structure\"","type":"string"}},"required":["marking_structure_type","tlp_color","type"],"type":"object"},"MarkingStructureEiqTimestampsSchema":{"properties":{"ingest_time":{"format":"date-time","type":"string"},"marking_structure_type":{"default":"eiq-timestamps","description":"Constant field, must have a value of \"eiq-timestamps\"","type":"string"},"threat_end_time":{"format":"date-time","type":"string"},"threat_observed_time":{"format":"date-time","type":"string"},"threat_start_time":{"format":"date-time","type":"string"},"type":{"default":"marking-structure","description":"Constant field, must have a value of \"marking-structure\"","type":"string"}},"required":["marking_structure_type","type"],"type":"object"},"MarkingStructureGenericSchema":{"additionalProperties":true,"properties":{"id":{"type":"string"},"idref":{"type":"string"},"marking_model_name":{"type":"string"},"marking_model_ref":{"format":"url","type":"string"},"marking_structure_type":{"type":"string"},"type":{"default":"marking-structure","description":"Constant field, must have a value of \"marking-structure\"","type":"string"}},"required":["type"],"type":"object"},"MarkingStructureSimpleSchema":{"properties":{"marking_structure_type":{"default":"simple","description":"Constant field, must have a value of \"simple\"","type":"string"},"statement":{"type":"string"},"type":{"default":"marking-structure","description":"Constant field, must have a value of \"marking-structure\"","type":"string"}},"required":["marking_structure_type","statement","type"],"type":"object"},"MarkingStructureTermsOfUseSchema":{"properties":{"marking_structure_type":{"default":"terms-of-use","description":"Constant field, must have a value of \"terms-of-use\"","type":"string"},"terms_of_use":{"type":"string"},"type":{"default":"marking-structure","description":"Constant field, must have a value of \"marking-structure\"","type":"string"}},"required":["marking_structure_type","terms_of_use","type"],"type":"object"},"MarkingStructureTlpSchema":{"properties":{"color":{"enum":["WHITE","GREEN","AMBER","RED"],"type":"string"},"marking_structure_type":{"default":"tlp","description":"Constant field, must have a value of \"tlp\"","type":"string"},"type":{"default":"marking-structure","description":"Constant field, must have a value of \"marking-structure\"","type":"string"}},"required":["color","marking_structure_type","type"],"type":"object"},"MatchingCriteriaSchema":{"properties":{"keywords":{"items":{"type":"string"},"type":"array"},"match_keywords_in":{"description":"List of entity fields to search for keywords. Supported: ['title', 'tags', 'description']","items":{"enum":["title","tags","description"],"type":"string"},"type":"array"}},"type":"object"},"ModelSchema":{"properties":{"model":{"type":"string"},"recommended":{"type":"boolean"}},"required":["model"],"type":"object"},"NameSchema":{"properties":{"value":{"type":"string"}},"required":["value"],"type":"object"},"NodeQuerySchema":{"properties":{"es_query":{"allOf":[{"$ref":"#/components/schemas/ElasticSearchQuerySchema"}],"description":"\nAn ElasticSearch query.\n\nFor the best experience, it is recommended to follow this query structure. It will\nbenefit from automatic Intelligence Center optimizations leading to better results.\n"},"node_type":{"enum":["entity"],"type":"string"}},"required":["es_query","node_type"],"type":"object"},"NotificationAPISchema":{"properties":{"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"event_data":{"readOnly":true},"event_name":{"readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"importance":{"readOnly":true,"type":"string"},"is_read":{"type":"boolean"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"message_type":{"readOnly":true,"type":"string"},"user":{"description":"URL of the recipient of notification","example":"http://localhost/api/v2/users/1","readOnly":true}},"required":["id"],"type":"object"},"NotificationSettingsSchema":{"properties":{"notify_high_accuracy":{"description":"Notify if ai-based Intel Requirement matched with High accuracy","type":"boolean"},"notify_keyword_match":{"description":"Notify if keyword-based Intel Requirement matched","type":"boolean"},"notify_low_accuracy":{"description":"Notify if ai-based Intel Requirement matched with Low accuracy","type":"boolean"},"notify_medium_accuracy":{"description":"Notify if ai-based Intel Requirement matched with Medium accuracy","type":"boolean"}},"type":"object"},"ObjectiveSchema":{"properties":{"applicability_confidence":{"$ref":"#/components/schemas/ApplicabilityConfidenceSchema"},"description":{"type":"string"},"type":{"default":"objective","description":"Constant field, must have a value of \"objective\"","type":"string"}},"type":"object"},"ObservableAPISchema":{"properties":{"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"entities":{"description":"Entities associated with this observable","example":["http://localhost/api/v2/entities/a7097e6f-1c46-400d-af49-0e4ce6975657"],"items":{"description":"Entity ID/URL","example":"http://localhost/api/v2/entities/a7097e6f-1c46-400d-af49-0e4ce6975657","readOnly":true},"readOnly":true,"type":"array"},"id":{"readOnly":true,"type":"integer"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"meta":{"$ref":"#/components/schemas/ObservableMetaAPISchema"},"sources":{"description":"Sources associated with this observable (currently only one source is allowed)","example":["http://localhost/api/v2/sources/a1711a44-41cc-4c32-aaf1-9bbd734c00c5"],"items":{"description":"Source associated to this object. (ID/URL) Only the source of type {'group'} can be assigned. But any source types may be returned if assigned by the system, like an incoming feed source.","example":"http://localhost/api/v2/sources/a1711a44-41cc-4c32-aaf1-9bbd734c00c5"},"type":"array"},"type":{"enum":["ja3-full","hash-md5","ipv4-cidr","certificate-hash","malware-key","hash-sha384","inetnum","cwe","ipv4","hash-sha224","snort","certificate-serial-number","account-id","handle","certificate-subject","user-agent","person","hash-imphash","process","country","street","name","mutex","container-image-name","certificate-issuer","card","ipv6","organization","host","hash-ssdeep","city","cpu-architecture","uri-hash-sha256","bank-account","domain","ja3s-hash","card-owner","process-name","address","netname","email-subject","jarm","hash-rich-pe-header","geo-long","asn","registrar","email","product","forum-room","ja3-hash","rule","container-registry-account-name","country-code","file","yara","port","industry","forum-thread","winregistry","user-account","region","telephone","hash-vhash","container-cluster-name","device-fingerprint","hash-authentihash","hash-sha256","cloud-storage-bucket","cce","ipv6-cidr","ssh-public-key","nationality","eui-64","ja3s-full","cve","actor-id","geo-lat","hash-sha512","postcode","company","forum-name","geo","hash-sha1","mac-48","file-size","fox-it-portal-uri","uri","malware","crypto-address"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["type","value"],"type":"object"},"ObservableActionByQuerySchema":{"properties":{"observable_query":{"description":"\nFull-text or faceted search with logic operators\nlike `AND` and `OR`.\n\nThe language of the search queries is Lucene and the\ncapability is the same as the one in Intelligence Center\nUI. Read more in [its documentation](\nhttps://docs.eclecticiq.com/ic/3.1.0/get-to-know-the-ic/search/).\n","example":"data.title:malware OR data.description:APT17","type":"string"},"time_zone":{"description":"Timezone in Coordinated Universal Time (UTC) offset format","example":"+01:00 or -08:00","pattern":"[\\+,-][0-9][0-9]:[0-9][0-9]"}},"required":["observable_query"],"type":"object"},"ObservableDeleteByQueryAPISchema":{"properties":{"observable_query":{"description":"\nFull-text or faceted search with logic operators\nlike `AND` and `OR`.\n\nThe language of the search queries is Lucene and the\ncapability is the same as the one in Intelligence Center\nUI. Read more in [its documentation](\nhttps://docs.eclecticiq.com/ic/3.1.0/get-to-know-the-ic/search/).\n","example":"data.title:malware OR data.description:APT17","type":"string"},"time_zone":{"description":"Timezone in Coordinated Universal Time (UTC) offset format","example":"+01:00 or -08:00","pattern":"[\\+,-][0-9][0-9]:[0-9][0-9]"}},"required":["observable_query"],"type":"object"},"ObservableEnrichByQueryAPISchema":{"properties":{"enrichers":{"description":"List of active enricher IDs or URLs","example":["http://localhost/api/v2/enrichers/1"],"items":{"description":"Enricher ID/URL","example":"http://localhost/api/v2/enrichers/1"},"type":"array"},"observable_query":{"description":"\nFull-text or faceted search with logic operators\nlike `AND` and `OR`.\n\nThe language of the search queries is Lucene and the\ncapability is the same as the one in Intelligence Center\nUI. Read more in [its documentation](\nhttps://docs.eclecticiq.com/ic/3.1.0/get-to-know-the-ic/search/).\n","example":"data.title:malware OR data.description:APT17","type":"string"},"time_zone":{"description":"Timezone in Coordinated Universal Time (UTC) offset format","example":"+01:00 or -08:00","pattern":"[\\+,-][0-9][0-9]:[0-9][0-9]"}},"required":["observable_query"],"type":"object"},"ObservableExportByQueryAPISchema":{"properties":{"content_configuration":{"$ref":"#/components/schemas/ExtractCsvSchema"},"content_type":{"enum":["urn:eclecticiq.com:advanced-csv-extracts:1.0"],"type":"string"},"observable_query":{"description":"\nFull-text or faceted search with logic operators\nlike `AND` and `OR`.\n\nThe language of the search queries is Lucene and the\ncapability is the same as the one in Intelligence Center\nUI. Read more in [its documentation](\nhttps://docs.eclecticiq.com/ic/3.1.0/get-to-know-the-ic/search/).\n","example":"data.title:malware OR data.description:APT17","type":"string"},"time_zone":{"description":"Timezone in Coordinated Universal Time (UTC) offset format","example":"+01:00 or -08:00","pattern":"[\\+,-][0-9][0-9]:[0-9][0-9]"}},"required":["content_type","observable_query"],"type":"object"},"ObservableMetaAPISchema":{"additionalProperties":true,"properties":{"link_type":{"type":"string"},"maliciousness":{"enum":["unknown","safe","low","medium","high"],"type":"string"},"risk_score":{"description":"To modify risk_score, use `score-updates` endpoint. A value provided here is ignored.","readOnly":true,"type":"string"}},"type":"object"},"ObservableObjectSchema":{"properties":{"properties_xml":{"type":"string"},"properties_xml_type":{"type":"string"},"type":{"default":"cybox-object","description":"Constant field, must have a value of \"cybox-object\"","type":"string"}},"type":"object"},"ObservableRiskScoreUpdateByQueryAPISchema":{"properties":{"comment":{"type":"string"},"observable_query":{"description":"\nFull-text or faceted search with logic operators\nlike `AND` and `OR`.\n\nThe language of the search queries is Lucene and the\ncapability is the same as the one in Intelligence Center\nUI. Read more in [its documentation](\nhttps://docs.eclecticiq.com/ic/3.1.0/get-to-know-the-ic/search/).\n","example":"data.title:malware OR data.description:APT17","type":"string"},"risk_score":{"enum":["Low","Medium","High","Not Set"],"type":"string"},"time_zone":{"description":"Timezone in Coordinated Universal Time (UTC) offset format","example":"+01:00 or -08:00","pattern":"[\\+,-][0-9][0-9]:[0-9][0-9]"}},"required":["observable_query","risk_score"],"type":"object"},"ObservableRiskScoreUpdateSchema":{"properties":{"comment":{"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"observable_id":{"readOnly":true,"type":"integer"},"score":{"type":"string"},"score_breakdown":{"items":{"$ref":"#/components/schemas/RiskScoreBreakdown"},"readOnly":true,"type":"array"},"score_source":{"readOnly":true,"type":"string"}},"required":["score","score_source"],"type":"object"},"ObservableRuleAPISchema":{"properties":{"action":{"description":"Action that should be executed on the observables that match the rule","example":"classify","type":"string"},"action_details":{"description":"Arguments of the action associated to this rule","example":{"classification":"bad","confidence":"medium"}},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"description":{"nullable":true,"type":"string"},"entity_types":{"description":"Types of entities matched by the rule","items":{"enum":["attack-pattern","campaign","course-of-action","exploit-target","identity","incident","indicator","infrastructure","intrusion-set","location","malware","malware-analysis","report","eclecticiq-sighting","threat-actor","tool","ttp","custom-entity"],"type":"string"},"type":"array"},"id":{"readOnly":true,"type":"integer"},"is_active":{"type":"boolean"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"link_types":{"description":"List of observable values that the rule should match","items":{"type":"string"},"type":"array"},"name":{"type":"string"},"observable_types":{"description":"Types of observables matched by the rule","items":{"enum":["ja3-full","hash-md5","ipv4-cidr","certificate-hash","malware-key","hash-sha384","inetnum","cwe","ipv4","hash-sha224","snort","certificate-serial-number","account-id","handle","certificate-subject","user-agent","person","hash-imphash","process","country","street","name","mutex","container-image-name","certificate-issuer","card","ipv6","organization","host","hash-ssdeep","city","cpu-architecture","uri-hash-sha256","bank-account","domain","ja3s-hash","card-owner","process-name","address","netname","email-subject","jarm","hash-rich-pe-header","geo-long","asn","registrar","email","product","forum-room","ja3-hash","rule","container-registry-account-name","country-code","file","yara","port","industry","forum-thread","winregistry","user-account","region","telephone","hash-vhash","container-cluster-name","device-fingerprint","hash-authentihash","hash-sha256","cloud-storage-bucket","cce","ipv6-cidr","ssh-public-key","nationality","eui-64","ja3s-full","cve","actor-id","geo-lat","hash-sha512","postcode","company","forum-name","geo","hash-sha1","mac-48","file-size","fox-it-portal-uri","uri","malware","crypto-address"],"type":"string"},"type":"array"},"paths":{"description":"List of paths that the rule should match","items":{"type":"string"},"type":"array"},"source":{"description":"Source associated to this object. (ID/URL)","example":"http://localhost/api/v2/sources/01509aa5-f10a-4d2c-a7a5-11c2780c8d53"},"status":{"description":"Status of the latest rule task execution","enum":["PENDING","SENT","STARTED","RETRY","FAILURE","REVOKED","CAP_REACHED","WARNING","SUCCESS",null],"nullable":true,"readOnly":true,"type":"string"},"task":{"description":"Task associated to this rule","example":"http://localhost/api/v2/tasks/1","readOnly":true},"values":{"description":"List of observable values that the rule should match","items":{"type":"string"},"type":"array"},"without_link_type":{"description":"Set to true if the rule matches observables without link type","type":"boolean"}},"required":["action","is_active","name"],"type":"object"},"ObservableSchema":{"properties":{"object":{"$ref":"#/components/schemas/ObservableObjectSchema"},"type":{"default":"observable","description":"Constant field, must have a value of \"observable\"","type":"string"}},"type":"object"},"ObservableUpdateByQueryAPISchema":{"properties":{"maliciousness":{"enum":["unknown","safe","low","medium","high"],"type":"string"},"observable_query":{"description":"\nFull-text or faceted search with logic operators\nlike `AND` and `OR`.\n\nThe language of the search queries is Lucene and the\ncapability is the same as the one in Intelligence Center\nUI. Read more in [its documentation](\nhttps://docs.eclecticiq.com/ic/3.1.0/get-to-know-the-ic/search/).\n","example":"data.title:malware OR data.description:APT17","type":"string"},"time_zone":{"description":"Timezone in Coordinated Universal Time (UTC) offset format","example":"+01:00 or -08:00","pattern":"[\\+,-][0-9][0-9]:[0-9][0-9]"}},"required":["observable_query"],"type":"object"},"OutgoingFeedAPISchema":{"properties":{"allowed_link_types":{"items":{"enum":["parameter","affected","configuration","vulnerability","weakness","affected-asset","related","observed","sighted","test-mechanism","identity","malicious-infrastructure","targeted-victim","communicates-with","consists-of","drops","downloads","sample","host-vm","operating-system","installed-software","analysis"],"type":"string"},"type":"array"},"allowed_observable_states":{"description":"List of observable states allowed in the feed","items":{"$ref":"#/components/schemas/AllowedObservableStateAPISchema"},"type":"array"},"anonymize_replace_actions":{"items":{"$ref":"#/components/schemas/AnonimizeReplaceActionSchema"},"type":"array"},"anonymize_skip_paths":{"items":{"type":"string"},"nullable":true,"type":"array"},"content_configuration":{"nullable":true},"content_type":{"enum":["urn:eclecticiq.com:advanced-csv-entities:1.0","urn:eclecticiq.com:advanced-csv-extracts:1.0"],"type":"string"},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"datasets":{"description":"List of dataset URLs linked to the outgoing feed","example":["http://localhost/api/v2/datasets/1"],"items":{"description":"Dataset ID/URL","example":"http://localhost/api/v2/datasets/1"},"type":"array"},"delivery_last_run_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"delivery_status":{"enum":["FAILURE","RUNNING","SUCCESS","N/A"],"readOnly":true,"type":"string"},"destination":{"description":"Destination object id","format":"uuid","readOnly":true,"type":"string"},"do_sign_content":{"description":"If true then the platform's private key will be used to sign the payload","type":"boolean"},"enrichment_observable_types":{"description":"Only include these enrichment observable types in the feed","items":{"enum":["ja3-full","hash-md5","ipv4-cidr","certificate-hash","malware-key","hash-sha384","inetnum","cwe","ipv4","hash-sha224","snort","certificate-serial-number","account-id","handle","certificate-subject","user-agent","person","hash-imphash","process","country","street","name","mutex","container-image-name","certificate-issuer","card","ipv6","organization","host","hash-ssdeep","city","cpu-architecture","uri-hash-sha256","bank-account","domain","ja3s-hash","card-owner","process-name","address","netname","email-subject","jarm","hash-rich-pe-header","geo-long","asn","registrar","email","product","forum-room","ja3-hash","rule","container-registry-account-name","country-code","file","yara","port","industry","forum-thread","winregistry","user-account","region","telephone","hash-vhash","container-cluster-name","device-fingerprint","hash-authentihash","hash-sha256","cloud-storage-bucket","cce","ipv6-cidr","ssh-public-key","nationality","eui-64","ja3s-full","cve","actor-id","geo-lat","hash-sha512","postcode","company","forum-name","geo","hash-sha1","mac-48","file-size","fox-it-portal-uri","uri","malware","crypto-address"],"type":"string"},"type":"array"},"execution_schedule":{"allOf":[{"$ref":"#/components/schemas/TaskExecutionScheduleSchema"}],"nullable":true},"export_inactive_only":{"default":false,"description":"Only include data with half-life relevancy below 0.01","type":"boolean"},"half_life_filter":{"nullable":true,"type":"number"},"id":{"readOnly":true,"type":"integer"},"include_without_link_type":{"default":false,"type":"boolean"},"integration_task":{"description":"Integration task associated to this feed","example":"http://localhost/api/v2/tasks/1","readOnly":true},"is_active":{"type":"boolean"},"last_triggered_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"name":{"type":"string"},"observable_scores":{"description":"Only include these observable risk score value in the feed, if no values are provided, all values are included","items":{"enum":["Low","Medium","High","Not Set"],"type":"string"},"type":"array"},"observable_types":{"description":"Only include these observable types in the feed","items":{"enum":["ja3-full","hash-md5","ipv4-cidr","certificate-hash","malware-key","hash-sha384","inetnum","cwe","ipv4","hash-sha224","snort","certificate-serial-number","account-id","handle","certificate-subject","user-agent","person","hash-imphash","process","country","street","name","mutex","container-image-name","certificate-issuer","card","ipv6","organization","host","hash-ssdeep","city","cpu-architecture","uri-hash-sha256","bank-account","domain","ja3s-hash","card-owner","process-name","address","netname","email-subject","jarm","hash-rich-pe-header","geo-long","asn","registrar","email","product","forum-room","ja3-hash","rule","container-registry-account-name","country-code","file","yara","port","industry","forum-thread","winregistry","user-account","region","telephone","hash-vhash","container-cluster-name","device-fingerprint","hash-authentihash","hash-sha256","cloud-storage-bucket","cce","ipv6-cidr","ssh-public-key","nationality","eui-64","ja3s-full","cve","actor-id","geo-lat","hash-sha512","postcode","company","forum-name","geo","hash-sha1","mac-48","file-size","fox-it-portal-uri","uri","malware","crypto-address"],"type":"string"},"type":"array"},"packaging_last_run_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"packaging_status":{"readOnly":true,"type":"string"},"packing_batch_size_entities":{"type":"integer"},"packing_batch_size_relations":{"default":-1,"description":"Constant field, must have a value of \"-1\"","type":"string"},"require_valid_data":{"default":false,"type":"boolean"},"source_reliability_filter":{"enum":["A","B","C","D","E","F",null],"nullable":true,"type":"string"},"status":{"description":"Status of the latest feed run","enum":["PENDING","SENT","STARTED","RETRY","FAILURE","REVOKED","CAP_REACHED","WARNING","SUCCESS"],"readOnly":true,"type":"string"},"tlp_color_filter":{"description":"The values `CLEAR` and `AMBER_STRICT` are also accepted as an input but converted to TLP v1 on the response side.","enum":["NONE","WHITE","GREEN","AMBER","RED"],"nullable":true,"type":"string"},"tlp_color_override":{"description":"The values `CLEAR` and `AMBER_STRICT` are also accepted as an input but converted to TLP v1 on the response side.","enum":["NONE","WHITE","GREEN","AMBER","RED"],"nullable":true,"type":"string"},"transport_access_details":{"readOnly":true,"type":"string"},"transport_configuration":{"description":"Outgoing transport specific configuration","nullable":true},"transport_error":{"readOnly":true},"transport_type":{"enum":["eiq.outgoing-transports.email_push","eiq.outgoing-transports.ftp","eiq.outgoing-transports.sftp","eiq.outgoing-transports.mount_point","eiq.outgoing-transports.syslog","eiq.outgoing-transports.http_download","eiq.outgoing-transports.taxii_inbox_push","eiq.outgoing-transports.taxii_poll_passive","eiq.outgoing-transports.taxii21_push","eiq.outgoing-transports.taxii21_poll_passive","eiq.outgoing-transports.ms_defender_endpoint","eiq.outgoing-transports.misp_v2_upload","eiq.outgoing-transports.misp_upload","eiq.outgoing-transports.manageengine","eiq.outgoing-transports.logscale","eiq.outgoing-transports.infoblox_observables_push","eiq.outgoing-transports.cybereason","eiq.outgoing-transports.s3_push","eiq.outgoing-transports.zscaler","eiq.outgoing-transports.qradar","eiq.outgoing-transports.ms_sentinel","eiq.outgoing-transports.ms_sentinel_v2","eiq.outgoing-transports.exabeam","eiq.outgoing-transports.crowdstrike_upload","eiq.outgoing-transports.confluence"],"type":"string"},"update_strategy":{"description":"Configure the behaviour of the feed in case of duplicate content - append, replace or apply the difference","enum":["APPEND","REPLACE","DIFF"],"type":"string"},"update_task":{"description":"Update task associated to this feed","example":"http://localhost/api/v2/tasks/1","readOnly":true},"whitelist_sources":{"description":"List of sources that should be included in the feed","example":["http://localhost/api/v2/sources/b3c60126-327f-44de-beda-a902f3d42595"],"items":{"description":"Source associated to this object. (ID/URL)","example":"http://localhost/api/v2/sources/b3c60126-327f-44de-beda-a902f3d42595"},"type":"array"},"whitelist_tags":{"description":"Only include objects with these tags in the feed","items":{"type":"string"},"type":"array"},"whitelist_taxonomy_nodes":{"description":"List of taxonomies nodes (as IDs or URLs) that should be included in the feed","example":["http://localhost/api/v2/taxonomies/1"],"items":{"description":"Taxonomy ID, URL or path expressed as a lists of strings","example":"http://localhost/api/v2/taxonomies/1"},"type":"array"}},"required":["content_type","name","transport_configuration","transport_type"],"type":"object"},"OverviewDashboardAPISchema":{"properties":{"category":{"enum":["entity","observable","dataset","discovery","incoming-feeds","outgoing-feeds","dashboard"],"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"id":{"readOnly":true,"type":"integer"},"ui_metadata":{"description":"The parameters to configure the user interface.","type":"object"},"widgets":{"description":"List of widgets added to the overview dashboard","example":["http://localhost/api/v2/widgets/1"],"items":{"description":"Widget ID/URL","example":"http://localhost/api/v2/widgets/1"},"type":"array"}},"required":["category"],"type":"object"},"ParameterValueCriteriaSchema":{"properties":{"pattern":{"nullable":true,"type":"string"},"related_object_id":{"description":"ID of a related object if value is referencing it. E.g. a `source`"},"value":{"type":"string"},"value_config":{"$ref":"#/components/schemas/ValueSearchInSchema"}},"required":["value"],"type":"object"},"PermissionAPISchema":{"properties":{"id":{"readOnly":true,"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"PlanningAndOperationalSupportVocabSchema":{"properties":{"value":{"enum":["Data Exploitation","Data Exploitation - Analytic Support","Data Exploitation - Translation Support","Financial Resources","Financial Resources - Academic","Financial Resources - Commercial","Financial Resources - Government","Financial Resources - Hacktivist or Grassroot","Financial Resources - Non-Attributable Finance","Planning","Planning - Open-Source Intelligence (OSINT) Gathering","Planning - Operational Cover Plan","Planning - Pre-Operational Surveillance and Reconnaissance","Planning - Target Selection","Skill Development / Recruitment","Skill Development / Recruitment - Contracting and Hiring","Skill Development / Recruitment - Document Exploitation (DOCEX) Training","Skill Development / Recruitment - Internal Training","Skill Development / Recruitment - Military Programs","Skill Development / Recruitment - Security / Hacker Conferences","Skill Development / Recruitment - Underground Forums","Skill Development / Recruitment - University Programs"],"type":"string"},"vocab":{"default":"{http://stix.mitre.org/default_vocabularies-1}PlanningAndOperationalSupportVocab-1.0.1","description":"Constant field, must have a value of \"{http://stix.mitre.org/default_vocabularies-1}PlanningAndOperationalSupportVocab-1.0.1\"","type":"string"}},"required":["value"],"type":"object"},"ProcessorArchitectureVocabSchema":{"properties":{"value":{"enum":["alpha","arm","ia-64","mips","powerpc","sparc","x86","x86-64"],"type":"string"},"vocab":{"default":"processor-architecture-ov","description":"Constant field, must have a value of \"processor-architecture-ov\"","type":"string"}},"required":["value"],"type":"object"},"ProducerSchema":{"properties":{"identity":{"$ref":"#/components/schemas/InformationSourceIdentitySchema"},"references":{"items":{"format":"url","type":"string"},"type":"array"},"time_end":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"time_end_precision":{"enum":["day","hour","minute","month","second","year"],"type":"string"},"time_received":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"time_received_precision":{"enum":["day","hour","minute","month","second","year"],"type":"string"},"time_start":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"time_start_precision":{"enum":["day","hour","minute","month","second","year"],"type":"string"},"type":{"default":"information-source","description":"Constant field, must have a value of \"information-source\"","type":"string"}},"type":"object"},"PropertiesAffectedSchema":{"properties":{"description_of_effect":{"type":"string"},"duration_of_availability_loss":{"enum":["Days","Hours","Minutes","Permanent","Seconds","Unknown","Weeks"],"type":"string"},"non_public_data_compromised":{"enum":["No","Suspected","Unknown","Yes"],"type":"string"},"property":{"enum":["Accountability","Availability","Confidentiality","Integrity","Non-Repudiation"],"type":"string"},"type":{"default":"property-affected","description":"Constant field, must have a value of \"property-affected\"","type":"string"},"type_of_availability_loss":{"enum":["Acceleration","Degradation","Destruction","Interruption","Loss","Obscuration","Unknown"],"type":"string"}},"type":"object"},"PropertyBlockContainerSchema":{"properties":{"blocks":{"items":{"$ref":"#/components/schemas/PropertyBlockItemSchema"},"type":"array"},"is_enabled":{"type":"boolean"}},"type":"object"},"PropertyBlockItemSchema":{"properties":{"type":{"enum":["STIX_ID","Source","Date","Version","TLP","Intent"],"type":"string"},"value":{"nullable":true,"type":"string"}},"required":["type","value"],"type":"object"},"PropertyPropagationAPISchema":{"properties":{"copy_fields":{"additionalProperties":{"$ref":"#/components/schemas/CopyFieldSchema"},"type":"object"},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"description":{"nullable":true,"type":"string"},"execution_schedule":{"allOf":[{"$ref":"#/components/schemas/TaskExecutionScheduleSchema"}],"nullable":true},"filtering_criteria":{"$ref":"#/components/schemas/FilteringCriteriaSchema1"},"id":{"readOnly":true,"type":"integer"},"is_active":{"type":"boolean"},"is_retroactive":{"type":"boolean"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"name":{"type":"string"},"related_directly":{"type":"boolean"},"related_through_entities":{"type":"boolean"},"related_through_observables":{"type":"boolean"},"task":{"description":"PropertyPropagationTask object id","format":"int32","readOnly":true,"type":"integer"},"time_field":{"enum":["ingestion","start","observed",null],"nullable":true,"type":"string"},"time_period":{"nullable":true,"type":"integer"}},"required":["copy_fields","filtering_criteria","is_active","is_retroactive","name"],"type":"object"},"PublicAttackPatternDataSchema":{"additionalProperties":true,"properties":{"aliases":{"items":{"$ref":"#/components/schemas/NameSchema"},"type":"array"},"confidence":{"enum":["unknown","none","high","low","medium"],"type":"string"},"custom_attributes":{},"description":{"type":"string"},"description_structuring_format":{"type":"string"},"external_references":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"source_name\" property. If the value doesn't match a specific schema, the schema named \"ExternalReferenceSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/ExternalReferenceSchema","capec":"#/components/schemas/CapecExternalReferenceSchema"},"propertyName":"source_name"},"oneOf":[{"$ref":"#/components/schemas/CapecExternalReferenceSchema"},{"$ref":"#/components/schemas/ExternalReferenceSchema"}],"properties":{"source_name":{"enum":["capec","*"],"type":"string"}},"required":["source_name"],"type":"object"},"type":"array"},"handling":{"items":{"$ref":"#/components/schemas/MarkingSpecificationSchema"},"type":"array"},"id":{"description":"STIX ID to uniquely identify the object. If none is specified on an entity payload then the platform will automatically generate a STIX ID in the format `{platform-namespace-url}type-UUID`.","example":"{https://example.com}indicator-da747dd9-5564-44e1-aa24-8b527dfb8868","minLength":1,"type":"string"},"information_source":{"$ref":"#/components/schemas/InformationSourceSchema"},"original_eiqjson1_entity":{"type":"object"},"timestamp":{"description":"Entity timestamp (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"title":{"type":"string"},"type":{"default":"attack-pattern","description":"Constant field, must have a value of \"attack-pattern\"","type":"string"}},"required":["title","type"],"type":"object"},"PublicIdentityDataSchema":{"additionalProperties":true,"properties":{"confidence":{"enum":["unknown","none","high","low","medium"],"type":"string"},"custom_attributes":{},"description":{"type":"string"},"external_references":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"source_name\" property. If the value doesn't match a specific schema, the schema named \"ExternalReferenceSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/ExternalReferenceSchema","capec":"#/components/schemas/CapecExternalReferenceSchema"},"propertyName":"source_name"},"oneOf":[{"$ref":"#/components/schemas/CapecExternalReferenceSchema"},{"$ref":"#/components/schemas/ExternalReferenceSchema"}],"properties":{"source_name":{"enum":["capec","*"],"type":"string"}},"required":["source_name"],"type":"object"},"type":"array"},"handling":{"items":{"$ref":"#/components/schemas/MarkingSpecificationSchema"},"type":"array"},"id":{"description":"STIX ID to uniquely identify the object. If none is specified on an entity payload then the platform will automatically generate a STIX ID in the format `{platform-namespace-url}type-UUID`.","example":"{https://example.com}indicator-da747dd9-5564-44e1-aa24-8b527dfb8868","minLength":1,"type":"string"},"identity_class":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","identity-class-ov":"#/components/schemas/IdentityClassVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/IdentityClassVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["identity-class-ov","*"],"type":"string"}},"type":"object"},"identity_specification":{"$ref":"#/components/schemas/CIQIdentitySchema"},"information_source":{"$ref":"#/components/schemas/InformationSourceSchema"},"original_eiqjson1_entity":{"type":"object"},"roles":{"items":{"$ref":"#/components/schemas/NameSchema"},"type":"array"},"sectors":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","industry-sector-ov":"#/components/schemas/IndustrySectorVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/IndustrySectorVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["industry-sector-ov","*"],"type":"string"}},"type":"object"},"type":"array"},"timestamp":{"description":"Entity timestamp (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"title":{"type":"string"},"type":{"default":"identity","description":"Constant field, must have a value of \"identity\"","type":"string"}},"required":["title","type"],"type":"object"},"PublicInfrastructureDataSchema":{"additionalProperties":true,"properties":{"aliases":{"items":{"$ref":"#/components/schemas/NameSchema"},"type":"array"},"confidence":{"enum":["unknown","none","high","low","medium"],"type":"string"},"custom_attributes":{},"description":{"type":"string"},"description_structuring_format":{"type":"string"},"external_references":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"source_name\" property. If the value doesn't match a specific schema, the schema named \"ExternalReferenceSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/ExternalReferenceSchema","capec":"#/components/schemas/CapecExternalReferenceSchema"},"propertyName":"source_name"},"oneOf":[{"$ref":"#/components/schemas/CapecExternalReferenceSchema"},{"$ref":"#/components/schemas/ExternalReferenceSchema"}],"properties":{"source_name":{"enum":["capec","*"],"type":"string"}},"required":["source_name"],"type":"object"},"type":"array"},"handling":{"items":{"$ref":"#/components/schemas/MarkingSpecificationSchema"},"type":"array"},"id":{"description":"STIX ID to uniquely identify the object. If none is specified on an entity payload then the platform will automatically generate a STIX ID in the format `{platform-namespace-url}type-UUID`.","example":"{https://example.com}indicator-da747dd9-5564-44e1-aa24-8b527dfb8868","minLength":1,"type":"string"},"information_source":{"$ref":"#/components/schemas/InformationSourceSchema"},"infrastructure_types":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","infrastructure-type-ov":"#/components/schemas/InfrastructureTypeVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/InfrastructureTypeVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["infrastructure-type-ov","*"],"type":"string"}},"type":"object"},"type":"array"},"original_eiqjson1_entity":{"type":"object"},"timestamp":{"description":"Entity timestamp (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"title":{"type":"string"},"type":{"default":"infrastructure","description":"Constant field, must have a value of \"infrastructure\"","type":"string"}},"required":["title","type"],"type":"object"},"PublicIntrusionSetDataSchema":{"additionalProperties":true,"properties":{"aliases":{"items":{"$ref":"#/components/schemas/NameSchema"},"type":"array"},"confidence":{"enum":["unknown","none","high","low","medium"],"type":"string"},"custom_attributes":{},"description":{"type":"string"},"description_structuring_format":{"type":"string"},"external_references":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"source_name\" property. If the value doesn't match a specific schema, the schema named \"ExternalReferenceSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/ExternalReferenceSchema","capec":"#/components/schemas/CapecExternalReferenceSchema"},"propertyName":"source_name"},"oneOf":[{"$ref":"#/components/schemas/CapecExternalReferenceSchema"},{"$ref":"#/components/schemas/ExternalReferenceSchema"}],"properties":{"source_name":{"enum":["capec","*"],"type":"string"}},"required":["source_name"],"type":"object"},"type":"array"},"handling":{"items":{"$ref":"#/components/schemas/MarkingSpecificationSchema"},"type":"array"},"id":{"description":"STIX ID to uniquely identify the object. If none is specified on an entity payload then the platform will automatically generate a STIX ID in the format `{platform-namespace-url}type-UUID`.","example":"{https://example.com}indicator-da747dd9-5564-44e1-aa24-8b527dfb8868","minLength":1,"type":"string"},"information_source":{"$ref":"#/components/schemas/InformationSourceSchema"},"intended_effects":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","{http://stix.mitre.org/default_vocabularies-1}IntendedEffectVocab-1.0":"#/components/schemas/IntendedEffectVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/IntendedEffectVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["{http://stix.mitre.org/default_vocabularies-1}IntendedEffectVocab-1.0","*"],"type":"string"}},"type":"object"},"type":"array"},"motivations":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","attack-motivation-ov":"#/components/schemas/AttackMotivationVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/AttackMotivationVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["attack-motivation-ov","*"],"type":"string"}},"type":"object"},"type":"array"},"original_eiqjson1_entity":{"type":"object"},"planning_and_operational_support":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","{http://stix.mitre.org/default_vocabularies-1}PlanningAndOperationalSupportVocab-1.0.1":"#/components/schemas/PlanningAndOperationalSupportVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/PlanningAndOperationalSupportVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["{http://stix.mitre.org/default_vocabularies-1}PlanningAndOperationalSupportVocab-1.0.1","*"],"type":"string"}},"type":"object"},"type":"array"},"resource_level":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","attack-resource-level-ov":"#/components/schemas/AttackResourceLevelVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/AttackResourceLevelVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["attack-resource-level-ov","*"],"type":"string"}},"type":"object"},"sophistication":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","threat-actor-sophistication-ov":"#/components/schemas/ThreatActorSophisticationVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/ThreatActorSophisticationVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["threat-actor-sophistication-ov","*"],"type":"string"}},"type":"object"},"timestamp":{"description":"Entity timestamp (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"title":{"type":"string"},"type":{"default":"intrusion-set","description":"Constant field, must have a value of \"intrusion-set\"","type":"string"}},"required":["title","type"],"type":"object"},"PublicKeyDetailsSchema":{"properties":{"description":{"type":"string"},"fingerprint":{"readOnly":true,"type":"string"},"key":{"type":"string"},"keyid":{"readOnly":true,"type":"string"}},"required":["description","key"],"type":"object"},"PublicLocationDataSchema":{"additionalProperties":true,"properties":{"administrative_area":{"description":"Should be a valid ISO-3166-2 subdivision code.","type":"string"},"city":{"type":"string"},"confidence":{"enum":["unknown","none","high","low","medium"],"type":"string"},"country":{"description":"Should be a valid ISO-3166-2 ALPHA-2 code.","type":"string"},"custom_attributes":{},"description":{"type":"string"},"description_structuring_format":{"type":"string"},"external_references":{"items":{"$ref":"#/components/schemas/ExternalReferenceSchema"},"type":"array"},"handling":{"items":{"$ref":"#/components/schemas/MarkingSpecificationSchema"},"type":"array"},"id":{"description":"STIX ID to uniquely identify the object. If none is specified on an entity payload then the platform will automatically generate a STIX ID in the format `{platform-namespace-url}type-UUID`.","example":"{https://example.com}indicator-da747dd9-5564-44e1-aa24-8b527dfb8868","minLength":1,"type":"string"},"information_source":{"$ref":"#/components/schemas/InformationSourceSchema"},"latitude":{"type":"number"},"longitude":{"type":"number"},"postal_code":{"type":"string"},"precision":{"type":"number"},"region":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","region-ov":"#/components/schemas/RegionVocabularySchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/RegionVocabularySchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["region-ov","*"],"type":"string"}},"type":"object"},"street_address":{"type":"string"},"timestamp":{"description":"Entity timestamp (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"title":{"type":"string"},"type":{"default":"location","description":"Constant field, must have a value of \"location\"","type":"string"}},"required":["title","type"],"type":"object"},"PublicMalwareAnalysisDataSchema":{"additionalProperties":true,"properties":{"analysis_definition_version":{"type":"string"},"analysis_engine_version":{"type":"string"},"confidence":{"enum":["unknown","none","high","low","medium"],"type":"string"},"configuration_version":{"type":"string"},"custom_attributes":{},"description":{"type":"string"},"description_structuring_format":{"type":"string"},"external_references":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"source_name\" property. If the value doesn't match a specific schema, the schema named \"ExternalReferenceSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/ExternalReferenceSchema","capec":"#/components/schemas/CapecExternalReferenceSchema"},"propertyName":"source_name"},"oneOf":[{"$ref":"#/components/schemas/CapecExternalReferenceSchema"},{"$ref":"#/components/schemas/ExternalReferenceSchema"}],"properties":{"source_name":{"enum":["capec","*"],"type":"string"}},"required":["source_name"],"type":"object"},"type":"array"},"handling":{"items":{"$ref":"#/components/schemas/MarkingSpecificationSchema"},"type":"array"},"id":{"description":"STIX ID to uniquely identify the object. If none is specified on an entity payload then the platform will automatically generate a STIX ID in the format `{platform-namespace-url}type-UUID`.","example":"{https://example.com}indicator-da747dd9-5564-44e1-aa24-8b527dfb8868","minLength":1,"type":"string"},"information_source":{"$ref":"#/components/schemas/InformationSourceSchema"},"modules":{"items":{"$ref":"#/components/schemas/NameSchema"},"type":"array"},"product":{"type":"string"},"result":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","malware-result-ov":"#/components/schemas/MalwareResultVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/MalwareResultVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["malware-result-ov","*"],"type":"string"}},"type":"object"},"result_name":{"type":"string"},"timestamp":{"description":"Entity timestamp (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"title":{"type":"string"},"type":{"default":"malware-analysis","description":"Constant field, must have a value of \"malware-analysis\"","type":"string"},"version":{"type":"string"}},"required":["product","title","type"],"type":"object"},"PublicMalwareDataSchema":{"additionalProperties":true,"properties":{"aliases":{"items":{"$ref":"#/components/schemas/NameSchema"},"type":"array"},"architecture_execution_envs":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","processor-architecture-ov":"#/components/schemas/ProcessorArchitectureVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/ProcessorArchitectureVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["processor-architecture-ov","*"],"type":"string"}},"type":"object"},"type":"array"},"capabilities":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","malware-capabilities-ov":"#/components/schemas/MalwareCapabilityVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/MalwareCapabilityVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["malware-capabilities-ov","*"],"type":"string"}},"type":"object"},"type":"array"},"confidence":{"enum":["unknown","none","high","low","medium"],"type":"string"},"custom_attributes":{},"description":{"type":"string"},"description_structuring_format":{"type":"string"},"external_references":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"source_name\" property. If the value doesn't match a specific schema, the schema named \"ExternalReferenceSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/ExternalReferenceSchema","capec":"#/components/schemas/CapecExternalReferenceSchema"},"propertyName":"source_name"},"oneOf":[{"$ref":"#/components/schemas/CapecExternalReferenceSchema"},{"$ref":"#/components/schemas/ExternalReferenceSchema"}],"properties":{"source_name":{"enum":["capec","*"],"type":"string"}},"required":["source_name"],"type":"object"},"type":"array"},"handling":{"items":{"$ref":"#/components/schemas/MarkingSpecificationSchema"},"type":"array"},"id":{"description":"STIX ID to uniquely identify the object. If none is specified on an entity payload then the platform will automatically generate a STIX ID in the format `{platform-namespace-url}type-UUID`.","example":"{https://example.com}indicator-da747dd9-5564-44e1-aa24-8b527dfb8868","minLength":1,"type":"string"},"implementation_languages":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","implementation-language-ov":"#/components/schemas/ImplementationLanguageVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/ImplementationLanguageVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["implementation-language-ov","*"],"type":"string"}},"type":"object"},"type":"array"},"information_source":{"$ref":"#/components/schemas/InformationSourceSchema"},"is_family":{"default":false,"type":"boolean"},"malware_types":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","malware-type-ov":"#/components/schemas/MalwareTypeVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/MalwareTypeVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["malware-type-ov","*"],"type":"string"}},"type":"object"},"type":"array"},"original_eiqjson1_entity":{"type":"object"},"timestamp":{"description":"Entity timestamp (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"title":{"type":"string"},"type":{"default":"malware","description":"Constant field, must have a value of \"malware\"","type":"string"}},"required":["title","type"],"type":"object"},"PublicNoteDataSchema":{"additionalProperties":true,"properties":{"confidence":{"enum":["unknown","none","high","low","medium"],"type":"string"},"description":{"type":"string"},"description_structuring_format":{"type":"string"},"external_references":{"items":{"$ref":"#/components/schemas/ExternalReferenceSchema"},"type":"array"},"handling":{"items":{"$ref":"#/components/schemas/MarkingSpecificationSchema"},"type":"array"},"id":{"description":"STIX ID to uniquely identify the object. If none is specified on an entity payload then the platform will automatically generate a STIX ID in the format `{platform-namespace-url}type-UUID`.","example":"{https://example.com}indicator-da747dd9-5564-44e1-aa24-8b527dfb8868","minLength":1,"type":"string"},"information_source":{"$ref":"#/components/schemas/InformationSourceSchema"},"timestamp":{"description":"Entity timestamp (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"title":{"type":"string"},"type":{"default":"note","description":"Constant field, must have a value of \"note\"","type":"string"}},"required":["title","type"],"type":"object"},"PublicTTPDataSchema":{"additionalProperties":true,"properties":{"behavior":{"$ref":"#/components/schemas/TTPBehaviorSchema"},"confidence":{"enum":["unknown","none","high","low","medium"],"type":"string"},"description":{"type":"string"},"description_structuring_format":{"type":"string"},"handling":{"items":{"$ref":"#/components/schemas/MarkingSpecificationSchema"},"type":"array"},"id":{"description":"STIX ID to uniquely identify the object. If none is specified on an entity payload then the platform will automatically generate a STIX ID in the format `{platform-namespace-url}type-UUID`.","example":"{https://example.com}indicator-da747dd9-5564-44e1-aa24-8b527dfb8868","minLength":1,"type":"string"},"id_namespaces":{"additionalProperties":{"type":"string"},"type":"object"},"idref":{"minLength":1,"type":"string"},"information_source":{"$ref":"#/components/schemas/InformationSourceSchema"},"intended_effects":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"value_vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"StatementSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/StatementSchema","{http://stix.mitre.org/default_vocabularies-1}IntendedEffectVocab-1.0":"#/components/schemas/IntendedEffectStatementSchema"},"propertyName":"value_vocab"},"oneOf":[{"$ref":"#/components/schemas/IntendedEffectStatementSchema"},{"$ref":"#/components/schemas/StatementSchema"}],"properties":{"value_vocab":{"enum":["{http://stix.mitre.org/default_vocabularies-1}IntendedEffectVocab-1.0","*"],"type":"string"}},"type":"object"},"type":"array"},"kill_chain_phases":{"items":{"$ref":"#/components/schemas/KillChainPhaseReferenceSchema"},"type":"array"},"kill_chains":{"items":{"$ref":"#/components/schemas/KillChainSchema"},"type":"array"},"resources":{"$ref":"#/components/schemas/TTPResourceSchema"},"short_description":{"type":"string"},"short_description_structuring_format":{"type":"string"},"timestamp":{"description":"Entity timestamp (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"title":{"type":"string"},"type":{"default":"ttp","description":"Constant field, must have a value of \"ttp\"","type":"string"},"version":{"type":"string"},"victim_targeting":{"$ref":"#/components/schemas/TTPVictimTargetingSchema"}},"required":["title","type"],"type":"object"},"PublicThreatActorV2DataSchema":{"additionalProperties":true,"properties":{"aliases":{"items":{"$ref":"#/components/schemas/NameSchema"},"type":"array"},"confidence":{"enum":["unknown","none","high","low","medium"],"type":"string"},"custom_attributes":{},"description":{"type":"string"},"description_structuring_format":{"type":"string"},"external_references":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"source_name\" property. If the value doesn't match a specific schema, the schema named \"ExternalReferenceSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/ExternalReferenceSchema","capec":"#/components/schemas/CapecExternalReferenceSchema"},"propertyName":"source_name"},"oneOf":[{"$ref":"#/components/schemas/CapecExternalReferenceSchema"},{"$ref":"#/components/schemas/ExternalReferenceSchema"}],"properties":{"source_name":{"enum":["capec","*"],"type":"string"}},"required":["source_name"],"type":"object"},"type":"array"},"handling":{"items":{"$ref":"#/components/schemas/MarkingSpecificationSchema"},"type":"array"},"id":{"description":"STIX ID to uniquely identify the object. If none is specified on an entity payload then the platform will automatically generate a STIX ID in the format `{platform-namespace-url}type-UUID`.","example":"{https://example.com}indicator-da747dd9-5564-44e1-aa24-8b527dfb8868","minLength":1,"type":"string"},"identity":{"$ref":"#/components/schemas/CIQIdentitySchema"},"information_source":{"$ref":"#/components/schemas/InformationSourceSchema"},"intended_effects":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","{http://stix.mitre.org/default_vocabularies-1}IntendedEffectVocab-1.0":"#/components/schemas/IntendedEffectVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/IntendedEffectVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["{http://stix.mitre.org/default_vocabularies-1}IntendedEffectVocab-1.0","*"],"type":"string"}},"type":"object"},"type":"array"},"motivations":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","attack-motivation-ov":"#/components/schemas/AttackMotivationVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/AttackMotivationVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["attack-motivation-ov","*"],"type":"string"}},"type":"object"},"type":"array"},"personal_motivations":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","attack-motivation-ov":"#/components/schemas/AttackMotivationVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/AttackMotivationVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["attack-motivation-ov","*"],"type":"string"}},"type":"object"},"type":"array"},"planning_and_operational_support":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","{http://stix.mitre.org/default_vocabularies-1}PlanningAndOperationalSupportVocab-1.0.1":"#/components/schemas/PlanningAndOperationalSupportVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/PlanningAndOperationalSupportVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["{http://stix.mitre.org/default_vocabularies-1}PlanningAndOperationalSupportVocab-1.0.1","*"],"type":"string"}},"type":"object"},"type":"array"},"resource_level":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","attack-resource-level-ov":"#/components/schemas/AttackResourceLevelVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/AttackResourceLevelVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["attack-resource-level-ov","*"],"type":"string"}},"type":"object"},"roles":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","threat-actor-role-ov":"#/components/schemas/ThreatActorRoleVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/ThreatActorRoleVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["threat-actor-role-ov","*"],"type":"string"}},"type":"object"},"type":"array"},"short_description":{"type":"string"},"short_description_structuring_format":{"type":"string"},"sophistication":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","threat-actor-sophistication-ov":"#/components/schemas/ThreatActorSophisticationVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/ThreatActorSophisticationVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["threat-actor-sophistication-ov","*"],"type":"string"}},"type":"object"},"timestamp":{"description":"Entity timestamp (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"title":{"type":"string"},"type":{"default":"threat-actor","description":"Constant field, must have a value of \"threat-actor\"","type":"string"},"types":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","threat-actor-type-ov":"#/components/schemas/ThreatActorTypeVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/ThreatActorTypeVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["threat-actor-type-ov","*"],"type":"string"}},"type":"object"},"type":"array"}},"required":["title","type"],"type":"object"},"PublicToolDataSchema":{"additionalProperties":true,"properties":{"aliases":{"items":{"$ref":"#/components/schemas/NameSchema"},"type":"array"},"architecture_execution_envs":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","processor-architecture-ov":"#/components/schemas/ProcessorArchitectureVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/ProcessorArchitectureVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["processor-architecture-ov","*"],"type":"string"}},"type":"object"},"type":"array"},"confidence":{"enum":["unknown","none","high","low","medium"],"type":"string"},"custom_attributes":{},"description":{"type":"string"},"description_structuring_format":{"type":"string"},"external_references":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"source_name\" property. If the value doesn't match a specific schema, the schema named \"ExternalReferenceSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/ExternalReferenceSchema","capec":"#/components/schemas/CapecExternalReferenceSchema"},"propertyName":"source_name"},"oneOf":[{"$ref":"#/components/schemas/CapecExternalReferenceSchema"},{"$ref":"#/components/schemas/ExternalReferenceSchema"}],"properties":{"source_name":{"enum":["capec","*"],"type":"string"}},"required":["source_name"],"type":"object"},"type":"array"},"handling":{"items":{"$ref":"#/components/schemas/MarkingSpecificationSchema"},"type":"array"},"id":{"description":"STIX ID to uniquely identify the object. If none is specified on an entity payload then the platform will automatically generate a STIX ID in the format `{platform-namespace-url}type-UUID`.","example":"{https://example.com}indicator-da747dd9-5564-44e1-aa24-8b527dfb8868","minLength":1,"type":"string"},"implementation_languages":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","implementation-language-ov":"#/components/schemas/ImplementationLanguageVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/ImplementationLanguageVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["implementation-language-ov","*"],"type":"string"}},"type":"object"},"type":"array"},"information_source":{"$ref":"#/components/schemas/InformationSourceSchema"},"original_eiqjson1_entity":{"type":"object"},"timestamp":{"description":"Entity timestamp (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"title":{"type":"string"},"tool_types":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"GenericVocabSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/GenericVocabSchema","tool-type-ov":"#/components/schemas/ToolTypeVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/ToolTypeVocabSchema"},{"$ref":"#/components/schemas/GenericVocabSchema"}],"properties":{"vocab":{"enum":["tool-type-ov","*"],"type":"string"}},"type":"object"},"type":"array"},"tool_version":{"type":"string"},"type":{"default":"tool","description":"Constant field, must have a value of \"tool\"","type":"string"}},"required":["title","type"],"type":"object"},"ReasonSchema":{"properties":{"reason":{"type":"string"},"reason_category":{"type":"string"},"reason_type":{"enum":["Positive","Negative"],"type":"string"}},"required":["reason","reason_category"],"type":"object"},"RegionVocabularySchema":{"properties":{"value":{"enum":["africa","eastern-africa","middle-africa","northern-africa","southern-africa","western-africa","americas","carebbean","central-america","latin-america-caribbean","northern-america","south-america","asia","central-asia","eastern-asia","southern-asia","south-eastern-asia","western-asia","europe","eastern-europe","northern-europe","southern-europe","western-europe","oceania","antarctica","australia-new-zealand","melanesia","micronesia","polynesia"],"type":"string"},"vocab":{"default":"region-ov","description":"Constant field, must have a value of \"region-ov\"","type":"string"}},"required":["value"],"type":"object"},"RegularHeaderFooterContainerSchema":{"properties":{"is_enabled":{"type":"boolean"},"sections":{"items":{"$ref":"#/components/schemas/HeaderFooterSectionSchema"},"type":"array"}},"type":"object"},"RelatedEntitySchema":{"properties":{"entity_description":{"type":"string"},"entity_title":{"type":"string"},"entity_type":{"type":"string"},"relationship":{"type":"string"},"source_ids":{"items":{"type":"string"},"type":"array"}},"type":"object"},"RelationAPISchema":{"properties":{"id":{"items":{"type":"string"},"type":"array"}},"type":"object"},"RelationalQueryAPISchema":{"properties":{"include_indirectly_related":{"default":false,"description":"\nThis flag when set to `True` allows to also include the entities that related\nindirectly to the other query. An indirect relation means that another entity,\nwithout specific criteria, connect entities from both queries.\nBy default, it is `False` so only the entities directly related are returned.\n","type":"boolean"},"output":{"description":"choose which nodes of relational query to return, either `query_1` or `query_2` is a valid option","enum":["query_1","query_2"],"type":"string"},"query_1":{"allOf":[{"$ref":"#/components/schemas/NodeQuerySchema"}],"description":"Elasticsearch query matching entities (nodes) representing relation source(s)."},"query_2":{"allOf":[{"$ref":"#/components/schemas/NodeQuerySchema"}],"description":"Elasticsearch query matching entities (nodes) representing relation target(s)."},"relation_query":{"description":"Elasticsearch query for relationship object itself (defaults to `*`)","type":"object"}},"required":["output","query_1","query_2","relation_query"],"type":"object"},"RelationshipAPISchema":{"properties":{"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"data":{"$ref":"#/components/schemas/RelationshipDataAPISchema"},"id":{"format":"uuid","type":"string"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"meta":{"$ref":"#/components/schemas/RelationshipMetaAPISchema"},"sources":{"description":"[Collection of] Source associated to this object. (ID/URL) Only the source of type {'group'} can be assigned. But any source types may be returned if assigned by the system, like an incoming feed source.","example":["http://localhost/api/v2/sources/aadcb1f9-5aaf-4131-83ab-e91f6185893b"],"items":{"description":"Source associated to this object. (ID/URL) Only the source of type {'group'} can be assigned. But any source types may be returned if assigned by the system, like an incoming feed source.","example":"http://localhost/api/v2/sources/aadcb1f9-5aaf-4131-83ab-e91f6185893b"},"maxItems":1,"minItems":1,"type":"array"},"strict_stix_1":{"readOnly":true,"type":"boolean"},"strict_stix_2":{"readOnly":true,"type":"boolean"}},"required":["data","sources"],"type":"object"},"RelationshipDataAPISchema":{"properties":{"description":{"description":"A description that provides more details and context about the Relationship, potentially including its purpose and its key characteristics.","nullable":true,"type":"string"},"id":{"description":"STIX ID to uniquely identify the object. If none is specified on an entity payload then the platform will automatically generate a STIX ID in the format `{platform-namespace-url}type-UUID`.","example":"{https://example.com}indicator-da747dd9-5564-44e1-aa24-8b527dfb8868","minLength":1,"type":"string"},"key":{"description":"EIQ JSON relation key e.g. `based-on`. The value of this property must be in ASCII, no longer than 256 characters and is limited to characters a–z (lowercase ASCII), 0–9, and hyphen (-).","nullable":true,"pattern":"^[a-z0-9\\-]{1,256}$","type":"string"},"source":{"description":"Source EIQ entity ID, STIX ID or API entity URL","example":"http://localhost/api/v2/entities/1a91dc13-4a84-4624-b99a-9ea14f4448df"},"subtype":{"description":"This field is currently only used for 'stix_update_of'. It indicates that the source entity is an update of the target one. The target entity is going to be marked as outdated. The key is ignored when this property is set.","enum":["stix_update_of"],"type":"string"},"target":{"description":"Target EIQ entity ID or STIX ID or API entity URL","example":"http://localhost/api/v2/entities/f91ca45e-4fd4-4242-a190-d0c47e3527c1"},"timestamp":{"description":"Relationship last modification timestamp in ISO-8601 format (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"}},"required":["source","target"],"type":"object"},"RelationshipMetaAPISchema":{"properties":{"estimated_threat_end_time":{"description":"\nThe latest time at which the Relationship between the objects exists. If\nthis property is a future timestamp, at the time the\n`estimated_threat_end_time` property is defined, then this represents an\nestimate by the producer of the intelligence of the latest time at which\nrelationship will be asserted to be true.\n\nIf `estimated_threat_start_time` and `estimated_threat_end_time` are\nboth defined, then `estimated_threat_end_time` MUST be later than the\n`estimated_threat_start_time` value.\n\nIf `estimated_threat_end_time` is not specified, then the latest time at\nwhich the relationship between the objects exists is either not known,\nnot disclosed, or has no defined stop time.\n","format":"date-time","nullable":true,"type":"string"},"estimated_threat_start_time":{"description":"\nThis optional timestamp represents the earliest time at which the\nRelationship between the objects exists. If this property is a future\ntimestamp, at the time the `estimated_threat_start_time` property is\ndefined, then this represents an estimate by the producer of the\nintelligence of the earliest time at which relationship will be asserted\nto be true.\n\nIf it is not specified, then the earliest time at which the relationship\nbetween the objects exists is not defined.\n","format":"date-time","nullable":true,"type":"string"},"external_ids":{"items":{"type":"string"},"type":"array"},"is_rewired":{"description":"Indicates if this relation has its source/target Entity that have been merged. When an entity is merged all the relations are copied to the master entity. A missing value implies False.","readOnly":true,"type":"boolean"},"is_rewired_by":{"description":"The UUID id of the master entity. This field is only present if `is_rewired` is `True`.","format":"uuid","readOnly":true,"type":"string"},"source_reliability":{"enum":["A","B","C","D","E","F",null],"nullable":true,"readOnly":true,"type":"string"},"stix_id":{"readOnly":true,"type":"string"},"tlp_color":{"description":"The current TLP value.\n\nThe values `CLEAR` and `AMBER_STRICT` are also accepted as an input but converted to TLP v1 on the response side.","enum":["NONE","WHITE","GREEN","AMBER","RED"],"nullable":true,"type":"string"},"tlp_color_original":{"description":"The value of the very first TLP set.","enum":["NONE","WHITE","GREEN","AMBER","RED"],"nullable":true,"readOnly":true,"type":"string"}},"type":"object"},"ReportDataSchema":{"additionalProperties":true,"properties":{"confidence":{"enum":["unknown","none","high","low","medium"],"type":"string"},"custom_attributes":{},"description":{"type":"string"},"description_structuring_format":{"type":"string"},"id":{"description":"STIX ID to uniquely identify the object. If none is specified on an entity payload then the platform will automatically generate a STIX ID in the format `{platform-namespace-url}type-UUID`.","example":"{https://example.com}indicator-da747dd9-5564-44e1-aa24-8b527dfb8868","minLength":1,"type":"string"},"information_source":{"$ref":"#/components/schemas/InformationSourceAPISchema"},"intents":{"items":{"$ref":"#/components/schemas/ReportIntentsSchema"},"type":"array"},"short_description":{"type":"string"},"timestamp":{"description":"Entity timestamp (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"title":{"type":"string"},"type":{"enum":["attack-pattern","campaign","course-of-action","exploit-target","identity","incident","indicator","infrastructure","intrusion-set","location","malware","malware-analysis","report","eclecticiq-sighting","threat-actor","tool","ttp","custom-entity"],"type":"string"}},"required":["title","type"],"type":"object"},"ReportIntentsSchema":{"properties":{"value":{"enum":["Attack Pattern Characterization","Campaign Characterization","Collective Threat Intelligence","Courses of Action","Exploit Characterization","Incident","Indicators","Indicators - Endpoint Characteristics","Indicators - Malware Artifacts","Indicators - Network Activity","Indicators - Phishing","Indicators - Watchlist","Malware Characterization","Malware Samples","Observations","Observations - Email","TTP - Infrastructure","TTP - Tools","Threat Actor Characterization","Threat Report"],"type":"string"},"value_vocab":{"default":"{http://stix.mitre.org/default_vocabularies-1}ReportIntentVocab-1.0","description":"Constant field, must have a value of \"{http://stix.mitre.org/default_vocabularies-1}ReportIntentVocab-1.0\"","type":"string"}},"type":"object"},"ReportTemplateAttachmentSchema":{"properties":{"data":{"type":"string","writeOnly":true},"id":{"readOnly":true,"type":"integer"},"name":{"readOnly":true,"type":"string"},"url":{"readOnly":true}},"type":"object"},"ReportTemplateDetailSchema":{"properties":{"content":{"nullable":true,"type":"string"},"cover_page_config":{"$ref":"#/components/schemas/CoverPageContainerSchema"},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"description":{"nullable":true,"type":"string"},"id":{"type":"integer"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"last_updated_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"name":{"type":"string"},"property_block_config":{"$ref":"#/components/schemas/PropertyBlockContainerSchema"},"regular_footer_config":{"$ref":"#/components/schemas/RegularHeaderFooterContainerSchema"},"regular_header_config":{"$ref":"#/components/schemas/RegularHeaderFooterContainerSchema"},"sub_title_config":{"$ref":"#/components/schemas/TitleSchema"},"super_title_config":{"$ref":"#/components/schemas/TitleSchema"},"text_styles":{"items":{"$ref":"#/components/schemas/TextStyleSchema"},"type":"array"},"title":{"nullable":true,"type":"string"},"tlp":{"nullable":true,"type":"string"}},"type":"object"},"ReportTemplateSchema":{"properties":{"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"description":{"type":"string"},"id":{"readOnly":true,"type":"integer"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"last_updated_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"name":{"type":"string"}},"required":["name"],"type":"object"},"ReportTemplateSummarySchema":{"properties":{"id":{"description":"ID of the associated report template","nullable":true,"type":"integer"},"sub_title":{"description":"Sub title of the report","nullable":true,"type":"string"},"super_title":{"description":"Super title of the report","nullable":true,"type":"string"}},"type":"object"},"RiskScoreBreakdown":{"properties":{"parameters":{"additionalProperties":{"items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array"},"type":"object"},"policy_id":{"description":"RiskScorePolicy ID/URL","example":"http://localhost/api/v2/risk-score-policy/1","readOnly":true},"score":{"type":"string"}},"required":["score"],"type":"object"},"RiskScoreDecaySchema":{"properties":{"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"last_updated_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"n_days":{"type":"integer"},"observable_type":{"enum":["ja3-full","hash-md5","ipv4-cidr","hash-sha384","inetnum","ipv4","hash-sha224","hash-vhash","hash-authentihash","hash-imphash","hash-sha256","ipv6","hash-ssdeep","ipv6-cidr","domain","ja3s-hash","email-subject","hash-rich-pe-header","actor-id","asn","hash-sha512","email","hash-sha1","ja3-hash","uri","malware"],"type":"string"}},"required":["n_days","observable_type"],"type":"object"},"RiskScoreParameterAPISchema":{"properties":{"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"id":{"type":"integer"},"is_active":{"type":"boolean"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"last_updated_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"name":{"readOnly":true,"type":"string"},"policy_id":{"description":"RiskScorePolicy ID/URL","example":"http://localhost/api/v2/risk-score-policy/1","readOnly":true}},"required":["is_active","name"],"type":"object"},"RiskScoreParameterValueAPISchema":{"properties":{"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"criteria":{"$ref":"#/components/schemas/ParameterValueCriteriaSchema"},"id":{"type":"integer"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"last_updated_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"parameter_id":{"description":"RiskScoreParameter ID/URL","example":"http://localhost/api/v2/risk-score-policy-parameter/1","readOnly":true},"score":{"enum":["Low","Medium","High","Not Set"],"type":"string"}},"required":["criteria","score"],"type":"object"},"RiskScorePolicyAPISchema":{"properties":{"apply_task":{"description":"Task associated to this policy","example":"http://localhost/api/v2/tasks/1","readOnly":true},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"id":{"type":"integer"},"is_active":{"type":"boolean"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"last_updated_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"name":{"type":"string"},"observable_types":{"items":{"enum":["ja3-full","hash-md5","ipv4-cidr","hash-sha384","inetnum","ipv4","hash-sha224","hash-vhash","hash-authentihash","hash-imphash","hash-sha256","ipv6","hash-ssdeep","ipv6-cidr","domain","ja3s-hash","email-subject","hash-rich-pe-header","actor-id","asn","hash-sha512","email","hash-sha1","ja3-hash","uri","malware"],"type":"string"},"type":"array"},"score_thresholds":{"$ref":"#/components/schemas/ScoreThresholdSchema"}},"required":["is_active","name","observable_types"],"type":"object"},"RiskScorePolicyPreviewAPISchema":{"properties":{"observable":{"$ref":"#/components/schemas/ObservableAPISchema"},"score_preview":{"allOf":[{"$ref":"#/components/schemas/RiskScoreBreakdown"}],"nullable":true}},"type":"object"},"RiskScorePolicyPreviewByQueryAPISchema":{"properties":{"observable_query":{"description":"\nFull-text or faceted search with logic operators\nlike `AND` and `OR`.\n\nThe language of the search queries is Lucene and the\ncapability is the same as the one in Intelligence Center\nUI. Read more in [its documentation](\nhttps://docs.eclecticiq.com/ic/3.1.0/get-to-know-the-ic/search/).\n","example":"data.title:malware OR data.description:APT17","type":"string"},"time_zone":{"description":"Timezone in Coordinated Universal Time (UTC) offset format","example":"+01:00 or -08:00","pattern":"[\\+,-][0-9][0-9]:[0-9][0-9]"}},"required":["observable_query"],"type":"object"},"RoleAPISchema":{"properties":{"created_at":{"description":"User role creation date (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"description":{"type":"string"},"id":{"description":"Role ID","readOnly":true,"type":"integer"},"last_updated_at":{"description":"User role last update date (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"name":{"description":"Role name","example":"admin","type":"string"},"permissions":{"description":"List of permissions associated to this role","example":["http://localhost/api/v2/permissions/1"],"items":{"description":"Permissions ID/URL","example":"http://localhost/api/v2/permissions/1"},"type":"array"},"users":{"description":"List of users associated to this role","example":["http://localhost/api/v2/users/1"],"items":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"readOnly":true,"type":"array"}},"required":["id","name"],"type":"object"},"RolesSchema":{"properties":{"value":{"enum":["Aggregator","Content Enhancer/Refiner","Initial Author","Transformer/Translator"],"type":"string"},"value_vocab":{"default":"{http://stix.mitre.org/default_vocabularies-1}InformationSourceRoleVocab-1.0","description":"Constant field, must have a value of \"{http://stix.mitre.org/default_vocabularies-1}InformationSourceRoleVocab-1.0\"","type":"string"}},"type":"object"},"RuleAPISchema":{"properties":{"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"description":{"nullable":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"is_active":{"type":"boolean"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"name":{"type":"string"},"status":{"description":"Status of the latest rule task execution","enum":["PENDING","SENT","STARTED","RETRY","FAILURE","REVOKED","CAP_REACHED","WARNING","SUCCESS",null],"nullable":true,"readOnly":true,"type":"string"}},"required":["is_active","name"],"type":"object"},"SandboxDetonationSchema":{"properties":{"completed_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"detonation_type":{"enum":["hash","url","file"],"type":"string"},"detonator_task_id":{"type":"integer"},"detonator_task_name":{"readOnly":true,"type":"string"},"error_result":{"readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"job_id":{"readOnly":true,"type":"string"},"name":{"type":"string"},"parameters":{"type":"object"},"report_supported_type":{"items":{"type":"string"},"readOnly":true,"type":"array"},"scan_type":{"enum":["Static","Dynamic"],"type":"string"},"status":{"enum":["Success","Processing","Failed","Pending"],"readOnly":true,"type":"string"},"terms_accepted":{"type":"boolean"},"vendor_report_url":{"nullable":true,"readOnly":true,"type":"string"},"verdict":{"enum":["Suspicious","Informative","Unknown","Malicious","Not Detonated"],"readOnly":true,"type":"string"},"verdict_reason":{"readOnly":true,"type":"string"}},"required":["detonation_type","name","scan_type","terms_accepted"],"type":"object"},"SandboxReportSchema":{"properties":{"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"html_report":{"type":"string"},"id":{"readOnly":true,"type":"integer"},"sandbox_detonation_id":{"readOnly":true,"type":"integer"}},"type":"object"},"SandboxResultSchema":{"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"string"},"description":{"nullable":true,"type":"string"},"entities":{"items":{"$ref":"#/components/schemas/DetonationResultEntitySchema"},"nullable":true,"type":"array"},"extracts":{"items":{"$ref":"#/components/schemas/DetonationResultExtractSchema"},"nullable":true,"type":"array"},"id":{"readOnly":true,"type":"integer"},"mitres":{"items":{"$ref":"#/components/schemas/DetonationMitreAttackSchema"},"nullable":true,"type":"array"},"tags":{"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"},"ScoreThresholdSchema":{"properties":{"high_score_threshold":{"description":"Minimal number of parameters that need to score High for an overall High score","type":"integer"},"medium_score_threshold":{"description":"Minimal number of parameters that need to score Mediun for an overall Medium score","type":"integer"}},"required":["high_score_threshold","medium_score_threshold"],"type":"object"},"SightingDataSchema":{"additionalProperties":true,"properties":{"confidence":{"enum":["unknown","none","high","low","medium"],"type":"string"},"custom_attributes":{},"description":{"type":"string"},"description_structuring_format":{"type":"string"},"id":{"description":"STIX ID to uniquely identify the object. If none is specified on an entity payload then the platform will automatically generate a STIX ID in the format `{platform-namespace-url}type-UUID`.","example":"{https://example.com}indicator-da747dd9-5564-44e1-aa24-8b527dfb8868","minLength":1,"type":"string"},"impact":{"$ref":"#/components/schemas/SightingImpactSchema"},"raw_events":{"type":"string"},"security_control":{"$ref":"#/components/schemas/ProducerSchema"},"short_description":{"type":"string"},"timestamp":{"description":"Entity timestamp (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"title":{"type":"string"},"type":{"enum":["attack-pattern","campaign","course-of-action","exploit-target","identity","incident","indicator","infrastructure","intrusion-set","location","malware","malware-analysis","report","eclecticiq-sighting","threat-actor","tool","ttp","custom-entity"],"type":"string"}},"required":["title","type"],"type":"object"},"SightingImpactSchema":{"properties":{"type":{"default":"statement","description":"Constant field, must have a value of \"statement\"","type":"string"},"value":{"enum":["High","Low","Medium","None","Unknown"],"type":"string"},"value_vocab":{"default":"{http://stix.mitre.org/default_vocabularies-1}HighMediumLowVocab-1.0","description":"Constant field, must have a value of \"{http://stix.mitre.org/default_vocabularies-1}HighMediumLowVocab-1.0\"","type":"string"}},"type":"object"},"SimplifiedRelationalQueryAPISchema":{"properties":{"include_indirectly_related":{"default":false,"description":"This flag when set to `True` allows to also include the entities that related indirectly to the other query. An indirect relation means that another entity, without specific criteria, connect entities from both queries. By default, it is `False` so only the entities directly related are returned. ","type":"boolean"},"output":{"description":"choose which nodes of relational query to return, either `query_1` or `query_2` is a valid option","enum":["query_1","query_2"],"type":"string"},"query_1":{"description":"\nFull-text or faceted search with logic operators\nlike `AND` and `OR`.\n\nThe language of the search queries is Lucene and the\ncapability is the same as the one in Intelligence Center\nUI. Read more in [its documentation](\nhttps://docs.eclecticiq.com/ic/3.1.0/get-to-know-the-ic/search/).\n","example":"data.title:malware OR data.description:APT17","type":"string"},"query_2":{"description":"\nFull-text or faceted search with logic operators\nlike `AND` and `OR`.\n\nThe language of the search queries is Lucene and the\ncapability is the same as the one in Intelligence Center\nUI. Read more in [its documentation](\nhttps://docs.eclecticiq.com/ic/3.1.0/get-to-know-the-ic/search/).\n","example":"data.title:malware OR data.description:APT17","type":"string"},"relation_query":{"description":"Elasticsearch query for relationship object itself (defaults to `*`)","example":"data.title:malware OR data.description:APT17","type":"string"}},"required":["output","query_1","query_2","relation_query"],"type":"object"},"SnortTestMechanismTypeSchema":{"properties":{"efficacy":{"$ref":"#/components/schemas/TestMechanismEfficacySchema"},"event_filters":{"items":{"$ref":"#/components/schemas/ValueSchema"},"type":"array"},"event_suppressions":{"items":{"$ref":"#/components/schemas/ValueSchema"},"type":"array"},"producer":{"$ref":"#/components/schemas/ProducerSchema"},"product_name":{"type":"string"},"rate_filters":{"items":{"$ref":"#/components/schemas/ValueSchema"},"type":"array"},"rules":{"items":{"$ref":"#/components/schemas/TestMechanismRulesSchema"},"type":"array"},"test_mechanism_type":{"enum":["generic","snort","yara"],"type":"string"},"type":{"default":"test-mechanism","description":"Constant field, must have a value of \"test-mechanism\"","type":"string"},"version":{"minLength":1,"type":"string"}},"required":["test_mechanism_type","version"],"type":"object"},"SourceAPISchema":{"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"last_updated_at":{"format":"date-time","readOnly":true,"type":"string"},"name":{"type":"string"},"reliability":{"enum":["A","B","C","D","E","F",null],"nullable":true,"type":"string"},"source_type":{"type":"string"}},"required":["id"],"type":"object"},"StandaloneApiAccountPolicySchema":{"properties":{"account_policy_enabled":{},"last_updated_at":{"format":"date-time","readOnly":true,"type":"string"},"lockout_attempts":{"default":5,"maximum":1000,"minimum":0,"type":"integer"},"password_min_length":{"default":10,"maximum":64,"minimum":8,"type":"integer"},"password_requires_capital_letters":{"default":true,"type":"boolean"},"password_requires_numbers":{"default":true,"type":"boolean"},"password_requires_special_chars":{"default":true,"type":"boolean"},"password_reset_link_expiry_in_seconds":{"default":604800,"maximum":31536000,"minimum":3600,"type":"integer"},"two_factor_authn_enforced":{"type":"boolean"},"two_factor_suspension_min":{"maximum":525600,"minimum":0,"type":"integer"},"type":{"type":"string"}},"required":["type"],"type":"object"},"StatementSchema":{"properties":{"confidence":{"description":"This object will be validated with a schema selected based on the value of the \"value_vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"ConfidenceSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/ConfidenceSchema","{http://stix.mitre.org/default_vocabularies-1}HighMediumLowVocab-1.0":"#/components/schemas/ConfidenceHighMediumLowVocabSchema"},"propertyName":"value_vocab"},"oneOf":[{"$ref":"#/components/schemas/ConfidenceHighMediumLowVocabSchema"},{"$ref":"#/components/schemas/ConfidenceSchema"}],"properties":{"value_vocab":{"enum":["{http://stix.mitre.org/default_vocabularies-1}HighMediumLowVocab-1.0","*"],"type":"string"}},"type":"object"},"description":{"type":"string"},"description_structuring_format":{"type":"string"},"id":{"type":"string"},"idref":{"type":"string"},"timestamp":{"format":"date-time","nullable":true,"type":"string"},"timestamp_precision":{"enum":["year","month","day","hour","minute","second"],"type":"string"},"type":{"default":"statement","description":"Constant field, must have a value of \"statement\"","type":"string"},"value":{"type":"string"},"value_vocab":{"type":"string"},"value_vocab_name":{"type":"string"},"value_vocab_reference":{"type":"string"}},"required":["type"],"type":"object"},"SystemConfigurationSchema":{"properties":{"data":{"description":"This object will be validated with a schema selected based on the value of the \"type\" property.","discriminator":{"mapping":{"account-policy":"#/components/schemas/ApiAccountPolicySchema","configuration-bundles-producer":"#/components/schemas/ApiConfigurationBundlesProducerConfigSchema","email":"#/components/schemas/ApiEmailSchema","intel-report":"#/components/schemas/ApiIntelReportSchema","license":"#/components/schemas/ApiLicenseSchema","private-key":"#/components/schemas/ApiPrivateKeySchema","server":"#/components/schemas/ApiServerSchema","stix":"#/components/schemas/ApiStixSchema","trusted-public-keys":"#/components/schemas/ApiPublicKeysSchema"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ApiAccountPolicySchema"},{"$ref":"#/components/schemas/ApiConfigurationBundlesProducerConfigSchema"},{"$ref":"#/components/schemas/ApiEmailSchema"},{"$ref":"#/components/schemas/ApiIntelReportSchema"},{"$ref":"#/components/schemas/ApiLicenseSchema"},{"$ref":"#/components/schemas/ApiPrivateKeySchema"},{"$ref":"#/components/schemas/ApiServerSchema"},{"$ref":"#/components/schemas/ApiStixSchema"},{"$ref":"#/components/schemas/ApiPublicKeysSchema"}],"properties":{"type":{"enum":["account-policy","configuration-bundles-producer","email","intel-report","license","private-key","server","stix","trusted-public-keys"],"type":"string"}},"required":["type"],"type":"object"}},"required":["data"],"type":"object"},"SystemSettingSchema":{"properties":{"data":{"description":"This object will be validated with a schema selected based on the value of the \"type\" property.","discriminator":{"mapping":{"ai_provider_feature_availability":"#/components/schemas/AiProviderFeatureAvailabilitySchema"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AiProviderFeatureAvailabilitySchema"}],"properties":{"type":{"enum":["ai_provider_feature_availability"],"type":"string"}},"readOnly":true,"required":["type"],"type":"object"}},"type":"object"},"SystemTypeVocabSchema":{"properties":{"value":{"enum":["Enterprise Systems","Enterprise Systems - Application Layer","Enterprise Systems - Database Layer","Enterprise Systems - Enterprise Technologies and Support Infrastructure","Enterprise Systems - Network Systems","Enterprise Systems - Networking Devices","Enterprise Systems - Web Layer","Enterprise Systems - VoIP","Industrial Control Systems","Industrial Control Systems - Equipment Under Control","Industrial Control Systems - Operations Management","Industrial Control Systems - Safety, Protection and Local Control","Industrial Control Systems - Supervisory Control","Mobile Systems","Mobile Systems - Mobile Operating Systems","Mobile Systems - Near Field Communications","Mobile Systems - Mobile Devices","Third-Party Services","Third-Party Services - Application Stores","Third-Party Services - Cloud Services","Third-Party Services - Security Vendors","Third-Party Services - Social Media","Third-Party Services - Software Update","Users","Users - Application And Software","Users - Workstation","Users - Removable Media"],"type":"string"},"vocab":{"default":"{http://stix.mitre.org/default_vocabularies-1}SystemTypeVocab-1.0","description":"Constant field, must have a value of \"{http://stix.mitre.org/default_vocabularies-1}SystemTypeVocab-1.0\"","type":"string"}},"required":["value"],"type":"object"},"TTPBehaviorAttackPatternSchema":{"properties":{"capec_id":{"type":"string"},"description":{"type":"string"},"description_structuring_format":{"type":"string"},"id":{"minLength":1,"type":"string"},"idref":{"minLength":1,"type":"string"},"short_description":{"type":"string"},"short_description_structuring_format":{"type":"string"},"title":{"type":"string"},"type":{"default":"attack-pattern","description":"Constant field, must have a value of \"attack-pattern\"","type":"string"}},"required":["type"],"type":"object"},"TTPBehaviorExploitSchema":{"properties":{"description":{"type":"string"},"description_structuring_format":{"type":"string"},"id":{"minLength":1,"type":"string"},"idref":{"minLength":1,"type":"string"},"short_description":{"type":"string"},"short_description_structuring_format":{"type":"string"},"title":{"type":"string"},"type":{"default":"exploit","description":"Constant field, must have a value of \"exploit\"","type":"string"}},"required":["type"],"type":"object"},"TTPBehaviorMalwareSchema":{"properties":{"description":{"type":"string"},"description_structuring_format":{"type":"string"},"id":{"minLength":1,"type":"string"},"idref":{"minLength":1,"type":"string"},"names":{"items":{"$ref":"#/components/schemas/ControlledVocabularyStringSchema"},"type":"array"},"short_description":{"type":"string"},"short_description_structuring_format":{"type":"string"},"title":{"type":"string"},"type":{"default":"malware-instance","description":"Constant field, must have a value of \"malware-instance\"","type":"string"},"types":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"ControlledVocabularyStringSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/ControlledVocabularyStringSchema","{http://stix.mitre.org/default_vocabularies-1}MalwareTypeVocab-1.0":"#/components/schemas/MalwareTypeVocabSchema1"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/MalwareTypeVocabSchema1"},{"$ref":"#/components/schemas/ControlledVocabularyStringSchema"}],"properties":{"vocab":{"enum":["{http://stix.mitre.org/default_vocabularies-1}MalwareTypeVocab-1.0","*"],"type":"string"}},"type":"object"},"type":"array"}},"required":["type"],"type":"object"},"TTPBehaviorSchema":{"properties":{"attack_patterns":{"items":{"$ref":"#/components/schemas/TTPBehaviorAttackPatternSchema"},"type":"array"},"exploits":{"items":{"$ref":"#/components/schemas/TTPBehaviorExploitSchema"},"type":"array"},"malware":{"items":{"$ref":"#/components/schemas/TTPBehaviorMalwareSchema"},"type":"array"},"type":{"default":"behavior","description":"Constant field, must have a value of \"behavior\"","type":"string"}},"required":["type"],"type":"object"},"TTPResourceInfrastructureSchema":{"properties":{"description":{"type":"string"},"description_structuring_format":{"type":"string"},"id":{"minLength":1,"type":"string"},"idref":{"minLength":1,"type":"string"},"short_description":{"type":"string"},"short_description_structuring_format":{"type":"string"},"title":{"type":"string"},"type":{"default":"infrastructure","description":"Constant field, must have a value of \"infrastructure\"","type":"string"},"types":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"ControlledVocabularyStringSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/ControlledVocabularyStringSchema","{http://stix.mitre.org/default_vocabularies-1}AttackerInfrastructureTypeVocab-1.0":"#/components/schemas/AttackerInfrastructureTypeVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/AttackerInfrastructureTypeVocabSchema"},{"$ref":"#/components/schemas/ControlledVocabularyStringSchema"}],"properties":{"vocab":{"enum":["{http://stix.mitre.org/default_vocabularies-1}AttackerInfrastructureTypeVocab-1.0","*"],"type":"string"}},"type":"object"},"type":"array"}},"required":["type"],"type":"object"},"TTPResourceSchema":{"properties":{"infrastructure":{"$ref":"#/components/schemas/TTPResourceInfrastructureSchema"},"personas":{"items":{"$ref":"#/components/schemas/IdentitySchema"},"type":"array"},"tools":{"items":{"$ref":"#/components/schemas/AttackerToolInformationSchema"},"type":"array"},"type":{"default":"resource","description":"Constant field, must have a value of \"resource\"","type":"string"}},"required":["type"],"type":"object"},"TTPVictimTargetingSchema":{"properties":{"identity":{"$ref":"#/components/schemas/CIQIdentitySchema"},"targeted_information":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"ControlledVocabularyStringSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/ControlledVocabularyStringSchema","{http://stix.mitre.org/default_vocabularies-1}InformationTypeVocab-1.0":"#/components/schemas/InformationTypeVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/InformationTypeVocabSchema"},{"$ref":"#/components/schemas/ControlledVocabularyStringSchema"}],"properties":{"vocab":{"enum":["{http://stix.mitre.org/default_vocabularies-1}InformationTypeVocab-1.0","*"],"type":"string"}},"type":"object"},"type":"array"},"targeted_systems":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"ControlledVocabularyStringSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/ControlledVocabularyStringSchema","{http://stix.mitre.org/default_vocabularies-1}SystemTypeVocab-1.0":"#/components/schemas/SystemTypeVocabSchema"},"propertyName":"vocab"},"oneOf":[{"$ref":"#/components/schemas/SystemTypeVocabSchema"},{"$ref":"#/components/schemas/ControlledVocabularyStringSchema"}],"properties":{"vocab":{"enum":["{http://stix.mitre.org/default_vocabularies-1}SystemTypeVocab-1.0","*"],"type":"string"}},"type":"object"},"type":"array"},"type":{"default":"victim-targeting","description":"Constant field, must have a value of \"victim-targeting\"","type":"string"}},"required":["type"],"type":"object"},"TaskAPISchema":{"properties":{"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"is_active":{"type":"boolean"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"name":{"type":"string"},"parameters":{},"related_object":{"description":"URL of the object associated with this task. It can be a rule, a feed or an enricher.","example":"http://localhost/api/v2/entity_rules/1","format":"url","nullable":true,"readOnly":true,"type":"string"},"runs":{"description":"List containing the 10 most recent runs of this task","example":["http://localhost/api/v2/tasks/runs/1"],"items":{"description":"Task run ID/URL","example":"http://localhost/api/v2/tasks/runs/1","readOnly":true},"readOnly":true,"type":"array"},"type":{"readOnly":true,"type":"string"}},"required":["name"],"type":"object"},"TaskExecutionScheduleParametersSchema":{"properties":{"day_of_month":{"default":"*","description":"A cron field: `*`, `5`, `*/4`.","example":"*","type":"string"},"day_of_week":{"default":"*","description":"A cron field: `*`, `5`, `*/4`.","example":"*","type":"string"},"hour":{"default":"*","description":"A cron field: `*`, `5`, `*/4`.","example":"*","type":"string"},"minute":{"default":"0","description":"A cron field: `*`, `5`, `*/4`.","example":"*","type":"string"},"month_of_year":{"default":"*","description":"A cron field: `*`, `5`, `*/4`.","example":"*","type":"string"}},"type":"object"},"TaskExecutionScheduleSchema":{"properties":{"parameters":{"allOf":[{"$ref":"#/components/schemas/TaskExecutionScheduleParametersSchema"}],"description":"The schedule is automatically adjusted from the timezone to run accordingly on UTC on the server. This is only adjusted as long as no range, step or list is used in the `hour` and `minute` parts."},"timezone":{"description":"If not provided, the value is inferred in order from the user setting, system setting or UTC.","example":"Europe/Amsterdam","type":"string"},"type":{"enum":["cron"],"type":"string"}},"required":["parameters","type"],"type":"object"},"TaskGroupAPISchema":{"properties":{"id":{"format":"uuid","type":"string"},"task_runs":{"items":{"$ref":"#/components/schemas/TaskRunProgressAPISchema"},"type":"array"}},"required":["id"],"type":"object"},"TaskRunAPISchema":{"properties":{"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"group_id":{"format":"uuid","readOnly":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"parameters":{"nullable":true,"type":"object"},"result":{"nullable":true},"status":{"enum":["PENDING","SENT","STARTED","RETRY","FAILURE","REVOKED","CAP_REACHED","WARNING","SUCCESS"],"readOnly":true,"type":"string"},"task":{"description":"URL of the associated task","example":"http://localhost/api/v2/tasks/1"},"triggered_by":{"description":"User that triggered the task","example":"http://localhost/api/v2/users/1","nullable":true,"readOnly":true}},"required":["id"],"type":"object"},"TaskRunGroupAPISchema":{"properties":{"id":{"format":"uuid","type":"string"},"runs_per_status":{"additionalProperties":{"type":"integer"},"readOnly":true,"type":"object"},"status":{"description":"The aggregated status of the whole group, if at least one run in the group is 'FAILURE'/'PENDING', the group status is 'FAILURE'/'PENDING', if all runs have a 'SUCCESS' status, the group status is 'SUCCESS'.","enum":["PENDING","SENT","STARTED","RETRY","FAILURE","REVOKED","CAP_REACHED","WARNING","SUCCESS"],"type":"string"},"total_task_runs":{"type":"integer"}},"required":["id"],"type":"object"},"TaskRunProgressAPISchema":{"properties":{"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"id":{"format":"uuid","type":"string"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"parameters":{"nullable":true,"readOnly":true,"type":"object"},"progress_details":{"additionalProperties":{"enum":["PENDING","SENT","STARTED","RETRY","FAILURE","REVOKED","CAP_REACHED","WARNING","SUCCESS"],"type":"string"},"nullable":true,"readOnly":true,"type":"object"},"progress_status":{"enum":["PENDING","SENT","STARTED","RETRY","FAILURE","REVOKED","CAP_REACHED","WARNING","SUCCESS"],"readOnly":true,"type":"string"},"result":{"nullable":true,"readOnly":true,"type":"object"},"task":{"description":"Task ID/URL","example":"http://localhost/api/v2/tasks/1","readOnly":true}},"required":["id","task"],"type":"object"},"TaxonomyNodeAPISchema":{"properties":{"children":{"description":"URLs of the children nodes","example":["http://localhost/api/v2/taxonomies/1"],"items":{"description":"Taxonomy ID, URL or path expressed as a lists of strings","example":"http://localhost/api/v2/taxonomies/1"},"type":"array"},"code":{"description":"The ``code`` of a taxonomy node is only used\n        in the built-in Admiralty Code taxonomy.\n\n        It expects a single character\n        that corresponds to one of the two-letter\n        Admiralty Code system.\n        E.g., 'A' represents a source reliability of 'Completely reliable'.\n        ","nullable":true,"type":"string"},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"description":{"nullable":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"is_system_defined":{"description":"True if this is a system-defined taxonomy node (in such case this node cannot be edited/deleted)","nullable":true,"readOnly":true,"type":"boolean"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"name":{"type":"string"},"parent":{"description":"URL of the parent node, or null if this is a root node","example":"http://localhost/api/v2/taxonomies/1","nullable":true}},"type":"object"},"TerminologyCustomizationSchema":{"properties":{"abbreviation":{"readOnly":true,"type":"string"},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"custom_plural":{"maxLength":50,"nullable":true,"pattern":"^[^<>\\[\\]{}\\/\\\\\\\"';:|?*^%$#@=+~]*$","type":"string"},"custom_singular":{"maxLength":50,"nullable":true,"pattern":"^[^<>\\[\\]{}\\/\\\\\\\"';:|?*^%$#@=+~]*$","type":"string"},"custom_starts_with_vowel":{"nullable":true,"type":"boolean"},"default_plural":{"readOnly":true,"type":"string"},"default_singular":{"readOnly":true,"type":"string"},"default_starts_with_vowel":{"readOnly":true,"type":"boolean"},"id":{"type":"integer"},"key":{"readOnly":true,"type":"string"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"last_updated_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true}},"required":["id"],"type":"object"},"TermsItemSchema":{"properties":{"links":{"additionalProperties":{"$ref":"#/components/schemas/TermsLinkDetailSchema"},"nullable":true,"type":"object"},"text":{"type":"string"}},"required":["text"],"type":"object"},"TermsLinkDetailSchema":{"properties":{"external_link":{"type":"string"},"text":{"type":"string"}},"required":["external_link","text"],"type":"object"},"TermsSchema":{"properties":{"terms":{"items":{"$ref":"#/components/schemas/TermsItemSchema"},"readOnly":true,"type":"array"}},"type":"object"},"TestMechanismEfficacySchema":{"properties":{"type":{"default":"statement","description":"Constant field, must have a value of \"statement\"","type":"string"},"value":{"enum":["High","Low","Medium","None","Unknown"],"type":"string"}},"type":"object"},"TestMechanismRulesSchema":{"properties":{"value":{"minLength":1,"type":"string"}},"required":["value"],"type":"object"},"TextStyleSchema":{"properties":{"font_color":{"nullable":true,"type":"string"},"font_family_id":{"type":"integer"},"id":{"type":"integer"},"meta":{"type":"object"},"type":{"enum":["titles_and_headings","paragraphs_and_links"],"type":"string"}},"required":["id"],"type":"object"},"ThreatActorRoleVocabSchema":{"properties":{"value":{"enum":["agent","director","independent","infrastructure-architect","infrastructure-operator","malware-author","sponsor"],"type":"string"},"vocab":{"default":"threat-actor-role-ov","description":"Constant field, must have a value of \"threat-actor-role-ov\"","type":"string"}},"required":["value"],"type":"object"},"ThreatActorSophisticationVocabSchema":{"properties":{"value":{"enum":["none","minimal","intermediate","advanced","expert","innovator","strategic"],"type":"string"},"vocab":{"default":"threat-actor-sophistication-ov","description":"Constant field, must have a value of \"threat-actor-sophistication-ov\"","type":"string"}},"required":["value"],"type":"object"},"ThreatActorTypeVocabSchema":{"properties":{"value":{"enum":["activist","competitor","crime-syndicate","criminal","hacker","insider-accidental","insider-disgruntled","nation-state","sensationalist","spy","terrorist","unknown"],"type":"string"},"vocab":{"default":"threat-actor-type-ov","description":"Constant field, must have a value of \"threat-actor-type-ov\"","type":"string"}},"required":["value"],"type":"object"},"TicketAPISchema":{"properties":{"assignee":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1"},"comments":{"description":"[Collection of] Ticket comment ID/URL","example":["http://localhost/api/v2/tickets/comments/1"],"items":{"description":"Ticket comment ID/URL","example":"http://localhost/api/v2/tickets/comments/1","readOnly":true},"readOnly":true,"type":"array"},"created_at":{"format":"date-time","readOnly":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"description":{"nullable":true,"type":"string"},"done_at":{"format":"date-time","readOnly":true,"type":"string"},"due_date":{"format":"date","nullable":true,"type":"string"},"entities":{"description":"[Collection of] Entity ID/URL","example":["http://localhost/api/v2/entities/0c1e0600-187a-49b4-8bc4-a4323dbab780"],"items":{"description":"Entity ID/URL","example":"http://localhost/api/v2/entities/0c1e0600-187a-49b4-8bc4-a4323dbab780"},"type":"array"},"guidance":{"nullable":true,"type":"string"},"id":{"type":"integer"},"last_updated_at":{"format":"date-time","readOnly":true,"type":"string"},"last_updated_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"name":{"type":"string"},"stakeholders":{"description":"[Collection of] User ID/URL","example":["http://localhost/api/v2/users/1"],"items":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1"},"type":"array"},"status":{"default":"OPEN","enum":["","OPEN","IN PROGRESS","DONE","CANCELLED"],"type":"string"},"workspaces":{"description":"[Collection of] Workspace ID/URL","example":["http://localhost/api/v2/workspaces/1"],"items":{"description":"Workspace ID/URL","example":"http://localhost/api/v2/workspaces/1"},"type":"array"}},"required":["name"],"type":"object"},"TicketCommentAPISchema":{"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"id":{"type":"integer"},"last_updated_at":{"format":"date-time","readOnly":true,"type":"string"},"last_updated_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"text":{"type":"string"},"ticket":{"description":"Ticket ID/URL","example":"http://localhost/api/v2/tickets/1"}},"required":["text"],"type":"object"},"TimeWindowSchema":{"properties":{"end":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"end_precision":{"enum":["day","hour","minute","month","second","year"],"type":"string"},"start":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"start_precision":{"enum":["day","hour","minute","month","second","year"],"type":"string"},"type":{"default":"valid-time","description":"Constant field, must have a value of \"valid-time\"","type":"string"}},"type":"object"},"TitleSchema":{"properties":{"is_enabled":{"type":"boolean"},"title":{"nullable":true,"type":"string"}},"type":"object"},"ToolInformationSchema":{"properties":{"description":{"type":"string"},"description_structuring_format":{"type":"string"},"hashes":{"items":{"description":"This object will be validated with a schema selected based on the value of the \"hash_type_vocab\" property. If the value doesn't match a specific schema or the property is missing, the schema named \"CyboxHashSchema\" will be used.","discriminator":{"mapping":{"*":"#/components/schemas/CyboxHashSchema","{http://cybox.mitre.org/default_vocabularies-2}HashNameVocab-1.0":"#/components/schemas/CyboxHashNameVocabSchema"},"propertyName":"hash_type_vocab"},"oneOf":[{"$ref":"#/components/schemas/CyboxHashNameVocabSchema"},{"$ref":"#/components/schemas/CyboxHashSchema"}],"properties":{"hash_type_vocab":{"enum":["{http://cybox.mitre.org/default_vocabularies-2}HashNameVocab-1.0","*"],"type":"string"}},"type":"object"},"type":"array"},"id":{"type":"string"},"idref":{"type":"string"},"name":{"type":"string"},"service_pack":{"type":"string"},"type":{"default":"tool-information","description":"Constant field, must have a value of \"tool-information\"","type":"string"},"types":{"items":{"$ref":"#/components/schemas/CyboxControlledVocabularySchema"},"type":"array"},"vendor":{"type":"string"},"version":{"type":"string"}},"required":["type"],"type":"object"},"ToolTypeVocabSchema":{"properties":{"value":{"enum":["denial-of-service","exploitation","information-gathering","network-capture","credential-exploitation","remote-access","vulnerability-scanning","unknown"],"type":"string"},"vocab":{"default":"tool-type-ov","description":"Constant field, must have a value of \"tool-type-ov\"","type":"string"}},"required":["value"],"type":"object"},"TranslationRequestSchema":{"properties":{"keep_html_formatting":{"description":"If translated text should keep the html tags.","type":"boolean"},"target_language":{"enum":["Albanian","Arabic","Bosnian","Bulgarian","Chinese(Simplified)","Chinese(Traditional)","Croatian","Czech","Danish","Dutch","English","Estonian","Farsi(Persian)","Finnish","French","German","Greek","Hebrew","Hindi","Hungarian","Icelandic","Italian","Japanese","Korean","Latvian","Lithuanian","Macedonian","Norwegian","Polish","Portuguese","Romanian","Russian","Serbian","Slovak","Slovenian","Spanish","Swedish","Turkish","Ukrainian"],"type":"string"},"text":{"description":"Translate provided text snippet.","minLength":1,"type":"string"}},"required":["keep_html_formatting","target_language","text"],"type":"object"},"TranslationResponseSchema":{"properties":{"output_text":{"type":"string"}},"type":"object"},"UploadedBlobAPISchema":{"properties":{"archive_password":{"type":"string"},"blob_id":{"readOnly":true,"type":"integer"},"category":{"enum":["malware-sandbox","manual","entity-extraction"],"type":"string"},"content_type":{"enum":["urn:spycloud.io:json:1.0","urn:spycloud.io:data-json:1.0","urn:eclecticiq.com:advanced-csv-entities:1.0"],"type":"string"},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"csv_mapping":{"description":"CSV Mapping linked to the uploaded blob","example":"http://localhost/api/v2/csv-mappings/1"},"csv_mapping_inline":{"$ref":"#/components/schemas/CSVMappingInlineSchema"},"filename":{"default":"untitled","type":"string"},"group_id":{"readOnly":true},"has_valid_signature":{"type":"boolean"},"id":{"type":"integer"},"information_source":{},"mime_type":{"type":"string"},"notification_metadata":{"description":"Details of the data included in the notification response.","type":"object"},"processing_details":{"readOnly":true},"processing_status":{"readOnly":true},"require_content_validation":{"type":"boolean"},"require_link_types":{"type":"boolean"},"size":{"readOnly":true,"type":"integer"},"source":{"description":"Source associated to this object. (ID/URL)","example":"http://localhost/api/v2/sources/f2131e00-a34d-45bc-8cef-77fe793c6e08"},"source_reliability":{"enum":["A","B","C","D","E","F",null],"nullable":true,"type":"string"},"tlp_color_override":{"description":"The values `CLEAR` and `AMBER_STRICT` are also accepted as an input but converted to TLP v1 on the response side.","enum":["NONE","WHITE","GREEN","AMBER","RED"],"nullable":true,"type":"string"}},"required":["content_type","source"],"type":"object"},"UserAPISchema":{"properties":{"activation_link":{"description":"This field is specified if the user has not been activated yet, and it is only visible to the user itself and to platform admins","format":"url","readOnly":true,"type":"string"},"created_at":{"description":"User creation date (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"default_source":{"description":"\nThe default source that will be attached when an entity is created by the user and no\nsource is provided. The default source can be manually defined else it will be the most\nrecent accessible source.\n\nIf the user has no accessible source, then `None` is returned. Only a source id of a\ngroup is accepted.\n","example":"http://localhost/api/v2/sources/ca9041c8-9c35-4f6e-877f-90d103e51f4b","nullable":true},"email":{"description":"User email address","example":"admin@localhost","type":"string"},"first_name":{"description":"User first name","type":"string"},"groups":{"description":"List of groups the user is subscribed to, together with the role. Possible values for roles: ['admin', 'member']","example":["http://localhost/api/v2/groups/1?role=member"],"items":{"description":"Group ID/URL associated to a group,together with its role. Possible values: ('member', 'admin'))","example":"http://localhost/api/v2/groups/1?role=member"},"type":"array"},"has_mfa_activated":{"description":"True if the user has multi-factor authentication enabled","readOnly":true,"type":"boolean"},"id":{"description":"User ID","readOnly":true,"type":"integer"},"is_admin":{"description":"The user is a platform admin. This flag can only be modified by other admin users","type":"boolean"},"last_name":{"description":"User last name","type":"string"},"last_updated_at":{"description":"User last update (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"password_last_updated_at":{"description":"When the user password was last updated (UTC ISO-8601 format)","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"permissions":{"description":"List of permissions associated to the user","example":["http://localhost/api/v2/permissions/1"],"items":{"description":"Permissions ID/URL","example":"http://localhost/api/v2/permissions/1","readOnly":true},"readOnly":true,"type":"array"},"roles":{"description":"List of roles associated to the user","example":["http://localhost/api/v2/roles/1"],"items":{"description":"Role ID/URL/name","example":"http://localhost/api/v2/roles/1"},"type":"array"},"sources":{"description":"[Collection of] List of sources the user is allowed to access.","example":["http://localhost/api/v2/sources/71980b87-87da-487a-ba02-0734fec178fc?allowed_tlp=RED"],"items":{"description":"List of sources the user is allowed to access.","example":"http://localhost/api/v2/sources/71980b87-87da-487a-ba02-0734fec178fc?allowed_tlp=RED","readOnly":true},"readOnly":true,"type":"array"},"status":{"description":"User status","enum":["inactive","locked","password reset requested","pending","active"],"type":"string"},"user_data":{"allOf":[{"$ref":"#/components/schemas/UserDataSchema"}],"description":"\n        This object contains specific information related to the user.\n\n        For storing custom data related to a user although any keys is accepted, there\n        is some best-practice for forward compatibility if EIQ will reserve more keys.\n\n        1. Use root keys as little as possible, instead group the keys in a \"namespace\"\n           key.\n        2. Prefer descriptive and non-generic names to avoid collision.\n        ","nullable":true},"username":{"description":"User name","example":"admin","type":"string"}},"required":["id"],"type":"object"},"UserDataSchema":{"additionalProperties":true,"properties":{"dashboard":{"description":"Some internal settings used by the EIQ browser interface.","nullable":true},"default_values":{"allOf":[{"$ref":"#/components/schemas/DefaultValuesSchema"}],"description":"Some default values to be used when the user makes actions."},"theme":{"description":"The theme mode used by the EIQ browser interface.","enum":["auto","light","dark"],"type":"string"},"theme_variant":{"default":"dutch-blue","description":"The theme style used by the EIQ browser interface.","enum":["teal","lavender","dutch-blue","ruby-red"],"type":"string"},"view_states":{"description":"Some internal settings used by the EIQ browser interface."}},"type":"object"},"ValueRequiredSchema":{"properties":{"value":{"minLength":1,"type":"string"}},"required":["value"],"type":"object"},"ValueSchema":{"properties":{"value":{"minLength":1,"type":"string"}},"type":"object"},"ValueSearchInSchema":{"properties":{"fields_to_search":{"description":"List of entity fields to search for a pattern. Supported: ['title', 'tags', 'description']","enum":["title","tags","description"],"items":{"type":"string"},"type":"array"}},"type":"object"},"VendorAPISchema":{"properties":{"category":{"enum":["ticketing","default"],"type":"string"},"description":{"type":"string"},"id":{"type":"integer"},"is_active":{"type":"boolean"},"name":{"readOnly":true,"type":"string"},"parameters":{},"slug":{"readOnly":true},"ui_form_schema":{"readOnly":true}},"required":["category","name"],"type":"object"},"VulnerabilitiesSchema":{"properties":{"affected_software":{"items":{"$ref":"#/components/schemas/ObservableSchema"},"type":"array"},"cve_id":{"type":"string"},"cvss_score":{"$ref":"#/components/schemas/CvssScoreSchema"},"description":{"type":"string"},"discovered_datetime":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"discovered_datetime_precision":{"type":"string"},"is_known":{"type":"boolean"},"is_publicly_acknowledged":{"type":"boolean"},"osvdb_id":{"minimum":1,"type":"integer"},"published_datetime":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"type":"string"},"published_datetime_precision":{"type":"string"},"references":{"items":{"format":"url","type":"string"},"type":"array"},"source":{"type":"string"},"title":{"type":"string"},"type":{"default":"vulnerability","description":"Constant field, must have a value of \"vulnerability\"","type":"string"}},"type":"object"},"WeaknessSchema":{"properties":{"cwe_id":{"type":"string"},"description":{"minLength":1,"type":"string"},"type":{"default":"weakness","description":"Constant field, must have a value of \"weakness\"","type":"string"}},"required":["description"],"type":"object"},"WebEnrichmentSourceSchema":{"properties":{"source_id":{"type":"string"},"source_link":{"type":"string"},"source_name":{"type":"string"}},"type":"object"},"WidgetAPISchema":{"properties":{"category":{"enum":["custom","entity","user","observable","dataset","group","role","system-job"],"type":"string"},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"dashboards":{"description":"[Collection of] Dashboard ID/URL","example":["http://localhost/api/v2/dashboards/1"],"items":{"description":"Dashboard ID/URL","example":"http://localhost/api/v2/dashboards/1"},"type":"array"},"description":{"default":"","nullable":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"last_updated_by":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1","readOnly":true},"name":{"type":"string"},"thumbnail_dark":{"format":"byte","nullable":true,"type":"string","writeOnly":true},"thumbnail_light":{"format":"byte","nullable":true,"type":"string","writeOnly":true},"widget_config":{"type":"object"},"widget_type":{"enum":["overview","information"],"type":"string"},"workspaces":{"description":"[Collection of] Workspace ID/URL","example":["http://localhost/api/v2/workspaces/1"],"items":{"description":"Workspace ID/URL","example":"http://localhost/api/v2/workspaces/1"},"type":"array"}},"required":["category","name","widget_config"],"type":"object"},"WorkspaceAPISchema":{"properties":{"all_collaborators":{"description":"List of all the collaborators of the workspace, including those associated through their groups","example":["http://localhost/api/v2/users/1"],"items":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1"},"type":"array"},"analysis":{"type":"string"},"archived_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"collaborators":{"description":"List of users the workspace has been shared with. Does not include users in groups that the workspace has been shared with.","example":["http://localhost/api/v2/users/1"],"items":{"description":"User ID/URL","example":"http://localhost/api/v2/users/1"},"type":"array"},"comments":{"description":"List of workspace comments","example":["http://localhost/api/v2/workspaces/comments/1"],"items":{"description":"Workspace comment ID/URL","example":"http://localhost/api/v2/workspaces/comments/1","readOnly":true},"readOnly":true,"type":"array"},"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"User that created this workspace","example":"http://localhost/api/v2/users/1","readOnly":true},"datasets":{"description":"List of datasets attached to the workspace. The `public` attribute is set to `True` if the workspace is listed as public and the dataset is visible to everyone.","example":["http://localhost/api/v2/datasets/1?public=True","http://localhost/api/v2/datasets/2?public=False","http://localhost/api/v2/datasets/3?public=True","http://localhost/api/v2/datasets/4?public=False"],"items":{"description":"Dataset ID/URL","example":"http://localhost/api/v2/datasets/1"},"type":"array"},"description":{"type":"string"},"discovery_tasks":{"description":"List of discovery rules associated with the workspace","example":["http://localhost/api/v2/tasks/1"],"items":{"description":"Discovery task ID/URL","example":"http://localhost/api/v2/tasks/1"},"type":"array"},"entities":{"description":"List of public entities attached to the workspace","example":["http://localhost/api/v2/entities/d290fe4d-2238-4376-83b6-2c1e19e9fecf"],"items":{"description":"Entity ID/URL","example":"http://localhost/api/v2/entities/d290fe4d-2238-4376-83b6-2c1e19e9fecf"},"type":"array"},"external_url":{"format":"url","readOnly":true,"type":"string"},"files":{"description":"List of files attached to the workspace","example":["http://localhost/api/v2/files/1?public=True","http://localhost/api/v2/files/2?public=False","http://localhost/api/v2/files/3?public=True","http://localhost/api/v2/files/4?public=False"],"items":{"description":"File ID/URL","example":"http://localhost/api/v2/files/1","readOnly":true},"readOnly":true,"type":"array"},"groups":{"description":"List of user groups the workspace has been shared with","example":["http://localhost/api/v2/groups/1"],"items":{"description":"Group ID/URL","example":"http://localhost/api/v2/groups/1"},"type":"array"},"id":{"readOnly":true,"type":"integer"},"is_archived":{"type":"boolean"},"is_public":{"description":"Set to `True` to make the workspace \"Listed\".\n\n        \"Listed\" workspaces have\n        their name, public description,\n        and \"pinned\" (public) items visible\n        to all users who have at least `read workspaces`\n        permissions. Users still cannot modify\n        these workspaces unless it has been\n        shared with them.\n        ","type":"boolean"},"is_shared_with_all":{"description":"Internal-only value.\n\n        By default, this is set to `True` only\n        for the default public workspace.\n\n        This means the workspace can be accessed\n        by all users with at least\n        `read workspaces` permissions,\n        and modified by all users with\n        at least `modify workspaces` permissions.\n\n        This workspace cannot be deleted.\n        ","readOnly":true,"type":"boolean"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"last_updated_by":{"description":"User that last updated this workspace","example":"http://localhost/api/v2/users/1","readOnly":true},"name":{"type":"string"},"public_datasets":{"description":"List of public datasets attached to the workspace. Internal only - please favourusing `https://your-host/api/<version>/datasets/<id>?public=true` on the datasets field instead of using this field.","example":["http://localhost/api/v2/datasets/1?public=True","http://localhost/api/v2/datasets/2?public=True","http://localhost/api/v2/datasets/3?public=True","http://localhost/api/v2/datasets/4?public=True"],"items":{"description":"Dataset ID/URL","example":"http://localhost/api/v2/datasets/1"},"type":"array"},"public_description":{"type":"string"},"tickets":{"description":"List of tickets for that workspace. Tickets are workspace \"Tasks\" in the UI.","example":["http://localhost/api/v2/tickets/1"],"items":{"description":"Ticket ID/URL","example":"http://localhost/api/v2/tickets/1"},"type":"array"},"type":{"enum":["generic","team","topic","case"],"type":"string"}},"type":"object"},"WorkspaceCommentAPISchema":{"properties":{"created_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"User that created this comment","example":"http://localhost/api/v2/users/1","readOnly":true},"id":{"readOnly":true,"type":"integer"},"last_updated_at":{"description":"Timestamp in UTC ISO-8601 format","example":"2016-12-31T16:28:00+00:00","nullable":true,"readOnly":true,"type":"string"},"last_updated_by":{"description":"User that last updated this comment","example":"http://localhost/api/v2/users/1","readOnly":true},"text":{"type":"string"},"workspace":{"description":"Workspace associated to this comment","example":"http://localhost/api/v2/workspaces/1"}},"type":"object"},"YaraTestMechanismTypeSchema":{"properties":{"efficacy":{"$ref":"#/components/schemas/TestMechanismEfficacySchema"},"producer":{"$ref":"#/components/schemas/ProducerSchema"},"rule":{"$ref":"#/components/schemas/ValueSchema"},"test_mechanism_type":{"enum":["generic","snort","yara"],"type":"string"},"type":{"default":"test-mechanism","description":"Constant field, must have a value of \"test-mechanism\"","type":"string"}},"required":["test_mechanism_type"],"type":"object"}},"securitySchemes":{"access-token":{"bearerFormat":"API Token","description":"IC API access token. Token may have expiration date","scheme":"bearer","type":"http"},"jwt":{"bearerFormat":"JWT","description":"A JSON Web Token. Token expiration depends on system configuration (by default token is valid for 30 minutes)","scheme":"bearer","type":"http"}}},"info":{"description":"# EclecticIQ Platform API Documentation\n\n## API root and reference\n\nThe API root is located at `https://<platform_host>/api/v2`\n\nGET the API root endpoint (`https://<platform_host>/api/v2`)\nto retrieve an OpenAPI 3-compatible specifications for the API.\n\nInstalling the package on an EclecticIQ Platform instance\nlets you access the API reference, available through Redoc interface,\nthrough `https://<platform_host>/api/v2/docs/`.\n\n## Schema\n\nAll request and response payloads\nencapsulate parameters in a `data` object:\n\n```javascript\n{\n    \"data\": [\n        {\n        // parameters\n        }\n    ]\n}\n```\n\nTimestamps are returned in ISO 8601 format.\nFor example: `2017-11-30T10:04:07.890853+00:00`\n\n## Content Type\n\nAll requests and responses should expect\nthe `application/json` content type:\n\n```\nContent-Type: application/json\nAccept: application/json\n```\n\n## Authentication\n\nRequests are authenticated through the following HTTP header:\n\n```\n\"Authorization: Bearer $EIQ_TOKEN\"\n```\n\n### Generate API tokens\n\nTo generate an API token:\n\n- Open the EclecticIQ web interface\n- Select your profile (bottom-left corner of the screen)\n- Click _My Profile_\n- Scroll to _API Tokens_\n- Click _Create API Token_\n\n## Pagination\n\nResponses contain a maximum of `100` items per page by default.\n\nTo retrieve more than `100` items from an endpoint\nmake your request with these parameters:\n\n| Parameter     | Description                                                                      |\n| ------------- | -------------------------------------------------------------------------------- |\n| `?limit=<n>`  | Set the number of items the endpoints should respond with.                       |\n| `?offset=<n>` | Retrieve responses from a given endpoint starting from the (zero-based) index n. |\n\nExcept if mentioned otherwise on the endpoint documentation, the maximum page size is\nlimited to `1000`. For more results, multiple calls must be made.\n\nThe `count` field at the top level response shows the number of document as part of the\nresponse.\n\nThe total number of resources matching a request are visible in the `total_count` field\nat the top level response.\n\nTo retrieve only the total number of resources matching a request, the query parameter\n `data` set to `false` must be added to the request. The `count` field will be present\nat the response top level with the value.\n\n## Sorting\n\nYou can customize the sorting strategy for the `GET`\nendpoints by using the `?sort` argument on your query\nstring. The `sort` argument has the following format:\n\n```\nsort=field1,field2,-field3,...\n```\n\nWhere each field identifies a payload attribute.\nA field prefixed by the minus sign `-` will instruct\nthe API to apply descending sorting on that field -\nascending ordering is the default behaviour otherwise.\n\n## Filtering\n\nFilter collections with the `?filter` parameter.\n\nFor example:\n\n```\n# To get only observables of ipv4 `type`\nGET /api/v2/observables?filter[type]=ipv4\n\n# To get only observables with the `value` '127.0.0.1'\nGET /api/v2/observables?filter[value]=127.0.0.1\n```\n\nYou can also combine filters:\n\n```\nGET /api/v2/observables?filter[type]=city&filter[type]=country&filter[value]=Andorra\n```\n\nThe following conventions apply:\n\n1. If two filter parameters point to the same field (like `type` in the previous\n   example), then they will be chained with an OR logic (in the previous example,\n   `type='city' OR type='country'`).\n\n2. If two filter parameters point to different fields (like `type` and `value`\n   in the previous example), then they will be chained with an AND logic.\n\nSo the SQL-like equivalent for the previous request would be:\n\n```sql\nSELECT *\nFROM observables\nWHERE type IN ('city', 'country')\nAND value = 'Andorra'\n```\n\nYou can also use relational operators for more advanced filtering, for example:\n\n```\n# To get entities that were created after certain time\nGET /api/v2/entities?filter[>created_at]=2020-01-01T00:00:00+00:00\n\n# To get entities that have `COVID` in their title\nGET /api/v2/entities?filter[*data.title]=*COVID*\n```\n\nThe syntax for relational operators is the following:\n\n`?filter[<operator><field>]=<value>`\n\nThe following operators are supported:\n\n| Operator | Description            |\n| -------- | ---------------------- |\n| `<`      | Less than.             |\n| `<=`     | Lesser or equal than.  |\n| `>`      | Greater than.          |\n| `>=`     | Greater or equal than. |\n| `!`      | Does not equal/not in. |\n| `*`      | Wildcard.              |\n\n\nNOTE: often when multiple filters are applied to a resource, the complete request URL\ncan grow significantly, but for security reasons the length of a request-URL is restricted\nto 8k characters. If request line exceeds this size, `414 (Request-URI Too Large)` error\nis returned to the client.\n\n## Response attributes\n\nYou can select which attributes should be returned on the `GET` responses through\nthe `?attributes` parameter. Nested attributes are separated by dots \"`.`\" (e.g.\n`data.timestamp`).\n\nFor instance, if you only want to return `created_at` and `data.title` of the entities:\n\n`GET /api/v2/entities?attributes=created_at,data.title`\n\nIf a client does not specify the set of fields for a given resource type, the server returns all fields.\n\n## Missing Top-Level Resource Permission\n\nEclecticIQ provides a permission mechanism to define which top-level resource a user can\naccess. A permission is separated in `read` and `modify`. A `modify` permission implies\na `read` one.\n\nWhen such permission is missing, the API response is `403`. It could originate either\nfrom the main top-level resource or a related top-level resource used through a\nproperty.\n\n## Missing Individual Resource Access\n\nSome individual resource may require additional permission to be accessed. For example\nto fetch an entity, one must have the `read entities` permission but also access to at\nleast one of the source the entity is from.\n\nIf only an individual resource can not be accessed then a `404` is returned. It is not a\n`403` to hide the existence of such object. It could originate either from the main\nindividual resource or a related individual resource used through a property.\n\n## Bulk requests\n\nThe API supports bulk manipulation of objects on the following endpoints:\n\n- `PUT /api/v2/<objects>`: create `<objects>` from the provided payload, or\n   update them if they already exist (according to some unique attribute, e.g.\n   `name` or `<type, value>`). This is functionally equivalent to an idempotent\n   `upsert` (insert or update) operation. The endpoint returns a `201` response\n   code if at least one of the provided objects was newly created, `200` if all\n   the objects existed and have been updated.\n\n- `DELETE /api/v2/<objects>`: delete `<objects>` whose IDs are provided as\n  a list on the JSON payload, e.g. `{\"data\": [1, 2, 3, 4]}`.\n\nNOTE: for performance reasons, bulk operations are handled within the same\ntransaction. This means that the whole request fails if at least the handling of\none record failed. This also minimizes the risk of data inconsistency caused by\npartially succeeded transactions.\n\n## Update Resource Relationships\n\nAn update on a relationships fields will overwrite all the related values:\n\nExample for an entity with those datasets:\n\n```\nGET /api/v2/entities/10d0fc3e-5bf3-4065-9d28-a3125c1be200?attributes=datasets\nHTTP/1.1 200 OK\n\n{\n    \"data\": {\n        \"datasets\": [\n            \"https://host.com/api/v2/datasets/2\",\n        ]\n    }\n}\n```\n\nIf the `datasets` field is updated like this:\n\n```\nPATCH /api/v2/entities/10d0fc3e-5bf3-4065-9d28-a3125c1be200\n{\n    \"data\": {\n        \"datasets\": [\n            \"https://host.com/api/v2/datasets/1\",\n            \"https://host.com/api/v2/datasets/3\"\n        ]\n    }\n}\nHTTP/1.1 200 OK\n```\n\nThen, it will overwrite the existing ones with the one in the update query:\n\n```\nGET /api/v2/entities/10d0fc3e-5bf3-4065-9d28-a3125c1be200?attributes=datasets\nHTTP/1.1 200 OK\n\n{\n    \"data\": {\n        \"datasets\": [\n            \"https://host.com/api/v2/datasets/1\",\n            \"https://host.com/api/v2/datasets/3\"\n        ]\n    }\n}\n```\n\nIn order to control the relationships atomically, please refer to:\n- `PUT /api/v2/entities/<entity-id>/datasets`\n- `DELETE /api/v2/entities/<entity-id>/datasets`\n- `PUT /api/v2/entities/<entity-id>/datasets/<dataset-id>`\n- `DELETE /api/v2/entities/<entity-id>/datasets/<dataset-id>`\n\n## URI Length Restriction\n\nThe API relies on `GET` endpoints to query the data. Some requests may contain many\nfilters like `?filter[id]=id1&filter[id]=id2&...&filter[id]=id1000` that result in very\nlong URI. The server may put a restriction on this length and reject it with a `414`.\n\nTo circumvent it, it is possible to convert any `GET` call to a `POST` alternative. The\nsame URI path must be used but the query string is moved to the payload and the header\n`Content-Type` is `application/x-www-form-urlencoded`. The query string schemata are\nrespecting the same one that the equivalent `GET` endpoint. Also, those `POST` endpoints\nreturn `200` on success.\n\nFor a POST request, if both a payload as `application/x-www-form-urlencoded` and a query\nstring is provided then the latter is ignored and only the payload will be used.\n\nOriginal GET call:\n\n```http\nGET https://example.com/api/v2/attacks\n    ?filter[id]=TA0001\n    &filter[matrix]=ics-attack\n```\n\nConverted POST call:\n\n```http\nPOST https://example.com/api/v2/attacks HTTP/1.1\nContent-Type: application/x-www-form-urlencoded\n\nfilter[id]=TA0001&filter[matrix]=ics-attack\n```\n\n## Datetime\n\nA datetime field is based on the ISO 8601 format. \n\n- As input, any format is supported like `2024-01-01` or `2025-06-01T22:50:36+00:00`\n- The returned value is always the full format with a timezone like\n  `2017-11-30T10:04:07.890853+00:00`. By default UTC, but it may be aligned to another\n  one if specified by the API.\n\nIf the datetime is provided as a filter, the same input requirements are applied. As a\nresult the timezone is honored as well.\n\nIf the timezone is not provided in the input, the system will infer in this order of\npriority:\n\n1. The user preference\n2. The IC preference\n3. UTC\n\n\n\n# Release Notes\n\n## V2\n\n### Changes\n\n- Added `GET /api/v2/csv-mappings/supported-fields` to list all supported Entity fields that can be used by CSV Mappings.\n- Added `/api/v2/csv-mappings` and `/api/v2/csv-mappings/<id>` APIs to provide complete CRUD operations for CSV Mapping Configurations,\n  which are later used in Uploaded Blobs or Incoming Feeds for ingestion of CSV files.\n- Added `PATCH /api/v2/relationships/<uuid>` to update a single entity relation.\n- The `/api/v2/relationships` endpoints accept new fields: `data.description`,\n  `meta.estimated_threat_start_time`, `meta.estimated_threat_end_time` and\n  `meta.tlp_color`.\n- Added `PUT /api/v2/relationships` to allow bulk upserting of entity relations.\n- Added `GET /api/v2/aggregations/entities/counts` to get count entities aggregation on the field value usages, for specific set of fields.\n- A response from the endpoint `/api/v2/relationships` can return `strict_stix_1` and `strict_stix_2` fields.\n- Performance change: endpoints querying the total count in PostgreSQL (i.e. `GET /api/v2/observables/`) will return an estimated count of total entries if there are more entries than a set number. Default is `10_000`.\n- Added new entity types:\n  - Attack Pattern\n  - Location\n  - Malware\n  - Tool\n  - Infrastructure\n  - Intrusion set\n  - Identity\n  - Malware Analysis\n- Added `remove_taxonomies` field on entity rule, a list of taxonomies removed from the matched entity if the rule has `remove_tags` action.\n- Added `remove_tags` field on entity rule, a list of tags removed from the matched entity if the rule has `remove_tags` action.\n- Added `eiqjson2_entity_type` field on entity rule, which is a required target type for conversion if the rule has `convert_to_eiqjson2` action.\n- Added `GET /api/v2/content-blocks` to list content blocks.\n- Added `GET /api/v2/content-blocks/<id>` to get content block by id.\n- It is possible to attach `attachments` on `/api/v2/entities` to any entity type and\n  not only `report`.\n- For `/api/v2/entities`, as a security measure, it is not possible to reference an\n  attachment as an image `<img src=\"/private/entity-attachments/<id>/download\" />` in\n  `data.description` or `data.short_description` without having that attachment also\n  related in `attachments`. If this is not respected a `400` is returned.\n- The `/api/v2/tickets` API accepts the blank value `\"\"` for `status`. If no `status` is\n  provided, then `\"OPEN\"` is the default instead of `\"\"`.\n- The `/api/v2/observables` API allows to filter by `filter[entities]=<entity-id>` to\n  return only the observables related to that entity.\n- Added `POST /api/v2/entities/relational-search` that exposes `search entities by relationships`.\n- Added `POST /api/v2/entities/update-tasks` to start a background task that apply a change to the entities that match\n  the specified search query.\n- Added `POST /api/v2/entities/delete-tasks` to start a background task that delete the entities that match\n  the specified search query.\n- Added `POST /api/v2/entities/enrich-tasks` to start a background task that enrich the observables of entities\n  that match the specified search query.\n- Added `POST /api/v2/entities/export-tasks` to expose possibility to export the entities that match\n  the specified search query in a specified content-type.\n- Added `GET /api/v2/uploaded-blobs` and `GET /api/v2/uploaded-blobs/<id>` that lists and gets uploaded blobs.\n- Added `POST /api/v2/uploaded-blobs` to expose IC functionality for files/blobs upload.\n- Added `filter[_lucene_search]` entity and relation filter that exposes Lucene for\n  advanced queries, which should be on par with search in UI.\n- Added the capacity for the attachment created with `POST /api/v2/attachments` to be\n  attached to some `entities` at the creation time.\n- Added `GET /api/v2/export-blocks/<id>/content` to allow downloading of files generated by bulk export.\n- Added `meta.is_unresolved_idref`, `meta.ingest_time` and `meta.first_ingest_time`\n  attributes to the `Entity` endpoints.\n- Added `user_data` attribute on the `User` resource. It contains settings related to\n  the user.\n- Deprecate `/api/v2/files/<id>/download` and `/api/v2/attachments/<id>/download` endpoints.\n- Added `/api/v2/files/<id>/content` and `/api/v2/attachments/<id>/content` endpoints\n  instead of deprecated `/download`.\n- Added `default_source` to the `User` endpoint.\n- On `Entity` creation, the `sources`, `data.confidence` and `meta.tlp_color` is\n  automatically set based on the `User`'s defaults if defined. Those are respectively in\n  the `User` at `default_source`, `user_data.default_values.entity.confidence` and\n  `user_data.default_values.entity.tlp`.\n- Added `POST /api/v2/observables/export-tasks` to expose possibility to export the\n  observables that match the specified search query in a specified content-type.\n- Added a new parameter `include_indirectly_related` to the request payload of `POST\n/api/v2/entities/relational-search` to also include the entities that are indirectly\n  related.\n- Added new entity type: Note.\n- Added validation for POST `/api/v2/rules/entities/observables` and PUT `/api/v2/rules/observables/<id>`\n  to verify that at least one of parameters serving as matching criteria for a rule is present.\n- Added `'relational_search'` field to dataset object for `/api/v2/datasets/` endpoints.\n- Added `relational_query` parameter for `/api/v2/entities/export-tasks` .\n  Either `entities_query` or `relational_query` must be provided for a task.\n- Added `relational_query` parameter for `/api/v2/entities/update-tasks` .\n  Either `entities_query` or `relational_query` must be provided for a task.\n- Added `relational_query` parameter for `/api/v2/entities/delete-tasks` .\n  Either `entities_query` or `relational_query` must be provided for a task.\n  - Added `relational_query` parameter for `/api/v2/entities/enrich-tasks` .\n    Either `entities_query` or `relational_query` must be provided for a task.\n- Added `POST /api/v2/datasets/<id>/delete-tasks` endpoint for\n  removing dataset in a background task.\n- Added `POST /api/v2/observables/update-tasks` to expose possibility to update the\n  observables that match the specified search query.\n- Added `POST /api/v2/observables/enrich-tasks` to expose possibility to enrich the\n  observables that match the specified search query.\n- Added `POST /api/v2/observables/delete-tasks` to expose possibility to delete the\n  observables that match the specified search query.\n- Added `/api/v2/attack-analyses` and `/api/v2/attack-analysis-annotations` to expose Attack\n  Analysis resource and its related Note resource.\n- Added `PUT/DELETE /api/v2/attack-analyses/<path:id>/entities` and `PUT/DELETE\n/api/v2/attack-analyses/<path:id>/datasets/<path:dataset_id>` endpoints to manage the\n  attack analysis scope.\n- Added `meta.total_resources_aggregated` to the payload of `GET\n/api/v2/aggregations/entities/counts` to know how many entities were aggregated.\n- Added `PUT /api/v2/datasets/<path:id>/entities` to expose possibility to update the\n  dataset with passed entities.\n- Added `POST /api/v2/datasets/<path:id>/add-tasks` to expose possibility to update the\n  dataset with entities that match the query.\n- Added the capacity to filter Attack by matrix with\n  `/api/v2/attacks?filter[matrix]=enterprise-attack`.\n- Added `entities` parameter to the request payload of `POST\n/api/v2/datasets` to include entities in dataset on creation.\n- Added `ignore_exemptions` flag for `/api/v2/entities/delete-tasks` to control exemptions for deletion.\n- Added `time_zone` parameter for `/api/v2/entities/export-tasks`,\n  `/api/v2/entities/update-tasks`, `/api/v2/entities/delete-tasks`,\n  `/api/v2/entities/enrich-tasks`, `/api/v2/observables/update-tasks`, `\n/api/v2/observables/enrich-tasks`, `/api/v2/observables/enxport-tasks`,\n  `/api/v2/observables/enxport-tasks`, `/api/v2/datasets/<path:id>/add-tasks` to specify\n  timezone\n- Added `/api/v2/attack-defenses` and `/api/v2/attack-defense-relationships` to fetch\n  the ATTACK objects `data-source`. `data-component`, `mitigation` and their\n  relationships to techniques (`mitigates` and `detects`).\n- Added the capacity to call any `GET` endpoint with a `POST` alternative to circumvent\n  the URI length limit. Please refer to the documentation for more information.\n- Added support for a new configuration available for a discovery rule (`api/v2/discovery_rules`).\n- Added `attack classifications` as a filter on `/api/v2/entities` and also as a\n  aggregatable field on `/api/v2/aggregations/entities/counts`. The field behaves like\n  `meta.attacks` except that it does not include the ATT&CK parents if they are not\n  explicitly used in classifications.\n- Added `/api/v2/risk-score/policies` route to expose creation/modification/deletion/viewing\n  Observable Risk Score Policies.\n- Added GET `/api/v2/risk-score/policies/<policy_id>/parameters` endpoint to expose\n  listing of Parameters for an Observable Risk Score Policy.\n- Added `GET/PATCH /api/v2/risk-score/policies/<policy_id>/parameters/<parameter_id>` to expose fetching\n  a parameter object and modifying state of a parameter.\n- Added `/api/v2/widgets` endpoints to manage the Widget resource.\n- Added `GET/PATCH/DELETE /api/v2/risk-score/policies/<policy_id>/parameters/<parameter_id>/values/<parameter_value_id>`\n  and `GET/POST/DELETE /api/v2/risk-score/policies/<policy_id>/parameters/<parameter_id>/values/`\n  to expose creating/fetching/modifying and deleting a parameter value objects.\n- Added `/api/v2/dashboards` route to expose creation/modification/deletion/viewing dashboards\n- Added `filter[_lucene_search]` capacity on `/api/v2/observables`.\n- Added `/api/v2/dashboards` route to expose creation/modification/deletion/viewing dashboards.\n- Added GET`/api/v2/observables/<id>/score-updates` endpoint to allow querying risk score modifications for an observable\n  and POST`/api/v2/observables/<id>/score-updates` endpoint to allow user to modify score.\n- Added `/api/v2/overview-dashboards` route to expose creation/modification/deletion/viewing overview dashboards\n- Added POST `/api/v2/risk-score/policies/<policy_id/score-previews` endpoint to expose previewing of a policy impact on extracts score.\n- Added  `POST /api/v2/observables/score-update-tasks` to allow updating risk score for\n  observables that match the specified search query and create score update records.\n- Added `/api/v2/rules/intel-requirements` route to expose creation/modification/deletion/viewing of intelligence requirements.\n- Added `/api/v2/rules/entities/intel-requirement-matches` route to expose \n  creation/modification/deletion/viewing of intelligence requirements matches to an entity.\n- Added `/api/v2/rules/property-propagations` route to expose creation/modification/deletion/viewing of property propagations.\n- Added `/api/v2/tasks/runs/groups/<group_id>` route to make possible to view the information about \n  task run groups, with an overview of the number of tasks it includes and their statuses.\n- Added `/api/v2/report-templates` route to expose creation/modification/deletion/viewing of report templates.\n- Added `/api/v2/content-generation-prompts` resource to expose creation/modification/deletion/viewing of content generation prompts for AI providers.\n- Added `/api/v2/font-families` route to expose viewing/upload/deletion of font families.\n- Added `/api/v2/fonts` route to expose download of fonts.\n- Added `/api/v2/consolidation/policies` route to expose \n  modification/viewing of consolidation policies.\n- Added `/api/v2/consolidation/policies/configurations` route to expose \n  creation/modification/deletion/viewing of consolidation policy configurations.\n- Added `/api/v2/notifications` route to expose viewing of notifications and marking them read.\n- Added `/api/v2/custom-attributes` route to expose creation/modification/deletion/viewing/aggregations/mappings of custom attributes.\n- Added `/api/v2/custom-entity-schemas` route to expose creation/modification/deletion/viewing/aggregations of custom entity schemas.\n- Added `POST /api/v2/entities/consolidate-tasks` to expose possibility to consolidate the\n  entities that match the specified search query.\n- Added `POST /api/v2/entities/deconsolidate-tasks` to expose possibility to deconsolidate the\n  entities that match the specified search query.\n- Custom attribute creation now supports an optional `display_name` field.\n- Custom attributes can now be deleted even if they are attached to one or more schemas, and even if instances of those schemas already exist.\n- Custom Attributes now support two new data types: `text` and `multiple_choice`. The text type allows free-form text up to 1000 characters, and the multiple_choice type allows selecting multiple values (a list).  \n- `/api/v2/attack-defenses` property `matrix` has been deprecated as it only considered\n  the first domain while a defense object may be linked to multiple ones. `domains` is\n  replacing and fixing the limitation in `v3`.\n- `/api/v2/attack-defenses` returns now a `domains` property listing all the matrices\n  name that the object is part of.\n- `packing_batch_size_relations` property of an outgoing feed resource is deprecated\n\n### Breaking Changes\n\n- Added: The payload of `/api/v2/relationships` requires a `sources` property. By providing a list of source ids, you can define the relationship sources.\n- The `/api/v2/relationships` endpoints expect that `data.key` better aligns with our new model based on STIX 2.1. The value of this property must be in ASCII, no longer than 256 characters and is limited to characters a–z (lowercase ASCII), 0–9, and hyphen (-).\n- The `/api/v2/relationships` endpoints expect that `data.subtype` can only accept `stix_update_of` value.\n- The `type` of an entity is now nested inside the data dictionary. See old behaviour first:\n\n```json\n{\n  \"type\": \"indicator\",\n  \"data\": {\n    \"title\": \"Entity Old\",\n    \"description\": \"Test entity with old schema\"\n  },\n  \"meta\": {}\n}\n```\n\nIn the new example the type field is nested inside:\n\n```json\n{\n  \"data\": {\n    \"type\": \"indicator\",\n    \"title\": \"Entity New\",\n    \"description\": \"Test entity with new schema\"\n  },\n  \"meta\": {}\n}\n```\n\n- The field `data.source` property of `/api/v2/entities/rules` is replaced with `data.sources` which contain an array of sources' ids which the rule applies to. If the array is empty, the rule is applied to all sources.\n\n- `taxonomies` field is renamed to `add_taxonomies`\n- `overwrite_tags` and `overwrite_taxonomies` query parameters are no longer supported\n\n- The payload of `/api/v2/datasets` requires at least one relationship for `workspaces`. The `workspaces` relationship field is also returned on the response.\n\n- The payload for a `PUT` request does not require a another nested `data` property.\n  From:\n\n  ```json\n  {\n    \"data\": [{ \"data\": {} }, { \"data\": {} }]\n  }\n  ```\n\n  To:\n\n  ```json\n  {\n    \"data\": [{}, {}]\n  }\n  ```\n\n- A query parameter to filter a related resource if the wrong id type is put will return\n  a 400 instead of a 200 where the filter is ignored. Example: `GET\n/api/v2/tickets?filter[entities]=1111` will return `400` as `filter[entities]` is\n  expecting a UUID.\n\n- Threat Actor schema is replaced with the strict EIQ JSON v2 schema\n- Required entity data fields normalised to `type` and `title` for all entity types\n\n- Custom Entity Schemas do not support mandatory Custom Attributes anymore. This is intentional because enforcing required fields would make it difficult to update or migrate existing instances, and could easily lead to broken data if older records or integrations don’t include those attributes. \n\n\n- `data_source` property that was returned on `/api/v2/attack-defenses` for\n  `data-component` type has been removed. This is caused by the upgrade to ATTACK v18\n  that deprecated and removed `data-source` objects.\n\n- `/api/v2/attack-defense-relationships` had a field `matrix` that was not part of the original\n  ATTACK framework. The query parameter `filter[matrix]` is still accepted but does\n  nothing while the property on the response is not returned.\n\n### Bug Fixes\n\n- Fixed: Knowledge packs can be deleted via API with only read knowledge pack permission\n\n- Update of `attachments` on `/api/v2/entities` used to be ignored. Now, the new `attachments` provided will overwrite the current ones.\n\n- The public API for relationship and entities used to not recognized STIX id of some\n  format when queries like:\n  `/api/v2/entities/{my-namespace}threat-actor-dc07abbd-ea1a-4ac1-acfd-e56328299635` or\n  `/api/v2/entities/indicator--34818854-03ba-4b9a-b99b-319694c1d392`. A `400` was\n  returned. Now, either a `200` with the entity is returned or a `404` if it does\n  not exist.\n\n- Providing multiple values to a similar range filter used to only consider the first\n  one. Both Entity and Relationship endpoints were impacted. Example:\n  `?filter[>created_at]=2024-01-01&filter[>created_at]=2024-06-06`\n\n- Filter observables on `sources` is fixed: `/api/v2/observables?filter[sources]=<uuid>`\n\n- `name` and `data_type` are now immutable fields and cannot be modified after creation via the \n  PUT (update entire resource) or PATCH (partial update) API endpoints for the `/custom-attributes` resource. \n  This is a bug fix to prevent inconsistencies between the attribute definition and the data already stored  \n  using that attribute.\n\n- `type` is now an immutable field in Custom Entity Schema and cannot be modified after creation. \n  This is a bug fix to avoid mismatches between the schema's identifier and the underlying entity data \n  that relies on that type.\n\n- `string` data type in Custom Attributes can not accept empty allowed_values, it has to\n  have at least one value. This is a bug fix because allowing an empty list made the\n  attribute unusable.\n\n- `/api/v2/attack-defenses` query parameter `filter[matrix]` is now correctly filtering\n  on all matrices the object is part of, instead of the first one. However, for backward\n  compatibility, `matrix` property in the response is still returning a single value,\n  the first matrix. Please use `domains` to have the complete list.\n","title":"EclecticIQ Platform API","version":"v2"},"openapi":"3.0.2","paths":{"/":{},"/aggregations/entities/counts":{"get":{"deprecated":true,"description":"This endpoint is going to be replaced in v3 by `/entities/aggregations`.\n\n**Required permissions**\n\n- `read entities`\n\n","parameters":[{"$ref":"#/components/parameters/TotalResourcesAggregatedParameter"},{"description":"Aggregates on the given field. `meta.attacks` is aggregating on the attack classifications including the parents. So if an entity is classified with a technique, the tactic is going to be included as well. `attack_classifications` will not include the parents.\n","in":"query","name":"field","required":true,"schema":{"enum":["meta.attacks","meta.tags","meta.taxonomy","attack_classifications"],"type":"string"}},{"description":"Filter by entity id, or other entity fields which are supported by the entity index endpoint. e.g. `GET /entities`","in":"query","name":"filter[id]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CountsPerFieldValuesAggregationSchema"},"meta":{"properties":{"total_resources_aggregated":{"description":"The total number of resources that have been aggregated. The value may be approximated. Please check `meta[total_resources_aggregated]` to customize the approximation.","type":"integer"}},"type":"object"}},"type":"object"}}},"description":"The requested object(s)"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get an aggregation that counts entities per field values usages","tags":["Aggregations","Entities"],"x-eiq-permissions":{"read entities":"Required to access the entity aggregations"}}},"/aggregations/uploaded-blobs/counts":{"get":{"deprecated":true,"description":"This endpoint is going to be replaced in v3 by `/uploaded-blobs/aggregations`.\n\n**Required permissions**\n\n- `read blob-uploads`\n\n","parameters":[{"description":"Aggregates on given field.","in":"query","name":"field","required":true,"schema":{"enum":["content_type","created_by_id","processing_status"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CountsPerFieldValuesAggregationSchema"}},"type":"object"}}},"description":"The requested object(s)"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get an aggregation that counts uploaded-blobs per field values usages","tags":["Aggregations","Uploaded Blobs"],"x-eiq-permissions":{"read blob-uploads":"Required to access the uploaded blob aggregations"}}},"/attack-analyses":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify attack`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of Attack Analysis referenced by IDs.","tags":["MITRE Attacks"],"x-eiq-permissions":["modify attack"]},"get":{"description":"\n\n**Required permissions**\n\n- `read attack`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AttackAnalysisAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of Attack Analyses.","tags":["MITRE Attacks"],"x-eiq-permissions":["read attack"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify attack`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AttackAnalysisAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AttackAnalysisAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create an Attack Analysis.","tags":["MITRE Attacks"],"x-eiq-permissions":["modify attack"]}},"/attack-analyses/{analysis_id}/datasets/{dataset_id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify attack`\n\n- `read intel-sets`\n\n","parameters":[{"description":"Attack Analysis ID","in":"path","name":"analysis_id","required":true,"schema":{"type":"number"}},{"description":"Dataset ID","in":"path","name":"dataset_id","required":true,"schema":{"type":"number"}}],"responses":{"204":{"description":"Relations deleted successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a dataset from the scope of an Attack Analysis.","tags":["MITRE Attacks","Relation"],"x-eiq-permissions":["modify attack","read intel-sets"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify attack`\n\n- `read intel-sets`\n\n","parameters":[{"description":"Attack Analysis ID","in":"path","name":"analysis_id","required":true,"schema":{"type":"number"}},{"description":"Dataset ID","in":"path","name":"dataset_id","required":true,"schema":{"type":"number"}}],"responses":{"201":{"description":"Relations added successfully."},"400":{"description":"If the analysis would have more than one dataset in its scope.\n"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Add a dataset to the scope of an Attack Analysis.","tags":["MITRE Attacks","Relation"],"x-eiq-permissions":["modify attack","read intel-sets"]}},"/attack-analyses/{analysis_id}/entities":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify attack`\n\n- `read entities`\n\n","parameters":[{"description":"Attack Analysis ID","in":"path","name":"analysis_id","required":true,"schema":{"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"format":"uuid","type":"string"},"type":"array"}},"type":"object"}}}},"responses":{"204":{"description":"Relations deleted successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Bulk delete entities from the scope of an Attack Analysis.","tags":["MITRE Attacks","Relation"],"x-eiq-permissions":["modify attack","read entities"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify attack`\n\n- `read entities`\n\n","parameters":[{"description":"Attack Analysis ID","in":"path","name":"analysis_id","required":true,"schema":{"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"format":"uuid","type":"string"},"type":"array"}},"type":"object"}}}},"responses":{"201":{"description":"Relations added successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Bulk add entities to the scope of an Attack Analysis.","tags":["MITRE Attacks","Relation"],"x-eiq-permissions":["modify attack","read entities"]}},"/attack-analyses/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify attack`\n\n","parameters":[{"description":"Attack Analysis ID","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete an Attack Analysis by ID.","tags":["MITRE Attacks"],"x-eiq-permissions":["modify attack"]},"get":{"description":"\n\n**Required permissions**\n\n- `read attack`\n\n","parameters":[{"description":"Attack Analysis ID","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AttackAnalysisAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get an Attack Analysis by ID.","tags":["MITRE Attacks"],"x-eiq-permissions":["read attack"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify attack`\n\n","parameters":[{"description":"Attack Analysis ID","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AttackAnalysisAPISchema"}},"type":"object"}}},"description":"The updated object"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Update an Attack Analysis by ID.","tags":["MITRE Attacks"],"x-eiq-permissions":["modify attack"]}},"/attack-analysis-annotations":{"get":{"description":"\n\n**Required permissions**\n\n- `read attack`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by attack analysis","in":"query","name":"filter[attack_analysis]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AttackAnalysisAnnotationAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of Attack Analysis Annotations.","tags":["MITRE Attacks"],"x-eiq-permissions":["read attack"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify attack`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AttackAnalysisAnnotationAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AttackAnalysisAnnotationAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create an Attack Analysis Annotation.","tags":["MITRE Attacks"],"x-eiq-permissions":["modify attack"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify attack`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AttackAnalysisAnnotationAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AttackAnalysisAnnotationAPISchema"},"type":"array"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AttackAnalysisAnnotationAPISchema"},"type":"array"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create (or update) one or more Attack Analysis Annotations.","tags":["MITRE Attacks"],"x-eiq-permissions":["modify attack"]}},"/attack-analysis-annotations/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify attack`\n\n","parameters":[{"description":"Attack Analysis Annotation ID","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete an Attack Analysis Annotation by ID.","tags":["MITRE Attacks"],"x-eiq-permissions":["modify attack"]},"get":{"description":"\n\n**Required permissions**\n\n- `read attack`\n\n","parameters":[{"description":"Attack Analysis Annotation ID","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AttackAnalysisAnnotationAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get an Attack Analysis Annotation by ID.","tags":["MITRE Attacks"],"x-eiq-permissions":["read attack"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify attack`\n\n","parameters":[{"description":"Attack Analysis Annotation ID","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AttackAnalysisAnnotationAPISchema"}},"type":"object"}}},"description":"The updated object"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Update an Attack Analysis Annotation by ID.","tags":["MITRE Attacks"],"x-eiq-permissions":["modify attack"]}},"/attack-defense-relationships":{"get":{"description":"\n\n**Required permissions**\n\n- `read attack`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by ID","in":"query","name":"filter[id]","schema":{"type":"string"}},{"$ref":"#/components/parameters/FilterDefenseRelTypeParameter"},{"description":"Filter by the related Technique id","in":"query","name":"filter[technique]","schema":{"type":"string"}},{"description":"Filter by the related Defense id","in":"query","name":"filter[defense]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AttackDefenseRelationshipAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of MITRE Attack Defense Relationships.","tags":["MITRE Attacks"],"x-eiq-permissions":["read attack"]}},"/attack-defenses":{"get":{"description":"\n\n**Required permissions**\n\n- `read attack`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by ID","in":"query","name":"filter[id]","schema":{"type":"string"}},{"$ref":"#/components/parameters/FilterDefenseTypeParameter"},{"description":"Filter by name","in":"query","name":"filter[name]","schema":{"type":"string"}},{"$ref":"#/components/parameters/FilterMatrixParameter"},{"description":"Filter objects being directly related to a certain ATTACK technique id. This filter is not having an effect on `data-source` as those objects are related to techniques through `data-component` objects.\n","example":["TA0006:T1547","TA0006:T1003.001"],"in":"query","name":"filter[related_techniques]","schema":{"type":"string"}},{"description":"Filter objects being referenced by a certain ATTACK defense id. For a `detection-strategy` id the related `analytic` objects are returned while for an `analytic` id, the related `data-component` are returned. example: [DET0103, AN0286]\n","in":"query","name":"filter[source_defenses]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AttackDefenseV2APISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of MITRE Attack Defenses.","tags":["MITRE Attacks"],"x-eiq-permissions":["read attack"]}},"/attacks":{"get":{"description":"\n\n**Required permissions**\n\n- `read attack`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by ID","in":"query","name":"filter[id]","schema":{"type":"string"}},{"$ref":"#/components/parameters/FilterAttackNodeTypeParameter"},{"description":"Filter by attack name","in":"query","name":"filter[name]","schema":{"type":"string"}},{"description":"Filter by attack description","in":"query","name":"filter[description]","schema":{"type":"string"}},{"description":"Filter by parent ID/URL","in":"query","name":"filter[parent]","schema":{"type":"string"}},{"$ref":"#/components/parameters/FilterMatrixParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AttackNodeAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of MITRE Attacks.","tags":["MITRE Attacks"],"x-eiq-permissions":["read attack"]}},"/attacks/{id}":{"get":{"description":"\n\n**Required permissions**\n\n- `read attack`\n\n","parameters":[{"description":"MITRE Attack ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AttackNodeAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get MITRE Attack by ID.","tags":["MITRE Attacks"],"x-eiq-permissions":["read attack"]}},"/consolidation/policies":{"get":{"description":"\n\n**Required permissions**\n\n- `read consolidation-policies`\n\n\n\n**Optional permissions**\n\n- `read tasks` Required to access the task attached to a policy\n\n- `read groups` Required to access the group assigned to a policy\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ConsolidationPolicyAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of consolidation policies","tags":["Consolidation"],"x-eiq-optional-permissions":{"read groups":"Required to access the group assigned to a policy","read tasks":"Required to access the task attached to a policy"},"x-eiq-permissions":["read consolidation-policies"]}},"/consolidation/policies/{policy_id}":{"get":{"description":"\n\n**Required permissions**\n\n- `read consolidation-policies`\n\n\n\n**Optional permissions**\n\n- `read tasks` Required to access the task attached to a policy\n\n- `read groups` Required to access the group assigned to a policy\n\n","parameters":[{"description":"Consolidation policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ConsolidationPolicyAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a consolidation policy by ID.","tags":["Consolidation"],"x-eiq-optional-permissions":{"read groups":"Required to access the group assigned to a policy","read tasks":"Required to access the task attached to a policy"},"x-eiq-permissions":["read consolidation-policies"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify consolidation-policies`\n\n\n\n**Optional permissions**\n\n- `read tasks` Required to access the task attached to a policy\n\n- `read groups` Required to access the group assigned to a policy\n\n","parameters":[{"description":"Consolidation policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ConsolidationPolicyAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ConsolidationPolicyAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Edit a consolidation policy by ID.","tags":["Consolidation"],"x-eiq-optional-permissions":{"read groups":"Required to access the group assigned to a policy","read tasks":"Required to access the task attached to a policy"},"x-eiq-permissions":["modify consolidation-policies"]}},"/consolidation/policies/{policy_id}/configurations":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify consolidation-policies`\n\n","parameters":[{"description":"Consolidation policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of consolidation policy configurations referenced by IDs.","tags":["Consolidation"],"x-eiq-permissions":["modify consolidation-policies"]},"get":{"description":"\n\n**Required permissions**\n\n- `read consolidation-policies`\n\n\n\n**Optional permissions**\n\n- `read sources` Required to access the sources attached to a policy configuration\n\n","parameters":[{"description":"Consolidation policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ConsolidationPolicyConfigurationAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of consolidation policy configurations","tags":["Consolidation"],"x-eiq-optional-permissions":{"read sources":"Required to access the sources attached to a policy configuration"},"x-eiq-permissions":["read consolidation-policies"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify consolidation-policies`\n\n\n\n**Optional permissions**\n\n- `read sources` Required to access the sources attached to a policy configuration\n\n","parameters":[{"description":"Consolidation policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ConsolidationPolicyConfigurationAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ConsolidationPolicyConfigurationAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ConsolidationPolicyConfigurationAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create (or update if the name already exists) one or more consolidation policy configurations.","tags":["Consolidation"],"x-eiq-optional-permissions":{"read sources":"Required to access the sources attached to a policy configuration"},"x-eiq-permissions":["modify consolidation-policies"]}},"/consolidation/policies/{policy_id}/configurations/{configuration_id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify consolidation-policies`\n\n","parameters":[{"description":"Consolidation policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"description":"Consolidation policy configuration ID","in":"path","name":"configuration_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a consolidation policy configuration by ID.","tags":["Consolidation"],"x-eiq-permissions":["modify consolidation-policies"]},"get":{"description":"\n\n**Required permissions**\n\n- `read consolidation-policies`\n\n\n\n**Optional permissions**\n\n- `read sources` Required to access the sources attached to a policy configuration\n\n","parameters":[{"description":"Consolidation policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"description":"Consolidation policy configuration ID","in":"path","name":"configuration_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ConsolidationPolicyConfigurationAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a consolidation policy configuration by ID.","tags":["Consolidation"],"x-eiq-optional-permissions":{"read sources":"Required to access the sources attached to a policy configuration"},"x-eiq-permissions":["read consolidation-policies"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify consolidation-policies`\n\n\n\n**Optional permissions**\n\n- `read sources` Required to access the sources attached to a policy configuration\n\n","parameters":[{"description":"Consolidation policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"description":"Consolidation policy configuration ID","in":"path","name":"configuration_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ConsolidationPolicyConfigurationAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ConsolidationPolicyConfigurationAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Edit a consolidation policy configuration by ID.","tags":["Consolidation"],"x-eiq-optional-permissions":{"read sources":"Required to access the sources attached to a policy configuration"},"x-eiq-permissions":["modify consolidation-policies"]}},"/content-blocks":{"get":{"description":"\n\n**Required permissions**\n\n- `read content-blocks`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"description":"Filter by outgoing feed id","in":"query","name":"filter[outgoing_feed]","schema":{"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ContentBlockAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of content blocks.","tags":["Content Blocks"],"x-eiq-permissions":["read content-blocks"]}},"/content-blocks/{id}":{"get":{"description":"\n\n**Required permissions**\n\n- `read content-blocks`\n\n","parameters":[{"description":"Content block ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ContentBlockAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a content block by ID.","tags":["Content Blocks"],"x-eiq-permissions":["read content-blocks"]}},"/content-generation-prompts":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify prompts`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of prompts referenced by IDs.","tags":["Content Generation Prompts"],"x-eiq-permissions":["modify prompts"]},"get":{"description":"\n\n**Required permissions**\n\n- `read prompts`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter prompt by name","in":"query","name":"filter[name]","schema":{"type":"string"}},{"in":"query","name":"filter[is_enabled]","schema":{"type":"boolean"}},{"in":"query","name":"filter[is_pinned]","schema":{"type":"boolean"}},{"description":"Filter by creation timestamp","in":"query","name":"filter[last_updated_at]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ContentGenerationPromptAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of content generation prompts.","tags":["Content Generation Prompts"],"x-eiq-permissions":["read prompts"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify prompts`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ContentGenerationPromptAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ContentGenerationPromptAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a content generation prompt.","tags":["Content Generation Prompts"],"x-eiq-permissions":["modify prompts"]}},"/content-generation-prompts/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify prompts`\n\n","parameters":[{"description":"CSV Mapping ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a prompt referenced by ID.","tags":["Content Generation Prompts"],"x-eiq-permissions":["modify prompts"]},"get":{"description":"\n\n**Required permissions**\n\n- `read prompts`\n\n","parameters":[{"description":"Prompt ID","in":"path","name":"id","required":true,"schema":{"type":"number"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ContentGenerationPromptAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a content generation prompt by ID.","tags":["Content Generation Prompts"],"x-eiq-permissions":["read prompts"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify prompts`\n\n","parameters":[{"description":"Prompt ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ContentGenerationPromptAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ContentGenerationPromptAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Update a content generation prompt.","tags":["Content Generation Prompts"],"x-eiq-permissions":["modify prompts"]}},"/csv-mappings":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify csv-mappings`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIntIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of CSV Mappings referenced by IDs.","tags":["CSVMappings"],"x-eiq-permissions":["modify csv-mappings"]},"get":{"description":"\n\n**Required permissions**\n\n- `read csv-mappings`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by name","in":"query","name":"filter[name]","schema":{"type":"string"}},{"description":"Filter by description","in":"query","name":"filter[description]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CSVMappingAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Returns the list of CSV Mappings on the platform.","tags":["CSVMappings"],"x-eiq-permissions":["read csv-mappings"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify csv-mappings`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CSVMappingAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CSVMappingAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a CSV Mapping.","tags":["CSVMappings"],"x-eiq-permissions":["modify csv-mappings"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify csv-mappings`\n\n","parameters":[{"$ref":"#/components/parameters/AttributesParameter"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CSVMappingAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CSVMappingAPISchema"},"type":"array"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CSVMappingAPISchema"},"type":"array"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create (or modify if the name already exists) one or more csv-mappings.","tags":["CSVMappings"],"x-eiq-permissions":["modify csv-mappings"]}},"/csv-mappings/supported-fields":{"get":{"description":"\n\n**Required permissions**\n\n- `read csv-mappings`\n\n","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"entity":{"additionalProperties":{"properties":{"hint":{"type":"string"},"is_multiple_allowed":{"type":"boolean"},"parameters":{"properties":{"is_parsing_allowed":{"type":"boolean"},"maliciousness":{"type":"boolean"},"time_format":{"type":"boolean"},"title_before_description":{"type":"boolean"}},"type":"object"},"title":{"type":"string"}},"type":"object"},"type":"object"},"observable":{"additionalProperties":{"properties":{"hint":{"type":"string"},"is_multiple_allowed":{"type":"boolean"},"parameters":{"properties":{"is_parsing_allowed":{"type":"boolean"},"maliciousness":{"type":"boolean"},"time_format":{"type":"boolean"},"title_before_description":{"type":"boolean"}},"type":"object"},"title":{"type":"string"}},"type":"object"},"type":"object"}},"type":"object"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get Entity supported fields in a CSV Mapping.","tags":["CSVMappings"],"x-eiq-permissions":["read csv-mappings"]}},"/csv-mappings/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify csv-mappings`\n\n","parameters":[{"description":"CSV Mapping ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a CSV Mapping by ID.","tags":["CSVMappings"],"x-eiq-permissions":["modify csv-mappings"]},"get":{"description":"\n\n**Required permissions**\n\n- `read csv-mappings`\n\n","parameters":[{"description":"CSV Mapping ID","in":"path","name":"id","required":true,"schema":{"type":"number"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CSVMappingAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a CSV Mapping by ID.","tags":["CSVMappings"],"x-eiq-permissions":["read csv-mappings"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify csv-mappings`\n\n","parameters":[{"description":"CSV Mapping ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CSVMappingAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CSVMappingAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Update a CSV Mapping.","tags":["CSVMappings"],"x-eiq-permissions":["modify csv-mappings"]}},"/custom-attributes":{"get":{"description":"\n\n**Required permissions**\n\n- `read custom-entities`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CustomAttributeSchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of custom attributes.","tags":["Custom Attributes"],"x-eiq-permissions":["read custom-entities"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify custom-entities`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomAttributeSchema"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CustomAttributeSchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create new or update existing custom attributes.","tags":["Custom Attributes"],"x-eiq-permissions":["modify custom-entities"]}},"/custom-attributes/mappings":{"get":{"description":"\n\n**Required permissions**\n\n- `read custom-entities`\n\n","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CustomAttributeMappingSchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of custom attribute mappings.","tags":["Custom Attributes"],"x-eiq-permissions":["read custom-entities"]}},"/custom-attributes/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify custom-entities`\n\n","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Attribute deleted successfully"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a custom attribute by ID.","tags":["Custom Attributes"],"x-eiq-permissions":["modify custom-entities"]},"get":{"description":"\n\n**Required permissions**\n\n- `read custom-entities`\n\n","parameters":[{"description":"Custom Attribute ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CustomAttributeSchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CustomAttributeSchema"}},"type":"object"}}},"description":"The requested object(s)"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get custom attribute by ID.","tags":["Custom Attributes"],"x-eiq-permissions":["read custom-entities"]},"patch":{"description":"Only unassigned attributes  (not linked to any CustomEntitySchema) can be edited.\n\n**Required permissions**\n\n- `modify custom-entities`\n\n","parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CustomAttributeSchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CustomAttributeSchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Partially update a custom attribute by ID","tags":["Custom Attributes"],"x-eiq-permissions":["modify custom-entities"]}},"/custom-entity-schemas":{"get":{"deprecated":true,"description":"Deprecated in favor of entity-schemas.\n\n**Required permissions**\n\n- `read custom-entities`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EntityDefinitionSchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of custom entity schemas","tags":["Custom Entity Schemas"],"x-eiq-permissions":["read custom-entities"]},"post":{"deprecated":true,"description":"Deprecated in favor of entity-schemas.\n\n**Required permissions**\n\n- `modify custom-entities`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityDefinitionSchema"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntityDefinitionSchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a new custom entity schema","tags":["Custom Entity Schemas"],"x-eiq-permissions":["modify custom-entities"]}},"/custom-entity-schemas/{id}":{"delete":{"deprecated":true,"description":"Only unassigned entity schemas can be deleted\n\nDeprecated in favor of entity-schemas/{id}.\n\n**Required permissions**\n\n- `modify custom-entities`\n\n","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Custom Entity Definition deleted successfully"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"description":"Cannot delete Custom Entity Definition once assigned"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a custom entity schema by ID","tags":["Custom Entity Schemas"],"x-eiq-permissions":["modify custom-entities"]},"get":{"deprecated":true,"description":"Deprecated in favor of entity-schemas/{id}.\n\n**Required permissions**\n\n- `read custom-entities`\n\n","parameters":[{"description":"Custom Entity Definition ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntityDefinitionSchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntityDefinitionSchema"}},"type":"object"}}},"description":"The requested object(s)"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get custom entity schema by ID","tags":["Custom Entity Schemas"],"x-eiq-permissions":["read custom-entities"]},"patch":{"deprecated":true,"description":"Deprecated in favor of entity-schemas/{id}.\n\n**Required permissions**\n\n- `modify custom-entities`\n\n","parameters":[{"description":"ID of the custom entity definition","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntityDefinitionSchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntityDefinitionSchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Update an existing custom entity schema by ID","tags":["Custom Entity Schemas"],"x-eiq-permissions":["modify custom-entities"]}},"/dashboards":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify dashboard`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of dashboards referenced by IDs.","tags":["Dashboards"],"x-eiq-permissions":["modify dashboard"]},"get":{"description":"\n\n**Required permissions**\n\n- `read dashboard`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter dashboard by name","in":"query","name":"filter[name]","schema":{"type":"string"}},{"description":"Filter dashboard to see only pinned ones","in":"query","name":"filter[is_pinned]","schema":{"type":"boolean"}},{"description":"Filter dashboard by name","in":"query","name":"filter[created_by]","schema":{"type":"string"}},{"description":"Filter dashboard to see last user whop modified the data","in":"query","name":"filter[last_updated_by]","schema":{"type":"boolean"}},{"description":"Filter dashboard by user id to see all the shared users allowed to edit","in":"query","name":"filter[collaborators]","schema":{"items":{"type":"string"},"type":"array"}},{"description":"Filter dashboards by group id allowed to make edit","in":"query","name":"filter[groups]","schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DashboardAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of Dashboards.","tags":["Dashboards"],"x-eiq-permissions":["read dashboard"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify dashboard`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/DashboardAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/DashboardAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a dashboard.","tags":["Dashboards"],"x-eiq-permissions":["modify dashboard"]}},"/dashboards/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify dashboard`\n\n","parameters":[{"description":"Dashboard ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"responses":{"204":{"description":"Deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a dashboard.","tags":["Dashboards"],"x-eiq-permissions":["modify dashboard"]},"get":{"description":"\n\n**Required permissions**\n\n- `read dashboard`\n\n","parameters":[{"description":"Dashboard ID","in":"path","name":"id","required":true,"schema":{"type":"number"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/DashboardAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a dashboard by ID.","tags":["Dashboards"],"x-eiq-permissions":["read dashboard"]},"patch":{"parameters":[{"description":"Dashboard ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/DashboardAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/DashboardAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Update a dashboard.","tags":["Dashboards"]}},"/datasets":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify intel-sets`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of datasets referenced by IDs.","tags":["Datasets"],"x-eiq-permissions":["modify intel-sets"]},"get":{"description":"\n\n**Required permissions**\n\n- `read intel-sets`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter datasets by name","in":"query","name":"filter[name]","schema":{"type":"string"}},{"description":"Filter datasets by search query","in":"query","name":"filter[search_query]","schema":{"type":"string"}},{"description":"Filter dynamic datasets","in":"query","name":"filter[is_dynamic]","schema":{"type":"boolean"}},{"description":"Filter relational datasets","in":"query","name":"filter[is_relational]","schema":{"type":"boolean"}},{"description":"Filter datasets which are favorite for authenticated user","in":"query","name":"filter[is_favorite]","schema":{"type":"boolean"}},{"description":"Filter static datasets which have relationships with given observable, via entities.","in":"query","name":"filter[observable_id]","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DatasetAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of datasets.","tags":["Datasets"],"x-eiq-permissions":["read intel-sets"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify intel-sets`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/DatasetAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/DatasetAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a dataset.","tags":["Datasets"],"x-eiq-permissions":["modify intel-sets"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify intel-sets`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DatasetAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DatasetAPISchema"},"type":"array"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DatasetAPISchema"},"type":"array"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create (or update if the name already exists) one or more datasets.","tags":["Datasets"],"x-eiq-permissions":["modify intel-sets"]}},"/datasets/{dataset_id}/entities":{"put":{"description":"\n\n**Required permissions**\n\n- `modify intel-sets`\n\n- `read entities`\n\n","parameters":[{"description":"Dataset ID","in":"path","name":"dataset_id","required":true,"schema":{"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"format":"uuid","type":"string"},"type":"array"}},"type":"object"}}}},"responses":{"201":{"description":"Entities removed successfully."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Bulk delete entities from a dataset.","tags":["Datasets","Entities","Relation"],"x-eiq-permissions":["modify intel-sets","read entities"]}},"/datasets/{dataset_id}/entities/add-tasks":{"post":{"description":"\n\n**Required permissions**\n\n- `modify intel-sets`\n\n- `read entities`\n\n","parameters":[{"description":"Dataset ID","in":"path","name":"dataset_id","required":true,"schema":{"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/DatasetEntitiesByQuerySchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaskRunAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Add entities to a dataset by query.","tags":["Datasets","Tasks"],"x-eiq-permissions":["modify intel-sets","read entities"]}},"/datasets/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify intel-sets`\n\n","parameters":[{"description":"Dataset ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"responses":{"204":{"description":"Deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a dataset.","tags":["Datasets","Tasks"],"x-eiq-permissions":["modify intel-sets"]},"get":{"description":"\n\n**Required permissions**\n\n- `read intel-sets`\n\n","parameters":[{"description":"Dataset ID","in":"path","name":"id","required":true,"schema":{"type":"number"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/DatasetAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a dataset by ID.","tags":["Datasets"],"x-eiq-permissions":["read intel-sets"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify intel-sets`\n\n","parameters":[{"description":"Dataset ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/DatasetAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/DatasetAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Update a dataset.","tags":["Datasets"],"x-eiq-permissions":["modify intel-sets"]}},"/datasets/{id}/delete-tasks":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify intel-sets`\n\n","parameters":[{"description":"Dataset ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaskRunAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a dataset in a background task.","tags":["Datasets"],"x-eiq-permissions":["modify intel-sets"]}},"/detonator-tasks":{"get":{"description":"\n\n**Required permissions**\n\n- `read detonation-vendors`\n\n","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DetonatorTaskSchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of Detonation Task","tags":["Malware Sandbox"],"x-eiq-permissions":["read detonation-vendors"]}},"/detonator-tasks/{id}":{"get":{"description":"\n\n**Required permissions**\n\n- `read detonation-vendors`\n\n","parameters":[{"description":"Detonator Task ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/DetonatorTaskSchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a Detonator Task by an ID","tags":["Malware Sandbox"],"x-eiq-permissions":["read detonation-vendors"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify detonation-vendors`\n\n","parameters":[{"description":"Detonator Task ID","in":"path","name":"id","required":true,"schema":{"type":"number"}},{"$ref":"#/components/parameters/AttributesParameter"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/DetonatorTaskSchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/DetonatorTaskSchema"}},"type":"object"}}},"description":"The updated object"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Update the detonation Task by an ID","tags":["Malware Sandbox"],"x-eiq-permissions":["modify detonation-vendors"]}},"/docs/{filename}":{},"/enrichers":{"get":{"description":"\n\n**Required permissions**\n\n- `read enrichers`\n\n\n\n**Optional permissions**\n\n- `read tasks` Required to access the task associated to an enricher\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by enricher name","in":"query","name":"filter[name]","schema":{"type":"string"}},{"description":"Filter by enricher description","in":"query","name":"filter[description]","schema":{"type":"string"}},{"description":"Filter by active state","in":"query","name":"filter[is_active]","schema":{"type":"boolean"}},{"description":"Filter by rate limit","in":"query","name":"filter[rate_limit]","schema":{"type":"integer"}},{"description":"Filter by monthly execution cap","in":"query","name":"filter[execution_cap]","schema":{"type":"integer"}},{"description":"Filter by creation timestamp","in":"query","name":"filter[created_at]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EnricherAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of enrichers.","tags":["Enrichers"],"x-eiq-optional-permissions":{"read tasks":"Required to access the task associated to an enricher"},"x-eiq-permissions":["read enrichers"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify enrichers`\n\n\n\n**Optional permissions**\n\n- `read tasks` Required to access the task associated to an enricher\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EnricherAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EnricherAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a new enricher.","tags":["Enrichers"],"x-eiq-optional-permissions":{"read tasks":"Required to access the task associated to an enricher"},"x-eiq-permissions":["modify enrichers"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify enrichers`\n\n\n\n**Optional permissions**\n\n- `read tasks` Required to access the task associated to an enricher\n\n","parameters":[{"$ref":"#/components/parameters/AttributesParameter"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EnricherAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EnricherAPISchema"},"type":"array"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EnricherAPISchema"},"type":"array"}},"type":"object"}}},"description":"The created object"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create (or modify if the name already exists) one or more enrichers.","tags":["Enrichers"],"x-eiq-optional-permissions":{"read tasks":"Required to access the task associated to an enricher"},"x-eiq-permissions":["modify enrichers"]}},"/enrichers/run":{"post":{"description":"Note:\n\n- If `enricher_tasks` is empty, all available enrichers are used\n- If a list entities is provided, all entity extracts are enriched\n\nThe endpoint return a TaskGroup with progress details for all invoked\ntasks.\n\n**Required permissions**\n\n- `modify enrichments`\n\n- `read enrichers`\n\n- `read tasks`\n\n\n\n**Optional permissions**\n\n- `read entities` Required to specify a list of entities\n\n- `read extracts` Required to specify a list of observables\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/BatchRunAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaskGroupAPISchema"}},"type":"object"}}},"description":"The enricher has been started."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Enriches all given extracts and/or entities with a list of enrichers.","tags":["Enrichers"],"x-eiq-optional-permissions":{"read entities":"Required to specify a list of entities","read extracts":"Required to specify a list of observables"},"x-eiq-permissions":["modify enrichments","read enrichers","read tasks"]}},"/enrichers/{id}":{"get":{"description":"\n\n**Required permissions**\n\n- `read enrichers`\n\n\n\n**Optional permissions**\n\n- `read tasks` Required to access the task associated to an enricher\n\n","parameters":[{"description":"Enricher ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EnricherAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get an enricher by ID.","tags":["Enrichers"],"x-eiq-optional-permissions":{"read tasks":"Required to access the task associated to an enricher"},"x-eiq-permissions":["read enrichers"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify enrichers`\n\n\n\n**Optional permissions**\n\n- `read tasks` Required to access the task associated to an enricher\n\n","parameters":[{"description":"Enricher ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"description":"If `true` (default) then overwrite the existing\n`source_urls` with the new mapping, otherwise\nextend them.\n","in":"query","name":"overwrite_source_urls","schema":{"type":"boolean"}},{"description":"If `true` (default) then overwrite the existing\n`parameters` with the new mapping, otherwise\nextend them.\n","in":"query","name":"overwrite_parameters","schema":{"type":"boolean"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EnricherAPISchema"}},"type":"object"}}},"description":"The updated object"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Modify an enricher.","tags":["Enrichers"],"x-eiq-optional-permissions":{"read tasks":"Required to access the task associated to an enricher"},"x-eiq-permissions":["modify enrichers"]}},"/entities":{"delete":{"description":"Note:\n\n- Referencing an entity by internal (UUID) ID will delete _only_ that\n    specific version/record of the entity.\n- Referencing an entity by STIX ID will delete all the versions of the\n    specified entity.\n- Does not delete an entity if:\n\n    - it has a draft\n    - it is a part of a static dataset\n    - it is a master entity in entity rules\n    - it has related tasks\n    - it is a part of a public dataset\n    - it is outdated\n\n    unless ``force`` flag is set to ``True``\n\n**Required permissions**\n\n- `modify entities`\n\n","parameters":[{"description":"A flag to indicate if an entity should be deleted disregarding normal checks.","in":"query","name":"force","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of entities referenced by internal or STIX IDs.","tags":["Entities"],"x-eiq-permissions":["modify entities"]},"get":{"description":"\n\n**Required permissions**\n\n- `read entities`\n\n\n\n**Optional permissions**\n\n- `read extracts` Required to access the observables attached with an entity\n\n- `read taxonomies` Required to access the taxonomies associated with an entity\n\n- `read attack` Required to access the MITRE ATT&CKs associated with an entity\n\n- `read intel-sets` Required to access the datasets associated with an entity\n\n- `read incoming-feeds` Required to access the incoming feeds associated with an entity\n\n- `read outgoing-feeds` Required to access the outgoing feeds associated with an entity\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by entity internal UUID","in":"query","name":"filter[id]","schema":{"type":"string"}},{"description":"Filter by entity type","in":"query","name":"filter[type]","schema":{"type":"string"}},{"description":"Filter by STIX ID","in":"query","name":"filter[data.id]","schema":{"type":"string"}},{"description":"Filter by title","in":"query","name":"filter[data.title]","schema":{"type":"string"}},{"description":"Filter by description","in":"query","name":"filter[data.description]","schema":{"type":"string"}},{"description":"Filter by test mechanism type","in":"query","name":"filter[data.test_mechanisms.test_mechanism_type]","schema":{"type":"string"}},{"description":"Filter by producer identity","in":"query","name":"filter[data.producer.identity]","schema":{"type":"string"}},{"description":"Filter by producer roles","in":"query","name":"filter[data.producer.roles]","schema":{"type":"string"}},{"description":"Filter by entity alias","in":"query","name":"filter[meta.alias]","schema":{"type":"string"}},{"description":"Filter by entity half-life","in":"query","name":"filter[meta.half_life]","schema":{"type":"string"}},{"description":"Filter by source(s)","in":"query","name":"filter[sources]","schema":{"type":"string"}},{"description":"Filter by incoming feed ID/URL","in":"query","name":"filter[incoming_feed]","schema":{"type":"string"}},{"description":"Filter by outgoing feed IDs/URLs","in":"query","name":"filter[outgoing_feeds]","schema":{"type":"string"}},{"description":"Filter by entity source reliability","in":"query","name":"filter[meta.source_reliability]","schema":{"type":"string"}},{"description":"Filter by tags","in":"query","name":"filter[meta.tags]","schema":{"type":"string"}},{"description":"Filter by taxonomy node IDs/URLs","in":"query","name":"filter[meta.taxonomies]","schema":{"type":"string"}},{"description":"To filter out all unresolved entities, the correct filter is `filter[!meta.is_unresolved_idref]=true`.\n","in":"query","name":"filter[meta.is_unresolved_idref]","schema":{"type":"string"}},{"description":"Filter by TLP color","in":"query","name":"filter[meta.tlp_color]","schema":{"type":"string"}},{"description":"Filter by MITRE attack IDs/URLs. The filter also targets the parents. So if an entity is classified with a technique, filtering on the parent tactic is going to include such entity.\n","in":"query","name":"filter[meta.attacks]","schema":{"type":"string"}},{"description":"Filter by MITRE attack IDs/URLs. The filter also targets the explicitly classified ATT&CK. So if an entity is classified with a technique, filtering on the parent tactic is NOT going to include such entity.\n","in":"query","name":"filter[attack_classifications]","schema":{"type":"string"}},{"description":"Filter by dataset IDs/URLs. When multiple datasets are provided, if all of them are non-relational datasets, there is a single search query executed on the server, combining all filters. But, in case of multiple datasets that include at least a relational dataset, a union query is run on the server. A union query handles combination of both entity queries and entity-relational queries. The fetching from the contained queries is done sequentially by the given order of queries in the list... E.g. if ``queries=[q_1, q_2,..., q_m]``, union query will first iterate over result set of ``q_1``, then over results of ``q_2``, and finally over results of ``q_m``.\nDue to this simplistic approach, there are some limitations of union query fetching mechanism\n- results are sorted per each individual contained query, and not per the union query; - there might be duplicated items in result, because they occur in multiple contained queries.","in":"query","name":"filter[datasets]","schema":{"type":"string"}},{"description":"Filter by observable IDs/URLs","in":"query","name":"filter[observables]","schema":{"type":"string"}},{"description":"Full-text or faceted search with logic operators\nlike `AND` and `OR`. The value examples follow.\n\n- `\"IoT Malware\"`\n- `data.title:malware OR data.description:APT17`\n- `attached_files: *`\n\nThe language of the search queries is Lucene and the\ncapability is the same as the one in Intelligence Center\nUI. Read more in [its documentation](\nhttps://docs.eclecticiq.com/ic/3.1.0/get-to-know-the-ic/search/).\n","in":"query","name":"filter[_lucene_search]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EntityAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/UnprocessableEntity"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of entities.","tags":["Entities"],"x-eiq-optional-permissions":{"read attack":"Required to access the MITRE ATT&CKs associated with an entity","read extracts":"Required to access the observables attached with an entity","read incoming-feeds":"Required to access the incoming feeds associated with an entity","read intel-sets":"Required to access the datasets associated with an entity","read outgoing-feeds":"Required to access the outgoing feeds associated with an entity","read taxonomies":"Required to access the taxonomies associated with an entity"},"x-eiq-permissions":["read entities"]},"post":{"description":"This endpoint leverages the external (STIX) ID provided on the\npayload's ``data`` attribute to de-duplicate the entity. If an\nentity with the provided STIX ID already exists, this endpoint\nreturns ``409: Conflict``, and you should use ``PATCH\n/api/<version>/entities/<stix_id>`` instead to update it.\n\n**Required permissions**\n\n- `modify entities`\n\n\n\n**Optional permissions**\n\n- `read extracts` Required to access the observables attached with an entity\n\n- `read taxonomies` Required to access the taxonomies associated with an entity\n\n- `read attack` Required to access the MITRE ATT&CKs associated with an entity\n\n- `read intel-sets` Required to access the datasets associated with an entity\n\n- `read incoming-feeds` Required to access the incoming feeds associated with an entity\n\n- `read outgoing-feeds` Required to access the outgoing feeds associated with an entity\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntityAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntityAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create an entity.","tags":["Entities"],"x-eiq-optional-permissions":{"read attack":"Required to access the MITRE ATT&CKs associated with an entity","read extracts":"Required to access the observables attached with an entity","read incoming-feeds":"Required to access the incoming feeds associated with an entity","read intel-sets":"Required to access the datasets associated with an entity","read outgoing-feeds":"Required to access the outgoing feeds associated with an entity","read taxonomies":"Required to access the taxonomies associated with an entity"},"x-eiq-permissions":["modify entities"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify entities`\n\n\n\n**Optional permissions**\n\n- `read extracts` Required to access the observables attached with an entity\n\n- `read taxonomies` Required to access the taxonomies associated with an entity\n\n- `read attack` Required to access the MITRE ATT&CKs associated with an entity\n\n- `read intel-sets` Required to access the datasets associated with an entity\n\n- `read incoming-feeds` Required to access the incoming feeds associated with an entity\n\n- `read outgoing-feeds` Required to access the outgoing feeds associated with an entity\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EntityAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EntityAPISchema"},"type":"array"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EntityAPISchema"},"type":"array"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create (or update/create a new version if the STIX ID already exists) one or more entities.","tags":["Entities"],"x-eiq-optional-permissions":{"read attack":"Required to access the MITRE ATT&CKs associated with an entity","read extracts":"Required to access the observables attached with an entity","read incoming-feeds":"Required to access the incoming feeds associated with an entity","read intel-sets":"Required to access the datasets associated with an entity","read outgoing-feeds":"Required to access the outgoing feeds associated with an entity","read taxonomies":"Required to access the taxonomies associated with an entity"},"x-eiq-permissions":["modify entities"]}},"/entities/attachments":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify entities`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of entity attachments referenced by IDs.","tags":["Entity Attachments"],"x-eiq-permissions":["modify entities"]},"get":{"description":"\n\n**Required permissions**\n\n- `read entities`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by attachment name","in":"query","name":"filter[filename]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EntityAttachmentAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of entity attachments.","tags":["Entity Attachments"],"x-eiq-permissions":["read entities"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify entities`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntityAttachmentAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntityAttachmentAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a new entity attachment.","tags":["Entity Attachments"],"x-eiq-permissions":["modify entities"]}},"/entities/attachments/{id}":{"delete":{"description":"On top of the required permissions, deleting attachments is allowed only if:\n\n- The user is the creator of the attachment, or\n- The user is a platform admin\n\n**Required permissions**\n\n- `modify entities`\n\n","parameters":[{"description":"Entity attachment ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete an entity attachment by ID.","tags":["Entity Attachments"],"x-eiq-permissions":["modify entities"]},"get":{"description":"\n\n**Required permissions**\n\n- `read entities`\n\n","parameters":[{"description":"Entity attachment ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntityAttachmentAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get an entity attachment by ID.","tags":["Entity Attachments"],"x-eiq-permissions":["read entities"]}},"/entities/attachments/{id}/content":{"get":{"description":"\n\n**Required permissions**\n\n- `read entities`\n\n","parameters":[{"description":"Entity attachment ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}},"description":"File content","headers":{"Content-Length":{"description":"File size","schema":{"type":"integer"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get content of an entity attachment by ID.","tags":["Entity Attachments"],"x-eiq-permissions":["read entities"]}},"/entities/attachments/{id}/download":{"get":{"deprecated":true,"description":"Deprecated in favor of entities/attachments/{id}/content.\n\n**Required permissions**\n\n- `read entities`\n\n","parameters":[{"description":"Entity attachment ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}},"description":"File content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Download an entity attachment by ID.","tags":["Entity Attachments"],"x-eiq-permissions":["read entities"]}},"/entities/consolidate-tasks":{"post":{"description":"Entities matching the query are consolidated into one.\nIf entities are not of the same type or\nIf an entity is already a contributor to another entity, an exception is raised.\n\nThe action is applied in a background task.\nIf no query is specified, there is no operation executed.\n\n**Required permissions**\n\n- `modify entities`\n\n- `read tasks`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntitiesConsolidateByQueryAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaskRunAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Consolidate the entities that match the specified search query.","tags":["Entities","Tasks"],"x-eiq-permissions":["modify entities","read tasks"]}},"/entities/deconsolidate-tasks":{"post":{"description":"Each matching entity is decoupled from its consolidation group.\nDecoupled entities are not going to be consolidated by future matching policies\nbut can still be merged manually via ``consolidate-tasks`` endpoint.\nIf remaining contributors for each respective consolidation group\nare a single entity, the group is dissolved, unified entities are removed and\ncontibutors are returned to a standalone state.\n\nThe action is applied in a background task.\nIf no query is specified, there is no operation executed.\n\n**Required permissions**\n\n- `modify entities`\n\n- `read tasks`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntitiesConsolidateByQueryAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaskRunAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Undo consolidation of the entities that match the specified search query.","tags":["Entities","Tasks"],"x-eiq-permissions":["modify entities","read tasks"]}},"/entities/delete-tasks":{"post":{"description":"The removal is applied in a background task.\nIf no query is specified, there is no operation executed.\n\nEntities are usually exempt from deletion if:\n\n- in static datasets\n- in public workspaces\n- set in merge rules as master entity\n- having tasks attached\n- having drafts\n\nIf `ignore_exemptions` flag is set to `True`,\nall checks except are bypassed and entities will be deleted.\n\n**Required permissions**\n\n- `modify entities`\n\n- `read tasks`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntitiesDeleteByQueryAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaskRunAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete the entities that match the specified search query.","tags":["Entities","Tasks"],"x-eiq-permissions":["modify entities","read tasks"]}},"/entities/enrich-tasks":{"post":{"description":"Starts enricher tasks for the entities that match the specified search query.\nEnrichment is done on the entities extracts (observables)\nwith a list of selected enrichers, if extracts are supported by specified enrichers.\n\nFor a search query with a relatively big number of matched entities,\nthe endpoint might have scalability issues since a new enricher task is triggered per\nsingle extract. Recommended way to work with big dataset is to use time-window\nfilters to reduce the number of matching entities...\n\nThe endpoint only starts enricher tasks, and the caller should later retrieve\ntask group information to get the status of the whole operation.\n\n**Required permissions**\n\n- `modify enrichments`\n\n- `read entities`\n\n- `read tasks`\n\n- `read enrichers`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntitiesEnrichByQueryAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaskRunAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Enrich entities by search query","tags":["Entities","Tasks"],"x-eiq-permissions":["modify enrichments","read entities","read tasks","read enrichers"]}},"/entities/export-tasks":{"post":{"description":"The action is executed in a background task.\nIf no query is specified, there is no operation executed.\n\n**Required permissions**\n\n- `modify entities`\n\n- `read tasks`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntityExportByQueryAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaskRunAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Export the entities that match the specified search query.","tags":["Entities","Tasks"],"x-eiq-permissions":["modify entities","read tasks"]}},"/entities/intel-requirement-matches":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify entities`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of matches between an entity and an intelligence requirement referenced by IDs.","tags":["Intelligence Requirement Matches"],"x-eiq-permissions":["modify entities"]},"get":{"description":"\n\n**Required permissions**\n\n- `read entities`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by Entity IDs/URLs","in":"query","name":"filter[entity_id]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IntelRequirementMatchAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of intelligence requirement matches to an entity.","tags":["Intelligence Requirement Matches"],"x-eiq-permissions":["read entities"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify entities`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/IntelRequirementMatchAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/IntelRequirementMatchAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a new match object between an enity and an intelligence requirement.","tags":["Intelligence Requirement Matches"],"x-eiq-permissions":["modify entities"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify entities`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IntelRequirementMatchAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IntelRequirementMatchAPISchema"},"type":"array"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IntelRequirementAPISchema"},"type":"array"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create (or update if the (entity_id, intel_requirement_id) combination already exists) one or more Intelligence Requirement Match objects.","tags":["Intelligence Requirement Matches"],"x-eiq-permissions":["modify entities"]}},"/entities/intel-requirement-matches/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify entities`\n\n","parameters":[{"description":"Intelligence Requirement Match ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a match between an entity and an intelligence requirement by ID.","tags":["Intelligence Requirement Matches"],"x-eiq-permissions":["modify entities"]},"get":{"description":"\n\n**Required permissions**\n\n- `read entities`\n\n","parameters":[{"description":"Intelligence Requirement Match ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/IntelRequirementMatchAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get an intelligence requirement match by ID.","tags":["Intelligence Requirement Matches"],"x-eiq-permissions":["read entities"]}},"/entities/relational-search":{"post":{"description":"**Relational search** allows users to find entities which have *relations* to other\nentities, while both `entity sets` have specific search criteria.\n\nThe query representing nodes: `query_1.es_query`, or `query_2.es_query` are native\nelasticsearch supported query objects.\n\nIt is possible to search:\n\n1. Only directly related entities\n2. Both entities related directly or indirectly through any intermediary entity\n\nFor example, a relational query looking for \"all ttps with tag 'bar' linked to\nindicators with tag 'apt-x'\", will be:\n\n```\n{\n    \"data\":{\n        \"query_1\": {\n            \"es_query\": {\n                \"query_string\": {\n                    \"query\": \"data.type:ttp AND meta.tags: bar\", \"lenient\": true,\n                }\n            }, \"node_type\": \"entity\",\n        }, \"query_2\": {\n            \"es_query\": {\n                \"query_string\": {\n                    \"query\": \"data.type:indicator AND meta.tags: apt-x\",\n                    \"lenient\": true,\n                }\n            }, \"node_type\": \"entity\",\n        }, \"relation_query\": {\"query_string\": {\"query\": \"*\", \"lenient\": true}},\n        \"output\": \"query_1\",\n    }\n}\n```\n\n**Required permissions**\n\n- `read entities`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/CursorParameter"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RelationalQueryAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EntityAPISchema"},"type":"array"},"page[cursor]":{"description":"The cursor value that can be used to fetch the next page with the page[cursor] query parameter.\n","example":"WyIyMDI0LTAxLTIyVDIwOjI4OjQxLjIxNTk0NiswMDowMCJdCg==","type":"string"}},"type":"object"}}},"description":"The requested object(s)"},"400":{"$ref":"#/components/responses/BadRequest","description":"Timeout or a malformed relational query."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Invoke a relational search query.","tags":["Entities"],"x-eiq-permissions":["read entities"]}},"/entities/update-tasks":{"post":{"description":"The change is applied in a background task.\nIf no query is specified, there is no operation executed.\n\n**Required permissions**\n\n- `modify entities`\n\n- `read tasks`\n\n\n\n**Optional permissions**\n\n- `read taxonomies` Required to access the taxonomies associated with an entity\n\n- `read attack` Required to access the MITRE ATT&CKs associated with an entity\n\n","parameters":[{"description":"If `?is_priority=true` the task is started in priority. By default, task is not prioritized.","in":"query","name":"is_priority","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntitiesUpdateByQueryAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaskRunAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Applies a change to the entities that match the specified search query.","tags":["Entities","Tasks"],"x-eiq-optional-permissions":{"read attack":"Required to access the MITRE ATT&CKs associated with an entity","read taxonomies":"Required to access the taxonomies associated with an entity"},"x-eiq-permissions":["modify entities","read tasks"]}},"/entities/{id}":{"delete":{"description":"- it has a draft\n- it is a part of a static dataset\n- it is a master entity in entity rules\n- it has related tasks\n- it is a part of a public dataset\n- it is outdated\n\nunless ``force`` flag is set to ``True``\n\n**Required permissions**\n\n- `modify entities`\n\n","parameters":[{"description":"Entity ID. It can be either a STIX ID or an EclecticIQ ID.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"A flag to indicate if an entity should be deleted disregarding normal checks.","in":"query","name":"force","required":false,"schema":{"type":"boolean"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete an entity by ID. Does not delete an entity if:","tags":["Entities"],"x-eiq-permissions":["modify entities"]},"get":{"description":"\n\n**Required permissions**\n\n- `read entities`\n\n\n\n**Optional permissions**\n\n- `read extracts` Required to access the observables attached with an entity\n\n- `read taxonomies` Required to access the taxonomies associated with an entity\n\n- `read attack` Required to access the MITRE ATT&CKs associated with an entity\n\n- `read intel-sets` Required to access the datasets associated with an entity\n\n- `read incoming-feeds` Required to access the incoming feeds associated with an entity\n\n- `read outgoing-feeds` Required to access the outgoing feeds associated with an entity\n\n","parameters":[{"description":"Entity ID. It can be either a STIX ID or an EclecticIQ ID.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntityAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get an entity by ID.","tags":["Entities"],"x-eiq-optional-permissions":{"read attack":"Required to access the MITRE ATT&CKs associated with an entity","read extracts":"Required to access the observables attached with an entity","read incoming-feeds":"Required to access the incoming feeds associated with an entity","read intel-sets":"Required to access the datasets associated with an entity","read outgoing-feeds":"Required to access the outgoing feeds associated with an entity","read taxonomies":"Required to access the taxonomies associated with an entity"},"x-eiq-permissions":["read entities"]},"patch":{"description":"The ID can be either an internal ID or an external (STIX) ID.\n\nNote, that an unified entity\n(an entity with ``is_unified_entity`` flag set to ``True`` in meta)\ncannot be modified by user. An attempt to modify it will result in an error.\n\n**Required permissions**\n\n- `modify entities`\n\n\n\n**Optional permissions**\n\n- `read extracts` Required to access the observables attached with an entity\n\n- `read taxonomies` Required to access the taxonomies associated with an entity\n\n- `read attack` Required to access the MITRE ATT&CKs associated with an entity\n\n- `read intel-sets` Required to access the datasets associated with an entity\n\n- `read incoming-feeds` Required to access the incoming feeds associated with an entity\n\n- `read outgoing-feeds` Required to access the outgoing feeds associated with an entity\n\n","parameters":[{"description":"Entity ID. It can be either a STIX ID or an EclecticIQ ID.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"If `?overwrite_observables=false` and new `observables`\nare provided, the resulting set of `observables` will\ncontain both the previous and the new observables.\nOtherwise, the list of observables will be overwritten\nby the new one (default: `true`).\n","in":"query","name":"overwrite_observables","schema":{"type":"boolean"}},{"description":"If `?overwrite_tags=false` and new `meta.tags` are\nprovided, the resulting set of `meta.tags` will contain\nboth the previous and the new tags. Otherwise, the list\nof tags will be overwritten by the new one (default:\n`true`).\n","in":"query","name":"overwrite_tags","schema":{"type":"boolean"}},{"description":"If `?overwrite_datasets=false` and new `datasets`\nreferences are provided, the resulting set of\n`datasets` will contain both the previous and the new\ndatasets. Otherwise, the list of datasets will\n be overwritten by the new one (default: `true`).\n","in":"query","name":"overwrite_datasets","schema":{"type":"boolean"}},{"description":"If `?overwrite_taxonomies=false` and new `taxonomies`\nare provided, the resulting set of `taxonomies` will\ncontain both the previous and the new taxonomies.\nOtherwise, the list of taxonomies will be overwritten\nby the new one (default: `true`).\n","in":"query","name":"overwrite_taxonomies","schema":{"type":"boolean"}},{"description":"If `?overwrite_attacks=false` and new `attacks` are\nprovided, the resulting set of `attacks` will contain\nboth the previous and the new attacks. Otherwise, the\nlist of attacks will be overwritten by the new one\n(default: `true`).\n","in":"query","name":"overwrite_attacks","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntityAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntityAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Update an entity by ID.","tags":["Entities"],"x-eiq-optional-permissions":{"read attack":"Required to access the MITRE ATT&CKs associated with an entity","read extracts":"Required to access the observables attached with an entity","read incoming-feeds":"Required to access the incoming feeds associated with an entity","read intel-sets":"Required to access the datasets associated with an entity","read outgoing-feeds":"Required to access the outgoing feeds associated with an entity","read taxonomies":"Required to access the taxonomies associated with an entity"},"x-eiq-permissions":["modify entities"]}},"/export-blocks/{id}/content":{"get":{"description":"\n\n**Required permissions**\n\n- `read entities`\n\n","parameters":[{"description":"Export block ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"responses":{"200":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}},"description":"File content","headers":{"Content-Length":{"description":"File size","schema":{"type":"integer"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get content of an export block by ID.","tags":["Export Blocks"],"x-eiq-permissions":["read entities"]}},"/files":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify files`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of files referenced by IDs.","tags":["Files"],"x-eiq-permissions":["modify files"]},"get":{"description":"If the user is not admin, then only the files that are either public\nor attached to a workspace where the user is a collaborator will be\nreturned.\n\n**Required permissions**\n\n- `read files`\n\n\n\n**Optional permissions**\n\n- `read workspaces` To access the workspace a file is attached to\n\n- `read user` To access the file creator information\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by file name","in":"query","name":"filter[filename]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/FileAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of workspace files.","tags":["Files"],"x-eiq-optional-permissions":{"read user":"To access the file creator information","read workspaces":"To access the workspace a file is attached to"},"x-eiq-permissions":["read files"]},"post":{"description":"The creation of a file in a workspace is only allowed if:\n\n- The user is a collaborator of the workspace, or\n- The user is a platform admin\n\n**Required permissions**\n\n- `modify files`\n\n\n\n**Optional permissions**\n\n- `read workspaces` To access the workspace a file is attached to\n\n- `read user` To access the file creator information\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/FileAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/FileAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a new file in a workspace.","tags":["Files"],"x-eiq-optional-permissions":{"read user":"To access the file creator information","read workspaces":"To access the workspace a file is attached to"},"x-eiq-permissions":["modify files"]}},"/files/{id}":{"delete":{"description":"On top of the required permissions, deleting files is allowed only if:\n\n- The user is the creator of the file, or\n- The user is a platform admin\n\n**Required permissions**\n\n- `modify files`\n\n","parameters":[{"description":"Workspace file ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a workspace file by ID.","tags":["Files"],"x-eiq-permissions":["modify files"]},"get":{"description":"On top of the required permissions, reading a file attached to a\nworkspace is allowed only if:\n\n    - The user is a collaborator of the workspace, or\n    - The user is a platform admin, or\n    - The file has `is_public=True`.\n\nThe file content hash must be unique per workspace.\n\n**Required permissions**\n\n- `read files`\n\n\n\n**Optional permissions**\n\n- `read workspaces` To access the workspace a file is attached to\n\n- `read user` To access the file creator information\n\n","parameters":[{"description":"Workspace file ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/FileAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a workspace file by ID.","tags":["Files"],"x-eiq-optional-permissions":{"read user":"To access the file creator information","read workspaces":"To access the workspace a file is attached to"},"x-eiq-permissions":["read files"]}},"/files/{id}/content":{"get":{"description":"\n\n**Required permissions**\n\n- `read files`\n\n","parameters":[{"description":"Workspace file ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}},"description":"File content","headers":{"Content-Length":{"description":"File size","schema":{"type":"integer"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get content of a file by ID.","tags":["Files"],"x-eiq-permissions":["read files"]}},"/files/{id}/download":{"get":{"deprecated":true,"description":"Deprecated in favor of /files/{id}/content.\n\n**Required permissions**\n\n- `read files`\n\n","parameters":[{"description":"Workspace file ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}},"description":"File content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Download a file by ID.","tags":["Files"],"x-eiq-permissions":["read files"]}},"/font-families":{"get":{"description":"\n\n**Required permissions**\n\n- `read report-templates`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/FontFamilySchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of fonts.","tags":["Fonts"],"x-eiq-permissions":["read report-templates"]},"post":{"description":"Accepts either:\n- A single `.ttf`, `.otf` font file.\n- A `.zip` file containing one or more `.ttf` files.\n\n**Required permissions**\n\n- `modify report-templates`\n\n","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"description":"The font file or zip to upload","format":"binary","type":"string"}},"required":["file"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/FontFamilySchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Upload a new custom font (TTF or ZIP).","tags":["Fonts"],"x-eiq-permissions":["modify report-templates"]}},"/font-families/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify report-templates`\n\n","parameters":[{"description":"Font ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a font by ID.","tags":["Fonts"],"x-eiq-permissions":["modify report-templates"]}},"/groups":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify groups`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of groups referenced by IDs.","tags":["Groups"],"x-eiq-permissions":["modify groups"]},"get":{"description":"Note that only the groups the user is a member of will be returned.\nOnly global admin users can see the full list of groups.\n\n**Required permissions**\n\n- `read groups`\n\n\n\n**Optional permissions**\n\n- `read users` Required to access the list of users on a group (alternatively, you can only see users for the groups you administer)\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by group name","in":"query","name":"filter[name]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/GroupAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Returns a list of the groups on the platform.","tags":["Groups"],"x-eiq-optional-permissions":{"read users":"Required to access the list of users on a group (alternatively, you can only see users for the groups you administer)"},"x-eiq-permissions":["read groups"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify groups`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/GroupAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/GroupAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a group.","tags":["Groups"],"x-eiq-permissions":["modify groups"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify groups`\n\n","parameters":[{"$ref":"#/components/parameters/AttributesParameter"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/GroupAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/GroupAPISchema"},"type":"array"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/GroupAPISchema"},"type":"array"}},"type":"object"}}},"description":"The created object"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create (or modify if the name already exists) one or more groups.","tags":["Groups"],"x-eiq-permissions":["modify groups"]}},"/groups/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify groups`\n\n","parameters":[{"description":"Group ID","in":"path","name":"id","required":true,"schema":{"type":"number"}},{"description":"If `false` (default) then group deletion will fail if\nthe group is still in use - namely, if non-global admin\nusers are still associated to the group or the group is\nconfigured as an allowed group for an incoming or\noutgoing feed. In that case, you'll have to explicitly\nremove those associations. If `true`, the existing\nassociations will automatically be removed on cascade.\n","in":"query","name":"force","schema":{"type":"boolean"}}],"responses":{"204":{"description":"The deletion has been successful"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a group by ID.","tags":["Groups"],"x-eiq-permissions":["modify groups"]},"get":{"description":"Note that only the groups the user is a member of will be returned.\nOnly global admin users can see the full list of groups.\n\n**Required permissions**\n\n- `read groups`\n\n\n\n**Optional permissions**\n\n- `read users` Required to access the list of users on a group (alternatively, you can only see users for the groups you administer)\n\n","parameters":[{"description":"Group ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/GroupAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a group by ID.","tags":["Groups"],"x-eiq-optional-permissions":{"read users":"Required to access the list of users on a group (alternatively, you can only see users for the groups you administer)"},"x-eiq-permissions":["read groups"]},"patch":{"description":"Note that you can only update groups that you administer (unless you are\na global admin), and modifying the sources attached to a group requires\nthe `modify groups` permission.\n\n**Required permissions**\n\n- `read groups`\n\n\n\n**Optional permissions**\n\n- `modify groups` Required to modify the sources attached to a group\n\n","parameters":[{"description":"Group ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"If `?overwrite_sources=false` and new `sources` are\nprovided, the resulting set of `sources` will contain\nboth the previous and the new sources. Otherwise, the\nlist of sources will be overwritten by the new one\n(default: `true`).\n","in":"query","name":"overwrite_sources","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/GroupAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/GroupAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Update a group.","tags":["Groups"],"x-eiq-optional-permissions":{"modify groups":"Required to modify the sources attached to a group"},"x-eiq-permissions":["read groups"]}},"/incoming-feeds":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify incoming-feeds`\n\n","parameters":[{"description":"Delete the entities associated to the feed.","in":"query","name":"delete_entities","required":true,"schema":{"type":"boolean"}},{"description":"Delete the configuration associated to the feed.","in":"query","name":"delete_configuration","required":true,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of incoming feeds referenced by IDs.","tags":["Incoming feeds"],"x-eiq-permissions":["modify incoming-feeds"]},"get":{"description":"\n\n**Required permissions**\n\n- `read incoming-feeds`\n\n\n\n**Optional permissions**\n\n- `read tasks` To read the tasks associated to the feeds\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by feed name","in":"query","name":"filter[name]","schema":{"type":"string"}},{"description":"Filter by feed status","in":"query","name":"filter[status]","schema":{"type":"string"}},{"description":"Filter by content type","in":"query","name":"filter[content_type]","schema":{"type":"string"}},{"description":"Filter by transport type","in":"query","name":"filter[transport_type]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IncomingFeedAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of incoming feeds.","tags":["Incoming feeds"],"x-eiq-optional-permissions":{"read tasks":"To read the tasks associated to the feeds"},"x-eiq-permissions":["read incoming-feeds"]},"post":{"description":"Depending on the content type it will be required\nto provide additional transport configuration fields.\nFor more details see the documentation\n\n**Required permissions**\n\n- `modify incoming-feeds`\n\n\n\n**Optional permissions**\n\n- `read tasks` To read/modify the task associated to this feed\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/IncomingFeedAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/IncomingFeedAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Configure a new incoming feed.","tags":["Incoming feeds"],"x-eiq-optional-permissions":{"read tasks":"To read/modify the task associated to this feed"},"x-eiq-permissions":["modify incoming-feeds"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify incoming-feeds`\n\n\n\n**Optional permissions**\n\n- `read tasks` To read/modify the task associated to this feed\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IncomingFeedAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IncomingFeedAPISchema"},"type":"array"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IncomingFeedAPISchema"},"type":"array"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create (or update if the name already exists) an incoming feed.","tags":["Incoming feeds"],"x-eiq-optional-permissions":{"read tasks":"To read/modify the task associated to this feed"},"x-eiq-permissions":["modify incoming-feeds"]}},"/incoming-feeds/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify incoming-feeds`\n\n","parameters":[{"description":"Feed ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"description":"Delete the entities associated to the feed.","in":"query","name":"delete_entities","required":true,"schema":{"type":"boolean"}},{"description":"Delete the configuration associated to the feed.","in":"query","name":"delete_configuration","required":true,"schema":{"type":"boolean"}}],"responses":{"204":{"description":"The deletion has been successful"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete an incoming feed configuration by ID.","tags":["Incoming feeds"],"x-eiq-permissions":["modify incoming-feeds"]},"get":{"description":"\n\n**Required permissions**\n\n- `read incoming-feeds`\n\n\n\n**Optional permissions**\n\n- `read tasks` To read the task associated to this feed\n\n","parameters":[{"description":"Feed ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/IncomingFeedAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get an incoming feed by ID.","tags":["Incoming feeds"],"x-eiq-optional-permissions":{"read tasks":"To read the task associated to this feed"},"x-eiq-permissions":["read incoming-feeds"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify incoming-feeds`\n\n\n\n**Optional permissions**\n\n- `read tasks` To read/modify the task associated to this feed\n\n","parameters":[{"description":"Feed ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/IncomingFeedAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/IncomingFeedAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Edit an incoming feed configuration by ID.","tags":["Incoming feeds"],"x-eiq-optional-permissions":{"read tasks":"To read/modify the task associated to this feed"},"x-eiq-permissions":["modify incoming-feeds"]}},"/knowledge-packs":{"get":{"description":"\n\n**Required permissions**\n\n- `read knowledge-packs`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by name","in":"query","name":"filter[name]","schema":{"type":"string"}},{"description":"Filter by state","in":"query","name":"filter[state]","schema":{"type":"string"}},{"description":"Filter by description","in":"query","name":"filter[description]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/KnowledgePackAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Returns a list of knowledge packs.","tags":["Knowledge Packs"],"x-eiq-permissions":["read knowledge-packs"]},"post":{"description":"**Note:** Setting the \"state\" field only supported with PATCH method.\n\n\n**Required permissions**\n\n- `modify knowledge-packs`\n\n- `read knowledge-packs`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/KnowledgePackAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/KnowledgePackAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a new knowledge pack.","tags":["Knowledge Packs"],"x-eiq-permissions":["modify knowledge-packs","read knowledge-packs"]},"put":{"description":"**Note:** Setting the \"state\" field only supported with PATCH method.\n\n\n**Required permissions**\n\n- `modify knowledge-packs`\n\n- `read knowledge-packs`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/KnowledgePackAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/KnowledgePackAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create (or modify if already exists) one or more knowledge packs.","tags":["Knowledge Packs"],"x-eiq-permissions":["modify knowledge-packs","read knowledge-packs"]}},"/knowledge-packs/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify knowledge-packs`\n\n- `read knowledge-packs`\n\n","parameters":[{"description":"Knowledge pack ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a knowledge pack as publisher.","tags":["Knowledge Packs"],"x-eiq-permissions":["modify knowledge-packs","read knowledge-packs"]},"get":{"description":"\n\n**Required permissions**\n\n- `read knowledge-packs`\n\n","parameters":[{"description":"Knowledge pack ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/KnowledgePackAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a Knowledge Pack by ID.","tags":["Knowledge Packs"],"x-eiq-permissions":["read knowledge-packs"]},"patch":{"description":"Knowledge pack life cycle can be managed by setting \"state\"\nto one of following values: `INSTALLED`, `UNINSTALLED`, `PUBLISHED`\nor `NEW`.\n\n**Note:** Setting state only supported with PATCH method and\ncannot be mixed with update of other fields.\n\n**Required permissions**\n\n- `modify knowledge-packs`\n\n- `read knowledge-packs`\n\n","parameters":[{"description":"Knowledge pack ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/KnowledgePackAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/KnowledgePackAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"410":{"$ref":"#/components/responses/Gone"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Update a knowledge pack.","tags":["Knowledge Packs"],"x-eiq-permissions":["modify knowledge-packs","read knowledge-packs"]}},"/notifications":{"get":{"description":"Notifications are periodically removed from the system.\nThere is a limit of most revent notifications per user that is controlled\nby ``NOTIFICATIONS_MAX_PER_USER`` value in platform settings.\n\n**Required permissions**\n\n- `read notifications`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by recipient user","in":"query","name":"filter[user]","schema":{"type":"string"}},{"description":"Filter by type of the message","in":"query","name":"filter[message_type]","schema":{"type":"string"}},{"description":"Filter by type of the event","in":"query","name":"filter[event_name]","schema":{"type":"string"}},{"description":"Filter by whether the notification is read","in":"query","name":"filter[is_read]","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/NotificationAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Returns a list of notifications in the platform.","tags":["Notifications"],"x-eiq-permissions":["read notifications"]}},"/notifications/{id}":{"get":{"description":"\n\n**Required permissions**\n\n- `read permissions`\n\n","parameters":[{"description":"Notification ID","in":"path","name":"id","required":true,"schema":{"type":"number"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/NotificationAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a user notification by ID.","tags":["Notifications"],"x-eiq-permissions":["read permissions"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify notifications`\n\n","parameters":[{"description":"Notification ID","in":"path","name":"id","required":true,"schema":{"type":"number"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/NotificationAPISchema"}},"type":"object"}}},"description":"The updated object"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Modify a notification by ID. The only supported modification is marking a notification as ``is_read``.","tags":["Notifications"],"x-eiq-permissions":["modify notifications"]}},"/observables":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify extracts`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of observables referenced by IDs.","tags":["Observables"],"x-eiq-permissions":["modify extracts"]},"get":{"description":"\n\n**Required permissions**\n\n- `read extracts`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by observable type","in":"query","name":"filter[type]","schema":{"type":"string"}},{"description":"Filter by observable value","in":"query","name":"filter[value]","schema":{"type":"string"}},{"description":"Filter by source ID/URL","in":"query","name":"filter[sources]","schema":{"type":"string"}},{"description":"Filter by related entity ID/URL","in":"query","name":"filter[entities]","schema":{"type":"string"}},{"description":"Full-text or faceted search with logic operators\nlike `AND` and `OR`. The value examples follow.\n\nThis filter is incompatible with any other filter type.\n\nThe language of the search queries is Lucene and the\ncapability is the same as the one in Intelligence Center\nUI. Read more in [its documentation](\nhttps://docs.eclecticiq.com/ic/3.1.0/get-to-know-the-ic/search/).\n","in":"query","name":"filter[_lucene_search]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ObservableAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of observables.","tags":["Observables"],"x-eiq-permissions":["read extracts"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify extracts`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ObservableAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ObservableAPISchema"},"type":"array"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a new observable.","tags":["Observables"],"x-eiq-permissions":["modify extracts"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify extracts`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ObservableAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ObservableAPISchema"},"type":"array"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ObservableAPISchema"},"type":"array"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create (or update if the (`type`, `value`) pair already exists) one or more observables.","tags":["Observables"],"x-eiq-permissions":["modify extracts"]}},"/observables/delete-tasks":{"post":{"description":"\n\n**Required permissions**\n\n- `modify extracts`\n\n- `read tasks`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ObservableDeleteByQueryAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaskRunAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete the extracts that match the specified search query. Only extracts matching the query are deleted.","tags":["Observables","Tasks"],"x-eiq-permissions":["modify extracts","read tasks"]}},"/observables/enrich-tasks":{"post":{"description":"Starts enricher tasks for the extracts that match the specified search query.\nEnrichment is done on the extracts (observables)\nwith a list of selected enrichers, if extracts are supported by specified enrichers.\n\nThe endpoint only starts enricher tasks, and the caller should later retrieve\ntask groups information to get the status of the whole operation.\n\n**Required permissions**\n\n- `modify extracts`\n\n- `read tasks`\n\n- `modify enrichments`\n\n- `read enrichers`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ObservableEnrichByQueryAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaskRunAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Enrich the extracts that match the specified search query.","tags":["Observables","Tasks"],"x-eiq-permissions":["modify extracts","read tasks","modify enrichments","read enrichers"]}},"/observables/export-tasks":{"post":{"description":"Action is executed in a background task.\nIf no query is specified, there is no operation executed.\n\n**Required permissions**\n\n- `modify extracts`\n\n- `read tasks`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ObservableExportByQueryAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaskRunAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Export the extracts that match the specified search query.","tags":["Observables","Tasks"],"x-eiq-permissions":["modify extracts","read tasks"]}},"/observables/score-update-tasks":{"post":{"description":"Action is executed in a background task.\nIf no query is specified, there is no operation executed.\n\n**Required permissions**\n\n- `modify extracts`\n\n- `modify tasks`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ObservableRiskScoreUpdateByQueryAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaskRunAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Update risk score of extracts that match the specified search query and create score update records.","tags":["Observables","Tasks"],"x-eiq-permissions":["modify extracts","modify tasks"]}},"/observables/update-tasks":{"post":{"description":"Action is executed in a background task.\nIf no query is specified, there is no operation executed.\n\n**Required permissions**\n\n- `modify extracts`\n\n- `read tasks`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ObservableUpdateByQueryAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaskRunAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Update the extracts that match the specified search query.","tags":["Observables","Tasks"],"x-eiq-permissions":["modify extracts","read tasks"]}},"/observables/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify extracts`\n\n","parameters":[{"description":"Observable ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete an observable by ID.","tags":["Observables"],"x-eiq-permissions":["modify extracts"]},"get":{"description":"\n\n**Required permissions**\n\n- `read extracts`\n\n","parameters":[{"description":"Observable ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ObservableAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get an observable by ID.","tags":["Observables"],"x-eiq-permissions":["read extracts"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify extracts`\n\n","parameters":[{"description":"Observable ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ObservableAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ObservableAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Edit an observable by ID.","tags":["Observables"],"x-eiq-permissions":["modify extracts"]}},"/observables/{id}/score-updates":{"get":{"description":"\n\n**Required permissions**\n\n- `read extracts`\n\n","parameters":[{"description":"Observable ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/AttributesParameter"},{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/DataParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ObservableRiskScoreUpdateSchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a history of risk score changes for an observable.","tags":["Observables"],"x-eiq-permissions":["read extracts"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify extracts`\n\n","parameters":[{"description":"Observable ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ObservableRiskScoreUpdateSchema"}},"type":"object"}}},"description":"The created object"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create an observable risk score update.","tags":["Observables"],"x-eiq-permissions":["modify extracts"]}},"/outgoing-feeds":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify outgoing-feeds`\n\n","parameters":[{"description":"Delete the configuration associated to the feed.","in":"query","name":"delete_configuration","required":true,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of outgoing feeds referenced by IDs.","tags":["Outgoing feeds"],"x-eiq-permissions":["modify outgoing-feeds"]},"get":{"description":"\n\n**Required permissions**\n\n- `read outgoing-feeds`\n\n\n\n**Optional permissions**\n\n- `read intel-sets` To read the datasets associated to the feeds\n\n- `read tasks` To read the tasks associated to the feeds\n\n- `read taxonomies` To read the whitelisted taxonomy nodes associated to the feeds\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by feed name","in":"query","name":"filter[name]","schema":{"type":"string"}},{"description":"Filter by feed status","in":"query","name":"filter[status]","schema":{"type":"string"}},{"description":"Filter by packaging status","in":"query","name":"filter[packaging_status]","schema":{"type":"string"}},{"description":"Filter by content type","in":"query","name":"filter[content_type]","schema":{"type":"string"}},{"description":"Filter by transport type","in":"query","name":"filter[transport_type]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/OutgoingFeedAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of outgoing feeds.","tags":["Outgoing feeds"],"x-eiq-optional-permissions":{"read intel-sets":"To read the datasets associated to the feeds","read tasks":"To read the tasks associated to the feeds","read taxonomies":"To read the whitelisted taxonomy nodes associated to the feeds"},"x-eiq-permissions":["read outgoing-feeds"]},"post":{"description":"Depending on the content type it will be required\nto provide additional transport configuration fields.\nFor more details see the documentation\n\n**Required permissions**\n\n- `modify outgoing-feeds`\n\n\n\n**Optional permissions**\n\n- `read intel-sets` To read/modify the datasets associated to this feed\n\n- `read tasks` To read/modify the tasks associated to this feed\n\n- `read taxonomies` To read/modify the whitelisted taxonomy nodes associated to this feed\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/OutgoingFeedAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/OutgoingFeedAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Configure a new outgoing feed.","tags":["Outgoing feeds"],"x-eiq-optional-permissions":{"read intel-sets":"To read/modify the datasets associated to this feed","read tasks":"To read/modify the tasks associated to this feed","read taxonomies":"To read/modify the whitelisted taxonomy nodes associated to this feed"},"x-eiq-permissions":["modify outgoing-feeds"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify outgoing-feeds`\n\n\n\n**Optional permissions**\n\n- `read intel-sets` To read/modify the datasets associated to this feed\n\n- `read tasks` To read/modify the tasks associated to this feed\n\n- `read taxonomies` To read/modify the whitelisted taxonomy nodes associated to this feed\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/OutgoingFeedAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/OutgoingFeedAPISchema"},"type":"array"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/OutgoingFeedAPISchema"},"type":"array"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create (or update if the name already exists) one or more outgoing feeds.","tags":["Outgoing feeds"],"x-eiq-optional-permissions":{"read intel-sets":"To read/modify the datasets associated to this feed","read tasks":"To read/modify the tasks associated to this feed","read taxonomies":"To read/modify the whitelisted taxonomy nodes associated to this feed"},"x-eiq-permissions":["modify outgoing-feeds"]}},"/outgoing-feeds/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify outgoing-feeds`\n\n","parameters":[{"description":"Feed ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"description":"Delete the configuration associated to the feed.","in":"query","name":"delete_configuration","required":true,"schema":{"type":"boolean"}}],"responses":{"204":{"description":"The deletion has been successful"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete an outgoing feed configuration by ID.","tags":["Outgoing feeds"],"x-eiq-permissions":["modify outgoing-feeds"]},"get":{"description":"\n\n**Required permissions**\n\n- `read outgoing-feeds`\n\n\n\n**Optional permissions**\n\n- `read intel-sets` To read the datasets associated to this feed\n\n- `read tasks` To read the tasks associated to this feed\n\n- `read taxonomies` To read the whitelisted taxonomy nodes associated to this feed\n\n","parameters":[{"description":"Feed ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/OutgoingFeedAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get an outgoing feed by ID.","tags":["Outgoing feeds"],"x-eiq-optional-permissions":{"read intel-sets":"To read the datasets associated to this feed","read tasks":"To read the tasks associated to this feed","read taxonomies":"To read the whitelisted taxonomy nodes associated to this feed"},"x-eiq-permissions":["read outgoing-feeds"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify outgoing-feeds`\n\n\n\n**Optional permissions**\n\n- `read intel-sets` To read/modify the datasets associated to this feed\n\n- `read tasks` To read/modify the tasks associated to this feed\n\n- `read taxonomies` To read/modify the whitelisted taxonomy nodes associated to this feed\n\n","parameters":[{"description":"Feed ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/OutgoingFeedAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/OutgoingFeedAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Edit an outgoing feed configuration by ID.","tags":["Outgoing feeds"],"x-eiq-optional-permissions":{"read intel-sets":"To read/modify the datasets associated to this feed","read tasks":"To read/modify the tasks associated to this feed","read taxonomies":"To read/modify the whitelisted taxonomy nodes associated to this feed"},"x-eiq-permissions":["modify outgoing-feeds"]}},"/overview-dashboards":{"get":{"description":"\n\n**Required permissions**\n\n- `read dashboard`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/OverviewDashboardAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of Overview Dashboards.","tags":["Dashboards"],"x-eiq-permissions":["read dashboard"]},"post":{"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/OverviewDashboardAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/OverviewDashboardAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create overview dashboard.","tags":["Dashboards"]}},"/overview-dashboards/{id}":{"delete":{"parameters":[{"description":"Overview Dashboard ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"responses":{"204":{"description":"Deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete an overview dashboard.","tags":["Dashboards"]},"patch":{"parameters":[{"description":"Overview Dashboard ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/OverviewDashboardAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/OverviewDashboardAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Update Overview dashboard.","tags":["Dashboards"]}},"/permissions":{"get":{"description":"\n\n**Required permissions**\n\n- `read permissions`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by permission name","in":"query","name":"filter[name]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PermissionAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Returns a list of permissions on the platform.","tags":["Permissions"],"x-eiq-permissions":["read permissions"]}},"/permissions/{id}":{"get":{"description":"\n\n**Required permissions**\n\n- `read permissions`\n\n","parameters":[{"description":"Permission ID","in":"path","name":"id","required":true,"schema":{"type":"number"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/PermissionAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a user permission by ID.","tags":["Permissions"],"x-eiq-permissions":["read permissions"]}},"/relationships":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify entities`\n\n","parameters":[{"description":"Filter by source entity internal or STIX ID","in":"query","name":"source","schema":{"type":"string"}},{"description":"Filter by target entity internal or STIX ID","in":"query","name":"target","schema":{"type":"string"}}],"responses":{"204":{"description":"The deletion has been successful"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete relationships based on source and/or target.","tags":["Relationships"],"x-eiq-permissions":["modify entities"]},"get":{"description":"\n\n**Required permissions**\n\n- `read entities`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by EIQ JSON relation type.","in":"query","name":"filter[key]","schema":{"type":"string"}},{"description":"Filter by EIQ JSON relation subtype (e.g. `stix_update_of`).","in":"query","name":"filter[subtype]","schema":{"type":"string"}},{"description":"Filter by relation STIX ID","in":"query","name":"filter[id]","schema":{"type":"string"}},{"description":"Filter by source entity internal or STIX ID","in":"query","name":"filter[data.source]","schema":{"type":"string"}},{"description":"Filter by target entity internal or STIX ID","in":"query","name":"filter[data.target]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RelationshipAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of relationships.","tags":["Relationships"],"x-eiq-permissions":["read entities"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify entities`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RelationshipAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RelationshipAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a relationship.","tags":["Relationships"],"x-eiq-permissions":["modify entities"]},"put":{"description":"On Update, there are some restriction:\n\n1. Only ``data.key`` and ``data.description``, and ``meta`` can be changed else a\n   400 is raised\n2. Other existing properties in ``data`` can be provided but only with the same\n   value\n3. Any other root properties than ``data`` and ``meta`` are ignored\n\n**Required permissions**\n\n- `modify entities`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RelationshipAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RelationshipAPISchema"},"type":"array"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RelationshipAPISchema"},"type":"array"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create (or update) one or more relationships.","tags":["Relationships"],"x-eiq-permissions":["modify entities"]}},"/relationships/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify entities`\n\n","parameters":[{"description":"Relationship ID.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a relationship by ID.","tags":["Relationships"],"x-eiq-permissions":["modify entities"]},"get":{"description":"\n\n**Required permissions**\n\n- `read entities`\n\n","parameters":[{"description":"Relationship ID.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RelationshipAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a relationship by ID.","tags":["Relationships"],"x-eiq-permissions":["read entities"]},"patch":{"description":"Restriction:\n\n1. Only ``data.key`` and ``data.description``, and ``meta`` can be changed else a\n   400 is raised\n2. Other existing properties in ``data`` can be provided but only with the same\n   value\n3. Any other root properties than ``data`` and ``meta`` are ignored\n\n**Required permissions**\n\n- `modify entities`\n\n","parameters":[{"description":"Relationship ID.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RelationshipAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RelationshipAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Update a relationship by ID.","tags":["Relationships"],"x-eiq-permissions":["modify entities"]}},"/report-template-attachments":{"post":{"description":"\n\n**Required permissions**\n\n- `modify report-templates`\n\n","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"description":"Attachment to upload","format":"binary","type":"string"}},"required":["file"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ReportTemplateAttachmentSchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Upload a report template attachment.","tags":["Report Templates"],"x-eiq-permissions":["modify report-templates"]}},"/report-template-attachments/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify report-templates`\n\n","parameters":[{"description":"Report Template Attachment ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete report template attachment by ID.","tags":["Report Templates"],"x-eiq-permissions":["modify report-templates"]}},"/report-templates":{"delete":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of report templates by IDs.","tags":["Report Templates"]},"get":{"description":"\n\n**Required permissions**\n\n- `read report-templates`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ReportTemplateSchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of report templates.","tags":["Report Templates"],"x-eiq-permissions":["read report-templates"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify report-templates`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ReportTemplateSchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ReportTemplateSchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a report template.","tags":["Report Templates"],"x-eiq-permissions":["modify report-templates"]}},"/report-templates/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify report-templates`\n\n","parameters":[{"description":"Report Template ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a report template by ID.","tags":["Report Templates"],"x-eiq-permissions":["modify report-templates"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify report-templates`\n\n","parameters":[{"description":"Report Template ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ReportTemplateDetailSchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ReportTemplateDetailSchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Update report template by ID.","tags":["Report Templates"],"x-eiq-permissions":["modify report-templates"]}},"/report-templates/{id}/duplicate":{"post":{"description":"\n\n**Required permissions**\n\n- `modify report-templates`\n\n","parameters":[{"description":"Report Template ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ReportTemplateSchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ReportTemplateSchema"}},"type":"object"}}},"description":"The requested object(s)"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a duplicate report template using existing report template ID.","tags":["Report Templates"],"x-eiq-permissions":["modify report-templates"]}},"/risk-score/decay-settings":{"get":{"description":"\n\n**Required permissions**\n\n- `read observable-risk-score-policy`\n\n","parameters":[{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RiskScoreDecaySchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of risk score decay settings.","tags":["Observable Risk Score"],"x-eiq-permissions":["read observable-risk-score-policy"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify observable-risk-score-policy`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RiskScoreDecaySchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RiskScoreDecaySchema"},"type":"array"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RiskScoreDecaySchema"},"type":"array"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create or update (if a setting for such observable type already exists) one or more risk score decay settings.","tags":["Observable Risk Score"],"x-eiq-permissions":["modify observable-risk-score-policy"]}},"/risk-score/policies":{"get":{"description":"\n\n**Required permissions**\n\n- `read observable-risk-score-policy`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RiskScorePolicyAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of risk score policies.","tags":["Observable Risk Score"],"x-eiq-permissions":["read observable-risk-score-policy"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify observable-risk-score-policy`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RiskScorePolicyAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RiskScorePolicyAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a risk score policy.","tags":["Observable Risk Score"],"x-eiq-permissions":["modify observable-risk-score-policy"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify observable-risk-score-policy`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RiskScorePolicyAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RiskScorePolicyAPISchema"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RiskScorePolicyAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create (or update if the name already exists) one or more policies.","tags":["Observable Risk Score"],"x-eiq-permissions":["modify observable-risk-score-policy"]}},"/risk-score/policies/{policy_id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify observable-risk-score-policy`\n\n","parameters":[{"description":"Risk Score Policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a risk score policy by ID.","tags":["Observable Risk Score"],"x-eiq-permissions":["modify observable-risk-score-policy"]},"get":{"description":"\n\n**Required permissions**\n\n- `read observable-risk-score-policy`\n\n","parameters":[{"description":"Risk Score Policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RiskScorePolicyAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a risk score policy by ID","tags":["Observable Risk Score"],"x-eiq-permissions":["read observable-risk-score-policy"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify observable-risk-score-policy`\n\n","parameters":[{"description":"Risk Score Policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RiskScorePolicyAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RiskScorePolicyAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Edit a risk score policy by ID.","tags":["Observable Risk Score"],"x-eiq-permissions":["modify observable-risk-score-policy"]}},"/risk-score/policies/{policy_id}/parameters":{"get":{"description":"\n\n**Required permissions**\n\n- `read observable-risk-score-policy`\n\n","parameters":[{"description":"Risk Score Policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RiskScoreParameterAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of parameters for a policy.","tags":["Observable Risk Score"],"x-eiq-permissions":["read observable-risk-score-policy"]}},"/risk-score/policies/{policy_id}/parameters/{parameter_id}":{"get":{"description":"\n\n**Required permissions**\n\n- `read observable-risk-score-policy`\n\n","parameters":[{"description":"Risk Score Policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"description":"parameter ID","in":"path","name":"parameter_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RiskScoreParameterAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a policy parameter by ID.","tags":["Observable Risk Score"],"x-eiq-permissions":["read observable-risk-score-policy"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify observable-risk-score-policy`\n\n","parameters":[{"description":"Risk Score Policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"description":"Parameter ID","in":"path","name":"parameter_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RiskScoreParameterAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RiskScoreParameterAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Edit a policy parameter by ID.","tags":["Observable Risk Score"],"x-eiq-permissions":["modify observable-risk-score-policy"]}},"/risk-score/policies/{policy_id}/parameters/{parameter_id}/values":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify observable-risk-score-policy`\n\n","parameters":[{"description":"Risk Score Policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"description":"Parameter ID","in":"path","name":"parameter_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of parameter values by ID.","tags":["Observable Risk Score"],"x-eiq-permissions":["modify observable-risk-score-policy"]},"get":{"description":"\n\n**Required permissions**\n\n- `read observable-risk-score-policy`\n\n\n\n**Optional permissions**\n\n- `read sources` Required to access the sources associated to risk score parameter\n\n- `read entities` Required to access the entities associated to risk score parameter\n\n- `read observables` Required to access the observables associated to risk score parameter\n\n- `read taxonomies` Required to access the taxonomies associated to risk score parameter\n\n","parameters":[{"description":"Risk Score Policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"description":"parameter ID","in":"path","name":"parameter_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RiskScoreParameterValueAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a parameter values list.","tags":["Observable Risk Score"],"x-eiq-optional-permissions":{"read entities":"Required to access the entities associated to risk score parameter","read observables":"Required to access the observables associated to risk score parameter","read sources":"Required to access the sources associated to risk score parameter","read taxonomies":"Required to access the taxonomies associated to risk score parameter"},"x-eiq-permissions":["read observable-risk-score-policy"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify observable-risk-score-policy`\n\n\n\n**Optional permissions**\n\n- `read sources` Required to access the sources associated to risk score parameter\n\n- `read entities` Required to access the entities associated to risk score parameter\n\n- `read observables` Required to access the observables associated to risk score parameter\n\n- `read taxonomies` Required to access the taxonomies associated to risk score parameter\n\n","parameters":[{"description":"Risk Score Policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"description":"Parameter ID","in":"path","name":"parameter_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RiskScoreParameterValueAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RiskScoreParameterValueAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a new parameter value.","tags":["Observable Risk Score"],"x-eiq-optional-permissions":{"read entities":"Required to access the entities associated to risk score parameter","read observables":"Required to access the observables associated to risk score parameter","read sources":"Required to access the sources associated to risk score parameter","read taxonomies":"Required to access the taxonomies associated to risk score parameter"},"x-eiq-permissions":["modify observable-risk-score-policy"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify observable-risk-score-policy`\n\n\n\n**Optional permissions**\n\n- `read sources` Required to access the sources associated to risk score parameter\n\n- `read entities` Required to access the entities associated to risk score parameter\n\n- `read observables` Required to access the observables associated to risk score parameter\n\n- `read taxonomies` Required to access the taxonomies associated to risk score parameter\n\n","parameters":[{"description":"Risk Score Policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"description":"Parameter ID","in":"path","name":"parameter_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RiskScoreParameterValueAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RiskScoreParameterValueAPISchema"},"type":"array"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RiskScoreParameterValueAPISchema"},"type":"array"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create or update one or more parameter values.","tags":["Observable Risk Score"],"x-eiq-optional-permissions":{"read entities":"Required to access the entities associated to risk score parameter","read observables":"Required to access the observables associated to risk score parameter","read sources":"Required to access the sources associated to risk score parameter","read taxonomies":"Required to access the taxonomies associated to risk score parameter"},"x-eiq-permissions":["modify observable-risk-score-policy"]}},"/risk-score/policies/{policy_id}/parameters/{parameter_id}/values/{parameter_value_id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify observable-risk-score-policy`\n\n","parameters":[{"description":"Risk Score Policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"description":"Parameter ID","in":"path","name":"parameter_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"description":"Parameter Value ID","in":"path","name":"parameter_value_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a parameter value by ID.","tags":["Observable Risk Score"],"x-eiq-permissions":["modify observable-risk-score-policy"]},"get":{"description":"\n\n**Required permissions**\n\n- `read observable-risk-score-policy`\n\n\n\n**Optional permissions**\n\n- `read sources` Required to access the sources associated to risk score parameter\n\n- `read entities` Required to access the entities associated to risk score parameter\n\n- `read observables` Required to access the observables associated to risk score parameter\n\n- `read taxonomies` Required to access the taxonomies associated to risk score parameter\n\n","parameters":[{"description":"Risk Score Policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"description":"Parameter ID","in":"path","name":"parameter_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"description":"Parameter Value ID","in":"path","name":"parameter_value_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RiskScoreParameterValueAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a parameter value by ID.","tags":["Observable Risk Score"],"x-eiq-optional-permissions":{"read entities":"Required to access the entities associated to risk score parameter","read observables":"Required to access the observables associated to risk score parameter","read sources":"Required to access the sources associated to risk score parameter","read taxonomies":"Required to access the taxonomies associated to risk score parameter"},"x-eiq-permissions":["read observable-risk-score-policy"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify observable-risk-score-policy`\n\n\n\n**Optional permissions**\n\n- `read sources` Required to access the sources associated to risk score parameter\n\n- `read entities` Required to access the entities associated to risk score parameter\n\n- `read observables` Required to access the observables associated to risk score parameter\n\n- `read taxonomies` Required to access the taxonomies associated to risk score parameter\n\n","parameters":[{"description":"Risk Score Policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"description":"Parameter ID","in":"path","name":"parameter_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"description":"Parameter Value ID","in":"path","name":"parameter_value_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RiskScoreParameterValueAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RiskScoreParameterValueAPISchema"},"type":"array"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Edit a parameter value by ID.","tags":["Observable Risk Score"],"x-eiq-optional-permissions":{"read entities":"Required to access the entities associated to risk score parameter","read observables":"Required to access the observables associated to risk score parameter","read sources":"Required to access the sources associated to risk score parameter","read taxonomies":"Required to access the taxonomies associated to risk score parameter"},"x-eiq-permissions":["modify observable-risk-score-policy"]}},"/risk-score/policies/{policy_id}/score-previews":{"post":{"description":"\n\n**Required permissions**\n\n- `read observable-risk-score-policy`\n\n- `read extracts`\n\n","parameters":[{"description":"Risk Score Policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RiskScorePolicyPreviewByQueryAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RiskScorePolicyPreviewAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Preview a result of a risk score policy by ID run for a batch of up to 100 of extracts matching provided query.","tags":["Observable Risk Score"],"x-eiq-permissions":["read observable-risk-score-policy","read extracts"]}},"/roles":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify roles`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of roles referenced by IDs.","tags":["Roles"],"x-eiq-permissions":["modify roles"]},"get":{"description":"\n\n**Required permissions**\n\n- `read roles`\n\n\n\n**Optional permissions**\n\n- `read users` Required to get the list of users associated to a role\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by name","in":"query","name":"filter[name]","schema":{"type":"string"}},{"description":"Filter by description","in":"query","name":"filter[description]","schema":{"type":"string"}},{"description":"Filter by permissions","in":"query","name":"filter[permissions]","schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RoleAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Returns a list of roles on the platform.","tags":["Roles"],"x-eiq-optional-permissions":{"read users":"Required to get the list of users associated to a role"},"x-eiq-permissions":["read roles"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify roles`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RoleAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RoleAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a role.","tags":["Roles"],"x-eiq-permissions":["modify roles"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify roles`\n\n","parameters":[{"$ref":"#/components/parameters/AttributesParameter"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RoleAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RoleAPISchema"},"type":"array"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RoleAPISchema"},"type":"array"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create (or modify if the name already exists) one or more roles.","tags":["Roles"],"x-eiq-permissions":["modify roles"]}},"/roles/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify roles`\n\n","parameters":[{"description":"Role ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a role by ID.","tags":["Roles"],"x-eiq-permissions":["modify roles"]},"get":{"description":"\n\n**Required permissions**\n\n- `read roles`\n\n\n\n**Optional permissions**\n\n- `read users` Required to get the list of users associated to a role\n\n","parameters":[{"description":"Role ID","in":"path","name":"id","required":true,"schema":{"type":"number"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RoleAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a role by ID.","tags":["Roles"],"x-eiq-optional-permissions":{"read users":"Required to get the list of users associated to a role"},"x-eiq-permissions":["read roles"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify roles`\n\n","parameters":[{"description":"Role ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"If `?overwrite_permissions=false` and new `permissions`\nare provided, the resulting set of `permissions` will\ncontain both the previous and the new roles. Otherwise,\nthe list of roles will be overwritten by the new one\n(default: `true`).\n","in":"query","name":"overwrite_permissions","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RoleAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RoleAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Update a role.","tags":["Roles"],"x-eiq-permissions":["modify roles"]}},"/rules/discovery":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify intel-sets`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of discovery_rules referenced by IDs.","tags":["Discovery Rules"],"x-eiq-permissions":["modify intel-sets"]},"get":{"description":"\n\n**Required permissions**\n\n- `read rules`\n\n\n\n**Optional permissions**\n\n- `read tasks` Required to read the tasks attached to discovery rules\n\n- `read workspaces` Required to access the workspaces a discovery rule is attached to\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DiscoveryRuleAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of discovery rules.","tags":["Discovery Rules"],"x-eiq-optional-permissions":{"read tasks":"Required to read the tasks attached to discovery rules","read workspaces":"Required to access the workspaces a discovery rule is attached to"},"x-eiq-permissions":["read rules"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify rules`\n\n\n\n**Optional permissions**\n\n- `read tasks` Required to read the tasks attached to discovery rules\n\n- `read workspaces` Required to access the workspaces a discovery rule is attached to\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/DiscoveryRuleAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/DiscoveryRuleAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a new discovery rule.","tags":["Discovery Rules"],"x-eiq-optional-permissions":{"read tasks":"Required to read the tasks attached to discovery rules","read workspaces":"Required to access the workspaces a discovery rule is attached to"},"x-eiq-permissions":["modify rules"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify rules`\n\n\n\n**Optional permissions**\n\n- `read tasks` Required to read the tasks attached to discovery rules\n\n- `read workspaces` Required to access the workspaces a discovery rule is attached to\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DiscoveryRuleAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DiscoveryRuleAPISchema"},"type":"array"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DiscoveryRuleAPISchema"},"type":"array"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create (or update if the name already exists) one or more discovery rules.","tags":["Discovery Rules"],"x-eiq-optional-permissions":{"read tasks":"Required to read the tasks attached to discovery rules","read workspaces":"Required to access the workspaces a discovery rule is attached to"},"x-eiq-permissions":["modify rules"]}},"/rules/discovery/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify rules`\n\n","parameters":[{"description":"Discovery rule ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete an discovery rule by ID.","tags":["Discovery Rules"],"x-eiq-permissions":["modify rules"]},"get":{"description":"\n\n**Required permissions**\n\n- `read rules`\n\n\n\n**Optional permissions**\n\n- `read tasks` Required to read the tasks attached to discovery rules\n\n- `read workspaces` Required to access the workspaces a discovery rule is attached to\n\n","parameters":[{"description":"Discovery rule ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/DiscoveryRuleAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get an discovery rule by ID.","tags":["Discovery Rules"],"x-eiq-optional-permissions":{"read tasks":"Required to read the tasks attached to discovery rules","read workspaces":"Required to access the workspaces a discovery rule is attached to"},"x-eiq-permissions":["read rules"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify rules`\n\n\n\n**Optional permissions**\n\n- `read tasks` Required to read the tasks attached to discovery rules\n\n- `read workspaces` Required to access the workspaces a discovery rule is attached to\n\n","parameters":[{"description":"Discovery rule ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/DiscoveryRuleAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/DiscoveryRuleAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Edit an discovery rule by ID.","tags":["Discovery Rules"],"x-eiq-optional-permissions":{"read tasks":"Required to read the tasks attached to discovery rules","read workspaces":"Required to access the workspaces a discovery rule is attached to"},"x-eiq-permissions":["modify rules"]}},"/rules/enrichments":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify rules`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of enrichment rules referenced by IDs.","tags":["Enrichment Rules"],"x-eiq-permissions":["modify rules"]},"get":{"description":"\n\n**Required permissions**\n\n- `read rules`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EnrichmentRuleAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of enrichment rules.","tags":["Enrichment Rules"],"x-eiq-permissions":["read rules"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify rules`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EnrichmentRuleAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EnrichmentRuleAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a new enrichment rule.","tags":["Enrichment Rules"],"x-eiq-permissions":["modify rules"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify rules`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EnrichmentRuleAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EnrichmentRuleAPISchema"},"type":"array"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EnrichmentRuleAPISchema"},"type":"array"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create (or update if the name already exists) one or more enrichment rules.","tags":["Enrichment Rules"],"x-eiq-permissions":["modify rules"]}},"/rules/enrichments/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify rules`\n\n","parameters":[{"description":"Enrichment rule ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete an enrichment rule by ID.","tags":["Enrichment Rules"],"x-eiq-permissions":["modify rules"]},"get":{"description":"\n\n**Required permissions**\n\n- `read rules`\n\n","parameters":[{"description":"Enrichment rule ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EnrichmentRuleAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get an enrichment rule by ID.","tags":["Enrichment Rules"],"x-eiq-permissions":["read rules"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify rules`\n\n","parameters":[{"description":"Enrichment rule ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EnrichmentRuleAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EnrichmentRuleAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Edit an enrichment rule by ID.","tags":["Enrichment Rules"],"x-eiq-permissions":["modify rules"]}},"/rules/entities":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify rules`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of entity rules referenced by IDs.","tags":["Entity Rules"],"x-eiq-permissions":["modify rules"]},"get":{"description":"\n\n**Required permissions**\n\n- `read rules`\n\n\n\n**Optional permissions**\n\n- `read intel-sets` Required to access the datasets attached to entity rules\n\n- `read entities` Required to access the master entity attached to entity rules\n\n- `read tasks` Required to access the tasks attached to entity rules\n\n- `read taxonomies` Required to access the taxonomies attached to entity rules\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EntityRuleAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of entity rules.","tags":["Entity Rules"],"x-eiq-optional-permissions":{"read entities":"Required to access the master entity attached to entity rules","read intel-sets":"Required to access the datasets attached to entity rules","read tasks":"Required to access the tasks attached to entity rules","read taxonomies":"Required to access the taxonomies attached to entity rules"},"x-eiq-permissions":["read rules"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify rules`\n\n\n\n**Optional permissions**\n\n- `read intel-sets` Required to access the datasets attached to entity rules\n\n- `read entities` Required to access the master entity attached to entity rules\n\n- `read tasks` Required to access the tasks attached to entity rules\n\n- `read taxonomies` Required to access the taxonomies attached to entity rules\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntityRuleAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntityRuleAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a new entity rule.","tags":["Entity Rules"],"x-eiq-optional-permissions":{"read entities":"Required to access the master entity attached to entity rules","read intel-sets":"Required to access the datasets attached to entity rules","read tasks":"Required to access the tasks attached to entity rules","read taxonomies":"Required to access the taxonomies attached to entity rules"},"x-eiq-permissions":["modify rules"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify rules`\n\n\n\n**Optional permissions**\n\n- `read intel-sets` Required to access the datasets attached to entity rules\n\n- `read entities` Required to access the master entity attached to entity rules\n\n- `read tasks` Required to access the tasks attached to entity rules\n\n- `read taxonomies` Required to access the taxonomies attached to entity rules\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EntityRuleAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EntityRuleAPISchema"},"type":"array"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EntityRuleAPISchema"},"type":"array"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create (or update if the name already exists) one or more entity rules.","tags":["Entity Rules"],"x-eiq-optional-permissions":{"read entities":"Required to access the master entity attached to entity rules","read intel-sets":"Required to access the datasets attached to entity rules","read tasks":"Required to access the tasks attached to entity rules","read taxonomies":"Required to access the taxonomies attached to entity rules"},"x-eiq-permissions":["modify rules"]}},"/rules/entities/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify rules`\n\n","parameters":[{"description":"Entity rule ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete an entity rule by ID.","tags":["Entity Rules"],"x-eiq-permissions":["modify rules"]},"get":{"description":"\n\n**Required permissions**\n\n- `read rules`\n\n\n\n**Optional permissions**\n\n- `read intel-sets` Required to access the datasets attached to entity rules\n\n- `read entities` Required to access the master entity attached to entity rules\n\n- `read tasks` Required to access the tasks attached to entity rules\n\n- `read taxonomies` Required to access the taxonomies attached to entity rules\n\n","parameters":[{"description":"Entity rule ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntityRuleAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get an entity rule by ID.","tags":["Entity Rules"],"x-eiq-optional-permissions":{"read entities":"Required to access the master entity attached to entity rules","read intel-sets":"Required to access the datasets attached to entity rules","read tasks":"Required to access the tasks attached to entity rules","read taxonomies":"Required to access the taxonomies attached to entity rules"},"x-eiq-permissions":["read rules"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify rules`\n\n\n\n**Optional permissions**\n\n- `read intel-sets` Required to access the datasets attached to entity rules\n\n- `read entities` Required to access the master entity attached to entity rules\n\n- `read tasks` Required to access the tasks attached to entity rules\n\n- `read taxonomies` Required to access the taxonomies attached to entity rules\n\n","parameters":[{"description":"Entity rule ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"description":"If `?overwrite_tags=false` and new `tags` are provided,\nthe resulting set of `tags` will contain both the\nprevious and the new tags. Otherwise, the list of tags\nwill be overwritten by the new one (default: `true`).\n","in":"query","name":"overwrite_tags","schema":{"type":"boolean"}},{"description":"If `?overwrite_taxonomies=false` and new `taxonomies`\nare provided, the resulting set of `taxonomies` will\ncontain both the previous and the new taxonomies.\nOtherwise, the list of taxonomies will be overwritten by\nthe new one (default: `true`).\n","in":"query","name":"overwrite_taxonomies","schema":{"type":"boolean"}},{"description":"If `?overwrite_datasets=false` and new `datasets` are\nprovided, the resulting set of `datasets` will contain\nboth the previous and the new datasets. Otherwise, the\nlist of datasets will be overwritten by the new one\n(default: `true`).\n","in":"query","name":"overwrite_datasets","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntityRuleAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EntityRuleAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Edit an entity rule by ID.","tags":["Entity Rules"],"x-eiq-optional-permissions":{"read entities":"Required to access the master entity attached to entity rules","read intel-sets":"Required to access the datasets attached to entity rules","read tasks":"Required to access the tasks attached to entity rules","read taxonomies":"Required to access the taxonomies attached to entity rules"},"x-eiq-permissions":["modify rules"]}},"/rules/intel-requirements":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify intel-requirements`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of intelligence requirements referenced by IDs.","tags":["Intelligence Requirements"],"x-eiq-permissions":["modify intel-requirements"]},"get":{"description":"\n\n**Required permissions**\n\n- `read intel-requirements`\n\n\n\n**Optional permissions**\n\n- `read intel-sets` Required to access the datasets attached to intelligence requirements\n\n- `read users` Required to access the users attached to intelligence requirements\n\n- `read sources` Required to access sources attached to intelligence requirements\n\n- `read tasks` Required to access the tasks attached to intelligence requirements\n\n- `read taxonomies` Required to access the taxonomies attached to intelligence requirements\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IntelRequirementAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of intelligence requirements.","tags":["Intelligence Requirements"],"x-eiq-optional-permissions":{"read intel-sets":"Required to access the datasets attached to intelligence requirements","read sources":"Required to access sources attached to intelligence requirements","read tasks":"Required to access the tasks attached to intelligence requirements","read taxonomies":"Required to access the taxonomies attached to intelligence requirements","read users":"Required to access the users attached to intelligence requirements"},"x-eiq-permissions":["read intel-requirements"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify intel-requirements`\n\n\n\n**Optional permissions**\n\n- `read intel-sets` Required to access the datasets attached to intelligence requirements\n\n- `read users` Required to access the users attached to intelligence requirements\n\n- `read sources` Required to access sources attached to intelligence requirements\n\n- `read tasks` Required to access the tasks attached to intelligence requirements\n\n- `read taxonomies` Required to access the taxonomies attached to intelligence requirements\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/IntelRequirementAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/IntelRequirementAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a new intelligence requirement.","tags":["Intelligence Requirements"],"x-eiq-optional-permissions":{"read intel-sets":"Required to access the datasets attached to intelligence requirements","read sources":"Required to access sources attached to intelligence requirements","read tasks":"Required to access the tasks attached to intelligence requirements","read taxonomies":"Required to access the taxonomies attached to intelligence requirements","read users":"Required to access the users attached to intelligence requirements"},"x-eiq-permissions":["modify intel-requirements"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify intel-requirements`\n\n\n\n**Optional permissions**\n\n- `read intel-sets` Required to access the datasets attached to intelligence requirements\n\n- `read users` Required to access the users attached to intelligence requirements\n\n- `read sources` Required to access sources attached to intelligence requirements\n\n- `read tasks` Required to access the tasks attached to intelligence requirements\n\n- `read taxonomies` Required to access the taxonomies attached to intelligence requirements\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IntelRequirementAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IntelRequirementAPISchema"},"type":"array"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IntelRequirementAPISchema"},"type":"array"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create (or update if the name already exists) one or more intelligence requirements.","tags":["Intelligence Requirements"],"x-eiq-optional-permissions":{"read intel-sets":"Required to access the datasets attached to intelligence requirements","read sources":"Required to access sources attached to intelligence requirements","read tasks":"Required to access the tasks attached to intelligence requirements","read taxonomies":"Required to access the taxonomies attached to intelligence requirements","read users":"Required to access the users attached to intelligence requirements"},"x-eiq-permissions":["modify intel-requirements"]}},"/rules/intel-requirements/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify intel-requirements`\n\n","parameters":[{"description":"intelligence requirement ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete an intelligence requirement by ID.","tags":["Intelligence Requirements"],"x-eiq-permissions":["modify intel-requirements"]},"get":{"description":"\n\n**Required permissions**\n\n- `read intel-requirements`\n\n\n\n**Optional permissions**\n\n- `read intel-sets` Required to access the datasets attached to intelligence requirements\n\n- `read users` Required to access the users attached to intelligence requirements\n\n- `read sources` Required to access sources attached to intelligence requirements\n\n- `read tasks` Required to access the tasks attached to intelligence requirements\n\n- `read taxonomies` Required to access the taxonomies attached to intelligence requirements\n\n","parameters":[{"description":"intelligence requirement ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/IntelRequirementAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get an intelligence requirement by ID.","tags":["Intelligence Requirements"],"x-eiq-optional-permissions":{"read intel-sets":"Required to access the datasets attached to intelligence requirements","read sources":"Required to access sources attached to intelligence requirements","read tasks":"Required to access the tasks attached to intelligence requirements","read taxonomies":"Required to access the taxonomies attached to intelligence requirements","read users":"Required to access the users attached to intelligence requirements"},"x-eiq-permissions":["read intel-requirements"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify intel-requirements`\n\n\n\n**Optional permissions**\n\n- `read intel-sets` Required to access the datasets attached to intelligence requirements\n\n- `read users` Required to access the users attached to intelligence requirements\n\n- `read sources` Required to access sources attached to intelligence requirements\n\n- `read tasks` Required to access the tasks attached to intelligence requirements\n\n- `read taxonomies` Required to access the taxonomies attached to intelligence requirements\n\n","parameters":[{"description":"Intelligence requirement ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/IntelRequirementAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/IntelRequirementAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Edit an Intelligence requirement by ID.","tags":["Intelligence Requirements"],"x-eiq-optional-permissions":{"read intel-sets":"Required to access the datasets attached to intelligence requirements","read sources":"Required to access sources attached to intelligence requirements","read tasks":"Required to access the tasks attached to intelligence requirements","read taxonomies":"Required to access the taxonomies attached to intelligence requirements","read users":"Required to access the users attached to intelligence requirements"},"x-eiq-permissions":["modify intel-requirements"]}},"/rules/observables":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify rules`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of observable rules referenced by IDs.","tags":["Observable Rules"],"x-eiq-permissions":["modify rules"]},"get":{"description":"\n\n**Required permissions**\n\n- `read rules`\n\n\n\n**Optional permissions**\n\n- `read tasks` Required to access the tasks associated to observable rules\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ObservableRuleAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of observable rules.","tags":["Observable Rules"],"x-eiq-optional-permissions":{"read tasks":"Required to access the tasks associated to observable rules"},"x-eiq-permissions":["read rules"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify rules`\n\n\n\n**Optional permissions**\n\n- `read tasks` Required to access the tasks associated to observable rules\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ObservableRuleAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ObservableRuleAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a new observable rule.","tags":["Observable Rules"],"x-eiq-optional-permissions":{"read tasks":"Required to access the tasks associated to observable rules"},"x-eiq-permissions":["modify rules"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify rules`\n\n\n\n**Optional permissions**\n\n- `read tasks` Required to access the tasks associated to observable rules\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ObservableRuleAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ObservableRuleAPISchema"},"type":"array"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ObservableRuleAPISchema"},"type":"array"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create (or update if the name already exists) one or more observable rules.","tags":["Observable Rules"],"x-eiq-optional-permissions":{"read tasks":"Required to access the tasks associated to observable rules"},"x-eiq-permissions":["modify rules"]}},"/rules/observables/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify rules`\n\n\n\n**Optional permissions**\n\n- `read tasks` Required to access the tasks associated to observable rules\n\n","parameters":[{"description":"Observable rule ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete an observable rule by ID.","tags":["Observable Rules"],"x-eiq-optional-permissions":{"read tasks":"Required to access the tasks associated to observable rules"},"x-eiq-permissions":["modify rules"]},"get":{"description":"\n\n**Required permissions**\n\n- `read rules`\n\n\n\n**Optional permissions**\n\n- `read tasks` Required to access the tasks associated to observable rules\n\n","parameters":[{"description":"Observable rule ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ObservableRuleAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get an observable rule by ID.","tags":["Observable Rules"],"x-eiq-optional-permissions":{"read tasks":"Required to access the tasks associated to observable rules"},"x-eiq-permissions":["read rules"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify rules`\n\n\n\n**Optional permissions**\n\n- `read tasks` Required to access the tasks associated to observable rules\n\n","parameters":[{"description":"Observable rule ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ObservableRuleAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ObservableRuleAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Edit an observable rule by ID.","tags":["Observable Rules"],"x-eiq-optional-permissions":{"read tasks":"Required to access the tasks associated to observable rules"},"x-eiq-permissions":["modify rules"]}},"/rules/property-propagations":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify property-propagations`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of Property Propagations referenced by IDs.","tags":["Property Propagations"],"x-eiq-permissions":["modify property-propagations"]},"get":{"description":"\n\n**Required permissions**\n\n- `read property-propagations`\n\n\n\n**Optional permissions**\n\n- `read sources` Required to access sources attached to property propagations\n\n- `read tasks` Required to access the tasks attached to property propagations\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PropertyPropagationAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of property propagations.","tags":["Property Propagations"],"x-eiq-optional-permissions":{"read sources":"Required to access sources attached to property propagations","read tasks":"Required to access the tasks attached to property propagations"},"x-eiq-permissions":["read property-propagations"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify property-propagations`\n\n\n\n**Optional permissions**\n\n- `read sources` Required to access sources attached to property propagations\n\n- `read tasks` Required to access the tasks attached to property propagations\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/PropertyPropagationAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/PropertyPropagationAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a new property propagation.","tags":["Property Propagations"],"x-eiq-optional-permissions":{"read sources":"Required to access sources attached to property propagations","read tasks":"Required to access the tasks attached to property propagations"},"x-eiq-permissions":["modify property-propagations"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify property-propagations`\n\n\n\n**Optional permissions**\n\n- `read sources` Required to access sources attached to property propagations\n\n- `read tasks` Required to access the tasks attached to property propagations\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PropertyPropagationAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PropertyPropagationAPISchema"},"type":"array"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PropertyPropagationAPISchema"},"type":"array"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create (or update if the name already exists) one or more Property Propagations.","tags":["Property Propagations"],"x-eiq-optional-permissions":{"read sources":"Required to access sources attached to property propagations","read tasks":"Required to access the tasks attached to property propagations"},"x-eiq-permissions":["modify property-propagations"]}},"/rules/property-propagations/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify property-propagations`\n\n","parameters":[{"description":"property propagation ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete an property propagation by ID.","tags":["Property Propagations"],"x-eiq-permissions":["modify property-propagations"]},"get":{"description":"\n\n**Required permissions**\n\n- `read property-propagations`\n\n\n\n**Optional permissions**\n\n- `read sources` Required to access sources attached to property propagations\n\n- `read tasks` Required to access the tasks attached to property propagations\n\n","parameters":[{"description":"property propagation ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/PropertyPropagationAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get an property propagation by ID.","tags":["Property Propagations"],"x-eiq-optional-permissions":{"read sources":"Required to access sources attached to property propagations","read tasks":"Required to access the tasks attached to property propagations"},"x-eiq-permissions":["read property-propagations"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify property-propagations`\n\n\n\n**Optional permissions**\n\n- `read sources` Required to access sources attached to property propagations\n\n- `read tasks` Required to access the tasks attached to property propagations\n\n","parameters":[{"description":"property propagation ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/PropertyPropagationAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/PropertyPropagationAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Edit an property propagation by ID.","tags":["Property Propagations"],"x-eiq-optional-permissions":{"read sources":"Required to access sources attached to property propagations","read tasks":"Required to access the tasks attached to property propagations"},"x-eiq-permissions":["modify property-propagations"]}},"/sandbox-detonations":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify detonations`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of Sandbox Detonations referenced by IDs","tags":["Malware Sandbox"],"x-eiq-permissions":["modify detonations"]},"get":{"description":"\n\n**Required permissions**\n\n- `read detonations`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter Sandbox detonations by verdict","in":"query","name":"filter[verdict]","schema":{"type":"string"}},{"description":"Filter Sandbox detonations by status","in":"query","name":"filter[status]","schema":{"type":"string"}},{"description":"Filter Sandbox detonations by scan type","in":"query","name":"filter[scan_type]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SandboxDetonationSchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of Sandbox Detonations","tags":["Malware Sandbox"],"x-eiq-permissions":["read detonations"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify detonations`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/SandboxDetonationSchema"}},"required":["data"],"type":"object"}},"multipart/form-data":{"encoding":{"data":{"contentType":"application/json"}},"schema":{"properties":{"data":{"$ref":"#/components/schemas/SandboxDetonationSchema"},"file":{"description":"File to be analyzed in sandbox","format":"binary","type":"string"}},"required":["file","data"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SandboxDetonationSchema"}}},"description":"Detonation created successfully"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create Sandbox Detonation","tags":["Malware Sandbox"],"x-eiq-permissions":["modify detonations"]}},"/sandbox-detonations/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify detonations`\n\n","parameters":[{"description":"Sandbox detonation ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"responses":{"204":{"description":"Deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a Sandbox Detonations","tags":["Malware Sandbox"],"x-eiq-permissions":["modify detonations"]},"get":{"description":"\n\n**Required permissions**\n\n- `read detonations`\n\n","parameters":[{"description":"Sandbox Detonation ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/SandboxDetonationSchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a Sandbox Detonation details by an ID","tags":["Malware Sandbox"],"x-eiq-permissions":["read detonations"]}},"/sandbox-detonations/{id}/result":{"get":{"description":"\n\n**Required permissions**\n\n- `read detonations`\n\n","parameters":[{"description":"Sandbox Detonation ID","in":"path","name":"id","required":true,"schema":{"type":"number"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/SandboxResultSchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get the Detonation Result by sandbox detonation ID","tags":["Malware Sandbox"],"x-eiq-permissions":["read detonations"]}},"/sources":{"get":{"description":"\n\n**Required permissions**\n\n- `read sources`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SourceAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of all sources.","tags":["Sources"],"x-eiq-permissions":["read sources"]}},"/sources/{id}":{"get":{"description":"\n\n**Required permissions**\n\n- `read sources`\n\n","parameters":[{"description":"Source ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/SourceAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get an source by ID.","tags":["Sources"],"x-eiq-permissions":["read sources"]}},"/tasks":{"get":{"description":"\n\n**Required permissions**\n\n- `read tasks`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by task name","in":"query","name":"filter[name]","schema":{"type":"string"}},{"description":"Filter by task type","in":"query","name":"filter[type]","schema":{"type":"string"}},{"description":"Filter by active state","in":"query","name":"filter[is_active]","schema":{"type":"boolean"}},{"description":"Filter by related object","in":"query","name":"filter[related_object]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TaskAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of tasks.","tags":["Tasks"],"x-eiq-permissions":["read tasks"]}},"/tasks/runs":{"get":{"description":"\n\n**Required permissions**\n\n- `read tasks`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by task ID","in":"query","name":"filter[task]","schema":{"type":"string"}},{"description":"Filter by task run status","in":"query","name":"filter[status]","schema":{"type":"string"}},{"description":"Filter by triggering user ID/URL","in":"query","name":"filter[triggered_by]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TaskRunAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of task runs.","tags":["Tasks"],"x-eiq-permissions":["read tasks"]},"post":{"description":"\n\n**Optional permissions**\n\n- `modify tasks` Users with modify tasks permissions can modify any task\n\n- `modify incoming-feeds` Required to modify, run or stop tasks linked to incoming feeds\n\n- `modify outgoing-feeds` Required to modify, run or stop tasks linked to outgoing feeds\n\n- `modify retention-policies` Required to modify, run or stop tasks linked to retention policies\n\n- `modify discovery-rules` Required to modify, run or stop tasks linked to discovery rules\n\n- `modify enrichments` Required to modify, run or stop tasks linked to enrichers\n\n- `modify rules` Required to modify, run or stop tasks linked to entity or observable rules\n\n- `read users` Required to read the user that triggered a task\n\n","parameters":[{"description":"Force the task to run even if the task is already\nrunning (default: `false`).\n","in":"query","name":"force","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaskRunAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaskRunAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Run a task.","tags":["Tasks"],"x-eiq-optional-permissions":{"modify discovery-rules":"Required to modify, run or stop tasks linked to discovery rules","modify enrichments":"Required to modify, run or stop tasks linked to enrichers","modify incoming-feeds":"Required to modify, run or stop tasks linked to incoming feeds","modify outgoing-feeds":"Required to modify, run or stop tasks linked to outgoing feeds","modify retention-policies":"Required to modify, run or stop tasks linked to retention policies","modify rules":"Required to modify, run or stop tasks linked to entity or observable rules","modify tasks":"Users with modify tasks permissions can modify any task","read users":"Required to read the user that triggered a task"}}},"/tasks/runs/groups/{id}":{"get":{"description":"\n\n**Optional permissions**\n\n- `read tasks` Users with read tasks permissions can read any task\n\n- `read incoming-feeds` Required to read tasks linked to incoming feeds\n\n- `read outgoing-feeds` Required to read tasks linked to outgoing feeds\n\n- `read retention-policies` Required to read tasks linked to retention policies\n\n- `read discovery-rules` Required to read tasks linked to discovery rules\n\n- `read enrichments` Required to read tasks linked to enrichers\n\n- `read rules` Required to read tasks linked to entity or observable rules\n\n- `read users` Required to read the user that triggered a task\n\n","parameters":[{"description":"Task group ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaskRunGroupAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a task run group by ID.","tags":["Tasks"],"x-eiq-optional-permissions":{"read discovery-rules":"Required to read tasks linked to discovery rules","read enrichments":"Required to read tasks linked to enrichers","read incoming-feeds":"Required to read tasks linked to incoming feeds","read outgoing-feeds":"Required to read tasks linked to outgoing feeds","read retention-policies":"Required to read tasks linked to retention policies","read rules":"Required to read tasks linked to entity or observable rules","read tasks":"Users with read tasks permissions can read any task","read users":"Required to read the user that triggered a task"}}},"/tasks/runs/{id}":{"delete":{"description":"\n\n**Optional permissions**\n\n- `modify tasks` Users with modify tasks permissions can modify any task\n\n- `modify incoming-feeds` Required to modify, run or stop tasks linked to incoming feeds\n\n- `modify outgoing-feeds` Required to modify, run or stop tasks linked to outgoing feeds\n\n- `modify retention-policies` Required to modify, run or stop tasks linked to retention policies\n\n- `modify discovery-rules` Required to modify, run or stop tasks linked to discovery rules\n\n- `modify enrichments` Required to modify, run or stop tasks linked to enrichers\n\n- `modify rules` Required to modify, run or stop tasks linked to entity or observable rules\n\n- `read users` Required to read the user that triggered a task\n\n","parameters":[{"description":"Task run ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The task has been successfully stopped"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Stop a task execution by task run ID.","tags":["Tasks"],"x-eiq-optional-permissions":{"modify discovery-rules":"Required to modify, run or stop tasks linked to discovery rules","modify enrichments":"Required to modify, run or stop tasks linked to enrichers","modify incoming-feeds":"Required to modify, run or stop tasks linked to incoming feeds","modify outgoing-feeds":"Required to modify, run or stop tasks linked to outgoing feeds","modify retention-policies":"Required to modify, run or stop tasks linked to retention policies","modify rules":"Required to modify, run or stop tasks linked to entity or observable rules","modify tasks":"Users with modify tasks permissions can modify any task","read users":"Required to read the user that triggered a task"}},"get":{"description":"\n\n**Optional permissions**\n\n- `read tasks` Users with read tasks permissions can read any task\n\n- `read incoming-feeds` Required to read tasks linked to incoming feeds\n\n- `read outgoing-feeds` Required to read tasks linked to outgoing feeds\n\n- `read retention-policies` Required to read tasks linked to retention policies\n\n- `read discovery-rules` Required to read tasks linked to discovery rules\n\n- `read enrichments` Required to read tasks linked to enrichers\n\n- `read rules` Required to read tasks linked to entity or observable rules\n\n- `read users` Required to read the user that triggered a task\n\n","parameters":[{"description":"Task run ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaskRunAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a task run by ID.","tags":["Tasks"],"x-eiq-optional-permissions":{"read discovery-rules":"Required to read tasks linked to discovery rules","read enrichments":"Required to read tasks linked to enrichers","read incoming-feeds":"Required to read tasks linked to incoming feeds","read outgoing-feeds":"Required to read tasks linked to outgoing feeds","read retention-policies":"Required to read tasks linked to retention policies","read rules":"Required to read tasks linked to entity or observable rules","read tasks":"Users with read tasks permissions can read any task","read users":"Required to read the user that triggered a task"}}},"/tasks/{id}":{"get":{"description":"\n\n**Optional permissions**\n\n- `read tasks` Users with read tasks permissions can read any task\n\n- `read incoming-feeds` Required to read tasks linked to incoming feeds\n\n- `read outgoing-feeds` Required to read tasks linked to outgoing feeds\n\n- `read retention-policies` Required to read tasks linked to retention policies\n\n- `read discovery-rules` Required to read tasks linked to discovery rules\n\n- `read enrichments` Required to read tasks linked to enrichers\n\n- `read rules` Required to read tasks linked to entity or observable rules\n\n- `read users` Required to read the user that triggered a task\n\n","parameters":[{"description":"Task ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaskAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a task by ID.","tags":["Tasks"],"x-eiq-optional-permissions":{"read discovery-rules":"Required to read tasks linked to discovery rules","read enrichments":"Required to read tasks linked to enrichers","read incoming-feeds":"Required to read tasks linked to incoming feeds","read outgoing-feeds":"Required to read tasks linked to outgoing feeds","read retention-policies":"Required to read tasks linked to retention policies","read rules":"Required to read tasks linked to entity or observable rules","read tasks":"Users with read tasks permissions can read any task","read users":"Required to read the user that triggered a task"}},"patch":{"description":"\n\n**Optional permissions**\n\n- `modify tasks` Users with modify tasks permissions can modify any task\n\n- `modify incoming-feeds` Required to modify, run or stop tasks linked to incoming feeds\n\n- `modify outgoing-feeds` Required to modify, run or stop tasks linked to outgoing feeds\n\n- `modify retention-policies` Required to modify, run or stop tasks linked to retention policies\n\n- `modify discovery-rules` Required to modify, run or stop tasks linked to discovery rules\n\n- `modify enrichments` Required to modify, run or stop tasks linked to enrichers\n\n- `modify rules` Required to modify, run or stop tasks linked to entity or observable rules\n\n- `read users` Required to read the user that triggered a task\n\n","parameters":[{"description":"Task ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaskAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaskAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Edit a task by ID.","tags":["Tasks"],"x-eiq-optional-permissions":{"modify discovery-rules":"Required to modify, run or stop tasks linked to discovery rules","modify enrichments":"Required to modify, run or stop tasks linked to enrichers","modify incoming-feeds":"Required to modify, run or stop tasks linked to incoming feeds","modify outgoing-feeds":"Required to modify, run or stop tasks linked to outgoing feeds","modify retention-policies":"Required to modify, run or stop tasks linked to retention policies","modify rules":"Required to modify, run or stop tasks linked to entity or observable rules","modify tasks":"Users with modify tasks permissions can modify any task","read users":"Required to read the user that triggered a task"}}},"/taxonomies":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify taxonomies`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of taxonomies nodes referenced by IDs.","tags":["Taxonomies"],"x-eiq-permissions":["modify taxonomies"]},"get":{"description":"\n\n**Required permissions**\n\n- `read taxonomies`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter taxonomies by name.","in":"query","name":"filter[name]","schema":{"type":"string"}},{"description":"Filter taxonomies by description.","in":"query","name":"filter[description]","schema":{"type":"string"}},{"description":"Filter taxonomies by `code`. Only for retrieving\nAdmiralty Code taxonomy nodes.<br/><br/> For example:\n`filter[code]='A'` retrieves the 'Admiralty Code -\nCompletely reliable' taxonomy node. `code` is case-\nsensitive.\n","in":"query","name":"filter[code]","schema":{"type":"string"}},{"description":"Filter system-defined taxonomies","in":"query","name":"filter[is_system_defined]","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TaxonomyNodeAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of taxonomies.","tags":["Taxonomies"],"x-eiq-permissions":["read taxonomies"]},"post":{"description":"Same as `PUT` for taxonomies endpoint. POST for taxonomies is also idempotent.\n\n**Required permissions**\n\n- `modify taxonomies`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TaxonomyNodeAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TaxonomyNodeAPISchema","description":"Success, with no change. All specified taxonomy nodes already exist."},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TaxonomyNodeAPISchema","description":"Success. One or more taxonomy nodes are created."},"type":"array"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create taxonomy nodes by specifying a single node or a node path.","tags":["Taxonomies"],"x-eiq-permissions":["modify taxonomies"]},"put":{"description":"The taxonomy endpoint allows you to create:\n\n<ul>\n<li>a single taxonomy node, or</li>\n<li>all taxonomy nodes in a taxonomy node path.</li>\n</ul>\n\nCreate a single taxonomy node by sending as a request payload:\n\n<ul>\n<li>The taxonomy node name as a string. E.g., `\"this is a name\"`.</li>\n<li>A `TaxonomyNodeAPISchema` object.</li>\n</ul>\n\n<br/>\n<blockquote>\n<strong>Taxonomy node names:</strong>\nTaxonomy node names must be unique for their parents.\n</blockquote>\n<br/>\n\nCreate all the nodes along a taxonomy node\npath by sending a list of taxonomy nodes\nin these formats:\n\n<ul>\n<li>A list of taxonomy node names.\nThe first string in the list must be the name of a root node.\n<br/>\nFor example: <pre>[\"root node name\", \"parent node name\", \"child node name\"]</pre>\n</li>\n<li>A list of taxonomy node URLs.\nTo refer to a node by URL, it must already exist.\n<br/>\nFor example: <pre>[\n  \"https://<platform_host>/api/<version>/taxonomies/4\",\n  \"https://<platform_host>/api/<version>/taxonomies/9\"\n]</pre>\n</li>\n<li>A list of taxonomy node IDs.\nTo refer to a node by ID, it must already exist.\n<br/>\nFor example: <pre>[4, 9]</pre>\n</li>\n<li>A list of `TaxonomyNodeAPISchema` objects.\nIf you specify an ID for a node,\nit must already exist.\n<br/>\nFor example: <pre>[\n  {\n    \"id\": 4,\n    \"name\": \"a parent node name\",\n    \"description\": \"a description\"\n  },\n  {\n    \"id\": 9,\n    \"name\": \"a child node name\",\n    \"description\": \"a description\"\n  }\n]</pre>\n</li>\n<li>A mix of types.\n<br/>\nFor example: <pre>[\n  4,\n  \"https://<platform_host>/api/<version>/taxonomies/9\",\n  {\n    \"name\": \"a child node name\",\n    \"description\": \"a description\"\n  }\n]</pre>\n</li>\n</ul>\n\nWhen sending a list of taxonomy nodes,\nthe **first item in the list** must be one of these:\n\n<ul>\n<li>\n<strong>A root node:</strong>\nA root node is a top-level taxonomy node that has no parent nodes.\n</li>\n<li>\n<strong>An existing parent node:</strong>\nYou must specify an existing parent node\nby ID, URL, or as a `TaxonomyNodeAPISchema` object\nwith a specific `\"id\"`.\n</li>\n</ul>\n\n**Required permissions**\n\n- `modify taxonomies`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TaxonomyNodeAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TaxonomyNodeAPISchema","description":"Success, with no change. All specified taxonomy nodes already exist."},"type":"array"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TaxonomyNodeAPISchema","description":"Success. One or more taxonomy nodes are created."},"type":"array"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create taxonomy nodes by specifying a single node or a node path.","tags":["Taxonomies"],"x-eiq-permissions":["modify taxonomies"]}},"/taxonomies/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify taxonomies`\n\n","parameters":[{"description":"Taxonomy node ID","in":"path","name":"id","required":true,"schema":{"type":"number"}},{"description":"By default the request fails with a `417: Expectation\nFailed` error if the node has at least one child node.\nSet this flag to `true` if you want to delete the node\nand recursively deleted any derived nodes.\n","in":"query","name":"recursive","schema":{"type":"boolean"}}],"responses":{"204":{"description":"Deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"417":{"$ref":"#/components/responses/ExpectationFailed"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a taxonomy node or a sub-tree.","tags":["Taxonomies"],"x-eiq-permissions":["modify taxonomies"]},"get":{"description":"\n\n**Required permissions**\n\n- `read taxonomies`\n\n","parameters":[{"description":"Taxonomy node ID","in":"path","name":"id","required":true,"schema":{"type":"number"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaxonomyNodeAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a taxonomy node by ID.","tags":["Taxonomies"],"x-eiq-permissions":["read taxonomies"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify taxonomies`\n\n","parameters":[{"description":"Taxonomy node ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaxonomyNodeAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaxonomyNodeAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Update a taxonomy node.","tags":["Taxonomies"],"x-eiq-permissions":["modify taxonomies"]}},"/tickets":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify tickets`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of tickets referenced by IDs.","tags":["Tickets"],"x-eiq-permissions":["modify tickets"]},"get":{"description":"\n\n**Required permissions**\n\n- `read tickets`\n\n\n\n**Optional permissions**\n\n- `read ticket-comments` To access the comments associated to a ticket\n\n- `read entities` To access the entities attached to a ticket\n\n- `read users` To access the users associated to a ticket\n\n- `read workspaces` To access the workspaces a ticket is attached to\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"description":"Filter by ticket name","in":"query","name":"filter[name]","schema":{"type":"string"}},{"description":"Filter by ticket description","in":"query","name":"filter[description]","schema":{"type":"string"}},{"description":"Filter by ticket status","in":"query","name":"filter[status]","schema":{"type":"string"}},{"description":"Filter by entity IDs","in":"query","name":"filter[entities]","schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TicketAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of all tickets.","tags":["Tickets"],"x-eiq-optional-permissions":{"read entities":"To access the entities attached to a ticket","read ticket-comments":"To access the comments associated to a ticket","read users":"To access the users associated to a ticket","read workspaces":"To access the workspaces a ticket is attached to"},"x-eiq-permissions":["read tickets"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify tickets`\n\n\n\n**Optional permissions**\n\n- `read ticket-comments` To access the comments associated to a ticket\n\n- `read entities` To access the entities attached to a ticket\n\n- `read users` To access the users associated to a ticket\n\n- `read workspaces` To access the workspaces a ticket is attached to\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TicketAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TicketAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a ticket.","tags":["Tickets"],"x-eiq-optional-permissions":{"read entities":"To access the entities attached to a ticket","read ticket-comments":"To access the comments associated to a ticket","read users":"To access the users associated to a ticket","read workspaces":"To access the workspaces a ticket is attached to"},"x-eiq-permissions":["modify tickets"]}},"/tickets/comments/{id}":{"get":{"description":"\n\n**Required permissions**\n\n- `read ticket-comments`\n\n\n\n**Optional permissions**\n\n- `read tickets` To access the tickets a comment is associated to\n\n- `read users` To access the users associated to a ticket comment\n\n","parameters":[{"description":"Ticket Comment ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TicketCommentAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a ticket comment by ID.","tags":["Ticket Comments"],"x-eiq-optional-permissions":{"read tickets":"To access the tickets a comment is associated to","read users":"To access the users associated to a ticket comment"},"x-eiq-permissions":["read ticket-comments"]}},"/tickets/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify tickets`\n\n","parameters":[{"description":"Ticket ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a ticket by ID.","tags":["Tickets"],"x-eiq-permissions":["modify tickets"]},"get":{"description":"\n\n**Required permissions**\n\n- `read tickets`\n\n\n\n**Optional permissions**\n\n- `read ticket-comments` To access the comments associated to a ticket\n\n- `read entities` To access the entities attached to a ticket\n\n- `read users` To access the users associated to a ticket\n\n- `read workspaces` To access the workspaces a ticket is attached to\n\n","parameters":[{"description":"Ticket ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TicketAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a ticket by ID.","tags":["Tickets"],"x-eiq-optional-permissions":{"read entities":"To access the entities attached to a ticket","read ticket-comments":"To access the comments associated to a ticket","read users":"To access the users associated to a ticket","read workspaces":"To access the workspaces a ticket is attached to"},"x-eiq-permissions":["read tickets"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify tickets`\n\n\n\n**Optional permissions**\n\n- `read ticket-comments` To access the comments associated to a ticket\n\n- `read entities` To access the entities attached to a ticket\n\n- `read users` To access the users associated to a ticket\n\n- `read workspaces` To access the workspaces a ticket is attached to\n\n","parameters":[{"description":"Ticket ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"If `?overwrite_entities=false` and new `entities` are\nprovided, the resulting set of `entities` will contain\nboth the previous and the new entities. Otherwise, the\nlist of entities will be overwritten by the new one\n(default: `true`).\n","in":"query","name":"overwrite_entities","schema":{"type":"boolean"}},{"description":"If `?overwrite_stakeholders=false` and new\n`stakeholders` are provided, the resulting set of\n`stakeholders` will contain both the previous and the\nnew stakeholders. Otherwise, the list of stakeholders\nwill be overwritten by the new one (default: `true`).\n","in":"query","name":"overwrite_stakeholders","schema":{"type":"boolean"}},{"description":"If `?overwrite_workspaces=false` and new `workspaces`\nare provided, the resulting set of `workspaces` will\ncontain both the previous and the new workspaces.\nOtherwise, the list of workspaces will be overwritten by\nthe new one (default: `true`).\n","in":"query","name":"overwrite_workspaces","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TicketAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TicketAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Update a ticket by ID.","tags":["Tickets"],"x-eiq-optional-permissions":{"read entities":"To access the entities attached to a ticket","read ticket-comments":"To access the comments associated to a ticket","read users":"To access the users associated to a ticket","read workspaces":"To access the workspaces a ticket is attached to"},"x-eiq-permissions":["modify tickets"]}},"/tickets/{id}/comments":{"post":{"description":"\n\n**Required permissions**\n\n- `modify ticket-comments`\n\n\n\n**Optional permissions**\n\n- `read tickets` To access the tickets a comment is associated to\n\n- `read users` To access the users associated to a ticket comment\n\n","parameters":[{"description":"Ticket ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TicketCommentAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TicketCommentAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a comment on a ticket.","tags":["Ticket Comments"],"x-eiq-optional-permissions":{"read tickets":"To access the tickets a comment is associated to","read users":"To access the users associated to a ticket comment"},"x-eiq-permissions":["modify ticket-comments"]}},"/uploaded-blobs":{"get":{"description":"\n\n**Required permissions**\n\n- `read blob-uploads`\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by filename","in":"query","name":"filter[filename]","schema":{"type":"string"}},{"description":"Filter by content type","in":"query","name":"filter[content_type]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/UploadedBlobAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of uploaded blobs.","tags":["Uploaded Blobs"],"x-eiq-permissions":["read blob-uploads"]},"post":{"description":"The request body contains uploaded blob data in\n`application/octet-stream` format.\nThe blob details are passed in the header 'x-platformapi-metadata',\nrepresenting a dump of `UploadedBlobAPISchema`.\n\n**Required permissions**\n\n- `modify blob-uploads`\n\n","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadedBlobAPISchema"}}},"description":"value represent a string dump of a `UploadedBlobAPISchema`","in":"header","name":"x-platformapi-metadata"}],"requestBody":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/UploadedBlobAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Upload a new blob.","tags":["Uploaded Blobs"],"x-eiq-permissions":["modify blob-uploads"]}},"/uploaded-blobs/delete-tasks":{"post":{"description":"\n\n**Required permissions**\n\n- `modify blob-uploads`\n\n- `read tasks`\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/DeleteUploadedBlobAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TaskRunAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete blobs referenced by IDs.","tags":["Uploaded Blobs","Tasks"],"x-eiq-permissions":["modify blob-uploads","read tasks"]}},"/uploaded-blobs/{id}":{"get":{"description":"\n\n**Required permissions**\n\n- `read blob-uploads`\n\n","parameters":[{"description":"Uploaded Blob ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/UploadedBlobAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get an uploaded blob by ID.","tags":["Uploaded Blobs"],"x-eiq-permissions":["read blob-uploads"]}},"/users":{"get":{"description":"\n\n**Required permissions**\n\n- `read users`\n\n\n\n**Optional permissions**\n\n- `read groups` Required to access the groups associated with a user\n\n- `read permissions` Required to access the permissions associated with a user\n\n- `read roles` Required to access the roles associated with a user\n\n- `read sources` Required to access the sources associated with a user\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by user name","in":"query","name":"filter[username]","schema":{"type":"string"}},{"description":"Filter by user email","in":"query","name":"filter[email]","schema":{"type":"string"}},{"description":"Filter by first name","in":"query","name":"filter[first_name]","schema":{"type":"string"}},{"description":"Filter by last name","in":"query","name":"filter[last_name]","schema":{"type":"string"}},{"description":"Filter by status","in":"query","name":"filter[status]","schema":{"enum":["active","inactive","pending","locked","password reset requested"],"type":"string"}},{"description":"Filter by multi-factor authentication status","in":"query","name":"filter[has_mfa_activated]","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/UserAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Returns a list of users on the platform.","tags":["Users"],"x-eiq-optional-permissions":{"read groups":"Required to access the groups associated with a user","read permissions":"Required to access the permissions associated with a user","read roles":"Required to access the roles associated with a user","read sources":"Required to access the sources associated with a user"},"x-eiq-permissions":["read users"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify users`\n\n\n\n**Optional permissions**\n\n- `modify user-groups` Required if you want to modify the groups associated to a user\n\n- `modify user-roles` Required if you want to modify the roles associated to a user\n\n- `read permissions` Required to access the permissions associated with a user\n\n- `read sources` Required to access the sources associated with a user\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/UserAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/UserAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a user.","tags":["Users"],"x-eiq-optional-permissions":{"modify user-groups":"Required if you want to modify the groups associated to a user","modify user-roles":"Required if you want to modify the roles associated to a user","read permissions":"Required to access the permissions associated with a user","read sources":"Required to access the sources associated with a user"},"x-eiq-permissions":["modify users"]},"put":{"description":"\n\n**Required permissions**\n\n- `modify users`\n\n\n\n**Optional permissions**\n\n- `modify user-groups` Required if you want to modify the groups associated to a user\n\n- `modify user-roles` Required if you want to modify the roles associated to a user\n\n- `read permissions` Required to access the permissions associated with a user\n\n- `read sources` Required to access the sources associated with a user\n\n","parameters":[{"$ref":"#/components/parameters/AttributesParameter"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/UserAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/UserAPISchema"},"type":"array"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/UserAPISchema"},"type":"array"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create (or update if the name already exists) one or more users.","tags":["Users"],"x-eiq-optional-permissions":{"modify user-groups":"Required if you want to modify the groups associated to a user","modify user-roles":"Required if you want to modify the roles associated to a user","read permissions":"Required to access the permissions associated with a user","read sources":"Required to access the sources associated with a user"},"x-eiq-permissions":["modify users"]}},"/users/{id}":{"get":{"description":"Use `id=self` to get information about the user associated to the current API token.\n\n**Optional permissions**\n\n- `read users` Required to access the information of any user other than `self`\n\n- `read groups` Required to access the groups associated with a user\n\n- `read permissions` Required to access the permissions associated with a user\n\n- `read roles` Required to access the roles associated with a user\n\n- `read sources` Required to access the sources associated with a user\n\n","parameters":[{"description":"User ID","in":"path","name":"id","required":true,"schema":{"type":"number"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/UserAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a user by ID.","tags":["Users"],"x-eiq-optional-permissions":{"read groups":"Required to access the groups associated with a user","read permissions":"Required to access the permissions associated with a user","read roles":"Required to access the roles associated with a user","read sources":"Required to access the sources associated with a user","read users":"Required to access the information of any user other than `self`"}},"patch":{"description":"Use `id=self` to reference the user associated to the current API token.\n\n**Optional permissions**\n\n- `modify users` Required if you want to modify any user other than yourself\n\n- `modify user-groups` Required if you want to modify the groups associated to a user, unless you are a group admin\n\n- `modify user-roles` Required if you want to modify the roles associated to a user\n\n- `read permissions` Required to access the permissions associated with a user\n\n- `read sources` Required to access the sources associated with a user\n\n","parameters":[{"description":"User ID - use `self` to identify the current user.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"If `?overwrite_groups=false` and new `groups` are\nprovided, the resulting set of `groups` will contain\nboth the previous and the new groups. Otherwise, the\nlist of groups will be overwritten by the new one\n(default: `true`).\n","in":"query","name":"overwrite_groups","schema":{"type":"boolean"}},{"description":"If `?overwrite_roles=false` and new `roles` are\nprovided, the resulting set of `roles` will contain both\nthe previous and the new roles. Otherwise, the list of\nroles will be overwritten by the new one (default:\n`true`).\n","in":"query","name":"overwrite_roles","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/UserAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/UserAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Update a user.","tags":["Users"],"x-eiq-optional-permissions":{"modify user-groups":"Required if you want to modify the groups associated to a user, unless you are a group admin","modify user-roles":"Required if you want to modify the roles associated to a user","modify users":"Required if you want to modify any user other than yourself","read permissions":"Required to access the permissions associated with a user","read sources":"Required to access the sources associated with a user"}}},"/vendor-apis":{"get":{"description":"\n\n**Required permissions**\n\n- `read vendor-apis`\n\n","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/VendorAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of Vendor API","tags":["Vendor API"],"x-eiq-permissions":["read vendor-apis"]}},"/vendor-apis/{id}":{"get":{"description":"\n\n**Required permissions**\n\n- `read vendor-apis`\n\n","parameters":[{"description":"Vendor API ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/VendorAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a Vendor API by an ID","tags":["Vendor API"],"x-eiq-permissions":["read vendor-apis"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify vendor-apis`\n\n","parameters":[{"description":"Vendor API ID","in":"path","name":"id","required":true,"schema":{"type":"number"}},{"$ref":"#/components/parameters/AttributesParameter"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/VendorAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/VendorAPISchema"}},"type":"object"}}},"description":"The updated object"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Update the Vendor API by an ID","tags":["Vendor API"],"x-eiq-permissions":["modify vendor-apis"]}},"/widgets":{"delete":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of widgets referenced by IDs.","tags":["Dashboards"]},"get":{"parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter widgets by name","in":"query","name":"filter[name]","schema":{"type":"string"}},{"in":"query","name":"filter[category]","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/WidgetAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of widgets.","tags":["Dashboards"]},"post":{"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WidgetAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WidgetAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a widget.","tags":["Dashboards"]}},"/widgets/{id}":{"delete":{"parameters":[{"description":"Widget ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"responses":{"204":{"description":"Deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a widget.","tags":["Dashboards"]},"get":{"parameters":[{"description":"Widget ID","in":"path","name":"id","required":true,"schema":{"type":"number"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WidgetAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a widget by ID.","tags":["Dashboards"]},"patch":{"parameters":[{"description":"Widget ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WidgetAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WidgetAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Update a widget.","tags":["Dashboards"]}},"/widgets/{id}/thumbnail-dark":{"get":{"parameters":[{"description":"Widget ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"responses":{"200":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}},"description":"File content","headers":{"Content-Length":{"description":"File size","schema":{"type":"integer"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get the widget dark thumbnail as binary.","tags":["Dashboards"]}},"/widgets/{id}/thumbnail-light":{"get":{"parameters":[{"description":"Widget ID","in":"path","name":"id","required":true,"schema":{"type":"number"}}],"responses":{"200":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}},"description":"File content","headers":{"Content-Length":{"description":"File size","schema":{"type":"integer"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get the widget light thumbnail as binary.","tags":["Dashboards"]}},"/workspaces":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify workspaces`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of workspaces referenced by IDs.","tags":["Workspaces"],"x-eiq-permissions":["modify workspaces"]},"get":{"description":"Workspaces have three levels of access:\n\n- **Unlisted workspace:** ``is_public=False``\n\n  Only collaborators can see and modify this workspace.\n\n- **Listed workspace:** ``is_public=True``\n\n  This workspace has its public attributes\n  (public description, \"pinned\" objects) visible to all users\n  who have at least ``read workspaces`` permissions.\n  Only collaborators can see the full workspace and modify it.\n\n- **Public workspace:** ``is_shared_with_all=True``\n\n  This is only set to ``True`` for the \"Default public workspace\",\n  which is fully visible and can be modified by users who have\n  at least ``read workspaces`` permissions.\n\n**Required permissions**\n\n- `read workspaces`\n\n\n\n**Optional permissions**\n\n- `read intel-sets` To read datasets attached to the workspaces\n\n- `read entities` To read entities pinned to the workspaces\n\n- `read tasks` To read discovery tasks associated to the workspaces\n\n- `read discovery-rules` To read discovery tasks associated to the workspaces\n\n- `read tickets` To read tickets attached to the workspaces\n\n- `read users` To read workspace collaborators\n\n- `read groups` To read workspace collaborator groups\n\n- `read files` To read workspace files\n\n- `read workspace-comments` To read workspace comments\n\n","parameters":[{"$ref":"#/components/parameters/LimitParameter"},{"$ref":"#/components/parameters/OffsetParameter"},{"$ref":"#/components/parameters/SortParameter"},{"$ref":"#/components/parameters/DataParameter"},{"$ref":"#/components/parameters/AttributesParameter"},{"description":"Filter by workspace name","in":"query","name":"filter[name]","schema":{"type":"string"}},{"description":"Filter by workspace description","in":"query","name":"filter[description]","schema":{"type":"string"}},{"description":"Filter by workspace public description","in":"query","name":"filter[public_description]","schema":{"type":"string"}},{"description":"Filter by workspace type","in":"query","name":"filter[type]","schema":{"type":"string"}},{"description":"Filter by archived state","in":"query","name":"filter[is_archived]","schema":{"type":"boolean"}},{"description":"Filter by shared with all users state","in":"query","name":"filter[is_shared_with_all]","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/WorkspaceAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a list of workspaces.","tags":["Workspaces"],"x-eiq-optional-permissions":{"read discovery-rules":"To read discovery tasks associated to the workspaces","read entities":"To read entities pinned to the workspaces","read files":"To read workspace files","read groups":"To read workspace collaborator groups","read intel-sets":"To read datasets attached to the workspaces","read tasks":"To read discovery tasks associated to the workspaces","read tickets":"To read tickets attached to the workspaces","read users":"To read workspace collaborators","read workspace-comments":"To read workspace comments"},"x-eiq-permissions":["read workspaces"]},"post":{"description":"\n\n**Required permissions**\n\n- `modify workspaces`\n\n\n\n**Optional permissions**\n\n- `read intel-sets` To attach datasets to the workspace\n\n- `read entities` To pin entities to the workspace\n\n- `read tasks` To associate discovery tasks to the workspace\n\n- `read discovery-rules` To read discovery tasks associated to the workspaces\n\n- `read tickets` To attach tickets to the workspace\n\n- `read users` To add workspace collaborators\n\n- `read groups` To add workspace collaborator groups\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WorkspaceAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WorkspaceAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a new workspace.","tags":["Workspaces"],"x-eiq-optional-permissions":{"read discovery-rules":"To read discovery tasks associated to the workspaces","read entities":"To pin entities to the workspace","read groups":"To add workspace collaborator groups","read intel-sets":"To attach datasets to the workspace","read tasks":"To associate discovery tasks to the workspace","read tickets":"To attach tickets to the workspace","read users":"To add workspace collaborators"},"x-eiq-permissions":["modify workspaces"]},"put":{"description":"The workspace name is used as a unique key to identify whether the\nworkspace already exists.\n\n**Required permissions**\n\n- `modify workspaces`\n\n\n\n**Optional permissions**\n\n- `read intel-sets` To attach datasets to the workspace\n\n- `read entities` To pin entities to the workspace\n\n- `read tasks` To associate discovery tasks to the workspace\n\n- `read discovery-rules` To read discovery tasks associated to the workspaces\n\n- `read tickets` To attach tickets to the workspace\n\n- `read users` To add workspace collaborators\n\n- `read groups` To add workspace collaborator groups\n\n- `read files` To read workspace files\n\n- `read workspace-comments` To read workspace comments\n\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/WorkspaceAPISchema"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/WorkspaceAPISchema"},"type":"array"}},"type":"object"}}},"description":"The updated object"},"201":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/WorkspaceAPISchema"},"type":"array"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create (or update if the name already exists) one or more workspaces.","tags":["Workspaces"],"x-eiq-optional-permissions":{"read discovery-rules":"To read discovery tasks associated to the workspaces","read entities":"To pin entities to the workspace","read files":"To read workspace files","read groups":"To add workspace collaborator groups","read intel-sets":"To attach datasets to the workspace","read tasks":"To associate discovery tasks to the workspace","read tickets":"To attach tickets to the workspace","read users":"To add workspace collaborators","read workspace-comments":"To read workspace comments"},"x-eiq-permissions":["modify workspaces"]}},"/workspaces/comments":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify workspace-comments`\n\n- `read workspaces`\n\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a set of workspace comments referenced by IDs.","tags":["Workspace Comments"],"x-eiq-permissions":["modify workspace-comments","read workspaces"]}},"/workspaces/comments/{id}":{"delete":{"description":"On top of the required permissions, modifying workspace comments is allowed only if:\n\n- The user is a collaborator of the workspace and the creator of the comment, or\n- The user is a platform admin\n\n**Required permissions**\n\n- `modify workspace-comments`\n\n- `read workspaces`\n\n","parameters":[{"description":"Workspace comment ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a workspace comment by ID.","tags":["Workspace Comments"],"x-eiq-permissions":["modify workspace-comments","read workspaces"]},"get":{"description":"On top of the required permissions, reading workspace comments is allowed only if:\n\n- The user is a collaborator of the workspace, or\n- The user is a platform admin\n\n**Required permissions**\n\n- `read workspace-comments`\n\n- `read workspaces`\n\n","parameters":[{"description":"Workspace comment ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WorkspaceCommentAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a workspace comment by ID.","tags":["Workspace Comments"],"x-eiq-permissions":["read workspace-comments","read workspaces"]},"patch":{"description":"On top of the required permissions, modifying workspace comments is allowed only if:\n\n- The user is a collaborator of the workspace and the creator of the comment, or\n- The user is a platform admin\n\n**Required permissions**\n\n- `modify workspace-comments`\n\n- `read workspaces`\n\n","parameters":[{"description":"Workspace comment ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WorkspaceCommentAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WorkspaceCommentAPISchema"}},"type":"object"}}},"description":"The updated object"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Modify a workspace comment by ID.","tags":["Workspace Comments"],"x-eiq-permissions":["modify workspace-comments","read workspaces"]}},"/workspaces/{id}":{"delete":{"description":"\n\n**Required permissions**\n\n- `modify workspaces`\n\n","parameters":[{"description":"Workspace ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"204":{"description":"The deletion has been successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Delete a workspace by ID.","tags":["Workspaces"],"x-eiq-permissions":["modify workspaces"]},"get":{"description":"\n\n**Required permissions**\n\n- `read workspaces`\n\n\n\n**Optional permissions**\n\n- `read intel-sets` To read datasets attached to the workspace\n\n- `read entities` To read entities pinned to the workspace\n\n- `read tasks` To read discovery tasks associated to the workspace\n\n- `read discovery-rules` To read discovery tasks associated to the workspaces\n\n- `read tickets` To read tickets attached to the workspace\n\n- `read users` To read workspace collaborators\n\n- `read groups` To read workspace collaborator groups\n\n- `read files` To read workspace files\n\n- `read workspace-comments` To read workspace comments\n\n","parameters":[{"description":"Workspace ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/AttributesParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WorkspaceAPISchema"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get a workspace by ID.","tags":["Workspaces"],"x-eiq-optional-permissions":{"read discovery-rules":"To read discovery tasks associated to the workspaces","read entities":"To read entities pinned to the workspace","read files":"To read workspace files","read groups":"To read workspace collaborator groups","read intel-sets":"To read datasets attached to the workspace","read tasks":"To read discovery tasks associated to the workspace","read tickets":"To read tickets attached to the workspace","read users":"To read workspace collaborators","read workspace-comments":"To read workspace comments"},"x-eiq-permissions":["read workspaces"]},"patch":{"description":"\n\n**Required permissions**\n\n- `modify workspaces`\n\n\n\n**Optional permissions**\n\n- `read intel-sets` To read/modify datasets attached to the workspace\n\n- `read entities` To read/modify entities pinned to the workspace\n\n- `read tasks` To read/modify discovery tasks associated to the workspace\n\n- `read discovery-rules` To read discovery tasks associated to the workspaces\n\n- `read tickets` To read/modify tickets attached to the workspace\n\n- `read users` To read/modify workspace collaborators\n\n- `read groups` To read/modify workspace collaborator groups\n\n- `read files` To read workspace files\n\n- `read workspace-comments` To read workspace comments\n\n","parameters":[{"description":"Workspace ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}},{"description":"If `?overwrite_datasets=false` and new `datasets` are\nprovided, the resulting set of `datasets` will contain\nboth the previous and the new datasets. Otherwise, the\nlist of datasets will be overwritten by the new one\n(default: `true`).\n","in":"query","name":"overwrite_datasets","schema":{"type":"boolean"}},{"description":"If `?overwrite_entities=false` and new `entities` are\nprovided, the resulting set of `entities` will contain\nboth the previous and the new entities. Otherwise, the\nlist of entities will be overwritten by the new one\n(default: `true`).\n","in":"query","name":"overwrite_entities","schema":{"type":"boolean"}},{"description":"If `?overwrite_discovery_tasks=false` and new\n`discovery_tasks` are provided, the resulting set of\n`discovery_tasks` will contain both the previous and the\nnew discovery_tasks. Otherwise, the list of\ndiscovery_tasks will be overwritten by the new one\n(default: `true`).\n","in":"query","name":"overwrite_discovery_tasks","schema":{"type":"boolean"}},{"description":"If `?overwrite_tickets=false` and new `tickets` are\nprovided, the resulting set of `tickets` will contain\nboth the previous and the new tickets. Otherwise, the\nlist of tickets will be overwritten by the new one\n(default: `true`).\n","in":"query","name":"overwrite_tickets","schema":{"type":"boolean"}},{"description":"If `?overwrite_collaborators=false` and new\n`collaborators` are provided, the resulting set of\n`collaborators` will contain both the previous and the\nnew collaborators. Otherwise, the list of collaborators\nwill be overwritten by the new one (default: `true`).\n","in":"query","name":"overwrite_collaborators","schema":{"type":"boolean"}},{"description":"If `?overwrite_groups=false` and new `groups` are\nprovided, the resulting set of `groups` will contain\nboth the previous and the new groups. Otherwise, the\nlist of groups will be overwritten by the new one\n(default: `true`).\n","in":"query","name":"overwrite_groups","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WorkspaceAPISchema"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WorkspaceAPISchema"}},"type":"object"}}},"description":"The updated object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Edit a workspace by ID.","tags":["Workspaces"],"x-eiq-optional-permissions":{"read discovery-rules":"To read discovery tasks associated to the workspaces","read entities":"To read/modify entities pinned to the workspace","read files":"To read workspace files","read groups":"To read/modify workspace collaborator groups","read intel-sets":"To read/modify datasets attached to the workspace","read tasks":"To read/modify discovery tasks associated to the workspace","read tickets":"To read/modify tickets attached to the workspace","read users":"To read/modify workspace collaborators","read workspace-comments":"To read workspace comments"},"x-eiq-permissions":["modify workspaces"]}},"/workspaces/{id}/comments":{"get":{"description":"On top of the required permissions, reading workspace comments is allowed only if:\n\n- The user is a collaborator of the workspace, or\n- The user is a platform admin\n\n**Required permissions**\n\n- `read workspace-comments`\n\n- `read workspaces`\n\n","parameters":[{"description":"Workspace ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/WorkspaceCommentAPISchema"},"type":"array"}},"type":"object"}}},"description":"The requested object(s)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Get the content of the comments of a workspace.","tags":["Workspace Comments"],"x-eiq-permissions":["read workspace-comments","read workspaces"]},"post":{"description":"On top of the required permissions, comment creation is allowed only if:\n\n- The user is a collaborator of the workspace, or\n- The user is a platform admin\n\n**Required permissions**\n\n- `modify workspace-comments`\n\n- `read workspaces`\n\n","parameters":[{"description":"Workspace ID","in":"path","name":"id","required":true,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WorkspaceCommentAPISchema"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WorkspaceCommentAPISchema"}},"type":"object"}}},"description":"The created object"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Create a new workspace comment.","tags":["Workspace Comments"],"x-eiq-permissions":["modify workspace-comments","read workspaces"]}},"/{object_type}/{object_id}/{relation_type}":{"delete":{"parameters":[{"$ref":"#/components/parameters/ObjectTypeParameter"},{"$ref":"#/components/parameters/ObjectIDParameter"},{"$ref":"#/components/parameters/RelationTypeParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"204":{"description":"Relations deleted successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Generic endpoint for bulk deleting relations based on \"main object\" type and id and related objects type and ids (provided in request body).","tags":["Relation"]},"put":{"parameters":[{"$ref":"#/components/parameters/ObjectTypeParameter"},{"$ref":"#/components/parameters/ObjectIDParameter"},{"$ref":"#/components/parameters/RelationTypeParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONIDsSchema"}}}},"responses":{"201":{"description":"Relations added successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Generic endpoint for bulk adding relations based on \"main object\" type and id and related objects type and ids (provided in request body).","tags":["Relation"]}},"/{object_type}/{object_id}/{relation_type}/{relation_id}":{"delete":{"parameters":[{"$ref":"#/components/parameters/ObjectTypeParameter"},{"$ref":"#/components/parameters/ObjectIDParameter"},{"$ref":"#/components/parameters/RelationTypeParameter"},{"$ref":"#/components/parameters/RelationIDParameter"}],"responses":{"204":{"description":"Relation deleted successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Generic endpoint for deleting a relation based on \"main object\" type and id and related object type and id.","tags":["Relation"]},"put":{"parameters":[{"$ref":"#/components/parameters/ObjectTypeParameter"},{"$ref":"#/components/parameters/ObjectIDParameter"},{"$ref":"#/components/parameters/RelationTypeParameter"},{"$ref":"#/components/parameters/RelationIDParameter"}],"responses":{"201":{"description":"Relation added successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"access-token":[]},{"jwt":[]}],"summary":"Generic endpoint for adding a relation based on \"main object\" type and id and related object type and id.","tags":["Relation"]}}},"servers":[{"url":"https://cti.example.com/api/v2"}],"tags":[{"description":"Endpoints for providing some aggregations.","name":"Aggregations"},{"description":"All the features power by Artificial Intelligence.","name":"Artificial Intelligence"},{"description":"","name":"CSVMappings"},{"description":"","name":"Content Blocks"},{"description":"Datasets are collections of entities. They can be either static (users manually add intelligence to them) or dynamic (they are populated on the basis of an ElasticSearch query.","name":"Datasets"},{"description":"Discovery rules are tasks used to automatically attach intelligence that matches a certain ElasticSearch query to workspaces.","name":"Discovery Rules"},{"description":"Enrichers are functions or modules that can be used to automatically add information (i.e. enrich) to entities and observables.","name":"Enrichers"},{"description":"Enrichment rules are used to dynamically enrich intelligence that matches certain criteria.","name":"Enrichment Rules"},{"description":"In the platform entities represent the standard STIX objects defining different types of cyber threat information.","name":"Entities"},{"description":"\nThese endpoints are used to access and manipulate attachments related to an\nEntity, a Draft Entity or a Work-In-Progress Entity.\n\nThe accessibility of an attachment is defined if one has access to at least one\nof the attachment holder object (entity, draft, wip). An attachment without\nrelated object, called orphan, is by design inaccessible to everybody except\nadmin. As such attachment is useless, a background task run daily at night to\nremove them.\n\nDeprecation: The capacity to create orphan attachments will be removed in a\nfuture API version.\n\nThe expected creation flow is:\n\n1. Create the entity/draft/wip. You may already link existing attachments you\n    have access to.\n2. Create the new attachments directly related to the previously created object.\n","name":"Entity Attachments"},{"description":"Entity rules are used to dynamically apply a set of rules to ingested entities.","name":"Entity Rules"},{"description":"Export Blocks are objects produced by bulk export actions","name":"Export Blocks"},{"description":"These endpoints are used to access and manipulate files","name":"Files"},{"description":"Platform groups are used to provide users with the ability to easily share information, such as entities and observables.","name":"Groups"},{"description":"Incoming feeds are a way to programmatically ingest external intelligence into the platform.","name":"Incoming feeds"},{"description":"","name":"Knowledge Packs"},{"description":"MITRE Attacks (https://attack.mitre.org/) expose the MITRE framework, a globally-accessible knowledge base of adversary tactics and techniques based on real-world observations","name":"MITRE Attacks"},{"description":"Observable rules are used to dynamically apply a set of rules to ingested entities.","name":"Observable Rules"},{"description":"Observables represent properties associated to pieces of information. They can be used to store e.g. an IP address, a city name, or a hash.","name":"Observables"},{"description":"Outgoing feeds are a way to programmatically push entities and observables to other services.","name":"Outgoing feeds"},{"description":"Permissions define which kind of access (read/write) a user has to platform objects (entities, observables, groups, workspaces etc.)","name":"Permissions"},{"description":"","name":"Relation"},{"description":"These endpoints are used to manage relationships between entities.","name":"Relationships"},{"description":"Roles are sets of permissions that can be assigned to users and define which kind of platform profile the user has (Analyst/Team Lead/Admin etc.)","name":"Roles"},{"description":"A source defines a collection of platform objects that share the same owner, group or data source. Users, groups and incoming feeds all have their own `source_id`, and objects linked to that source will be visible to any user who has access to that source.","name":"Sources"},{"description":"These endpoints are used to access and manipulate a variety of platform tasks, such as enrichers, feeds, discovery rules and scheduled jobs.","name":"Tasks"},{"description":"Taxonomies define tree-like hierarchies to represent your intelligence - such as \"Exploit -> SSL -> Heartbleed\".","name":"Taxonomies"},{"description":"Endpoints for the manipulation of ticket comments.","name":"Ticket Comments"},{"description":"Tickets are units of work that can be assigned to users.","name":"Tickets"},{"description":"","name":"Uploaded Blobs"},{"description":"Users are individual platform consumers who can access the platform by signing in with their designated account credentials - username and password.","name":"Users"},{"description":"Endpoints for the manipulation of workspace comments.","name":"Workspace Comments"},{"description":"Workspaces are collections of intelligence, tickets, files and comments that can be shared across users and groups.","name":"Workspaces"}]}