diff --git a/docs/api-reference/spec/firework-v2-openapi.json b/docs/api-reference/spec/firework-v2-openapi.json index 1393624..461698c 100644 --- a/docs/api-reference/spec/firework-v2-openapi.json +++ b/docs/api-reference/spec/firework-v2-openapi.json @@ -1692,7 +1692,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: seller, bot, chat_message, forum_topic, blog_post, stealer_log, forum_post, financial_data, ransomleak, listing, forum_profile\n- open_web: service, paste, bucket, source_code_files, stack_exchange, google, social_media_account, bucket_object, source_code_secrets, docker\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, chat_message, seller, stealer_log, ransomleak, listing, forum_profile, forum_topic, bot, financial_data, blog_post\n- open_web: source_code_secrets, bucket, stack_exchange, paste, service, bucket_object, social_media_account, google, docker, source_code_files\n- leaks: leak, valid_credential, invalid_credential, mitigated_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -2016,7 +2016,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: seller, bot, chat_message, forum_topic, blog_post, stealer_log, forum_post, financial_data, ransomleak, listing, forum_profile\n- open_web: service, paste, bucket, source_code_files, stack_exchange, google, social_media_account, bucket_object, source_code_secrets, docker\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, chat_message, seller, stealer_log, ransomleak, listing, forum_profile, forum_topic, bot, financial_data, blog_post\n- open_web: source_code_secrets, bucket, stack_exchange, paste, service, bucket_object, social_media_account, google, docker, source_code_files\n- leaks: leak, valid_credential, invalid_credential, mitigated_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -2591,7 +2591,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: seller, bot, chat_message, forum_topic, blog_post, stealer_log, forum_post, financial_data, ransomleak, listing, forum_profile\n- open_web: service, paste, bucket, source_code_files, stack_exchange, google, social_media_account, bucket_object, source_code_secrets, docker\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, chat_message, seller, stealer_log, ransomleak, listing, forum_profile, forum_topic, bot, financial_data, blog_post\n- open_web: source_code_secrets, bucket, stack_exchange, paste, service, bucket_object, social_media_account, google, docker, source_code_files\n- leaks: leak, valid_credential, invalid_credential, mitigated_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -2915,7 +2915,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: seller, bot, chat_message, forum_topic, blog_post, stealer_log, forum_post, financial_data, ransomleak, listing, forum_profile\n- open_web: service, paste, bucket, source_code_files, stack_exchange, google, social_media_account, bucket_object, source_code_secrets, docker\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, chat_message, seller, stealer_log, ransomleak, listing, forum_profile, forum_topic, bot, financial_data, blog_post\n- open_web: source_code_secrets, bucket, stack_exchange, paste, service, bucket_object, social_media_account, google, docker, source_code_files\n- leaks: leak, valid_credential, invalid_credential, mitigated_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -3329,7 +3329,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: seller, bot, chat_message, forum_topic, blog_post, stealer_log, forum_post, financial_data, ransomleak, listing, forum_profile\n- open_web: service, paste, bucket, source_code_files, stack_exchange, google, social_media_account, bucket_object, source_code_secrets, docker\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, chat_message, seller, stealer_log, ransomleak, listing, forum_profile, forum_topic, bot, financial_data, blog_post\n- open_web: source_code_secrets, bucket, stack_exchange, paste, service, bucket_object, social_media_account, google, docker, source_code_files\n- leaks: leak, valid_credential, invalid_credential, mitigated_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -3612,7 +3612,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: seller, bot, chat_message, forum_topic, blog_post, stealer_log, forum_post, financial_data, ransomleak, listing, forum_profile\n- open_web: service, paste, bucket, source_code_files, stack_exchange, google, social_media_account, bucket_object, source_code_secrets, docker\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, chat_message, seller, stealer_log, ransomleak, listing, forum_profile, forum_topic, bot, financial_data, blog_post\n- open_web: source_code_secrets, bucket, stack_exchange, paste, service, bucket_object, social_media_account, google, docker, source_code_files\n- leaks: leak, valid_credential, invalid_credential, mitigated_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -4740,7 +4740,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: seller, bot, chat_message, forum_topic, blog_post, stealer_log, forum_post, financial_data, ransomleak, listing, forum_profile\n- open_web: service, paste, bucket, source_code_files, stack_exchange, google, social_media_account, bucket_object, source_code_secrets, docker\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, chat_message, seller, stealer_log, ransomleak, listing, forum_profile, forum_topic, bot, financial_data, blog_post\n- open_web: source_code_secrets, bucket, stack_exchange, paste, service, bucket_object, social_media_account, google, docker, source_code_files\n- leaks: leak, valid_credential, invalid_credential, mitigated_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -5044,7 +5044,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: seller, bot, chat_message, forum_topic, blog_post, stealer_log, forum_post, financial_data, ransomleak, listing, forum_profile\n- open_web: service, paste, bucket, source_code_files, stack_exchange, google, social_media_account, bucket_object, source_code_secrets, docker\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, chat_message, seller, stealer_log, ransomleak, listing, forum_profile, forum_topic, bot, financial_data, blog_post\n- open_web: source_code_secrets, bucket, stack_exchange, paste, service, bucket_object, social_media_account, google, docker, source_code_files\n- leaks: leak, valid_credential, invalid_credential, mitigated_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -5556,32 +5556,32 @@ "search_types": { "items": { "enum": [ - "seller", - "bot", - "service", - "forum_topic", - "bucket", - "stack_exchange", "forum_post", - "social_media_account", - "invalid_credential", "valid_credential", - "leak", - "chat_message", - "paste", - "blog_post", - "source_code_files", - "stealer_log", "mitigated_credential", - "financial_data", - "google", - "ad", - "domain", - "ransomleak", + "stack_exchange", "listing", - "forum_profile", + "paste", + "ad", "bucket_object", + "seller", + "chat_message", + "stealer_log", + "forum_profile", + "social_media_account", + "source_code_files", "source_code_secrets", + "bucket", + "forum_topic", + "leak", + "bot", + "financial_data", + "blog_post", + "service", + "ransomleak", + "domain", + "invalid_credential", + "google", "docker", "illicit_networks", "open_web", @@ -5596,7 +5596,7 @@ "infected_devices", "social_media" ], - "example": "seller", + "example": "forum_post", "type": "string" }, "type": "array" @@ -5664,31 +5664,31 @@ "search_types": { "items": { "enum": [ - "seller", - "bot", - "service", - "forum_topic", - "bucket", - "stack_exchange", "forum_post", - "social_media_account", - "invalid_credential", "valid_credential", - "leak", - "chat_message", - "paste", - "blog_post", - "source_code_files", - "stealer_log", "mitigated_credential", - "financial_data", - "google", - "domain", - "ransomleak", + "stack_exchange", "listing", - "forum_profile", + "paste", "bucket_object", + "seller", + "chat_message", + "stealer_log", + "forum_profile", + "social_media_account", + "source_code_files", "source_code_secrets", + "bucket", + "forum_topic", + "leak", + "bot", + "financial_data", + "blog_post", + "service", + "ransomleak", + "domain", + "invalid_credential", + "google", "docker", "illicit_networks", "open_web", @@ -5702,7 +5702,7 @@ "infected_devices", "social_media" ], - "example": "seller", + "example": "forum_post", "type": "string" }, "type": "array" @@ -6417,9 +6417,6 @@ "urn": { "type": "string" }, - "cello_jwt": { - "type": "string" - }, "needs_eusa": { "type": "boolean" }, diff --git a/docs/api-reference/spec/firework-v2-swagger.json b/docs/api-reference/spec/firework-v2-swagger.json index 1302eb3..dbb7e57 100644 --- a/docs/api-reference/spec/firework-v2-swagger.json +++ b/docs/api-reference/spec/firework-v2-swagger.json @@ -473,20 +473,6 @@ "activities" ] }, - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ActivityUserMetadata" - } - } - }, - "operationId": "get_activity_user_metadata_tags_/activities////user_metadata/tags", - "tags": [ - "activities" - ] - }, "put": { "responses": { "200": { @@ -516,6 +502,20 @@ "tags": [ "activities" ] + }, + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ActivityUserMetadata" + } + } + }, + "operationId": "get_activity_user_metadata_tags_/activities////user_metadata/tags", + "tags": [ + "activities" + ] } }, "/firework/v2/activities/{index}/{source}/{id}": { @@ -1041,24 +1041,6 @@ "Identifiers" ] }, - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "properties": { - "assets_group": { - "$ref": "#/definitions/IdentifierGroup" - } - } - } - } - }, - "operationId": "get_assets_group_api_/assets/groups/", - "tags": [ - "Identifiers" - ] - }, "put": { "responses": { "200": { @@ -1092,6 +1074,24 @@ "tags": [ "Identifiers" ] + }, + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "properties": { + "assets_group": { + "$ref": "#/definitions/IdentifierGroup" + } + } + } + } + }, + "operationId": "get_assets_group_api_/assets/groups/", + "tags": [ + "Identifiers" + ] } }, "/firework/v2/assets/groups/{assets_group_id}/alerts": { @@ -1161,17 +1161,6 @@ "type": "integer" } ], - "delete": { - "responses": { - "200": { - "description": "Success" - } - }, - "operationId": "delete_assets_group_alert_/assets/groups//alerts/", - "tags": [ - "Identifiers" - ] - }, "put": { "responses": { "200": { @@ -1195,6 +1184,17 @@ "tags": [ "Identifiers" ] + }, + "delete": { + "responses": { + "200": { + "description": "Success" + } + }, + "operationId": "delete_assets_group_alert_/assets/groups//alerts/", + "tags": [ + "Identifiers" + ] } }, "/firework/v2/assets/groups/{assets_group_id}/feed": { @@ -1284,7 +1284,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: seller, bot, chat_message, forum_topic, blog_post, stealer_log, forum_post, financial_data, ransomleak, listing, forum_profile\n- open_web: service, paste, bucket, source_code_files, stack_exchange, google, social_media_account, bucket_object, source_code_secrets, docker\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, chat_message, seller, stealer_log, ransomleak, listing, forum_profile, forum_topic, bot, financial_data, blog_post\n- open_web: source_code_secrets, bucket, stack_exchange, paste, service, bucket_object, social_media_account, google, docker, source_code_files\n- leaks: leak, valid_credential, invalid_credential, mitigated_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -1544,7 +1544,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: seller, bot, chat_message, forum_topic, blog_post, stealer_log, forum_post, financial_data, ransomleak, listing, forum_profile\n- open_web: service, paste, bucket, source_code_files, stack_exchange, google, social_media_account, bucket_object, source_code_secrets, docker\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, chat_message, seller, stealer_log, ransomleak, listing, forum_profile, forum_topic, bot, financial_data, blog_post\n- open_web: source_code_secrets, bucket, stack_exchange, paste, service, bucket_object, social_media_account, google, docker, source_code_files\n- leaks: leak, valid_credential, invalid_credential, mitigated_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -1747,24 +1747,6 @@ "Identifiers" ] }, - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "properties": { - "asset": { - "$ref": "#/definitions/Identifier" - } - } - } - } - }, - "operationId": "get_asset_api_/assets/", - "tags": [ - "Identifiers" - ] - }, "put": { "responses": { "400": { @@ -1798,6 +1780,24 @@ "tags": [ "Identifiers" ] + }, + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "properties": { + "asset": { + "$ref": "#/definitions/Identifier" + } + } + } + } + }, + "operationId": "get_asset_api_/assets/", + "tags": [ + "Identifiers" + ] } }, "/firework/v2/assets/{asset_id}/alerts": { @@ -1867,17 +1867,6 @@ "type": "integer" } ], - "delete": { - "responses": { - "200": { - "description": "Success" - } - }, - "operationId": "delete_asset_alert_/assets//alerts/", - "tags": [ - "Identifiers" - ] - }, "put": { "responses": { "200": { @@ -1901,6 +1890,17 @@ "tags": [ "Identifiers" ] + }, + "delete": { + "responses": { + "200": { + "description": "Success" + } + }, + "operationId": "delete_asset_alert_/assets//alerts/", + "tags": [ + "Identifiers" + ] } }, "/firework/v2/assets/{asset_id}/feed": { @@ -1990,7 +1990,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: seller, bot, chat_message, forum_topic, blog_post, stealer_log, forum_post, financial_data, ransomleak, listing, forum_profile\n- open_web: service, paste, bucket, source_code_files, stack_exchange, google, social_media_account, bucket_object, source_code_secrets, docker\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, chat_message, seller, stealer_log, ransomleak, listing, forum_profile, forum_topic, bot, financial_data, blog_post\n- open_web: source_code_secrets, bucket, stack_exchange, paste, service, bucket_object, social_media_account, google, docker, source_code_files\n- leaks: leak, valid_credential, invalid_credential, mitigated_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -2250,7 +2250,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: seller, bot, chat_message, forum_topic, blog_post, stealer_log, forum_post, financial_data, ransomleak, listing, forum_profile\n- open_web: service, paste, bucket, source_code_files, stack_exchange, google, social_media_account, bucket_object, source_code_secrets, docker\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, chat_message, seller, stealer_log, ransomleak, listing, forum_profile, forum_topic, bot, financial_data, blog_post\n- open_web: source_code_secrets, bucket, stack_exchange, paste, service, bucket_object, social_media_account, google, docker, source_code_files\n- leaks: leak, valid_credential, invalid_credential, mitigated_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -2579,7 +2579,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: seller, bot, chat_message, forum_topic, blog_post, stealer_log, forum_post, financial_data, ransomleak, listing, forum_profile\n- open_web: service, paste, bucket, source_code_files, stack_exchange, google, social_media_account, bucket_object, source_code_secrets, docker\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, chat_message, seller, stealer_log, ransomleak, listing, forum_profile, forum_topic, bot, financial_data, blog_post\n- open_web: source_code_secrets, bucket, stack_exchange, paste, service, bucket_object, social_media_account, google, docker, source_code_files\n- leaks: leak, valid_credential, invalid_credential, mitigated_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -2817,7 +2817,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: seller, bot, chat_message, forum_topic, blog_post, stealer_log, forum_post, financial_data, ransomleak, listing, forum_profile\n- open_web: service, paste, bucket, source_code_files, stack_exchange, google, social_media_account, bucket_object, source_code_secrets, docker\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, chat_message, seller, stealer_log, ransomleak, listing, forum_profile, forum_topic, bot, financial_data, blog_post\n- open_web: source_code_secrets, bucket, stack_exchange, paste, service, bucket_object, social_media_account, google, docker, source_code_files\n- leaks: leak, valid_credential, invalid_credential, mitigated_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -3064,17 +3064,6 @@ } }, "/firework/v2/me/profile": { - "get": { - "responses": { - "200": { - "description": "Returns the current user's profile" - } - }, - "operationId": "get_current_user_profile_/me/profile", - "tags": [ - "me" - ] - }, "put": { "responses": { "400": { @@ -3108,6 +3097,17 @@ "tags": [ "me" ] + }, + "get": { + "responses": { + "200": { + "description": "Returns the current user's profile" + } + }, + "operationId": "get_current_user_profile_/me/profile", + "tags": [ + "me" + ] } }, "/firework/v2/me/tenants": { @@ -3250,7 +3250,7 @@ "type": "integer" } ], - "get": { + "put": { "responses": { "200": { "description": "Success", @@ -3263,12 +3263,22 @@ } } }, - "operationId": "get_organization_member_api_/organizations//members/", + "operationId": "put_organization_member_api_/organizations//members/", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/OrganizationMember" + } + } + ], "tags": [ "organizations" ] }, - "put": { + "get": { "responses": { "200": { "description": "Success", @@ -3281,17 +3291,7 @@ } } }, - "operationId": "put_organization_member_api_/organizations//members/", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/OrganizationMember" - } - } - ], + "operationId": "get_organization_member_api_/organizations//members/", "tags": [ "organizations" ] @@ -3562,24 +3562,24 @@ "type": "integer" } ], - "delete": { + "get": { "responses": { "200": { - "description": "Deletes a report." + "description": "Returns a report and its elements." } }, - "operationId": "delete_report_endpoint_/reporting/reports/", + "operationId": "get_report_endpoint_/reporting/reports/", "tags": [ "reporting" ] }, - "get": { + "delete": { "responses": { "200": { - "description": "Returns a report and its elements." + "description": "Deletes a report." } }, - "operationId": "get_report_endpoint_/reporting/reports/", + "operationId": "delete_report_endpoint_/reporting/reports/", "tags": [ "reporting" ] @@ -3721,7 +3721,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: seller, bot, chat_message, forum_topic, blog_post, stealer_log, forum_post, financial_data, ransomleak, listing, forum_profile\n- open_web: service, paste, bucket, source_code_files, stack_exchange, google, social_media_account, bucket_object, source_code_secrets, docker\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, chat_message, seller, stealer_log, ransomleak, listing, forum_profile, forum_topic, bot, financial_data, blog_post\n- open_web: source_code_secrets, bucket, stack_exchange, paste, service, bucket_object, social_media_account, google, docker, source_code_files\n- leaks: leak, valid_credential, invalid_credential, mitigated_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -3973,7 +3973,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: seller, bot, chat_message, forum_topic, blog_post, stealer_log, forum_post, financial_data, ransomleak, listing, forum_profile\n- open_web: service, paste, bucket, source_code_files, stack_exchange, google, social_media_account, bucket_object, source_code_secrets, docker\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, chat_message, seller, stealer_log, ransomleak, listing, forum_profile, forum_topic, bot, financial_data, blog_post\n- open_web: source_code_secrets, bucket, stack_exchange, paste, service, bucket_object, social_media_account, google, docker, source_code_files\n- leaks: leak, valid_credential, invalid_credential, mitigated_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -4163,20 +4163,6 @@ "type": "integer" } ], - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/TenantWithCounts" - } - } - }, - "operationId": "get_tenant_api_/tenants/", - "tags": [ - "tenants" - ] - }, "put": { "responses": { "200": { @@ -4200,6 +4186,20 @@ "tags": [ "tenants" ] + }, + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TenantWithCounts" + } + } + }, + "operationId": "get_tenant_api_/tenants/", + "tags": [ + "tenants" + ] } }, "/firework/v2/tenants/{tenant_id}/archive": { @@ -4429,34 +4429,34 @@ "type": "array", "items": { "type": "string", - "example": "seller", + "example": "forum_post", "enum": [ - "seller", - "bot", - "service", - "forum_topic", - "bucket", - "stack_exchange", "forum_post", - "social_media_account", - "invalid_credential", "valid_credential", - "leak", - "chat_message", - "paste", - "blog_post", - "source_code_files", - "stealer_log", "mitigated_credential", - "financial_data", - "google", - "ad", - "domain", - "ransomleak", + "stack_exchange", "listing", - "forum_profile", + "paste", + "ad", "bucket_object", + "seller", + "chat_message", + "stealer_log", + "forum_profile", + "social_media_account", + "source_code_files", "source_code_secrets", + "bucket", + "forum_topic", + "leak", + "bot", + "financial_data", + "blog_post", + "service", + "ransomleak", + "domain", + "invalid_credential", + "google", "docker", "illicit_networks", "open_web", @@ -4536,33 +4536,33 @@ "type": "array", "items": { "type": "string", - "example": "seller", + "example": "forum_post", "enum": [ - "seller", - "bot", - "service", - "forum_topic", - "bucket", - "stack_exchange", "forum_post", - "social_media_account", - "invalid_credential", "valid_credential", - "leak", - "chat_message", - "paste", - "blog_post", - "source_code_files", - "stealer_log", "mitigated_credential", - "financial_data", - "google", - "domain", - "ransomleak", + "stack_exchange", "listing", - "forum_profile", + "paste", "bucket_object", + "seller", + "chat_message", + "stealer_log", + "forum_profile", + "social_media_account", + "source_code_files", "source_code_secrets", + "bucket", + "forum_topic", + "leak", + "bot", + "financial_data", + "blog_post", + "service", + "ransomleak", + "domain", + "invalid_credential", + "google", "docker", "illicit_networks", "open_web", @@ -5654,9 +5654,6 @@ "urn": { "type": "string" }, - "cello_jwt": { - "type": "string" - }, "needs_eusa": { "type": "boolean" }, diff --git a/docs/api-reference/spec/firework-v3-openapi.json b/docs/api-reference/spec/firework-v3-openapi.json index ecd9f2c..4fe7db6 100644 --- a/docs/api-reference/spec/firework-v3-openapi.json +++ b/docs/api-reference/spec/firework-v3-openapi.json @@ -569,7 +569,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, forum_profile, blog_post, seller, stealer_log, financial_data, bot, forum_topic, forum_post, listing, chat_message\n- open_web: google, source_code_files, stack_exchange, docker, paste, service, social_media_account, source_code_secrets, bucket, bucket_object\n- leaks: leak, invalid_credential, mitigated_credential, valid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, ransomleak, blog_post, listing, bot, financial_data, stealer_log, forum_post, forum_topic, forum_profile, seller\n- open_web: paste, stack_exchange, service, docker, social_media_account, bucket_object, source_code_files, bucket, google, source_code_secrets\n- leaks: leak, mitigated_credential, invalid_credential, valid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -893,7 +893,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, forum_profile, blog_post, seller, stealer_log, financial_data, bot, forum_topic, forum_post, listing, chat_message\n- open_web: google, source_code_files, stack_exchange, docker, paste, service, social_media_account, source_code_secrets, bucket, bucket_object\n- leaks: leak, invalid_credential, mitigated_credential, valid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, ransomleak, blog_post, listing, bot, financial_data, stealer_log, forum_post, forum_topic, forum_profile, seller\n- open_web: paste, stack_exchange, service, docker, social_media_account, bucket_object, source_code_files, bucket, google, source_code_secrets\n- leaks: leak, mitigated_credential, invalid_credential, valid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", diff --git a/docs/api-reference/spec/firework-v3-swagger.json b/docs/api-reference/spec/firework-v3-swagger.json index c483237..faeb82e 100644 --- a/docs/api-reference/spec/firework-v3-swagger.json +++ b/docs/api-reference/spec/firework-v3-swagger.json @@ -487,7 +487,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, forum_profile, blog_post, seller, stealer_log, financial_data, bot, forum_topic, forum_post, listing, chat_message\n- open_web: google, source_code_files, stack_exchange, docker, paste, service, social_media_account, source_code_secrets, bucket, bucket_object\n- leaks: leak, invalid_credential, mitigated_credential, valid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, ransomleak, blog_post, listing, bot, financial_data, stealer_log, forum_post, forum_topic, forum_profile, seller\n- open_web: paste, stack_exchange, service, docker, social_media_account, bucket_object, source_code_files, bucket, google, source_code_secrets\n- leaks: leak, mitigated_credential, invalid_credential, valid_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -747,7 +747,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, forum_profile, blog_post, seller, stealer_log, financial_data, bot, forum_topic, forum_post, listing, chat_message\n- open_web: google, source_code_files, stack_exchange, docker, paste, service, social_media_account, source_code_secrets, bucket, bucket_object\n- leaks: leak, invalid_credential, mitigated_credential, valid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, ransomleak, blog_post, listing, bot, financial_data, stealer_log, forum_post, forum_topic, forum_profile, seller\n- open_web: paste, stack_exchange, service, docker, social_media_account, bucket_object, source_code_files, bucket, google, source_code_secrets\n- leaks: leak, mitigated_credential, invalid_credential, valid_credential\n- domains: domain\n", "items": { "type": "string" }, diff --git a/docs/api-reference/spec/firework-v4-openapi.json b/docs/api-reference/spec/firework-v4-openapi.json index ba71dd4..52b8abe 100644 --- a/docs/api-reference/spec/firework-v4-openapi.json +++ b/docs/api-reference/spec/firework-v4-openapi.json @@ -1203,6 +1203,58 @@ } } }, + "/firework/v4/events/identifiers/{identifier_id}/_explain": { + "get": { + "tags": [ + "public", + "team=data-engineering" + ], + "summary": "Explain Identifier Event", + "operationId": "explain_identifier_event_events_identifiers__identifier_id___explain_get", + "parameters": [ + { + "name": "identifier_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Identifier Id" + } + }, + { + "name": "event_uid", + "in": "query", + "required": true, + "schema": { + "type": "string", + "title": "Event Uid" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EventExplanation" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, "/firework/v4/identifier-recommendations/": { "get": { "tags": [ @@ -4914,6 +4966,40 @@ ], "title": "CampaignEntityLiteData" }, + "CategoryVerdict": { + "properties": { + "event_category": { + "$ref": "#/components/schemas/ActivityModelName", + "description": "The category of the event" + }, + "allowed_categories": { + "items": { + "$ref": "#/components/schemas/SearchType" + }, + "type": "array", + "title": "Allowed Categories", + "description": "The categories the identifier is configured to monitor" + }, + "matched": { + "type": "boolean", + "title": "Matched", + "description": "Whether the event's category is among the allowed categories" + }, + "applicable": { + "type": "boolean", + "title": "Applicable", + "description": "Whether the identifier has any allowed categories configured" + } + }, + "type": "object", + "required": [ + "event_category", + "allowed_categories", + "matched", + "applicable" + ], + "title": "CategoryVerdict" + }, "ChatChannelEntityAPIResponse": { "properties": { "entity_type": { @@ -6711,6 +6797,31 @@ ], "title": "Topic Ids" }, + "intent_ids": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/Intent" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Intent Ids" + }, + "min_confidence": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Min Confidence" + }, "created_at": { "$ref": "#/components/schemas/DateFilter" }, @@ -6847,6 +6958,74 @@ ], "title": "EventActionsBody" }, + "EventExplanation": { + "properties": { + "event_uid": { + "type": "string", + "title": "Event Uid", + "description": "The uid of the explained event" + }, + "identifier_id": { + "type": "integer", + "title": "Identifier Id", + "description": "The id of the identifier the event is being explained for" + }, + "identifier_query": { + "$ref": "#/components/schemas/IdentifierQueryVerdict", + "description": "The verdict of the identifier's search query" + }, + "categories": { + "$ref": "#/components/schemas/CategoryVerdict", + "description": "The verdict of the event category check" + }, + "severity": { + "$ref": "#/components/schemas/SeverityVerdict", + "description": "The verdict of the event severity check" + }, + "matching_policies": { + "$ref": "#/components/schemas/MatchingPolicyVerdict", + "description": "The verdict of the matching policies check" + }, + "tenant_ignored_terms": { + "$ref": "#/components/schemas/IgnoredTermsVerdict", + "description": "The verdict of the tenant's ignored terms check" + }, + "global_policies": { + "$ref": "#/components/schemas/GlobalPolicyVerdict", + "description": "The verdict of the global policies check" + }, + "maybe_rate_limited": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Maybe Rate Limited", + "description": "Whether the event may have been suppressed due to rate limiting" + }, + "would_match": { + "type": "boolean", + "title": "Would Match", + "description": "Whether the event would have matched the identifier overall" + } + }, + "type": "object", + "required": [ + "event_uid", + "identifier_id", + "identifier_query", + "categories", + "severity", + "matching_policies", + "tenant_ignored_terms", + "global_policies", + "would_match" + ], + "title": "EventExplanation" + }, "EventMetadata": { "properties": { "estimated_created_at": { @@ -7164,7 +7343,7 @@ }, "type": { "items": { - "$ref": "#/components/schemas/SearchType" + "type": "string" }, "type": "array", "title": "Type" @@ -7944,6 +8123,13 @@ "type": "array", "title": "Topics" }, + "intents": { + "items": { + "$ref": "#/components/schemas/ThreadIntent" + }, + "type": "array", + "title": "Intents" + }, "original_post_overview": { "anyOf": [ { @@ -8005,6 +8191,7 @@ "name", "description", "topics", + "intents", "original_post_overview", "original_post_actor_intent", "replies_overview", @@ -8058,13 +8245,21 @@ }, "type": "array", "title": "Topics" + }, + "intents": { + "items": { + "$ref": "#/components/schemas/ThreadIntent" + }, + "type": "array", + "title": "Intents" } }, "type": "object", "required": [ "name", "description", - "topics" + "topics", + "intents" ], "title": "ForumThreadLiteData" }, @@ -8234,6 +8429,77 @@ ], "title": "GlobalFeedItem" }, + "GlobalPolicyEnum": { + "type": "string", + "enum": [ + "identical_market_listings", + "identical_forum_posts", + "identical_chat_messages", + "identical_pastes", + "identical_stealer_logs", + "identical_attachments", + "similar_market_listings", + "similar_forum_posts", + "similar_chat_messages", + "similar_pastes" + ], + "title": "GlobalPolicyEnum" + }, + "GlobalPolicyMatch": { + "properties": { + "policy": { + "$ref": "#/components/schemas/GlobalPolicyEnum", + "description": "The global policy considered for this event's category" + }, + "duplicate_uid": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Duplicate Uid", + "description": "The uid of the event this event was identified as a duplicate of, if matched" + }, + "matched": { + "type": "boolean", + "title": "Matched", + "description": "Whether this global policy matched the event" + } + }, + "type": "object", + "required": [ + "policy", + "duplicate_uid", + "matched" + ], + "title": "GlobalPolicyMatch" + }, + "GlobalPolicyVerdict": { + "properties": { + "policies": { + "items": { + "$ref": "#/components/schemas/GlobalPolicyMatch" + }, + "type": "array", + "title": "Policies", + "description": "The global policies considered for this event's category" + }, + "applicable": { + "type": "boolean", + "title": "Applicable", + "description": "Whether a global policy applies to this event's category and is enabled for the tenant" + } + }, + "type": "object", + "required": [ + "policies", + "applicable" + ], + "title": "GlobalPolicyVerdict" + }, "GlobalSearchRequestBody": { "properties": { "query": { @@ -8944,6 +9210,26 @@ ], "title": "IdentifierOrderBy" }, + "IdentifierQueryVerdict": { + "properties": { + "matched": { + "type": "boolean", + "title": "Matched", + "description": "Whether the identifier's own search query matched the event" + }, + "applicable": { + "type": "boolean", + "title": "Applicable", + "description": "Whether the identifier has its own search query to check" + } + }, + "type": "object", + "required": [ + "matched", + "applicable" + ], + "title": "IdentifierQueryVerdict" + }, "IdentifierRecommendationAction": { "properties": { "type": { @@ -9472,6 +9758,56 @@ ], "title": "IdentityIdentifierEntity" }, + "IgnoredTermsPolicyMatch": { + "properties": { + "ignored_terms_id": { + "type": "string", + "format": "uuid", + "title": "Ignored Terms Id", + "description": "The id of the tenant's ignored terms policy" + }, + "name": { + "type": "string", + "title": "Name", + "description": "The name of the ignored terms policy" + }, + "matched": { + "type": "boolean", + "title": "Matched", + "description": "Whether this ignored terms policy matched the event" + } + }, + "type": "object", + "required": [ + "ignored_terms_id", + "name", + "matched" + ], + "title": "IgnoredTermsPolicyMatch" + }, + "IgnoredTermsVerdict": { + "properties": { + "policies": { + "items": { + "$ref": "#/components/schemas/IgnoredTermsPolicyMatch" + }, + "type": "array", + "title": "Policies", + "description": "The tenant's ignored terms policies" + }, + "applicable": { + "type": "boolean", + "title": "Applicable", + "description": "Whether the tenant has any ignored terms policies configured" + } + }, + "type": "object", + "required": [ + "policies", + "applicable" + ], + "title": "IgnoredTermsVerdict" + }, "IncludeOptions": { "type": "string", "enum": [ @@ -9994,6 +10330,22 @@ ], "title": "IntelType" }, + "Intent": { + "type": "string", + "enum": [ + "sell", + "buy", + "free_release", + "share", + "trade", + "service_for_hire", + "request_help", + "discussion", + "recruitment", + "unknown" + ], + "title": "Intent" + }, "InvalidCredentialEvent": { "properties": { "event_type": { @@ -11072,6 +11424,38 @@ ], "title": "MatchingPolicyAssignmentPayload" }, + "MatchingPolicyMatch": { + "properties": { + "matching_policy_id": { + "type": "string", + "format": "uuid", + "title": "Matching Policy Id", + "description": "The id of the matching policy" + }, + "name": { + "type": "string", + "title": "Name", + "description": "The name of the matching policy" + }, + "type": { + "$ref": "#/components/schemas/MatchingPolicyType", + "description": "The type of the matching policy" + }, + "matched": { + "type": "boolean", + "title": "Matched", + "description": "Whether this matching policy matched the event" + } + }, + "type": "object", + "required": [ + "matching_policy_id", + "name", + "type", + "matched" + ], + "title": "MatchingPolicyMatch" + }, "MatchingPolicyPayload": { "properties": { "uuid": { @@ -11128,6 +11512,29 @@ ], "title": "MatchingPolicyType" }, + "MatchingPolicyVerdict": { + "properties": { + "policies": { + "items": { + "$ref": "#/components/schemas/MatchingPolicyMatch" + }, + "type": "array", + "title": "Policies", + "description": "The matching policies assigned to the identifier" + }, + "applicable": { + "type": "boolean", + "title": "Applicable", + "description": "Whether the identifier has any matching policies assigned" + } + }, + "type": "object", + "required": [ + "policies", + "applicable" + ], + "title": "MatchingPolicyVerdict" + }, "MitigatedCredentialEvent": { "properties": { "event_type": { @@ -13055,6 +13462,14 @@ ], "title": "RoleData" }, + "RuleSource": { + "type": "string", + "enum": [ + "flare", + "tenant" + ], + "title": "RuleSource" + }, "SandboxSubmissionEventType": { "type": "string", "enum": [ @@ -13392,6 +13807,92 @@ ], "title": "Severity" }, + "SeverityRuleMatch": { + "properties": { + "rule_id": { + "type": "string", + "format": "uuid", + "title": "Rule Id", + "description": "The id of the scoring rule" + }, + "name": { + "type": "string", + "title": "Name", + "description": "The name of the scoring rule" + }, + "source": { + "$ref": "#/components/schemas/RuleSource", + "description": "Whether the rule is a Flare-provided or tenant-defined rule" + }, + "severity": { + "$ref": "#/components/schemas/RiskScore", + "description": "The severity assigned to the event by this rule" + }, + "is_beta": { + "type": "boolean", + "title": "Is Beta", + "description": "Whether the rule is currently in beta" + }, + "is_override": { + "type": "boolean", + "title": "Is Override", + "description": "Whether the rule overrides the severity assigned by other rules" + } + }, + "type": "object", + "required": [ + "rule_id", + "name", + "source", + "severity", + "is_beta", + "is_override" + ], + "title": "SeverityRuleMatch" + }, + "SeverityVerdict": { + "properties": { + "event_severity": { + "$ref": "#/components/schemas/RiskScore", + "description": "The severity computed for the event" + }, + "allowed_severities": { + "items": { + "$ref": "#/components/schemas/RiskScore" + }, + "type": "array", + "title": "Allowed Severities", + "description": "The severities the identifier is configured to alert on" + }, + "matched": { + "type": "boolean", + "title": "Matched", + "description": "Whether the event's severity is among the allowed severities" + }, + "applicable": { + "type": "boolean", + "title": "Applicable", + "description": "Whether the identifier has any allowed severities configured" + }, + "matched_rules": { + "items": { + "$ref": "#/components/schemas/SeverityRuleMatch" + }, + "type": "array", + "title": "Matched Rules", + "description": "The scoring rules that matched the event and contributed to its severity" + } + }, + "type": "object", + "required": [ + "event_severity", + "allowed_severities", + "matched", + "applicable", + "matched_rules" + ], + "title": "SeverityVerdict" + }, "SocialMediaEvent": { "properties": { "event_type": { @@ -13802,6 +14303,28 @@ ], "title": "TenantMetadataResponse" }, + "ThreadIntent": { + "properties": { + "intent_id": { + "$ref": "#/components/schemas/Intent" + }, + "label": { + "type": "string", + "title": "Label" + }, + "description": { + "type": "string", + "title": "Description" + } + }, + "type": "object", + "required": [ + "intent_id", + "label", + "description" + ], + "title": "ThreadIntent" + }, "ThreadTopic": { "properties": { "topic_id": { diff --git a/docs/api-reference/v4/endpoints/explain-identifier-event.mdx b/docs/api-reference/v4/endpoints/explain-identifier-event.mdx new file mode 100644 index 0000000..3a37367 --- /dev/null +++ b/docs/api-reference/v4/endpoints/explain-identifier-event.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/events/identifiers/{identifier_id}/_explain +--- \ No newline at end of file