From 5cfa89bb282c1bfced8cb8e5181a55191f70ca5f Mon Sep 17 00:00:00 2001 From: Maxime Goyette Date: Mon, 2 Feb 2026 15:02:29 -0500 Subject: [PATCH] Add expand-event-field page. --- .../spec/firework-v2-openapi.json | 194 +- .../spec/firework-v2-swagger.json | 806 ++-- .../spec/firework-v3-openapi.json | 10 +- .../spec/firework-v3-swagger.json | 10 +- .../spec/firework-v4-openapi.json | 3659 ++++++++++++----- .../v4/endpoints/expand-event-field.mdx | 20 + docs/snippets/event_expand_field_examples.mdx | 38 + .../event_expand_field_valid_fields.mdx | 12 + 8 files changed, 3255 insertions(+), 1494 deletions(-) create mode 100644 docs/api-reference/v4/endpoints/expand-event-field.mdx create mode 100644 docs/snippets/event_expand_field_examples.mdx create mode 100644 docs/snippets/event_expand_field_valid_fields.mdx diff --git a/docs/api-reference/spec/firework-v2-openapi.json b/docs/api-reference/spec/firework-v2-openapi.json index 0ff9189..efadc47 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: forum_topic, chat_message, blog_post, forum_profile, listing, ransomleak, forum_post, stealer_log, seller, financial_data, bot\n- open_web: source_code_secrets, docker, bucket, paste, bucket_object, service, stack_exchange, source_code_files, google, 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: stealer_log, listing, forum_topic, forum_post, financial_data, chat_message, ransomleak, blog_post, forum_profile, seller, bot\n- open_web: source_code_secrets, source_code_files, service, social_media_account, docker, bucket, google, bucket_object, paste, stack_exchange\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: forum_topic, chat_message, blog_post, forum_profile, listing, ransomleak, forum_post, stealer_log, seller, financial_data, bot\n- open_web: source_code_secrets, docker, bucket, paste, bucket_object, service, stack_exchange, source_code_files, google, 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: stealer_log, listing, forum_topic, forum_post, financial_data, chat_message, ransomleak, blog_post, forum_profile, seller, bot\n- open_web: source_code_secrets, source_code_files, service, social_media_account, docker, bucket, google, bucket_object, paste, stack_exchange\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: forum_topic, chat_message, blog_post, forum_profile, listing, ransomleak, forum_post, stealer_log, seller, financial_data, bot\n- open_web: source_code_secrets, docker, bucket, paste, bucket_object, service, stack_exchange, source_code_files, google, 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: stealer_log, listing, forum_topic, forum_post, financial_data, chat_message, ransomleak, blog_post, forum_profile, seller, bot\n- open_web: source_code_secrets, source_code_files, service, social_media_account, docker, bucket, google, bucket_object, paste, stack_exchange\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: forum_topic, chat_message, blog_post, forum_profile, listing, ransomleak, forum_post, stealer_log, seller, financial_data, bot\n- open_web: source_code_secrets, docker, bucket, paste, bucket_object, service, stack_exchange, source_code_files, google, 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: stealer_log, listing, forum_topic, forum_post, financial_data, chat_message, ransomleak, blog_post, forum_profile, seller, bot\n- open_web: source_code_secrets, source_code_files, service, social_media_account, docker, bucket, google, bucket_object, paste, stack_exchange\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: forum_topic, chat_message, blog_post, forum_profile, listing, ransomleak, forum_post, stealer_log, seller, financial_data, bot\n- open_web: source_code_secrets, docker, bucket, paste, bucket_object, service, stack_exchange, source_code_files, google, 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: stealer_log, listing, forum_topic, forum_post, financial_data, chat_message, ransomleak, blog_post, forum_profile, seller, bot\n- open_web: source_code_secrets, source_code_files, service, social_media_account, docker, bucket, google, bucket_object, paste, stack_exchange\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: forum_topic, chat_message, blog_post, forum_profile, listing, ransomleak, forum_post, stealer_log, seller, financial_data, bot\n- open_web: source_code_secrets, docker, bucket, paste, bucket_object, service, stack_exchange, source_code_files, google, 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: stealer_log, listing, forum_topic, forum_post, financial_data, chat_message, ransomleak, blog_post, forum_profile, seller, bot\n- open_web: source_code_secrets, source_code_files, service, social_media_account, docker, bucket, google, bucket_object, paste, stack_exchange\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: forum_topic, chat_message, blog_post, forum_profile, listing, ransomleak, forum_post, stealer_log, seller, financial_data, bot\n- open_web: source_code_secrets, docker, bucket, paste, bucket_object, service, stack_exchange, source_code_files, google, 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: stealer_log, listing, forum_topic, forum_post, financial_data, chat_message, ransomleak, blog_post, forum_profile, seller, bot\n- open_web: source_code_secrets, source_code_files, service, social_media_account, docker, bucket, google, bucket_object, paste, stack_exchange\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -4539,6 +4539,46 @@ "x-codegen-request-body-name": "payload" } }, + "/firework/v2/organizations/{organization_id}/members/count": { + "get": { + "operationId": "get_organization_members_count_api_/organizations//members/count", + "parameters": [ + { + "in": "path", + "name": "organization_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Organization not found" + }, + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationMembersCount" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "organizations" + ] + } + }, "/firework/v2/organizations/{organization_id}/members/{user_id}": { "get": { "operationId": "get_organization_member_api_/organizations//members/", @@ -4798,6 +4838,29 @@ "schema": { "type": "string" } + }, + { + "explode": true, + "in": "query", + "name": "types[]", + "schema": { + "enum": [ + "regular", + "service-firm", + "micro", + "starter", + "essential", + "core", + "enterprise", + "demo", + "training" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "responses": { @@ -5122,7 +5185,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: forum_topic, chat_message, blog_post, forum_profile, listing, ransomleak, forum_post, stealer_log, seller, financial_data, bot\n- open_web: source_code_secrets, docker, bucket, paste, bucket_object, service, stack_exchange, source_code_files, google, 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: stealer_log, listing, forum_topic, forum_post, financial_data, chat_message, ransomleak, blog_post, forum_profile, seller, bot\n- open_web: source_code_secrets, source_code_files, service, social_media_account, docker, bucket, google, bucket_object, paste, stack_exchange\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -5422,7 +5485,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: forum_topic, chat_message, blog_post, forum_profile, listing, ransomleak, forum_post, stealer_log, seller, financial_data, bot\n- open_web: source_code_secrets, docker, bucket, paste, bucket_object, service, stack_exchange, source_code_files, google, 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: stealer_log, listing, forum_topic, forum_post, financial_data, chat_message, ransomleak, blog_post, forum_profile, seller, bot\n- open_web: source_code_secrets, source_code_files, service, social_media_account, docker, bucket, google, bucket_object, paste, stack_exchange\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -5968,29 +6031,29 @@ "items": { "enum": [ "domain", - "stealer_log", - "ad", "source_code_secrets", - "bucket", - "bucket_object", - "listing", - "google", - "social_media_account", + "source_code_files", "forum_topic", - "leak", "docker", - "paste", + "financial_data", + "chat_message", + "seller", "blog_post", "forum_profile", + "bot", + "stealer_log", + "paste", + "social_media_account", + "google", "service", - "ransomleak", - "source_code_files", + "listing", + "ad", + "bucket", "forum_post", - "seller", - "chat_message", + "ransomleak", + "bucket_object", + "leak", "stack_exchange", - "financial_data", - "bot", "illicit_networks", "open_web", "buckets", @@ -6068,28 +6131,28 @@ "items": { "enum": [ "domain", - "stealer_log", "source_code_secrets", - "bucket", - "bucket_object", - "listing", - "google", - "social_media_account", + "source_code_files", "forum_topic", - "leak", "docker", - "paste", + "financial_data", + "chat_message", + "seller", "blog_post", "forum_profile", + "bot", + "stealer_log", + "paste", + "social_media_account", + "google", "service", - "ransomleak", - "source_code_files", + "listing", + "bucket", "forum_post", - "seller", - "chat_message", + "ransomleak", + "bucket_object", + "leak", "stack_exchange", - "financial_data", - "bot", "illicit_networks", "open_web", "buckets", @@ -6467,17 +6530,6 @@ }, "type": "object" }, - "TenantWithCounts": { - "properties": { - "next": { - "type": "string" - }, - "items": { - "$ref": "#/components/schemas/TenantWithCounts" - } - }, - "type": "object" - }, "Tenant": { "properties": { "id": { @@ -6537,6 +6589,17 @@ }, "type": "object" }, + "TenantWithCounts": { + "properties": { + "next": { + "type": "string" + }, + "items": { + "$ref": "#/components/schemas/TenantWithCounts" + } + }, + "type": "object" + }, "UpdatedPermission": { "properties": { "updated_value": { @@ -6643,17 +6706,6 @@ ], "type": "object" }, - "OrganizationMemberPage": { - "properties": { - "members": { - "items": { - "$ref": "#/components/schemas/OrganizationMemberWithMetadata" - }, - "type": "array" - } - }, - "type": "object" - }, "OrganizationMemberWithMetadata": { "properties": { "user": { @@ -6707,6 +6759,25 @@ }, "type": "object" }, + "OrganizationMemberPage": { + "properties": { + "members": { + "items": { + "$ref": "#/components/schemas/OrganizationMemberWithMetadata" + }, + "type": "array" + } + }, + "type": "object" + }, + "OrganizationMembersCount": { + "properties": { + "count": { + "type": "integer" + } + }, + "type": "object" + }, "EnableState": { "properties": { "is_disabled": { @@ -6738,6 +6809,9 @@ "identifier_count": { "type": "integer" }, + "idp_synced_identifier_count": { + "type": "integer" + }, "global_search_calls_count": { "type": "integer" } diff --git a/docs/api-reference/spec/firework-v2-swagger.json b/docs/api-reference/spec/firework-v2-swagger.json index dc28376..3616648 100644 --- a/docs/api-reference/spec/firework-v2-swagger.json +++ b/docs/api-reference/spec/firework-v2-swagger.json @@ -306,17 +306,6 @@ "type": "string" } ], - "delete": { - "responses": { - "200": { - "description": "Success" - } - }, - "operationId": "delete_activity_user_metadata_notes_/activities////user_metadata/notes", - "tags": [ - "activities" - ] - }, "put": { "responses": { "400": { @@ -346,6 +335,17 @@ "tags": [ "activities" ] + }, + "delete": { + "responses": { + "200": { + "description": "Success" + } + }, + "operationId": "delete_activity_user_metadata_notes_/activities////user_metadata/notes", + "tags": [ + "activities" + ] } }, "/firework/v2/activities/{index}/{source}/{id_}/user_metadata/remediated": { @@ -421,17 +421,6 @@ "type": "string" } ], - "delete": { - "responses": { - "200": { - "description": "Success" - } - }, - "operationId": "delete_activity_user_metadata_risk_score_/activities////user_metadata/risk_score", - "tags": [ - "activities" - ] - }, "put": { "responses": { "400": { @@ -461,6 +450,17 @@ "tags": [ "activities" ] + }, + "delete": { + "responses": { + "200": { + "description": "Success" + } + }, + "operationId": "delete_activity_user_metadata_risk_score_/activities////user_metadata/risk_score", + "tags": [ + "activities" + ] } }, "/firework/v2/activities/{index}/{source}/{id_}/user_metadata/tags": { @@ -484,20 +484,6 @@ "type": "string" } ], - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ActivityUserMetadata" - } - } - }, - "operationId": "get_activity_user_metadata_tags_/activities////user_metadata/tags", - "tags": [ - "activities" - ] - }, "delete": { "responses": { "200": { @@ -538,6 +524,20 @@ "tags": [ "activities" ] + }, + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ActivityUserMetadata" + } + } + }, + "operationId": "get_activity_user_metadata_tags_/activities////user_metadata/tags", + "tags": [ + "activities" + ] } }, "/firework/v2/activities/{index}/{source}/{id}": { @@ -984,24 +984,6 @@ } }, "/firework/v2/assets/": { - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "properties": { - "assets": { - "$ref": "#/definitions/Identifier" - } - } - } - } - }, - "operationId": "get_assets_/assets/", - "tags": [ - "Identifiers" - ] - }, "post": { "responses": { "200": { @@ -1035,27 +1017,27 @@ "tags": [ "Identifiers" ] - } - }, - "/firework/v2/assets/groups/": { + }, "get": { "responses": { "200": { "description": "Success", "schema": { "properties": { - "assets_groups": { - "$ref": "#/definitions/IdentifierGroup" + "assets": { + "$ref": "#/definitions/Identifier" } } } } }, - "operationId": "get_assets_groups_/assets/groups/", + "operationId": "get_assets_/assets/", "tags": [ "Identifiers" ] - }, + } + }, + "/firework/v2/assets/groups/": { "post": { "responses": { "200": { @@ -1089,35 +1071,35 @@ "tags": [ "Identifiers" ] - } - }, - "/firework/v2/assets/groups/{assets_group_id}": { - "parameters": [ - { - "name": "assets_group_id", - "in": "path", - "required": true, - "type": "integer" - } - ], + }, "get": { "responses": { "200": { "description": "Success", "schema": { "properties": { - "assets_group": { + "assets_groups": { "$ref": "#/definitions/IdentifierGroup" } } } } }, - "operationId": "get_assets_group_api_/assets/groups/", + "operationId": "get_assets_groups_/assets/groups/", "tags": [ "Identifiers" ] - }, + } + }, + "/firework/v2/assets/groups/{assets_group_id}": { + "parameters": [ + { + "name": "assets_group_id", + "in": "path", + "required": true, + "type": "integer" + } + ], "delete": { "responses": { "200": { @@ -1162,35 +1144,35 @@ "tags": [ "Identifiers" ] - } - }, - "/firework/v2/assets/groups/{assets_group_id}/alerts": { - "parameters": [ - { - "name": "assets_group_id", - "in": "path", - "required": true, - "type": "integer" - } - ], + }, "get": { "responses": { "200": { "description": "Success", "schema": { "properties": { - "alerts": { - "$ref": "#/definitions/FeedAlert" + "assets_group": { + "$ref": "#/definitions/IdentifierGroup" } } } } }, - "operationId": "get_assets_group_alerts_/assets/groups//alerts", + "operationId": "get_assets_group_api_/assets/groups/", "tags": [ "Identifiers" ] - }, + } + }, + "/firework/v2/assets/groups/{assets_group_id}/alerts": { + "parameters": [ + { + "name": "assets_group_id", + "in": "path", + "required": true, + "type": "integer" + } + ], "post": { "responses": { "200": { @@ -1214,6 +1196,24 @@ "tags": [ "Identifiers" ] + }, + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "properties": { + "alerts": { + "$ref": "#/definitions/FeedAlert" + } + } + } + } + }, + "operationId": "get_assets_group_alerts_/assets/groups//alerts", + "tags": [ + "Identifiers" + ] } }, "/firework/v2/assets/groups/{assets_group_id}/alerts/{alert_id}": { @@ -1231,17 +1231,6 @@ "type": "integer" } ], - "delete": { - "responses": { - "200": { - "description": "Success" - } - }, - "operationId": "delete_assets_group_alert_/assets/groups//alerts/", - "tags": [ - "Identifiers" - ] - }, "put": { "responses": { "200": { @@ -1265,6 +1254,17 @@ "tags": [ "Identifiers" ] + }, + "delete": { + "responses": { + "200": { + "description": "Success" + } + }, + "operationId": "delete_assets_group_alert_/assets/groups//alerts/", + "tags": [ + "Identifiers" + ] } }, "/firework/v2/assets/groups/{assets_group_id}/feed": { @@ -1276,7 +1276,7 @@ "type": "integer" } ], - "get": { + "post": { "responses": { "404": { "description": "Identifier group does not exist.", @@ -1297,7 +1297,7 @@ } } }, - "operationId": "get_assets_group_feed_/assets/groups//feed", + "operationId": "post_assets_group_feed_/assets/groups//feed", "parameters": [ { "name": "fields", @@ -1354,7 +1354,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, 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: forum_topic, chat_message, blog_post, forum_profile, listing, ransomleak, forum_post, stealer_log, seller, financial_data, bot\n- open_web: source_code_secrets, docker, bucket, paste, bucket_object, service, stack_exchange, source_code_files, google, 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: stealer_log, listing, forum_topic, forum_post, financial_data, chat_message, ransomleak, blog_post, forum_profile, seller, bot\n- open_web: source_code_secrets, source_code_files, service, social_media_account, docker, bucket, google, bucket_object, paste, stack_exchange\n- leaks: leak\n- domains: domain\n", "items": { "type": "string" }, @@ -1532,7 +1532,7 @@ "Identifiers" ] }, - "post": { + "get": { "responses": { "404": { "description": "Identifier group does not exist.", @@ -1553,7 +1553,7 @@ } } }, - "operationId": "post_assets_group_feed_/assets/groups//feed", + "operationId": "get_assets_group_feed_/assets/groups//feed", "parameters": [ { "name": "fields", @@ -1610,7 +1610,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, 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: forum_topic, chat_message, blog_post, forum_profile, listing, ransomleak, forum_post, stealer_log, seller, financial_data, bot\n- open_web: source_code_secrets, docker, bucket, paste, bucket_object, service, stack_exchange, source_code_files, google, 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: stealer_log, listing, forum_topic, forum_post, financial_data, chat_message, ransomleak, blog_post, forum_profile, seller, bot\n- open_web: source_code_secrets, source_code_files, service, social_media_account, docker, bucket, google, bucket_object, paste, stack_exchange\n- leaks: leak\n- domains: domain\n", "items": { "type": "string" }, @@ -1798,24 +1798,6 @@ "type": "integer" } ], - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "properties": { - "asset": { - "$ref": "#/definitions/Identifier" - } - } - } - } - }, - "operationId": "get_asset_api_/assets/", - "tags": [ - "Identifiers" - ] - }, "delete": { "responses": { "200": { @@ -1860,35 +1842,35 @@ "tags": [ "Identifiers" ] - } - }, - "/firework/v2/assets/{asset_id}/alerts": { - "parameters": [ - { - "name": "asset_id", - "in": "path", - "required": true, - "type": "integer" - } - ], + }, "get": { "responses": { "200": { "description": "Success", "schema": { "properties": { - "alerts": { - "$ref": "#/definitions/FeedAlert" + "asset": { + "$ref": "#/definitions/Identifier" } } } } }, - "operationId": "get_asset_alerts_/assets//alerts", + "operationId": "get_asset_api_/assets/", "tags": [ "Identifiers" ] - }, + } + }, + "/firework/v2/assets/{asset_id}/alerts": { + "parameters": [ + { + "name": "asset_id", + "in": "path", + "required": true, + "type": "integer" + } + ], "post": { "responses": { "200": { @@ -1912,6 +1894,24 @@ "tags": [ "Identifiers" ] + }, + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "properties": { + "alerts": { + "$ref": "#/definitions/FeedAlert" + } + } + } + } + }, + "operationId": "get_asset_alerts_/assets//alerts", + "tags": [ + "Identifiers" + ] } }, "/firework/v2/assets/{asset_id}/alerts/{alert_id}": { @@ -1929,17 +1929,6 @@ "type": "integer" } ], - "delete": { - "responses": { - "200": { - "description": "Success" - } - }, - "operationId": "delete_asset_alert_/assets//alerts/", - "tags": [ - "Identifiers" - ] - }, "put": { "responses": { "200": { @@ -1963,6 +1952,17 @@ "tags": [ "Identifiers" ] + }, + "delete": { + "responses": { + "200": { + "description": "Success" + } + }, + "operationId": "delete_asset_alert_/assets//alerts/", + "tags": [ + "Identifiers" + ] } }, "/firework/v2/assets/{asset_id}/feed": { @@ -1974,7 +1974,7 @@ "type": "integer" } ], - "get": { + "post": { "responses": { "404": { "description": "Identifier does not exist.", @@ -1995,7 +1995,7 @@ } } }, - "operationId": "get_asset_feed_/assets//feed", + "operationId": "post_asset_feed_/assets//feed", "parameters": [ { "name": "fields", @@ -2052,7 +2052,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, 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: forum_topic, chat_message, blog_post, forum_profile, listing, ransomleak, forum_post, stealer_log, seller, financial_data, bot\n- open_web: source_code_secrets, docker, bucket, paste, bucket_object, service, stack_exchange, source_code_files, google, 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: stealer_log, listing, forum_topic, forum_post, financial_data, chat_message, ransomleak, blog_post, forum_profile, seller, bot\n- open_web: source_code_secrets, source_code_files, service, social_media_account, docker, bucket, google, bucket_object, paste, stack_exchange\n- leaks: leak\n- domains: domain\n", "items": { "type": "string" }, @@ -2230,7 +2230,7 @@ "Identifiers" ] }, - "post": { + "get": { "responses": { "404": { "description": "Identifier does not exist.", @@ -2251,7 +2251,7 @@ } } }, - "operationId": "post_asset_feed_/assets//feed", + "operationId": "get_asset_feed_/assets//feed", "parameters": [ { "name": "fields", @@ -2308,7 +2308,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, 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: forum_topic, chat_message, blog_post, forum_profile, listing, ransomleak, forum_post, stealer_log, seller, financial_data, bot\n- open_web: source_code_secrets, docker, bucket, paste, bucket_object, service, stack_exchange, source_code_files, google, 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: stealer_log, listing, forum_topic, forum_post, financial_data, chat_message, ransomleak, blog_post, forum_profile, seller, bot\n- open_web: source_code_secrets, source_code_files, service, social_media_account, docker, bucket, google, bucket_object, paste, stack_exchange\n- leaks: leak\n- domains: domain\n", "items": { "type": "string" }, @@ -2631,7 +2631,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, 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: forum_topic, chat_message, blog_post, forum_profile, listing, ransomleak, forum_post, stealer_log, seller, financial_data, bot\n- open_web: source_code_secrets, docker, bucket, paste, bucket_object, service, stack_exchange, source_code_files, google, 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: stealer_log, listing, forum_topic, forum_post, financial_data, chat_message, ransomleak, blog_post, forum_profile, seller, bot\n- open_web: source_code_secrets, source_code_files, service, social_media_account, docker, bucket, google, bucket_object, paste, stack_exchange\n- leaks: leak\n- domains: domain\n", "items": { "type": "string" }, @@ -2849,7 +2849,7 @@ } }, "/firework/v2/me/feed": { - "get": { + "post": { "responses": { "200": { "description": "The user's home feed activities", @@ -2858,7 +2858,7 @@ } } }, - "operationId": "get_current_user_home_feed_/me/feed", + "operationId": "post_current_user_home_feed_/me/feed", "parameters": [ { "name": "time", @@ -2905,7 +2905,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, 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: forum_topic, chat_message, blog_post, forum_profile, listing, ransomleak, forum_post, stealer_log, seller, financial_data, bot\n- open_web: source_code_secrets, docker, bucket, paste, bucket_object, service, stack_exchange, source_code_files, google, 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: stealer_log, listing, forum_topic, forum_post, financial_data, chat_message, ransomleak, blog_post, forum_profile, seller, bot\n- open_web: source_code_secrets, source_code_files, service, social_media_account, docker, bucket, google, bucket_object, paste, stack_exchange\n- leaks: leak\n- domains: domain\n", "items": { "type": "string" }, @@ -3083,7 +3083,7 @@ "me" ] }, - "post": { + "get": { "responses": { "200": { "description": "The user's home feed activities", @@ -3092,7 +3092,7 @@ } } }, - "operationId": "post_current_user_home_feed_/me/feed", + "operationId": "get_current_user_home_feed_/me/feed", "parameters": [ { "name": "time", @@ -3139,7 +3139,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, 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: forum_topic, chat_message, blog_post, forum_profile, listing, ransomleak, forum_post, stealer_log, seller, financial_data, bot\n- open_web: source_code_secrets, docker, bucket, paste, bucket_object, service, stack_exchange, source_code_files, google, 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: stealer_log, listing, forum_topic, forum_post, financial_data, chat_message, ransomleak, blog_post, forum_profile, seller, bot\n- open_web: source_code_secrets, source_code_files, service, social_media_account, docker, bucket, google, bucket_object, paste, stack_exchange\n- leaks: leak\n- domains: domain\n", "items": { "type": "string" }, @@ -3319,6 +3319,30 @@ } }, "/firework/v2/me/feed/credentials": { + "post": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PaginatedCredentials" + } + } + }, + "operationId": "post_leaked_credentials_feed_endpoint_/me/feed/credentials", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/UserUpdate" + } + } + ], + "tags": [ + "me" + ] + }, "get": { "responses": { "200": { @@ -3355,44 +3379,9 @@ "tags": [ "me" ] - }, - "post": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PaginatedCredentials" - } - } - }, - "operationId": "post_leaked_credentials_feed_endpoint_/me/feed/credentials", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/UserUpdate" - } - } - ], - "tags": [ - "me" - ] } }, "/firework/v2/me/profile": { - "get": { - "responses": { - "200": { - "description": "Returns the current user's profile" - } - }, - "operationId": "get_current_user_profile_/me/profile", - "tags": [ - "me" - ] - }, "put": { "responses": { "400": { @@ -3426,6 +3415,17 @@ "tags": [ "me" ] + }, + "get": { + "responses": { + "200": { + "description": "Returns the current user's profile" + } + }, + "operationId": "get_current_user_profile_/me/profile", + "tags": [ + "me" + ] } }, "/firework/v2/me/tenants": { @@ -3450,6 +3450,40 @@ "type": "integer" } ], + "post": { + "responses": { + "404": { + "description": "Organization not found", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "200": { + "description": "Success", + "schema": { + "properties": { + "member": { + "$ref": "#/definitions/OrganizationMemberWithMetadata" + } + } + } + } + }, + "operationId": "post_organization_members_api_/organizations//members", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/OrganizationMemberData" + } + } + ], + "tags": [ + "organizations" + ] + }, "get": { "responses": { "404": { @@ -3487,8 +3521,18 @@ "tags": [ "organizations" ] - }, - "post": { + } + }, + "/firework/v2/organizations/{organization_id}/members/count": { + "parameters": [ + { + "name": "organization_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "get": { "responses": { "404": { "description": "Organization not found", @@ -3499,25 +3543,11 @@ "200": { "description": "Success", "schema": { - "properties": { - "member": { - "$ref": "#/definitions/OrganizationMemberWithMetadata" - } - } + "$ref": "#/definitions/OrganizationMembersCount" } } }, - "operationId": "post_organization_members_api_/organizations//members", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/OrganizationMemberData" - } - } - ], + "operationId": "get_organization_members_count_api_/organizations//members/count", "tags": [ "organizations" ] @@ -3538,7 +3568,7 @@ "type": "integer" } ], - "get": { + "put": { "responses": { "200": { "description": "Success", @@ -3551,12 +3581,22 @@ } } }, - "operationId": "get_organization_member_api_/organizations//members/", + "operationId": "put_organization_member_api_/organizations//members/", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/OrganizationMember" + } + } + ], "tags": [ "organizations" ] }, - "put": { + "get": { "responses": { "200": { "description": "Success", @@ -3569,17 +3609,7 @@ } } }, - "operationId": "put_organization_member_api_/organizations//members/", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/OrganizationMember" - } - } - ], + "operationId": "get_organization_member_api_/organizations//members/", "tags": [ "organizations" ] @@ -3732,6 +3762,26 @@ "name": "q", "in": "query", "type": "string" + }, + { + "name": "types[]", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "enum": [ + "regular", + "service-firm", + "micro", + "starter", + "essential", + "core", + "enterprise", + "demo", + "training" + ] } ], "tags": [ @@ -3748,20 +3798,6 @@ "type": "integer" } ], - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/TenantWithCounts" - } - } - }, - "operationId": "get_organization_tenants_api_/organizations//tenants", - "tags": [ - "organizations" - ] - }, "post": { "responses": { "200": { @@ -3785,20 +3821,23 @@ "tags": [ "organizations" ] - } - }, - "/firework/v2/reporting/reports": { + }, "get": { "responses": { "200": { - "description": "Lists reports for the current tenant, ordered from newest to oldest." + "description": "Success", + "schema": { + "$ref": "#/definitions/TenantWithCounts" + } } }, - "operationId": "get_reports_endpoint_/reporting/reports", + "operationId": "get_organization_tenants_api_/organizations//tenants", "tags": [ - "reporting" + "organizations" ] - }, + } + }, + "/firework/v2/reporting/reports": { "post": { "responses": { "200": { @@ -3819,6 +3858,17 @@ "tags": [ "reporting" ] + }, + "get": { + "responses": { + "200": { + "description": "Lists reports for the current tenant, ordered from newest to oldest." + } + }, + "operationId": "get_reports_endpoint_/reporting/reports", + "tags": [ + "reporting" + ] } }, "/firework/v2/reporting/reports/{report_id}": { @@ -3830,13 +3880,23 @@ "type": "integer" } ], - "get": { + "patch": { "responses": { "200": { - "description": "Returns a report and its elements." + "description": "Updates a report." } }, - "operationId": "get_report_endpoint_/reporting/reports/", + "operationId": "patch_report_endpoint_/reporting/reports/", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/UpdatedReport" + } + } + ], "tags": [ "reporting" ] @@ -3852,23 +3912,13 @@ "reporting" ] }, - "patch": { + "get": { "responses": { "200": { - "description": "Updates a report." + "description": "Returns a report and its elements." } }, - "operationId": "patch_report_endpoint_/reporting/reports/", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/UpdatedReport" - } - } - ], + "operationId": "get_report_endpoint_/reporting/reports/", "tags": [ "reporting" ] @@ -3917,7 +3967,7 @@ } }, "/firework/v2/search/": { - "get": { + "post": { "responses": { "400": { "description": "Query is invalid.", @@ -3932,7 +3982,7 @@ } } }, - "operationId": "get_search_/search/", + "operationId": "post_search_/search/", "parameters": [ { "name": "fields", @@ -3989,7 +4039,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, 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: forum_topic, chat_message, blog_post, forum_profile, listing, ransomleak, forum_post, stealer_log, seller, financial_data, bot\n- open_web: source_code_secrets, docker, bucket, paste, bucket_object, service, stack_exchange, source_code_files, google, 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: stealer_log, listing, forum_topic, forum_post, financial_data, chat_message, ransomleak, blog_post, forum_profile, seller, bot\n- open_web: source_code_secrets, source_code_files, service, social_media_account, docker, bucket, google, bucket_object, paste, stack_exchange\n- leaks: leak\n- domains: domain\n", "items": { "type": "string" }, @@ -4165,7 +4215,7 @@ "search" ] }, - "post": { + "get": { "responses": { "400": { "description": "Query is invalid.", @@ -4180,7 +4230,7 @@ } } }, - "operationId": "post_search_/search/", + "operationId": "get_search_/search/", "parameters": [ { "name": "fields", @@ -4237,7 +4287,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, 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: forum_topic, chat_message, blog_post, forum_profile, listing, ransomleak, forum_post, stealer_log, seller, financial_data, bot\n- open_web: source_code_secrets, docker, bucket, paste, bucket_object, service, stack_exchange, source_code_files, google, 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: stealer_log, listing, forum_topic, forum_post, financial_data, chat_message, ransomleak, blog_post, forum_profile, seller, bot\n- open_web: source_code_secrets, source_code_files, service, social_media_account, docker, bucket, google, bucket_object, paste, stack_exchange\n- leaks: leak\n- domains: domain\n", "items": { "type": "string" }, @@ -4462,20 +4512,6 @@ "type": "integer" } ], - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/TenantWithCounts" - } - } - }, - "operationId": "get_tenant_api_/tenants/", - "tags": [ - "tenants" - ] - }, "put": { "responses": { "200": { @@ -4499,6 +4535,20 @@ "tags": [ "tenants" ] + }, + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TenantWithCounts" + } + } + }, + "operationId": "get_tenant_api_/tenants/", + "tags": [ + "tenants" + ] } }, "/firework/v2/tenants/{tenant_id}/archive": { @@ -4531,20 +4581,6 @@ "type": "integer" } ], - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/TenantUsers" - } - } - }, - "operationId": "get_tenant_users_api_/tenants//users", - "tags": [ - "tenants" - ] - }, "post": { "responses": { "200": { @@ -4565,6 +4601,20 @@ "tags": [ "tenants" ] + }, + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TenantUsers" + } + } + }, + "operationId": "get_tenant_users_api_/tenants//users", + "tags": [ + "tenants" + ] } }, "/firework/v2/tenants/{tenant_id}/users/{user_id}": { @@ -4730,29 +4780,29 @@ "example": "domain", "enum": [ "domain", - "stealer_log", - "ad", "source_code_secrets", - "bucket", - "bucket_object", - "listing", - "google", - "social_media_account", + "source_code_files", "forum_topic", - "leak", "docker", - "paste", + "financial_data", + "chat_message", + "seller", "blog_post", "forum_profile", + "bot", + "stealer_log", + "paste", + "social_media_account", + "google", "service", - "ransomleak", - "source_code_files", + "listing", + "ad", + "bucket", "forum_post", - "seller", - "chat_message", + "ransomleak", + "bucket_object", + "leak", "stack_exchange", - "financial_data", - "bot", "illicit_networks", "open_web", "buckets", @@ -4829,28 +4879,28 @@ "example": "domain", "enum": [ "domain", - "stealer_log", "source_code_secrets", - "bucket", - "bucket_object", - "listing", - "google", - "social_media_account", + "source_code_files", "forum_topic", - "leak", "docker", - "paste", + "financial_data", + "chat_message", + "seller", "blog_post", "forum_profile", + "bot", + "stealer_log", + "paste", + "social_media_account", + "google", "service", - "ransomleak", - "source_code_files", + "listing", + "bucket", "forum_post", - "seller", - "chat_message", + "ransomleak", + "bucket_object", + "leak", "stack_exchange", - "financial_data", - "bot", "illicit_networks", "open_web", "buckets", @@ -5304,6 +5354,13 @@ ] } ] + }, + "hs_contact_email": { + "type": [ + "string", + "null" + ], + "example": "nullable string" } }, "type": "object" @@ -5368,24 +5425,6 @@ }, "type": "object" }, - "TenantWithCounts": { - "properties": { - "next": { - "type": "string" - }, - "items": { - "$ref": "#/definitions/TenantWithCounts" - }, - "total_count": { - "type": [ - "integer", - "null" - ], - "example": "nullable integer" - } - }, - "type": "object" - }, "Tenant": { "properties": { "id": { @@ -5462,6 +5501,24 @@ }, "type": "object" }, + "TenantWithCounts": { + "properties": { + "next": { + "type": "string" + }, + "items": { + "$ref": "#/definitions/TenantWithCounts" + }, + "total_count": { + "type": [ + "integer", + "null" + ], + "example": "nullable integer" + } + }, + "type": "object" + }, "UpdatedPermission": { "properties": { "updated_value": { @@ -5562,24 +5619,6 @@ }, "type": "object" }, - "OrganizationMemberPage": { - "properties": { - "members": { - "type": "array", - "items": { - "$ref": "#/definitions/OrganizationMemberWithMetadata" - } - }, - "next": { - "type": [ - "string", - "null" - ], - "example": "nullable string" - } - }, - "type": "object" - }, "OrganizationMemberWithMetadata": { "properties": { "user": { @@ -5590,7 +5629,7 @@ }, "is_mfa_enabled": { "type": [ - "string", + "boolean", "null" ], "example": "nullable bool" @@ -5640,6 +5679,32 @@ }, "type": "object" }, + "OrganizationMemberPage": { + "properties": { + "members": { + "type": "array", + "items": { + "$ref": "#/definitions/OrganizationMemberWithMetadata" + } + }, + "next": { + "type": [ + "string", + "null" + ], + "example": "nullable string" + } + }, + "type": "object" + }, + "OrganizationMembersCount": { + "properties": { + "count": { + "type": "integer" + } + }, + "type": "object" + }, "EnableState": { "properties": { "is_disabled": { @@ -5671,6 +5736,9 @@ "identifier_count": { "type": "integer" }, + "idp_synced_identifier_count": { + "type": "integer" + }, "global_search_calls_count": { "type": "integer" } @@ -5988,7 +6056,7 @@ }, "should_show_guided_tenant_wizard": { "type": [ - "string", + "boolean", "null" ], "example": "nullable bool" diff --git a/docs/api-reference/spec/firework-v3-openapi.json b/docs/api-reference/spec/firework-v3-openapi.json index ae14157..819a878 100644 --- a/docs/api-reference/spec/firework-v3-openapi.json +++ b/docs/api-reference/spec/firework-v3-openapi.json @@ -483,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, seller, financial_data, forum_post, stealer_log, ransomleak, forum_profile, blog_post, listing, chat_message, forum_topic\n- open_web: social_media_account, google, source_code_files, stack_exchange, bucket_object, service, paste, docker, bucket, source_code_secrets\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: stealer_log, listing, forum_topic, forum_post, financial_data, chat_message, ransomleak, blog_post, forum_profile, seller, bot\n- open_web: source_code_secrets, source_code_files, service, social_media_account, docker, bucket, google, bucket_object, paste, stack_exchange\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -803,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, seller, financial_data, forum_post, stealer_log, ransomleak, forum_profile, blog_post, listing, chat_message, forum_topic\n- open_web: social_media_account, google, source_code_files, stack_exchange, bucket_object, service, paste, docker, bucket, source_code_secrets\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: stealer_log, listing, forum_topic, forum_post, financial_data, chat_message, ransomleak, blog_post, forum_profile, seller, bot\n- open_web: source_code_secrets, source_code_files, service, social_media_account, docker, bucket, google, bucket_object, paste, stack_exchange\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -1213,7 +1213,8 @@ "USER", "COUNTED", "SYSTEM", - "USER_AND_ATTRIBUTE" + "USER_AND_ATTRIBUTE", + "USER_AND_SYSTEM" ], "type": "string" } @@ -1355,7 +1356,8 @@ "USER", "COUNTED", "SYSTEM", - "USER_AND_ATTRIBUTE" + "USER_AND_ATTRIBUTE", + "USER_AND_SYSTEM" ], "type": "string" } diff --git a/docs/api-reference/spec/firework-v3-swagger.json b/docs/api-reference/spec/firework-v3-swagger.json index 43a09ca..42c20ae 100644 --- a/docs/api-reference/spec/firework-v3-swagger.json +++ b/docs/api-reference/spec/firework-v3-swagger.json @@ -401,7 +401,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, 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, seller, financial_data, forum_post, stealer_log, ransomleak, forum_profile, blog_post, listing, chat_message, forum_topic\n- open_web: social_media_account, google, source_code_files, stack_exchange, bucket_object, service, paste, docker, bucket, source_code_secrets\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: stealer_log, listing, forum_topic, forum_post, financial_data, chat_message, ransomleak, blog_post, forum_profile, seller, bot\n- open_web: source_code_secrets, source_code_files, service, social_media_account, docker, bucket, google, bucket_object, paste, stack_exchange\n- leaks: leak\n- domains: domain\n", "items": { "type": "string" }, @@ -657,7 +657,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, 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, seller, financial_data, forum_post, stealer_log, ransomleak, forum_profile, blog_post, listing, chat_message, forum_topic\n- open_web: social_media_account, google, source_code_files, stack_exchange, bucket_object, service, paste, docker, bucket, source_code_secrets\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: stealer_log, listing, forum_topic, forum_post, financial_data, chat_message, ransomleak, blog_post, forum_profile, seller, bot\n- open_web: source_code_secrets, source_code_files, service, social_media_account, docker, bucket, google, bucket_object, paste, stack_exchange\n- leaks: leak\n- domains: domain\n", "items": { "type": "string" }, @@ -991,7 +991,8 @@ "USER", "COUNTED", "SYSTEM", - "USER_AND_ATTRIBUTE" + "USER_AND_ATTRIBUTE", + "USER_AND_SYSTEM" ] }, { @@ -1107,7 +1108,8 @@ "USER", "COUNTED", "SYSTEM", - "USER_AND_ATTRIBUTE" + "USER_AND_ATTRIBUTE", + "USER_AND_SYSTEM" ] }, { diff --git a/docs/api-reference/spec/firework-v4-openapi.json b/docs/api-reference/spec/firework-v4-openapi.json index 54bd201..4465896 100644 --- a/docs/api-reference/spec/firework-v4-openapi.json +++ b/docs/api-reference/spec/firework-v4-openapi.json @@ -1434,22 +1434,33 @@ } } }, - "/firework/v4/actors/uuid": { + "/firework/v4/actors/{actor_name}/uuid": { "post": { "tags": [ "private" ], "summary": "Get Asset Uuid", - "operationId": "get_asset_uuid_actors_uuid_post", + "operationId": "get_asset_uuid_actors__actor_name__uuid_post", + "parameters": [ + { + "name": "actor_name", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Actor Name" + } + } + ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActorBodyPayload" } } - }, - "required": true + } }, "responses": { "200": { @@ -1458,7 +1469,7 @@ "application/json": { "schema": { "type": "string", - "title": "Response Get Asset Uuid Actors Uuid Post" + "title": "Response Get Asset Uuid Actors Actor Name Uuid Post" } } } @@ -1525,7 +1536,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FrontendActorMetadata" + "$ref": "#/components/schemas/ActorMetadata" } } } @@ -1837,10 +1848,57 @@ } } }, + "/firework/v4/actors/{asset_uuid}/threads": { + "get": { + "tags": [ + "private" + ], + "summary": "Get Actor Threads", + "operationId": "get_actor_threads_actors__asset_uuid__threads_get", + "parameters": [ + { + "name": "asset_uuid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Asset Uuid" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ActorThread" + }, + "title": "Response Get Actor Threads Actors Asset Uuid Threads Get" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, "/firework/v4/actors/{actor_name}/analysis/metadata": { "get": { "tags": [ - "public" + "private" ], "summary": "Get Actor Analysis Metadata", "operationId": "get_actor_analysis_metadata_actors__actor_name__analysis_metadata_get", @@ -1947,73 +2005,22 @@ } } }, - "/firework/v4/actors/{actor_name}/generate-summaries": { + "/firework/v4/actors/{asset_uuid}/generate-summaries": { "post": { "tags": [ "private" ], "summary": "Generate Summaries", - "operationId": "generate_summaries_actors__actor_name__generate_summaries_post", - "parameters": [ - { - "name": "actor_name", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Actor Name" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActorSummariesGenerationPayload" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActorSummariesResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/actors/{actor_name}/regenerate-summaries": { - "post": { - "tags": [ - "private" - ], - "summary": "Regenerate Summaries", - "operationId": "regenerate_summaries_actors__actor_name__regenerate_summaries_post", + "operationId": "generate_summaries_actors__asset_uuid__generate_summaries_post", "parameters": [ { - "name": "actor_name", + "name": "asset_uuid", "in": "path", "required": true, "schema": { "type": "string", - "title": "Actor Name" + "format": "uuid", + "title": "Asset Uuid" } } ], @@ -2196,46 +2203,22 @@ } } }, - "/firework/v4/actors/{actor_name}/communication-handles": { + "/firework/v4/actors/{asset_uuid}/communication-handles": { "get": { "tags": [ "private" ], "summary": "Get Actor Communication Handles", - "operationId": "get_actor_communication_handles_actors__actor_name__communication_handles_get", + "operationId": "get_actor_communication_handles_actors__asset_uuid__communication_handles_get", "parameters": [ { - "name": "actor_name", + "name": "asset_uuid", "in": "path", "required": true, "schema": { "type": "string", - "title": "Actor Name" - } - }, - { - "name": "actor_id", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Actor Id" - } - }, - { - "name": "source", - "in": "query", - "required": true, - "schema": { - "type": "string", - "title": "Source" + "format": "uuid", + "title": "Asset Uuid" } } ], @@ -2249,7 +2232,7 @@ "items": { "$ref": "#/components/schemas/ActorCommunicationHandle" }, - "title": "Response Get Actor Communication Handles Actors Actor Name Communication Handles Get" + "title": "Response Get Actor Communication Handles Actors Asset Uuid Communication Handles Get" } } } @@ -2319,73 +2302,22 @@ } } }, - "/firework/v4/actors/{actor_name}/generate-network": { + "/firework/v4/actors/{asset_uuid}/generate-network": { "post": { "tags": [ "private" ], "summary": "Generate Network", - "operationId": "generate_network_actors__actor_name__generate_network_post", - "parameters": [ - { - "name": "actor_name", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Actor Name" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActorNetworkGenerationPayload" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActorNetworkResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/actors/{actor_name}/regenerate-network": { - "post": { - "tags": [ - "private" - ], - "summary": "Regenerate Network", - "operationId": "regenerate_network_actors__actor_name__regenerate_network_post", + "operationId": "generate_network_actors__asset_uuid__generate_network_post", "parameters": [ { - "name": "actor_name", + "name": "asset_uuid", "in": "path", "required": true, "schema": { "type": "string", - "title": "Actor Name" + "format": "uuid", + "title": "Asset Uuid" } } ], @@ -3636,7 +3568,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedResults_EntityBrowserResponse__str_" + "$ref": "#/components/schemas/PaginatedResults_EntityAPIResponseTypes__str_" } } } @@ -3783,15 +3715,36 @@ { "$ref": "#/components/schemas/BucketEvent" }, + { + "$ref": "#/components/schemas/ChatMessageEvent" + }, { "$ref": "#/components/schemas/FinancialEvent" }, + { + "$ref": "#/components/schemas/DockerImageEvent" + }, + { + "$ref": "#/components/schemas/ForumPostEvent" + }, + { + "$ref": "#/components/schemas/ListingEvent" + }, { "$ref": "#/components/schemas/LookalikeDomainEvent" }, + { + "$ref": "#/components/schemas/PasteEvent" + }, { "$ref": "#/components/schemas/RansomLeakEvent" }, + { + "$ref": "#/components/schemas/ServiceEvent" + }, + { + "$ref": "#/components/schemas/SocialMediaEvent" + }, { "$ref": "#/components/schemas/StealerLogEvent" } @@ -3801,9 +3754,16 @@ "mapping": { "blog_post": "#/components/schemas/BlogPostEvent", "bucket": "#/components/schemas/BucketEvent", + "chat_message": "#/components/schemas/ChatMessageEvent", "cc": "#/components/schemas/FinancialEvent", + "docker_image": "#/components/schemas/DockerImageEvent", + "forum_post": "#/components/schemas/ForumPostEvent", + "listing": "#/components/schemas/ListingEvent", "lookalike": "#/components/schemas/LookalikeDomainEvent", + "paste": "#/components/schemas/PasteEvent", "ransomleak": "#/components/schemas/RansomLeakEvent", + "service": "#/components/schemas/ServiceEvent", + "social_media_account": "#/components/schemas/SocialMediaEvent", "stealer_log": "#/components/schemas/pyro__findings__stealerlogs__datamodels__StealerLogEvent" } }, @@ -4458,32 +4418,6 @@ "default": 20, "title": "Size" } - }, - { - "name": "reveal_full_contents", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false, - "title": "Reveal Full Contents" - } - }, - { - "name": "search_term", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Search Term" - } } ], "responses": { @@ -5961,23 +5895,66 @@ } } }, - "/firework/v4/identifiers/merge_identities": { - "post": { + "/firework/v4/identifiers/entity_by_domain": { + "get": { "tags": [ "private", "team=experience" ], - "summary": "Merge Identity Identifiers", - "operationId": "merge_identity_identifiers_identifiers_merge_identities_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MergeIdentitiesBody" - } + "summary": "Fetch Entity By Domain", + "operationId": "fetch_entity_by_domain_identifiers_entity_by_domain_get", + "parameters": [ + { + "name": "domain_name", + "in": "query", + "required": true, + "schema": { + "type": "string", + "title": "Domain Name" } - }, - "required": true + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IdentifierResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/identifiers/merge_identities": { + "post": { + "tags": [ + "private", + "team=experience" + ], + "summary": "Merge Identity Identifiers", + "operationId": "merge_identity_identifiers_identifiers_merge_identities_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MergeIdentitiesBody" + } + } + }, + "required": true }, "responses": { "200": { @@ -6959,7 +6936,7 @@ "in": "query", "required": false, "schema": { - "$ref": "#/components/schemas/SortType", + "$ref": "#/components/schemas/pyro__entities__identities__profile__sort_type__SortType", "default": "creation_date" } }, @@ -8268,7 +8245,7 @@ "in": "query", "required": false, "schema": { - "$ref": "#/components/schemas/pyro__reports__report_store__SortType", + "$ref": "#/components/schemas/SortType", "default": "updated_at" } }, @@ -8281,7 +8258,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ReportType" + "$ref": "#/components/schemas/pyro__reports__report_types__ReportType" } }, { @@ -10006,7 +9983,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/pyro__threat_flow__core__reports__report_store__ReportType" + "$ref": "#/components/schemas/ReportType" } }, { @@ -10857,11 +10834,37 @@ "operationId": "get_global_search_usage_by_feature_usage_global_search_by_feature_get", "parameters": [ { - "name": "time", + "name": "gte", "in": "query", - "required": true, + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Gte" + } + }, + { + "name": "lte", + "in": "query", + "required": false, "schema": { - "$ref": "#/components/schemas/Times" + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Lte" } }, { @@ -10933,11 +10936,37 @@ "operationId": "get_global_search_usage_by_member_usage_global_search_by_member_get", "parameters": [ { - "name": "time", + "name": "gte", "in": "query", - "required": true, + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Gte" + } + }, + { + "name": "lte", + "in": "query", + "required": false, "schema": { - "$ref": "#/components/schemas/Times" + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Lte" } }, { @@ -11000,11 +11029,37 @@ "operationId": "get_global_search_usage_by_tenant_usage_global_search_by_tenant_get", "parameters": [ { - "name": "time", + "name": "gte", "in": "query", - "required": true, + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Gte" + } + }, + { + "name": "lte", + "in": "query", + "required": false, "schema": { - "$ref": "#/components/schemas/Times" + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Lte" } }, { @@ -11307,56 +11362,21 @@ ], "title": "ActivityUid" }, - "ActorAnalysisMetadataResponse": { + "Actor": { "properties": { - "summarized_at": { - "type": "string", - "format": "date-time", - "title": "Summarized At" - }, - "summarization_start_at": { - "type": "string", - "format": "date-time", - "title": "Summarization Start At" - }, - "summarization_end_at": { - "type": "string", - "format": "date-time", - "title": "Summarization End At" - }, - "events_summarized_count": { - "type": "integer", - "title": "Events Summarized Count" - }, - "total_events_summary_count": { + "id": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Total Events Summary Count" + "title": "Id", + "description": "ID of the author of the forum post. These IDs relate to the forum platform." }, - "total_events_count": { - "type": "integer", - "title": "Total Events Count" - } - }, - "type": "object", - "required": [ - "summarized_at", - "summarization_start_at", - "summarization_end_at", - "events_summarized_count", - "total_events_count" - ], - "title": "ActorAnalysisMetadataResponse" - }, - "ActorBodyPayload": { - "properties": { - "actor_id": { + "name": { "anyOf": [ { "type": "string" @@ -11365,174 +11385,173 @@ "type": "null" } ], - "title": "Actor Id" - }, - "source": { - "type": "string", - "title": "Source" + "title": "Name", + "description": "Name of the author of the forum post." } }, "type": "object", "required": [ - "source" + "id", + "name" ], - "title": "ActorBodyPayload" + "title": "Actor" }, - "ActorCommunicationHandle": { + "ActorAPIResponse": { "properties": { - "platform": { + "uuid": { "type": "string", - "title": "Platform" + "title": "Uuid" }, - "handles": { + "type": { + "$ref": "#/components/schemas/EntityType" + }, + "name": { + "type": "string", + "title": "Name" + }, + "created_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Created At" + }, + "updated_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Updated At" + }, + "sources": { "items": { "type": "string" }, "type": "array", - "title": "Handles" - } - }, - "type": "object", - "required": [ - "platform", - "handles" - ], - "title": "ActorCommunicationHandle" - }, - "ActorHeatmapData": { - "properties": { - "per_hour": { - "items": { - "$ref": "#/components/schemas/HourData" - }, - "type": "array", - "title": "Per Hour" + "title": "Sources" }, - "total_count": { - "type": "integer", - "title": "Total Count" - } - }, - "type": "object", - "required": [ - "per_hour", - "total_count" - ], - "title": "ActorHeatmapData" - }, - "ActorNetwork": { - "properties": { - "nodes": { - "items": { - "$ref": "#/components/schemas/BaseNode" - }, - "type": "array", - "title": "Nodes" - }, - "edges": { - "items": { - "$ref": "#/components/schemas/BaseEdge" - }, - "type": "array", - "title": "Edges" - } - }, - "type": "object", - "required": [ - "nodes", - "edges" - ], - "title": "ActorNetwork" - }, - "ActorNetworkGenerationPayload": { - "properties": { - "actor_id": { + "first_seen_at": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Actor Id" + "title": "First Seen At" }, - "source": { - "type": "string", - "title": "Source" + "last_seen_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Seen At" }, - "group_by": { - "$ref": "#/components/schemas/GroupByType" + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Description" } }, "type": "object", "required": [ - "source", - "group_by" + "uuid", + "type", + "name", + "created_at", + "updated_at", + "sources", + "first_seen_at", + "last_seen_at", + "description" ], - "title": "ActorNetworkGenerationPayload" + "title": "ActorAPIResponse" }, - "ActorNetworkResponse": { + "ActorAnalysisMetadataResponse": { "properties": { - "request_id": { + "summarized_at": { + "type": "string", + "format": "date-time", + "title": "Summarized At" + }, + "summarization_start_at": { "anyOf": [ { "type": "string", - "format": "uuid" + "format": "date-time" }, { "type": "null" } ], - "title": "Request Id" + "title": "Summarization Start At" }, - "error": { + "summarization_end_at": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Error" + "title": "Summarization End At" }, - "network": { + "events_summarized_count": { + "type": "integer", + "title": "Events Summarized Count" + }, + "total_events_summary_count": { "anyOf": [ { - "$ref": "#/components/schemas/ActorNetwork" + "type": "integer" }, { "type": "null" } - ] - } - }, - "type": "object", - "required": [ - "request_id" - ], - "title": "ActorNetworkResponse" - }, - "ActorSourceDistribution": { - "properties": { - "source": { - "type": "string", - "title": "Source" + ], + "title": "Total Events Summary Count" }, - "count": { + "total_events_count": { "type": "integer", - "title": "Count" + "title": "Total Events Count" } }, "type": "object", "required": [ - "source", - "count" + "summarized_at", + "summarization_start_at", + "summarization_end_at", + "events_summarized_count", + "total_events_count" ], - "title": "ActorSourceDistribution" + "title": "ActorAnalysisMetadataResponse" }, - "ActorSummariesGenerationPayload": { + "ActorBodyPayload": { "properties": { "actor_id": { "anyOf": [ @@ -11554,34 +11573,65 @@ "required": [ "source" ], - "title": "ActorSummariesGenerationPayload" + "title": "ActorBodyPayload" }, - "ActorSummariesResponse": { + "ActorCommunicationHandle": { "properties": { - "request_id": { - "anyOf": [ - { - "type": "string", - "format": "uuid" - }, - { - "type": "null" - } - ], - "title": "Request Id" + "platform": { + "type": "string", + "title": "Platform" }, - "error": { + "handles": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Handles" + } + }, + "type": "object", + "required": [ + "platform", + "handles" + ], + "title": "ActorCommunicationHandle" + }, + "ActorHeatmapData": { + "properties": { + "per_hour": { + "items": { + "$ref": "#/components/schemas/HourData" + }, + "type": "array", + "title": "Per Hour" + }, + "total_count": { + "type": "integer", + "title": "Total Count" + } + }, + "type": "object", + "required": [ + "per_hour", + "total_count" + ], + "title": "ActorHeatmapData" + }, + "ActorMetadata": { + "properties": { + "first_seen": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Error" + "title": "First Seen" }, - "summarized_at": { + "last_seen": { "anyOf": [ { "type": "string", @@ -11591,75 +11641,293 @@ "type": "null" } ], - "title": "Summarized At" + "title": "Last Seen" }, - "profile": { + "total_events": { "anyOf": [ { - "$ref": "#/components/schemas/GeneralProfileSummaryOutput" - }, - { - "$ref": "#/components/schemas/ExecutiveSummaryOutput" + "type": "integer" }, { "type": "null" } ], - "title": "Profile" + "title": "Total Events" }, - "heatmap": { - "anyOf": [ - { - "$ref": "#/components/schemas/HeatmapAnalysisOutput" - }, - { - "type": "null" - } - ] + "aliases": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Aliases", + "default": [] }, - "activity": { + "actor_id": { "anyOf": [ { - "$ref": "#/components/schemas/GeneralActivityAnalysisOutput" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Actor Id" + }, + "actor_name": { + "type": "string", + "title": "Actor Name" + }, + "source": { + "$ref": "#/components/schemas/EnrichedSource" } }, "type": "object", "required": [ - "request_id" + "actor_name", + "source" ], - "title": "ActorSummariesResponse" + "title": "ActorMetadata" }, - "ActorTimeline": { + "ActorNetwork": { "properties": { - "aggregate_by": { - "anyOf": [ - { - "$ref": "#/components/schemas/StatsAggregates" - }, - { - "type": "null" - } - ] - }, - "timeline": { + "nodes": { "items": { - "$ref": "#/components/schemas/ActorTimelineEntry" + "$ref": "#/components/schemas/BaseNode" }, "type": "array", - "title": "Timeline" + "title": "Nodes" }, - "total_count": { - "type": "integer", - "title": "Total Count" - } - }, - "type": "object", - "required": [ + "edges": { + "items": { + "$ref": "#/components/schemas/BaseEdge" + }, + "type": "array", + "title": "Edges" + } + }, + "type": "object", + "required": [ + "nodes", + "edges" + ], + "title": "ActorNetwork" + }, + "ActorNetworkGenerationPayload": { + "properties": { + "group_by": { + "$ref": "#/components/schemas/GroupByType" + }, + "force_refresh": { + "type": "boolean", + "title": "Force Refresh", + "default": false + } + }, + "type": "object", + "required": [ + "group_by" + ], + "title": "ActorNetworkGenerationPayload" + }, + "ActorNetworkResponse": { + "properties": { + "request_id": { + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], + "title": "Request Id" + }, + "error": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Error" + }, + "network": { + "anyOf": [ + { + "$ref": "#/components/schemas/ActorNetwork" + }, + { + "type": "null" + } + ] + } + }, + "type": "object", + "required": [ + "request_id" + ], + "title": "ActorNetworkResponse" + }, + "ActorSourceDistribution": { + "properties": { + "source": { + "type": "string", + "title": "Source" + }, + "count": { + "type": "integer", + "title": "Count" + } + }, + "type": "object", + "required": [ + "source", + "count" + ], + "title": "ActorSourceDistribution" + }, + "ActorSummariesGenerationPayload": { + "properties": { + "force_refresh": { + "type": "boolean", + "title": "Force Refresh", + "default": false + } + }, + "type": "object", + "title": "ActorSummariesGenerationPayload" + }, + "ActorSummariesResponse": { + "properties": { + "request_id": { + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], + "title": "Request Id" + }, + "error": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Error" + }, + "summarized_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Summarized At" + }, + "profile": { + "anyOf": [ + { + "$ref": "#/components/schemas/GeneralProfileSummaryOutput" + }, + { + "type": "null" + } + ] + }, + "heatmap": { + "anyOf": [ + { + "$ref": "#/components/schemas/HeatmapAnalysisOutput" + }, + { + "type": "null" + } + ] + } + }, + "type": "object", + "required": [ + "request_id" + ], + "title": "ActorSummariesResponse" + }, + "ActorThread": { + "properties": { + "thread_id": { + "type": "string", + "title": "Thread Id" + }, + "thread_type": { + "$ref": "#/components/schemas/ThreadType" + }, + "title": { + "type": "string", + "title": "Title" + }, + "source": { + "type": "string", + "title": "Source" + }, + "event_count": { + "type": "integer", + "title": "Event Count" + }, + "last_event_at": { + "type": "string", + "format": "date-time", + "title": "Last Event At" + } + }, + "type": "object", + "required": [ + "thread_id", + "thread_type", + "title", + "source", + "event_count", + "last_event_at" + ], + "title": "ActorThread" + }, + "ActorTimeline": { + "properties": { + "aggregate_by": { + "anyOf": [ + { + "$ref": "#/components/schemas/StatsAggregates" + }, + { + "type": "null" + } + ] + }, + "timeline": { + "items": { + "$ref": "#/components/schemas/ActorTimelineEntry" + }, + "type": "array", + "title": "Timeline" + }, + "total_count": { + "type": "integer", + "title": "Total Count" + } + }, + "type": "object", + "required": [ "timeline", "total_count" ], @@ -13730,7 +13998,7 @@ } ], "title": "Created After", - "default": "2026-02-03T16:09:16.809405Z" + "default": "2026-02-12T20:01:15.359500Z" }, "from": { "anyOf": [ @@ -13839,21 +14107,31 @@ ], "title": "CategoryStatsHistogram" }, - "ConversationMessage": { + "ChatMessageEvent": { "properties": { - "uid": { - "type": "string", - "title": "Uid" - }, - "message": { + "event_type": { "type": "string", - "title": "Message" + "const": "chat_message", + "title": "Event Type", + "default": "chat_message" }, - "author_name": { - "type": "string", - "title": "Author Name" + "data": { + "$ref": "#/components/schemas/ChatMessageEventData" }, - "date_time": { + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + } + }, + "type": "object", + "required": [ + "data", + "metadata" + ], + "title": "Chat Message" + }, + "ChatMessageEventData": { + "properties": { + "posted_at": { "anyOf": [ { "type": "string", @@ -13863,20 +14141,263 @@ "type": "null" } ], - "title": "Date Time" - } - }, - "type": "object", - "required": [ - "uid", - "message", - "author_name", - "date_time" - ], - "title": "ConversationMessage" - }, - "ConversationSearchAfterDirection": { - "type": "string", + "title": "Posted At" + }, + "actor": { + "anyOf": [ + { + "$ref": "#/components/schemas/pyro__findings__chat_messages__datamodels__ChatMessageEventData__Actor" + }, + { + "type": "null" + } + ], + "default": {} + }, + "context": { + "anyOf": [ + { + "$ref": "#/components/schemas/pyro__findings__chat_messages__datamodels__ChatMessageEventData__Context" + }, + { + "type": "null" + } + ], + "default": {} + }, + "content": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Content" + }, + "parent_context": { + "anyOf": [ + { + "$ref": "#/components/schemas/ParentContext" + }, + { + "type": "null" + } + ], + "default": {} + }, + "forward_info": { + "anyOf": [ + { + "$ref": "#/components/schemas/ForwardInfo" + }, + { + "type": "null" + } + ], + "default": {} + }, + "was_forwarded": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Was Forwarded" + } + }, + "type": "object", + "title": "ChatMessageEventData" + }, + "Classes": { + "properties": { + "is_carding": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Is Carding" + }, + "is_bypass": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Is Bypass" + }, + "is_ident_fraud": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Is Ident Fraud" + }, + "is_doc_fraud": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Is Doc Fraud" + }, + "is_phishing": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Is Phishing" + }, + "is_money_xfer": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Is Money Xfer" + }, + "is_cashout": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Is Cashout" + }, + "is_virt_currency": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Is Virt Currency" + }, + "is_hacking": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Is Hacking" + }, + "is_misc_financial": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Is Misc Financial" + } + }, + "type": "object", + "title": "Classes" + }, + "Classification": { + "properties": { + "classes": { + "$ref": "#/components/schemas/Classes", + "default": {} + }, + "types": { + "$ref": "#/components/schemas/Types", + "default": {} + } + }, + "type": "object", + "title": "Classification" + }, + "Context": { + "properties": { + "category_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Category Name" + } + }, + "type": "object", + "title": "Context" + }, + "ConversationMessage": { + "properties": { + "uid": { + "type": "string", + "title": "Uid" + }, + "message": { + "type": "string", + "title": "Message" + }, + "author_name": { + "type": "string", + "title": "Author Name" + }, + "date_time": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Date Time" + } + }, + "type": "object", + "required": [ + "uid", + "message", + "author_name", + "date_time" + ], + "title": "ConversationMessage" + }, + "ConversationSearchAfterDirection": { + "type": "string", "enum": [ "next", "previous" @@ -15158,33 +15679,196 @@ ], "title": "DisableAccountPayload" }, - "DomainAssetEnrichment": { + "DockerImageEvent": { "properties": { - "type": { - "$ref": "#/components/schemas/AssetEnrichmentType" - }, - "sources": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Sources" + "event_type": { + "type": "string", + "const": "docker_image", + "title": "Event Type", + "default": "docker_image" }, - "entries": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Entries" + "data": { + "$ref": "#/components/schemas/DockerImageEventData" }, - "tags": { - "items": { - "$ref": "#/components/schemas/SubdomainTag" - }, - "type": "array", - "title": "Tags" + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + } + }, + "type": "object", + "required": [ + "data", + "metadata" + ], + "title": "Docker Image" + }, + "DockerImageEventData": { + "properties": { + "content": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Content" }, - "statuses": { + "browser_url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Browser Url" + }, + "digest": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Digest" + }, + "architecture": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Architecture" + }, + "variant": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Variant" + }, + "os": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Os" + }, + "os_features": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Os Features", + "default": [] + }, + "os_version": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Os Version" + }, + "last_pushed_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Pushed At" + }, + "last_pulled_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Pulled At" + }, + "tags": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/Tag" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Tags", + "default": [] + }, + "size": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Size" + } + }, + "type": "object", + "title": "DockerImageEventData" + }, + "DomainAssetEnrichment": { + "properties": { + "type": { + "$ref": "#/components/schemas/AssetEnrichmentType" + }, + "sources": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Sources" + }, + "entries": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Entries" + }, + "tags": { + "items": { + "$ref": "#/components/schemas/SubdomainTag" + }, + "type": "array", + "title": "Tags" + }, + "statuses": { "items": { "$ref": "#/components/schemas/SubdomainStatus" }, @@ -15646,59 +16330,15 @@ ], "title": "EnrichedSource" }, - "EntityBrowserResponse": { - "properties": { - "uuid": { - "type": "string", - "title": "Uuid" - }, - "type": { - "$ref": "#/components/schemas/EntityType" - }, - "name": { - "type": "string", - "title": "Name" - }, - "sources": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Sources" - }, - "created_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Created At" + "EntityAPIResponseTypes": { + "anyOf": [ + { + "$ref": "#/components/schemas/ActorAPIResponse" }, - "updated_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Updated At" + { + "$ref": "#/components/schemas/ForumThreadAPIResponse" } - }, - "type": "object", - "required": [ - "uuid", - "type", - "name", - "sources" - ], - "title": "EntityBrowserResponse" + ] }, "EntityType": { "type": "string", @@ -16071,56 +16711,6 @@ ], "title": "EventSeverity" }, - "ExecutiveSummaryOutput": { - "properties": { - "overview": { - "type": "string", - "title": "Overview", - "description": "Paragraph about the actor, including their username(s), presence on forum(s), total post count, and activity date range (use the 'First Post Date' and 'Last Post Date' fields); if the 'Last Post Date' is more than 90 days before 'Today's Date', mention that the actor has not been active for at least 90 days; if the actor is active on a single forum, avoid exclusive phrasing like \u201conly on\u201d or \u201cexclusively on\u201d and instead use neutral language such as \u201cis active on\u201d or \u201cgoes by the username on\u201d." - }, - "main_activities_and_motives": { - "type": "string", - "title": "Main Activities And Motives", - "description": "Paragraph about the main activies and motives of the actor. Base your assessment only on the 'General description of the threat actor's activity on the forum' section of the input." - }, - "latest_activity": { - "type": "string", - "title": "Latest Activity", - "description": "Short but specific and precise analysis of the threat actor's latest activity (highlighting any named moderators, admins, dates, or type of activity), (always translate everything in English, all examples or output should be always in English). Base your assessment only on the 'Latest activity from the threat actor' section of the input." - }, - "potential_associations_with_major_criminal_groups": { - "type": "string", - "title": "Potential Associations With Major Criminal Groups", - "description": "What groups the threat actor is associated with (if any). Base your assessment only on the 'General description of the threat actor's activity on the forum' section of the input." - }, - "linguistic_analysis": { - "type": "string", - "title": "Linguistic Analysis", - "description": "Identify all languages present in the 'Analysis of the threat actor\u2019s writing style' section, and do not omit any language even if it appears rarely (e.g., greetings, slang, or isolated phrases). For each detected language, provide its name, a proficiency rating from 1 to 10, a confidence rating from 1 to 10 (reduced if fewer than 100 posts are analyzed), and a short justification of 2\u20133 sentences. Present the results in a structured paragraph format, with one entry per language, and end with a brief summary sentence explaining whether the actor appears multilingual or primarily focused on one language." - }, - "likely_geographical_location": { - "type": "string", - "title": "Likely Geographical Location", - "description": "Identify the likely geography and give a confidence rating (1-10). When you have under 300 posts to analyse, mark confidence in your assessment as low and adjust the confidence score accordingly. Base your assessment only on the 'Description of the posting activity of the threat actor' section of the input." - }, - "potential_victims_shortlist": { - "type": "string", - "title": "Potential Victims Shortlist", - "description": "List up to ten victims, showing only their names (plus industry if relevant). Base your assessment only on the 'Description of potential victims mentioned in the threat actor's post' section of the input. Paragraph about the potential victim." - } - }, - "type": "object", - "required": [ - "overview", - "main_activities_and_motives", - "latest_activity", - "potential_associations_with_major_criminal_groups", - "linguistic_analysis", - "likely_geographical_location", - "potential_victims_shortlist" - ], - "title": "ExecutiveSummaryOutput" - }, "ExpandableField": { "type": "string", "enum": [ @@ -17101,35 +17691,223 @@ "type": "object", "title": "ForetraceParams" }, - "ForumThreadAnalysisMetadataResponse": { + "ForumPostData": { "properties": { - "summarized_at": { - "type": "string", - "format": "date-time", - "title": "Summarized At" + "actor": { + "$ref": "#/components/schemas/Actor", + "description": "Details about the author of the forum post." }, - "summarization_start_at": { - "type": "string", - "format": "date-time", - "title": "Summarization Start At" + "context": { + "$ref": "#/components/schemas/pyro__findings__forum_posts__datamodels__ForumPostData__Context", + "description": "Details about the context of the forum post." }, - "summarization_end_at": { - "type": "string", - "format": "date-time", - "title": "Summarization End At" + "posted_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Posted At", + "description": "Date and time the forum post was made." }, - "events_summarized_count": { - "type": "integer", - "title": "Events Summarized Count" + "content": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Content", + "description": "Content of the forum post." }, - "total_events_count": { - "type": "integer", - "title": "Total Events Count" - } - }, - "type": "object", - "required": [ - "summarized_at", + "url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Url", + "description": "URL to the forum post." + } + }, + "type": "object", + "required": [ + "actor", + "context", + "posted_at", + "content", + "url" + ], + "title": "ForumPostData" + }, + "ForumPostEvent": { + "properties": { + "event_type": { + "type": "string", + "const": "forum_post", + "title": "Event Type", + "default": "forum_post" + }, + "data": { + "$ref": "#/components/schemas/ForumPostData" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + } + }, + "type": "object", + "required": [ + "data", + "metadata" + ], + "title": "Forum Post" + }, + "ForumThreadAPIResponse": { + "properties": { + "uuid": { + "type": "string", + "title": "Uuid" + }, + "type": { + "$ref": "#/components/schemas/EntityType" + }, + "name": { + "type": "string", + "title": "Name" + }, + "created_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Created At" + }, + "updated_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Updated At" + }, + "sources": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Sources" + }, + "first_post_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "First Post At" + }, + "last_post_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Post At" + }, + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Description" + } + }, + "type": "object", + "required": [ + "uuid", + "type", + "name", + "created_at", + "updated_at", + "sources", + "first_post_at", + "last_post_at", + "description" + ], + "title": "ForumThreadAPIResponse" + }, + "ForumThreadAnalysisMetadataResponse": { + "properties": { + "summarized_at": { + "type": "string", + "format": "date-time", + "title": "Summarized At" + }, + "summarization_start_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Summarization Start At" + }, + "summarization_end_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Summarization End At" + }, + "events_summarized_count": { + "type": "integer", + "title": "Events Summarized Count" + }, + "total_events_count": { + "type": "integer", + "title": "Total Events Count" + } + }, + "type": "object", + "required": [ + "summarized_at", "summarization_start_at", "summarization_end_at", "events_summarized_count", @@ -17395,9 +18173,9 @@ ], "title": "ForumThreadTopicUidAndTitlePayload" }, - "FrontendActorMetadata": { + "ForwardInfo": { "properties": { - "actor_id": { + "forwarded_from": { "anyOf": [ { "type": "string" @@ -17406,114 +18184,78 @@ "type": "null" } ], - "title": "Actor Id" - }, - "actor_name": { - "type": "string", - "title": "Actor Name" - }, - "aliases": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Aliases", - "default": [] + "title": "Forwarded From" }, - "first_seen": { + "forwarded_from_author_id": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "First Seen" + "title": "Forwarded From Author Id" }, - "last_seen": { + "forwarded_from_chat_id": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "integer" }, { "type": "null" } ], - "title": "Last Seen" - }, - "total_events": { - "type": "integer", - "title": "Total Events", - "default": 0 - }, - "is_vetted": { - "type": "boolean", - "title": "Is Vetted", - "default": false - }, - "vetted_sources": { - "items": { - "$ref": "#/components/schemas/EnrichedSource" - }, - "type": "array", - "title": "Vetted Sources", - "default": [] - }, - "active_sources": { - "items": { - "$ref": "#/components/schemas/EnrichedSource" - }, - "type": "array", - "title": "Active Sources", - "default": [] - } - }, - "type": "object", - "required": [ - "actor_name" - ], - "title": "FrontendActorMetadata" - }, - "GeneralActivityAnalysisOutput": { - "properties": { - "overview": { - "type": "string", - "title": "Overview", - "description": "Begin by describing the actor\u2019s most impactful criminal activity. Then provide an overview of the general nature of the actor\u2019s activity, including up to 20 short, unique, and relevant examples in reverse chronological order (e.g., what is offered, at what price, on which date, and on which forum/source). For each example, cite the corresponding post, date, and source, translating all content into English. When applicable, include details on tools, exploits, pricing, communication style, and any unique skills demonstrated." + "title": "Forwarded From Chat Id" }, - "variation_of_activity_over_time": { - "type": "string", - "title": "Variation Of Activity Over Time", - "description": "Describe how the actor's tactics, type of activity or targets have changed over time, if applicable." + "forwarded_from_conversation_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Forwarded From Conversation Id" }, - "motivations": { - "type": "string", - "title": "Motivations", - "description": "Explain the actor's likely motives." + "forwarded_from_user_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Forwarded From User Id" }, - "affiliations": { - "type": "string", - "title": "Affiliations", - "description": "List groups, services, malware strains or RaaS programmes the actor is linked to." + "forwarded_from_username": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Forwarded From Username" }, - "non_criminal_activity": { - "type": "string", - "title": "Non Criminal Activity", - "description": "Summarise behaviour that is clearly non-criminal." + "forwarded_message_time": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Forwarded Message Time" } }, "type": "object", - "required": [ - "overview", - "variation_of_activity_over_time", - "motivations", - "affiliations", - "non_criminal_activity" - ], - "title": "GeneralActivityAnalysisOutput" + "title": "ForwardInfo" }, "GeneralProfileSummaryOutput": { "properties": { @@ -17807,7 +18549,14 @@ "GlobalSearchUsageByMemberDataPoint": { "properties": { "member": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Member" }, "count": { @@ -17841,7 +18590,14 @@ "GlobalSearchUsageByTenantDataPoint": { "properties": { "tenant_name": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Tenant Name" }, "count": { @@ -19220,6 +19976,18 @@ } ], "title": "Created At" + }, + "last_updated_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Updated At" } }, "type": "object", @@ -19261,7 +20029,8 @@ "USER", "COUNTED", "SYSTEM", - "USER_AND_ATTRIBUTE" + "USER_AND_ATTRIBUTE", + "USER_AND_SYSTEM" ], "title": "IdentifierSourceGroup" }, @@ -20018,6 +20787,157 @@ ], "title": "ListFeatureFlagsResponse" }, + "ListingEvent": { + "properties": { + "event_type": { + "type": "string", + "const": "listing", + "title": "Event Type", + "default": "listing" + }, + "data": { + "$ref": "#/components/schemas/ListingEventData" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + } + }, + "type": "object", + "required": [ + "data", + "metadata" + ], + "title": "Listing" + }, + "ListingEventData": { + "properties": { + "url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Url" + }, + "title": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Title" + }, + "content": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Content" + }, + "currency": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Currency" + }, + "escrow": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Escrow" + }, + "price": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Price" + }, + "ship_to": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Ship To", + "default": [] + }, + "ship_from": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Ship From", + "default": [] + }, + "stock_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Stock Count" + }, + "actor": { + "anyOf": [ + { + "$ref": "#/components/schemas/pyro__findings__listing__datamodels__ListingEventData__Actor" + }, + { + "type": "null" + } + ] + }, + "classification": { + "anyOf": [ + { + "$ref": "#/components/schemas/Classification" + }, + { + "type": "null" + } + ] + }, + "context": { + "anyOf": [ + { + "$ref": "#/components/schemas/Context" + }, + { + "type": "null" + } + ] + } + }, + "type": "object", + "title": "ListingEventData" + }, "LogoRequestBody": { "properties": { "domains": { @@ -20605,11 +21525,11 @@ ], "title": "PaginatedResults[EnrichedBulkAction, str]" }, - "PaginatedResults_EntityBrowserResponse__str_": { + "PaginatedResults_EntityAPIResponseTypes__str_": { "properties": { "items": { "items": { - "$ref": "#/components/schemas/EntityBrowserResponse" + "$ref": "#/components/schemas/EntityAPIResponseTypes" }, "type": "array", "title": "Items" @@ -20631,7 +21551,7 @@ "items", "next" ], - "title": "PaginatedResults[EntityBrowserResponse, str]" + "title": "PaginatedResults[EntityAPIResponseTypes, str]" }, "PaginatedResults_FeedItem__str_": { "properties": { @@ -21262,6 +22182,34 @@ ], "title": "PaginatedSources" }, + "ParentContext": { + "properties": { + "parent_uid": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Parent Uid" + }, + "parent_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Parent Type" + } + }, + "type": "object", + "title": "ParentContext" + }, "ParentIdentifierSortType": { "type": "string", "enum": [ @@ -21422,64 +22370,53 @@ ], "title": "PasswordPolicyOperator" }, - "PiiCollection_StealerLogFindingCookie_": { + "PasteEvent": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/StealerLogFindingCookie" - }, - "type": "array", - "title": "Items" + "event_type": { + "type": "string", + "const": "paste", + "title": "Event Type", + "default": "paste" }, - "hidden_count": { - "type": "integer", - "title": "Hidden Count" - } - }, - "type": "object", - "required": [ - "items", - "hidden_count" - ], - "title": "PiiCollection[StealerLogFindingCookie]" - }, - "PiiCollection_StealerLogFindingCredential_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/StealerLogFindingCredential" - }, - "type": "array", - "title": "Items" + "data": { + "$ref": "#/components/schemas/PasteEventData" }, - "hidden_count": { - "type": "integer", - "title": "Hidden Count" + "metadata": { + "$ref": "#/components/schemas/EventMetadata" } }, "type": "object", "required": [ - "items", - "hidden_count" + "data", + "metadata" ], - "title": "PiiCollection[StealerLogFindingCredential]" + "title": "Paste" }, - "PresetRestrictedTerm": { + "PasteEventData": { "properties": { - "type": { - "type": "string", - "const": "preset", - "title": "Type" - }, - "id": { - "type": "string", - "title": "Id" + "url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Url" }, - "display_name": { - "type": "string", - "title": "Display Name" + "title": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Title" }, - "description": { + "content": { "anyOf": [ { "type": "string" @@ -21488,9 +22425,114 @@ "type": "null" } ], - "title": "Description" + "title": "Content" }, - "terms": { + "actor": { + "anyOf": [ + { + "$ref": "#/components/schemas/pyro__findings__paste__datamodels__PasteEventData__Actor" + }, + { + "type": "null" + } + ] + }, + "expires_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Expires At" + }, + "syntax": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Syntax" + } + }, + "type": "object", + "title": "PasteEventData" + }, + "PiiCollection_StealerLogFindingCookie_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/StealerLogFindingCookie" + }, + "type": "array", + "title": "Items" + }, + "hidden_count": { + "type": "integer", + "title": "Hidden Count" + } + }, + "type": "object", + "required": [ + "items", + "hidden_count" + ], + "title": "PiiCollection[StealerLogFindingCookie]" + }, + "PiiCollection_StealerLogFindingCredential_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/StealerLogFindingCredential" + }, + "type": "array", + "title": "Items" + }, + "hidden_count": { + "type": "integer", + "title": "Hidden Count" + } + }, + "type": "object", + "required": [ + "items", + "hidden_count" + ], + "title": "PiiCollection[StealerLogFindingCredential]" + }, + "PresetRestrictedTerm": { + "properties": { + "type": { + "type": "string", + "const": "preset", + "title": "Type" + }, + "id": { + "type": "string", + "title": "Id" + }, + "display_name": { + "type": "string", + "title": "Display Name" + }, + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Description" + }, + "terms": { "items": { "$ref": "#/components/schemas/PresetRestrictedTermItem" }, @@ -21786,7 +22828,7 @@ "victim_information": { "anyOf": [ { - "$ref": "#/components/schemas/pyro__findings__ransomleaks__datamodels__VictimInformation" + "$ref": "#/components/schemas/VictimInformation" }, { "type": "null" @@ -23246,9 +24288,8 @@ "ReportType": { "type": "string", "enum": [ - "v1", - "event_based", - "feed_based" + "custom", + "standard" ], "title": "ReportType" }, @@ -23290,7 +24331,7 @@ "report_type": { "anyOf": [ { - "$ref": "#/components/schemas/ReportType" + "$ref": "#/components/schemas/pyro__reports__report_types__ReportType" }, { "type": "null" @@ -23617,7 +24658,8 @@ "apikey", "bypass-mfa", "search-unrestricted", - "private-endpoints" + "private-endpoints", + "impersonation" ], "title": "Scope" }, @@ -24155,122 +25197,349 @@ ], "title": "SecretQuery" }, - "Severity": { - "type": "string", - "enum": [ - "info", - "low", - "medium", - "high", - "critical" - ], - "title": "Severity" - }, - "SortType": { - "type": "string", - "enum": [ - "creation_date", - "credentials_count", - "event_type", - "information_type", - "ip_address", - "last_seen", - "leaked_date", - "password", - "source_name" + "ServiceEvent": { + "properties": { + "event_type": { + "type": "string", + "const": "service", + "title": "Event Type", + "default": "service" + }, + "data": { + "$ref": "#/components/schemas/ServiceEventData" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + } + }, + "type": "object", + "required": [ + "data", + "metadata" ], - "title": "SortType" + "title": "Service" }, - "Source": { + "ServiceEventData": { "properties": { - "sphere": { - "type": "string", - "title": "Sphere" + "url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Url", + "description": "The URL to the service. This is often an IP address and port combination." }, - "title": { - "type": "string", - "title": "Title" + "asn": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Asn", + "description": "The Autonomous System Number." }, - "category": { - "type": "string", - "title": "Category" + "content": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Content", + "description": "The content received from shodan scan." }, - "category_v2": { - "type": "string", - "title": "Category V2" + "service": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Service", + "description": "The service type, examples include http, https, dns, etc." }, - "crawled_since": { + "product": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Crawled Since" + "title": "Product" }, - "last_updated_at": { + "port": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Last Updated At" + "title": "Port", + "description": "The port used to access the service." }, - "status": { - "$ref": "#/components/schemas/SourceStatusV2" + "ip_address": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Ip Address", + "description": "The IP address of the service." }, - "event_count": { + "organization": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Event Count" + "title": "Organization", + "description": "The organization the service belongs to." }, - "total_event_count": { + "hostname": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Total Event Count" + "title": "Hostname" }, - "is_new": { - "type": "boolean", - "title": "Is New" + "country_code": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Country Code", + "description": "The country code representing where the service is hosted." }, - "crawling_frequency": { - "$ref": "#/components/schemas/CrawlingFrequency" + "vulnerabilities": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Vulnerabilities", + "description": "The list of possible vulnerabilities that could be present on the service." } }, "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" + "url", + "asn", + "content", + "service", + "product", + "port", + "ip_address", + "organization", + "hostname", + "country_code" + ], + "title": "ServiceEventData" + }, + "Severity": { + "type": "string", + "enum": [ + "info", + "low", + "medium", + "high", + "critical" + ], + "title": "Severity" + }, + "SocialMediaEvent": { + "properties": { + "event_type": { + "type": "string", + "const": "social_media_account", + "title": "Event Type", + "default": "social_media_account" + }, + "data": { + "$ref": "#/components/schemas/SocialMediaEventData" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + } + }, + "type": "object", + "required": [ + "data", + "metadata" + ], + "title": "Social Media Account" + }, + "SocialMediaEventData": { + "properties": { + "url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Url", + "description": "The URL to the profile page of the social media account." + }, + "site": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Site", + "description": "The name of the platform where the account was found." + }, + "username": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Username", + "description": "The username of the account that was found." + } + }, + "type": "object", + "title": "SocialMediaEventData" + }, + "SortType": { + "type": "string", + "enum": [ + "id", + "title", + "author", + "created_at", + "updated_at", + "status" + ], + "title": "SortType" + }, + "Source": { + "properties": { + "sphere": { + "type": "string", + "title": "Sphere" + }, + "title": { + "type": "string", + "title": "Title" + }, + "category": { + "type": "string", + "title": "Category" + }, + "category_v2": { + "type": "string", + "title": "Category V2" + }, + "crawled_since": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Crawled Since" + }, + "last_updated_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Updated At" + }, + "status": { + "$ref": "#/components/schemas/SourceStatusV2" + }, + "event_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "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", @@ -24789,6 +26058,15 @@ ], "title": "StealerLogCookie" }, + "StealerLogCookieExpiration": { + "type": "string", + "enum": [ + "all", + "expired", + "active" + ], + "title": "StealerLogCookieExpiration" + }, "StealerLogCredential": { "properties": { "url": { @@ -24803,10 +26081,6 @@ "type": "string", "title": "Password" }, - "hash": { - "type": "string", - "title": "Hash" - }, "application": { "type": "string", "title": "Application" @@ -24817,7 +26091,6 @@ "url", "username", "password", - "hash", "application" ], "title": "StealerLogCredential" @@ -24865,7 +26138,7 @@ "victim_information": { "anyOf": [ { - "$ref": "#/components/schemas/VictimInformation" + "$ref": "#/components/schemas/pyro__findings__stealerlogs__datamodels__VictimInformation" }, { "type": "null" @@ -25047,6 +26320,34 @@ ], "title": "SubdomainTag" }, + "Tag": { + "properties": { + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name" + }, + "repository_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Repository Name" + } + }, + "type": "object", + "title": "Tag" + }, "TagListPayload": { "properties": { "tags": { @@ -25118,12 +26419,18 @@ "primary_email": { "type": "string", "title": "Primary Email" + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "Created At" } }, "type": "object", "required": [ "id", - "primary_email" + "primary_email", + "created_at" ], "title": "TenantFlareCommunityUser" }, @@ -25663,6 +26970,14 @@ ], "title": "TestTenantIntegrationPayload" }, + "ThreadType": { + "type": "string", + "enum": [ + "chat_channel", + "forum_thread" + ], + "title": "ThreadType" + }, "ThreatFlowReportDownloadFormat": { "type": "string", "enum": [ @@ -25991,37 +27306,98 @@ ], "title": "TopActorsSummaryOutput" }, - "UpdateAlertChannel": { + "Types": { "properties": { - "name": { - "type": "string", - "title": "Name" - }, - "params": { - "oneOf": [ + "is_guide": { + "anyOf": [ { - "$ref": "#/components/schemas/AlertChannelEmailParams" + "type": "boolean" }, { - "$ref": "#/components/schemas/AlertChannelSlackParams" - }, + "type": "null" + } + ], + "title": "Is Guide" + }, + "is_service": { + "anyOf": [ { - "$ref": "#/components/schemas/AlertChannelDiscordParams" + "type": "boolean" }, { - "$ref": "#/components/schemas/AlertChannelSplunkParams" - }, + "type": "null" + } + ], + "title": "Is Service" + }, + "is_software": { + "anyOf": [ { - "$ref": "#/components/schemas/AlertChannelChannelParams" + "type": "boolean" }, { - "$ref": "#/components/schemas/AlertChannelLegacySentinelParams" - }, + "type": "null" + } + ], + "title": "Is Software" + }, + "is_hardware": { + "anyOf": [ { - "$ref": "#/components/schemas/AlertChannelSentinelV2Params" + "type": "boolean" }, { - "$ref": "#/components/schemas/AlertChannelTeamsParams" + "type": "null" + } + ], + "title": "Is Hardware" + }, + "is_data": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Is Data" + } + }, + "type": "object", + "title": "Types" + }, + "UpdateAlertChannel": { + "properties": { + "name": { + "type": "string", + "title": "Name" + }, + "params": { + "oneOf": [ + { + "$ref": "#/components/schemas/AlertChannelEmailParams" + }, + { + "$ref": "#/components/schemas/AlertChannelSlackParams" + }, + { + "$ref": "#/components/schemas/AlertChannelDiscordParams" + }, + { + "$ref": "#/components/schemas/AlertChannelSplunkParams" + }, + { + "$ref": "#/components/schemas/AlertChannelChannelParams" + }, + { + "$ref": "#/components/schemas/AlertChannelLegacySentinelParams" + }, + { + "$ref": "#/components/schemas/AlertChannelSentinelV2Params" + }, + { + "$ref": "#/components/schemas/AlertChannelTeamsParams" }, { "$ref": "#/components/schemas/AlertChannelJiraParams" @@ -26492,7 +27868,9 @@ "disable_rate_limit_csm_notification", "referrals_hidden", "astp_credentials_access", - "astp_cookies_access" + "astp_cookies_access", + "full_text_contents_view", + "full_text_contents_download" ], "title": "UserPermissions" }, @@ -26572,40 +27950,408 @@ ], "title": "ValidateByIDPActionParams" }, - "ValidationError": { + "ValidationError": { + "properties": { + "loc": { + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ] + }, + "type": "array", + "title": "Location" + }, + "msg": { + "type": "string", + "title": "Message" + }, + "type": { + "type": "string", + "title": "Error Type" + } + }, + "type": "object", + "required": [ + "loc", + "msg", + "type" + ], + "title": "ValidationError" + }, + "VictimInformation": { + "properties": { + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "The name of the victim. This is the name of the company or organization that was breached." + }, + "display_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Display Name" + }, + "domain": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Domain", + "description": "The domain of the victim. This is the domain of the company or organization that was breached." + }, + "alternative_domains": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Alternative Domains" + }, + "industry": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Industry", + "description": "The industry of the company or organization that was breached." + }, + "employee_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Employee Count", + "description": "The number of employees of the company or organization that was breached." + }, + "city": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "City", + "description": "The city of operation of the company or organization that was breached." + }, + "state": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "State", + "description": "The state of operation of the company or organization that was breached." + }, + "country": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Country", + "description": "The country of operation of the company or organization that was breached." + }, + "latitude": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Latitude" + }, + "longitude": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Longitude" + } + }, + "type": "object", + "required": [ + "name", + "display_name", + "domain", + "alternative_domains", + "industry", + "employee_count", + "city", + "state", + "country", + "latitude", + "longitude" + ], + "title": "VictimInformation" + }, + "WebhookBasicAuth": { + "properties": { + "username": { + "type": "string", + "title": "Username" + }, + "password": { + "type": "string", + "title": "Password" + } + }, + "type": "object", + "required": [ + "username", + "password" + ], + "title": "WebhookBasicAuth" + }, + "pyro__entities__identities__profile__sort_type__SortType": { + "type": "string", + "enum": [ + "creation_date", + "credentials_count", + "event_type", + "information_type", + "ip_address", + "last_seen", + "leaked_date", + "password", + "source_name" + ], + "title": "SortType" + }, + "pyro__events__event_datamodels__StealerLogEvent": { + "properties": { + "type": { + "type": "string", + "const": "stealer_log", + "title": "Type", + "default": "stealer_log" + }, + "data": { + "$ref": "#/components/schemas/StealerLogData" + }, + "actions": { + "$ref": "#/components/schemas/StealerLogActions" + } + }, + "type": "object", + "required": [ + "data", + "actions" + ], + "title": "StealerLogEvent" + }, + "pyro__findings__chat_messages__datamodels__ChatMessageEventData__Actor": { + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Id" + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name" + } + }, + "type": "object", + "title": "Actor" + }, + "pyro__findings__chat_messages__datamodels__ChatMessageEventData__Context": { + "properties": { + "conversation_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Conversation Id" + }, + "conversation_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Conversation Name" + } + }, + "type": "object", + "title": "Context" + }, + "pyro__findings__forum_posts__datamodels__ForumPostData__Context": { + "properties": { + "category_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Category Name", + "description": "Category of the forum, these vary between forum platforms." + }, + "topic_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Topic Id", + "description": "Topic ID of the forum post." + }, + "topic_title": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Topic Title", + "description": "Title of the topic the post was made in." + } + }, + "type": "object", + "required": [ + "category_name", + "topic_id", + "topic_title" + ], + "title": "Context" + }, + "pyro__findings__listing__datamodels__ListingEventData__Actor": { + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Id" + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name" + } + }, + "type": "object", + "title": "Actor" + }, + "pyro__findings__paste__datamodels__PasteEventData__Actor": { "properties": { - "loc": { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ] - }, - "type": "array", - "title": "Location" - }, - "msg": { - "type": "string", - "title": "Message" + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Id" }, - "type": { - "type": "string", - "title": "Error Type" + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name" } }, "type": "object", "required": [ - "loc", - "msg", - "type" + "id", + "name" ], - "title": "ValidationError" + "title": "Actor" }, - "VictimInformation": { + "pyro__findings__stealerlogs__datamodels__VictimInformation": { "properties": { "ip_address": { "anyOf": [ @@ -26841,196 +28587,6 @@ ], "title": "VictimInformation" }, - "WebhookBasicAuth": { - "properties": { - "username": { - "type": "string", - "title": "Username" - }, - "password": { - "type": "string", - "title": "Password" - } - }, - "type": "object", - "required": [ - "username", - "password" - ], - "title": "WebhookBasicAuth" - }, - "pyro__events__event_datamodels__StealerLogEvent": { - "properties": { - "type": { - "type": "string", - "const": "stealer_log", - "title": "Type", - "default": "stealer_log" - }, - "data": { - "$ref": "#/components/schemas/StealerLogData" - }, - "actions": { - "$ref": "#/components/schemas/StealerLogActions" - } - }, - "type": "object", - "required": [ - "data", - "actions" - ], - "title": "StealerLogEvent" - }, - "pyro__findings__ransomleaks__datamodels__VictimInformation": { - "properties": { - "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Name", - "description": "The name of the victim. This is the name of the company or organization that was breached." - }, - "display_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Display Name" - }, - "domain": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Domain", - "description": "The domain of the victim. This is the domain of the company or organization that was breached." - }, - "alternative_domains": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Alternative Domains" - }, - "industry": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Industry", - "description": "The industry of the company or organization that was breached." - }, - "employee_count": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Employee Count", - "description": "The number of employees of the company or organization that was breached." - }, - "city": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "City", - "description": "The city of operation of the company or organization that was breached." - }, - "state": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "State", - "description": "The state of operation of the company or organization that was breached." - }, - "country": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Country", - "description": "The country of operation of the company or organization that was breached." - }, - "latitude": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Latitude" - }, - "longitude": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Longitude" - } - }, - "type": "object", - "required": [ - "name", - "display_name", - "domain", - "alternative_domains", - "industry", - "employee_count", - "city", - "state", - "country", - "latitude", - "longitude" - ], - "title": "VictimInformation" - }, "pyro__firework__backend__api4__reports__report_groups__reports__report_datamodels__ReportResponse": { "properties": { "report": { @@ -27043,23 +28599,12 @@ ], "title": "ReportResponse" }, - "pyro__reports__report_store__SortType": { + "pyro__reports__report_types__ReportType": { "type": "string", "enum": [ - "id", - "title", - "author", - "created_at", - "updated_at", - "status" - ], - "title": "SortType" - }, - "pyro__threat_flow__core__reports__report_store__ReportType": { - "type": "string", - "enum": [ - "custom", - "standard" + "v1", + "event_based", + "feed_based" ], "title": "ReportType" }, diff --git a/docs/api-reference/v4/endpoints/expand-event-field.mdx b/docs/api-reference/v4/endpoints/expand-event-field.mdx new file mode 100644 index 0000000..e0f4063 --- /dev/null +++ b/docs/api-reference/v4/endpoints/expand-event-field.mdx @@ -0,0 +1,20 @@ +--- +openapi: firework-v4-openapi get /firework/v4/events/_expand +--- + +import EventExpandFieldExamples from '/snippets/event_expand_field_examples.mdx' +import EventExpandFieldValidFields from '/snippets/event_expand_field_valid_fields.mdx' + +Returns a page of items for a particular expanded field in a specified event. + + + + + + + +### Expandable fields + +The following fields can be expanded for the given event type. + + diff --git a/docs/snippets/event_expand_field_examples.mdx b/docs/snippets/event_expand_field_examples.mdx new file mode 100644 index 0000000..803634f --- /dev/null +++ b/docs/snippets/event_expand_field_examples.mdx @@ -0,0 +1,38 @@ +{/* + If you are in pyro: + - If this file changes, you should also modify the API docs. + - https://github.com/flared/docs-api/ + + If you are in mintlify: + - Don't edit this directly, edit the generator in pyro. + - firework/app/pyro/firework/backend/api4/events/docs/test_event_expand_field_examples.py +*/} + +```json StealerLogCookies +{ + "items": [ + { + "host_key": "example.com", + "path": "/", + "expires_utc": "2025-01-01T00:00:00", + "name": "example", + "value": "🍪" + } + ], + "next": null +} +``` + +```json StealerLogCredentials +{ + "items": [ + { + "url": "https://example.com", + "username": "john_doe", + "password": "hunter2", + "application": "application" + } + ], + "next": null +} +``` diff --git a/docs/snippets/event_expand_field_valid_fields.mdx b/docs/snippets/event_expand_field_valid_fields.mdx new file mode 100644 index 0000000..e3c1821 --- /dev/null +++ b/docs/snippets/event_expand_field_valid_fields.mdx @@ -0,0 +1,12 @@ +{/* + If you are in pyro: + - If this file changes, you should also modify the API docs. + - https://github.com/flared/docs-api/ + + If you are in mintlify: + - Don't edit this directly, edit the generator in pyro. + - firework/app/pyro/firework/backend/api4/events/docs/test_event_expand_field_valid_fields.py +*/} + + `cookies` `credentials` + \ No newline at end of file