diff --git a/.gitignore b/.gitignore index db3b6b1..dd3428b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ /.venv __pycache__/ +node_modules/ \ No newline at end of file diff --git a/docs/api-reference/spec/firework-v2-openapi.json b/docs/api-reference/spec/firework-v2-openapi.json index 786930c..4e99883 100644 --- a/docs/api-reference/spec/firework-v2-openapi.json +++ b/docs/api-reference/spec/firework-v2-openapi.json @@ -1692,7 +1692,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -1743,6 +1743,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -2016,7 +2017,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -2067,6 +2068,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -2591,7 +2593,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -2642,6 +2644,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -2915,7 +2918,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -2966,6 +2969,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -3329,7 +3333,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -3380,6 +3384,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -3612,7 +3617,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -3663,6 +3668,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -4740,7 +4746,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -4791,6 +4797,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -4945,6 +4952,25 @@ "default": false, "type": "boolean" } + }, + { + "description": "Stealer log labels used to filter search results", + "explode": true, + "in": "query", + "name": "labels", + "schema": { + "enum": [ + "access_types", + "pii", + "facts", + "findings" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "responses": { @@ -5044,7 +5070,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -5095,6 +5121,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -5249,6 +5276,25 @@ "default": false, "type": "boolean" } + }, + { + "description": "Stealer log labels used to filter search results", + "explode": true, + "in": "query", + "name": "labels", + "schema": { + "enum": [ + "access_types", + "pii", + "facts", + "findings" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "responses": { @@ -5556,33 +5602,33 @@ "search_types": { "items": { "enum": [ - "leak", + "google", + "financial_data", "invalid_credential", - "stealer_log", - "domain", - "mitigated_credential", - "chat_message", - "forum_profile", - "stack_exchange", + "service", + "blog_post", + "source_code_secrets", + "leak", "forum_post", + "chat_message", + "ransomleak", + "mitigated_credential", "paste", "docker", - "valid_credential", - "service", - "social_media_account", - "financial_data", "bucket", + "forum_profile", + "source_code_files", + "stealer_log", "ad", - "ransomleak", - "blog_post", + "forum_topic", "listing", - "google", + "valid_credential", "bot", "seller", - "source_code_secrets", - "source_code_files", - "forum_topic", + "stack_exchange", + "domain", "bucket_object", + "social_media_account", "illicit_networks", "open_web", "buckets", @@ -5596,7 +5642,7 @@ "infected_devices", "social_media" ], - "example": "leak", + "example": "google", "type": "string" }, "type": "array" @@ -5664,32 +5710,32 @@ "search_types": { "items": { "enum": [ - "leak", + "google", + "financial_data", "invalid_credential", - "stealer_log", - "domain", - "mitigated_credential", - "chat_message", - "forum_profile", - "stack_exchange", + "service", + "blog_post", + "source_code_secrets", + "leak", "forum_post", + "chat_message", + "ransomleak", + "mitigated_credential", "paste", "docker", - "valid_credential", - "service", - "social_media_account", - "financial_data", "bucket", - "ransomleak", - "blog_post", + "forum_profile", + "source_code_files", + "stealer_log", + "forum_topic", "listing", - "google", + "valid_credential", "bot", "seller", - "source_code_secrets", - "source_code_files", - "forum_topic", + "stack_exchange", + "domain", "bucket_object", + "social_media_account", "illicit_networks", "open_web", "buckets", @@ -5702,7 +5748,7 @@ "infected_devices", "social_media" ], - "example": "leak", + "example": "google", "type": "string" }, "type": "array" @@ -5898,6 +5944,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -6001,6 +6048,17 @@ }, "type": "object" }, + "TenantWithCounts": { + "properties": { + "next": { + "type": "string" + }, + "items": { + "$ref": "#/components/schemas/TenantWithCounts" + } + }, + "type": "object" + }, "Tenant": { "properties": { "id": { @@ -6060,17 +6118,6 @@ }, "type": "object" }, - "TenantWithCounts": { - "properties": { - "next": { - "type": "string" - }, - "items": { - "$ref": "#/components/schemas/TenantWithCounts" - } - }, - "type": "object" - }, "UpdatedPermission": { "properties": { "updated_value": { @@ -6140,6 +6187,17 @@ ], "type": "object" }, + "OrganizationMemberPage": { + "properties": { + "members": { + "items": { + "$ref": "#/components/schemas/OrganizationMemberWithMetadata" + }, + "type": "array" + } + }, + "type": "object" + }, "OrganizationMemberWithMetadata": { "properties": { "user": { @@ -6193,17 +6251,6 @@ }, "type": "object" }, - "OrganizationMemberPage": { - "properties": { - "members": { - "items": { - "$ref": "#/components/schemas/OrganizationMemberWithMetadata" - }, - "type": "array" - } - }, - "type": "object" - }, "OrganizationMembersCount": { "properties": { "count": { diff --git a/docs/api-reference/spec/firework-v2-swagger.json b/docs/api-reference/spec/firework-v2-swagger.json index 06c1efc..779d8fb 100644 --- a/docs/api-reference/spec/firework-v2-swagger.json +++ b/docs/api-reference/spec/firework-v2-swagger.json @@ -914,6 +914,24 @@ } }, "/firework/v2/assets/": { + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "properties": { + "assets": { + "$ref": "#/definitions/Identifier" + } + } + } + } + }, + "operationId": "get_assets_/assets/", + "tags": [ + "Identifiers" + ] + }, "post": { "responses": { "200": { @@ -947,27 +965,27 @@ "tags": [ "Identifiers" ] - }, + } + }, + "/firework/v2/assets/groups/": { "get": { "responses": { "200": { "description": "Success", "schema": { "properties": { - "assets": { - "$ref": "#/definitions/Identifier" + "assets_groups": { + "$ref": "#/definitions/IdentifierGroup" } } } } }, - "operationId": "get_assets_/assets/", + "operationId": "get_assets_groups_/assets/groups/", "tags": [ "Identifiers" ] - } - }, - "/firework/v2/assets/groups/": { + }, "post": { "responses": { "200": { @@ -1001,24 +1019,6 @@ "tags": [ "Identifiers" ] - }, - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "properties": { - "assets_groups": { - "$ref": "#/definitions/IdentifierGroup" - } - } - } - } - }, - "operationId": "get_assets_groups_/assets/groups/", - "tags": [ - "Identifiers" - ] } }, "/firework/v2/assets/groups/{assets_group_id}": { @@ -1103,6 +1103,24 @@ "type": "integer" } ], + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "properties": { + "alerts": { + "$ref": "#/definitions/FeedAlert" + } + } + } + } + }, + "operationId": "get_assets_group_alerts_/assets/groups//alerts", + "tags": [ + "Identifiers" + ] + }, "post": { "responses": { "200": { @@ -1126,24 +1144,6 @@ "tags": [ "Identifiers" ] - }, - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "properties": { - "alerts": { - "$ref": "#/definitions/FeedAlert" - } - } - } - } - }, - "operationId": "get_assets_group_alerts_/assets/groups//alerts", - "tags": [ - "Identifiers" - ] } }, "/firework/v2/assets/groups/{assets_group_id}/alerts/{alert_id}": { @@ -1206,7 +1206,7 @@ "type": "integer" } ], - "post": { + "get": { "responses": { "404": { "description": "Identifier group does not exist.", @@ -1227,7 +1227,7 @@ } } }, - "operationId": "post_assets_group_feed_/assets/groups//feed", + "operationId": "get_assets_group_feed_/assets/groups//feed", "parameters": [ { "name": "fields", @@ -1284,7 +1284,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -1335,6 +1335,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -1466,7 +1467,7 @@ "Identifiers" ] }, - "get": { + "post": { "responses": { "404": { "description": "Identifier group does not exist.", @@ -1487,7 +1488,7 @@ } } }, - "operationId": "get_assets_group_feed_/assets/groups//feed", + "operationId": "post_assets_group_feed_/assets/groups//feed", "parameters": [ { "name": "fields", @@ -1544,7 +1545,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -1595,6 +1596,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -1809,6 +1811,24 @@ "type": "integer" } ], + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "properties": { + "alerts": { + "$ref": "#/definitions/FeedAlert" + } + } + } + } + }, + "operationId": "get_asset_alerts_/assets//alerts", + "tags": [ + "Identifiers" + ] + }, "post": { "responses": { "200": { @@ -1832,24 +1852,6 @@ "tags": [ "Identifiers" ] - }, - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "properties": { - "alerts": { - "$ref": "#/definitions/FeedAlert" - } - } - } - } - }, - "operationId": "get_asset_alerts_/assets//alerts", - "tags": [ - "Identifiers" - ] } }, "/firework/v2/assets/{asset_id}/alerts/{alert_id}": { @@ -1912,7 +1914,7 @@ "type": "integer" } ], - "post": { + "get": { "responses": { "404": { "description": "Identifier does not exist.", @@ -1933,7 +1935,7 @@ } } }, - "operationId": "post_asset_feed_/assets//feed", + "operationId": "get_asset_feed_/assets//feed", "parameters": [ { "name": "fields", @@ -1990,7 +1992,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -2041,6 +2043,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -2172,7 +2175,7 @@ "Identifiers" ] }, - "get": { + "post": { "responses": { "404": { "description": "Identifier does not exist.", @@ -2193,7 +2196,7 @@ } } }, - "operationId": "get_asset_feed_/assets//feed", + "operationId": "post_asset_feed_/assets//feed", "parameters": [ { "name": "fields", @@ -2250,7 +2253,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -2301,6 +2304,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -2523,7 +2527,7 @@ } }, "/firework/v2/me/feed": { - "post": { + "get": { "responses": { "200": { "description": "The user's home feed activities", @@ -2532,7 +2536,7 @@ } } }, - "operationId": "post_current_user_home_feed_/me/feed", + "operationId": "get_current_user_home_feed_/me/feed", "parameters": [ { "name": "time", @@ -2579,7 +2583,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -2630,6 +2634,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -2761,7 +2766,7 @@ "me" ] }, - "get": { + "post": { "responses": { "200": { "description": "The user's home feed activities", @@ -2770,7 +2775,7 @@ } } }, - "operationId": "get_current_user_home_feed_/me/feed", + "operationId": "post_current_user_home_feed_/me/feed", "parameters": [ { "name": "time", @@ -2817,7 +2822,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -2868,6 +2873,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -3001,30 +3007,6 @@ } }, "/firework/v2/me/feed/credentials": { - "post": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PaginatedCredentials" - } - } - }, - "operationId": "post_leaked_credentials_feed_endpoint_/me/feed/credentials", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/UserUpdate" - } - } - ], - "tags": [ - "me" - ] - }, "get": { "responses": { "200": { @@ -3061,6 +3043,30 @@ "tags": [ "me" ] + }, + "post": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PaginatedCredentials" + } + } + }, + "operationId": "post_leaked_credentials_feed_endpoint_/me/feed/credentials", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/UserUpdate" + } + } + ], + "tags": [ + "me" + ] } }, "/firework/v2/me/profile": { @@ -3132,7 +3138,7 @@ "type": "integer" } ], - "post": { + "get": { "responses": { "404": { "description": "Organization not found", @@ -3143,30 +3149,34 @@ "200": { "description": "Success", "schema": { - "properties": { - "member": { - "$ref": "#/definitions/OrganizationMemberWithMetadata" - } - } + "$ref": "#/definitions/OrganizationMemberPage" } } }, - "operationId": "post_organization_members_api_/organizations//members", + "operationId": "get_organization_members_api_/organizations//members", "parameters": [ { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/OrganizationMemberData" - } + "name": "size", + "in": "query", + "type": "integer", + "default": 20 + }, + { + "name": "from", + "in": "query", + "type": "string" + }, + { + "name": "q", + "in": "query", + "type": "string" } ], "tags": [ "organizations" ] }, - "get": { + "post": { "responses": { "404": { "description": "Organization not found", @@ -3177,27 +3187,23 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/OrganizationMemberPage" + "properties": { + "member": { + "$ref": "#/definitions/OrganizationMemberWithMetadata" + } + } } } }, - "operationId": "get_organization_members_api_/organizations//members", + "operationId": "post_organization_members_api_/organizations//members", "parameters": [ { - "name": "size", - "in": "query", - "type": "integer", - "default": 20 - }, - { - "name": "from", - "in": "query", - "type": "string" - }, - { - "name": "q", - "in": "query", - "type": "string" + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/OrganizationMemberData" + } } ], "tags": [ @@ -3480,6 +3486,20 @@ "type": "integer" } ], + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TenantWithCounts" + } + } + }, + "operationId": "get_organization_tenants_api_/organizations//tenants", + "tags": [ + "organizations" + ] + }, "post": { "responses": { "200": { @@ -3503,23 +3523,20 @@ "tags": [ "organizations" ] - }, + } + }, + "/firework/v2/reporting/reports": { "get": { "responses": { "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/TenantWithCounts" - } + "description": "Lists reports for the current tenant, ordered from newest to oldest." } }, - "operationId": "get_organization_tenants_api_/organizations//tenants", + "operationId": "get_reports_endpoint_/reporting/reports", "tags": [ - "organizations" + "reporting" ] - } - }, - "/firework/v2/reporting/reports": { + }, "post": { "responses": { "200": { @@ -3540,17 +3557,6 @@ "tags": [ "reporting" ] - }, - "get": { - "responses": { - "200": { - "description": "Lists reports for the current tenant, ordered from newest to oldest." - } - }, - "operationId": "get_reports_endpoint_/reporting/reports", - "tags": [ - "reporting" - ] } }, "/firework/v2/reporting/reports/{report_id}": { @@ -3649,7 +3655,7 @@ } }, "/firework/v2/search/": { - "post": { + "get": { "responses": { "400": { "description": "Query is invalid.", @@ -3664,7 +3670,7 @@ } } }, - "operationId": "post_search_/search/", + "operationId": "get_search_/search/", "parameters": [ { "name": "fields", @@ -3721,7 +3727,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -3772,6 +3778,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -3895,13 +3902,29 @@ "in": "query", "type": "boolean", "default": false + }, + { + "name": "labels", + "in": "query", + "type": "array", + "description": "Stealer log labels used to filter search results", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "enum": [ + "access_types", + "pii", + "facts", + "findings" + ] } ], "tags": [ "search" ] }, - "get": { + "post": { "responses": { "400": { "description": "Query is invalid.", @@ -3916,7 +3939,7 @@ } } }, - "operationId": "get_search_/search/", + "operationId": "post_search_/search/", "parameters": [ { "name": "fields", @@ -3973,7 +3996,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -4024,6 +4047,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -4147,6 +4171,22 @@ "in": "query", "type": "boolean", "default": false + }, + { + "name": "labels", + "in": "query", + "type": "array", + "description": "Stealer log labels used to filter search results", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "enum": [ + "access_types", + "pii", + "facts", + "findings" + ] } ], "tags": [ @@ -4232,6 +4272,20 @@ "type": "integer" } ], + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TenantUsers" + } + } + }, + "operationId": "get_tenant_users_api_/tenants//users", + "tags": [ + "tenants" + ] + }, "post": { "responses": { "200": { @@ -4252,20 +4306,6 @@ "tags": [ "tenants" ] - }, - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/TenantUsers" - } - } - }, - "operationId": "get_tenant_users_api_/tenants//users", - "tags": [ - "tenants" - ] } }, "/firework/v2/tenants/{tenant_id}/users/{user_id}": { @@ -4429,35 +4469,35 @@ "type": "array", "items": { "type": "string", - "example": "leak", + "example": "google", "enum": [ - "leak", + "google", + "financial_data", "invalid_credential", - "stealer_log", - "domain", - "mitigated_credential", - "chat_message", - "forum_profile", - "stack_exchange", + "service", + "blog_post", + "source_code_secrets", + "leak", "forum_post", + "chat_message", + "ransomleak", + "mitigated_credential", "paste", "docker", - "valid_credential", - "service", - "social_media_account", - "financial_data", "bucket", + "forum_profile", + "source_code_files", + "stealer_log", "ad", - "ransomleak", - "blog_post", + "forum_topic", "listing", - "google", + "valid_credential", "bot", "seller", - "source_code_secrets", - "source_code_files", - "forum_topic", + "stack_exchange", + "domain", "bucket_object", + "social_media_account", "illicit_networks", "open_web", "buckets", @@ -4536,34 +4576,34 @@ "type": "array", "items": { "type": "string", - "example": "leak", + "example": "google", "enum": [ - "leak", + "google", + "financial_data", "invalid_credential", - "stealer_log", - "domain", - "mitigated_credential", - "chat_message", - "forum_profile", - "stack_exchange", + "service", + "blog_post", + "source_code_secrets", + "leak", "forum_post", + "chat_message", + "ransomleak", + "mitigated_credential", "paste", "docker", - "valid_credential", - "service", - "social_media_account", - "financial_data", "bucket", - "ransomleak", - "blog_post", + "forum_profile", + "source_code_files", + "stealer_log", + "forum_topic", "listing", - "google", + "valid_credential", "bot", "seller", - "source_code_secrets", - "source_code_files", - "forum_topic", + "stack_exchange", + "domain", "bucket_object", + "social_media_account", "illicit_networks", "open_web", "buckets", @@ -4801,6 +4841,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -5110,6 +5151,24 @@ }, "type": "object" }, + "TenantWithCounts": { + "properties": { + "next": { + "type": "string" + }, + "items": { + "$ref": "#/definitions/TenantWithCounts" + }, + "total_count": { + "type": [ + "integer", + "null" + ], + "example": "nullable integer" + } + }, + "type": "object" + }, "Tenant": { "properties": { "id": { @@ -5194,24 +5253,6 @@ }, "type": "object" }, - "TenantWithCounts": { - "properties": { - "next": { - "type": "string" - }, - "items": { - "$ref": "#/definitions/TenantWithCounts" - }, - "total_count": { - "type": [ - "integer", - "null" - ], - "example": "nullable integer" - } - }, - "type": "object" - }, "UpdatedPermission": { "properties": { "updated_value": { @@ -5319,6 +5360,24 @@ }, "type": "object" }, + "OrganizationMemberPage": { + "properties": { + "members": { + "type": "array", + "items": { + "$ref": "#/definitions/OrganizationMemberWithMetadata" + } + }, + "next": { + "type": [ + "string", + "null" + ], + "example": "nullable string" + } + }, + "type": "object" + }, "OrganizationMemberWithMetadata": { "properties": { "user": { @@ -5386,24 +5445,6 @@ }, "type": "object" }, - "OrganizationMemberPage": { - "properties": { - "members": { - "type": "array", - "items": { - "$ref": "#/definitions/OrganizationMemberWithMetadata" - } - }, - "next": { - "type": [ - "string", - "null" - ], - "example": "nullable string" - } - }, - "type": "object" - }, "OrganizationMembersCount": { "properties": { "count": { @@ -6004,6 +6045,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", diff --git a/docs/api-reference/spec/firework-v3-openapi.json b/docs/api-reference/spec/firework-v3-openapi.json index f97a2c1..9849a47 100644 --- a/docs/api-reference/spec/firework-v3-openapi.json +++ b/docs/api-reference/spec/firework-v3-openapi.json @@ -569,7 +569,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -620,6 +620,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -893,7 +894,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -944,6 +945,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -2348,6 +2350,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", diff --git a/docs/api-reference/spec/firework-v3-swagger.json b/docs/api-reference/spec/firework-v3-swagger.json index 87d68bc..4afa1fd 100644 --- a/docs/api-reference/spec/firework-v3-swagger.json +++ b/docs/api-reference/spec/firework-v3-swagger.json @@ -409,7 +409,7 @@ "type": "string" } ], - "post": { + "get": { "responses": { "403": { "description": "Forbidden.", @@ -430,7 +430,7 @@ } } }, - "operationId": "post_asset_feeds_api_/assets//feed", + "operationId": "get_asset_feeds_api_/assets//feed", "parameters": [ { "name": "fields", @@ -487,7 +487,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -538,6 +538,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -669,7 +670,7 @@ "assets" ] }, - "get": { + "post": { "responses": { "403": { "description": "Forbidden.", @@ -690,7 +691,7 @@ } } }, - "operationId": "get_asset_feeds_api_/assets//feed", + "operationId": "post_asset_feeds_api_/assets//feed", "parameters": [ { "name": "fields", @@ -747,7 +748,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -798,6 +799,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -1432,20 +1434,6 @@ "type": "integer" } ], - "post": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PaginatedCredentials" - } - } - }, - "operationId": "post_leaked_credentials_feed_endpoint_/identifiers//feed/credentials", - "tags": [ - "identifiers" - ] - }, "get": { "responses": { "200": { @@ -1472,6 +1460,20 @@ "tags": [ "identifiers" ] + }, + "post": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PaginatedCredentials" + } + } + }, + "operationId": "post_leaked_credentials_feed_endpoint_/identifiers//feed/credentials", + "tags": [ + "identifiers" + ] } }, "/firework/v3/identifiers/{identifier_id}/relations": { @@ -2050,6 +2052,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", diff --git a/docs/api-reference/spec/firework-v4-openapi.json b/docs/api-reference/spec/firework-v4-openapi.json index 3d1d099..64341e1 100644 --- a/docs/api-reference/spec/firework-v4-openapi.json +++ b/docs/api-reference/spec/firework-v4-openapi.json @@ -3151,6 +3151,7 @@ "seller", "service", "social_media_account", + "source_code_observation", "source_code_secret", "stealer_log", "attachment/telegram", @@ -6816,6 +6817,20 @@ ], "title": "Intent Ids" }, + "observable_types": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/StixCyberObservableType" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Observable Types" + }, "confidence": { "$ref": "#/components/schemas/IntRangeFilter" }, @@ -9212,7 +9227,7 @@ "matched": { "type": "boolean", "title": "Matched", - "description": "Whether the identifier's own search query matched the event" + "description": "Whether the identifier's own search query matched the event. See 'matched_uid' for the document the terms were found in" }, "applicable": { "type": "boolean", @@ -9236,7 +9251,19 @@ }, "type": "object", "title": "Highlights", - "description": "Excerpts of the event fields the identifier's terms matched, with each match wrapped in tags" + "description": "Excerpts of the fields the identifier's terms matched, with each match wrapped in tags. The keys are field names on the document identified by 'matched_uid'" + }, + "matched_uid": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Matched Uid", + "description": "The uid of the document the identifier's terms were found in. Usually the event's own uid; for events that merge attached files into their content it can be the uid of one of those files. Null when 'matched' is false" } }, "type": "object", @@ -9889,6 +9916,17 @@ ], "title": "Pattern Version" }, + "pattern_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Pattern Type" + }, "indicator_types": { "items": { "type": "string" @@ -9896,6 +9934,13 @@ "type": "array", "title": "Indicator Types" }, + "observable_types": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Observable Types" + }, "valid_from": { "anyOf": [ { @@ -9941,7 +9986,9 @@ "pattern", "description", "pattern_version", + "pattern_type", "indicator_types", + "observable_types", "valid_from", "valid_until", "kill_chain_phases", @@ -10316,6 +10363,17 @@ ], "title": "Web Search Queries", "description": "The queries used for web search" + }, + "time_range_type": { + "anyOf": [ + { + "$ref": "#/components/schemas/TimeRangeType" + }, + { + "type": "null" + } + ], + "description": "The time range inferred from the question" } }, "type": "object", @@ -13682,6 +13740,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -13952,7 +14011,7 @@ "properties": { "event_severity": { "$ref": "#/components/schemas/RiskScore", - "description": "The severity computed for the event" + "description": "The severity computed for the event from the currently active scoring rules" }, "allowed_severities": { "items": { @@ -14257,6 +14316,30 @@ "type": "object", "title": "StealerLogEventData" }, + "StixCyberObservableType": { + "type": "string", + "enum": [ + "artifact", + "autonomous-system", + "directory", + "domain-name", + "email-addr", + "email-message", + "file", + "ipv4-addr", + "ipv6-addr", + "mac-addr", + "mutex", + "network-traffic", + "process", + "software", + "url", + "user-account", + "windows-registry-key", + "x509-certificate" + ], + "title": "StixCyberObservableType" + }, "SubdomainStatus": { "properties": { "status": { diff --git a/docs/changelog/overview.mdx b/docs/changelog/overview.mdx index 750002e..3fde5aa 100644 --- a/docs/changelog/overview.mdx +++ b/docs/changelog/overview.mdx @@ -12,6 +12,11 @@ This page lists changes to Flare's API. Release notes for the Flare Platform can be found on the [product documentation website](https://docs.flare.io/releases). + + Added a new [Explain Identifier Event URL Endpoint ](/api-reference/v4/endpoints/explain-identifier-event) to provide evidence as to how an event matches to an identifier. + + + Added a new [Create Presigned Upload URL Endpoint ](/api-reference/v4/endpoints/create-presigned-upload-url) to upload files for later submission to Sandbox for analysis. diff --git a/docs/docs.json b/docs/docs.json index 1dfe9c2..ac11196 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -83,7 +83,8 @@ "api-reference/v2/endpoints/activities/get-fireworkv2activities--ai_assistance", "api-reference/v4/endpoints/event-actions", "api-reference/v4/endpoints/credential-actions", - "api-reference/v4/endpoints/public/update-tenant-metadata" + "api-reference/v4/endpoints/public/update-tenant-metadata", + "api-reference/v4/endpoints/explain-identifier-event" ] }, {