From d5689e8f981a4ba48a360100d7e104f2b16dc146 Mon Sep 17 00:00:00 2001 From: Gabrielle Rouillard Date: Wed, 17 Dec 2025 13:47:06 -0500 Subject: [PATCH 1/2] documentation generated and path added to Docs.json --- .../spec/firework-v2-openapi.json | 102 +- .../spec/firework-v2-swagger.json | 135 +- .../spec/firework-v3-openapi.json | 23 +- .../spec/firework-v3-swagger.json | 23 +- .../spec/firework-v4-openapi.json | 2379 +++++++++++++---- .../public/update-tenant-metadata.mdx | 3 + docs/docs.json | 3 +- 7 files changed, 2070 insertions(+), 598 deletions(-) create mode 100644 docs/api-reference/v4/endpoints/public/update-tenant-metadata.mdx diff --git a/docs/api-reference/spec/firework-v2-openapi.json b/docs/api-reference/spec/firework-v2-openapi.json index a700e99..8fea53e 100644 --- a/docs/api-reference/spec/firework-v2-openapi.json +++ b/docs/api-reference/spec/firework-v2-openapi.json @@ -1831,7 +1831,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, illicit_networks, open_web, domains, 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, seller, stealer_log, forum_topic, ransomleak, chat_message, blog_post, listing, forum_post, forum_profile, bot\n- open_web: source_code_files, stack_exchange, social_media_account, bucket, paste, service, bucket_object, docker, source_code_secrets, google\n- leaks: leak\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, illicit_networks, open_web, domains, 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: listing, chat_message, financial_data, stealer_log, forum_post, blog_post, ransomleak, forum_topic, forum_profile, seller, bot\n- open_web: paste, docker, social_media_account, service, source_code_secrets, source_code_files, google, bucket, stack_exchange, bucket_object\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -2151,7 +2151,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, illicit_networks, open_web, domains, 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, seller, stealer_log, forum_topic, ransomleak, chat_message, blog_post, listing, forum_post, forum_profile, bot\n- open_web: source_code_files, stack_exchange, social_media_account, bucket, paste, service, bucket_object, docker, source_code_secrets, google\n- leaks: leak\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, illicit_networks, open_web, domains, 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: listing, chat_message, financial_data, stealer_log, forum_post, blog_post, ransomleak, forum_topic, forum_profile, seller, bot\n- open_web: paste, docker, social_media_account, service, source_code_secrets, source_code_files, google, bucket, stack_exchange, bucket_object\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -2722,7 +2722,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, illicit_networks, open_web, domains, 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, seller, stealer_log, forum_topic, ransomleak, chat_message, blog_post, listing, forum_post, forum_profile, bot\n- open_web: source_code_files, stack_exchange, social_media_account, bucket, paste, service, bucket_object, docker, source_code_secrets, google\n- leaks: leak\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, illicit_networks, open_web, domains, 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: listing, chat_message, financial_data, stealer_log, forum_post, blog_post, ransomleak, forum_topic, forum_profile, seller, bot\n- open_web: paste, docker, social_media_account, service, source_code_secrets, source_code_files, google, bucket, stack_exchange, bucket_object\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -3042,7 +3042,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, illicit_networks, open_web, domains, 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, seller, stealer_log, forum_topic, ransomleak, chat_message, blog_post, listing, forum_post, forum_profile, bot\n- open_web: source_code_files, stack_exchange, social_media_account, bucket, paste, service, bucket_object, docker, source_code_secrets, google\n- leaks: leak\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, illicit_networks, open_web, domains, 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: listing, chat_message, financial_data, stealer_log, forum_post, blog_post, ransomleak, forum_topic, forum_profile, seller, bot\n- open_web: paste, docker, social_media_account, service, source_code_secrets, source_code_files, google, bucket, stack_exchange, bucket_object\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -3440,7 +3440,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, illicit_networks, open_web, domains, 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, seller, stealer_log, forum_topic, ransomleak, chat_message, blog_post, listing, forum_post, forum_profile, bot\n- open_web: source_code_files, stack_exchange, social_media_account, bucket, paste, service, bucket_object, docker, source_code_secrets, google\n- leaks: leak\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, illicit_networks, open_web, domains, 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: listing, chat_message, financial_data, stealer_log, forum_post, blog_post, ransomleak, forum_topic, forum_profile, seller, bot\n- open_web: paste, docker, social_media_account, service, source_code_secrets, source_code_files, google, bucket, stack_exchange, bucket_object\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -3782,7 +3782,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, illicit_networks, open_web, domains, 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, seller, stealer_log, forum_topic, ransomleak, chat_message, blog_post, listing, forum_post, forum_profile, bot\n- open_web: source_code_files, stack_exchange, social_media_account, bucket, paste, service, bucket_object, docker, source_code_secrets, google\n- leaks: leak\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, illicit_networks, open_web, domains, 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: listing, chat_message, financial_data, stealer_log, forum_post, blog_post, ransomleak, forum_topic, forum_profile, seller, bot\n- open_web: paste, docker, social_media_account, service, source_code_secrets, source_code_files, google, bucket, stack_exchange, bucket_object\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -4061,7 +4061,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, illicit_networks, open_web, domains, 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, seller, stealer_log, forum_topic, ransomleak, chat_message, blog_post, listing, forum_post, forum_profile, bot\n- open_web: source_code_files, stack_exchange, social_media_account, bucket, paste, service, bucket_object, docker, source_code_secrets, google\n- leaks: leak\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, illicit_networks, open_web, domains, 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: listing, chat_message, financial_data, stealer_log, forum_post, blog_post, ransomleak, forum_topic, forum_profile, seller, bot\n- open_web: paste, docker, social_media_account, service, source_code_secrets, source_code_files, google, bucket, stack_exchange, bucket_object\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -5122,7 +5122,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, illicit_networks, open_web, domains, 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, seller, stealer_log, forum_topic, ransomleak, chat_message, blog_post, listing, forum_post, forum_profile, bot\n- open_web: source_code_files, stack_exchange, social_media_account, bucket, paste, service, bucket_object, docker, source_code_secrets, google\n- leaks: leak\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, illicit_networks, open_web, domains, 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: listing, chat_message, financial_data, stealer_log, forum_post, blog_post, ransomleak, forum_topic, forum_profile, seller, bot\n- open_web: paste, docker, social_media_account, service, source_code_secrets, source_code_files, google, bucket, stack_exchange, bucket_object\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -5422,7 +5422,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, illicit_networks, open_web, domains, 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, seller, stealer_log, forum_topic, ransomleak, chat_message, blog_post, listing, forum_post, forum_profile, bot\n- open_web: source_code_files, stack_exchange, social_media_account, bucket, paste, service, bucket_object, docker, source_code_secrets, google\n- leaks: leak\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, illicit_networks, open_web, domains, 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: listing, chat_message, financial_data, stealer_log, forum_post, blog_post, ransomleak, forum_topic, forum_profile, seller, bot\n- open_web: paste, docker, social_media_account, service, source_code_secrets, source_code_files, google, bucket, stack_exchange, bucket_object\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -6504,29 +6504,29 @@ "search_types": { "items": { "enum": [ - "source_code_files", + "paste", "blog_post", - "leak", - "social_media_account", + "source_code_secrets", + "bucket_object", + "forum_post", + "docker", + "bot", "bucket", - "seller", - "stealer_log", "chat_message", - "service", - "docker", - "google", "financial_data", - "forum_topic", - "stack_exchange", - "listing", "ransomleak", - "paste", - "bucket_object", - "source_code_secrets", - "forum_post", - "forum_profile", "domain", - "bot", + "google", + "source_code_files", + "listing", + "stealer_log", + "social_media_account", + "service", + "forum_topic", + "forum_profile", + "seller", + "stack_exchange", + "leak", "illicit_networks", "open_web", "buckets", @@ -6539,7 +6539,7 @@ "infected_devices", "social_media" ], - "example": "source_code_files", + "example": "paste", "type": "string" }, "type": "array" @@ -6617,30 +6617,30 @@ "search_types": { "items": { "enum": [ - "source_code_files", + "paste", "blog_post", - "leak", - "social_media_account", + "source_code_secrets", + "bucket_object", + "forum_post", + "docker", + "bot", "bucket", - "seller", - "stealer_log", "chat_message", - "service", - "docker", - "google", "financial_data", - "forum_topic", - "stack_exchange", + "ransomleak", "ad", + "domain", + "google", + "source_code_files", "listing", - "ransomleak", - "paste", - "bucket_object", - "source_code_secrets", - "forum_post", + "stealer_log", + "social_media_account", + "service", + "forum_topic", "forum_profile", - "domain", - "bot", + "seller", + "stack_exchange", + "leak", "illicit_networks", "open_web", "buckets", @@ -6654,7 +6654,7 @@ "infected_devices", "social_media" ], - "example": "source_code_files", + "example": "paste", "type": "string" }, "type": "array" @@ -6741,10 +6741,6 @@ }, "Import": { "properties": { - "committed_at": { - "format": "date-time", - "type": "string" - }, "id": { "type": "integer" }, @@ -7060,6 +7056,9 @@ ], "type": "object" }, + "OrganizationHSProperties": { + "type": "object" + }, "OrganizationMember": { "properties": { "email": { @@ -7178,6 +7177,9 @@ }, "OrganizationSettings": { "properties": { + "hs_takedown_properties": { + "type": "object" + }, "permissions": { "items": { "type": "string" @@ -8259,4 +8261,4 @@ } }, "x-original-swagger-version": "2.0" -} +} \ No newline at end of file diff --git a/docs/api-reference/spec/firework-v2-swagger.json b/docs/api-reference/spec/firework-v2-swagger.json index 58a86c1..4846e58 100644 --- a/docs/api-reference/spec/firework-v2-swagger.json +++ b/docs/api-reference/spec/firework-v2-swagger.json @@ -646,29 +646,29 @@ "search_types": { "items": { "enum": [ - "source_code_files", + "paste", "blog_post", - "leak", - "social_media_account", + "source_code_secrets", + "bucket_object", + "forum_post", + "docker", + "bot", "bucket", - "seller", - "stealer_log", "chat_message", - "service", - "docker", - "google", "financial_data", - "forum_topic", - "stack_exchange", - "listing", "ransomleak", - "paste", - "bucket_object", - "source_code_secrets", - "forum_post", - "forum_profile", "domain", - "bot", + "google", + "source_code_files", + "listing", + "stealer_log", + "social_media_account", + "service", + "forum_topic", + "forum_profile", + "seller", + "stack_exchange", + "leak", "illicit_networks", "open_web", "buckets", @@ -681,7 +681,7 @@ "infected_devices", "social_media" ], - "example": "source_code_files", + "example": "paste", "type": "string" }, "type": "array" @@ -758,30 +758,30 @@ "search_types": { "items": { "enum": [ - "source_code_files", + "paste", "blog_post", - "leak", - "social_media_account", + "source_code_secrets", + "bucket_object", + "forum_post", + "docker", + "bot", "bucket", - "seller", - "stealer_log", "chat_message", - "service", - "docker", - "google", "financial_data", - "forum_topic", - "stack_exchange", + "ransomleak", "ad", + "domain", + "google", + "source_code_files", "listing", - "ransomleak", - "paste", - "bucket_object", - "source_code_secrets", - "forum_post", + "stealer_log", + "social_media_account", + "service", + "forum_topic", "forum_profile", - "domain", - "bot", + "seller", + "stack_exchange", + "leak", "illicit_networks", "open_web", "buckets", @@ -795,7 +795,7 @@ "infected_devices", "social_media" ], - "example": "source_code_files", + "example": "paste", "type": "string" }, "type": "array" @@ -902,8 +902,12 @@ "Import": { "properties": { "committed_at": { + "example": "nullable date", "format": "date-time", - "type": "string" + "type": [ + "string", + "null" + ] }, "id": { "type": "integer" @@ -1254,6 +1258,25 @@ ], "type": "object" }, + "OrganizationHSProperties": { + "properties": { + "annual_takedowns_used": { + "example": "nullable integer", + "type": [ + "integer", + "null" + ] + }, + "takedowns_in_subscription": { + "example": "nullable integer", + "type": [ + "integer", + "null" + ] + } + }, + "type": "object" + }, "OrganizationMember": { "properties": { "email": { @@ -1384,6 +1407,26 @@ }, "OrganizationSettings": { "properties": { + "demo_tenant_limit": { + "example": "nullable integer", + "type": [ + "integer", + "null" + ] + }, + "hs_takedown_properties": { + "anyOf": [ + { + "$ref": "#/definitions/OrganizationHSProperties" + }, + { + "type": [ + "object", + "null" + ] + } + ] + }, "permissions": { "items": { "type": "string" @@ -3783,7 +3826,7 @@ }, { "collectionFormat": "multi", - "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, illicit_networks, open_web, domains, 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, seller, stealer_log, forum_topic, ransomleak, chat_message, blog_post, listing, forum_post, forum_profile, bot\n- open_web: source_code_files, stack_exchange, social_media_account, bucket, paste, service, bucket_object, docker, source_code_secrets, google\n- leaks: leak\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, illicit_networks, open_web, domains, 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: listing, chat_message, financial_data, stealer_log, forum_post, blog_post, ransomleak, forum_topic, forum_profile, seller, bot\n- open_web: paste, docker, social_media_account, service, source_code_secrets, source_code_files, google, bucket, stack_exchange, bucket_object\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -4047,7 +4090,7 @@ }, { "collectionFormat": "multi", - "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, illicit_networks, open_web, domains, 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, seller, stealer_log, forum_topic, ransomleak, chat_message, blog_post, listing, forum_post, forum_profile, bot\n- open_web: source_code_files, stack_exchange, social_media_account, bucket, paste, service, bucket_object, docker, source_code_secrets, google\n- leaks: leak\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, illicit_networks, open_web, domains, 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: listing, chat_message, financial_data, stealer_log, forum_post, blog_post, ransomleak, forum_topic, forum_profile, seller, bot\n- open_web: paste, docker, social_media_account, service, source_code_secrets, source_code_files, google, bucket, stack_exchange, bucket_object\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -4481,7 +4524,7 @@ }, { "collectionFormat": "multi", - "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, illicit_networks, open_web, domains, 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, seller, stealer_log, forum_topic, ransomleak, chat_message, blog_post, listing, forum_post, forum_profile, bot\n- open_web: source_code_files, stack_exchange, social_media_account, bucket, paste, service, bucket_object, docker, source_code_secrets, google\n- leaks: leak\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, illicit_networks, open_web, domains, 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: listing, chat_message, financial_data, stealer_log, forum_post, blog_post, ransomleak, forum_topic, forum_profile, seller, bot\n- open_web: paste, docker, social_media_account, service, source_code_secrets, source_code_files, google, bucket, stack_exchange, bucket_object\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -4745,7 +4788,7 @@ }, { "collectionFormat": "multi", - "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, illicit_networks, open_web, domains, 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, seller, stealer_log, forum_topic, ransomleak, chat_message, blog_post, listing, forum_post, forum_profile, bot\n- open_web: source_code_files, stack_exchange, social_media_account, bucket, paste, service, bucket_object, docker, source_code_secrets, google\n- leaks: leak\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, illicit_networks, open_web, domains, 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: listing, chat_message, financial_data, stealer_log, forum_post, blog_post, ransomleak, forum_topic, forum_profile, seller, bot\n- open_web: paste, docker, social_media_account, service, source_code_secrets, source_code_files, google, bucket, stack_exchange, bucket_object\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -5054,7 +5097,7 @@ }, { "collectionFormat": "multi", - "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, illicit_networks, open_web, domains, 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, seller, stealer_log, forum_topic, ransomleak, chat_message, blog_post, listing, forum_post, forum_profile, bot\n- open_web: source_code_files, stack_exchange, social_media_account, bucket, paste, service, bucket_object, docker, source_code_secrets, google\n- leaks: leak\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, illicit_networks, open_web, domains, 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: listing, chat_message, financial_data, stealer_log, forum_post, blog_post, ransomleak, forum_topic, forum_profile, seller, bot\n- open_web: paste, docker, social_media_account, service, source_code_secrets, source_code_files, google, bucket, stack_exchange, bucket_object\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -5354,7 +5397,7 @@ }, { "collectionFormat": "multi", - "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, illicit_networks, open_web, domains, 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, seller, stealer_log, forum_topic, ransomleak, chat_message, blog_post, listing, forum_post, forum_profile, bot\n- open_web: source_code_files, stack_exchange, social_media_account, bucket, paste, service, bucket_object, docker, source_code_secrets, google\n- leaks: leak\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, illicit_networks, open_web, domains, 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: listing, chat_message, financial_data, stealer_log, forum_post, blog_post, ransomleak, forum_topic, forum_profile, seller, bot\n- open_web: paste, docker, social_media_account, service, source_code_secrets, source_code_files, google, bucket, stack_exchange, bucket_object\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -5588,7 +5631,7 @@ }, { "collectionFormat": "multi", - "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, illicit_networks, open_web, domains, 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, seller, stealer_log, forum_topic, ransomleak, chat_message, blog_post, listing, forum_post, forum_profile, bot\n- open_web: source_code_files, stack_exchange, social_media_account, bucket, paste, service, bucket_object, docker, source_code_secrets, google\n- leaks: leak\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, illicit_networks, open_web, domains, 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: listing, chat_message, financial_data, stealer_log, forum_post, blog_post, ransomleak, forum_topic, forum_profile, seller, bot\n- open_web: paste, docker, social_media_account, service, source_code_secrets, source_code_files, google, bucket, stack_exchange, bucket_object\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -6432,7 +6475,7 @@ }, { "collectionFormat": "multi", - "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, illicit_networks, open_web, domains, 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, seller, stealer_log, forum_topic, ransomleak, chat_message, blog_post, listing, forum_post, forum_profile, bot\n- open_web: source_code_files, stack_exchange, social_media_account, bucket, paste, service, bucket_object, docker, source_code_secrets, google\n- leaks: leak\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, illicit_networks, open_web, domains, 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: listing, chat_message, financial_data, stealer_log, forum_post, blog_post, ransomleak, forum_topic, forum_profile, seller, bot\n- open_web: paste, docker, social_media_account, service, source_code_secrets, source_code_files, google, bucket, stack_exchange, bucket_object\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -6680,7 +6723,7 @@ }, { "collectionFormat": "multi", - "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, illicit_networks, open_web, domains, 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, seller, stealer_log, forum_topic, ransomleak, chat_message, blog_post, listing, forum_post, forum_profile, bot\n- open_web: source_code_files, stack_exchange, social_media_account, bucket, paste, service, bucket_object, docker, source_code_secrets, google\n- leaks: leak\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, illicit_networks, open_web, domains, 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: listing, chat_message, financial_data, stealer_log, forum_post, blog_post, ransomleak, forum_topic, forum_profile, seller, bot\n- open_web: paste, docker, social_media_account, service, source_code_secrets, source_code_files, google, bucket, stack_exchange, bucket_object\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", diff --git a/docs/api-reference/spec/firework-v3-openapi.json b/docs/api-reference/spec/firework-v3-openapi.json index 9075b0b..eb23e74 100644 --- a/docs/api-reference/spec/firework-v3-openapi.json +++ b/docs/api-reference/spec/firework-v3-openapi.json @@ -250,6 +250,7 @@ "links_to_azure_tenant", "owns", "uses", + "consists_of", "related_to" ], "type": "string" @@ -278,9 +279,11 @@ "favicon", "screenshot", "azure_tenant", + "thread", "actor", "cve", - "identity" + "identity", + "forum_thread" ], "type": "string" } @@ -308,9 +311,11 @@ "favicon", "screenshot", "azure_tenant", + "thread", "actor", "cve", - "identity" + "identity", + "forum_thread" ], "type": "string" } @@ -478,7 +483,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, illicit_networks, open_web, domains, 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: bot, blog_post, financial_data, forum_profile, ransomleak, listing, stealer_log, chat_message, forum_topic, seller, forum_post\n- open_web: docker, source_code_files, stack_exchange, paste, source_code_secrets, bucket, google, bucket_object, service, social_media_account\n- leaks: leak\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, illicit_networks, open_web, domains, 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: listing, ransomleak, forum_post, forum_topic, bot, chat_message, seller, financial_data, blog_post, forum_profile, stealer_log\n- open_web: stack_exchange, bucket_object, source_code_secrets, bucket, google, docker, service, source_code_files, paste, social_media_account\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -798,7 +803,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, illicit_networks, open_web, domains, 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: bot, blog_post, financial_data, forum_profile, ransomleak, listing, stealer_log, chat_message, forum_topic, seller, forum_post\n- open_web: docker, source_code_files, stack_exchange, paste, source_code_secrets, bucket, google, bucket_object, service, social_media_account\n- leaks: leak\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, illicit_networks, open_web, domains, 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: listing, ransomleak, forum_post, forum_topic, bot, chat_message, seller, financial_data, blog_post, forum_profile, stealer_log\n- open_web: stack_exchange, bucket_object, source_code_secrets, bucket, google, docker, service, source_code_files, paste, social_media_account\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -1071,6 +1076,7 @@ "links_to_azure_tenant", "owns", "uses", + "consists_of", "related_to" ], "type": "string" @@ -1099,9 +1105,11 @@ "favicon", "screenshot", "azure_tenant", + "thread", "actor", "cve", - "identity" + "identity", + "forum_thread" ], "type": "string" } @@ -1775,9 +1783,11 @@ "favicon", "screenshot", "azure_tenant", + "thread", "actor", "cve", - "identity" + "identity", + "forum_thread" ], "example": "github_repository", "type": "string" @@ -1898,6 +1908,7 @@ "links_to_azure_tenant", "owns", "uses", + "consists_of", "related_to" ], "example": "subdomain_of", diff --git a/docs/api-reference/spec/firework-v3-swagger.json b/docs/api-reference/spec/firework-v3-swagger.json index f7da387..251e729 100644 --- a/docs/api-reference/spec/firework-v3-swagger.json +++ b/docs/api-reference/spec/firework-v3-swagger.json @@ -25,9 +25,11 @@ "favicon", "screenshot", "azure_tenant", + "thread", "actor", "cve", - "identity" + "identity", + "forum_thread" ], "example": "github_repository", "type": "string" @@ -147,6 +149,7 @@ "links_to_azure_tenant", "owns", "uses", + "consists_of", "related_to" ], "example": "subdomain_of", @@ -1130,6 +1133,7 @@ "links_to_azure_tenant", "owns", "uses", + "consists_of", "related_to" ], "in": "query", @@ -1156,9 +1160,11 @@ "favicon", "screenshot", "azure_tenant", + "thread", "actor", "cve", - "identity" + "identity", + "forum_thread" ], "in": "query", "name": "target_type", @@ -1184,9 +1190,11 @@ "favicon", "screenshot", "azure_tenant", + "thread", "actor", "cve", - "identity" + "identity", + "forum_thread" ], "in": "query", "name": "source_type", @@ -1318,7 +1326,7 @@ }, { "collectionFormat": "multi", - "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, illicit_networks, open_web, domains, 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: bot, blog_post, financial_data, forum_profile, ransomleak, listing, stealer_log, chat_message, forum_topic, seller, forum_post\n- open_web: docker, source_code_files, stack_exchange, paste, source_code_secrets, bucket, google, bucket_object, service, social_media_account\n- leaks: leak\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, illicit_networks, open_web, domains, 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: listing, ransomleak, forum_post, forum_topic, bot, chat_message, seller, financial_data, blog_post, forum_profile, stealer_log\n- open_web: stack_exchange, bucket_object, source_code_secrets, bucket, google, docker, service, source_code_files, paste, social_media_account\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -1582,7 +1590,7 @@ }, { "collectionFormat": "multi", - "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, illicit_networks, open_web, domains, 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: bot, blog_post, financial_data, forum_profile, ransomleak, listing, stealer_log, chat_message, forum_topic, seller, forum_post\n- open_web: docker, source_code_files, stack_exchange, paste, source_code_secrets, bucket, google, bucket_object, service, social_media_account\n- leaks: leak\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, illicit_networks, open_web, domains, 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: listing, ransomleak, forum_post, forum_topic, bot, chat_message, seller, financial_data, blog_post, forum_profile, stealer_log\n- open_web: stack_exchange, bucket_object, source_code_secrets, bucket, google, docker, service, source_code_files, paste, social_media_account\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -1803,6 +1811,7 @@ "links_to_azure_tenant", "owns", "uses", + "consists_of", "related_to" ], "in": "query", @@ -1829,9 +1838,11 @@ "favicon", "screenshot", "azure_tenant", + "thread", "actor", "cve", - "identity" + "identity", + "forum_thread" ], "in": "query", "name": "related_type", diff --git a/docs/api-reference/spec/firework-v4-openapi.json b/docs/api-reference/spec/firework-v4-openapi.json index 995f13f..bff0bbf 100644 --- a/docs/api-reference/spec/firework-v4-openapi.json +++ b/docs/api-reference/spec/firework-v4-openapi.json @@ -470,6 +470,16 @@ "type": "string", "title": "Restricted Term Id" } + }, + { + "name": "remove_related_requests", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": true, + "title": "Remove Related Requests" + } } ], "responses": { @@ -704,6 +714,382 @@ } } }, + "/firework/v4/admin/tenants/{tenant_id}/flare_community": { + "post": { + "tags": [ + "private" + ], + "summary": "Enable Tenant Flare Community", + "operationId": "enable_tenant_flare_community_admin_tenants__tenant_id__flare_community_post", + "parameters": [ + { + "name": "tenant_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Tenant Id" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "get": { + "tags": [ + "private" + ], + "summary": "Get Tenant Flare Community", + "operationId": "get_tenant_flare_community_admin_tenants__tenant_id__flare_community_get", + "parameters": [ + { + "name": "tenant_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Tenant Id" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantFlareCommunityIsEnabledResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "delete": { + "tags": [ + "private" + ], + "summary": "Disable Tenant Flare Community", + "operationId": "disable_tenant_flare_community_admin_tenants__tenant_id__flare_community_delete", + "parameters": [ + { + "name": "tenant_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Tenant Id" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/admin/tenants/{tenant_id}/flare_community/invite_link": { + "get": { + "tags": [ + "private" + ], + "summary": "Get Tenant Flare Community Invite Link", + "operationId": "get_tenant_flare_community_invite_link_admin_tenants__tenant_id__flare_community_invite_link_get", + "parameters": [ + { + "name": "tenant_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Tenant Id" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InviteLinkResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "post": { + "tags": [ + "private" + ], + "summary": "Create Invite Link", + "operationId": "create_invite_link_admin_tenants__tenant_id__flare_community_invite_link_post", + "parameters": [ + { + "name": "tenant_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Tenant Id" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FlareInviteLinkRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InviteLinkResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/admin/tenants/{tenant_id}/flare_community/users": { + "get": { + "tags": [ + "private" + ], + "summary": "Get Tenant Flare Community Users", + "operationId": "get_tenant_flare_community_users_admin_tenants__tenant_id__flare_community_users_get", + "parameters": [ + { + "name": "tenant_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Tenant Id" + } + }, + { + "name": "from_", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "From " + } + }, + { + "name": "size", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "default": 10, + "title": "Size" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaginatedResults_TenantFlareCommunityUser__int_" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/admin/tenants/{tenant_id}/flare_community/invite_link/{invite_link_id}": { + "delete": { + "tags": [ + "private" + ], + "summary": "Delete Invite Link", + "operationId": "delete_invite_link_admin_tenants__tenant_id__flare_community_invite_link__invite_link_id__delete", + "parameters": [ + { + "name": "invite_link_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Invite Link Id" + } + }, + { + "name": "tenant_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Tenant Id" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/admin/tenants/{tenant_id}/flare_community/users/{user_id}": { + "delete": { + "tags": [ + "private" + ], + "summary": "Delete User", + "operationId": "delete_user_admin_tenants__tenant_id__flare_community_users__user_id__delete", + "parameters": [ + { + "name": "user_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "User Id" + } + }, + { + "name": "tenant_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Tenant Id" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, "/firework/v4/admin/threat_flow/reports": { "get": { "tags": [ @@ -2701,8 +3087,8 @@ "tags": [ "public" ], - "summary": "Global Search", - "operationId": "global_search_credentials_global__search_post", + "summary": "Credentials Global Search", + "operationId": "credentials_global_search_credentials_global__search_post", "requestBody": { "content": { "application/json": { @@ -3157,9 +3543,55 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/Identifier" + "$ref": "#/components/schemas/Identifier" + }, + "title": "Response Get Matching Identifiers Events Matching Identifiers Get" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/events/identities": { + "get": { + "tags": [ + "private" + ], + "summary": "Get Identities", + "operationId": "get_identities_events_identities_get", + "parameters": [ + { + "name": "event_uid", + "in": "query", + "required": true, + "schema": { + "type": "string", + "title": "Event Uid" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IdentityProfileBanner" }, - "title": "Response Get Matching Identifiers Events Matching Identifiers Get" + "title": "Response Get Identities Events Identities Get" } } } @@ -3177,35 +3609,41 @@ } } }, - "/firework/v4/events/identities": { - "get": { + "/firework/v4/events/tenant/metadata": { + "patch": { "tags": [ - "private" + "public" ], - "summary": "Get Identities", - "operationId": "get_identities_events_identities_get", + "summary": "Update Tenant Metadata", + "operationId": "update_tenant_metadata_events_tenant_metadata_patch", "parameters": [ { - "name": "event_uid", + "name": "uid", "in": "query", "required": true, "schema": { "type": "string", - "title": "Event Uid" + "title": "Uid" } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateTenantMetadataBody" + } + } + } + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IdentityProfileBanner" - }, - "title": "Response Get Identities Events Identities Get" + "$ref": "#/components/schemas/TenantMetadataResponse" } } } @@ -4137,7 +4575,9 @@ }, "get": { "tags": [ - "public" + "public", + "team=experience", + "feature=identifiers" ], "summary": "Get Identifiers", "operationId": "get_identifiers_identifiers__get", @@ -6074,33 +6514,247 @@ } } }, - "/firework/v4/organizations/{organization_id}/demo_tenant": { + "/firework/v4/organizations/{organization_id}/demo_tenant": { + "post": { + "tags": [ + "private" + ], + "summary": "Create Demo Tenant", + "operationId": "create_demo_tenant_organizations__organization_id__demo_tenant_post", + "parameters": [ + { + "name": "organization_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Organization Id" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateDemoTenantRequestBody" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantPayload" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/organizations/{organization_id}/events/_stats": { + "get": { + "tags": [ + "private" + ], + "summary": "Get Event Stats", + "operationId": "get_event_stats_organizations__organization_id__events__stats_get", + "parameters": [ + { + "name": "organization_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Organization Id" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationEventStatsResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/query_assistant/fields": { + "get": { + "tags": [ + "private" + ], + "summary": "Get All Autocomplete Fields", + "operationId": "get_all_autocomplete_fields_query_assistant_fields_get", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AutocompletionFieldsPayload" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/query_assistant/terms": { + "get": { + "tags": [ + "private" + ], + "summary": "Get All Autocomplete Terms", + "operationId": "get_all_autocomplete_terms_query_assistant_terms_get", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AutocompletionTermsPayload" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/report_groups/": { + "get": { + "tags": [ + "private" + ], + "summary": "List Report Groups", + "operationId": "list_report_groups_report_groups__get", + "parameters": [ + { + "name": "from_", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "From " + } + }, + { + "name": "size", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "default": 20, + "title": "Size" + } + }, + { + "name": "include_archived", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false, + "title": "Include Archived" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaginatedResults_ReportGroupData__str_" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/report_groups": { "post": { "tags": [ "private" ], - "summary": "Create Demo Tenant", - "operationId": "create_demo_tenant_organizations__organization_id__demo_tenant_post", - "parameters": [ - { - "name": "organization_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Organization Id" - } - } - ], + "summary": "Create Report Group", + "operationId": "create_report_group_report_groups_post", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateDemoTenantRequestBody" + "$ref": "#/components/schemas/ReportGroupCreationPayload" } } - } + }, + "required": true }, "responses": { "200": { @@ -6108,7 +6762,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TenantPayload" + "$ref": "#/components/schemas/ReportGroupCreationResponse" } } } @@ -6126,21 +6780,21 @@ } } }, - "/firework/v4/organizations/{organization_id}/events/_stats": { + "/firework/v4/report_groups/{report_group_id}": { "get": { "tags": [ "private" ], - "summary": "Get Event Stats", - "operationId": "get_event_stats_organizations__organization_id__events__stats_get", + "summary": "Get Report Group", + "operationId": "get_report_group_report_groups__report_group_id__get", "parameters": [ { - "name": "organization_id", + "name": "report_group_id", "in": "path", "required": true, "schema": { "type": "integer", - "title": "Organization Id" + "title": "Report Group Id" } } ], @@ -6150,7 +6804,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrganizationEventStatsResponse" + "$ref": "#/components/schemas/ReportGroupData" } } } @@ -6166,54 +6820,30 @@ } } } - } - }, - "/firework/v4/query_assistant/fields": { - "get": { + }, + "delete": { "tags": [ "private" ], - "summary": "Get All Autocomplete Fields", - "operationId": "get_all_autocomplete_fields_query_assistant_fields_get", - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AutocompletionFieldsPayload" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "summary": "Delete Report Group", + "operationId": "delete_report_group_report_groups__report_group_id__delete", + "parameters": [ + { + "name": "report_group_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Report Group Id" } } - } - } - }, - "/firework/v4/query_assistant/terms": { - "get": { - "tags": [ - "private" ], - "summary": "Get All Autocomplete Terms", - "operationId": "get_all_autocomplete_terms_query_assistant_terms_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/AutocompletionTermsPayload" - } + "schema": {} } } }, @@ -6230,59 +6860,41 @@ } } }, - "/firework/v4/report_groups/": { - "get": { + "/firework/v4/report_groups/{report_group_id}/archive": { + "post": { "tags": [ + "private", "private" ], - "summary": "List Report Groups", - "operationId": "list_report_groups_report_groups__get", + "summary": "Archive Report Group", + "operationId": "archive_report_group_report_groups__report_group_id__archive_post", "parameters": [ { - "name": "from_", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From " - } - }, - { - "name": "size", - "in": "query", - "required": false, + "name": "report_group_id", + "in": "path", + "required": true, "schema": { "type": "integer", - "default": 20, - "title": "Size" - } - }, - { - "name": "include_archived", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false, - "title": "Include Archived" + "title": "Report Group Id" } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ArchiveReportGroupParams" + } + } + } + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_ReportGroupData__str_" - } + "schema": {} } } }, @@ -6377,13 +6989,13 @@ } } }, - "/firework/v4/report_groups/{report_group_id}/scheduler": { + "/firework/v4/report_groups/{report_group_id}/alert_channels": { "get": { "tags": [ "private" ], - "summary": "Get Report Scheduler", - "operationId": "get_report_scheduler_report_groups__report_group_id__scheduler_get", + "summary": "Get Report Alert Channels", + "operationId": "get_report_alert_channels_report_groups__report_group_id__alert_channels_get", "parameters": [ { "name": "report_group_id", @@ -6401,7 +7013,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ReportSchedulerData" + "type": "array", + "items": { + "$ref": "#/components/schemas/ReportAlertChannelData" + }, + "title": "Response Get Report Alert Channels Report Groups Report Group Id Alert Channels Get" } } } @@ -6422,8 +7038,8 @@ "tags": [ "private" ], - "summary": "Update Report Scheduler", - "operationId": "update_report_scheduler_report_groups__report_group_id__scheduler_patch", + "summary": "Update Report Alert Channels", + "operationId": "update_report_alert_channels_report_groups__report_group_id__alert_channels_patch", "parameters": [ { "name": "report_group_id", @@ -6440,7 +7056,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ReportSchedulerUpdatePayload" + "$ref": "#/components/schemas/ReportAlertChannelUpdatePayload" } } } @@ -6467,13 +7083,13 @@ } } }, - "/firework/v4/report_groups/{report_group_id}/alert_channels": { + "/firework/v4/report_groups/{report_group_id}/scheduler": { "get": { "tags": [ "private" ], - "summary": "Get Report Alert Channels", - "operationId": "get_report_alert_channels_report_groups__report_group_id__alert_channels_get", + "summary": "Get Report Scheduler", + "operationId": "get_report_scheduler_report_groups__report_group_id__scheduler_get", "parameters": [ { "name": "report_group_id", @@ -6491,11 +7107,7 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ReportAlertChannelData" - }, - "title": "Response Get Report Alert Channels Report Groups Report Group Id Alert Channels Get" + "$ref": "#/components/schemas/ReportSchedulerData" } } } @@ -6516,8 +7128,8 @@ "tags": [ "private" ], - "summary": "Update Report Alert Channels", - "operationId": "update_report_alert_channels_report_groups__report_group_id__alert_channels_patch", + "summary": "Update Report Scheduler", + "operationId": "update_report_scheduler_report_groups__report_group_id__scheduler_patch", "parameters": [ { "name": "report_group_id", @@ -6534,7 +7146,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ReportAlertChannelUpdatePayload" + "$ref": "#/components/schemas/ReportSchedulerUpdatePayload" } } } @@ -6561,13 +7173,13 @@ } } }, - "/firework/v4/reports/{report_id}": { + "/firework/v4/report_groups/{report_group_id}/reports/{report_id}": { "get": { "tags": [ "private" ], "summary": "Get Report", - "operationId": "get_report_reports__report_id__get", + "operationId": "get_report_report_groups__report_group_id__reports__report_id__get", "parameters": [ { "name": "report_id", @@ -6585,7 +7197,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/pyro__firework__backend__api4__reports__reports__report_datamodels__ReportResponse" + "$ref": "#/components/schemas/pyro__firework__backend__api4__reports__report_groups__reports__report_datamodels__ReportResponse" } } } @@ -6607,7 +7219,7 @@ "private" ], "summary": "Update Report", - "operationId": "update_report_reports__report_id__patch", + "operationId": "update_report_report_groups__report_group_id__reports__report_id__patch", "parameters": [ { "name": "report_id", @@ -6635,7 +7247,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/pyro__firework__backend__api4__reports__reports__report_datamodels__ReportResponse" + "$ref": "#/components/schemas/pyro__firework__backend__api4__reports__report_groups__reports__report_datamodels__ReportResponse" } } } @@ -6657,7 +7269,7 @@ "private" ], "summary": "Delete Report", - "operationId": "delete_report_reports__report_id__delete", + "operationId": "delete_report_report_groups__report_group_id__reports__report_id__delete", "parameters": [ { "name": "report_id", @@ -6675,7 +7287,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/pyro__firework__backend__api4__reports__reports__report_datamodels__ReportResponse" + "$ref": "#/components/schemas/pyro__firework__backend__api4__reports__report_groups__reports__report_datamodels__ReportResponse" } } } @@ -6693,13 +7305,13 @@ } } }, - "/firework/v4/reports/": { + "/firework/v4/report_groups/{report_group_id}/reports/": { "get": { "tags": [ "private" ], "summary": "List Reports", - "operationId": "list_reports_reports__get", + "operationId": "list_reports_report_groups__report_group_id__reports__get", "parameters": [ { "name": "from_", @@ -6809,31 +7421,32 @@ } } } - }, + } + }, + "/firework/v4/report_groups/{report_group_id}/reports/{report_id}/generate": { "post": { "tags": [ "private" ], - "summary": "Create Report", - "operationId": "create_report_reports__post", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportCreationPayload" - } + "summary": "Generate Report", + "operationId": "generate_report_report_groups__report_group_id__reports__report_id__generate_post", + "parameters": [ + { + "name": "report_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Report Id" } } - }, + ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/pyro__firework__backend__api4__reports__reports__report_datamodels__ReportResponse" - } + "schema": {} } } }, @@ -6850,13 +7463,13 @@ } } }, - "/firework/v4/reports/{report_id}/generate": { + "/firework/v4/report_groups/{report_group_id}/reports/{report_id}/generate_csv": { "post": { "tags": [ "private" ], - "summary": "Generate Report", - "operationId": "generate_report_reports__report_id__generate_post", + "summary": "Generate Report Csv", + "operationId": "generate_report_csv_report_groups__report_group_id__reports__report_id__generate_csv_post", "parameters": [ { "name": "report_id", @@ -6890,13 +7503,13 @@ } } }, - "/firework/v4/reports/{report_id}/generate_csv": { - "post": { + "/firework/v4/report_groups/{report_group_id}/reports/{report_id}/download": { + "get": { "tags": [ "private" ], - "summary": "Generate Report Csv", - "operationId": "generate_report_csv_reports__report_id__generate_csv_post", + "summary": "Download Report", + "operationId": "download_report_report_groups__report_group_id__reports__report_id__download_get", "parameters": [ { "name": "report_id", @@ -6906,6 +7519,21 @@ "type": "integer", "title": "Report Id" } + }, + { + "name": "format", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/ReportDownloadFormat", + "choices": [ + "docx", + "pdf", + "csv", + "zip" + ], + "default": "docx" + } } ], "responses": { @@ -6930,13 +7558,13 @@ } } }, - "/firework/v4/reports/{report_id}/config": { - "get": { + "/firework/v4/report_groups/{report_group_id}/reports/{report_id}/archive": { + "patch": { "tags": [ "private" ], - "summary": "Get Report Config", - "operationId": "get_report_config_reports__report_id__config_get", + "summary": "Archive Report", + "operationId": "archive_report_report_groups__report_group_id__reports__report_id__archive_patch", "parameters": [ { "name": "report_id", @@ -6954,7 +7582,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ReportConfigResponse" + "$ref": "#/components/schemas/pyro__firework__backend__api4__reports__report_groups__reports__report_datamodels__ReportResponse" } } } @@ -6970,13 +7598,15 @@ } } } - }, - "patch": { + } + }, + "/firework/v4/report_groups/{report_group_id}/reports/{report_id}/config": { + "get": { "tags": [ "private" ], - "summary": "Update Report Config", - "operationId": "update_report_config_reports__report_id__config_patch", + "summary": "Get Report Config", + "operationId": "get_report_config_report_groups__report_group_id__reports__report_id__config_get", "parameters": [ { "name": "report_id", @@ -6988,16 +7618,6 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportConfigUpdatePayload" - } - } - } - }, "responses": { "200": { "description": "Successful Response", @@ -7020,15 +7640,13 @@ } } } - } - }, - "/firework/v4/reports/{report_id}/download": { - "get": { + }, + "patch": { "tags": [ "private" ], - "summary": "Download Report", - "operationId": "download_report_reports__report_id__download_get", + "summary": "Update Report Config", + "operationId": "update_report_config_report_groups__report_group_id__reports__report_id__config_patch", "parameters": [ { "name": "report_id", @@ -7038,29 +7656,26 @@ "type": "integer", "title": "Report Id" } - }, - { - "name": "format", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/ReportDownloadFormat", - "choices": [ - "docx", - "pdf", - "csv", - "zip" - ], - "default": "docx" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReportConfigUpdatePayload" + } } } - ], + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/ReportConfigResponse" + } } } }, @@ -7077,13 +7692,13 @@ } } }, - "/firework/v4/reports/{report_id}/sections/{uid}": { + "/firework/v4/report_groups/{report_group_id}/reports/{report_id}/sections/{uid}": { "get": { "tags": [ "private" ], "summary": "Get Report Section", - "operationId": "get_report_section_reports__report_id__sections__uid__get", + "operationId": "get_report_section_report_groups__report_group_id__reports__report_id__sections__uid__get", "parameters": [ { "name": "uid", @@ -7133,7 +7748,7 @@ "private" ], "summary": "Update Report Section", - "operationId": "update_report_section_reports__report_id__sections__uid__patch", + "operationId": "update_report_section_report_groups__report_group_id__reports__report_id__sections__uid__patch", "parameters": [ { "name": "uid", @@ -7189,13 +7804,13 @@ } } }, - "/firework/v4/reports/{report_id}/sections": { + "/firework/v4/report_groups/{report_group_id}/reports/{report_id}/sections": { "get": { "tags": [ "private" ], "summary": "List Report Sections", - "operationId": "list_report_sections_reports__report_id__sections_get", + "operationId": "list_report_sections_report_groups__report_group_id__reports__report_id__sections_get", "parameters": [ { "name": "report_id", @@ -7259,14 +7874,24 @@ } } }, - "/firework/v4/reports/{report_id}/archive": { + "/firework/v4/report_groups/{report_group_id}/reports/{report_id}/sections/{uid}/summarize": { "patch": { "tags": [ "private" ], - "summary": "Archive Report", - "operationId": "archive_report_reports__report_id__archive_patch", + "summary": "Generate Summary", + "operationId": "generate_summary_report_groups__report_group_id__reports__report_id__sections__uid__summarize_patch", "parameters": [ + { + "name": "uid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Uid" + } + }, { "name": "report_id", "in": "path", @@ -7277,13 +7902,23 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReportGenerateSummaryPayload" + } + } + } + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/pyro__firework__backend__api4__reports__reports__report_datamodels__ReportResponse" + "$ref": "#/components/schemas/ReportSectionResponse" } } } @@ -7301,43 +7936,149 @@ } } }, - "/firework/v4/reports/{report_id}/summarize/{uid}": { - "patch": { + "/firework/v4/sources/activity-model-names": { + "post": { "tags": [ "private" ], - "summary": "Generate Summary", - "operationId": "generate_summary_reports__report_id__summarize__uid__patch", - "parameters": [ - { - "name": "uid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Uid" + "summary": "Get Activity Model Names Source Stats", + "operationId": "get_activity_model_names_source_stats_sources_activity_model_names_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActivityModelNameListParams" + } } }, - { - "name": "report_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Id" + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/ActivityModelNameSourceStats" + }, + "type": "array", + "title": "Response Get Activity Model Names Source Stats Sources Activity Model Names Post" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } } } + } + } + }, + "/firework/v4/sources/": { + "post": { + "tags": [ + "private" ], + "summary": "Get Source List", + "operationId": "get_source_list_sources__post", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ReportGenerateSummaryPayload" + "$ref": "#/components/schemas/SourceListParams" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaginatedSources" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/sources/count-by-status": { + "post": { + "tags": [ + "private" + ], + "summary": "Get Source Counts", + "operationId": "get_source_counts_sources_count_by_status_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SourceCountByStatusParams" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SourceCountByStatus" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } + } + } + }, + "/firework/v4/sources/count-by-year": { + "post": { + "tags": [ + "private" + ], + "summary": "Get Source Count By Year", + "operationId": "get_source_count_by_year_sources_count_by_year_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SourceCountByYearParams" + } + } + }, + "required": true }, "responses": { "200": { @@ -7345,7 +8086,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ReportSectionResponse" + "items": { + "$ref": "#/components/schemas/SourceCountByYear" + }, + "type": "array", + "title": "Response Get Source Count By Year Sources Count By Year Post" } } } @@ -7363,18 +8108,18 @@ } } }, - "/firework/v4/sources/": { + "/firework/v4/sources/histogram": { "post": { "tags": [ "private" ], - "summary": "Get Source List", - "operationId": "get_source_list_sources__post", + "summary": "Get Source Histogram", + "operationId": "get_source_histogram_sources_histogram_post", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SourceListParams" + "$ref": "#/components/schemas/SourceHistogramParams" } } }, @@ -7386,7 +8131,55 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedSources" + "$ref": "#/components/schemas/Histogram" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/sources/source-categories-histogram": { + "post": { + "tags": [ + "private" + ], + "summary": "Get Source Category Histograms", + "operationId": "get_source_category_histograms_sources_source_categories_histogram_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SourcesCategoriesStats" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "additionalProperties": { + "$ref": "#/components/schemas/CategoryStatsHistogram" + }, + "propertyNames": { + "$ref": "#/components/schemas/SourceCategoryV2" + }, + "type": "object", + "title": "Response Get Source Category Histograms Sources Source Categories Histogram Post" } } } @@ -8592,48 +9385,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ThreatFlowTenantConfigPayload" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/threat_flow/conversation_summary_requests/": { - "put": { - "tags": [ - "private" - ], - "summary": "Create Conversation Summary Request", - "operationId": "create_conversation_summary_request_threat_flow_conversation_summary_requests__put", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConversationSummaryRequestPayload" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConversationSummaryRequestResponse" + "$ref": "#/components/schemas/ThreatFlowTenantConfigPayload" } } } @@ -8649,57 +9401,32 @@ } } } - }, - "get": { + } + }, + "/firework/v4/threat_flow/conversation_summary_requests/": { + "post": { "tags": [ "private" ], - "summary": "List Conversation Summary Requests", - "operationId": "list_conversation_summary_requests_threat_flow_conversation_summary_requests__get", - "parameters": [ - { - "name": "from_", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From " - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "default": 10, - "title": "Size" + "summary": "Create Conversation Summary Request", + "operationId": "create_conversation_summary_request_threat_flow_conversation_summary_requests__post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConversationSummaryRequestPayload" + } } }, - { - "name": "order", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/OrderType", - "default": "desc" - } - } - ], + "required": true + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedResults_ConversationSummaryRequestResponse__str_" + "$ref": "#/components/schemas/ConversationSummaryRequestResponse" } } } @@ -9036,6 +9763,47 @@ } } } + }, + "/firework/v4/sandbox/submissions/{submission_uuid}/archive": { + "post": { + "tags": [ + "private" + ], + "summary": "Archive Submission", + "operationId": "archive_submission_sandbox_submissions__submission_uuid__archive_post", + "parameters": [ + { + "name": "submission_uuid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Submission Uuid" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } } }, "components": { @@ -9152,6 +9920,73 @@ ], "title": "ActivityModelName" }, + "ActivityModelNameListParams": { + "properties": { + "from": { + "type": "integer", + "title": "From", + "default": 0 + }, + "size": { + "type": "integer", + "title": "Size", + "default": 15 + }, + "order_by": { + "$ref": "#/components/schemas/SourceOrderBy", + "default": "title" + }, + "order_type": { + "$ref": "#/components/schemas/OrderType", + "default": "asc" + }, + "search_types": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/SearchType" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Search Types" + }, + "date_range": { + "$ref": "#/components/schemas/DateRangeType", + "default": "last_1m" + } + }, + "type": "object", + "title": "ActivityModelNameListParams" + }, + "ActivityModelNameSourceStats": { + "properties": { + "activity_model_name": { + "$ref": "#/components/schemas/ActivityModelName" + }, + "event_count": { + "type": "integer", + "title": "Event Count" + }, + "sources_stats": { + "additionalProperties": { + "type": "integer" + }, + "type": "object", + "title": "Sources Stats" + } + }, + "type": "object", + "required": [ + "activity_model_name", + "event_count", + "sources_stats" + ], + "title": "ActivityModelNameSourceStats" + }, "ActivityNode": { "properties": { "name": { @@ -10366,6 +11201,18 @@ }, "source": { "$ref": "#/components/schemas/AllowedRestrictedTermSource" + }, + "asset_uuid": { + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], + "title": "Asset Uuid" } }, "type": "object", @@ -10695,6 +11542,19 @@ ], "title": "ApplicationNode" }, + "ArchiveReportGroupParams": { + "properties": { + "is_archived": { + "type": "boolean", + "title": "Is Archived" + } + }, + "type": "object", + "required": [ + "is_archived" + ], + "title": "ArchiveReportGroupParams" + }, "Asset": { "properties": { "uuid": { @@ -10770,13 +11630,18 @@ "is_authorized": { "type": "boolean", "title": "Is Authorized" + }, + "is_restricted": { + "type": "boolean", + "title": "Is Restricted" } }, "type": "object", "required": [ "uuid", "data", - "is_authorized" + "is_authorized", + "is_restricted" ], "title": "Asset" }, @@ -10826,9 +11691,11 @@ "favicon", "screenshot", "azure_tenant", + "thread", "actor", "cve", - "identity" + "identity", + "forum_thread" ], "title": "AssetType" }, @@ -11298,7 +12165,8 @@ "identifier_recommendation", "identifier_recommendation_group", "credential", - "tenant_integration" + "tenant_integration", + "event" ], "title": "BulkActionTargetType" }, @@ -11364,7 +12232,7 @@ } ], "title": "Created After", - "default": "2025-11-09T16:28:39.927278Z" + "default": "2025-12-16T17:48:50.356717Z" }, "from": { "anyOf": [ @@ -11440,6 +12308,39 @@ ], "title": "CCBinData" }, + "CategoryStatsHistogram": { + "properties": { + "histogram": { + "additionalProperties": { + "type": "integer" + }, + "propertyNames": { + "format": "date-time" + }, + "type": "object", + "title": "Histogram" + }, + "event_count": { + "type": "integer", + "title": "Event Count" + }, + "category": { + "$ref": "#/components/schemas/SourceCategoryV2" + }, + "unique_sources": { + "type": "integer", + "title": "Unique Sources" + } + }, + "type": "object", + "required": [ + "histogram", + "event_count", + "category", + "unique_sources" + ], + "title": "CategoryStatsHistogram" + }, "ConversationMessage": { "properties": { "uid": { @@ -11655,6 +12556,31 @@ "type": "object", "title": "CookiesTenantSearchBody" }, + "CrawlingFrequency": { + "properties": { + "value": { + "type": "integer", + "title": "Value" + }, + "unit": { + "$ref": "#/components/schemas/CrawlingFrequencyUnit" + } + }, + "type": "object", + "required": [ + "value", + "unit" + ], + "title": "CrawlingFrequency" + }, + "CrawlingFrequencyUnit": { + "type": "string", + "enum": [ + "minute", + "hour" + ], + "title": "CrawlingFrequencyUnit" + }, "CreateAlert": { "properties": { "feed_definition": { @@ -12167,6 +13093,11 @@ ], "title": "Idp Verification States" }, + "first_occurrence_only": { + "type": "boolean", + "title": "First Occurrence Only", + "default": false + }, "feed_definition": { "$ref": "#/components/schemas/FeedDefinition" } @@ -12549,16 +13480,16 @@ "query": { "oneOf": [ { - "$ref": "#/components/schemas/pyro__firework__backend__api4__events__models__DomainQuery" + "$ref": "#/components/schemas/pyro__leaks__types__DomainQuery" }, { - "$ref": "#/components/schemas/pyro__leaks__types__EmailQuery" + "$ref": "#/components/schemas/pyro__firework__backend__api4__events__models__EmailQuery" }, { "$ref": "#/components/schemas/pyro__leaks__types__KeywordQuery" }, { - "$ref": "#/components/schemas/pyro__leaks__types__SecretQuery" + "$ref": "#/components/schemas/pyro__firework__backend__api4__events__models__SecretQuery" }, { "$ref": "#/components/schemas/AuthDomainQuery" @@ -12592,6 +13523,8 @@ }, "size": { "type": "integer", + "maximum": 10000.0, + "minimum": 1.0, "title": "Size", "default": 10 }, @@ -12624,25 +13557,16 @@ ], "title": "CredentialsQueryType" }, - "DateRange": { - "properties": { - "start": { - "type": "string", - "format": "date-time", - "title": "Start" - }, - "end": { - "type": "string", - "format": "date-time", - "title": "End" - } - }, - "type": "object", - "required": [ - "start", - "end" + "DateRangeType": { + "type": "string", + "enum": [ + "last_7d", + "last_1m", + "last_3m", + "last_6m", + "all_time" ], - "title": "DateRange" + "title": "DateRangeType" }, "DayOfWeekData": { "properties": { @@ -12900,12 +13824,16 @@ }, { "$ref": "#/components/schemas/TenantIntegrationFilters" + }, + { + "$ref": "#/components/schemas/EventFilters" } ], "discriminator": { "propertyName": "type", "mapping": { "credential": "#/components/schemas/CredentialFilters", + "event": "#/components/schemas/EventFilters", "group": "#/components/schemas/GroupFilters", "identifier": "#/components/schemas/IdentifierFilters", "identifier_recommendation": "#/components/schemas/IdentifierRecommendationFilters", @@ -13099,11 +14027,42 @@ } }, "type": "object", - "required": [ - "name", - "title" - ], - "title": "EnrichedSource" + "required": [ + "name", + "title" + ], + "title": "EnrichedSource" + }, + "EntraIDFailedValidationDetails": { + "properties": { + "invalid_parameter_field": { + "anyOf": [ + { + "$ref": "#/components/schemas/EntraIDInvalidParameterField" + }, + { + "type": "null" + } + ] + }, + "invalid_group_ids": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + { + "type": "null" + } + ], + "title": "Invalid Group Ids" + } + }, + "type": "object", + "title": "EntraIDFailedValidationDetails" }, "EntraIDFeature": { "type": "string", @@ -13118,6 +14077,15 @@ ], "title": "EntraIDFeature" }, + "EntraIDInvalidParameterField": { + "type": "string", + "enum": [ + "entra_client_id", + "entra_client_secret", + "entra_tenant_id" + ], + "title": "EntraIDInvalidParameterField" + }, "EntraIDParams": { "properties": { "params_type": { @@ -13134,6 +14102,17 @@ "type": "string", "title": "Entra Client Secret" }, + "entra_client_secret_encrypted": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Entra Client Secret Encrypted" + }, "entra_tenant_id": { "type": "string", "title": "Entra Tenant Id" @@ -13277,6 +14256,29 @@ ], "title": "EventActionsBody" }, + "EventFilters": { + "properties": { + "type": { + "type": "string", + "const": "event", + "title": "Type", + "default": "event" + }, + "event_uids": { + "items": { + "type": "string" + }, + "type": "array", + "minItems": 1, + "title": "Event Uids" + } + }, + "type": "object", + "required": [ + "event_uids" + ], + "title": "EventFilters" + }, "EventInput": { "properties": { "uid": { @@ -13829,7 +14831,7 @@ "$ref": "#/components/schemas/UsernameQuery" }, { - "$ref": "#/components/schemas/pyro__firework__backend__api4__events__models__DomainQuery" + "$ref": "#/components/schemas/pyro__leaks__types__DomainQuery" }, { "$ref": "#/components/schemas/BrandQuery" @@ -13850,10 +14852,10 @@ "$ref": "#/components/schemas/IpQuery" }, { - "$ref": "#/components/schemas/pyro__leaks__types__EmailQuery" + "$ref": "#/components/schemas/pyro__firework__backend__api4__events__models__EmailQuery" }, { - "$ref": "#/components/schemas/pyro__leaks__types__SecretQuery" + "$ref": "#/components/schemas/pyro__firework__backend__api4__events__models__SecretQuery" }, { "$ref": "#/components/schemas/CredentialsQuery" @@ -14041,6 +15043,27 @@ "type": "object", "title": "FilterSourceTypes" }, + "FlareInviteLinkRequest": { + "properties": { + "organization_name": { + "type": "string", + "title": "Organization Name" + }, + "domains": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Domains" + } + }, + "type": "object", + "required": [ + "organization_name", + "domains" + ], + "title": "FlareInviteLinkRequest" + }, "ForumThreadAnalysisMetadataResponse": { "properties": { "summarized_at": { @@ -14467,7 +15490,7 @@ "$ref": "#/components/schemas/UsernameQuery" }, { - "$ref": "#/components/schemas/pyro__firework__backend__api4__events__models__DomainQuery" + "$ref": "#/components/schemas/pyro__leaks__types__DomainQuery" }, { "$ref": "#/components/schemas/BrandQuery" @@ -14488,10 +15511,10 @@ "$ref": "#/components/schemas/IpQuery" }, { - "$ref": "#/components/schemas/pyro__leaks__types__EmailQuery" + "$ref": "#/components/schemas/pyro__firework__backend__api4__events__models__EmailQuery" }, { - "$ref": "#/components/schemas/pyro__leaks__types__SecretQuery" + "$ref": "#/components/schemas/pyro__firework__backend__api4__events__models__SecretQuery" }, { "$ref": "#/components/schemas/CredentialsQuery" @@ -14784,6 +15807,30 @@ ], "title": "HeatmapAnalysisOutput" }, + "Histogram": { + "properties": { + "histogram": { + "additionalProperties": { + "type": "integer" + }, + "propertyNames": { + "format": "date-time" + }, + "type": "object", + "title": "Histogram" + }, + "event_count": { + "type": "integer", + "title": "Event Count" + } + }, + "type": "object", + "required": [ + "histogram", + "event_count" + ], + "title": "Histogram" + }, "HourData": { "properties": { "hour": { @@ -16317,6 +17364,19 @@ ], "title": "IndicatorType" }, + "InviteLinkResponse": { + "properties": { + "invite_magic_link": { + "type": "string", + "title": "Invite Magic Link" + } + }, + "type": "object", + "required": [ + "invite_magic_link" + ], + "title": "InviteLinkResponse" + }, "IpQuery": { "properties": { "type": { @@ -16794,34 +17854,6 @@ ], "title": "PaginatedResults[Alert, str]" }, - "PaginatedResults_ConversationSummaryRequestResponse__str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/ConversationSummaryRequestResponse" - }, - "type": "array", - "title": "Items" - }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[ConversationSummaryRequestResponse, str]" - }, "PaginatedResults_CredentialValidationReponse__str_": { "properties": { "items": { @@ -17298,6 +18330,34 @@ ], "title": "PaginatedResults[SourceWithTenantCount, str]" }, + "PaginatedResults_TenantFlareCommunityUser__int_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/TenantFlareCommunityUser" + }, + "type": "array", + "title": "Items" + }, + "next": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[TenantFlareCommunityUser, int]" + }, "PaginatedResults_TenantIntegrationItem__str_": { "properties": { "items": { @@ -18489,31 +19549,6 @@ "type": "object", "title": "ReportConfigUpdatePayload" }, - "ReportCreationPayload": { - "properties": { - "title": { - "type": "string", - "minLength": 1, - "title": "Title" - }, - "author": { - "type": "string", - "minLength": 1, - "title": "Author" - }, - "time_zone": { - "type": "string", - "title": "Time Zone", - "default": "Etc/UTC" - } - }, - "type": "object", - "required": [ - "title", - "author" - ], - "title": "ReportCreationPayload" - }, "ReportData": { "properties": { "id": { @@ -18812,6 +19847,49 @@ "type": "object", "title": "ReportGenerateSummaryPayload" }, + "ReportGroupCreationPayload": { + "properties": { + "title": { + "type": "string", + "minLength": 1, + "title": "Title" + }, + "author": { + "type": "string", + "minLength": 1, + "title": "Author" + }, + "time_zone": { + "type": "string", + "title": "Time Zone", + "default": "Etc/UTC" + } + }, + "type": "object", + "required": [ + "title", + "author" + ], + "title": "ReportGroupCreationPayload" + }, + "ReportGroupCreationResponse": { + "properties": { + "report_group_id": { + "type": "integer", + "title": "Report Group Id" + }, + "report_id": { + "type": "integer", + "title": "Report Id" + } + }, + "type": "object", + "required": [ + "report_group_id", + "report_id" + ], + "title": "ReportGroupCreationResponse" + }, "ReportGroupData": { "properties": { "id": { @@ -19453,6 +20531,10 @@ }, "verdict": { "$ref": "#/components/schemas/SandboxSubmissionVerdict" + }, + "is_archived": { + "type": "boolean", + "title": "Is Archived" } }, "type": "object", @@ -19470,7 +20552,8 @@ "size", "submitted_at", "report_status", - "verdict" + "verdict", + "is_archived" ], "title": "SandboxSampleSubmission" }, @@ -20143,6 +21226,10 @@ "type": "string", "title": "Category" }, + "category_v2": { + "type": "string", + "title": "Category V2" + }, "crawled_since": { "anyOf": [ { @@ -20168,7 +21255,7 @@ "title": "Last Updated At" }, "status": { - "$ref": "#/components/schemas/SourceStatus" + "$ref": "#/components/schemas/SourceStatusV2" }, "event_count": { "anyOf": [ @@ -20180,34 +21267,156 @@ } ], "title": "Event Count" + }, + "total_event_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Total Event Count" + }, + "is_new": { + "type": "boolean", + "title": "Is New" + }, + "crawling_frequency": { + "$ref": "#/components/schemas/CrawlingFrequency" + } + }, + "type": "object", + "required": [ + "sphere", + "title", + "category", + "category_v2", + "crawled_since", + "last_updated_at", + "status", + "event_count", + "total_event_count", + "is_new", + "crawling_frequency" + ], + "title": "Source" + }, + "SourceCategoryV2": { + "type": "string", + "enum": [ + "Stealer Logs", + "Leaked Credentials", + "Forums", + "Imageboards", + "Messaging Apps", + "Darkweb Rooms", + "Ransomware", + "Financial Data", + "Infected Devices", + "Listings", + "Blogs", + "Doxing", + "Defacement", + "Pastes", + "Open Web" + ], + "title": "SourceCategoryV2" + }, + "SourceCountByStatus": { + "properties": { + "total_count": { + "type": "integer", + "title": "Total Count" + }, + "new_count": { + "type": "integer", + "title": "New Count" + }, + "offline_count": { + "type": "integer", + "title": "Offline Count" + }, + "defunct_count": { + "type": "integer", + "title": "Defunct Count" + } + }, + "type": "object", + "required": [ + "total_count", + "new_count", + "offline_count", + "defunct_count" + ], + "title": "SourceCountByStatus" + }, + "SourceCountByStatusParams": { + "properties": { + "date_range": { + "$ref": "#/components/schemas/DateRangeType", + "default": "last_1m" + } + }, + "type": "object", + "title": "SourceCountByStatusParams" + }, + "SourceCountByYear": { + "properties": { + "year": { + "type": "integer", + "title": "Year" + }, + "count": { + "type": "integer", + "title": "Count" + } + }, + "type": "object", + "required": [ + "year", + "count" + ], + "title": "SourceCountByYear" + }, + "SourceCountByYearParams": { + "properties": { + "start_year": { + "type": "integer", + "title": "Start Year" } }, "type": "object", "required": [ - "sphere", - "title", - "category", - "crawled_since", - "last_updated_at", - "status", - "event_count" + "start_year" ], - "title": "Source" + "title": "SourceCountByYearParams" }, - "SourceCategory": { + "SourceFilterByDateRange": { "type": "string", "enum": [ - "Autoshop", - "Imageboard", - "Illicit Blog", - "Illicit Forum", - "Illicit Market", - "Illicit - Other", - "Open Web", - "Paste Site", - "Ransom Blog" - ], - "title": "SourceCategory" + "crawled_since", + "last_updated_at" + ], + "title": "SourceFilterByDateRange" + }, + "SourceHistogramParams": { + "properties": { + "date_range": { + "$ref": "#/components/schemas/DateRangeType" + }, + "timezone": { + "type": "string", + "title": "Timezone", + "default": "America/New_York" + } + }, + "type": "object", + "required": [ + "date_range" + ], + "title": "SourceHistogramParams" }, "SourceListParams": { "properties": { @@ -20221,6 +21430,10 @@ "title": "Size", "default": 15 }, + "order_by": { + "$ref": "#/components/schemas/SourceOrderBy", + "default": "title" + }, "order_type": { "$ref": "#/components/schemas/OrderType", "default": "asc" @@ -20236,20 +21449,24 @@ ], "title": "Q" }, - "category": { + "categories": { "anyOf": [ { - "$ref": "#/components/schemas/SourceCategory" + "items": { + "$ref": "#/components/schemas/SourceCategoryV2" + }, + "type": "array" }, { "type": "null" } - ] + ], + "title": "Categories" }, "status": { "anyOf": [ { - "$ref": "#/components/schemas/SourceStatus" + "$ref": "#/components/schemas/SourceStatusV2" }, { "type": "null" @@ -20257,30 +21474,46 @@ ] }, "date_range": { + "$ref": "#/components/schemas/DateRangeType", + "default": "last_1m" + }, + "filter_by_date_range": { "anyOf": [ { - "type": "integer" + "$ref": "#/components/schemas/SourceFilterByDateRange" }, { - "$ref": "#/components/schemas/DateRange" + "type": "null" } - ], - "title": "Date Range", - "default": 30 + ] } }, "type": "object", "title": "SourceListParams" }, - "SourceStatus": { + "SourceOrderBy": { + "type": "string", + "enum": [ + "title", + "category_v2", + "status", + "crawled_since", + "last_updated_at", + "event_count", + "total_event_count" + ], + "title": "SourceOrderBy" + }, + "SourceStatusV2": { "type": "string", "enum": [ + "inactive", "active", "degraded", "offline", "defunct" ], - "title": "SourceStatus" + "title": "SourceStatusV2" }, "SourceSummary": { "properties": { @@ -20493,6 +21726,26 @@ ], "title": "SourceWithTenantCount" }, + "SourcesCategoriesStats": { + "properties": { + "categories": { + "items": { + "$ref": "#/components/schemas/SourceCategoryV2" + }, + "type": "array", + "title": "Categories", + "default": [] + }, + "date_range": { + "$ref": "#/components/schemas/DateRangeType" + } + }, + "type": "object", + "required": [ + "date_range" + ], + "title": "SourcesCategoriesStats" + }, "StatsAggregates": { "type": "string", "enum": [ @@ -20512,12 +21765,17 @@ "can_download_files": { "type": "boolean", "title": "Can Download Files" + }, + "can_display_pii_tags": { + "type": "boolean", + "title": "Can Display Pii Tags" } }, "type": "object", "required": [ "can_reveal_full_contents", - "can_download_files" + "can_download_files", + "can_display_pii_tags" ], "title": "StealerLogActions" }, @@ -20763,6 +22021,37 @@ ], "title": "TagPayload" }, + "TenantFlareCommunityIsEnabledResponse": { + "properties": { + "flare_community_enabled": { + "type": "boolean", + "title": "Flare Community Enabled" + } + }, + "type": "object", + "required": [ + "flare_community_enabled" + ], + "title": "TenantFlareCommunityIsEnabledResponse" + }, + "TenantFlareCommunityUser": { + "properties": { + "id": { + "type": "integer", + "title": "Id" + }, + "primary_email": { + "type": "string", + "title": "Primary Email" + } + }, + "type": "object", + "required": [ + "id", + "primary_email" + ], + "title": "TenantFlareCommunityUser" + }, "TenantIndustry": { "type": "string", "enum": [ @@ -20892,6 +22181,16 @@ "type": "integer", "title": "Failed Attempts", "default": 0 + }, + "failed_validation_details": { + "anyOf": [ + { + "$ref": "#/components/schemas/EntraIDFailedValidationDetails" + }, + { + "type": "null" + } + ] } }, "type": "object", @@ -20925,6 +22224,16 @@ } ], "title": "Message" + }, + "failed_validation_details": { + "anyOf": [ + { + "$ref": "#/components/schemas/EntraIDFailedValidationDetails" + }, + { + "type": "null" + } + ] } }, "type": "object", @@ -20941,6 +22250,51 @@ ], "title": "TenantIntegrationType" }, + "TenantMetadataResponse": { + "properties": { + "uid": { + "type": "string", + "title": "Uid" + }, + "notes": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Notes" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Tags" + }, + "severity": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Severity" + } + }, + "type": "object", + "required": [ + "uid", + "notes", + "tags", + "severity" + ], + "title": "TenantMetadataResponse" + }, "TenantPayload": { "properties": { "id": { @@ -21167,6 +22521,14 @@ "identities_limit": { "type": "integer", "title": "Identities Limit" + }, + "sandbox_submissions_usage": { + "type": "integer", + "title": "Sandbox Submissions Usage" + }, + "sandbox_submissions_limit": { + "type": "integer", + "title": "Sandbox Submissions Limit" } }, "type": "object", @@ -21179,7 +22541,9 @@ "global_search_calls_count", "identifier_rotation_count", "identifier_rotation_limit", - "identities_limit" + "identities_limit", + "sandbox_submissions_usage", + "sandbox_submissions_limit" ], "title": "TenantWithEnrichmentsPayload" }, @@ -21666,18 +23030,14 @@ "title": "Name" }, "is_enabled": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], + "type": "boolean", "title": "Is Enabled" } }, "type": "object", + "required": [ + "is_enabled" + ], "title": "UpdatePartialTenantIntegrationPayload" }, "UpdateReportParameters": { @@ -21850,6 +23210,47 @@ ], "title": "UpdateTenantIntegrationPayload" }, + "UpdateTenantMetadataBody": { + "properties": { + "tags": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Tags" + }, + "severity": { + "anyOf": [ + { + "$ref": "#/components/schemas/Severity" + }, + { + "type": "null" + } + ] + }, + "notes": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Notes" + } + }, + "type": "object", + "title": "UpdateTenantMetadataBody" + }, "UpdateTenantRequestBody": { "properties": { "name": { @@ -21965,7 +23366,6 @@ "view_legacy_footprint", "firework.identifiers.discovery_policy", "integrations", - "idp_credential_validation", "alert_channels", "ioc_feeds", "query_identifier_count_legacy", @@ -21975,6 +23375,7 @@ "phishing_content", "disable_search_restrictions", "firework.global_search_package_quota_only_count_api", + "enforce_global_search_limit", "mask_pii", "disable_rate_limit_csm_notification", "referrals_hidden", @@ -22150,26 +23551,45 @@ ], "title": "AuthorizationResponse" }, - "pyro__firework__backend__api4__events__models__DomainQuery": { + "pyro__firework__backend__api4__events__models__EmailQuery": { "properties": { "type": { "type": "string", - "const": "domain", + "const": "email", "title": "Type" }, - "fqdn": { + "email": { "type": "string", - "title": "Fqdn" + "title": "Email" } }, "type": "object", "required": [ "type", - "fqdn" + "email" ], - "title": "DomainQuery" + "title": "EmailQuery" + }, + "pyro__firework__backend__api4__events__models__SecretQuery": { + "properties": { + "type": { + "type": "string", + "const": "secret", + "title": "Type" + }, + "secret": { + "type": "string", + "title": "Secret" + } + }, + "type": "object", + "required": [ + "type", + "secret" + ], + "title": "SecretQuery" }, - "pyro__firework__backend__api4__reports__reports__report_datamodels__ReportResponse": { + "pyro__firework__backend__api4__reports__report_groups__reports__report_datamodels__ReportResponse": { "properties": { "report": { "$ref": "#/components/schemas/Report" @@ -22181,24 +23601,24 @@ ], "title": "ReportResponse" }, - "pyro__leaks__types__EmailQuery": { + "pyro__leaks__types__DomainQuery": { "properties": { "type": { "type": "string", - "const": "email", + "const": "domain", "title": "Type" }, - "email": { + "fqdn": { "type": "string", - "title": "Email" + "title": "Fqdn" } }, "type": "object", "required": [ "type", - "email" + "fqdn" ], - "title": "EmailQuery" + "title": "DomainQuery" }, "pyro__leaks__types__KeywordQuery": { "properties": { @@ -22219,25 +23639,6 @@ ], "title": "KeywordQuery" }, - "pyro__leaks__types__SecretQuery": { - "properties": { - "type": { - "type": "string", - "const": "secret", - "title": "Type" - }, - "secret": { - "type": "string", - "title": "Secret" - } - }, - "type": "object", - "required": [ - "type", - "secret" - ], - "title": "SecretQuery" - }, "pyro__reports__report_store__SortType": { "type": "string", "enum": [ diff --git a/docs/api-reference/v4/endpoints/public/update-tenant-metadata.mdx b/docs/api-reference/v4/endpoints/public/update-tenant-metadata.mdx new file mode 100644 index 0000000..afa5db7 --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/update-tenant-metadata.mdx @@ -0,0 +1,3 @@ +--- +openapi: patch /firework/v4/events/tenant/metadata +--- \ No newline at end of file diff --git a/docs/docs.json b/docs/docs.json index c66bea0..c7f8e8e 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -207,7 +207,8 @@ "api-reference/v2/endpoints/tenants/post-fireworkv2tenants-archive", "api-reference/v2/endpoints/tenants/get-fireworkv2tenants-users", "api-reference/v2/endpoints/tenants/post-fireworkv2tenants-users", - "api-reference/v2/endpoints/tenants/delete-fireworkv2tenants-users" + "api-reference/v2/endpoints/tenants/delete-fireworkv2tenants-users", + "api-reference/v4/endpoints/public/update-tenant-metadata" ] } ] From 328f93658be29dc55eabfcf977d07474c832a0f3 Mon Sep 17 00:00:00 2001 From: Gabrielle Rouillard Date: Thu, 18 Dec 2025 16:48:18 -0500 Subject: [PATCH 2/2] update name for Update Event Metadata --- docs/api-reference/spec/firework-v4-openapi.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-reference/spec/firework-v4-openapi.json b/docs/api-reference/spec/firework-v4-openapi.json index bff0bbf..43bce0a 100644 --- a/docs/api-reference/spec/firework-v4-openapi.json +++ b/docs/api-reference/spec/firework-v4-openapi.json @@ -3614,7 +3614,7 @@ "tags": [ "public" ], - "summary": "Update Tenant Metadata", + "summary": "Update Event metadata", "operationId": "update_tenant_metadata_events_tenant_metadata_patch", "parameters": [ {