diff --git a/docs/api-reference/spec/firework-v2-openapi.json b/docs/api-reference/spec/firework-v2-openapi.json index a419e99..7348fff 100644 --- a/docs/api-reference/spec/firework-v2-openapi.json +++ b/docs/api-reference/spec/firework-v2-openapi.json @@ -1409,7 +1409,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Identifier" + "$ref": "#/components/schemas/IdentifierCreate" } } }, @@ -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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: stealer_log, forum_topic, forum_post, forum_profile, ransomleak, listing, bot, seller, financial_data, blog_post, chat_message\n- open_web: bucket, google, stack_exchange, bucket_object, source_code_secrets, source_code_files, social_media, service, paste\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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, bot, stealer_log, forum_profile, seller, financial_data, ransomleak, chat_message, forum_post, forum_topic, listing\n- open_web: bucket_object, paste, stack_exchange, google, social_media, bucket, source_code_files, source_code_secrets, service\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -2149,7 +2149,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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: stealer_log, forum_topic, forum_post, forum_profile, ransomleak, listing, bot, seller, financial_data, blog_post, chat_message\n- open_web: bucket, google, stack_exchange, bucket_object, source_code_secrets, source_code_files, social_media, service, paste\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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, bot, stealer_log, forum_profile, seller, financial_data, ransomleak, chat_message, forum_post, forum_topic, listing\n- open_web: bucket_object, paste, stack_exchange, google, social_media, bucket, source_code_files, source_code_secrets, service\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -2718,7 +2718,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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: stealer_log, forum_topic, forum_post, forum_profile, ransomleak, listing, bot, seller, financial_data, blog_post, chat_message\n- open_web: bucket, google, stack_exchange, bucket_object, source_code_secrets, source_code_files, social_media, service, paste\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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, bot, stealer_log, forum_profile, seller, financial_data, ransomleak, chat_message, forum_post, forum_topic, listing\n- open_web: bucket_object, paste, stack_exchange, google, social_media, bucket, source_code_files, source_code_secrets, service\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -3036,7 +3036,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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: stealer_log, forum_topic, forum_post, forum_profile, ransomleak, listing, bot, seller, financial_data, blog_post, chat_message\n- open_web: bucket, google, stack_exchange, bucket_object, source_code_secrets, source_code_files, social_media, service, paste\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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, bot, stealer_log, forum_profile, seller, financial_data, ransomleak, chat_message, forum_post, forum_topic, listing\n- open_web: bucket_object, paste, stack_exchange, google, social_media, bucket, source_code_files, source_code_secrets, service\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -3432,7 +3432,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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: stealer_log, forum_topic, forum_post, forum_profile, ransomleak, listing, bot, seller, financial_data, blog_post, chat_message\n- open_web: bucket, google, stack_exchange, bucket_object, source_code_secrets, source_code_files, social_media, service, paste\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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, bot, stealer_log, forum_profile, seller, financial_data, ransomleak, chat_message, forum_post, forum_topic, listing\n- open_web: bucket_object, paste, stack_exchange, google, social_media, bucket, source_code_files, source_code_secrets, service\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -3772,7 +3772,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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: stealer_log, forum_topic, forum_post, forum_profile, ransomleak, listing, bot, seller, financial_data, blog_post, chat_message\n- open_web: bucket, google, stack_exchange, bucket_object, source_code_secrets, source_code_files, social_media, service, paste\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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, bot, stealer_log, forum_profile, seller, financial_data, ransomleak, chat_message, forum_post, forum_topic, listing\n- open_web: bucket_object, paste, stack_exchange, google, social_media, bucket, source_code_files, source_code_secrets, service\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -4049,7 +4049,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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: stealer_log, forum_topic, forum_post, forum_profile, ransomleak, listing, bot, seller, financial_data, blog_post, chat_message\n- open_web: bucket, google, stack_exchange, bucket_object, source_code_secrets, source_code_files, social_media, service, paste\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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, bot, stealer_log, forum_profile, seller, financial_data, ransomleak, chat_message, forum_post, forum_topic, listing\n- open_web: bucket_object, paste, stack_exchange, google, social_media, bucket, source_code_files, source_code_secrets, service\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -5081,7 +5081,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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: stealer_log, forum_topic, forum_post, forum_profile, ransomleak, listing, bot, seller, financial_data, blog_post, chat_message\n- open_web: bucket, google, stack_exchange, bucket_object, source_code_secrets, source_code_files, social_media, service, paste\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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, bot, stealer_log, forum_profile, seller, financial_data, ransomleak, chat_message, forum_post, forum_topic, listing\n- open_web: bucket_object, paste, stack_exchange, google, social_media, bucket, source_code_files, source_code_secrets, service\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -5379,7 +5379,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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: stealer_log, forum_topic, forum_post, forum_profile, ransomleak, listing, bot, seller, financial_data, blog_post, chat_message\n- open_web: bucket, google, stack_exchange, bucket_object, source_code_secrets, source_code_files, social_media, service, paste\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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, bot, stealer_log, forum_profile, seller, financial_data, ransomleak, chat_message, forum_post, forum_topic, listing\n- open_web: bucket_object, paste, stack_exchange, google, social_media, bucket, source_code_files, source_code_secrets, service\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -6507,6 +6507,28 @@ "search_types": { "items": { "enum": [ + "seller", + "financial_data", + "chat_message", + "source_code_files", + "domain", + "source_code_secrets", + "forum_topic", + "blog_post", + "stealer_log", + "bot", + "forum_profile", + "paste", + "social_media", + "google", + "leak", + "bucket_object", + "stack_exchange", + "ransomleak", + "bucket", + "forum_post", + "service", + "listing", "illicit_networks", "open_web", "buckets", @@ -6516,43 +6538,9 @@ "forum_content", "blog_content", "profile", - "infected_devices", - "stealer_log", - "forum_topic", - "forum_post", - "forum_profile", - "ransomleak", - "listing", - "bot", - "seller", - "financial_data", - "blog_post", - "chat_message", - "bucket", - "google", - "stack_exchange", - "bucket_object", - "source_code_secrets", - "source_code_files", - "social_media", - "service", - "paste", - "bucket_object", - "bucket", - "source_code_secrets", - "source_code_files", - "stack_exchange", - "leak", - "domain", - "forum_topic", - "forum_post", - "blog_post", - "seller", - "forum_profile", - "stealer_log", - "bot" + "infected_devices" ], - "example": "illicit_networks", + "example": "seller", "type": "string" }, "type": "array" @@ -6605,6 +6593,99 @@ ], "type": "object" }, + "IdentifierCreate": { + "properties": { + "data": { + "properties": {}, + "type": "object" + }, + "experimental_search_types": { + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "minLength": 1, + "type": "string" + }, + "risks": { + "items": { + "type": "integer" + }, + "type": "array" + }, + "search_types": { + "items": { + "enum": [ + "seller", + "financial_data", + "chat_message", + "source_code_files", + "domain", + "source_code_secrets", + "forum_topic", + "blog_post", + "stealer_log", + "bot", + "forum_profile", + "paste", + "social_media", + "google", + "leak", + "bucket_object", + "stack_exchange", + "ransomleak", + "bucket", + "forum_post", + "ad", + "service", + "listing", + "illicit_networks", + "open_web", + "buckets", + "source_code", + "leaks", + "domains", + "forum_content", + "blog_content", + "profile", + "ads", + "infected_devices" + ], + "example": "seller", + "type": "string" + }, + "type": "array" + }, + "type": { + "enum": [ + "domain", + "brand", + "name", + "keyword", + "github_repository", + "username", + "email", + "search_query", + "dork_query", + "bin", + "ip", + "secret", + "azure_tenant" + ], + "example": "domain", + "type": "string" + } + }, + "required": [ + "data", + "name", + "search_types", + "type" + ], + "type": "object" + }, "IdentifierGroup": { "properties": { "feed_id": { @@ -6702,7 +6783,8 @@ "unknown_identifier_type", "bad_identifier_query", "above_max_group_nesting", - "unknown_identifier_source" + "unknown_identifier_source", + "identifier_not_allowed" ], "example": "unknown_identifier_type", "type": "string" @@ -7312,6 +7394,12 @@ "type": "integer" }, "sort_by": { + "enum": [ + "custom", + "alphabetical", + "date" + ], + "example": "custom", "type": "string" }, "time_interval": { @@ -7360,39 +7448,6 @@ ], "type": "object" }, - "SubscriptionPlan": { - "properties": { - "global_search_calls_limit": { - "description": "Number of calls allowed via API for global search on the plan", - "type": "integer" - }, - "id": { - "description": "Unique id for the Subscription plan", - "type": "integer" - }, - "identifier_rotation_limit": { - "description": "Maximum monthly allowed identifier rotations", - "type": "integer" - }, - "identifiers_price": { - "description": "Price of the identifiers plan", - "type": "integer" - }, - "max_identifiers": { - "description": "Maximum number of identifiers for the plan", - "type": "integer" - }, - "organization_id": { - "description": "Organization id associated with the plan", - "type": "integer" - }, - "plan_identifiers_template_id": { - "description": "Reference to the plan template for identifiers", - "type": "integer" - } - }, - "type": "object" - }, "TableChartDataModel": { "properties": { "items": { @@ -8083,6 +8138,12 @@ }, "name": { "type": "string" + }, + "pii_tags": { + "items": { + "type": "string" + }, + "type": "array" } }, "required": [ diff --git a/docs/api-reference/spec/firework-v2-swagger.json b/docs/api-reference/spec/firework-v2-swagger.json index 7c19625..1ac49c9 100644 --- a/docs/api-reference/spec/firework-v2-swagger.json +++ b/docs/api-reference/spec/firework-v2-swagger.json @@ -694,6 +694,28 @@ "search_types": { "items": { "enum": [ + "seller", + "financial_data", + "chat_message", + "source_code_files", + "domain", + "source_code_secrets", + "forum_topic", + "blog_post", + "stealer_log", + "bot", + "forum_profile", + "paste", + "social_media", + "google", + "leak", + "bucket_object", + "stack_exchange", + "ransomleak", + "bucket", + "forum_post", + "service", + "listing", "illicit_networks", "open_web", "buckets", @@ -703,43 +725,9 @@ "forum_content", "blog_content", "profile", - "infected_devices", - "stealer_log", - "forum_topic", - "forum_post", - "forum_profile", - "ransomleak", - "listing", - "bot", - "seller", - "financial_data", - "blog_post", - "chat_message", - "bucket", - "google", - "stack_exchange", - "bucket_object", - "source_code_secrets", - "source_code_files", - "social_media", - "service", - "paste", - "bucket_object", - "bucket", - "source_code_secrets", - "source_code_files", - "stack_exchange", - "leak", - "domain", - "forum_topic", - "forum_post", - "blog_post", - "seller", - "forum_profile", - "stealer_log", - "bot" + "infected_devices" ], - "example": "illicit_networks", + "example": "seller", "type": "string" }, "type": "array" @@ -792,6 +780,98 @@ ], "type": "object" }, + "IdentifierCreate": { + "properties": { + "data": { + "type": "object" + }, + "experimental_search_types": { + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "minLength": 1, + "type": "string" + }, + "risks": { + "items": { + "type": "integer" + }, + "type": "array" + }, + "search_types": { + "items": { + "enum": [ + "seller", + "financial_data", + "chat_message", + "source_code_files", + "domain", + "source_code_secrets", + "forum_topic", + "blog_post", + "stealer_log", + "bot", + "forum_profile", + "paste", + "social_media", + "google", + "leak", + "bucket_object", + "stack_exchange", + "ransomleak", + "bucket", + "forum_post", + "ad", + "service", + "listing", + "illicit_networks", + "open_web", + "buckets", + "source_code", + "leaks", + "domains", + "forum_content", + "blog_content", + "profile", + "ads", + "infected_devices" + ], + "example": "seller", + "type": "string" + }, + "type": "array" + }, + "type": { + "enum": [ + "domain", + "brand", + "name", + "keyword", + "github_repository", + "username", + "email", + "search_query", + "dork_query", + "bin", + "ip", + "secret", + "azure_tenant" + ], + "example": "domain", + "type": "string" + } + }, + "required": [ + "data", + "name", + "search_types", + "type" + ], + "type": "object" + }, "IdentifierGroup": { "properties": { "feed_id": { @@ -907,7 +987,8 @@ "unknown_identifier_type", "bad_identifier_query", "above_max_group_nesting", - "unknown_identifier_source" + "unknown_identifier_source", + "identifier_not_allowed" ], "example": "unknown_identifier_type", "type": "string" @@ -1570,6 +1651,12 @@ "type": "integer" }, "sort_by": { + "enum": [ + "custom", + "alphabetical", + "date" + ], + "example": "custom", "type": "string" }, "time_interval": { @@ -1617,39 +1704,6 @@ ], "type": "object" }, - "SubscriptionPlan": { - "properties": { - "global_search_calls_limit": { - "description": "Number of calls allowed via API for global search on the plan", - "type": "integer" - }, - "id": { - "description": "Unique id for the Subscription plan", - "type": "integer" - }, - "identifier_rotation_limit": { - "description": "Maximum monthly allowed identifier rotations", - "type": "integer" - }, - "identifiers_price": { - "description": "Price of the identifiers plan", - "type": "integer" - }, - "max_identifiers": { - "description": "Maximum number of identifiers for the plan", - "type": "integer" - }, - "organization_id": { - "description": "Organization id associated with the plan", - "type": "integer" - }, - "plan_identifiers_template_id": { - "description": "Reference to the plan template for identifiers", - "type": "integer" - } - }, - "type": "object" - }, "TableChartDataModel": { "properties": { "items": { @@ -2436,6 +2490,12 @@ }, "name": { "type": "string" + }, + "pii_tags": { + "items": { + "type": "string" + }, + "type": "array" } }, "required": [ @@ -3459,7 +3519,7 @@ "name": "payload", "required": true, "schema": { - "$ref": "#/definitions/Identifier" + "$ref": "#/definitions/IdentifierCreate" } } ], @@ -3773,7 +3833,7 @@ }, { "collectionFormat": "multi", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: stealer_log, forum_topic, forum_post, forum_profile, ransomleak, listing, bot, seller, financial_data, blog_post, chat_message\n- open_web: bucket, google, stack_exchange, bucket_object, source_code_secrets, source_code_files, social_media, service, paste\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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, bot, stealer_log, forum_profile, seller, financial_data, ransomleak, chat_message, forum_post, forum_topic, listing\n- open_web: bucket_object, paste, stack_exchange, google, social_media, bucket, source_code_files, source_code_secrets, service\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -4035,7 +4095,7 @@ }, { "collectionFormat": "multi", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: stealer_log, forum_topic, forum_post, forum_profile, ransomleak, listing, bot, seller, financial_data, blog_post, chat_message\n- open_web: bucket, google, stack_exchange, bucket_object, source_code_secrets, source_code_files, social_media, service, paste\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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, bot, stealer_log, forum_profile, seller, financial_data, ransomleak, chat_message, forum_post, forum_topic, listing\n- open_web: bucket_object, paste, stack_exchange, google, social_media, bucket, source_code_files, source_code_secrets, service\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -4467,7 +4527,7 @@ }, { "collectionFormat": "multi", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: stealer_log, forum_topic, forum_post, forum_profile, ransomleak, listing, bot, seller, financial_data, blog_post, chat_message\n- open_web: bucket, google, stack_exchange, bucket_object, source_code_secrets, source_code_files, social_media, service, paste\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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, bot, stealer_log, forum_profile, seller, financial_data, ransomleak, chat_message, forum_post, forum_topic, listing\n- open_web: bucket_object, paste, stack_exchange, google, social_media, bucket, source_code_files, source_code_secrets, service\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -4729,7 +4789,7 @@ }, { "collectionFormat": "multi", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: stealer_log, forum_topic, forum_post, forum_profile, ransomleak, listing, bot, seller, financial_data, blog_post, chat_message\n- open_web: bucket, google, stack_exchange, bucket_object, source_code_secrets, source_code_files, social_media, service, paste\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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, bot, stealer_log, forum_profile, seller, financial_data, ransomleak, chat_message, forum_post, forum_topic, listing\n- open_web: bucket_object, paste, stack_exchange, google, social_media, bucket, source_code_files, source_code_secrets, service\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -5036,7 +5096,7 @@ }, { "collectionFormat": "multi", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: stealer_log, forum_topic, forum_post, forum_profile, ransomleak, listing, bot, seller, financial_data, blog_post, chat_message\n- open_web: bucket, google, stack_exchange, bucket_object, source_code_secrets, source_code_files, social_media, service, paste\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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, bot, stealer_log, forum_profile, seller, financial_data, ransomleak, chat_message, forum_post, forum_topic, listing\n- open_web: bucket_object, paste, stack_exchange, google, social_media, bucket, source_code_files, source_code_secrets, service\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -5334,7 +5394,7 @@ }, { "collectionFormat": "multi", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: stealer_log, forum_topic, forum_post, forum_profile, ransomleak, listing, bot, seller, financial_data, blog_post, chat_message\n- open_web: bucket, google, stack_exchange, bucket_object, source_code_secrets, source_code_files, social_media, service, paste\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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, bot, stealer_log, forum_profile, seller, financial_data, ransomleak, chat_message, forum_post, forum_topic, listing\n- open_web: bucket_object, paste, stack_exchange, google, social_media, bucket, source_code_files, source_code_secrets, service\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -5566,7 +5626,7 @@ }, { "collectionFormat": "multi", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: stealer_log, forum_topic, forum_post, forum_profile, ransomleak, listing, bot, seller, financial_data, blog_post, chat_message\n- open_web: bucket, google, stack_exchange, bucket_object, source_code_secrets, source_code_files, social_media, service, paste\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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, bot, stealer_log, forum_profile, seller, financial_data, ransomleak, chat_message, forum_post, forum_topic, listing\n- open_web: bucket_object, paste, stack_exchange, google, social_media, bucket, source_code_files, source_code_secrets, service\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -6387,7 +6447,7 @@ }, { "collectionFormat": "multi", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: stealer_log, forum_topic, forum_post, forum_profile, ransomleak, listing, bot, seller, financial_data, blog_post, chat_message\n- open_web: bucket, google, stack_exchange, bucket_object, source_code_secrets, source_code_files, social_media, service, paste\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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, bot, stealer_log, forum_profile, seller, financial_data, ransomleak, chat_message, forum_post, forum_topic, listing\n- open_web: bucket_object, paste, stack_exchange, google, social_media, bucket, source_code_files, source_code_secrets, service\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -6633,7 +6693,7 @@ }, { "collectionFormat": "multi", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: stealer_log, forum_topic, forum_post, forum_profile, ransomleak, listing, bot, seller, financial_data, blog_post, chat_message\n- open_web: bucket, google, stack_exchange, bucket_object, source_code_secrets, source_code_files, social_media, service, paste\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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, bot, stealer_log, forum_profile, seller, financial_data, ransomleak, chat_message, forum_post, forum_topic, listing\n- open_web: bucket_object, paste, stack_exchange, google, social_media, bucket, source_code_files, source_code_secrets, service\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", diff --git a/docs/api-reference/spec/firework-v3-openapi.json b/docs/api-reference/spec/firework-v3-openapi.json index a522a12..219c72c 100644 --- a/docs/api-reference/spec/firework-v3-openapi.json +++ b/docs/api-reference/spec/firework-v3-openapi.json @@ -473,7 +473,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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, listing, blog_post, seller, forum_topic, stealer_log, ransomleak, forum_profile, bot, forum_post, financial_data\n- open_web: bucket_object, google, source_code_files, bucket, social_media, paste, stack_exchange, source_code_secrets, service\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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, bot, stealer_log, forum_profile, seller, financial_data, ransomleak, chat_message, forum_post, forum_topic, listing\n- open_web: bucket_object, paste, stack_exchange, google, social_media, bucket, source_code_files, source_code_secrets, service\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -791,7 +791,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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, listing, blog_post, seller, forum_topic, stealer_log, ransomleak, forum_profile, bot, forum_post, financial_data\n- open_web: bucket_object, google, source_code_files, bucket, social_media, paste, stack_exchange, source_code_secrets, service\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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, bot, stealer_log, forum_profile, seller, financial_data, ransomleak, chat_message, forum_post, forum_topic, listing\n- open_web: bucket_object, paste, stack_exchange, google, social_media, bucket, source_code_files, source_code_secrets, service\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -2043,6 +2043,10 @@ "fetching_progress": { "type": "integer" }, + "first_rate_limited_at": { + "format": "date-time", + "type": "string" + }, "id": { "type": "integer" }, @@ -2226,6 +2230,9 @@ "identifier_count": { "type": "integer" }, + "rate_limited_identifiers_count": { + "type": "integer" + }, "total_identifier_count": { "type": "integer" } @@ -2543,6 +2550,12 @@ }, "name": { "type": "string" + }, + "pii_tags": { + "items": { + "type": "string" + }, + "type": "array" } }, "required": [ diff --git a/docs/api-reference/spec/firework-v3-swagger.json b/docs/api-reference/spec/firework-v3-swagger.json index efb9b44..694ab57 100644 --- a/docs/api-reference/spec/firework-v3-swagger.json +++ b/docs/api-reference/spec/firework-v3-swagger.json @@ -307,6 +307,10 @@ "fetching_progress": { "type": "integer" }, + "first_rate_limited_at": { + "format": "date-time", + "type": "string" + }, "id": { "type": "integer" }, @@ -515,6 +519,9 @@ "identifier_count": { "type": "integer" }, + "rate_limited_identifiers_count": { + "type": "integer" + }, "total_identifier_count": { "type": "integer" } @@ -866,6 +873,12 @@ }, "name": { "type": "string" + }, + "pii_tags": { + "items": { + "type": "string" + }, + "type": "array" } }, "required": [ @@ -1240,7 +1253,7 @@ }, { "collectionFormat": "multi", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, listing, blog_post, seller, forum_topic, stealer_log, ransomleak, forum_profile, bot, forum_post, financial_data\n- open_web: bucket_object, google, source_code_files, bucket, social_media, paste, stack_exchange, source_code_secrets, service\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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, bot, stealer_log, forum_profile, seller, financial_data, ransomleak, chat_message, forum_post, forum_topic, listing\n- open_web: bucket_object, paste, stack_exchange, google, social_media, bucket, source_code_files, source_code_secrets, service\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -1502,7 +1515,7 @@ }, { "collectionFormat": "multi", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, listing, blog_post, seller, forum_topic, stealer_log, ransomleak, forum_profile, bot, forum_post, financial_data\n- open_web: bucket_object, google, source_code_files, bucket, social_media, paste, stack_exchange, source_code_secrets, service\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, chat_message/telegram, 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, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, bot, stealer_log, forum_profile, seller, financial_data, ransomleak, chat_message, forum_post, forum_topic, listing\n- open_web: bucket_object, paste, stack_exchange, google, social_media, bucket, source_code_files, source_code_secrets, service\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", diff --git a/docs/api-reference/spec/firework-v4-openapi.json b/docs/api-reference/spec/firework-v4-openapi.json index c67a28f..8febe45 100644 --- a/docs/api-reference/spec/firework-v4-openapi.json +++ b/docs/api-reference/spec/firework-v4-openapi.json @@ -139,6 +139,25 @@ "type": "string", "title": "Actor Name" } + }, + { + "name": "sources[]", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ], + "title": "Sources[]" + } } ], "responses": { @@ -178,6 +197,88 @@ "type": "string", "title": "Actor Name" } + }, + { + "name": "times", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Times" + } + }, + { + "name": "search_types[]", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/SearchType" + } + }, + { + "type": "null" + } + ], + "title": "Search Types[]" + } + }, + { + "name": "risk_scores[]", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/RiskScore" + } + }, + { + "type": "null" + } + ], + "title": "Risk Scores[]" + } + }, + { + "name": "sources[]", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ], + "title": "Sources[]" + } + }, + { + "name": "aggregate_by", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/StatsAggregates", + "default": "monthly" + } } ], "responses": { @@ -204,6 +305,176 @@ } } }, + "/actors/{actor_name}/recent-activities": { + "get": { + "summary": "Get Actor Recent Activities", + "operationId": "get_actor_recent_activities_actors__actor_name__recent_activities_get", + "parameters": [ + { + "name": "actor_name", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Actor Name" + } + }, + { + "name": "times", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Times" + } + }, + { + "name": "search_types[]", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/SearchType" + } + }, + { + "type": "null" + } + ], + "title": "Search Types[]" + } + }, + { + "name": "risk_scores[]", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/RiskScore" + } + }, + { + "type": "null" + } + ], + "title": "Risk Scores[]" + } + }, + { + "name": "sources[]", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ], + "title": "Sources[]" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActorRecentActivities" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/actors/{actor_name}/summary": { + "get": { + "summary": "Get Actor Summary", + "operationId": "get_actor_summary_actors__actor_name__summary_get", + "parameters": [ + { + "name": "actor_name", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Actor Name" + } + }, + { + "name": "sources[]", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ], + "title": "Sources[]" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActorSummary" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, "/alerts/": { "get": { "summary": "Tenant Alerts", @@ -775,8 +1046,8 @@ } }, "post": { - "summary": "Validate Credentials", - "operationId": "validate_credentials_integrations_credential_validations_post", + "summary": "Validate Credential", + "operationId": "validate_credential_integrations_credential_validations_post", "requestBody": { "required": true, "content": { @@ -811,15 +1082,15 @@ } } }, - "/credentials/entra-id/validate": { + "/events/tenant/_search": { "post": { - "summary": "Validate Credentials", - "operationId": "validate_credentials_credentials_entra_id_validate_post", + "summary": "Current Tenant Feed", + "operationId": "current_tenant_feed_events_tenant__search_post", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CredentialId" + "$ref": "#/components/schemas/FeedRequestBody" } } }, @@ -831,7 +1102,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ValidatedCredential" + "$ref": "#/components/schemas/PaginatedResults_FeedItem_" } } } @@ -849,15 +1120,15 @@ } } }, - "/events/tenant/_search": { + "/events/global/_search": { "post": { - "summary": "Current Tenant Feed", - "operationId": "current_tenant_feed_events_tenant__search_post", + "summary": "Global Search", + "operationId": "global_search_events_global__search_post", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FeedRequestBody" + "$ref": "#/components/schemas/GlobalSearchRequestBody" } } }, @@ -887,45 +1158,7 @@ } } }, - "/events/global/_search": { - "post": { - "summary": "Global Search", - "operationId": "global_search_events_global__search_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GlobalSearchRequestBody" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_FeedItem_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/events/identifiers/{identifier_id}/_search": { + "/events/identifiers/{identifier_id}/_search": { "post": { "summary": "Identifier Feed", "operationId": "identifier_feed_events_identifiers__identifier_id___search_post", @@ -1207,6 +1440,90 @@ } } } + }, + "patch": { + "summary": "Update Report", + "operationId": "update_report_reports__report_id__patch", + "parameters": [ + { + "name": "report_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Report Id" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReportUpdatePayload" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/firework__backend__api4__reports__report_datamodels__ReportResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "delete": { + "summary": "Delete Report", + "operationId": "delete_report_reports__report_id__delete", + "parameters": [ + { + "name": "report_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Report Id" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/firework__backend__api4__reports__report_datamodels__ReportResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } } }, "/reports/": { @@ -1350,59 +1667,18 @@ } } }, - "/integrations/tenant_integrations/": { + "/reports/{report_id}/config": { "get": { - "summary": "Get Tenant Integrations", - "operationId": "get_tenant_integrations_integrations_tenant_integrations__get", + "summary": "Get Report Config", + "operationId": "get_report_config_reports__report_id__config_get", "parameters": [ { - "name": "from_", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "From " - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Size" - } - }, - { - "name": "order_type", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/OrderType", - "default": "asc" - } - }, - { - "name": "tenant_id", - "in": "query", + "name": "report_id", + "in": "path", "required": true, "schema": { "type": "integer", - "title": "Tenant Id" + "title": "Report Id" } } ], @@ -1412,7 +1688,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedResults_TenantIntegration_" + "$ref": "#/components/schemas/ReportConfigResponse" } } } @@ -1429,26 +1705,37 @@ } } }, - "post": { - "summary": "Create Tenant Integration", - "operationId": "create_tenant_integration_integrations_tenant_integrations__post", + "patch": { + "summary": "Update Report Config", + "operationId": "update_report_config_reports__report_id__config_patch", + "parameters": [ + { + "name": "report_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Report Id" + } + } + ], "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateTenantIntegration" + "$ref": "#/components/schemas/ReportConfigUpdatePayload" } } } }, "responses": { - "201": { + "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TenantIntegration" + "$ref": "#/components/schemas/ReportConfigResponse" } } } @@ -1466,19 +1753,28 @@ } } }, - "/integrations/tenant_integrations/{tenant_integration_id}": { + "/reports/{report_id}/sections/{uid}": { "get": { - "summary": "Get Tenant Integration", - "operationId": "get_tenant_integration_integrations_tenant_integrations__tenant_integration_id__get", + "summary": "Get Report Section", + "operationId": "get_report_section_reports__report_id__sections__uid__get", "parameters": [ { - "name": "tenant_integration_id", + "name": "uid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", - "title": "Tenant Integration Id" + "title": "Uid" + } + }, + { + "name": "report_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Report Id" } } ], @@ -1488,7 +1784,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TenantIntegration" + "$ref": "#/components/schemas/ReportSectionResponse" } } } @@ -1505,18 +1801,27 @@ } } }, - "put": { - "summary": "Update Tenant Integration", - "operationId": "update_tenant_integration_integrations_tenant_integrations__tenant_integration_id__put", + "patch": { + "summary": "Update Report Section", + "operationId": "update_report_section_reports__report_id__sections__uid__patch", "parameters": [ { - "name": "tenant_integration_id", + "name": "uid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", - "title": "Tenant Integration Id" + "title": "Uid" + } + }, + { + "name": "report_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Report Id" } } ], @@ -1525,7 +1830,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateTenantIntegration" + "$ref": "#/components/schemas/ReportSectionUpdatePayload" } } } @@ -1535,7 +1840,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/ReportSectionResponse" + } } } }, @@ -1552,11 +1859,20 @@ } } }, - "/threat_flow/reports/": { + "/reports/{report_id}/sections": { "get": { - "summary": "List Reports", - "operationId": "list_reports_threat_flow_reports__get", + "summary": "List Report Sections", + "operationId": "list_report_sections_reports__report_id__sections_get", "parameters": [ + { + "name": "report_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Report Id" + } + }, { "name": "from_", "in": "query", @@ -1579,37 +1895,11 @@ "required": false, "schema": { "type": "integer", - "default": 10, + "maximum": 100, + "exclusiveMinimum": 0, + "default": 30, "title": "Size" } - }, - { - "name": "order", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/OrderType", - "default": "desc" - } - }, - { - "name": "report_types", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/pyro__threat_flow__core__reports__report_store__ReportType" - } - }, - { - "type": "null" - } - ], - "title": "Report Types" - } } ], "responses": { @@ -1618,7 +1908,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/firework__backend__api4__models__PaginatedResults_Report___2" + "$ref": "#/components/schemas/PaginatedResults_ReportSection_" } } } @@ -1636,10 +1926,355 @@ } } }, - "/threat_flow/reports/{report_id}": { - "get": { - "summary": "Get Report", - "operationId": "get_report_threat_flow_reports__report_id__get", + "/reports/{report_id}/archive": { + "patch": { + "summary": "Archive Report", + "operationId": "archive_report_reports__report_id__archive_patch", + "parameters": [ + { + "name": "report_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Report Id" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/firework__backend__api4__reports__report_datamodels__ReportResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/integrations/tenant_integrations": { + "get": { + "summary": "Get Tenant Integrations", + "operationId": "get_tenant_integrations_integrations_tenant_integrations_get", + "parameters": [ + { + "name": "from_", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "From " + } + }, + { + "name": "size", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Size" + } + }, + { + "name": "order_type", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/OrderType", + "default": "asc" + } + }, + { + "name": "tenant_id", + "in": "query", + "required": true, + "schema": { + "type": "integer", + "title": "Tenant Id" + } + }, + { + "name": "include_params", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false, + "title": "Include Params" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaginatedResults_TenantIntegrationItem_" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "post": { + "summary": "Create Tenant Integration", + "operationId": "create_tenant_integration_integrations_tenant_integrations_post", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateTenantIntegration" + } + } + } + }, + "responses": { + "201": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantIntegrationItem" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/integrations/tenant_integrations/{tenant_integration_id}": { + "get": { + "summary": "Get Tenant Integration", + "operationId": "get_tenant_integration_integrations_tenant_integrations__tenant_integration_id__get", + "parameters": [ + { + "name": "tenant_integration_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Tenant Integration Id" + } + }, + { + "name": "include_params", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false, + "title": "Include Params" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantIntegrationItem" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "put": { + "summary": "Update Tenant Integration", + "operationId": "update_tenant_integration_integrations_tenant_integrations__tenant_integration_id__put", + "parameters": [ + { + "name": "tenant_integration_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Tenant Integration Id" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateTenantIntegration" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/threat_flow/reports/": { + "get": { + "summary": "List Reports", + "operationId": "list_reports_threat_flow_reports__get", + "parameters": [ + { + "name": "from_", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "From " + } + }, + { + "name": "size", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "default": 10, + "title": "Size" + } + }, + { + "name": "order", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/OrderType", + "default": "desc" + } + }, + { + "name": "report_types", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/pyro__threat_flow__core__reports__report_store__ReportType" + } + }, + { + "type": "null" + } + ], + "title": "Report Types" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/firework__backend__api4__models__PaginatedResults_Report___2" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/threat_flow/reports/{report_id}": { + "get": { + "summary": "Get Report", + "operationId": "get_report_threat_flow_reports__report_id__get", "parameters": [ { "name": "report_id", @@ -2174,14 +2809,90 @@ ], "title": "ActorProfile" }, + "ActorRecentActivities": { + "properties": { + "name": { + "type": "string", + "title": "Name" + }, + "recent_activities": { + "items": { + "$ref": "#/components/schemas/ActorRecentActivity" + }, + "type": "array", + "title": "Recent Activities" + } + }, + "type": "object", + "required": [ + "name", + "recent_activities" + ], + "title": "ActorRecentActivities" + }, + "ActorRecentActivity": { + "properties": { + "date": { + "type": "string", + "format": "date-time", + "title": "Date" + }, + "uid": { + "type": "string", + "title": "Uid" + }, + "risk_score": { + "$ref": "#/components/schemas/RiskScore" + }, + "extra_fields": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], + "title": "Extra Fields" + } + }, + "type": "object", + "required": [ + "date", + "uid", + "risk_score" + ], + "title": "ActorRecentActivity" + }, + "ActorSummary": { + "properties": { + "name": { + "type": "string", + "title": "Name" + }, + "summary": { + "type": "string", + "title": "Summary" + } + }, + "type": "object", + "required": [ + "name", + "summary" + ], + "title": "ActorSummary" + }, "ActorTimeline": { "properties": { "name": { "type": "string", "title": "Name" }, - "interval": { - "$ref": "#/components/schemas/OverTimeInterval" + "aggregate_by": { + "$ref": "#/components/schemas/StatsAggregates" }, "timeline": { "items": { @@ -2194,7 +2905,7 @@ "type": "object", "required": [ "name", - "interval", + "aggregate_by", "timeline" ], "title": "ActorTimeline" @@ -2231,6 +2942,10 @@ "type": "string", "title": "Created At" }, + "updated_at": { + "type": "string", + "title": "Updated At" + }, "id": { "type": "integer", "title": "Id" @@ -2313,6 +3028,7 @@ "feed_definition", "type", "created_at", + "updated_at", "id", "name", "tenant_id", @@ -2630,13 +3346,9 @@ "type": "string", "title": "Server Url" }, - "username": { - "type": "string", - "title": "Username" - }, - "password": { + "api_key": { "type": "string", - "title": "Password" + "title": "Api Key" }, "table_name": { "type": "string", @@ -2647,8 +3359,7 @@ "required": [ "type", "server_url", - "username", - "password", + "api_key", "table_name" ], "title": "AlertChannelServicenowParams" @@ -3074,7 +3785,7 @@ } ], "title": "Created After", - "default": "2025-03-18T15:44:56.726208Z" + "default": "2025-04-23T11:47:45.445296Z" }, "from": { "anyOf": [ @@ -3424,19 +4135,6 @@ ], "title": "CreateTenantIntegration" }, - "CredentialId": { - "properties": { - "credential_id": { - "type": "integer", - "title": "Credential Id" - } - }, - "type": "object", - "required": [ - "credential_id" - ], - "title": "CredentialId" - }, "CredentialValidationReponse": { "properties": { "tenant_integration_id": { @@ -3499,9 +4197,9 @@ "CredentialValidationStatus": { "type": "string", "enum": [ - "pending", - "valid", - "invalid" + "match", + "no_match", + "failed" ], "title": "CredentialValidationStatus" }, @@ -4829,15 +5527,13 @@ ], "title": "OrderType" }, - "OverTimeInterval": { + "OtherSectionType": { "type": "string", "enum": [ - "daily", - "weekly", - "monthly", - "yearly" + "appendix", + "executive_summary" ], - "title": "OverTimeInterval" + "title": "OtherSectionType" }, "PagedCookieConfigurations": { "properties": { @@ -5035,11 +5731,39 @@ ], "title": "PaginatedResults[PartialAlertChannel]" }, - "PaginatedResults_TenantIntegration_": { + "PaginatedResults_ReportSection_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/ReportSection" + }, + "type": "array", + "title": "Items" + }, + "next": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[ReportSection]" + }, + "PaginatedResults_TenantIntegrationItem_": { "properties": { "items": { "items": { - "$ref": "#/components/schemas/TenantIntegration" + "$ref": "#/components/schemas/TenantIntegrationItem" }, "type": "array", "title": "Items" @@ -5061,7 +5785,7 @@ "items", "next" ], - "title": "PaginatedResults[TenantIntegration]" + "title": "PaginatedResults[TenantIntegrationItem]" }, "PartialAlert": { "properties": { @@ -5258,39 +5982,142 @@ "type": "array", "title": "Conversation Messages" }, - "conversation_name": { - "type": "string", - "title": "Conversation Name" + "conversation_name": { + "type": "string", + "title": "Conversation Name" + }, + "next": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Next" + }, + "previous": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Previous" + } + }, + "type": "object", + "required": [ + "conversation_messages", + "conversation_name" + ], + "title": "RelatedConversationResponse" + }, + "ReportAnalyticSectionType": { + "type": "string", + "enum": [ + "analytics", + "cumulative_event_growth", + "remediated_and_ignored_events", + "event_distribution", + "mean_time_to_remediation", + "total_enabled_identifiers_per_category", + "total_identifiers" + ], + "title": "ReportAnalyticSectionType" + }, + "ReportConfigResponse": { + "properties": { + "report_config": { + "$ref": "#/components/schemas/ReportFeedConfig" + } + }, + "type": "object", + "required": [ + "report_config" + ], + "title": "ReportConfigResponse" + }, + "ReportConfigUpdatePayload": { + "properties": { + "feed_definition": { + "anyOf": [ + { + "$ref": "#/components/schemas/FeedDefinition" + }, + { + "type": "null" + } + ] + }, + "search_types": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/SearchType" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Search Types" + }, + "risks": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/RiskScore" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Risks" + }, + "time_range_type": { + "anyOf": [ + { + "$ref": "#/components/schemas/TimeRangeType" + }, + { + "type": "null" + } + ] }, - "next": { + "time_range_from": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Next" + "title": "Time Range From" }, - "previous": { + "time_range_to": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Previous" + "title": "Time Range To" } }, "type": "object", - "required": [ - "conversation_messages", - "conversation_name" - ], - "title": "RelatedConversationResponse" + "title": "ReportConfigUpdatePayload" }, "ReportCreationPayload": { "properties": { @@ -5316,6 +6143,68 @@ ], "title": "ReportCreationPayload" }, + "ReportFeedConfig": { + "properties": { + "report_id": { + "type": "integer", + "title": "Report Id" + }, + "tenant_id": { + "type": "integer", + "title": "Tenant Id" + }, + "feed_definition": { + "$ref": "#/components/schemas/FeedDefinition" + }, + "identifier_scope": { + "$ref": "#/components/schemas/IdentifierScope" + }, + "search_types": { + "items": { + "$ref": "#/components/schemas/SearchType" + }, + "type": "array", + "title": "Search Types" + }, + "available_search_types": { + "items": { + "$ref": "#/components/schemas/SearchType" + }, + "type": "array", + "title": "Available Search Types" + }, + "risks": { + "items": { + "$ref": "#/components/schemas/RiskScore" + }, + "type": "array", + "title": "Risks" + }, + "time_range_from": { + "type": "string", + "format": "date-time", + "title": "Time Range From" + }, + "time_range_to": { + "type": "string", + "format": "date-time", + "title": "Time Range To" + } + }, + "type": "object", + "required": [ + "report_id", + "tenant_id", + "feed_definition", + "identifier_scope", + "search_types", + "available_search_types", + "risks", + "time_range_from", + "time_range_to" + ], + "title": "ReportFeedConfig" + }, "ReportRequestInfoResponse": { "properties": { "status": { @@ -5432,6 +6321,128 @@ ], "title": "ReportRequestResponse" }, + "ReportSection": { + "properties": { + "uid": { + "type": "string", + "format": "uuid", + "title": "Uid" + }, + "report_id": { + "type": "integer", + "title": "Report Id" + }, + "tenant_id": { + "type": "integer", + "title": "Tenant Id" + }, + "main_category": { + "anyOf": [ + { + "$ref": "#/components/schemas/SearchType" + }, + { + "$ref": "#/components/schemas/ReportAnalyticSectionType" + }, + { + "$ref": "#/components/schemas/OtherSectionType" + } + ], + "title": "Main Category" + }, + "sub_category": { + "anyOf": [ + { + "$ref": "#/components/schemas/SearchType" + }, + { + "$ref": "#/components/schemas/ReportAnalyticSectionType" + }, + { + "$ref": "#/components/schemas/OtherSectionType" + } + ], + "title": "Sub Category" + }, + "content": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Content" + }, + "enabled": { + "type": "boolean", + "title": "Enabled" + }, + "visible": { + "type": "boolean", + "title": "Visible" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "title": "Updated At" + } + }, + "type": "object", + "required": [ + "uid", + "report_id", + "tenant_id", + "main_category", + "sub_category", + "content", + "enabled", + "visible", + "updated_at" + ], + "title": "ReportSection" + }, + "ReportSectionResponse": { + "properties": { + "report_section": { + "$ref": "#/components/schemas/ReportSection" + } + }, + "type": "object", + "required": [ + "report_section" + ], + "title": "ReportSectionResponse" + }, + "ReportSectionUpdatePayload": { + "properties": { + "content": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Content" + }, + "enabled": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Enabled" + } + }, + "type": "object", + "title": "ReportSectionUpdatePayload" + }, "ReportStatus": { "type": "string", "enum": [ @@ -5450,6 +6461,57 @@ ], "title": "ReportType" }, + "ReportUpdatePayload": { + "properties": { + "title": { + "anyOf": [ + { + "type": "string", + "minLength": 1 + }, + { + "type": "null" + } + ], + "title": "Title" + }, + "author": { + "anyOf": [ + { + "type": "string", + "minLength": 1 + }, + { + "type": "null" + } + ], + "title": "Author" + }, + "report_type": { + "anyOf": [ + { + "$ref": "#/components/schemas/pyro__reports__report_models__ReportType" + }, + { + "type": "null" + } + ] + }, + "include_flare_event_links": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Include Flare Event Links" + } + }, + "type": "object", + "title": "ReportUpdatePayload" + }, "RequestStatus": { "type": "string", "enum": [ @@ -5571,6 +6633,16 @@ ], "title": "SortType" }, + "StatsAggregates": { + "type": "string", + "enum": [ + "daily", + "weekly", + "monthly", + "yearly" + ], + "title": "StatsAggregates" + }, "TagListPayload": { "properties": { "tags": { @@ -5620,7 +6692,7 @@ ], "title": "TagPayload" }, - "TenantIntegration": { + "TenantIntegrationItem": { "properties": { "id": { "type": "string", @@ -5631,8 +6703,18 @@ "type": "integer", "title": "Tenant Id" }, + "type": { + "$ref": "#/components/schemas/TenantIntegrationType" + }, "params": { - "$ref": "#/components/schemas/EntraIDParams" + "anyOf": [ + { + "$ref": "#/components/schemas/EntraIDParams" + }, + { + "type": "null" + } + ] }, "is_enabled": { "type": "boolean", @@ -5653,12 +6735,20 @@ "required": [ "id", "tenant_id", + "type", "params", "is_enabled", "created_at", "updated_at" ], - "title": "TenantIntegration" + "title": "TenantIntegrationItem" + }, + "TenantIntegrationType": { + "type": "string", + "enum": [ + "entra_id" + ], + "title": "TenantIntegrationType" }, "ThreatFlowReportDownloadFormat": { "type": "string", @@ -5822,19 +6912,6 @@ ], "title": "UsernameQuery" }, - "ValidatedCredential": { - "properties": { - "is_valid": { - "type": "boolean", - "title": "Is Valid" - } - }, - "type": "object", - "required": [ - "is_valid" - ], - "title": "ValidatedCredential" - }, "ValidationError": { "properties": { "loc": { diff --git a/docs/api-reference/v2/endpoints/activities/get-activities--parent_chat_data.mdx b/docs/api-reference/v2/endpoints/activities/get-activities--parent_chat_data.mdx new file mode 100644 index 0000000..55926e9 --- /dev/null +++ b/docs/api-reference/v2/endpoints/activities/get-activities--parent_chat_data.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /activities/{index}/{source}/{id}/parent_chat_data +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/alert-channels.mdx b/docs/api-reference/v4/endpoints/alert-channels.mdx new file mode 100644 index 0000000..4105072 --- /dev/null +++ b/docs/api-reference/v4/endpoints/alert-channels.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /alerts/channels +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/archive-report.mdx b/docs/api-reference/v4/endpoints/archive-report.mdx new file mode 100644 index 0000000..8404d70 --- /dev/null +++ b/docs/api-reference/v4/endpoints/archive-report.mdx @@ -0,0 +1,3 @@ +--- +openapi: patch /reports/{report_id}/archive +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/bulk-actions.mdx b/docs/api-reference/v4/endpoints/bulk-actions.mdx new file mode 100644 index 0000000..3efc4e3 --- /dev/null +++ b/docs/api-reference/v4/endpoints/bulk-actions.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /tasks/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/create-channel.mdx b/docs/api-reference/v4/endpoints/create-channel.mdx new file mode 100644 index 0000000..c230bca --- /dev/null +++ b/docs/api-reference/v4/endpoints/create-channel.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /alerts/channels +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/create-conversation-summary-request.mdx b/docs/api-reference/v4/endpoints/create-conversation-summary-request.mdx new file mode 100644 index 0000000..53b0156 --- /dev/null +++ b/docs/api-reference/v4/endpoints/create-conversation-summary-request.mdx @@ -0,0 +1,3 @@ +--- +openapi: put /threat_flow/conversation_summary_requests/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/create-report.mdx b/docs/api-reference/v4/endpoints/create-report.mdx new file mode 100644 index 0000000..f699529 --- /dev/null +++ b/docs/api-reference/v4/endpoints/create-report.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /reports/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/create-tenant-integration.mdx b/docs/api-reference/v4/endpoints/create-tenant-integration.mdx new file mode 100644 index 0000000..58f97bc --- /dev/null +++ b/docs/api-reference/v4/endpoints/create-tenant-integration.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /integrations/tenant_integrations +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/delete-channel.mdx b/docs/api-reference/v4/endpoints/delete-channel.mdx new file mode 100644 index 0000000..389be43 --- /dev/null +++ b/docs/api-reference/v4/endpoints/delete-channel.mdx @@ -0,0 +1,3 @@ +--- +openapi: delete /alerts/channels/{alert_channel_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/delete-report-1.mdx b/docs/api-reference/v4/endpoints/delete-report-1.mdx new file mode 100644 index 0000000..61d99b6 --- /dev/null +++ b/docs/api-reference/v4/endpoints/delete-report-1.mdx @@ -0,0 +1,3 @@ +--- +openapi: delete /threat_flow/reports/{report_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/get-actor-profile.mdx b/docs/api-reference/v4/endpoints/get-actor-profile.mdx new file mode 100644 index 0000000..def8869 --- /dev/null +++ b/docs/api-reference/v4/endpoints/get-actor-profile.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /actors/{actor_name}/profile +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/get-actor-recent-activities.mdx b/docs/api-reference/v4/endpoints/get-actor-recent-activities.mdx new file mode 100644 index 0000000..47ec617 --- /dev/null +++ b/docs/api-reference/v4/endpoints/get-actor-recent-activities.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /actors/{actor_name}/recent-activities +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/get-actor-summary.mdx b/docs/api-reference/v4/endpoints/get-actor-summary.mdx new file mode 100644 index 0000000..b3dcc65 --- /dev/null +++ b/docs/api-reference/v4/endpoints/get-actor-summary.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /actors/{actor_name}/summary +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/get-actor-timeline.mdx b/docs/api-reference/v4/endpoints/get-actor-timeline.mdx new file mode 100644 index 0000000..f8588f3 --- /dev/null +++ b/docs/api-reference/v4/endpoints/get-actor-timeline.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /actors/{actor_name}/timeline +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/get-credential-validations.mdx b/docs/api-reference/v4/endpoints/get-credential-validations.mdx new file mode 100644 index 0000000..7b6114c --- /dev/null +++ b/docs/api-reference/v4/endpoints/get-credential-validations.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /integrations/credential_validations +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/get-related-conversation.mdx b/docs/api-reference/v4/endpoints/get-related-conversation.mdx new file mode 100644 index 0000000..ad3e72d --- /dev/null +++ b/docs/api-reference/v4/endpoints/get-related-conversation.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /threat_flow/unit_summary/related_conversation +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/get-report-1.mdx b/docs/api-reference/v4/endpoints/get-report-1.mdx new file mode 100644 index 0000000..a77f056 --- /dev/null +++ b/docs/api-reference/v4/endpoints/get-report-1.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /threat_flow/reports/{report_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/get-report-config.mdx b/docs/api-reference/v4/endpoints/get-report-config.mdx new file mode 100644 index 0000000..4fba38e --- /dev/null +++ b/docs/api-reference/v4/endpoints/get-report-config.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /reports/{report_id}/config +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/get-report-section.mdx b/docs/api-reference/v4/endpoints/get-report-section.mdx new file mode 100644 index 0000000..54debd5 --- /dev/null +++ b/docs/api-reference/v4/endpoints/get-report-section.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /reports/{report_id}/sections/{uid} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/get-tenant-alert.mdx b/docs/api-reference/v4/endpoints/get-tenant-alert.mdx new file mode 100644 index 0000000..cecd18c --- /dev/null +++ b/docs/api-reference/v4/endpoints/get-tenant-alert.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /alerts/{alert_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/get-tenant-integration.mdx b/docs/api-reference/v4/endpoints/get-tenant-integration.mdx new file mode 100644 index 0000000..45bc9ed --- /dev/null +++ b/docs/api-reference/v4/endpoints/get-tenant-integration.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /integrations/tenant_integrations/{tenant_integration_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/get-tenant-integrations.mdx b/docs/api-reference/v4/endpoints/get-tenant-integrations.mdx new file mode 100644 index 0000000..b2c80fa --- /dev/null +++ b/docs/api-reference/v4/endpoints/get-tenant-integrations.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /integrations/tenant_integrations +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/list-conversation-summary-requests.mdx b/docs/api-reference/v4/endpoints/list-conversation-summary-requests.mdx new file mode 100644 index 0000000..21436b4 --- /dev/null +++ b/docs/api-reference/v4/endpoints/list-conversation-summary-requests.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /threat_flow/conversation_summary_requests/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/list-report-sections.mdx b/docs/api-reference/v4/endpoints/list-report-sections.mdx new file mode 100644 index 0000000..607641f --- /dev/null +++ b/docs/api-reference/v4/endpoints/list-report-sections.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /reports/{report_id}/sections +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/list-reports-1.mdx b/docs/api-reference/v4/endpoints/list-reports-1.mdx new file mode 100644 index 0000000..74539b6 --- /dev/null +++ b/docs/api-reference/v4/endpoints/list-reports-1.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /threat_flow/reports/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/update-channel.mdx b/docs/api-reference/v4/endpoints/update-channel.mdx new file mode 100644 index 0000000..7c18c90 --- /dev/null +++ b/docs/api-reference/v4/endpoints/update-channel.mdx @@ -0,0 +1,3 @@ +--- +openapi: put /alerts/channels/{alert_channel_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/update-report-config.mdx b/docs/api-reference/v4/endpoints/update-report-config.mdx new file mode 100644 index 0000000..fd2c7be --- /dev/null +++ b/docs/api-reference/v4/endpoints/update-report-config.mdx @@ -0,0 +1,3 @@ +--- +openapi: patch /reports/{report_id}/config +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/update-report-section.mdx b/docs/api-reference/v4/endpoints/update-report-section.mdx new file mode 100644 index 0000000..c8c58f3 --- /dev/null +++ b/docs/api-reference/v4/endpoints/update-report-section.mdx @@ -0,0 +1,3 @@ +--- +openapi: patch /reports/{report_id}/sections/{uid} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/update-report.mdx b/docs/api-reference/v4/endpoints/update-report.mdx new file mode 100644 index 0000000..893781c --- /dev/null +++ b/docs/api-reference/v4/endpoints/update-report.mdx @@ -0,0 +1,3 @@ +--- +openapi: patch /reports/{report_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/update-tenant-integration.mdx b/docs/api-reference/v4/endpoints/update-tenant-integration.mdx new file mode 100644 index 0000000..d953184 --- /dev/null +++ b/docs/api-reference/v4/endpoints/update-tenant-integration.mdx @@ -0,0 +1,3 @@ +--- +openapi: put /integrations/tenant_integrations/{tenant_integration_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/validate-credential.mdx b/docs/api-reference/v4/endpoints/validate-credential.mdx new file mode 100644 index 0000000..e042543 --- /dev/null +++ b/docs/api-reference/v4/endpoints/validate-credential.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /integrations/credential_validations +--- \ No newline at end of file