From 2f3ab5470906d77d1e31ffebb9b76b5be7798f57 Mon Sep 17 00:00:00 2001 From: "sara.brazille" Date: Wed, 1 Oct 2025 15:25:24 -0400 Subject: [PATCH] update all api docs --- .../spec/firework-v2-openapi.json | 118 +- .../spec/firework-v2-swagger.json | 127 +- .../spec/firework-v3-openapi.json | 17 +- .../spec/firework-v3-swagger.json | 17 +- .../spec/firework-v4-openapi.json | 6351 +++++++++++++---- .../private/add-allowed-restricted-term.mdx | 3 + .../private/add-tenant-users-put.mdx | 3 + .../endpoints/private/add-user-to-tenants.mdx | 3 + .../v4/endpoints/private/archive-report.mdx | 3 + .../v4/endpoints/private/are-allowed.mdx | 3 + .../v4/endpoints/private/bulk-actions.mdx | 3 + .../v4/endpoints/private/create-alert.mdx | 3 + .../create-conversation-summary-request.mdx | 3 + ...create-cookie-monitoring-configuration.mdx | 3 + .../private/create-credential-bulk-action.mdx | 3 + .../create-or-update-tenant-config.mdx | 3 + .../v4/endpoints/private/create-report.mdx | 3 + .../private/create-tenant-integration.mdx | 3 + .../endpoints/private/create-tenant-user.mdx | 3 + .../v4/endpoints/private/delete-alert.mdx | 3 + .../delete-allowed-restricted-terms.mdx | 3 + .../v4/endpoints/private/delete-channel.mdx | 3 + .../v4/endpoints/private/delete-report.mdx | 3 + .../private/delete-tenant-integration.mdx | 3 + .../v4/endpoints/private/disable-account.mdx | 3 + .../private/disable-tenant-member.mdx | 3 + .../v4/endpoints/private/download-report.mdx | 3 + .../private/enable-tenant-member.mdx | 3 + .../private/fetch-extracted-secrets.mdx | 3 + .../fetch-identifier-by-asset-data.mdx | 3 + .../private/fetch-identity-by-email.mdx | 3 + .../private/generate-actor-summaries.mdx | 3 + .../generate-forum-thread-summaries.mdx | 3 + .../endpoints/private/generate-report-csv.mdx | 3 + .../v4/endpoints/private/generate-report.mdx | 3 + .../v4/endpoints/private/generate-summary.mdx | 3 + .../private/get-actor-analysis-metadata.mdx | 3 + .../get-actor-communication-handles.mdx | 3 + .../endpoints/private/get-actor-heatmap.mdx | 3 + .../endpoints/private/get-actor-network.mdx | 3 + .../endpoints/private/get-actor-profile.mdx | 3 + .../private/get-actor-recent-activities.mdx | 3 + .../get-actor-summaries-by-request-id.mdx | 3 + .../endpoints/private/get-actor-timeline.mdx | 3 + .../endpoints/private/get-alert-channel.mdx | 3 + .../private/get-allowed-restricted-terms.mdx | 3 + .../private/get-and-create-tenant-config.mdx | 3 + .../private/get-application-exposures.mdx | 3 + .../private/get-credential-validations.mdx | 3 + .../v4/endpoints/private/get-feature-flag.mdx | 3 + .../get-forum-thread-analysis-metadata.mdx | 3 + .../private/get-forum-thread-breakdown.mdx | 3 + .../private/get-forum-thread-indicators.mdx | 3 + .../private/get-forum-thread-metadata.mdx | 3 + ...t-forum-thread-summaries-by-request-id.mdx | 3 + .../private/get-identifier-count-by-id.mdx | 3 + .../private/get-identifier-count.mdx | 3 + .../private/get-identifier-relations.mdx | 3 + ...t-identity-application-exposures-graph.mdx | 3 + .../private/get-idp-services-exposed.mdx | 3 + .../endpoints/private/get-idp-user-data.mdx | 3 + .../private/get-logos-from-domains.mdx | 3 + .../private/get-matching-identifiers.mdx | 3 + .../private/get-recent-activities-count.mdx | 3 + .../private/get-recent-activities-search.mdx | 3 + ...ent-activities-timeline-by-search-type.mdx | 3 + .../v4/endpoints/private/get-report-1.mdx | 3 + .../endpoints/private/get-report-config.mdx | 3 + .../endpoints/private/get-report-section.mdx | 3 + .../v4/endpoints/private/get-report.mdx | 3 + .../private/get-restricted-terms.mdx | 3 + .../endpoints/private/get-source-summary.mdx | 3 + .../v4/endpoints/private/get-tenant-alert.mdx | 3 + .../private/get-tenant-integration.mdx | 3 + .../private/get-tenant-integrations.mdx | 3 + .../v4/endpoints/private/is-allowed.mdx | 3 + .../list-conversation-summary-requests.mdx | 3 + .../list-cookie-monitoring-configurations.mdx | 3 + .../endpoints/private/list-feature-flags.mdx | 3 + .../private/list-report-sections.mdx | 3 + .../v4/endpoints/private/list-reports-1.mdx | 3 + .../v4/endpoints/private/list-reports.mdx | 3 + .../v4/endpoints/private/list-tags.mdx | 3 + .../private/mark-user-as-compromised.mdx | 3 + .../private/merge-identity-identifiers.mdx | 3 + .../private/regenerate-actor-summaries.mdx | 3 + .../regenerate-forum-thread-summaries.mdx | 3 + .../private/reset-credential-validations.mdx | 3 + .../v4/endpoints/private/revoke-sessions.mdx | 3 + .../private/submit-presigned-url.mdx | 3 + .../tenant-cookies-search-by-value.mdx | 3 + .../private/test-tenant-integration.mdx | 3 + .../v4/endpoints/private/update-alert.mdx | 3 + .../update-allowed-restricted-terms.mdx | 3 + .../v4/endpoints/private/update-channel.mdx | 3 + .../update-domain-identifier-properties.mdx | 3 + .../private/update-identifier-by-id.mdx | 3 + .../update-partial-tenant-integration.mdx | 3 + .../v4/endpoints/private/update-report-1.mdx | 3 + .../private/update-report-config.mdx | 3 + .../private/update-report-section.mdx | 3 + .../v4/endpoints/private/update-report.mdx | 3 + .../private/update-tenant-integration.mdx | 3 + .../v4/endpoints/private/update-tenant.mdx | 3 + .../endpoints/private/validate-credential.mdx | 3 + .../v4/endpoints/public/alert-channels.mdx | 3 + ...-action-for-identifier-recommendations.mdx | 3 + .../v4/endpoints/public/create-channel.mdx | 3 + .../v4/endpoints/public/create-identifier.mdx | 3 + .../public/create-report-request.mdx | 3 + .../endpoints/public/current-tenant-feed.mdx | 3 + .../v4/endpoints/public/delete-report.mdx | 3 + .../v4/endpoints/public/download-report.mdx | 3 + .../v4/endpoints/public/event-actions.mdx | 3 + .../public/fetch-filters-risk-score.mdx | 3 + .../public/fetch-filters-source-types.mdx | 3 + .../fetch-identifier-recommendations.mdx | 3 + .../v4/endpoints/public/get-identifier.mdx | 3 + .../v4/endpoints/public/get-identifiers.mdx | 3 + .../public/get-related-conversation.mdx | 3 + .../endpoints/public/get-report-request.mdx | 3 + .../v4/endpoints/public/get-report.mdx | 3 + .../v4/endpoints/public/global-search.mdx | 3 + .../v4/endpoints/public/identifier-feed.mdx | 3 + .../public/identifier-group-feed.mdx | 3 + .../public/is-api-up-and-running.mdx | 3 + .../v4/endpoints/public/list-reports.mdx | 3 + .../v4/endpoints/public/tenant-alerts.mdx | 3 + 128 files changed, 5461 insertions(+), 1538 deletions(-) create mode 100644 docs/api-reference/v4/endpoints/private/add-allowed-restricted-term.mdx create mode 100644 docs/api-reference/v4/endpoints/private/add-tenant-users-put.mdx create mode 100644 docs/api-reference/v4/endpoints/private/add-user-to-tenants.mdx create mode 100644 docs/api-reference/v4/endpoints/private/archive-report.mdx create mode 100644 docs/api-reference/v4/endpoints/private/are-allowed.mdx create mode 100644 docs/api-reference/v4/endpoints/private/bulk-actions.mdx create mode 100644 docs/api-reference/v4/endpoints/private/create-alert.mdx create mode 100644 docs/api-reference/v4/endpoints/private/create-conversation-summary-request.mdx create mode 100644 docs/api-reference/v4/endpoints/private/create-cookie-monitoring-configuration.mdx create mode 100644 docs/api-reference/v4/endpoints/private/create-credential-bulk-action.mdx create mode 100644 docs/api-reference/v4/endpoints/private/create-or-update-tenant-config.mdx create mode 100644 docs/api-reference/v4/endpoints/private/create-report.mdx create mode 100644 docs/api-reference/v4/endpoints/private/create-tenant-integration.mdx create mode 100644 docs/api-reference/v4/endpoints/private/create-tenant-user.mdx create mode 100644 docs/api-reference/v4/endpoints/private/delete-alert.mdx create mode 100644 docs/api-reference/v4/endpoints/private/delete-allowed-restricted-terms.mdx create mode 100644 docs/api-reference/v4/endpoints/private/delete-channel.mdx create mode 100644 docs/api-reference/v4/endpoints/private/delete-report.mdx create mode 100644 docs/api-reference/v4/endpoints/private/delete-tenant-integration.mdx create mode 100644 docs/api-reference/v4/endpoints/private/disable-account.mdx create mode 100644 docs/api-reference/v4/endpoints/private/disable-tenant-member.mdx create mode 100644 docs/api-reference/v4/endpoints/private/download-report.mdx create mode 100644 docs/api-reference/v4/endpoints/private/enable-tenant-member.mdx create mode 100644 docs/api-reference/v4/endpoints/private/fetch-extracted-secrets.mdx create mode 100644 docs/api-reference/v4/endpoints/private/fetch-identifier-by-asset-data.mdx create mode 100644 docs/api-reference/v4/endpoints/private/fetch-identity-by-email.mdx create mode 100644 docs/api-reference/v4/endpoints/private/generate-actor-summaries.mdx create mode 100644 docs/api-reference/v4/endpoints/private/generate-forum-thread-summaries.mdx create mode 100644 docs/api-reference/v4/endpoints/private/generate-report-csv.mdx create mode 100644 docs/api-reference/v4/endpoints/private/generate-report.mdx create mode 100644 docs/api-reference/v4/endpoints/private/generate-summary.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-actor-analysis-metadata.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-actor-communication-handles.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-actor-heatmap.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-actor-network.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-actor-profile.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-actor-recent-activities.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-actor-summaries-by-request-id.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-actor-timeline.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-alert-channel.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-allowed-restricted-terms.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-and-create-tenant-config.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-application-exposures.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-credential-validations.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-feature-flag.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-forum-thread-analysis-metadata.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-forum-thread-breakdown.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-forum-thread-indicators.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-forum-thread-metadata.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-forum-thread-summaries-by-request-id.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-identifier-count-by-id.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-identifier-count.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-identifier-relations.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-identity-application-exposures-graph.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-idp-services-exposed.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-idp-user-data.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-logos-from-domains.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-matching-identifiers.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-recent-activities-count.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-recent-activities-search.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-recent-activities-timeline-by-search-type.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-report-1.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-report-config.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-report-section.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-report.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-restricted-terms.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-source-summary.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-tenant-alert.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-tenant-integration.mdx create mode 100644 docs/api-reference/v4/endpoints/private/get-tenant-integrations.mdx create mode 100644 docs/api-reference/v4/endpoints/private/is-allowed.mdx create mode 100644 docs/api-reference/v4/endpoints/private/list-conversation-summary-requests.mdx create mode 100644 docs/api-reference/v4/endpoints/private/list-cookie-monitoring-configurations.mdx create mode 100644 docs/api-reference/v4/endpoints/private/list-feature-flags.mdx create mode 100644 docs/api-reference/v4/endpoints/private/list-report-sections.mdx create mode 100644 docs/api-reference/v4/endpoints/private/list-reports-1.mdx create mode 100644 docs/api-reference/v4/endpoints/private/list-reports.mdx create mode 100644 docs/api-reference/v4/endpoints/private/list-tags.mdx create mode 100644 docs/api-reference/v4/endpoints/private/mark-user-as-compromised.mdx create mode 100644 docs/api-reference/v4/endpoints/private/merge-identity-identifiers.mdx create mode 100644 docs/api-reference/v4/endpoints/private/regenerate-actor-summaries.mdx create mode 100644 docs/api-reference/v4/endpoints/private/regenerate-forum-thread-summaries.mdx create mode 100644 docs/api-reference/v4/endpoints/private/reset-credential-validations.mdx create mode 100644 docs/api-reference/v4/endpoints/private/revoke-sessions.mdx create mode 100644 docs/api-reference/v4/endpoints/private/submit-presigned-url.mdx create mode 100644 docs/api-reference/v4/endpoints/private/tenant-cookies-search-by-value.mdx create mode 100644 docs/api-reference/v4/endpoints/private/test-tenant-integration.mdx create mode 100644 docs/api-reference/v4/endpoints/private/update-alert.mdx create mode 100644 docs/api-reference/v4/endpoints/private/update-allowed-restricted-terms.mdx create mode 100644 docs/api-reference/v4/endpoints/private/update-channel.mdx create mode 100644 docs/api-reference/v4/endpoints/private/update-domain-identifier-properties.mdx create mode 100644 docs/api-reference/v4/endpoints/private/update-identifier-by-id.mdx create mode 100644 docs/api-reference/v4/endpoints/private/update-partial-tenant-integration.mdx create mode 100644 docs/api-reference/v4/endpoints/private/update-report-1.mdx create mode 100644 docs/api-reference/v4/endpoints/private/update-report-config.mdx create mode 100644 docs/api-reference/v4/endpoints/private/update-report-section.mdx create mode 100644 docs/api-reference/v4/endpoints/private/update-report.mdx create mode 100644 docs/api-reference/v4/endpoints/private/update-tenant-integration.mdx create mode 100644 docs/api-reference/v4/endpoints/private/update-tenant.mdx create mode 100644 docs/api-reference/v4/endpoints/private/validate-credential.mdx create mode 100644 docs/api-reference/v4/endpoints/public/alert-channels.mdx create mode 100644 docs/api-reference/v4/endpoints/public/create-action-for-identifier-recommendations.mdx create mode 100644 docs/api-reference/v4/endpoints/public/create-channel.mdx create mode 100644 docs/api-reference/v4/endpoints/public/create-identifier.mdx create mode 100644 docs/api-reference/v4/endpoints/public/create-report-request.mdx create mode 100644 docs/api-reference/v4/endpoints/public/current-tenant-feed.mdx create mode 100644 docs/api-reference/v4/endpoints/public/delete-report.mdx create mode 100644 docs/api-reference/v4/endpoints/public/download-report.mdx create mode 100644 docs/api-reference/v4/endpoints/public/event-actions.mdx create mode 100644 docs/api-reference/v4/endpoints/public/fetch-filters-risk-score.mdx create mode 100644 docs/api-reference/v4/endpoints/public/fetch-filters-source-types.mdx create mode 100644 docs/api-reference/v4/endpoints/public/fetch-identifier-recommendations.mdx create mode 100644 docs/api-reference/v4/endpoints/public/get-identifier.mdx create mode 100644 docs/api-reference/v4/endpoints/public/get-identifiers.mdx create mode 100644 docs/api-reference/v4/endpoints/public/get-related-conversation.mdx create mode 100644 docs/api-reference/v4/endpoints/public/get-report-request.mdx create mode 100644 docs/api-reference/v4/endpoints/public/get-report.mdx create mode 100644 docs/api-reference/v4/endpoints/public/global-search.mdx create mode 100644 docs/api-reference/v4/endpoints/public/identifier-feed.mdx create mode 100644 docs/api-reference/v4/endpoints/public/identifier-group-feed.mdx create mode 100644 docs/api-reference/v4/endpoints/public/is-api-up-and-running.mdx create mode 100644 docs/api-reference/v4/endpoints/public/list-reports.mdx create mode 100644 docs/api-reference/v4/endpoints/public/tenant-alerts.mdx diff --git a/docs/api-reference/spec/firework-v2-openapi.json b/docs/api-reference/spec/firework-v2-openapi.json index 87590cd..2c668c8 100644 --- a/docs/api-reference/spec/firework-v2-openapi.json +++ b/docs/api-reference/spec/firework-v2-openapi.json @@ -157,7 +157,7 @@ "responses": { "200": { "content": {}, - "description": "Returns all the different file extensions that were found in a ransom leak." + "description": "Returns all the different file extensions that were found in the files of a ransom leak." }, "404": { "content": { @@ -1196,7 +1196,7 @@ }, "/firework/v2/activities/{index}/{source}/{id}/parent_chat_data": { "get": { - "operationId": "get_parent_chat_data_/activities////parent_chat_data", + "operationId": "get_parent_activity_data_/activities////parent_chat_data", "parameters": [ { "in": "path", @@ -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_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, listing, chat_message, forum_post, ransomleak, forum_profile, blog_post, stealer_log, seller, financial_data, forum_topic\n- open_web: bucket_object, docker, social_media_account, paste, service, source_code_secrets, bucket, google, stack_exchange, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, financial_data, forum_profile, forum_topic, seller, listing, forum_post, bot, stealer_log, ransomleak, blog_post\n- open_web: social_media_account, service, source_code_secrets, stack_exchange, google, docker, paste, bucket_object, bucket, source_code_files\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -1848,7 +1848,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -2153,7 +2152,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_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, listing, chat_message, forum_post, ransomleak, forum_profile, blog_post, stealer_log, seller, financial_data, forum_topic\n- open_web: bucket_object, docker, social_media_account, paste, service, source_code_secrets, bucket, google, stack_exchange, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, financial_data, forum_profile, forum_topic, seller, listing, forum_post, bot, stealer_log, ransomleak, blog_post\n- open_web: social_media_account, service, source_code_secrets, stack_exchange, google, docker, paste, bucket_object, bucket, source_code_files\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -2170,7 +2169,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -2726,7 +2724,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_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, listing, chat_message, forum_post, ransomleak, forum_profile, blog_post, stealer_log, seller, financial_data, forum_topic\n- open_web: bucket_object, docker, social_media_account, paste, service, source_code_secrets, bucket, google, stack_exchange, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, financial_data, forum_profile, forum_topic, seller, listing, forum_post, bot, stealer_log, ransomleak, blog_post\n- open_web: social_media_account, service, source_code_secrets, stack_exchange, google, docker, paste, bucket_object, bucket, source_code_files\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -2743,7 +2741,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -3048,7 +3045,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_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, listing, chat_message, forum_post, ransomleak, forum_profile, blog_post, stealer_log, seller, financial_data, forum_topic\n- open_web: bucket_object, docker, social_media_account, paste, service, source_code_secrets, bucket, google, stack_exchange, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, financial_data, forum_profile, forum_topic, seller, listing, forum_post, bot, stealer_log, ransomleak, blog_post\n- open_web: social_media_account, service, source_code_secrets, stack_exchange, google, docker, paste, bucket_object, bucket, source_code_files\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -3065,7 +3062,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -3448,7 +3444,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_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, listing, chat_message, forum_post, ransomleak, forum_profile, blog_post, stealer_log, seller, financial_data, forum_topic\n- open_web: bucket_object, docker, social_media_account, paste, service, source_code_secrets, bucket, google, stack_exchange, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, financial_data, forum_profile, forum_topic, seller, listing, forum_post, bot, stealer_log, ransomleak, blog_post\n- open_web: social_media_account, service, source_code_secrets, stack_exchange, google, docker, paste, bucket_object, bucket, source_code_files\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -3465,7 +3461,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -3792,7 +3787,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_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, listing, chat_message, forum_post, ransomleak, forum_profile, blog_post, stealer_log, seller, financial_data, forum_topic\n- open_web: bucket_object, docker, social_media_account, paste, service, source_code_secrets, bucket, google, stack_exchange, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, financial_data, forum_profile, forum_topic, seller, listing, forum_post, bot, stealer_log, ransomleak, blog_post\n- open_web: social_media_account, service, source_code_secrets, stack_exchange, google, docker, paste, bucket_object, bucket, source_code_files\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -3809,7 +3804,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -4073,7 +4067,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_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, listing, chat_message, forum_post, ransomleak, forum_profile, blog_post, stealer_log, seller, financial_data, forum_topic\n- open_web: bucket_object, docker, social_media_account, paste, service, source_code_secrets, bucket, google, stack_exchange, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, financial_data, forum_profile, forum_topic, seller, listing, forum_post, bot, stealer_log, ransomleak, blog_post\n- open_web: social_media_account, service, source_code_secrets, stack_exchange, google, docker, paste, bucket_object, bucket, source_code_files\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -4090,7 +4084,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -4795,7 +4788,7 @@ "in": "query", "name": "from", "schema": { - "type": "integer" + "type": "string" } } ], @@ -5121,7 +5114,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_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, listing, chat_message, forum_post, ransomleak, forum_profile, blog_post, stealer_log, seller, financial_data, forum_topic\n- open_web: bucket_object, docker, social_media_account, paste, service, source_code_secrets, bucket, google, stack_exchange, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, financial_data, forum_profile, forum_topic, seller, listing, forum_post, bot, stealer_log, ransomleak, blog_post\n- open_web: social_media_account, service, source_code_secrets, stack_exchange, google, docker, paste, bucket_object, bucket, source_code_files\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -5138,7 +5131,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -5423,7 +5415,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_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, listing, chat_message, forum_post, ransomleak, forum_profile, blog_post, stealer_log, seller, financial_data, forum_topic\n- open_web: bucket_object, docker, social_media_account, paste, service, source_code_secrets, bucket, google, stack_exchange, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, financial_data, forum_profile, forum_topic, seller, listing, forum_post, bot, stealer_log, ransomleak, blog_post\n- open_web: social_media_account, service, source_code_secrets, stack_exchange, google, docker, paste, bucket_object, bucket, source_code_files\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -5440,7 +5432,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -6292,7 +6283,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -6362,7 +6352,6 @@ "slack", "discord", "splunk", - "cgcd", "jira", "teams", "servicenow", @@ -6509,29 +6498,29 @@ "search_types": { "items": { "enum": [ - "bucket_object", "chat_message", - "forum_post", + "source_code_secrets", + "paste", + "source_code_files", + "financial_data", + "stack_exchange", + "stealer_log", + "google", "ransomleak", + "bucket_object", + "domain", + "seller", + "forum_post", + "bot", + "bucket", + "social_media_account", "forum_profile", + "forum_topic", "service", "leak", - "blog_post", - "stack_exchange", - "source_code_files", - "forum_topic", - "bot", - "social_media_account", - "seller", - "bucket", - "stealer_log", - "financial_data", - "paste", "listing", "docker", - "source_code_secrets", - "google", - "domain", + "blog_post", "illicit_networks", "open_web", "buckets", @@ -6544,7 +6533,7 @@ "infected_devices", "social_media" ], - "example": "bucket_object", + "example": "chat_message", "type": "string" }, "type": "array" @@ -6553,7 +6542,6 @@ "enum": [ "USER", "SYSTEM_RELATION", - "DEMO", "SELF_ONBOARDING" ], "example": "USER", @@ -6622,30 +6610,30 @@ "search_types": { "items": { "enum": [ - "bucket_object", "chat_message", - "forum_post", + "source_code_secrets", + "paste", + "source_code_files", + "financial_data", + "ad", + "stack_exchange", + "stealer_log", + "google", "ransomleak", + "bucket_object", + "domain", + "seller", + "forum_post", + "bot", + "bucket", + "social_media_account", "forum_profile", + "forum_topic", "service", "leak", - "blog_post", - "stack_exchange", - "source_code_files", - "forum_topic", - "bot", - "social_media_account", - "seller", - "bucket", - "stealer_log", - "financial_data", - "ad", - "paste", "listing", "docker", - "source_code_secrets", - "google", - "domain", + "blog_post", "illicit_networks", "open_web", "buckets", @@ -6659,7 +6647,7 @@ "infected_devices", "social_media" ], - "example": "bucket_object", + "example": "chat_message", "type": "string" }, "type": "array" @@ -6790,7 +6778,10 @@ "bad_identifier_query", "above_max_group_nesting", "unknown_identifier_source", - "identifier_not_allowed" + "identifier_not_allowed", + "identifier_type_not_allowed", + "too_many_attributes", + "invalid_attribute_format" ], "example": "unknown_identifier_type", "type": "string" @@ -7526,10 +7517,6 @@ }, "TenantData": { "properties": { - "description": { - "description": "The Tenant's purpose / description", - "type": "string" - }, "industry": { "description": "The Tenant's industry", "enum": [ @@ -7563,7 +7550,6 @@ } }, "required": [ - "description", "industry", "name", "type" @@ -7612,7 +7598,6 @@ "type": { "enum": [ "auto-accept", - "ignore-term", "ignore-pattern" ], "example": "auto-accept", @@ -7647,7 +7632,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", diff --git a/docs/api-reference/spec/firework-v2-swagger.json b/docs/api-reference/spec/firework-v2-swagger.json index 0995ece..8835564 100644 --- a/docs/api-reference/spec/firework-v2-swagger.json +++ b/docs/api-reference/spec/firework-v2-swagger.json @@ -419,7 +419,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -489,7 +488,6 @@ "slack", "discord", "splunk", - "cgcd", "jira", "teams", "servicenow", @@ -648,29 +646,29 @@ "search_types": { "items": { "enum": [ - "bucket_object", "chat_message", - "forum_post", + "source_code_secrets", + "paste", + "source_code_files", + "financial_data", + "stack_exchange", + "stealer_log", + "google", "ransomleak", + "bucket_object", + "domain", + "seller", + "forum_post", + "bot", + "bucket", + "social_media_account", "forum_profile", + "forum_topic", "service", "leak", - "blog_post", - "stack_exchange", - "source_code_files", - "forum_topic", - "bot", - "social_media_account", - "seller", - "bucket", - "stealer_log", - "financial_data", - "paste", "listing", "docker", - "source_code_secrets", - "google", - "domain", + "blog_post", "illicit_networks", "open_web", "buckets", @@ -683,7 +681,7 @@ "infected_devices", "social_media" ], - "example": "bucket_object", + "example": "chat_message", "type": "string" }, "type": "array" @@ -692,7 +690,6 @@ "enum": [ "USER", "SYSTEM_RELATION", - "DEMO", "SELF_ONBOARDING" ], "example": "USER", @@ -760,30 +757,30 @@ "search_types": { "items": { "enum": [ - "bucket_object", "chat_message", - "forum_post", + "source_code_secrets", + "paste", + "source_code_files", + "financial_data", + "ad", + "stack_exchange", + "stealer_log", + "google", "ransomleak", + "bucket_object", + "domain", + "seller", + "forum_post", + "bot", + "bucket", + "social_media_account", "forum_profile", + "forum_topic", "service", "leak", - "blog_post", - "stack_exchange", - "source_code_files", - "forum_topic", - "bot", - "social_media_account", - "seller", - "bucket", - "stealer_log", - "financial_data", - "ad", - "paste", "listing", "docker", - "source_code_secrets", - "google", - "domain", + "blog_post", "illicit_networks", "open_web", "buckets", @@ -797,7 +794,7 @@ "infected_devices", "social_media" ], - "example": "bucket_object", + "example": "chat_message", "type": "string" }, "type": "array" @@ -947,7 +944,10 @@ "bad_identifier_query", "above_max_group_nesting", "unknown_identifier_source", - "identifier_not_allowed" + "identifier_not_allowed", + "identifier_type_not_allowed", + "too_many_attributes", + "invalid_attribute_format" ], "example": "unknown_identifier_type", "type": "string" @@ -1744,7 +1744,11 @@ "properties": { "description": { "description": "The Tenant's purpose / description", - "type": "string" + "example": "nullable string", + "type": [ + "string", + "null" + ] }, "global_search_calls_limit": { "description": "The number of global search api calls allowed for the tenant", @@ -1770,6 +1774,14 @@ "null" ] }, + "identities_limit": { + "description": "The number of identities allowed for the tenant", + "example": "nullable integer", + "type": [ + "integer", + "null" + ] + }, "industry": { "description": "The Tenant's industry", "enum": [ @@ -1861,7 +1873,6 @@ "type": { "enum": [ "auto-accept", - "ignore-term", "ignore-pattern" ], "example": "auto-accept", @@ -1896,7 +1907,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -2550,7 +2560,7 @@ "operationId": "get_ransom_leak_file_extensions_endpoint_/activities/document///extensions", "responses": { "200": { - "description": "Returns all the different file extensions that were found in a ransom leak." + "description": "Returns all the different file extensions that were found in the files of a ransom leak." }, "404": { "description": "Activity not found", @@ -3309,7 +3319,7 @@ }, "/firework/v2/activities/{index}/{source}/{id}/parent_chat_data": { "get": { - "operationId": "get_parent_chat_data_/activities////parent_chat_data", + "operationId": "get_parent_activity_data_/activities////parent_chat_data", "responses": { "200": { "description": "Returns the related parent_uids data" @@ -3798,7 +3808,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_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, listing, chat_message, forum_post, ransomleak, forum_profile, blog_post, stealer_log, seller, financial_data, forum_topic\n- open_web: bucket_object, docker, social_media_account, paste, service, source_code_secrets, bucket, google, stack_exchange, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, financial_data, forum_profile, forum_topic, seller, listing, forum_post, bot, stealer_log, ransomleak, blog_post\n- open_web: social_media_account, service, source_code_secrets, stack_exchange, google, docker, paste, bucket_object, bucket, source_code_files\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -3811,7 +3821,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -4064,7 +4073,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_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, listing, chat_message, forum_post, ransomleak, forum_profile, blog_post, stealer_log, seller, financial_data, forum_topic\n- open_web: bucket_object, docker, social_media_account, paste, service, source_code_secrets, bucket, google, stack_exchange, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, financial_data, forum_profile, forum_topic, seller, listing, forum_post, bot, stealer_log, ransomleak, blog_post\n- open_web: social_media_account, service, source_code_secrets, stack_exchange, google, docker, paste, bucket_object, bucket, source_code_files\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -4077,7 +4086,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -4500,7 +4508,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_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, listing, chat_message, forum_post, ransomleak, forum_profile, blog_post, stealer_log, seller, financial_data, forum_topic\n- open_web: bucket_object, docker, social_media_account, paste, service, source_code_secrets, bucket, google, stack_exchange, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, financial_data, forum_profile, forum_topic, seller, listing, forum_post, bot, stealer_log, ransomleak, blog_post\n- open_web: social_media_account, service, source_code_secrets, stack_exchange, google, docker, paste, bucket_object, bucket, source_code_files\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -4513,7 +4521,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -4766,7 +4773,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_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, listing, chat_message, forum_post, ransomleak, forum_profile, blog_post, stealer_log, seller, financial_data, forum_topic\n- open_web: bucket_object, docker, social_media_account, paste, service, source_code_secrets, bucket, google, stack_exchange, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, financial_data, forum_profile, forum_topic, seller, listing, forum_post, bot, stealer_log, ransomleak, blog_post\n- open_web: social_media_account, service, source_code_secrets, stack_exchange, google, docker, paste, bucket_object, bucket, source_code_files\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -4779,7 +4786,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -5077,7 +5083,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_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, listing, chat_message, forum_post, ransomleak, forum_profile, blog_post, stealer_log, seller, financial_data, forum_topic\n- open_web: bucket_object, docker, social_media_account, paste, service, source_code_secrets, bucket, google, stack_exchange, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, financial_data, forum_profile, forum_topic, seller, listing, forum_post, bot, stealer_log, ransomleak, blog_post\n- open_web: social_media_account, service, source_code_secrets, stack_exchange, google, docker, paste, bucket_object, bucket, source_code_files\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -5090,7 +5096,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -5379,7 +5384,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_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, listing, chat_message, forum_post, ransomleak, forum_profile, blog_post, stealer_log, seller, financial_data, forum_topic\n- open_web: bucket_object, docker, social_media_account, paste, service, source_code_secrets, bucket, google, stack_exchange, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, financial_data, forum_profile, forum_topic, seller, listing, forum_post, bot, stealer_log, ransomleak, blog_post\n- open_web: social_media_account, service, source_code_secrets, stack_exchange, google, docker, paste, bucket_object, bucket, source_code_files\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -5392,7 +5397,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -5615,7 +5619,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_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, listing, chat_message, forum_post, ransomleak, forum_profile, blog_post, stealer_log, seller, financial_data, forum_topic\n- open_web: bucket_object, docker, social_media_account, paste, service, source_code_secrets, bucket, google, stack_exchange, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, financial_data, forum_profile, forum_topic, seller, listing, forum_post, bot, stealer_log, ransomleak, blog_post\n- open_web: social_media_account, service, source_code_secrets, stack_exchange, google, docker, paste, bucket_object, bucket, source_code_files\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -5628,7 +5632,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -6186,7 +6189,7 @@ { "in": "query", "name": "from", - "type": "integer" + "type": "string" } ], "responses": { @@ -6450,7 +6453,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_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, listing, chat_message, forum_post, ransomleak, forum_profile, blog_post, stealer_log, seller, financial_data, forum_topic\n- open_web: bucket_object, docker, social_media_account, paste, service, source_code_secrets, bucket, google, stack_exchange, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, financial_data, forum_profile, forum_topic, seller, listing, forum_post, bot, stealer_log, ransomleak, blog_post\n- open_web: social_media_account, service, source_code_secrets, stack_exchange, google, docker, paste, bucket_object, bucket, source_code_files\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -6463,7 +6466,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -6700,7 +6702,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_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, listing, chat_message, forum_post, ransomleak, forum_profile, blog_post, stealer_log, seller, financial_data, forum_topic\n- open_web: bucket_object, docker, social_media_account, paste, service, source_code_secrets, bucket, google, stack_exchange, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, financial_data, forum_profile, forum_topic, seller, listing, forum_post, bot, stealer_log, ransomleak, blog_post\n- open_web: social_media_account, service, source_code_secrets, stack_exchange, google, docker, paste, bucket_object, bucket, source_code_files\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -6713,7 +6715,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", diff --git a/docs/api-reference/spec/firework-v3-openapi.json b/docs/api-reference/spec/firework-v3-openapi.json index b72c4ee..aed4552 100644 --- a/docs/api-reference/spec/firework-v3-openapi.json +++ b/docs/api-reference/spec/firework-v3-openapi.json @@ -247,7 +247,8 @@ "has_favicon", "has_screenshot", "looks_like", - "links_to_azure_tenant" + "links_to_azure_tenant", + "related_to" ], "type": "string" } @@ -473,7 +474,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_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, listing, chat_message, forum_post, ransomleak, forum_profile, blog_post, stealer_log, seller, financial_data, forum_topic\n- open_web: bucket_object, docker, social_media_account, paste, service, source_code_secrets, bucket, google, stack_exchange, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: stealer_log, blog_post, financial_data, seller, forum_topic, listing, ransomleak, bot, chat_message, forum_post, forum_profile\n- open_web: stack_exchange, source_code_files, bucket_object, service, paste, source_code_secrets, bucket, google, docker, social_media_account\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -490,7 +491,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -795,7 +795,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_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, listing, chat_message, forum_post, ransomleak, forum_profile, blog_post, stealer_log, seller, financial_data, forum_topic\n- open_web: bucket_object, docker, social_media_account, paste, service, source_code_secrets, bucket, google, stack_exchange, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: stealer_log, blog_post, financial_data, seller, forum_topic, listing, ransomleak, bot, chat_message, forum_post, forum_profile\n- open_web: stack_exchange, source_code_files, bucket_object, service, paste, source_code_secrets, bucket, google, docker, social_media_account\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -812,7 +812,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -1067,7 +1066,8 @@ "has_favicon", "has_screenshot", "looks_like", - "links_to_azure_tenant" + "links_to_azure_tenant", + "related_to" ], "type": "string" } @@ -1887,7 +1887,8 @@ "has_favicon", "has_screenshot", "looks_like", - "links_to_azure_tenant" + "links_to_azure_tenant", + "related_to" ], "example": "subdomain_of", "type": "string" @@ -2093,7 +2094,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -2147,7 +2147,6 @@ "enum": [ "USER", "SYSTEM_RELATION", - "DEMO", "SELF_ONBOARDING" ], "example": "USER", diff --git a/docs/api-reference/spec/firework-v3-swagger.json b/docs/api-reference/spec/firework-v3-swagger.json index ecd0f4e..7fcf84b 100644 --- a/docs/api-reference/spec/firework-v3-swagger.json +++ b/docs/api-reference/spec/firework-v3-swagger.json @@ -143,7 +143,8 @@ "has_favicon", "has_screenshot", "looks_like", - "links_to_azure_tenant" + "links_to_azure_tenant", + "related_to" ], "example": "subdomain_of", "type": "string" @@ -354,7 +355,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -408,7 +408,6 @@ "enum": [ "USER", "SYSTEM_RELATION", - "DEMO", "SELF_ONBOARDING" ], "example": "USER", @@ -1125,7 +1124,8 @@ "has_favicon", "has_screenshot", "looks_like", - "links_to_azure_tenant" + "links_to_azure_tenant", + "related_to" ], "in": "query", "name": "type", @@ -1311,7 +1311,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_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, listing, chat_message, forum_post, ransomleak, forum_profile, blog_post, stealer_log, seller, financial_data, forum_topic\n- open_web: bucket_object, docker, social_media_account, paste, service, source_code_secrets, bucket, google, stack_exchange, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: stealer_log, blog_post, financial_data, seller, forum_topic, listing, ransomleak, bot, chat_message, forum_post, forum_profile\n- open_web: stack_exchange, source_code_files, bucket_object, service, paste, source_code_secrets, bucket, google, docker, social_media_account\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -1324,7 +1324,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -1577,7 +1576,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_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, listing, chat_message, forum_post, ransomleak, forum_profile, blog_post, stealer_log, seller, financial_data, forum_topic\n- open_web: bucket_object, docker, social_media_account, paste, service, source_code_secrets, bucket, google, stack_exchange, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, stealer_log_cookie, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: stealer_log, blog_post, financial_data, seller, forum_topic, listing, ransomleak, bot, chat_message, forum_post, forum_profile\n- open_web: stack_exchange, source_code_files, bucket_object, service, paste, source_code_secrets, bucket, google, docker, social_media_account\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -1590,7 +1589,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -1797,7 +1795,8 @@ "has_favicon", "has_screenshot", "looks_like", - "links_to_azure_tenant" + "links_to_azure_tenant", + "related_to" ], "in": "query", "name": "type", diff --git a/docs/api-reference/spec/firework-v4-openapi.json b/docs/api-reference/spec/firework-v4-openapi.json index 0da3b12..0b21428 100644 --- a/docs/api-reference/spec/firework-v4-openapi.json +++ b/docs/api-reference/spec/firework-v4-openapi.json @@ -12,6 +12,9 @@ "paths": { "/firework/v4/admin/cookies/configurations": { "get": { + "tags": [ + "private" + ], "summary": "List Cookie Monitoring Configurations", "operationId": "list_cookie_monitoring_configurations_admin_cookies_configurations_get", "parameters": [ @@ -92,6 +95,9 @@ }, "/firework/v4/admin/cookies/monitor": { "post": { + "tags": [ + "private" + ], "summary": "Create Cookie Monitoring Configuration", "operationId": "create_cookie_monitoring_configuration_admin_cookies_monitor_post", "requestBody": { @@ -128,6 +134,9 @@ }, "/firework/v4/admin/threat_flow/reports": { "get": { + "tags": [ + "private" + ], "summary": "List Reports", "operationId": "list_reports_admin_threat_flow_reports_get", "parameters": [ @@ -218,6 +227,9 @@ }, "/firework/v4/admin/threat_flow/reports/{report_id}": { "get": { + "tags": [ + "private" + ], "summary": "Get Report", "operationId": "get_report_admin_threat_flow_reports__report_id__get", "parameters": [ @@ -255,6 +267,9 @@ } }, "put": { + "tags": [ + "private" + ], "summary": "Update Report", "operationId": "update_report_admin_threat_flow_reports__report_id__put", "parameters": [ @@ -304,6 +319,9 @@ }, "/firework/v4/admin/identifiers/{identifier_id}/update_domain_identifier_properties": { "post": { + "tags": [ + "private" + ], "summary": "Update Domain Identifier Properties", "description": "Schedule the update of the domain identifier properties for a given identifier.", "operationId": "update_domain_identifier_properties_admin_identifiers__identifier_id__update_domain_identifier_properties_post", @@ -343,37 +361,32 @@ } } }, - "/firework/v4/actors/{actor_name}/profile": { + "/firework/v4/admin/feature_flags/": { "get": { - "summary": "Get Actor Profile", - "operationId": "get_actor_profile_actors__actor_name__profile_get", + "tags": [ + "private" + ], + "summary": "List Feature Flags", + "operationId": "list_feature_flags_admin_feature_flags__get", "parameters": [ { - "name": "actor_name", - "in": "path", - "required": true, + "name": "page", + "in": "query", + "required": false, "schema": { - "type": "string", - "title": "Actor Name" + "type": "integer", + "default": 1, + "title": "Page" } }, { - "name": "sources", + "name": "size", "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ], - "title": "Sources" + "type": "integer", + "default": 100, + "title": "Size" } } ], @@ -383,7 +396,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActorMetadata" + "$ref": "#/components/schemas/ListFeatureFlagsResponse" } } } @@ -401,133 +414,144 @@ } } }, - "/firework/v4/actors/{actor_name}/timeline": { + "/firework/v4/admin/feature_flags/{feature_flag_name}": { "get": { - "summary": "Get Actor Timeline", - "operationId": "get_actor_timeline_actors__actor_name__timeline_get", + "tags": [ + "private" + ], + "summary": "Get Feature Flag", + "operationId": "get_feature_flag_admin_feature_flags__feature_flag_name__get", "parameters": [ { - "name": "actor_name", + "name": "feature_flag_name", "in": "path", "required": true, "schema": { "type": "string", - "title": "Actor Name" + "title": "Feature Flag Name" } - }, - { - "name": "times", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FeatureFlagDefinition" } - ], - "title": "Times" + } } }, - { - "name": "time_zone", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" } - ], - "title": "Time Zone" + } + } + } + } + } + }, + "/firework/v4/admin/restricted_terms/is_allowed": { + "post": { + "tags": [ + "private" + ], + "summary": "Is Allowed", + "operationId": "is_allowed_admin_restricted_terms_is_allowed_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchQueryAllowedRequest" + } } }, - { - "name": "search_types", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/SearchType" - } - }, - { - "type": "null" + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchQueryAllowedResponse" } - ], - "title": "Search Types" + } } }, - { - "name": "risk_scores", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/RiskScore" - } - }, - { - "type": "null" + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" } - ], - "title": "Risk Scores" + } + } + } + } + } + }, + "/firework/v4/admin/restricted_terms/are_allowed": { + "post": { + "tags": [ + "private" + ], + "summary": "Are Allowed", + "operationId": "are_allowed_admin_restricted_terms_are_allowed_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchTermsAllowedRequest" + } } }, - { - "name": "sources", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchQueryAllowedResponse" } - ], - "title": "Sources" + } } }, - { - "name": "aggregate_by", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/StatsAggregates" - }, - { - "type": "null" + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" } - ], - "title": "Aggregate By" + } } } + } + } + }, + "/firework/v4/admin/restricted_terms": { + "get": { + "tags": [ + "private" ], + "summary": "Get Restricted Terms", + "operationId": "get_restricted_terms_admin_restricted_terms_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActorTimeline" + "$ref": "#/components/schemas/RestrictedTerms" } } } @@ -545,122 +569,80 @@ } } }, - "/firework/v4/actors/{actor_name}/recent-activities": { + "/firework/v4/admin/organizations/{organization_id}/allowed_restricted_terms": { "get": { - "summary": "Get Actor Recent Activities", - "operationId": "get_actor_recent_activities_actors__actor_name__recent_activities_get", + "tags": [ + "private" + ], + "summary": "Get Allowed Restricted Terms", + "operationId": "get_allowed_restricted_terms_admin_organizations__organization_id__allowed_restricted_terms_get", "parameters": [ { - "name": "actor_name", + "name": "organization_id", "in": "path", "required": true, "schema": { - "type": "string", - "title": "Actor Name" + "type": "integer", + "title": "Organization Id" } - }, - { - "name": "times", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAllowedRestrictedTermsResponse" } - ], - "title": "Times" + } } }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "post": { + "tags": [ + "private" + ], + "summary": "Add Allowed Restricted Term", + "operationId": "add_allowed_restricted_term_admin_organizations__organization_id__allowed_restricted_terms_post", + "parameters": [ { - "name": "time_zone", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Time Zone" - } - }, - { - "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, + "name": "organization_id", + "in": "path", + "required": true, "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ], - "title": "Sources" + "type": "integer", + "title": "Organization Id" } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddAllowedRestrictedTermRequest" + } + } + } + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ActorEvent" - }, - "title": "Response Get Actor Recent Activities Actors Actor Name Recent Activities Get" - } + "schema": {} } } }, @@ -677,19 +659,30 @@ } } }, - "/firework/v4/actors/summaries/{request_id}": { - "get": { - "summary": "Get Actor Summaries By Request Id", - "operationId": "get_actor_summaries_by_request_id_actors_summaries__request_id__get", + "/firework/v4/admin/organizations/{organization_id}/allowed_restricted_terms/{restricted_term_id}": { + "delete": { + "tags": [ + "private" + ], + "summary": "Delete Allowed Restricted Terms", + "operationId": "delete_allowed_restricted_terms_admin_organizations__organization_id__allowed_restricted_terms__restricted_term_id__delete", "parameters": [ { - "name": "request_id", + "name": "organization_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Organization Id" + } + }, + { + "name": "restricted_term_id", "in": "path", "required": true, "schema": { "type": "string", - "format": "uuid", - "title": "Request Id" + "title": "Restricted Term Id" } } ], @@ -698,17 +691,7 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/ActorSummariesResponse" - }, - { - "type": "null" - } - ], - "title": "Response Get Actor Summaries By Request Id Actors Summaries Request Id Get" - } + "schema": {} } } }, @@ -723,20 +706,30 @@ } } } - } - }, - "/firework/v4/actors/{actor_name}/generate_summaries": { - "post": { - "summary": "Generate Actor Summaries", - "operationId": "generate_actor_summaries_actors__actor_name__generate_summaries_post", + }, + "put": { + "tags": [ + "private" + ], + "summary": "Update Allowed Restricted Terms", + "operationId": "update_allowed_restricted_terms_admin_organizations__organization_id__allowed_restricted_terms__restricted_term_id__put", "parameters": [ { - "name": "actor_name", + "name": "organization_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Organization Id" + } + }, + { + "name": "restricted_term_id", "in": "path", "required": true, "schema": { "type": "string", - "title": "Actor Name" + "title": "Restricted Term Id" } } ], @@ -745,7 +738,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActorSummariesGenerationPayload" + "$ref": "#/components/schemas/UpdateAllowedRestrictedTermRequest" } } } @@ -755,9 +748,7 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ActorSummariesResponse" - } + "schema": {} } } }, @@ -774,10 +765,13 @@ } } }, - "/firework/v4/actors/{actor_name}/heatmap": { + "/firework/v4/actors/{actor_name}/profile": { "get": { - "summary": "Get Actor Heatmap", - "operationId": "get_actor_heatmap_actors__actor_name__heatmap_get", + "tags": [ + "private" + ], + "summary": "Get Actor Profile", + "operationId": "get_actor_profile_actors__actor_name__profile_get", "parameters": [ { "name": "actor_name", @@ -806,38 +800,6 @@ ], "title": "Sources" } - }, - { - "name": "times", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Times" - } - }, - { - "name": "time_zone", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Time Zone" - } } ], "responses": { @@ -846,15 +808,7 @@ "content": { "application/json": { "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/ActorHeatmapData" - }, - { - "type": "null" - } - ], - "title": "Response Get Actor Heatmap Actors Actor Name Heatmap Get" + "$ref": "#/components/schemas/ActorMetadata" } } } @@ -872,10 +826,13 @@ } } }, - "/firework/v4/actors/{actor_name}/communication-handles": { + "/firework/v4/actors/{actor_name}/timeline": { "get": { - "summary": "Get Actor Communication Handles", - "operationId": "get_actor_communication_handles_actors__actor_name__communication_handles_get", + "tags": [ + "private" + ], + "summary": "Get Actor Timeline", + "operationId": "get_actor_timeline_actors__actor_name__timeline_get", "parameters": [ { "name": "actor_name", @@ -887,78 +844,688 @@ } }, { - "name": "sources", + "name": "times", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "array", - "items": { - "type": "string" - } + "type": "string" }, { "type": "null" } ], - "title": "Sources" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ActorCommunicationHandle" - }, - "title": "Response Get Actor Communication Handles Actors Actor Name Communication Handles Get" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/actors/{actor_name}/network": { - "get": { - "summary": "Get Actor Network", - "operationId": "get_actor_network_actors__actor_name__network_get", - "parameters": [ - { - "name": "actor_name", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Actor Name" + "title": "Times" } }, { - "name": "sources", + "name": "time_zone", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "array", - "items": { - "type": "string" - } + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Time Zone" + } + }, + { + "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": { + "anyOf": [ + { + "$ref": "#/components/schemas/StatsAggregates" + }, + { + "type": "null" + } + ], + "title": "Aggregate By" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActorTimeline" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/actors/{actor_name}/recent-activities": { + "get": { + "tags": [ + "private" + ], + "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": "time_zone", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Time Zone" + } + }, + { + "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": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EventInput" + }, + "title": "Response Get Actor Recent Activities Actors Actor Name Recent Activities Get" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/actors/{actor_name}/analysis/metadata": { + "get": { + "tags": [ + "private" + ], + "summary": "Get Actor Analysis Metadata", + "operationId": "get_actor_analysis_metadata_actors__actor_name__analysis_metadata_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/ActorAnalysisMetadataResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/actors/summaries/{request_id}": { + "get": { + "tags": [ + "private" + ], + "summary": "Get Actor Summaries By Request Id", + "operationId": "get_actor_summaries_by_request_id_actors_summaries__request_id__get", + "parameters": [ + { + "name": "request_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Request Id" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActorSummariesResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/actors/{actor_name}/generate-summaries": { + "post": { + "tags": [ + "private" + ], + "summary": "Generate Actor Summaries", + "operationId": "generate_actor_summaries_actors__actor_name__generate_summaries_post", + "parameters": [ + { + "name": "actor_name", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Actor Name" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActorSummariesGenerationPayload" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActorSummariesResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/actors/{actor_name}/regenerate-summaries": { + "post": { + "tags": [ + "private" + ], + "summary": "Regenerate Actor Summaries", + "operationId": "regenerate_actor_summaries_actors__actor_name__regenerate_summaries_post", + "parameters": [ + { + "name": "actor_name", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Actor Name" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActorSummariesGenerationPayload" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActorSummariesResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/actors/{actor_name}/heatmap": { + "get": { + "tags": [ + "private" + ], + "summary": "Get Actor Heatmap", + "operationId": "get_actor_heatmap_actors__actor_name__heatmap_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" + } + }, + { + "name": "times", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Times" + } + }, + { + "name": "time_zone", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Time Zone" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "anyOf": [ + { + "$ref": "#/components/schemas/ActorHeatmapData" + }, + { + "type": "null" + } + ], + "title": "Response Get Actor Heatmap Actors Actor Name Heatmap Get" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/actors/{actor_name}/communication-handles": { + "get": { + "tags": [ + "private" + ], + "summary": "Get Actor Communication Handles", + "operationId": "get_actor_communication_handles_actors__actor_name__communication_handles_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": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ActorCommunicationHandle" + }, + "title": "Response Get Actor Communication Handles Actors Actor Name Communication Handles Get" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/actors/{actor_name}/network": { + "get": { + "tags": [ + "private" + ], + "summary": "Get Actor Network", + "operationId": "get_actor_network_actors__actor_name__network_get", + "parameters": [ + { + "name": "actor_name", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Actor Name" + } + }, + { + "name": "group_by", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "$ref": "#/components/schemas/GroupByType" + }, + { + "type": "null" + } + ], + "title": "Group By" + } + }, + { + "name": "sources", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } }, { "type": "null" @@ -974,7 +1541,278 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GraphDTO" + "$ref": "#/components/schemas/ActorGraph" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/alerts/": { + "get": { + "tags": [ + "public" + ], + "summary": "Tenant Alerts", + "operationId": "tenant_alerts_alerts__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", + "maximum": 10, + "exclusiveMinimum": 0, + "default": 10, + "title": "Size" + } + }, + { + "name": "order_type", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/OrderType", + "default": "asc" + } + }, + { + "name": "q", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Q" + } + }, + { + "name": "feed_owner_id", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Feed Owner Id" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaginatedResults_Alert_" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "post": { + "tags": [ + "private" + ], + "summary": "Create Alert", + "operationId": "create_alert_alerts__post", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateAlert" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Alert" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/alerts/{alert_id}": { + "patch": { + "tags": [ + "private" + ], + "summary": "Update Alert", + "operationId": "update_alert_alerts__alert_id__patch", + "parameters": [ + { + "name": "alert_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Alert Id" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PartialAlert" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Alert" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "delete": { + "tags": [ + "private" + ], + "summary": "Delete Alert", + "operationId": "delete_alert_alerts__alert_id__delete", + "parameters": [ + { + "name": "alert_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Alert Id" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "get": { + "tags": [ + "private" + ], + "summary": "Get Tenant Alert", + "operationId": "get_tenant_alert_alerts__alert_id__get", + "parameters": [ + { + "name": "alert_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Alert Id" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Alert" } } } @@ -992,10 +1830,13 @@ } } }, - "/firework/v4/alerts/": { + "/firework/v4/alerts/channels": { "get": { - "summary": "Tenant Alerts", - "operationId": "tenant_alerts_alerts__get", + "tags": [ + "public" + ], + "summary": "Alert Channels", + "operationId": "alert_channels_alerts_channels_get", "parameters": [ { "name": "from_", @@ -1046,24 +1887,175 @@ { "type": "null" } - ], - "title": "Q" + ], + "title": "Q" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaginatedResults_PartialAlertChannel_" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "post": { + "tags": [ + "public" + ], + "summary": "Create Channel", + "operationId": "create_channel_alerts_channels_post", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateAlertChannel" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AlertChannel" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/alerts/channels/{alert_channel_id}": { + "delete": { + "tags": [ + "private" + ], + "summary": "Delete Channel", + "operationId": "delete_channel_alerts_channels__alert_channel_id__delete", + "parameters": [ + { + "name": "alert_channel_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Alert Channel Id" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "put": { + "tags": [ + "private" + ], + "summary": "Update Channel", + "operationId": "update_channel_alerts_channels__alert_channel_id__put", + "parameters": [ + { + "name": "alert_channel_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Alert Channel Id" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateAlertChannel" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } } - }, + } + } + }, + "get": { + "tags": [ + "private" + ], + "summary": "Get Alert Channel", + "operationId": "get_alert_channel_alerts_channels__alert_channel_id__get", + "parameters": [ { - "name": "feed_owner_id", - "in": "query", - "required": false, + "name": "alert_channel_id", + "in": "path", + "required": true, "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Feed Owner Id" + "type": "integer", + "title": "Alert Channel Id" } } ], @@ -1073,7 +2065,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedResults_Alert_" + "$ref": "#/components/schemas/AlertChannel" } } } @@ -1089,19 +2081,24 @@ } } } - }, + } + }, + "/firework/v4/tasks/": { "post": { - "summary": "Create Alert", - "operationId": "create_alert_alerts__post", + "tags": [ + "private" + ], + "summary": "Bulk Actions", + "operationId": "bulk_actions_tasks__post", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateAlert" + "$ref": "#/components/schemas/BulkActionsRequestBody" } } - } + }, + "required": true }, "responses": { "200": { @@ -1109,7 +2106,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Alert" + "$ref": "#/components/schemas/PaginatedResults_EnrichedBulkAction_" } } } @@ -1127,38 +2124,31 @@ } } }, - "/firework/v4/alerts/{alert_id}": { - "patch": { - "summary": "Update Alert", - "operationId": "update_alert_alerts__alert_id__patch", + "/firework/v4/integrations/credential_validations": { + "get": { + "tags": [ + "private" + ], + "summary": "Get Credential Validations", + "operationId": "get_credential_validations_integrations_credential_validations_get", "parameters": [ { - "name": "alert_id", - "in": "path", + "name": "credential_hash", + "in": "query", "required": true, "schema": { - "type": "integer", - "title": "Alert Id" + "type": "string", + "title": "Credential Hash" } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PartialAlert" - } - } - } - }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Alert" + "$ref": "#/components/schemas/PaginatedResults_CredentialValidationReponse_" } } } @@ -1175,26 +2165,30 @@ } } }, - "delete": { - "summary": "Delete Alert", - "operationId": "delete_alert_alerts__alert_id__delete", - "parameters": [ - { - "name": "alert_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Alert Id" + "post": { + "tags": [ + "private" + ], + "summary": "Validate Credential", + "operationId": "validate_credential_integrations_credential_validations_post", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredentialValidationRequestBody" + } } } - ], + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/CredentialValidationReponse" + } } } }, @@ -1209,18 +2203,23 @@ } } } - }, - "get": { - "summary": "Get Tenant Alert", - "operationId": "get_tenant_alert_alerts__alert_id__get", + } + }, + "/firework/v4/integrations/credential_validations/{tenant_id}/reset": { + "post": { + "tags": [ + "private" + ], + "summary": "Reset Credential Validations", + "operationId": "reset_credential_validations_integrations_credential_validations__tenant_id__reset_post", "parameters": [ { - "name": "alert_id", + "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "integer", - "title": "Alert Id" + "title": "Tenant Id" } } ], @@ -1229,9 +2228,7 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/Alert" - } + "schema": {} } } }, @@ -1248,73 +2245,29 @@ } } }, - "/firework/v4/alerts/channels": { - "get": { - "summary": "Alert Channels", - "operationId": "alert_channels_alerts_channels_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", - "maximum": 10, - "exclusiveMinimum": 0, - "default": 10, - "title": "Size" - } - }, - { - "name": "order_type", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/OrderType", - "default": "asc" + "/firework/v4/credentials/bulk_action": { + "post": { + "tags": [ + "private" + ], + "summary": "Create Credential Bulk Action", + "operationId": "create_credential_bulk_action_credentials_bulk_action_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredentialBulkActionRequestBody" + } } }, - { - "name": "q", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Q" - } - } - ], + "required": true + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_PartialAlertChannel_" - } + "schema": {} } } }, @@ -1329,16 +2282,20 @@ } } } - }, + } + }, + "/firework/v4/events/tenant/_search": { "post": { - "summary": "Create Channel", - "operationId": "create_channel_alerts_channels_post", + "tags": [ + "public" + ], + "summary": "Current Tenant Feed", + "operationId": "current_tenant_feed_events_tenant__search_post", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateAlertChannel" + "$ref": "#/components/schemas/FeedRequestBody" } } } @@ -1349,7 +2306,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AlertChannel" + "$ref": "#/components/schemas/PaginatedResults_FeedItem_" } } } @@ -1367,27 +2324,31 @@ } } }, - "/firework/v4/alerts/channels/{alert_channel_id}": { - "delete": { - "summary": "Delete Channel", - "operationId": "delete_channel_alerts_channels__alert_channel_id__delete", - "parameters": [ - { - "name": "alert_channel_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Alert Channel Id" - } - } + "/firework/v4/events/global/_search": { + "post": { + "tags": [ + "public" ], + "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": {} + "schema": { + "$ref": "#/components/schemas/PaginatedResults_FeedItem_" + } } } }, @@ -1402,27 +2363,31 @@ } } } - }, - "put": { - "summary": "Update Channel", - "operationId": "update_channel_alerts_channels__alert_channel_id__put", + } + }, + "/firework/v4/events/identifiers/{identifier_id}/_search": { + "post": { + "tags": [ + "public" + ], + "summary": "Identifier Feed", + "operationId": "identifier_feed_events_identifiers__identifier_id___search_post", "parameters": [ { - "name": "alert_channel_id", + "name": "identifier_id", "in": "path", "required": true, "schema": { "type": "integer", - "title": "Alert Channel Id" + "title": "Identifier Id" } } ], "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateAlertChannel" + "$ref": "#/components/schemas/FeedRequestBody" } } } @@ -1432,7 +2397,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/PaginatedResults_FeedItem_" + } } } }, @@ -1447,28 +2414,42 @@ } } } - }, - "get": { - "summary": "Get Alert Channel", - "operationId": "get_alert_channel_alerts_channels__alert_channel_id__get", + } + }, + "/firework/v4/events/identifier_groups/{identifier_group_id}/_search": { + "post": { + "tags": [ + "public" + ], + "summary": "Identifier Group Feed", + "operationId": "identifier_group_feed_events_identifier_groups__identifier_group_id___search_post", "parameters": [ { - "name": "alert_channel_id", + "name": "identifier_group_id", "in": "path", "required": true, "schema": { "type": "integer", - "title": "Alert Channel Id" + "title": "Identifier Group Id" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FeedRequestBody" + } + } + } + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AlertChannel" + "$ref": "#/components/schemas/PaginatedResults_FeedItem_" } } } @@ -1486,27 +2467,20 @@ } } }, - "/firework/v4/tasks/": { - "post": { - "summary": "Bulk Actions", - "operationId": "bulk_actions_tasks__post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BulkActionsRequestBody" - } - } - }, - "required": true - }, + "/firework/v4/events/filters/types": { + "get": { + "tags": [ + "public" + ], + "summary": "Fetch Filters Source Types", + "operationId": "fetch_filters_source_types_events_filters_types_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedResults_EnrichedBulkAction_" + "$ref": "#/components/schemas/FilterSourceTypes" } } } @@ -1524,28 +2498,20 @@ } } }, - "/firework/v4/integrations/credential_validations": { + "/firework/v4/events/filters/severities": { "get": { - "summary": "Get Credential Validations", - "operationId": "get_credential_validations_integrations_credential_validations_get", - "parameters": [ - { - "name": "credential_hash", - "in": "query", - "required": true, - "schema": { - "type": "string", - "title": "Credential Hash" - } - } + "tags": [ + "public" ], + "summary": "Fetch Filters Risk Score", + "operationId": "fetch_filters_risk_score_events_filters_severities_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedResults_CredentialValidationReponse_" + "$ref": "#/components/schemas/FilterSeverities" } } } @@ -1561,28 +2527,31 @@ } } } - }, + } + }, + "/firework/v4/events/actions": { "post": { - "summary": "Validate Credential", - "operationId": "validate_credential_integrations_credential_validations_post", + "tags": [ + "public" + ], + "summary": "Event Actions", + "operationId": "event_actions_events_actions_post", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CredentialValidationRequestBody" + "$ref": "#/components/schemas/EventActionsBody" } } - } + }, + "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/CredentialValidationReponse" - } + "schema": {} } } }, @@ -1599,15 +2568,18 @@ } } }, - "/firework/v4/credentials/bulk_action": { + "/firework/v4/events/extracted_secrets": { "post": { - "summary": "Create Credential Bulk Action", - "operationId": "create_credential_bulk_action_credentials_bulk_action_post", + "tags": [ + "private" + ], + "summary": "Fetch Extracted Secrets", + "operationId": "fetch_extracted_secrets_events_extracted_secrets_post", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CredentialBulkActionRequestBody" + "$ref": "#/components/schemas/EventSecretsBody" } } }, @@ -1618,7 +2590,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/PaginatedResults_SecretItem_" + } } } }, @@ -1635,26 +2609,35 @@ } } }, - "/firework/v4/events/tenant/_search": { - "post": { - "summary": "Current Tenant Feed", - "operationId": "current_tenant_feed_events_tenant__search_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FeedRequestBody" - } + "/firework/v4/events/matching_identifiers": { + "get": { + "tags": [ + "private" + ], + "summary": "Get Matching Identifiers", + "operationId": "get_matching_identifiers_events_matching_identifiers_get", + "parameters": [ + { + "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/PaginatedResults_FeedItem_" + "type": "array", + "items": { + "$ref": "#/components/schemas/Identifier" + }, + "title": "Response Get Matching Identifiers Events Matching Identifiers Get" } } } @@ -1672,15 +2655,18 @@ } } }, - "/firework/v4/events/global/_search": { + "/firework/v4/file_analysis/submit": { "post": { - "summary": "Global Search", - "operationId": "global_search_events_global__search_post", + "tags": [ + "private" + ], + "summary": "Submit Presigned Url", + "operationId": "submit_presigned_url_file_analysis_submit_post", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GlobalSearchRequestBody" + "$ref": "#/components/schemas/FileAnalysisSubmit" } } }, @@ -1691,9 +2677,7 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_FeedItem_" - } + "schema": {} } } }, @@ -1710,37 +2694,91 @@ } } }, - "/firework/v4/events/identifiers/{identifier_id}/_search": { - "post": { - "summary": "Identifier Feed", - "operationId": "identifier_feed_events_identifiers__identifier_id___search_post", + "/firework/v4/forum-threads/{forum_thread_id}/metadata": { + "get": { + "tags": [ + "private" + ], + "summary": "Get Forum Thread Metadata", + "operationId": "get_forum_thread_metadata_forum_threads__forum_thread_id__metadata_get", "parameters": [ { - "name": "identifier_id", + "name": "forum_thread_id", "in": "path", "required": true, "schema": { - "type": "integer", - "title": "Identifier Id" + "type": "string", + "title": "Forum Thread Id" + } + }, + { + "name": "source", + "in": "query", + "required": true, + "schema": { + "type": "string", + "title": "Source" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FeedRequestBody" + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ForumThreadMetadata" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } - }, + } + } + }, + "/firework/v4/forum-threads/{forum_thread_id}/analysis/metadata": { + "get": { + "tags": [ + "private" + ], + "summary": "Get Forum Thread Analysis Metadata", + "operationId": "get_forum_thread_analysis_metadata_forum_threads__forum_thread_id__analysis_metadata_get", + "parameters": [ + { + "name": "forum_thread_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Forum Thread Id" + } + }, + { + "name": "source", + "in": "query", + "required": true, + "schema": { + "type": "string", + "title": "Source" + } + } + ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedResults_FeedItem_" + "$ref": "#/components/schemas/ForumThreadAnalysisMetadataResponse" } } } @@ -1758,37 +2796,88 @@ } } }, - "/firework/v4/events/identifier_groups/{identifier_group_id}/_search": { - "post": { - "summary": "Identifier Group Feed", - "operationId": "identifier_group_feed_events_identifier_groups__identifier_group_id___search_post", + "/firework/v4/forum-threads/{forum_thread_id}/breakdown": { + "get": { + "tags": [ + "private" + ], + "summary": "Get Forum Thread Breakdown", + "operationId": "get_forum_thread_breakdown_forum_threads__forum_thread_id__breakdown_get", "parameters": [ { - "name": "identifier_group_id", + "name": "forum_thread_id", "in": "path", "required": true, "schema": { - "type": "integer", - "title": "Identifier Group Id" + "type": "string", + "title": "Forum Thread Id" + } + }, + { + "name": "times", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Times" + } + }, + { + "name": "time_zone", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Time Zone" + } + }, + { + "name": "source", + "in": "query", + "required": true, + "schema": { + "type": "string", + "title": "Source" + } + }, + { + "name": "aggregate_by", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "$ref": "#/components/schemas/StatsAggregates" + }, + { + "type": "null" + } + ], + "title": "Aggregate By" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FeedRequestBody" - } - } - } - }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedResults_FeedItem_" + "$ref": "#/components/schemas/ForumThreadTimeline" } } } @@ -1806,45 +2895,57 @@ } } }, - "/firework/v4/events/filters/types": { + "/firework/v4/forum-threads/{forum_thread_id}/indicators": { "get": { - "summary": "Fetch Filters Source Types", - "operationId": "fetch_filters_source_types_events_filters_types_get", - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilterSourceTypes" - } - } + "tags": [ + "private" + ], + "summary": "Get Forum Thread Indicators", + "operationId": "get_forum_thread_indicators_forum_threads__forum_thread_id__indicators_get", + "parameters": [ + { + "name": "forum_thread_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Forum Thread Id" } }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + { + "name": "source", + "in": "query", + "required": true, + "schema": { + "type": "string", + "title": "Source" + } + }, + { + "name": "scope", + "in": "query", + "required": true, + "schema": { + "enum": [ + "original_post", + "replies" + ], + "type": "string", + "title": "Scope" } } - } - } - }, - "/firework/v4/events/filters/severities": { - "get": { - "summary": "Fetch Filters Risk Score", - "operationId": "fetch_filters_risk_score_events_filters_severities_get", + ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FilterSeverities" + "type": "array", + "items": { + "$ref": "#/components/schemas/ForumThreadIndicator" + }, + "title": "Response Get Forum Thread Indicators Forum Threads Forum Thread Id Indicators Get" } } } @@ -1862,26 +2963,42 @@ } } }, - "/firework/v4/events/actions": { + "/firework/v4/forum-threads/{forum_thread_id}/generate-summaries": { "post": { - "summary": "Event Actions", - "operationId": "event_actions_events_actions_post", + "tags": [ + "private" + ], + "summary": "Generate Forum Thread Summaries", + "operationId": "generate_forum_thread_summaries_forum_threads__forum_thread_id__generate_summaries_post", + "parameters": [ + { + "name": "forum_thread_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Forum Thread Id" + } + } + ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EventActionsBody" + "$ref": "#/components/schemas/ForumThreadSummariesGenerationPayload" } } - }, - "required": true + } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/ForumThreadSummariesResponse" + } } } }, @@ -1898,19 +3015,33 @@ } } }, - "/firework/v4/events/extracted_secrets": { + "/firework/v4/forum-threads/{forum_thread_id}/regenerate-summaries": { "post": { - "summary": "Fetch Extracted Secrets", - "operationId": "fetch_extracted_secrets_events_extracted_secrets_post", + "tags": [ + "private" + ], + "summary": "Regenerate Forum Thread Summaries", + "operationId": "regenerate_forum_thread_summaries_forum_threads__forum_thread_id__regenerate_summaries_post", + "parameters": [ + { + "name": "forum_thread_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Forum Thread Id" + } + } + ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EventSecretsBody" + "$ref": "#/components/schemas/ForumThreadSummariesGenerationPayload" } } - }, - "required": true + } }, "responses": { "200": { @@ -1918,7 +3049,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedResults_SecretItem_" + "$ref": "#/components/schemas/ForumThreadSummariesResponse" } } } @@ -1936,26 +3067,33 @@ } } }, - "/firework/v4/file_analysis/submit": { - "post": { - "summary": "Submit Presigned Url", - "operationId": "submit_presigned_url_file_analysis_submit_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileAnalysisSubmit" - } + "/firework/v4/forum-threads/summaries/{request_id}": { + "get": { + "tags": [ + "private" + ], + "summary": "Get Forum Thread Summaries By Request Id", + "operationId": "get_forum_thread_summaries_by_request_id_forum_threads_summaries__request_id__get", + "parameters": [ + { + "name": "request_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Request Id" } - }, - "required": true - }, + } + ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/ForumThreadSummariesResponse" + } } } }, @@ -1974,6 +3112,9 @@ }, "/firework/v4/healthz/": { "get": { + "tags": [ + "public" + ], "summary": "Is Api Up And Running", "operationId": "is_api_up_and_running_healthz__get", "responses": { @@ -1987,12 +3128,25 @@ } } } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/firework/v4/identifiers/count": { "get": { + "tags": [ + "private" + ], "summary": "Get Identifier Count", "operationId": "get_identifier_count_identifiers_count_get", "parameters": [ @@ -2127,6 +3281,38 @@ "title": "Properties" } }, + { + "name": "reachable_dates", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "$ref": "#/components/schemas/Times" + }, + { + "type": "null" + } + ], + "title": "Reachable Dates" + } + }, + { + "name": "resolves_dates", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "$ref": "#/components/schemas/Times" + }, + { + "type": "null" + } + ], + "title": "Resolves Dates" + } + }, { "name": "types", "in": "query", @@ -2183,6 +3369,9 @@ }, "/firework/v4/identifiers/": { "post": { + "tags": [ + "public" + ], "summary": "Create Identifier", "operationId": "create_identifier_identifiers__post", "requestBody": { @@ -2219,6 +3408,9 @@ } }, "get": { + "tags": [ + "public" + ], "summary": "Get Identifiers", "operationId": "get_identifiers_identifiers__get", "parameters": [ @@ -2353,6 +3545,38 @@ "title": "Properties" } }, + { + "name": "reachable_dates", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "$ref": "#/components/schemas/Times" + }, + { + "type": "null" + } + ], + "title": "Reachable Dates" + } + }, + { + "name": "resolves_dates", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "$ref": "#/components/schemas/Times" + }, + { + "type": "null" + } + ], + "title": "Resolves Dates" + } + }, { "name": "types", "in": "query", @@ -2409,6 +3633,9 @@ }, "/firework/v4/identifiers/{identifier_id}": { "put": { + "tags": [ + "private" + ], "summary": "Update Identifier By Id", "operationId": "update_identifier_by_id_identifiers__identifier_id__put", "parameters": [ @@ -2456,6 +3683,9 @@ } }, "get": { + "tags": [ + "public" + ], "summary": "Get Identifier", "operationId": "get_identifier_identifiers__identifier_id__get", "parameters": [ @@ -2495,13 +3725,16 @@ }, "/firework/v4/identifiers/identity_by_asset_data": { "post": { + "tags": [ + "private" + ], "summary": "Fetch Identifier By Asset Data", "operationId": "fetch_identifier_by_asset_data_identifiers_identity_by_asset_data_post", "requestBody": { "content": { "application/json": { "schema": { - "anyOf": [ + "oneOf": [ { "$ref": "#/components/schemas/CCBinData" }, @@ -2542,7 +3775,25 @@ "$ref": "#/components/schemas/NameData" } ], - "title": "Identifier Request" + "title": "Identifier Request", + "discriminator": { + "propertyName": "type", + "mapping": { + "bin": "#/components/schemas/CCBinData", + "ip": "#/components/schemas/IPData", + "brand": "#/components/schemas/BrandData", + "keyword": "#/components/schemas/KeywordData", + "azure_tenant": "#/components/schemas/AzureTenantData", + "domain": "#/components/schemas/DomainData", + "search_query": "#/components/schemas/SearchQueryData", + "github_repository": "#/components/schemas/GithubRepositoryData", + "credentials": "#/components/schemas/CredentialsData", + "email": "#/components/schemas/EmailData", + "username": "#/components/schemas/UsernameData", + "secret": "#/components/schemas/SecretData", + "name": "#/components/schemas/NameData" + } + } } } }, @@ -2574,6 +3825,9 @@ }, "/firework/v4/identifiers/identity_by_email": { "get": { + "tags": [ + "private" + ], "summary": "Fetch Identity By Email", "operationId": "fetch_identity_by_email_identifiers_identity_by_email_get", "parameters": [ @@ -2614,6 +3868,9 @@ }, "/firework/v4/identifiers/merge_identities": { "post": { + "tags": [ + "private" + ], "summary": "Merge Identity Identifiers", "operationId": "merge_identity_identifiers_identifiers_merge_identities_post", "requestBody": { @@ -2652,6 +3909,9 @@ }, "/firework/v4/identifiers/{identifier_id}/relations": { "get": { + "tags": [ + "private" + ], "summary": "Get Identifier Relations", "operationId": "get_identifier_relations_identifiers__identifier_id__relations_get", "parameters": [ @@ -2744,38 +4004,70 @@ } }, { - "name": "parent_group_id", + "name": "parent_group_id", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Parent Group Id" + } + }, + { + "name": "properties", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/IdentifierProperty" + } + }, + { + "type": "null" + } + ], + "title": "Properties" + } + }, + { + "name": "reachable_dates", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "integer" + "$ref": "#/components/schemas/Times" }, { "type": "null" } ], - "title": "Parent Group Id" + "title": "Reachable Dates" } }, { - "name": "properties", + "name": "resolves_dates", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/IdentifierProperty" - } + "$ref": "#/components/schemas/Times" }, { "type": "null" } ], - "title": "Properties" + "title": "Resolves Dates" } }, { @@ -2833,6 +4125,9 @@ }, "/firework/v4/identifiers/{identifier_id}/count": { "get": { + "tags": [ + "private" + ], "summary": "Get Identifier Count By Id", "operationId": "get_identifier_count_by_id_identifiers__identifier_id__count_get", "parameters": [ @@ -2959,6 +4254,38 @@ "title": "Properties" } }, + { + "name": "reachable_dates", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "$ref": "#/components/schemas/Times" + }, + { + "type": "null" + } + ], + "title": "Reachable Dates" + } + }, + { + "name": "resolves_dates", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "$ref": "#/components/schemas/Times" + }, + { + "type": "null" + } + ], + "title": "Resolves Dates" + } + }, { "name": "types", "in": "query", @@ -3014,6 +4341,9 @@ }, "/firework/v4/identifier-recommendations/": { "get": { + "tags": [ + "public" + ], "summary": "Fetch Identifier Recommendations", "operationId": "fetch_identifier_recommendations_identifier_recommendations__get", "parameters": [ @@ -3113,6 +4443,9 @@ }, "/firework/v4/identifier-recommendations/actions": { "post": { + "tags": [ + "public" + ], "summary": "Create Action For Identifier Recommendations", "operationId": "create_action_for_identifier_recommendations_identifier_recommendations_actions_post", "requestBody": { @@ -3149,6 +4482,9 @@ }, "/firework/v4/identities/{asset_uuid}/application_exposures": { "get": { + "tags": [ + "private" + ], "summary": "Get Application Exposures", "operationId": "get_application_exposures_identities__asset_uuid__application_exposures_get", "parameters": [ @@ -3187,6 +4523,38 @@ "title": "Time Zone" } }, + { + "name": "leak_types", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "enum": [ + "cookie", + "leaked_credential" + ], + "type": "string" + }, + "title": "Leak Types" + } + }, + { + "name": "cookie_expiration_status", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "$ref": "#/components/schemas/CookieExpirationStatus" + }, + { + "type": "null" + } + ], + "title": "Cookie Expiration Status" + } + }, { "name": "next", "in": "query", @@ -3244,38 +4612,6 @@ ], "title": "Keyword" } - }, - { - "name": "leak_types", - "in": "query", - "required": false, - "schema": { - "type": "array", - "items": { - "enum": [ - "cookie", - "leaked_credential" - ], - "type": "string" - }, - "title": "Leak Types" - } - }, - { - "name": "cookie_expiration_status", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/CookieExpirationStatus" - }, - { - "type": "null" - } - ], - "title": "Cookie Expiration Status" - } } ], "responses": { @@ -3304,6 +4640,9 @@ }, "/firework/v4/identities/{asset_uuid}/application_exposures_graph": { "get": { + "tags": [ + "private" + ], "summary": "Get Identity Application Exposures Graph", "operationId": "get_identity_application_exposures_graph_identities__asset_uuid__application_exposures_graph_get", "parameters": [ @@ -3374,6 +4713,41 @@ ], "title": "Cookie Expiration Status" } + }, + { + "name": "risk_scores", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/RiskScore" + } + }, + { + "type": "null" + } + ], + "title": "Risk Scores" + } + }, + { + "name": "max_application_nodes", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Max Application Nodes" + } } ], "responses": { @@ -3408,8 +4782,57 @@ } } }, + "/firework/v4/identities/{asset_uuid}/idp_services_exposed": { + "get": { + "tags": [ + "private" + ], + "summary": "Get Idp Services Exposed", + "operationId": "get_idp_services_exposed_identities__asset_uuid__idp_services_exposed_get", + "parameters": [ + { + "name": "asset_uuid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Asset Uuid" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TenantIntegrationType" + }, + "title": "Response Get Idp Services Exposed Identities Asset Uuid Idp Services Exposed Get" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, "/firework/v4/identities/{asset_uuid}/recent_activities/_count": { "get": { + "tags": [ + "private" + ], "summary": "Get Recent Activities Count", "operationId": "get_recent_activities_count_identities__asset_uuid__recent_activities__count_get", "parameters": [ @@ -3453,7 +4876,15 @@ "in": "query", "required": true, "schema": { - "$ref": "#/components/schemas/SearchType" + "enum": [ + "stealer_log", + "pii", + "illicit_networks", + "open_web", + "identity_profile_password" + ], + "type": "string", + "title": "Search Type" } } ], @@ -3483,6 +4914,9 @@ }, "/firework/v4/identities/{asset_uuid}/recent_activities/_search": { "get": { + "tags": [ + "private" + ], "summary": "Get Recent Activities Search", "operationId": "get_recent_activities_search_identities__asset_uuid__recent_activities__search_get", "parameters": [ @@ -3526,7 +4960,15 @@ "in": "query", "required": true, "schema": { - "$ref": "#/components/schemas/SearchType" + "enum": [ + "stealer_log", + "pii", + "illicit_networks", + "open_web", + "identity_profile_password" + ], + "type": "string", + "title": "Search Type" } }, { @@ -3560,7 +5002,7 @@ "in": "query", "required": false, "schema": { - "$ref": "#/components/schemas/firework__backend__api4__identities__recent_activities__models__SortType", + "$ref": "#/components/schemas/pyro__identity__profile__sort_type__SortType", "default": "creation_date" } }, @@ -3600,6 +5042,9 @@ }, "/firework/v4/identities/{asset_uuid}/timeline_by_search_type": { "get": { + "tags": [ + "private" + ], "summary": "Get Recent Activities Timeline By Search Type", "operationId": "get_recent_activities_timeline_by_search_type_identities__asset_uuid__timeline_by_search_type_get", "parameters": [ @@ -3674,6 +5119,9 @@ }, "/firework/v4/identities/{asset_uuid}/idp_user_data": { "get": { + "tags": [ + "private" + ], "summary": "Get Idp User Data", "operationId": "get_idp_user_data_identities__asset_uuid__idp_user_data_get", "parameters": [ @@ -3695,7 +5143,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/IdentityIdPUserData" + "$ref": "#/components/schemas/IdentityIdPUserPayload" }, "title": "Response Get Idp User Data Identities Asset Uuid Idp User Data Get" } @@ -3717,6 +5165,9 @@ }, "/firework/v4/logos/": { "post": { + "tags": [ + "private" + ], "summary": "Get Logos From Domains", "operationId": "get_logos_from_domains_logos__post", "requestBody": { @@ -3755,6 +5206,9 @@ }, "/firework/v4/reports/{report_id}": { "get": { + "tags": [ + "private" + ], "summary": "Get Report", "operationId": "get_report_reports__report_id__get", "parameters": [ @@ -3774,7 +5228,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/firework__backend__api4__reports__report_datamodels__ReportResponse" + "$ref": "#/components/schemas/pyro__firework__backend__api4__reports__report_datamodels__ReportResponse" } } } @@ -3792,6 +5246,9 @@ } }, "patch": { + "tags": [ + "private" + ], "summary": "Update Report", "operationId": "update_report_reports__report_id__patch", "parameters": [ @@ -3821,7 +5278,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/firework__backend__api4__reports__report_datamodels__ReportResponse" + "$ref": "#/components/schemas/pyro__firework__backend__api4__reports__report_datamodels__ReportResponse" } } } @@ -3839,6 +5296,9 @@ } }, "delete": { + "tags": [ + "private" + ], "summary": "Delete Report", "operationId": "delete_report_reports__report_id__delete", "parameters": [ @@ -3858,7 +5318,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/firework__backend__api4__reports__report_datamodels__ReportResponse" + "$ref": "#/components/schemas/pyro__firework__backend__api4__reports__report_datamodels__ReportResponse" } } } @@ -3878,6 +5338,9 @@ }, "/firework/v4/reports/": { "get": { + "tags": [ + "private" + ], "summary": "List Reports", "operationId": "list_reports_reports__get", "parameters": [ @@ -3936,7 +5399,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/pyro__reports__report_models__ReportType" + "$ref": "#/components/schemas/pyro__reports__report_types__ReportType" } }, { @@ -3973,7 +5436,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/firework__backend__api4__models__PaginatedResults_Report___1" + "$ref": "#/components/schemas/pyro__firework__backend__api4__models__PaginatedResults_Report___1" } } } @@ -3991,6 +5454,9 @@ } }, "post": { + "tags": [ + "private" + ], "summary": "Create Report", "operationId": "create_report_reports__post", "requestBody": { @@ -4009,7 +5475,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/firework__backend__api4__reports__report_datamodels__ReportResponse" + "$ref": "#/components/schemas/pyro__firework__backend__api4__reports__report_datamodels__ReportResponse" } } } @@ -4029,6 +5495,9 @@ }, "/firework/v4/reports/{report_id}/generate": { "post": { + "tags": [ + "private" + ], "summary": "Generate Report", "operationId": "generate_report_reports__report_id__generate_post", "parameters": [ @@ -4066,6 +5535,9 @@ }, "/firework/v4/reports/{report_id}/generate_csv": { "post": { + "tags": [ + "private" + ], "summary": "Generate Report Csv", "operationId": "generate_report_csv_reports__report_id__generate_csv_post", "parameters": [ @@ -4103,6 +5575,9 @@ }, "/firework/v4/reports/{report_id}/config": { "get": { + "tags": [ + "private" + ], "summary": "Get Report Config", "operationId": "get_report_config_reports__report_id__config_get", "parameters": [ @@ -4140,6 +5615,9 @@ } }, "patch": { + "tags": [ + "private" + ], "summary": "Update Report Config", "operationId": "update_report_config_reports__report_id__config_patch", "parameters": [ @@ -4189,6 +5667,9 @@ }, "/firework/v4/reports/{report_id}/download": { "get": { + "tags": [ + "private" + ], "summary": "Download Report", "operationId": "download_report_reports__report_id__download_get", "parameters": [ @@ -4241,6 +5722,9 @@ }, "/firework/v4/reports/{report_id}/sections/{uid}": { "get": { + "tags": [ + "private" + ], "summary": "Get Report Section", "operationId": "get_report_section_reports__report_id__sections__uid__get", "parameters": [ @@ -4288,6 +5772,9 @@ } }, "patch": { + "tags": [ + "private" + ], "summary": "Update Report Section", "operationId": "update_report_section_reports__report_id__sections__uid__patch", "parameters": [ @@ -4347,6 +5834,9 @@ }, "/firework/v4/reports/{report_id}/sections": { "get": { + "tags": [ + "private" + ], "summary": "List Report Sections", "operationId": "list_report_sections_reports__report_id__sections_get", "parameters": [ @@ -4414,6 +5904,9 @@ }, "/firework/v4/reports/{report_id}/archive": { "patch": { + "tags": [ + "private" + ], "summary": "Archive Report", "operationId": "archive_report_reports__report_id__archive_patch", "parameters": [ @@ -4433,7 +5926,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/firework__backend__api4__reports__report_datamodels__ReportResponse" + "$ref": "#/components/schemas/pyro__firework__backend__api4__reports__report_datamodels__ReportResponse" } } } @@ -4453,6 +5946,9 @@ }, "/firework/v4/reports/{report_id}/summarize/{uid}": { "patch": { + "tags": [ + "private" + ], "summary": "Generate Summary", "operationId": "generate_summary_reports__report_id__summarize__uid__patch", "parameters": [ @@ -4476,23 +5972,65 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportGenerateSummaryPayload" - } - } - } - }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReportGenerateSummaryPayload" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReportSectionResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/sources/{source}/summary": { + "get": { + "tags": [ + "private" + ], + "summary": "Get Source Summary", + "operationId": "get_source_summary_sources__source__summary_get", + "parameters": [ + { + "name": "source", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Source" + } + } + ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ReportSectionResponse" + "$ref": "#/components/schemas/SourceSummary" } } } @@ -4512,6 +6050,9 @@ }, "/firework/v4/integrations/tenant_integrations": { "get": { + "tags": [ + "private" + ], "summary": "Get Tenant Integrations", "operationId": "get_tenant_integrations_integrations_tenant_integrations_get", "parameters": [ @@ -4616,6 +6157,9 @@ } }, "post": { + "tags": [ + "private" + ], "summary": "Create Tenant Integration", "operationId": "create_tenant_integration_integrations_tenant_integrations_post", "requestBody": { @@ -4654,6 +6198,9 @@ }, "/firework/v4/integrations/tenant_integrations/{tenant_integration_id}": { "get": { + "tags": [ + "private" + ], "summary": "Get Tenant Integration", "operationId": "get_tenant_integration_integrations_tenant_integrations__tenant_integration_id__get", "parameters": [ @@ -4702,6 +6249,9 @@ } }, "put": { + "tags": [ + "private" + ], "summary": "Update Tenant Integration", "operationId": "update_tenant_integration_integrations_tenant_integrations__tenant_integration_id__put", "parameters": [ @@ -4748,6 +6298,9 @@ } }, "patch": { + "tags": [ + "private" + ], "summary": "Update Partial Tenant Integration", "operationId": "update_partial_tenant_integration_integrations_tenant_integrations__tenant_integration_id__patch", "parameters": [ @@ -4794,6 +6347,9 @@ } }, "delete": { + "tags": [ + "private" + ], "summary": "Delete Tenant Integration", "operationId": "delete_tenant_integration_integrations_tenant_integrations__tenant_integration_id__delete", "parameters": [ @@ -4832,6 +6388,9 @@ }, "/firework/v4/integrations/tenant_integrations/test": { "post": { + "tags": [ + "private" + ], "summary": "Test Tenant Integration", "operationId": "test_tenant_integration_integrations_tenant_integrations_test_post", "requestBody": { @@ -4870,6 +6429,9 @@ }, "/firework/v4/integrations/tenant_integrations/{tenant_integration_id}/idp/revoke_sessions": { "post": { + "tags": [ + "private" + ], "summary": "Revoke Sessions", "operationId": "revoke_sessions_integrations_tenant_integrations__tenant_integration_id__idp_revoke_sessions_post", "parameters": [ @@ -4913,6 +6475,9 @@ }, "/firework/v4/integrations/tenant_integrations/{tenant_integration_id}/idp/disable_account": { "post": { + "tags": [ + "private" + ], "summary": "Disable Account", "operationId": "disable_account_integrations_tenant_integrations__tenant_integration_id__idp_disable_account_post", "parameters": [ @@ -4956,6 +6521,9 @@ }, "/firework/v4/integrations/tenant_integrations/{tenant_integration_id}/idp/mark_user_as_compromised": { "post": { + "tags": [ + "private" + ], "summary": "Mark User As Compromised", "operationId": "mark_user_as_compromised_integrations_tenant_integrations__tenant_integration_id__idp_mark_user_as_compromised_post", "parameters": [ @@ -4999,6 +6567,9 @@ }, "/firework/v4/threat_flow/reports/": { "get": { + "tags": [ + "public" + ], "summary": "List Reports", "operationId": "list_reports_threat_flow_reports__get", "parameters": [ @@ -5063,7 +6634,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/firework__backend__api4__models__PaginatedResults_Report___2" + "$ref": "#/components/schemas/pyro__firework__backend__api4__models__PaginatedResults_Report___2" } } } @@ -5083,6 +6654,9 @@ }, "/firework/v4/threat_flow/reports/{report_id}": { "get": { + "tags": [ + "public" + ], "summary": "Get Report", "operationId": "get_report_threat_flow_reports__report_id__get", "parameters": [ @@ -5120,6 +6694,9 @@ } }, "delete": { + "tags": [ + "public" + ], "summary": "Delete Report", "operationId": "delete_report_threat_flow_reports__report_id__delete", "parameters": [ @@ -5157,6 +6734,9 @@ }, "/firework/v4/threat_flow/reports/{report_id}/download": { "get": { + "tags": [ + "public" + ], "summary": "Download Report", "operationId": "download_report_threat_flow_reports__report_id__download_get", "parameters": [ @@ -5203,6 +6783,9 @@ }, "/firework/v4/threat_flow/unit_summary/related_conversation": { "post": { + "tags": [ + "public" + ], "summary": "Get Related Conversation", "operationId": "get_related_conversation_threat_flow_unit_summary_related_conversation_post", "requestBody": { @@ -5241,6 +6824,9 @@ }, "/firework/v4/threat_flow/tags/": { "get": { + "tags": [ + "private" + ], "summary": "List Tags", "operationId": "list_tags_threat_flow_tags__get", "responses": { @@ -5269,6 +6855,9 @@ }, "/firework/v4/threat_flow/tenant_config/": { "get": { + "tags": [ + "private" + ], "summary": "Get And Create Tenant Config", "operationId": "get_and_create_tenant_config_threat_flow_tenant_config__get", "responses": { @@ -5295,6 +6884,9 @@ } }, "put": { + "tags": [ + "private" + ], "summary": "Create Or Update Tenant Config", "operationId": "create_or_update_tenant_config_threat_flow_tenant_config__put", "requestBody": { @@ -5333,6 +6925,9 @@ }, "/firework/v4/threat_flow/conversation_summary_requests/": { "put": { + "tags": [ + "private" + ], "summary": "Create Conversation Summary Request", "operationId": "create_conversation_summary_request_threat_flow_conversation_summary_requests__put", "requestBody": { @@ -5369,6 +6964,9 @@ } }, "get": { + "tags": [ + "private" + ], "summary": "List Conversation Summary Requests", "operationId": "list_conversation_summary_requests_threat_flow_conversation_summary_requests__get", "parameters": [ @@ -5434,6 +7032,9 @@ }, "/firework/v4/threat_flow/reports/requests": { "post": { + "tags": [ + "public" + ], "summary": "Create Report Request", "operationId": "create_report_request_threat_flow_reports_requests_post", "requestBody": { @@ -5472,6 +7073,9 @@ }, "/firework/v4/threat_flow/reports/requests/{request_info_id}": { "get": { + "tags": [ + "public" + ], "summary": "Get Report Request", "operationId": "get_report_request_threat_flow_reports_requests__request_info_id__get", "parameters": [ @@ -5512,6 +7116,9 @@ }, "/firework/v4/organizations/{organization_id}/users/{user_id}/tenants": { "post": { + "tags": [ + "private" + ], "summary": "Add User To Tenants", "operationId": "add_user_to_tenants_organizations__organization_id__users__user_id__tenants_post", "parameters": [ @@ -5568,6 +7175,9 @@ }, "/firework/v4/tenants/{tenant_id}/users": { "put": { + "tags": [ + "private" + ], "summary": "Add Tenant Users Put", "operationId": "add_tenant_users_put_tenants__tenant_id__users_put", "parameters": [ @@ -5613,6 +7223,9 @@ } }, "post": { + "tags": [ + "private" + ], "summary": "Create Tenant User", "operationId": "create_tenant_user_tenants__tenant_id__users_post", "requestBody": { @@ -5649,6 +7262,9 @@ }, "/firework/v4/tenants/{tenant_id}/users/{user_id}/disable": { "post": { + "tags": [ + "private" + ], "summary": "Disable Tenant Member", "operationId": "disable_tenant_member_tenants__tenant_id__users__user_id__disable_post", "parameters": [ @@ -5695,6 +7311,9 @@ }, "/firework/v4/tenants/{tenant_id}/users/{user_id}/enable": { "post": { + "tags": [ + "private" + ], "summary": "Enable Tenant Member", "operationId": "enable_tenant_member_tenants__tenant_id__users__user_id__enable_post", "parameters": [ @@ -5738,10 +7357,160 @@ } } } + }, + "/firework/v4/tenants/{tenant_id}": { + "put": { + "tags": [ + "private" + ], + "summary": "Update Tenant", + "operationId": "update_tenant_tenants__tenant_id__put", + "parameters": [ + { + "name": "tenant_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Tenant Id" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateTenantRequestBody" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantWithEnrichmentsPayload" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/cookies/tenant/_search_by_value": { + "post": { + "tags": [ + "private" + ], + "summary": "Tenant Cookies Search By Value", + "operationId": "tenant_cookies_search_by_value_cookies_tenant__search_by_value_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CookiesTenantSearchBody" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaginatedResults_ASTPCookiePayload_" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } } }, "components": { "schemas": { + "ASTPCookiePayload": { + "properties": { + "uuid": { + "type": "string", + "title": "Uuid" + }, + "domain": { + "type": "string", + "title": "Domain" + }, + "expires_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Expires At" + }, + "imported_at": { + "type": "string", + "format": "date-time", + "title": "Imported At" + }, + "name": { + "type": "string", + "title": "Name" + }, + "path": { + "type": "string", + "title": "Path" + }, + "value": { + "type": "string", + "title": "Value" + }, + "event_uid": { + "type": "string", + "title": "Event Uid" + } + }, + "type": "object", + "required": [ + "uuid", + "domain", + "expires_at", + "imported_at", + "name", + "path", + "value", + "event_uid" + ], + "title": "ASTPCookiePayload" + }, "ActivityModelName": { "type": "string", "enum": [ @@ -5774,6 +7543,7 @@ "forum_post", "forum_profile", "forum_topic", + "forum_thread_summary", "host", "leak", "leaked_credential", @@ -5791,7 +7561,6 @@ "source_code_secret", "stealer_log", "attachment/telegram", - "chat_message/telegram", "threat_flow_summary", "whois" ], @@ -5859,6 +7628,42 @@ ], "title": "ActivityUid" }, + "ActorAnalysisMetadataResponse": { + "properties": { + "summarized_at": { + "type": "string", + "format": "date-time", + "title": "Summarized At" + }, + "summarization_start_at": { + "type": "string", + "format": "date-time", + "title": "Summarization Start At" + }, + "summarization_end_at": { + "type": "string", + "format": "date-time", + "title": "Summarization End At" + }, + "events_summarized_count": { + "type": "integer", + "title": "Events Summarized Count" + }, + "total_events_count": { + "type": "integer", + "title": "Total Events Count" + } + }, + "type": "object", + "required": [ + "summarized_at", + "summarization_start_at", + "summarization_end_at", + "events_summarized_count", + "total_events_count" + ], + "title": "ActorAnalysisMetadataResponse" + }, "ActorCommunicationHandle": { "properties": { "platform": { @@ -5870,7 +7675,6 @@ "type": "string" }, "type": "array", - "uniqueItems": true, "title": "Handles" } }, @@ -5881,38 +7685,29 @@ ], "title": "ActorCommunicationHandle" }, - "ActorEvent": { + "ActorGraph": { "properties": { - "uid": { - "type": "string", - "title": "Uid" - }, - "actor_name": { - "type": "string", - "title": "Actor Name" - }, - "source_name": { - "type": "string", - "title": "Source Name" - }, - "date": { - "type": "string", - "format": "date-time", - "title": "Date" + "nodes": { + "items": { + "$ref": "#/components/schemas/BaseNode" + }, + "type": "array", + "title": "Nodes" }, - "risk_score": { - "$ref": "#/components/schemas/RiskScore" + "edges": { + "items": { + "$ref": "#/components/schemas/BaseEdge" + }, + "type": "array", + "title": "Edges" } }, "type": "object", "required": [ - "uid", - "actor_name", - "source_name", - "date", - "risk_score" + "nodes", + "edges" ], - "title": "ActorEvent" + "title": "ActorGraph" }, "ActorHeatmapData": { "properties": { @@ -5961,6 +7756,17 @@ ], "title": "Last Seen" }, + "total_events": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Total Events" + }, "is_vetted": { "type": "boolean", "title": "Is Vetted", @@ -5968,7 +7774,7 @@ }, "vetted_sources": { "items": { - "$ref": "#/components/schemas/ActorSource" + "$ref": "#/components/schemas/EnrichedSource" }, "type": "array", "title": "Vetted Sources", @@ -5976,57 +7782,15 @@ }, "active_sources": { "items": { - "$ref": "#/components/schemas/ActorSource" + "$ref": "#/components/schemas/EnrichedSource" }, "type": "array", "title": "Active Sources", - "default": [] - } - }, - "type": "object", - "title": "ActorMetadata" - }, - "ActorNodeDTO": { - "properties": { - "id": { - "type": "string", - "title": "Id" - }, - "name": { - "type": "string", - "title": "Name" - }, - "type": { - "type": "string", - "const": "actor", - "title": "Type", - "default": "actor" - } - }, - "type": "object", - "required": [ - "id", - "name" - ], - "title": "ActorNodeDTO" - }, - "ActorSource": { - "properties": { - "name": { - "type": "string", - "title": "Name" - }, - "title": { - "type": "string", - "title": "Title" + "default": [] } }, "type": "object", - "required": [ - "name", - "title" - ], - "title": "ActorSource" + "title": "ActorMetadata" }, "ActorSourceDistribution": { "properties": { @@ -6076,58 +7840,58 @@ ], "title": "Request Id" }, - "profile": { + "summarized_at": { "anyOf": [ { - "type": "string" - }, - { - "$ref": "#/components/schemas/ExecutiveSummaryOutput" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Profile" + "title": "Summarized At" }, - "heatmap": { + "error": { "anyOf": [ { "type": "string" }, - { - "$ref": "#/components/schemas/HeatmapAnalysisOutput" - }, { "type": "null" } ], - "title": "Heatmap" + "title": "Error" }, - "activity": { + "profile": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/ExecutiveSummaryOutput" }, { - "$ref": "#/components/schemas/GeneralActivityAnalysisOutput" + "type": "null" + } + ] + }, + "heatmap": { + "anyOf": [ + { + "$ref": "#/components/schemas/HeatmapAnalysisOutput" }, { "type": "null" } - ], - "title": "Activity" + ] }, - "error": { + "activity": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/GeneralActivityAnalysisOutput" }, { "type": "null" } - ], - "title": "Error" + ] } }, "type": "object", @@ -6194,53 +7958,50 @@ ], "title": "ActorTimelineEntry" }, - "ActorToActorEdgeDTO": { + "AddAllowedRestrictedTermRequest": { "properties": { - "source": { + "restricted_term_id": { "type": "string", - "title": "Source" + "minLength": 1, + "title": "Restricted Term Id" }, - "target": { - "type": "string", - "title": "Target" + "tenant_ids": { + "anyOf": [ + { + "items": { + "type": "integer" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Tenant Ids" }, "type": { - "type": "string", - "const": "related_to", - "title": "Type", - "default": "related_to" + "$ref": "#/components/schemas/AllowedRestrictedTermType" }, - "params": { - "$ref": "#/components/schemas/ActorToActorEdgeParams", - "description": "Additional parameters for the edge" + "reason": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Reason" } }, "type": "object", "required": [ - "source", - "target" + "restricted_term_id", + "tenant_ids", + "type", + "reason" ], - "title": "ActorToActorEdgeDTO" - }, - "ActorToActorEdgeParams": { - "properties": { - "forums": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true, - "title": "Forums", - "default": [] - }, - "number_of_interactions": { - "type": "integer", - "title": "Number Of Interactions", - "default": 1 - } - }, - "type": "object", - "title": "ActorToActorEdgeParams" + "title": "AddAllowedRestrictedTermRequest" }, "Alert": { "properties": { @@ -6392,9 +8153,6 @@ { "$ref": "#/components/schemas/AlertChannelSentinelParams" }, - { - "$ref": "#/components/schemas/AlertChannelCgcdParams" - }, { "$ref": "#/components/schemas/AlertChannelTeamsParams" }, @@ -6413,7 +8171,6 @@ "propertyName": "type", "mapping": { "azure_sentinel": "#/components/schemas/AlertChannelSentinelParams", - "cgcd": "#/components/schemas/AlertChannelCgcdParams", "channel": "#/components/schemas/AlertChannelChannelParams", "discord": "#/components/schemas/AlertChannelDiscordParams", "email": "#/components/schemas/AlertChannelEmailParams", @@ -6437,57 +8194,6 @@ ], "title": "AlertChannel" }, - "AlertChannelCgcdParams": { - "properties": { - "type": { - "type": "string", - "const": "cgcd", - "title": "Type" - }, - "emails": { - "type": "string", - "title": "Emails" - }, - "smtp_host": { - "type": "string", - "title": "Smtp Host" - }, - "smtp_port": { - "type": "integer", - "title": "Smtp Port" - }, - "smtp_username": { - "type": "string", - "title": "Smtp Username" - }, - "smtp_password": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Smtp Password" - }, - "cipher_password": { - "type": "string", - "title": "Cipher Password" - } - }, - "type": "object", - "required": [ - "type", - "emails", - "smtp_host", - "smtp_port", - "smtp_username", - "smtp_password", - "cipher_password" - ], - "title": "AlertChannelCgcdParams" - }, "AlertChannelChannelParams": { "properties": { "type": { @@ -6845,7 +8551,6 @@ "slack", "discord", "splunk", - "cgcd", "jira", "teams", "servicenow", @@ -6853,6 +8558,67 @@ ], "title": "AlertType" }, + "AllowedRestrictedTerm": { + "properties": { + "organization_id": { + "type": "integer", + "title": "Organization Id" + }, + "tenant_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Tenant Id" + }, + "restricted_term_id": { + "type": "string", + "title": "Restricted Term Id" + }, + "type": { + "$ref": "#/components/schemas/AllowedRestrictedTermType" + }, + "created_by_system": { + "type": "boolean", + "title": "Created By System" + }, + "reason": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Reason" + } + }, + "type": "object", + "required": [ + "organization_id", + "tenant_id", + "restricted_term_id", + "type", + "created_by_system", + "reason" + ], + "title": "AllowedRestrictedTerm" + }, + "AllowedRestrictedTermType": { + "type": "string", + "enum": [ + "restricted_term", + "noisy_term", + "domain", + "keyword" + ], + "title": "AllowedRestrictedTermType" + }, "ApiReport": { "properties": { "id": { @@ -6970,6 +8736,7 @@ "activity", "leak", "application", + "grouped_application", "idp_application" ], "title": "ApplicationExposureNodeType" @@ -7004,6 +8771,16 @@ "type": "array", "title": "Application Nodes" }, + "grouped_application_node": { + "anyOf": [ + { + "$ref": "#/components/schemas/GroupedApplicationNode" + }, + { + "type": "null" + } + ] + }, "idp_application_nodes": { "items": { "$ref": "#/components/schemas/IdPApplicationNode" @@ -7032,6 +8809,13 @@ "type": "array", "title": "Leak Application Edges" }, + "leak_grouped_application_edges": { + "items": { + "$ref": "#/components/schemas/ApplicationExposureEdge" + }, + "type": "array", + "title": "Leak Grouped Application Edges" + }, "application_idp_edges": { "items": { "$ref": "#/components/schemas/ApplicationExposureEdge" @@ -7046,10 +8830,12 @@ "activity_nodes", "leak_nodes", "application_nodes", + "grouped_application_node", "idp_application_nodes", "identity_activity_edges", "activity_leak_edges", "leak_application_edges", + "leak_grouped_application_edges", "application_idp_edges" ], "title": "ApplicationExposuresGraph" @@ -7166,7 +8952,8 @@ "type": { "type": "string", "const": "azure_tenant", - "title": "Type" + "title": "Type", + "default": "azure_tenant" }, "tenant_id": { "type": "string", @@ -7176,7 +8963,6 @@ }, "type": "object", "required": [ - "type", "tenant_id" ], "title": "AzureTenantData" @@ -7200,6 +8986,56 @@ ], "title": "AzureTenantQuery" }, + "BaseEdge": { + "properties": { + "source": { + "type": "string", + "title": "Source" + }, + "target": { + "type": "string", + "title": "Target" + }, + "type": { + "type": "string", + "title": "Type" + }, + "params": { + "title": "Params" + } + }, + "type": "object", + "required": [ + "source", + "target", + "type", + "params" + ], + "title": "BaseEdge" + }, + "BaseNode": { + "properties": { + "id": { + "type": "string", + "title": "Id" + }, + "name": { + "type": "string", + "title": "Name" + }, + "type": { + "type": "string", + "title": "Type" + } + }, + "type": "object", + "required": [ + "id", + "name", + "type" + ], + "title": "BaseNode" + }, "BinQuery": { "properties": { "type": { @@ -7224,7 +9060,8 @@ "type": { "type": "string", "const": "brand", - "title": "Type" + "title": "Type", + "default": "brand" }, "name": { "type": "string", @@ -7234,7 +9071,6 @@ }, "type": "object", "required": [ - "type", "name" ], "title": "BrandData" @@ -7275,7 +9111,8 @@ "group", "identifier_recommendation", "identifier_recommendation_group", - "credential" + "credential", + "tenant_integration" ], "title": "BulkActionTargetType" }, @@ -7341,7 +9178,7 @@ } ], "title": "Created After", - "default": "2025-08-07T14:41:01.845889Z" + "default": "2025-09-30T18:47:36.661595Z" }, "from": { "anyOf": [ @@ -7402,7 +9239,8 @@ "type": { "type": "string", "const": "bin", - "title": "Type" + "title": "Type", + "default": "bin" }, "bin": { "type": "string", @@ -7412,7 +9250,6 @@ }, "type": "object", "required": [ - "type", "bin" ], "title": "CCBinData" @@ -7589,15 +9426,44 @@ }, "tenant_id": { "type": "integer", - "title": "Tenant Id" + "title": "Tenant Id" + } + }, + "type": "object", + "required": [ + "domain", + "tenant_id" + ], + "title": "CookieMonitoringConfigurationItem" + }, + "CookiesTenantSearchBody": { + "properties": { + "value": { + "type": "string", + "title": "Value" + }, + "from_": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "From" + }, + "size": { + "type": "integer", + "title": "Size", + "default": 100 } }, "type": "object", "required": [ - "domain", - "tenant_id" + "value" ], - "title": "CookieMonitoringConfigurationItem" + "title": "CookiesTenantSearchBody" }, "CreateAlert": { "properties": { @@ -7682,9 +9548,6 @@ { "$ref": "#/components/schemas/AlertChannelSentinelParams" }, - { - "$ref": "#/components/schemas/AlertChannelCgcdParams" - }, { "$ref": "#/components/schemas/AlertChannelTeamsParams" }, @@ -7703,7 +9566,6 @@ "propertyName": "type", "mapping": { "azure_sentinel": "#/components/schemas/AlertChannelSentinelParams", - "cgcd": "#/components/schemas/AlertChannelCgcdParams", "channel": "#/components/schemas/AlertChannelChannelParams", "discord": "#/components/schemas/AlertChannelDiscordParams", "email": "#/components/schemas/AlertChannelEmailParams", @@ -8112,6 +9974,30 @@ "type": "object", "title": "CredentialFilters" }, + "CredentialValidation": { + "properties": { + "tenant_integration_id": { + "type": "string", + "format": "uuid", + "title": "Tenant Integration Id" + }, + "credential_hash": { + "type": "string", + "title": "Credential Hash" + }, + "status": { + "type": "string", + "title": "Status" + } + }, + "type": "object", + "required": [ + "tenant_integration_id", + "credential_hash", + "status" + ], + "title": "CredentialValidation" + }, "CredentialValidationReponse": { "properties": { "tenant_integration_id": { @@ -8177,7 +10063,9 @@ "match", "no_match", "unknown", - "failed" + "failed", + "not_found", + "mitigated" ], "title": "CredentialValidationStatus" }, @@ -8188,6 +10076,8 @@ "no_match", "unknown", "failed", + "not_found", + "mitigated", "pending" ], "title": "CredentialValidationStatusFilter" @@ -8197,7 +10087,8 @@ "type": { "type": "string", "const": "credentials", - "title": "Type" + "title": "Type", + "default": "credentials" }, "username": { "type": "string", @@ -8212,7 +10103,6 @@ }, "type": "object", "required": [ - "type", "username", "password" ], @@ -8356,7 +10246,8 @@ "type": { "type": "string", "const": "domain", - "title": "Type" + "title": "Type", + "default": "domain" }, "fqdn": { "type": "string", @@ -8366,7 +10257,6 @@ }, "type": "object", "required": [ - "type", "fqdn" ], "title": "DomainData" @@ -8390,59 +10280,69 @@ ], "title": "DomainQuery" }, - "DomainStatus": { - "type": "string", - "enum": [ - "found", - "resolves", - "reachable" - ], - "title": "DomainStatus" - }, - "EmailData": { + "DomainRestrictedTerm": { "properties": { "type": { "type": "string", - "const": "email", + "const": "domain", "title": "Type" }, - "email": { + "id": { "type": "string", - "format": "email", - "title": "Email" + "title": "Id" + }, + "term": { + "type": "string", + "title": "Term" + }, + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Description" } }, "type": "object", "required": [ "type", - "email" + "id", + "term" ], - "title": "EmailData" + "title": "DomainRestrictedTerm" + }, + "DomainStatus": { + "type": "string", + "enum": [ + "found", + "resolves", + "reachable" + ], + "title": "DomainStatus" }, - "EmailIdentityAttribute": { + "EmailData": { "properties": { "type": { "type": "string", "const": "email", - "title": "Type" + "title": "Type", + "default": "email" }, "email": { "type": "string", "format": "email", "title": "Email" - }, - "asset_uuid": { - "type": "string", - "title": "Asset Uuid" } }, "type": "object", "required": [ - "type", - "email", - "asset_uuid" + "email" ], - "title": "EmailIdentityAttribute" + "title": "EmailData" }, "EmailQuery": { "properties": { @@ -8534,6 +10434,9 @@ }, { "$ref": "#/components/schemas/CredentialFilters" + }, + { + "$ref": "#/components/schemas/TenantIntegrationFilters" } ], "discriminator": { @@ -8543,7 +10446,8 @@ "group": "#/components/schemas/GroupFilters", "identifier": "#/components/schemas/IdentifierFilters", "identifier_recommendation": "#/components/schemas/IdentifierRecommendationFilters", - "identifier_recommendation_group": "#/components/schemas/IdentifierRecommendationGroupFilters" + "identifier_recommendation_group": "#/components/schemas/IdentifierRecommendationGroupFilters", + "tenant_integration": "#/components/schemas/TenantIntegrationFilters" } } }, @@ -8852,6 +10756,34 @@ ], "title": "EnrichedReportSection" }, + "EnrichedSource": { + "properties": { + "name": { + "type": "string", + "title": "Name" + }, + "title": { + "type": "string", + "title": "Title" + } + }, + "type": "object", + "required": [ + "name", + "title" + ], + "title": "EnrichedSource" + }, + "EntraIDFeature": { + "type": "string", + "enum": [ + "automatically_validate_credentials", + "automatically_disable_accounts", + "automatically_mark_as_compromised", + "automatically_revoke_sessions" + ], + "title": "EntraIDFeature" + }, "EntraIDParams": { "properties": { "params_type": { @@ -8872,16 +10804,18 @@ "type": "string", "title": "Entra Tenant Id" }, - "enable_etl": { - "type": "boolean", - "title": "Enable Etl", - "default": false - }, "get_users_additional_params": { "anyOf": [ { "additionalProperties": { - "type": "string" + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ] }, "type": "object" }, @@ -8890,6 +10824,29 @@ } ], "title": "Get Users Additional Params" + }, + "group_id_for_user_sync": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Group Id For User Sync" + }, + "enable_full_idp_sync": { + "type": "boolean", + "title": "Enable Full Idp Sync", + "default": false + }, + "features": { + "items": { + "$ref": "#/components/schemas/EntraIDFeature" + }, + "type": "array", + "title": "Features" } }, "type": "object", @@ -8952,6 +10909,30 @@ ], "title": "EventActionsBody" }, + "EventInput": { + "properties": { + "uid": { + "type": "string", + "title": "Uid" + }, + "date": { + "type": "string", + "format": "date-time", + "title": "Date" + }, + "source_name": { + "type": "string", + "title": "Source Name" + } + }, + "type": "object", + "required": [ + "uid", + "date", + "source_name" + ], + "title": "EventInput" + }, "EventSecretsBody": { "properties": { "uid": { @@ -8979,59 +10960,183 @@ }, "type": "object", "required": [ - "uid" + "uid" + ], + "title": "EventSecretsBody" + }, + "ExecutiveSummaryOutput": { + "properties": { + "overview": { + "type": "string", + "title": "Overview", + "description": "Paragraph about the actor, including their username(s), presence on forum(s), total post count, and activity date range (use the 'First Post Date' and 'Last Post Date' fields); if the 'Last Post Date' is more than 90 days before 'Today's Date', mention that the actor has not been active for at least 90 days; if the actor is active on a single forum, avoid exclusive phrasing like \u201conly on\u201d or \u201cexclusively on\u201d and instead use neutral language such as \u201cis active on\u201d or \u201cgoes by the username on\u201d." + }, + "main_activities_and_motives": { + "type": "string", + "title": "Main Activities And Motives", + "description": "Paragraph about the main activies and motives of the actor. Base your assessment only on the 'General description of the threat actor's activity on the forum' section of the input." + }, + "latest_activity": { + "type": "string", + "title": "Latest Activity", + "description": "Short but specific and precise analysis of the threat actor's latest activity (highlighting any named moderators, admins, dates, or type of activity), (always translate everything in English, all examples or output should be always in English). Base your assessment only on the 'Latest activity from the threat actor' section of the input." + }, + "potential_associations_with_major_criminal_groups": { + "type": "string", + "title": "Potential Associations With Major Criminal Groups", + "description": "What groups the threat actor is associated with (if any). Base your assessment only on the 'General description of the threat actor's activity on the forum' section of the input." + }, + "linguistic_analysis": { + "type": "string", + "title": "Linguistic Analysis", + "description": "Identify all languages present in the 'Analysis of the threat actor\u2019s writing style' section, and do not omit any language even if it appears rarely (e.g., greetings, slang, or isolated phrases). For each detected language, provide its name, a proficiency rating from 1 to 10, a confidence rating from 1 to 10 (reduced if fewer than 100 posts are analyzed), and a short justification of 2\u20133 sentences. Present the results in a structured paragraph format, with one entry per language, and end with a brief summary sentence explaining whether the actor appears multilingual or primarily focused on one language." + }, + "likely_geographical_location": { + "type": "string", + "title": "Likely Geographical Location", + "description": "Identify the likely geography and give a confidence rating (1-10). When you have under 300 posts to analyse, mark confidence in your assessment as low and adjust the confidence score accordingly. Base your assessment only on the 'Description of the posting activity of the threat actor' section of the input." + }, + "potential_victims_shortlist": { + "type": "string", + "title": "Potential Victims Shortlist", + "description": "List up to ten victims, showing only their names (plus industry if relevant). Base your assessment only on the 'Description of potential victims mentioned in the threat actor's post' section of the input. Paragraph about the potential victim." + } + }, + "type": "object", + "required": [ + "overview", + "main_activities_and_motives", + "latest_activity", + "potential_associations_with_major_criminal_groups", + "linguistic_analysis", + "likely_geographical_location", + "potential_victims_shortlist" + ], + "title": "ExecutiveSummaryOutput" + }, + "FeatureFlagDefinition": { + "properties": { + "name": { + "type": "string", + "title": "Name" + }, + "description": { + "type": "string", + "title": "Description" + }, + "active": { + "type": "boolean", + "title": "Active" + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "Created At" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "title": "Updated At" + }, + "metrics": { + "anyOf": [ + { + "$ref": "#/components/schemas/FeatureFlagMetrics" + }, + { + "type": "null" + } + ] + }, + "strategies": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/FeatureFlagStrategy" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Strategies" + } + }, + "type": "object", + "required": [ + "name", + "description", + "active", + "created_at", + "updated_at" ], - "title": "EventSecretsBody" + "title": "FeatureFlagDefinition" }, - "ExecutiveSummaryOutput": { + "FeatureFlagMetrics": { "properties": { - "overview": { - "type": "string", - "title": "Overview", - "description": "Paragraph about the actor, including their username(s), presence on forum(s), total post count, and activity date range (use the 'First Post Date' and 'Last Post Date' fields); if the 'Last Post Date' is more than 90 days before 'Today's Date', mention that the actor has not been active for at least 90 days; if the actor is active on a single forum, avoid exclusive phrasing like \u201conly on\u201d or \u201cexclusively on\u201d and instead use neutral language such as \u201cis active on\u201d or \u201cgoes by the username on\u201d." + "user_count": { + "type": "integer", + "title": "User Count", + "default": 0 }, - "main_activities_and_motives": { - "type": "string", - "title": "Main Activities And Motives", - "description": "Paragraph about the main activies and motives of the actor. Base your assessment only on the 'General description of the threat actor's activity on the forum' section of the input." + "tenant_count": { + "type": "integer", + "title": "Tenant Count", + "default": 0 }, - "latest_activity": { - "type": "string", - "title": "Latest Activity", - "description": "Short but specific and precise analysis of the threat actor's latest activity (highlighting any named moderators, admins, dates, or type of activity), (always translate everything in English, all examples or output should be always in English). Base your assessment only on the 'Latest activity from the threat actor' section of the input." + "organization_count": { + "type": "integer", + "title": "Organization Count", + "default": 0 + } + }, + "type": "object", + "title": "FeatureFlagMetrics" + }, + "FeatureFlagStrategy": { + "properties": { + "id": { + "type": "integer", + "title": "Id" }, - "potential_associations_with_major_criminal_groups": { - "type": "string", - "title": "Potential Associations With Major Criminal Groups", - "description": "What groups the threat actor is associated with (if any). Base your assessment only on the 'General description of the threat actor's activity on the forum' section of the input." + "type": { + "$ref": "#/components/schemas/GitlabFeatureFlagStrategyName" }, - "linguistic_analysis": { - "type": "string", - "title": "Linguistic Analysis", - "description": "Identify each language present, then rate proficiency and confidence from 1-10. If fewer than 100 posts are analyzed, mark the confidence in your assessment as low and adjust the confidence score accordingly. Base your assessment only on the 'Analysis of the threat actor\u2019s writing style' section of the input." + "members": { + "items": { + "$ref": "#/components/schemas/StrategyMember" + }, + "type": "array", + "title": "Members" }, - "likely_geographical_location": { - "type": "string", - "title": "Likely Geographical Location", - "description": "Identify the likely geography and give a confidence rating (1-10). When you have under 300 posts to analyse, mark confidence in your assessment as low and adjust the confidence score accordingly. Base your assessment only on the 'Description of the posting activity of the threat actor' section of the input." + "scopes": { + "items": { + "$ref": "#/components/schemas/GitlabEnvironmentScope" + }, + "type": "array", + "title": "Scopes" }, - "potential_victims_shortlist": { - "type": "string", - "title": "Potential Victims Shortlist", - "description": "Up to three victims (name only). Base your assessment only on the 'Description of potential victims mentioned in the threat actor's post' section of the input. Paragraph about the potential victim." + "gitlab_user_list_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Gitlab User List Name" } }, "type": "object", "required": [ - "overview", - "main_activities_and_motives", - "latest_activity", - "potential_associations_with_major_criminal_groups", - "linguistic_analysis", - "likely_geographical_location", - "potential_victims_shortlist" + "id", + "type", + "members", + "scopes" ], - "title": "ExecutiveSummaryOutput" + "title": "FeatureFlagStrategy" }, "FeedConfiguration": { "properties": { @@ -9251,6 +11356,18 @@ "format": "date-time", "title": "Estimated Created At" }, + "matched_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Matched At" + }, "type": { "$ref": "#/components/schemas/ActivityModelName" }, @@ -9266,6 +11383,7 @@ "required": [ "uid", "estimated_created_at", + "matched_at", "type", "severity", "flare_url" @@ -9474,93 +11592,358 @@ } }, "type": "object", - "title": "FilterSeverities" + "title": "FilterSeverities" + }, + "FilterSeverity": { + "properties": { + "value": { + "type": "string", + "title": "Value" + }, + "label": { + "type": "string", + "title": "Label" + }, + "color": { + "type": "string", + "title": "Color" + } + }, + "type": "object", + "required": [ + "value", + "label", + "color" + ], + "title": "FilterSeverity" + }, + "FilterSourceType": { + "properties": { + "value": { + "type": "string", + "title": "Value" + }, + "label": { + "type": "string", + "title": "Label" + } + }, + "type": "object", + "required": [ + "value", + "label" + ], + "title": "FilterSourceType" + }, + "FilterSourceTypeCategory": { + "properties": { + "value": { + "type": "string", + "title": "Value" + }, + "label": { + "type": "string", + "title": "Label" + }, + "types": { + "items": { + "$ref": "#/components/schemas/FilterSourceType" + }, + "type": "array", + "title": "Types" + } + }, + "type": "object", + "required": [ + "value", + "label" + ], + "title": "FilterSourceTypeCategory" + }, + "FilterSourceTypes": { + "properties": { + "categories": { + "items": { + "$ref": "#/components/schemas/FilterSourceTypeCategory" + }, + "type": "array", + "title": "Categories" + } + }, + "type": "object", + "title": "FilterSourceTypes" + }, + "ForumThreadAnalysisMetadataResponse": { + "properties": { + "summarized_at": { + "type": "string", + "format": "date-time", + "title": "Summarized At" + }, + "summarization_start_at": { + "type": "string", + "format": "date-time", + "title": "Summarization Start At" + }, + "summarization_end_at": { + "type": "string", + "format": "date-time", + "title": "Summarization End At" + }, + "events_summarized_count": { + "type": "integer", + "title": "Events Summarized Count" + }, + "total_events_count": { + "type": "integer", + "title": "Total Events Count" + } + }, + "type": "object", + "required": [ + "summarized_at", + "summarization_start_at", + "summarization_end_at", + "events_summarized_count", + "total_events_count" + ], + "title": "ForumThreadAnalysisMetadataResponse" + }, + "ForumThreadIndicator": { + "properties": { + "type": { + "$ref": "#/components/schemas/IndicatorType" + }, + "value": { + "type": "string", + "title": "Value" + } + }, + "type": "object", + "required": [ + "type", + "value" + ], + "title": "ForumThreadIndicator" + }, + "ForumThreadMetadata": { + "properties": { + "first_seen": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "First Seen" + }, + "last_seen": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Seen" + }, + "total_events": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Total Events" + }, + "creator": { + "type": "string", + "title": "Creator" + }, + "category": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Category" + }, + "creation_date": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Creation Date" + }, + "source": { + "$ref": "#/components/schemas/EnrichedSource" + } + }, + "type": "object", + "required": [ + "creator", + "source" + ], + "title": "ForumThreadMetadata" }, - "FilterSeverity": { + "ForumThreadSummariesGenerationPayload": { "properties": { - "value": { - "type": "string", - "title": "Value" - }, - "label": { - "type": "string", - "title": "Label" - }, - "color": { + "source": { "type": "string", - "title": "Color" + "title": "Source" } }, "type": "object", "required": [ - "value", - "label", - "color" + "source" ], - "title": "FilterSeverity" + "title": "ForumThreadSummariesGenerationPayload" }, - "FilterSourceType": { + "ForumThreadSummariesResponse": { "properties": { - "value": { - "type": "string", - "title": "Value" + "request_id": { + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], + "title": "Request Id" }, - "label": { - "type": "string", - "title": "Label" + "summarized_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Summarized At" + }, + "error": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Error" + }, + "original_post_summary": { + "anyOf": [ + { + "$ref": "#/components/schemas/OriginalPostSummaryOutput" + }, + { + "type": "null" + } + ] + }, + "replies_summary": { + "anyOf": [ + { + "$ref": "#/components/schemas/RepliesSummaryOutput" + }, + { + "type": "null" + } + ] + }, + "top_actors_summary": { + "anyOf": [ + { + "$ref": "#/components/schemas/TopActorsSummaryOutput" + }, + { + "type": "null" + } + ] } }, "type": "object", "required": [ - "value", - "label" + "request_id" ], - "title": "FilterSourceType" + "title": "ForumThreadSummariesResponse" }, - "FilterSourceTypeCategory": { + "ForumThreadTimeline": { "properties": { - "value": { - "type": "string", - "title": "Value" - }, - "label": { - "type": "string", - "title": "Label" + "aggregate_by": { + "anyOf": [ + { + "$ref": "#/components/schemas/StatsAggregates" + }, + { + "type": "null" + } + ] }, - "types": { + "timeline": { "items": { - "$ref": "#/components/schemas/FilterSourceType" + "$ref": "#/components/schemas/ForumThreadTimelineEntry" }, "type": "array", - "title": "Types" + "title": "Timeline" + }, + "total_count": { + "type": "integer", + "title": "Total Count" } }, "type": "object", "required": [ - "value", - "label" + "timeline", + "total_count" ], - "title": "FilterSourceTypeCategory" + "title": "ForumThreadTimeline" }, - "FilterSourceTypes": { + "ForumThreadTimelineEntry": { "properties": { - "categories": { - "items": { - "$ref": "#/components/schemas/FilterSourceTypeCategory" - }, - "type": "array", - "title": "Categories" + "date": { + "type": "string", + "format": "date-time", + "title": "Date" + }, + "total_count": { + "type": "integer", + "title": "Total Count" } }, "type": "object", - "title": "FilterSourceTypes" + "required": [ + "date", + "total_count" + ], + "title": "ForumThreadTimelineEntry" }, "GeneralActivityAnalysisOutput": { "properties": { "overview": { "type": "string", "title": "Overview", - "description": "Start with the most impactful criminal activity. Mention tools, exploits, pricing, communication style, unique skills when available. Cite posts and dates that support your statements (always translate them in English)." + "description": "Begin by describing the actor\u2019s most impactful criminal activity. Then provide an overview of the general nature of the actor\u2019s activity, including up to 20 short, unique, and relevant examples in reverse chronological order (e.g., what is offered, at what price, on which date, and on which forum/source). For each example, cite the corresponding post, date, and source, translating all content into English. When applicable, include details on tools, exploits, pricing, communication style, and any unique skills demonstrated." }, "variation_of_activity_over_time": { "type": "string", @@ -9593,12 +11976,29 @@ ], "title": "GeneralActivityAnalysisOutput" }, + "GetAllowedRestrictedTermsResponse": { + "properties": { + "allowed_restricted_terms": { + "items": { + "$ref": "#/components/schemas/AllowedRestrictedTerm" + }, + "type": "array", + "title": "Allowed Restricted Terms" + } + }, + "type": "object", + "required": [ + "allowed_restricted_terms" + ], + "title": "GetAllowedRestrictedTermsResponse" + }, "GithubRepositoryData": { "properties": { "type": { "type": "string", "const": "github_repository", - "title": "Type" + "title": "Type", + "default": "github_repository" }, "repo_name": { "type": "string", @@ -9613,7 +12013,6 @@ }, "type": "object", "required": [ - "type", "repo_name", "repo_owner" ], @@ -9643,6 +12042,27 @@ ], "title": "GithubRepositoryQuery" }, + "GitlabEnvironmentScope": { + "type": "string", + "enum": [ + "*", + "development", + "staging", + "production" + ], + "title": "GitlabEnvironmentScope" + }, + "GitlabFeatureFlagStrategyName": { + "type": "string", + "enum": [ + "default", + "flexibleRollout", + "gradualRolloutUserId", + "userWithId", + "gitlabUserList" + ], + "title": "GitlabFeatureFlagStrategyName" + }, "GlobalSearchRequestBody": { "properties": { "query": { @@ -9745,29 +12165,12 @@ ], "title": "GlobalSearchRequestBody" }, - "GraphDTO": { - "properties": { - "nodes": { - "items": { - "$ref": "#/components/schemas/ActorNodeDTO" - }, - "type": "array", - "title": "Nodes" - }, - "edges": { - "items": { - "$ref": "#/components/schemas/ActorToActorEdgeDTO" - }, - "type": "array", - "title": "Edges" - } - }, - "type": "object", - "required": [ - "nodes", - "edges" + "GroupByType": { + "type": "string", + "enum": [ + "relationship_nature" ], - "title": "GraphDTO" + "title": "GroupByType" }, "GroupFilters": { "properties": { @@ -9824,6 +12227,26 @@ ], "title": "Properties" }, + "reachable_dates": { + "anyOf": [ + { + "$ref": "#/components/schemas/Times" + }, + { + "type": "null" + } + ] + }, + "resolves_dates": { + "anyOf": [ + { + "$ref": "#/components/schemas/Times" + }, + { + "type": "null" + } + ] + }, "source_group": { "anyOf": [ { @@ -9834,42 +12257,100 @@ } ] }, - "group_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "string", - "const": "NO_GROUP" - }, - { - "type": "null" - } - ], - "title": "Group Id", - "default": "NO_GROUP" + "group_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "string", + "const": "NO_GROUP" + }, + { + "type": "null" + } + ], + "title": "Group Id", + "default": "NO_GROUP" + }, + "parent_identifier_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Parent Identifier Id" + }, + "type": { + "type": "string", + "const": "group", + "title": "Type", + "default": "group" + } + }, + "type": "object", + "title": "GroupFilters" + }, + "GroupedApplicationNode": { + "properties": { + "activity_types": { + "items": { + "type": "string", + "enum": [ + "stealer_log", + "leak" + ] + }, + "type": "array", + "uniqueItems": true, + "title": "Activity Types" + }, + "leak_types": { + "items": { + "type": "string", + "enum": [ + "cookie", + "leaked_credential" + ] + }, + "type": "array", + "uniqueItems": true, + "title": "Leak Types" + }, + "top_domains": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Top Domains" }, - "parent_identifier_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Parent Identifier Id" + "count": { + "type": "integer", + "title": "Count" }, "type": { + "$ref": "#/components/schemas/ApplicationExposureNodeType", + "readOnly": true + }, + "id": { "type": "string", - "const": "group", - "title": "Type", - "default": "group" + "title": "Id", + "readOnly": true } }, "type": "object", - "title": "GroupFilters" + "required": [ + "activity_types", + "leak_types", + "top_domains", + "count", + "type", + "id" + ], + "title": "GroupedApplicationNode" }, "HTTPValidationError": { "properties": { @@ -9889,12 +12370,12 @@ "general_analysis": { "type": "string", "title": "General Analysis", - "description": "The first paragraph contains the years of activities, number of total posts and on which forums as well as if there are any gaps or seasonal trends." + "description": "Provide an overview of the actor\u2019s activity, including: the total number of posts and the forums where they were made, the years or range of years the actor was active, and any gaps or seasonal trends in posting activity." }, "precise_analysis": { "type": "string", "title": "Precise Analysis", - "description": "The second paragraph should first outline the actor's peak posting hours and the identified sleep window, explain how these windows align with the chosen time-zone, state the most likely location with confidence and example countries, and then note which days show the highest and lowest overall activity." + "description": "Outline the actor\u2019s hourly activity and inactivity periods, explain how these align with the chosen UTC time zone, and indicate the most likely location with a confidence level and three example countries (If the dataset is fewer than 300 posts, mark confidence as low and adjust the score accordingly)." } }, "type": "object", @@ -9938,7 +12419,8 @@ "type": { "type": "string", "const": "ip", - "title": "Type" + "title": "Type", + "default": "ip" }, "ip": { "type": "string", @@ -9948,7 +12430,6 @@ }, "type": "object", "required": [ - "type", "ip" ], "title": "IPData" @@ -10011,6 +12492,14 @@ ], "title": "IdPApplicationNode" }, + "IdPUserAccountType": { + "type": "string", + "enum": [ + "Member", + "Guest" + ], + "title": "IdPUserAccountType" + }, "Identifier": { "properties": { "id": { @@ -10039,7 +12528,7 @@ "title": "Asset Uuid" }, "data": { - "anyOf": [ + "oneOf": [ { "$ref": "#/components/schemas/CCBinData" }, @@ -10083,7 +12572,26 @@ "$ref": "#/components/schemas/IdentityData" } ], - "title": "Data" + "title": "Data", + "discriminator": { + "propertyName": "type", + "mapping": { + "azure_tenant": "#/components/schemas/AzureTenantData", + "bin": "#/components/schemas/CCBinData", + "brand": "#/components/schemas/BrandData", + "credentials": "#/components/schemas/CredentialsData", + "domain": "#/components/schemas/DomainData", + "email": "#/components/schemas/EmailData", + "github_repository": "#/components/schemas/GithubRepositoryData", + "identity": "#/components/schemas/IdentityData", + "ip": "#/components/schemas/IPData", + "keyword": "#/components/schemas/KeywordData", + "name": "#/components/schemas/NameData", + "search_query": "#/components/schemas/SearchQueryData", + "secret": "#/components/schemas/SecretData", + "username": "#/components/schemas/UsernameData" + } + } }, "collection": { "anyOf": [ @@ -10345,6 +12853,26 @@ ], "title": "Properties" }, + "reachable_dates": { + "anyOf": [ + { + "$ref": "#/components/schemas/Times" + }, + { + "type": "null" + } + ] + }, + "resolves_dates": { + "anyOf": [ + { + "$ref": "#/components/schemas/Times" + }, + { + "type": "null" + } + ] + }, "source_group": { "anyOf": [ { @@ -10803,7 +13331,6 @@ "enum": [ "USER", "SYSTEM_RELATION", - "DEMO", "SELF_ONBOARDING" ], "title": "IdentifierSource" @@ -10851,6 +13378,16 @@ "type": "null" } ] + }, + "validation_status": { + "anyOf": [ + { + "$ref": "#/components/schemas/IdentifierValidationStatus" + }, + { + "type": "null" + } + ] } }, "type": "object", @@ -10859,7 +13396,8 @@ "data_updated_at", "event_count", "usage_count", - "rate_limits" + "rate_limits", + "validation_status" ], "title": "IdentifierState" }, @@ -10882,12 +13420,56 @@ ], "title": "IdentifierType" }, + "IdentifierValidationStatus": { + "type": "string", + "enum": [ + "FIRST_PARTY" + ], + "title": "IdentifierValidationStatus" + }, + "IdentityAttribute": { + "properties": { + "asset_uuid": { + "type": "string", + "title": "Asset Uuid" + }, + "data": { + "oneOf": [ + { + "$ref": "#/components/schemas/EmailData" + }, + { + "$ref": "#/components/schemas/UsernameData" + }, + { + "$ref": "#/components/schemas/NameData" + } + ], + "title": "Data", + "discriminator": { + "propertyName": "type", + "mapping": { + "email": "#/components/schemas/EmailData", + "name": "#/components/schemas/NameData", + "username": "#/components/schemas/UsernameData" + } + } + } + }, + "type": "object", + "required": [ + "asset_uuid", + "data" + ], + "title": "IdentityAttribute" + }, "IdentityData": { "properties": { "type": { "type": "string", "const": "identity", - "title": "Type" + "title": "Type", + "default": "identity" }, "uuid": { "type": "string", @@ -10897,7 +13479,6 @@ }, "type": "object", "required": [ - "type", "uuid" ], "title": "IdentityData" @@ -10944,18 +13525,68 @@ ], "title": "IdentityDataRequestBody" }, - "IdentityIdPUserApplication": { + "IdentityIdPUserPayload": { "properties": { "uuid": { "type": "string", "format": "uuid", "title": "Uuid" }, + "email": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Email" + }, + "username": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Username" + }, + "title": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Title" + }, "display_name": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Display Name" }, - "domain_name": { + "account_type": { + "anyOf": [ + { + "$ref": "#/components/schemas/IdPUserAccountType" + }, + { + "type": "null" + } + ] + }, + "department": { "anyOf": [ { "type": "string" @@ -10964,54 +13595,88 @@ "type": "null" } ], - "title": "Domain Name" + "title": "Department" }, - "labels": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Labels" - } - }, - "type": "object", - "required": [ - "uuid", - "display_name", - "domain_name", - "labels" - ], - "title": "IdentityIdPUserApplication" - }, - "IdentityIdPUserData": { - "properties": { - "uuid": { - "type": "string", - "format": "uuid", - "title": "Uuid" + "is_on_premises_sync_enabled": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Is On Premises Sync Enabled" }, - "email": { - "type": "string", - "title": "Email" + "password_changed_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Password Changed At" }, - "username": { - "type": "string", - "title": "Username" + "refresh_tokens_valid_from": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Refresh Tokens Valid From" + }, + "sign_in_sessions_valid_from": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Sign In Sessions Valid From" }, - "tenant_integration_type": { - "$ref": "#/components/schemas/TenantIntegrationType" + "last_synced_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Synced At" }, - "tenant_integration_id": { - "type": "string", - "format": "uuid", - "title": "Tenant Integration Id" + "password_policies": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Password Policies" }, - "applications": { - "items": { - "$ref": "#/components/schemas/IdentityIdPUserApplication" - }, - "type": "array", - "title": "Applications" + "is_active": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Is Active" } }, "type": "object", @@ -11019,11 +13684,19 @@ "uuid", "email", "username", - "tenant_integration_type", - "tenant_integration_id", - "applications" - ], - "title": "IdentityIdPUserData" + "title", + "display_name", + "account_type", + "department", + "is_on_premises_sync_enabled", + "password_changed_at", + "refresh_tokens_valid_from", + "sign_in_sessions_valid_from", + "last_synced_at", + "password_policies", + "is_active" + ], + "title": "IdentityIdPUserPayload" }, "IdentityIdentifierEntity": { "properties": { @@ -11032,17 +13705,7 @@ }, "attributes": { "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/EmailIdentityAttribute" - }, - { - "$ref": "#/components/schemas/UsernameIdentityAttribute" - }, - { - "$ref": "#/components/schemas/NameIdentityAttribute" - } - ] + "$ref": "#/components/schemas/IdentityAttribute" }, "type": "array", "title": "Attributes" @@ -11103,6 +13766,13 @@ ], "title": "IdentityNode" }, + "IndicatorType": { + "type": "string", + "enum": [ + "URL" + ], + "title": "IndicatorType" + }, "IpQuery": { "properties": { "type": { @@ -11127,7 +13797,8 @@ "type": { "type": "string", "const": "keyword", - "title": "Type" + "title": "Type", + "default": "keyword" }, "keyword": { "type": "string", @@ -11137,7 +13808,6 @@ }, "type": "object", "required": [ - "type", "keyword" ], "title": "KeywordData" @@ -11161,6 +13831,41 @@ ], "title": "KeywordQuery" }, + "KeywordRestrictedTerm": { + "properties": { + "type": { + "type": "string", + "const": "keyword", + "title": "Type" + }, + "id": { + "type": "string", + "title": "Id" + }, + "term": { + "type": "string", + "title": "Term" + }, + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Description" + } + }, + "type": "object", + "required": [ + "type", + "id", + "term" + ], + "title": "KeywordRestrictedTerm" + }, "Language": { "type": "string", "enum": [ @@ -11215,6 +13920,38 @@ ], "title": "LeakNode" }, + "ListFeatureFlagsResponse": { + "properties": { + "feature_flags": { + "items": { + "$ref": "#/components/schemas/FeatureFlagDefinition" + }, + "type": "array", + "title": "Feature Flags" + }, + "total": { + "type": "integer", + "title": "Total" + }, + "next_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Next Page" + } + }, + "type": "object", + "required": [ + "feature_flags", + "total" + ], + "title": "ListFeatureFlagsResponse" + }, "LogoRequestBody": { "properties": { "domains": { @@ -11301,7 +14038,8 @@ "type": { "type": "string", "const": "name", - "title": "Type" + "title": "Type", + "default": "name" }, "first_name": { "type": "string", @@ -11318,47 +14056,12 @@ }, "type": "object", "required": [ - "type", "first_name", "last_name", "is_strict" ], "title": "NameData" }, - "NameIdentityAttribute": { - "properties": { - "type": { - "type": "string", - "const": "name", - "title": "Type" - }, - "first_name": { - "type": "string", - "title": "First Name" - }, - "last_name": { - "type": "string", - "title": "Last Name" - }, - "is_strict": { - "type": "boolean", - "title": "Is Strict" - }, - "asset_uuid": { - "type": "string", - "title": "Asset Uuid" - } - }, - "type": "object", - "required": [ - "type", - "first_name", - "last_name", - "is_strict", - "asset_uuid" - ], - "title": "NameIdentityAttribute" - }, "NameQuery": { "properties": { "type": { @@ -11396,6 +14099,26 @@ ], "title": "OrderType" }, + "OriginalPostSummaryOutput": { + "properties": { + "overview": { + "type": "string", + "title": "Overview", + "description": "Single paragraph providing an analytical summary of the post." + }, + "actor_intent": { + "type": "string", + "title": "Actor Intent", + "description": "Single paragraph summarizing the actor's intent." + } + }, + "type": "object", + "required": [ + "overview", + "actor_intent" + ], + "title": "OriginalPostSummaryOutput" + }, "OtherSectionType": { "type": "string", "enum": [ @@ -11457,6 +14180,34 @@ ], "title": "PaginatedResult[int]" }, + "PaginatedResults_ASTPCookiePayload_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/ASTPCookiePayload" + }, + "type": "array", + "title": "Items" + }, + "next": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[ASTPCookiePayload]" + }, "PaginatedResults_Alert_": { "properties": { "items": { @@ -12016,75 +14767,89 @@ ], "title": "PasswordPolicyOperator" }, - "QueryStringQuery": { + "PresetRestrictedTerm": { "properties": { "type": { "type": "string", - "const": "query_string", + "const": "preset", "title": "Type" }, - "query_string": { - "type": "string", - "title": "Query String" - } - }, - "type": "object", - "required": [ - "type", - "query_string" - ], - "title": "QueryStringQuery" - }, - "RecentActivityCookies": { - "properties": { - "type": { - "$ref": "#/components/schemas/SearchType" - }, - "uid": { - "type": "string", - "title": "Uid" - }, - "host_key": { + "id": { "type": "string", - "title": "Host Key" + "title": "Id" }, - "leaked_date": { + "display_name": { "type": "string", - "format": "date-time", - "title": "Leaked Date" + "title": "Display Name" }, - "expiration_date": { + "description": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Expiration Date" + "title": "Description" }, - "name": { + "terms": { + "items": { + "$ref": "#/components/schemas/PresetRestrictedTermItem" + }, + "type": "array", + "title": "Terms" + } + }, + "type": "object", + "required": [ + "type", + "id", + "display_name", + "terms" + ], + "title": "PresetRestrictedTerm" + }, + "PresetRestrictedTermItem": { + "properties": { + "type": { "type": "string", - "title": "Name" + "enum": [ + "keyword", + "domain" + ], + "title": "Type" }, - "value": { + "term": { "type": "string", - "title": "Value" + "title": "Term" } }, "type": "object", "required": [ "type", - "uid", - "host_key", - "leaked_date", - "expiration_date", - "name", - "value" + "term" + ], + "title": "PresetRestrictedTermItem" + }, + "QueryStringQuery": { + "properties": { + "type": { + "type": "string", + "const": "query_string", + "title": "Type" + }, + "query_string": { + "type": "string", + "title": "Query String" + } + }, + "type": "object", + "required": [ + "type", + "query_string" ], - "title": "RecentActivityCookies" + "title": "QueryStringQuery" }, "RecentActivityCountResponse": { "properties": { @@ -12137,7 +14902,7 @@ ], "title": "RecentActivityExposedPII" }, - "RecentActivityLeakedCredential": { + "RecentActivityOpenWebIllicitNetwork": { "properties": { "type": { "$ref": "#/components/schemas/SearchType" @@ -12155,9 +14920,9 @@ "type": "string", "title": "Attribute" }, - "password": { + "event_type": { "type": "string", - "title": "Password" + "title": "Event Type" }, "source_name": { "type": "string", @@ -12170,68 +14935,72 @@ "uid", "creation_date", "attribute", - "password", + "event_type", "source_name" ], - "title": "RecentActivityLeakedCredential" + "title": "RecentActivityOpenWebIllicitNetwork" }, - "RecentActivityOpenWebIllicitNetwork": { + "RecentActivityPassword": { "properties": { "type": { - "$ref": "#/components/schemas/SearchType" - }, - "uid": { "type": "string", - "title": "Uid" + "title": "Type", + "default": "identity_profile_password" }, - "creation_date": { + "last_seen": { "type": "string", "format": "date-time", - "title": "Creation Date" + "title": "Last Seen" }, "attribute": { "type": "string", "title": "Attribute" }, - "event_type": { + "password": { "type": "string", - "title": "Event Type" + "title": "Password" }, - "source_name": { - "type": "string", - "title": "Source Name" + "source_count": { + "type": "integer", + "title": "Source Count" + }, + "validation": { + "anyOf": [ + { + "$ref": "#/components/schemas/CredentialValidation" + }, + { + "type": "null" + } + ] } }, "type": "object", "required": [ - "type", - "uid", - "creation_date", + "last_seen", "attribute", - "event_type", - "source_name" + "password", + "source_count", + "validation" ], - "title": "RecentActivityOpenWebIllicitNetwork" + "title": "RecentActivityPassword" }, "RecentActivityResponse": { "properties": { "items": { "items": { "anyOf": [ - { - "$ref": "#/components/schemas/RecentActivityLeakedCredential" - }, { "$ref": "#/components/schemas/RecentActivityStealerLog" }, - { - "$ref": "#/components/schemas/RecentActivityCookies" - }, { "$ref": "#/components/schemas/RecentActivityExposedPII" }, { "$ref": "#/components/schemas/RecentActivityOpenWebIllicitNetwork" + }, + { + "$ref": "#/components/schemas/RecentActivityPassword" } ] }, @@ -12410,6 +15179,26 @@ ], "title": "RelatedConversationResponse" }, + "RepliesSummaryOutput": { + "properties": { + "overview": { + "type": "string", + "title": "Overview", + "description": "Single paragraph summarizing the replies." + }, + "sentiment_analysis": { + "type": "string", + "title": "Sentiment Analysis", + "description": "Single paragraph analyzing the sentiment in the replies." + } + }, + "type": "object", + "required": [ + "overview", + "sentiment_analysis" + ], + "title": "RepliesSummaryOutput" + }, "ReportAnalyticSectionType": { "type": "string", "enum": [ @@ -12570,6 +15359,28 @@ ], "title": "ReportDownloadFormat" }, + "ReportEventType": { + "type": "string", + "enum": [ + "blog_post", + "bucket", + "chat", + "domain", + "financial_data", + "forum_post", + "google", + "host", + "infected_device", + "leaked_credential", + "listing", + "paste", + "profile", + "ransom_leak", + "source_code", + "web_account" + ], + "title": "ReportEventType" + }, "ReportFeedConfig": { "properties": { "report_id": { @@ -12611,19 +15422,21 @@ } ] }, - "search_types": { + "report_event_types": { "items": { - "$ref": "#/components/schemas/SearchType" + "$ref": "#/components/schemas/ReportEventType" }, "type": "array", - "title": "Search Types" + "uniqueItems": true, + "title": "Report Event Types" }, - "available_search_types": { + "available_report_event_types": { "items": { - "$ref": "#/components/schemas/SearchType" + "$ref": "#/components/schemas/ReportEventType" }, "type": "array", - "title": "Available Search Types" + "uniqueItems": true, + "title": "Available Report Event Types" }, "risks": { "items": { @@ -12668,8 +15481,8 @@ "feed_id", "feed_definition", "identifier_scope", - "search_types", - "available_search_types", + "report_event_types", + "available_report_event_types", "risks", "time_range_from", "time_range_to", @@ -12910,7 +15723,7 @@ "report_type": { "anyOf": [ { - "$ref": "#/components/schemas/pyro__reports__report_models__ReportType" + "$ref": "#/components/schemas/pyro__reports__report_types__ReportType" }, { "type": "null" @@ -12930,6 +15743,50 @@ ], "title": "RequestStatus" }, + "RestrictedTerms": { + "properties": { + "restricted": { + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/DomainRestrictedTerm" + }, + { + "$ref": "#/components/schemas/KeywordRestrictedTerm" + }, + { + "$ref": "#/components/schemas/PresetRestrictedTerm" + } + ] + }, + "type": "array", + "title": "Restricted" + }, + "noisy": { + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/DomainRestrictedTerm" + }, + { + "$ref": "#/components/schemas/KeywordRestrictedTerm" + }, + { + "$ref": "#/components/schemas/PresetRestrictedTerm" + } + ] + }, + "type": "array", + "title": "Noisy" + } + }, + "type": "object", + "required": [ + "restricted", + "noisy" + ], + "title": "RestrictedTerms" + }, "RevokeSessionsPayload": { "properties": { "credential_hash": { @@ -12954,12 +15811,142 @@ ], "title": "RiskScore" }, + "Scope": { + "type": "string", + "enum": [ + "authenticated", + "authenticated-sso", + "authenticated-mfa", + "firework", + "leaksdb", + "astp-credentials", + "astp-cookies", + "astp-show-passwords", + "ioc-feeds", + "do-not-track", + "admin", + "ratelimited", + "apikey", + "bypass-mfa", + "search-unrestricted", + "private-endpoints" + ], + "title": "Scope" + }, + "SearchQueryAllowedRequest": { + "properties": { + "search_query": { + "type": "string", + "title": "Search Query" + }, + "organization_id": { + "type": "integer", + "title": "Organization Id" + }, + "tenant_id": { + "type": "integer", + "title": "Tenant Id" + }, + "user_id": { + "type": "integer", + "title": "User Id" + }, + "include_restricted_domains": { + "type": "boolean", + "title": "Include Restricted Domains" + }, + "include_noisy_domains": { + "type": "boolean", + "title": "Include Noisy Domains" + }, + "scopes": { + "items": { + "$ref": "#/components/schemas/Scope" + }, + "type": "array", + "title": "Scopes" + }, + "ip": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Ip" + }, + "user_agent": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "User Agent" + }, + "flare_referer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Flare Referer" + } + }, + "type": "object", + "required": [ + "search_query", + "organization_id", + "tenant_id", + "user_id", + "include_restricted_domains", + "include_noisy_domains", + "scopes", + "ip", + "user_agent", + "flare_referer" + ], + "title": "SearchQueryAllowedRequest" + }, + "SearchQueryAllowedResponse": { + "properties": { + "is_allowed": { + "type": "boolean", + "title": "Is Allowed" + }, + "restricted_term": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Restricted Term" + } + }, + "type": "object", + "required": [ + "is_allowed", + "restricted_term" + ], + "title": "SearchQueryAllowedResponse" + }, "SearchQueryData": { "properties": { "type": { "type": "string", "const": "search_query", - "title": "Type" + "title": "Type", + "default": "search_query" }, "search_query": { "type": "string", @@ -12969,10 +15956,94 @@ }, "type": "object", "required": [ - "type", - "search_query" + "search_query" + ], + "title": "SearchQueryData" + }, + "SearchTermsAllowedRequest": { + "properties": { + "search_terms": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Search Terms" + }, + "organization_id": { + "type": "integer", + "title": "Organization Id" + }, + "tenant_id": { + "type": "integer", + "title": "Tenant Id" + }, + "user_id": { + "type": "integer", + "title": "User Id" + }, + "include_restricted_domains": { + "type": "boolean", + "title": "Include Restricted Domains" + }, + "include_noisy_domains": { + "type": "boolean", + "title": "Include Noisy Domains" + }, + "scopes": { + "items": { + "$ref": "#/components/schemas/Scope" + }, + "type": "array", + "title": "Scopes" + }, + "ip": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Ip" + }, + "user_agent": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "User Agent" + }, + "flare_referer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Flare Referer" + } + }, + "type": "object", + "required": [ + "search_terms", + "organization_id", + "tenant_id", + "user_id", + "include_restricted_domains", + "include_noisy_domains", + "scopes", + "ip", + "user_agent", + "flare_referer" ], - "title": "SearchQueryData" + "title": "SearchTermsAllowedRequest" }, "SearchType": { "type": "string", @@ -12988,7 +16059,6 @@ "paste", "leak", "chat_message", - "chat_message/telegram", "domain", "bot", "stealer_log", @@ -13042,7 +16112,8 @@ "type": { "type": "string", "const": "secret", - "title": "Type" + "title": "Type", + "default": "secret" }, "secret": { "type": "string", @@ -13052,7 +16123,6 @@ }, "type": "object", "required": [ - "type", "secret" ], "title": "SecretData" @@ -13309,6 +16379,19 @@ ], "title": "Severity" }, + "SourceSummary": { + "properties": { + "is_defunct": { + "type": "boolean", + "title": "Is Defunct" + } + }, + "type": "object", + "required": [ + "is_defunct" + ], + "title": "SourceSummary" + }, "StatsAggregates": { "type": "string", "enum": [ @@ -13319,6 +16402,43 @@ ], "title": "StatsAggregates" }, + "StrategyMember": { + "properties": { + "type": { + "$ref": "#/components/schemas/StrategyMemberType" + }, + "id": { + "type": "integer", + "title": "Id" + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name" + } + }, + "type": "object", + "required": [ + "type", + "id" + ], + "title": "StrategyMember" + }, + "StrategyMemberType": { + "type": "string", + "enum": [ + "user", + "tenant", + "organization" + ], + "title": "StrategyMemberType" + }, "SubdomainStatus": { "properties": { "status": { @@ -13412,6 +16532,47 @@ ], "title": "TagPayload" }, + "TenantIndustry": { + "type": "string", + "enum": [ + "global", + "transport", + "education", + "energy", + "finance", + "healthcare", + "manufacturing", + "retail", + "software", + "telecommunication" + ], + "title": "TenantIndustry" + }, + "TenantIntegrationFilters": { + "properties": { + "type": { + "type": "string", + "const": "tenant_integration", + "title": "Type", + "default": "tenant_integration" + }, + "tenant_integration_ids": { + "items": { + "type": "string", + "format": "uuid" + }, + "type": "array", + "maxItems": 1, + "minItems": 1, + "title": "Tenant Integration Ids" + } + }, + "type": "object", + "required": [ + "tenant_integration_ids" + ], + "title": "TenantIntegrationFilters" + }, "TenantIntegrationItem": { "properties": { "id": { @@ -13514,57 +16675,255 @@ "status": { "$ref": "#/components/schemas/TenantIntegrationStatus" }, - "message": { + "message": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Message" + } + }, + "type": "object", + "required": [ + "status", + "message" + ], + "title": "TenantIntegrationStatusResponse" + }, + "TenantIntegrationType": { + "type": "string", + "enum": [ + "entra_id" + ], + "title": "TenantIntegrationType" + }, + "TenantPayload": { + "properties": { + "id": { + "type": "integer", + "title": "Id" + }, + "name": { + "type": "string", + "title": "Name" + }, + "type": { + "type": "string", + "title": "Type" + }, + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Description" + }, + "organization_id": { + "type": "integer", + "title": "Organization Id" + }, + "urn": { + "type": "string", + "title": "Urn" + }, + "number_of_employees": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Number Of Employees" + }, + "industry": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Industry" + }, + "is_archived": { + "type": "boolean", + "title": "Is Archived" + }, + "feed_id": { + "type": "integer", + "title": "Feed Id" + }, + "identifier_limit": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Identifier Limit" + }, + "permissions": { + "items": { + "$ref": "#/components/schemas/UserPermissions" + }, + "type": "array", + "title": "Permissions" + }, + "prevent_global_search": { + "type": "boolean", + "title": "Prevent Global Search" + } + }, + "type": "object", + "required": [ + "id", + "name", + "type", + "description", + "organization_id", + "urn", + "number_of_employees", + "industry", + "is_archived", + "feed_id", + "identifier_limit", + "permissions", + "prevent_global_search" + ], + "title": "TenantPayload" + }, + "TenantRoleType": { + "type": "string", + "enum": [ + "viewer", + "editor", + "admin" + ], + "title": "TenantRoleType" + }, + "TenantUserAccess": { + "properties": { + "tenant_id": { + "type": "integer", + "title": "Tenant Id" + }, + "tenant_role": { + "$ref": "#/components/schemas/TenantRoleType" + } + }, + "type": "object", + "required": [ + "tenant_id", + "tenant_role" + ], + "title": "TenantUserAccess" + }, + "TenantWithEnrichmentsPayload": { + "properties": { + "tenant": { + "$ref": "#/components/schemas/TenantPayload" + }, + "user_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "User Count" + }, + "identifier_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Identifier Count" + }, + "identifier_limit": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Identifier Limit" + }, + "global_search_calls_limit": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Global Search Calls Limit" + }, + "global_search_calls_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Global Search Calls Count" + }, + "identifier_rotation_count": { + "type": "integer", + "title": "Identifier Rotation Count" + }, + "identifier_rotation_limit": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Message" - } - }, - "type": "object", - "required": [ - "status", - "message" - ], - "title": "TenantIntegrationStatusResponse" - }, - "TenantIntegrationType": { - "type": "string", - "enum": [ - "entra_id" - ], - "title": "TenantIntegrationType" - }, - "TenantRoleType": { - "type": "string", - "enum": [ - "viewer", - "editor", - "admin" - ], - "title": "TenantRoleType" - }, - "TenantUserAccess": { - "properties": { - "tenant_id": { - "type": "integer", - "title": "Tenant Id" + "title": "Identifier Rotation Limit" }, - "tenant_role": { - "$ref": "#/components/schemas/TenantRoleType" + "identities_limit": { + "type": "integer", + "title": "Identities Limit" } }, "type": "object", "required": [ - "tenant_id", - "tenant_role" + "tenant", + "user_count", + "identifier_count", + "identifier_limit", + "global_search_calls_limit", + "global_search_calls_count", + "identifier_rotation_count", + "identifier_rotation_limit", + "identities_limit" ], - "title": "TenantUserAccess" + "title": "TenantWithEnrichmentsPayload" }, "TestTenantIntegrationPayload": { "properties": { @@ -13752,6 +17111,19 @@ ], "title": "ThreatFlowTenantConfigPayload" }, + "TimeField": { + "type": "string", + "enum": [ + "metadata.first_crawled_at", + "metadata.estimated_created_at", + "metadata.last_crawled_at", + "firework.materialized_at", + "metadata.searchable_at", + "firework.user_metadata.ignored_at", + "firework.user_metadata.remediated_at" + ], + "title": "TimeField" + }, "TimeRangeType": { "type": "string", "enum": [ @@ -13821,6 +17193,78 @@ ], "title": "TimelineSearchTypeWithValues" }, + "Times": { + "properties": { + "field": { + "$ref": "#/components/schemas/TimeField", + "default": "metadata.estimated_created_at" + }, + "gt": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Gt" + }, + "gte": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Gte" + }, + "lt": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Lt" + }, + "lte": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Lte" + } + }, + "type": "object", + "title": "Times" + }, + "TopActorsSummaryOutput": { + "properties": { + "top_actors": { + "type": "string", + "title": "Top Actors", + "description": "Single paragraph summarizing the most active actors in the forum thread." + } + }, + "type": "object", + "required": [ + "top_actors" + ], + "title": "TopActorsSummaryOutput" + }, "UpdateAlertChannel": { "properties": { "name": { @@ -13847,9 +17291,6 @@ { "$ref": "#/components/schemas/AlertChannelSentinelParams" }, - { - "$ref": "#/components/schemas/AlertChannelCgcdParams" - }, { "$ref": "#/components/schemas/AlertChannelTeamsParams" }, @@ -13868,7 +17309,6 @@ "propertyName": "type", "mapping": { "azure_sentinel": "#/components/schemas/AlertChannelSentinelParams", - "cgcd": "#/components/schemas/AlertChannelCgcdParams", "channel": "#/components/schemas/AlertChannelChannelParams", "discord": "#/components/schemas/AlertChannelDiscordParams", "email": "#/components/schemas/AlertChannelEmailParams", @@ -13893,6 +17333,40 @@ ], "title": "UpdateAlertChannel" }, + "UpdateAllowedRestrictedTermRequest": { + "properties": { + "tenant_ids": { + "anyOf": [ + { + "items": { + "type": "integer" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Tenant Ids" + }, + "reason": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Reason" + } + }, + "type": "object", + "required": [ + "tenant_ids" + ], + "title": "UpdateAllowedRestrictedTermRequest" + }, "UpdatePartialTenantIntegrationPayload": { "properties": { "name": { @@ -14091,6 +17565,122 @@ ], "title": "UpdateTenantIntegrationPayload" }, + "UpdateTenantRequestBody": { + "properties": { + "name": { + "type": "string", + "minLength": 1, + "title": "Name" + }, + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Description" + }, + "number_of_employees": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Number Of Employees" + }, + "industry": { + "$ref": "#/components/schemas/TenantIndustry" + }, + "identifier_limit": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Identifier Limit" + }, + "prevent_global_search": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Prevent Global Search" + } + }, + "type": "object", + "required": [ + "name", + "description", + "number_of_employees", + "industry", + "identifier_limit", + "prevent_global_search" + ], + "title": "UpdateTenantRequestBody" + }, + "UserPermissions": { + "type": "string", + "enum": [ + "firework.identifiers.search_query", + "firework.identifiers.github_repository", + "firework.global_search", + "firework.identifiers.search_query.regex", + "leaksdb", + "leaksdb.show-passwords", + "ads", + "do-not-track", + "firework.api.can_use_apikeys", + "bypass-mfa", + "industry.finance_canada", + "footprint", + "audit_log", + "discourse_moderator", + "discourse_admin", + "partner_portal", + "partner_portal_redirect", + "pendo", + "qa", + "qa.test-bench", + "ai-assist-disabled", + "leaked_files.allow_download", + "stealer_logs.allow_chat_messages", + "file_transfers", + "supply_chain_monitoring", + "threat_flow_custom_reports", + "view_legacy_footprint", + "firework.identifiers.discovery_policy", + "integrations", + "idp_credential_validation", + "alert_channels", + "ioc_feeds", + "query_identifier_count_legacy", + "white_labeling", + "github_account_sync", + "illicit_political_content", + "phishing_content", + "disable_search_restrictions", + "firework.global_search_package_quota_only_count_api", + "mask_pii", + "disable_rate_limit_csm_notification", + "referrals_hidden", + "astp_credentials_access", + "astp_cookies_access" + ], + "title": "UserPermissions" + }, "UserTenantAccess": { "properties": { "user_id": { @@ -14113,7 +17703,8 @@ "type": { "type": "string", "const": "username", - "title": "Type" + "title": "Type", + "default": "username" }, "username": { "type": "string", @@ -14123,36 +17714,10 @@ }, "type": "object", "required": [ - "type", "username" ], "title": "UsernameData" }, - "UsernameIdentityAttribute": { - "properties": { - "type": { - "type": "string", - "const": "username", - "title": "Type" - }, - "username": { - "type": "string", - "minLength": 1, - "title": "Username" - }, - "asset_uuid": { - "type": "string", - "title": "Asset Uuid" - } - }, - "type": "object", - "required": [ - "type", - "username", - "asset_uuid" - ], - "title": "UsernameIdentityAttribute" - }, "UsernameQuery": { "properties": { "type": { @@ -14243,16 +17808,7 @@ ], "title": "WebhookBasicAuth" }, - "firework__backend__api4__identities__recent_activities__models__SortType": { - "type": "string", - "enum": [ - "creation_date", - "event_type", - "source_name" - ], - "title": "SortType" - }, - "firework__backend__api4__models__PaginatedResults_Report___1": { + "pyro__firework__backend__api4__models__PaginatedResults_Report___1": { "properties": { "items": { "items": { @@ -14280,7 +17836,7 @@ ], "title": "PaginatedResults[Report]" }, - "firework__backend__api4__models__PaginatedResults_Report___2": { + "pyro__firework__backend__api4__models__PaginatedResults_Report___2": { "properties": { "items": { "items": { @@ -14308,7 +17864,7 @@ ], "title": "PaginatedResults[Report]" }, - "firework__backend__api4__reports__report_datamodels__ReportResponse": { + "pyro__firework__backend__api4__reports__report_datamodels__ReportResponse": { "properties": { "report": { "$ref": "#/components/schemas/pyro__reports__report_datamodels__Report" @@ -14320,6 +17876,21 @@ ], "title": "ReportResponse" }, + "pyro__identity__profile__sort_type__SortType": { + "type": "string", + "enum": [ + "creation_date", + "credentials_count", + "event_type", + "information_type", + "ip_address", + "last_seen", + "leaked_date", + "password", + "source_name" + ], + "title": "SortType" + }, "pyro__reports__report_datamodels__Report": { "properties": { "id": { @@ -14416,15 +17987,6 @@ ], "title": "Report" }, - "pyro__reports__report_models__ReportType": { - "type": "string", - "enum": [ - "v1", - "event_based", - "feed_based" - ], - "title": "ReportType" - }, "pyro__reports__report_store__SortType": { "type": "string", "enum": [ @@ -14437,6 +17999,15 @@ ], "title": "SortType" }, + "pyro__reports__report_types__ReportType": { + "type": "string", + "enum": [ + "v1", + "event_based", + "feed_based" + ], + "title": "ReportType" + }, "pyro__threat_flow__core__reports__datamodels__Report": { "properties": { "id": { diff --git a/docs/api-reference/v4/endpoints/private/add-allowed-restricted-term.mdx b/docs/api-reference/v4/endpoints/private/add-allowed-restricted-term.mdx new file mode 100644 index 0000000..3bfec2e --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/add-allowed-restricted-term.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/admin/organizations/{organization_id}/allowed_restricted_terms +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/add-tenant-users-put.mdx b/docs/api-reference/v4/endpoints/private/add-tenant-users-put.mdx new file mode 100644 index 0000000..8f7f403 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/add-tenant-users-put.mdx @@ -0,0 +1,3 @@ +--- +openapi: put /firework/v4/tenants/{tenant_id}/users +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/add-user-to-tenants.mdx b/docs/api-reference/v4/endpoints/private/add-user-to-tenants.mdx new file mode 100644 index 0000000..cc381f2 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/add-user-to-tenants.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/organizations/{organization_id}/users/{user_id}/tenants +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/archive-report.mdx b/docs/api-reference/v4/endpoints/private/archive-report.mdx new file mode 100644 index 0000000..d39816c --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/archive-report.mdx @@ -0,0 +1,3 @@ +--- +openapi: patch /firework/v4/reports/{report_id}/archive +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/are-allowed.mdx b/docs/api-reference/v4/endpoints/private/are-allowed.mdx new file mode 100644 index 0000000..8174e90 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/are-allowed.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/admin/restricted_terms/are_allowed +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/bulk-actions.mdx b/docs/api-reference/v4/endpoints/private/bulk-actions.mdx new file mode 100644 index 0000000..f94ec8a --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/bulk-actions.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/tasks/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/create-alert.mdx b/docs/api-reference/v4/endpoints/private/create-alert.mdx new file mode 100644 index 0000000..4d20734 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/create-alert.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/alerts/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/create-conversation-summary-request.mdx b/docs/api-reference/v4/endpoints/private/create-conversation-summary-request.mdx new file mode 100644 index 0000000..d909fde --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/create-conversation-summary-request.mdx @@ -0,0 +1,3 @@ +--- +openapi: put /firework/v4/threat_flow/conversation_summary_requests/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/create-cookie-monitoring-configuration.mdx b/docs/api-reference/v4/endpoints/private/create-cookie-monitoring-configuration.mdx new file mode 100644 index 0000000..62beba0 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/create-cookie-monitoring-configuration.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/admin/cookies/monitor +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/create-credential-bulk-action.mdx b/docs/api-reference/v4/endpoints/private/create-credential-bulk-action.mdx new file mode 100644 index 0000000..24be568 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/create-credential-bulk-action.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/credentials/bulk_action +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/create-or-update-tenant-config.mdx b/docs/api-reference/v4/endpoints/private/create-or-update-tenant-config.mdx new file mode 100644 index 0000000..7dacfc6 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/create-or-update-tenant-config.mdx @@ -0,0 +1,3 @@ +--- +openapi: put /firework/v4/threat_flow/tenant_config/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/create-report.mdx b/docs/api-reference/v4/endpoints/private/create-report.mdx new file mode 100644 index 0000000..29dd388 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/create-report.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/reports/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/create-tenant-integration.mdx b/docs/api-reference/v4/endpoints/private/create-tenant-integration.mdx new file mode 100644 index 0000000..dbce2a0 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/create-tenant-integration.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/integrations/tenant_integrations +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/create-tenant-user.mdx b/docs/api-reference/v4/endpoints/private/create-tenant-user.mdx new file mode 100644 index 0000000..8434a9d --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/create-tenant-user.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/tenants/{tenant_id}/users +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/delete-alert.mdx b/docs/api-reference/v4/endpoints/private/delete-alert.mdx new file mode 100644 index 0000000..2566673 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/delete-alert.mdx @@ -0,0 +1,3 @@ +--- +openapi: delete /firework/v4/alerts/{alert_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/delete-allowed-restricted-terms.mdx b/docs/api-reference/v4/endpoints/private/delete-allowed-restricted-terms.mdx new file mode 100644 index 0000000..a6450d4 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/delete-allowed-restricted-terms.mdx @@ -0,0 +1,3 @@ +--- +openapi: delete /firework/v4/admin/organizations/{organization_id}/allowed_restricted_terms/{restricted_term_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/delete-channel.mdx b/docs/api-reference/v4/endpoints/private/delete-channel.mdx new file mode 100644 index 0000000..54ad57a --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/delete-channel.mdx @@ -0,0 +1,3 @@ +--- +openapi: delete /firework/v4/alerts/channels/{alert_channel_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/delete-report.mdx b/docs/api-reference/v4/endpoints/private/delete-report.mdx new file mode 100644 index 0000000..6003f50 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/delete-report.mdx @@ -0,0 +1,3 @@ +--- +openapi: delete /firework/v4/reports/{report_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/delete-tenant-integration.mdx b/docs/api-reference/v4/endpoints/private/delete-tenant-integration.mdx new file mode 100644 index 0000000..7c68cc9 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/delete-tenant-integration.mdx @@ -0,0 +1,3 @@ +--- +openapi: delete /firework/v4/integrations/tenant_integrations/{tenant_integration_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/disable-account.mdx b/docs/api-reference/v4/endpoints/private/disable-account.mdx new file mode 100644 index 0000000..b3f5dde --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/disable-account.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/integrations/tenant_integrations/{tenant_integration_id}/idp/disable_account +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/disable-tenant-member.mdx b/docs/api-reference/v4/endpoints/private/disable-tenant-member.mdx new file mode 100644 index 0000000..4dfac48 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/disable-tenant-member.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/tenants/{tenant_id}/users/{user_id}/disable +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/download-report.mdx b/docs/api-reference/v4/endpoints/private/download-report.mdx new file mode 100644 index 0000000..dd3fb39 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/download-report.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/reports/{report_id}/download +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/enable-tenant-member.mdx b/docs/api-reference/v4/endpoints/private/enable-tenant-member.mdx new file mode 100644 index 0000000..dff6801 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/enable-tenant-member.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/tenants/{tenant_id}/users/{user_id}/enable +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/fetch-extracted-secrets.mdx b/docs/api-reference/v4/endpoints/private/fetch-extracted-secrets.mdx new file mode 100644 index 0000000..2dd20bc --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/fetch-extracted-secrets.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/events/extracted_secrets +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/fetch-identifier-by-asset-data.mdx b/docs/api-reference/v4/endpoints/private/fetch-identifier-by-asset-data.mdx new file mode 100644 index 0000000..01fb3a3 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/fetch-identifier-by-asset-data.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/identifiers/identity_by_asset_data +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/fetch-identity-by-email.mdx b/docs/api-reference/v4/endpoints/private/fetch-identity-by-email.mdx new file mode 100644 index 0000000..06c4d1e --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/fetch-identity-by-email.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/identifiers/identity_by_email +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/generate-actor-summaries.mdx b/docs/api-reference/v4/endpoints/private/generate-actor-summaries.mdx new file mode 100644 index 0000000..12d1216 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/generate-actor-summaries.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/actors/{actor_name}/generate-summaries +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/generate-forum-thread-summaries.mdx b/docs/api-reference/v4/endpoints/private/generate-forum-thread-summaries.mdx new file mode 100644 index 0000000..e072809 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/generate-forum-thread-summaries.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/forum-threads/{forum_thread_id}/generate-summaries +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/generate-report-csv.mdx b/docs/api-reference/v4/endpoints/private/generate-report-csv.mdx new file mode 100644 index 0000000..9c11d95 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/generate-report-csv.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/reports/{report_id}/generate_csv +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/generate-report.mdx b/docs/api-reference/v4/endpoints/private/generate-report.mdx new file mode 100644 index 0000000..f40068b --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/generate-report.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/reports/{report_id}/generate +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/generate-summary.mdx b/docs/api-reference/v4/endpoints/private/generate-summary.mdx new file mode 100644 index 0000000..ec580ae --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/generate-summary.mdx @@ -0,0 +1,3 @@ +--- +openapi: patch /firework/v4/reports/{report_id}/summarize/{uid} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-actor-analysis-metadata.mdx b/docs/api-reference/v4/endpoints/private/get-actor-analysis-metadata.mdx new file mode 100644 index 0000000..40e7c0e --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-actor-analysis-metadata.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/actors/{actor_name}/analysis/metadata +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-actor-communication-handles.mdx b/docs/api-reference/v4/endpoints/private/get-actor-communication-handles.mdx new file mode 100644 index 0000000..b45bfe0 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-actor-communication-handles.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/actors/{actor_name}/communication-handles +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-actor-heatmap.mdx b/docs/api-reference/v4/endpoints/private/get-actor-heatmap.mdx new file mode 100644 index 0000000..b5e3c7e --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-actor-heatmap.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/actors/{actor_name}/heatmap +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-actor-network.mdx b/docs/api-reference/v4/endpoints/private/get-actor-network.mdx new file mode 100644 index 0000000..6da810d --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-actor-network.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/actors/{actor_name}/network +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-actor-profile.mdx b/docs/api-reference/v4/endpoints/private/get-actor-profile.mdx new file mode 100644 index 0000000..b427fca --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-actor-profile.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/actors/{actor_name}/profile +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-actor-recent-activities.mdx b/docs/api-reference/v4/endpoints/private/get-actor-recent-activities.mdx new file mode 100644 index 0000000..5fa4c26 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-actor-recent-activities.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/actors/{actor_name}/recent-activities +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-actor-summaries-by-request-id.mdx b/docs/api-reference/v4/endpoints/private/get-actor-summaries-by-request-id.mdx new file mode 100644 index 0000000..2c6c567 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-actor-summaries-by-request-id.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/actors/summaries/{request_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-actor-timeline.mdx b/docs/api-reference/v4/endpoints/private/get-actor-timeline.mdx new file mode 100644 index 0000000..3c544b4 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-actor-timeline.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/actors/{actor_name}/timeline +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-alert-channel.mdx b/docs/api-reference/v4/endpoints/private/get-alert-channel.mdx new file mode 100644 index 0000000..78b3225 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-alert-channel.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/alerts/channels/{alert_channel_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-allowed-restricted-terms.mdx b/docs/api-reference/v4/endpoints/private/get-allowed-restricted-terms.mdx new file mode 100644 index 0000000..202cd37 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-allowed-restricted-terms.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/admin/organizations/{organization_id}/allowed_restricted_terms +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-and-create-tenant-config.mdx b/docs/api-reference/v4/endpoints/private/get-and-create-tenant-config.mdx new file mode 100644 index 0000000..6afb5c8 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-and-create-tenant-config.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/threat_flow/tenant_config/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-application-exposures.mdx b/docs/api-reference/v4/endpoints/private/get-application-exposures.mdx new file mode 100644 index 0000000..a346b7c --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-application-exposures.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/identities/{asset_uuid}/application_exposures +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-credential-validations.mdx b/docs/api-reference/v4/endpoints/private/get-credential-validations.mdx new file mode 100644 index 0000000..f2b157b --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-credential-validations.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/integrations/credential_validations +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-feature-flag.mdx b/docs/api-reference/v4/endpoints/private/get-feature-flag.mdx new file mode 100644 index 0000000..a693f9a --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-feature-flag.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/admin/feature_flags/{feature_flag_name} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-forum-thread-analysis-metadata.mdx b/docs/api-reference/v4/endpoints/private/get-forum-thread-analysis-metadata.mdx new file mode 100644 index 0000000..c4de87b --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-forum-thread-analysis-metadata.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/forum-threads/{forum_thread_id}/analysis/metadata +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-forum-thread-breakdown.mdx b/docs/api-reference/v4/endpoints/private/get-forum-thread-breakdown.mdx new file mode 100644 index 0000000..d03d39a --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-forum-thread-breakdown.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/forum-threads/{forum_thread_id}/breakdown +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-forum-thread-indicators.mdx b/docs/api-reference/v4/endpoints/private/get-forum-thread-indicators.mdx new file mode 100644 index 0000000..73887aa --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-forum-thread-indicators.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/forum-threads/{forum_thread_id}/indicators +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-forum-thread-metadata.mdx b/docs/api-reference/v4/endpoints/private/get-forum-thread-metadata.mdx new file mode 100644 index 0000000..bc9d07f --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-forum-thread-metadata.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/forum-threads/{forum_thread_id}/metadata +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-forum-thread-summaries-by-request-id.mdx b/docs/api-reference/v4/endpoints/private/get-forum-thread-summaries-by-request-id.mdx new file mode 100644 index 0000000..11b4ca6 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-forum-thread-summaries-by-request-id.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/forum-threads/summaries/{request_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-identifier-count-by-id.mdx b/docs/api-reference/v4/endpoints/private/get-identifier-count-by-id.mdx new file mode 100644 index 0000000..d4000ec --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-identifier-count-by-id.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/identifiers/{identifier_id}/count +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-identifier-count.mdx b/docs/api-reference/v4/endpoints/private/get-identifier-count.mdx new file mode 100644 index 0000000..39fc7ce --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-identifier-count.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/identifiers/count +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-identifier-relations.mdx b/docs/api-reference/v4/endpoints/private/get-identifier-relations.mdx new file mode 100644 index 0000000..6c450a9 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-identifier-relations.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/identifiers/{identifier_id}/relations +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-identity-application-exposures-graph.mdx b/docs/api-reference/v4/endpoints/private/get-identity-application-exposures-graph.mdx new file mode 100644 index 0000000..4e53dc9 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-identity-application-exposures-graph.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/identities/{asset_uuid}/application_exposures_graph +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-idp-services-exposed.mdx b/docs/api-reference/v4/endpoints/private/get-idp-services-exposed.mdx new file mode 100644 index 0000000..4c6a288 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-idp-services-exposed.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/identities/{asset_uuid}/idp_services_exposed +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-idp-user-data.mdx b/docs/api-reference/v4/endpoints/private/get-idp-user-data.mdx new file mode 100644 index 0000000..9410090 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-idp-user-data.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/identities/{asset_uuid}/idp_user_data +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-logos-from-domains.mdx b/docs/api-reference/v4/endpoints/private/get-logos-from-domains.mdx new file mode 100644 index 0000000..105146d --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-logos-from-domains.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/logos/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-matching-identifiers.mdx b/docs/api-reference/v4/endpoints/private/get-matching-identifiers.mdx new file mode 100644 index 0000000..e38f739 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-matching-identifiers.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/events/matching_identifiers +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-recent-activities-count.mdx b/docs/api-reference/v4/endpoints/private/get-recent-activities-count.mdx new file mode 100644 index 0000000..b84bb95 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-recent-activities-count.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/identities/{asset_uuid}/recent_activities/_count +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-recent-activities-search.mdx b/docs/api-reference/v4/endpoints/private/get-recent-activities-search.mdx new file mode 100644 index 0000000..8c986f9 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-recent-activities-search.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/identities/{asset_uuid}/recent_activities/_search +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-recent-activities-timeline-by-search-type.mdx b/docs/api-reference/v4/endpoints/private/get-recent-activities-timeline-by-search-type.mdx new file mode 100644 index 0000000..00399db --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-recent-activities-timeline-by-search-type.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/identities/{asset_uuid}/timeline_by_search_type +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-report-1.mdx b/docs/api-reference/v4/endpoints/private/get-report-1.mdx new file mode 100644 index 0000000..eed3167 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-report-1.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/reports/{report_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-report-config.mdx b/docs/api-reference/v4/endpoints/private/get-report-config.mdx new file mode 100644 index 0000000..62ed637 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-report-config.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/reports/{report_id}/config +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-report-section.mdx b/docs/api-reference/v4/endpoints/private/get-report-section.mdx new file mode 100644 index 0000000..6441c68 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-report-section.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/reports/{report_id}/sections/{uid} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-report.mdx b/docs/api-reference/v4/endpoints/private/get-report.mdx new file mode 100644 index 0000000..a0b1f4b --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-report.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/admin/threat_flow/reports/{report_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-restricted-terms.mdx b/docs/api-reference/v4/endpoints/private/get-restricted-terms.mdx new file mode 100644 index 0000000..ab0fbe9 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-restricted-terms.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/admin/restricted_terms +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-source-summary.mdx b/docs/api-reference/v4/endpoints/private/get-source-summary.mdx new file mode 100644 index 0000000..0c658f7 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-source-summary.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/sources/{source}/summary +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-tenant-alert.mdx b/docs/api-reference/v4/endpoints/private/get-tenant-alert.mdx new file mode 100644 index 0000000..e1ee527 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-tenant-alert.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/alerts/{alert_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-tenant-integration.mdx b/docs/api-reference/v4/endpoints/private/get-tenant-integration.mdx new file mode 100644 index 0000000..2d84d70 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-tenant-integration.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/integrations/tenant_integrations/{tenant_integration_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/get-tenant-integrations.mdx b/docs/api-reference/v4/endpoints/private/get-tenant-integrations.mdx new file mode 100644 index 0000000..3c18a15 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/get-tenant-integrations.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/integrations/tenant_integrations +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/is-allowed.mdx b/docs/api-reference/v4/endpoints/private/is-allowed.mdx new file mode 100644 index 0000000..220bf1f --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/is-allowed.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/admin/restricted_terms/is_allowed +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/list-conversation-summary-requests.mdx b/docs/api-reference/v4/endpoints/private/list-conversation-summary-requests.mdx new file mode 100644 index 0000000..ecaf123 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/list-conversation-summary-requests.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/threat_flow/conversation_summary_requests/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/list-cookie-monitoring-configurations.mdx b/docs/api-reference/v4/endpoints/private/list-cookie-monitoring-configurations.mdx new file mode 100644 index 0000000..1de3e08 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/list-cookie-monitoring-configurations.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/admin/cookies/configurations +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/list-feature-flags.mdx b/docs/api-reference/v4/endpoints/private/list-feature-flags.mdx new file mode 100644 index 0000000..c8006dc --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/list-feature-flags.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/admin/feature_flags/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/list-report-sections.mdx b/docs/api-reference/v4/endpoints/private/list-report-sections.mdx new file mode 100644 index 0000000..0627277 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/list-report-sections.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/reports/{report_id}/sections +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/list-reports-1.mdx b/docs/api-reference/v4/endpoints/private/list-reports-1.mdx new file mode 100644 index 0000000..f42fb7b --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/list-reports-1.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/reports/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/list-reports.mdx b/docs/api-reference/v4/endpoints/private/list-reports.mdx new file mode 100644 index 0000000..ec0bb0b --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/list-reports.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/admin/threat_flow/reports +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/list-tags.mdx b/docs/api-reference/v4/endpoints/private/list-tags.mdx new file mode 100644 index 0000000..e400165 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/list-tags.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/threat_flow/tags/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/mark-user-as-compromised.mdx b/docs/api-reference/v4/endpoints/private/mark-user-as-compromised.mdx new file mode 100644 index 0000000..7fca68b --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/mark-user-as-compromised.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/integrations/tenant_integrations/{tenant_integration_id}/idp/mark_user_as_compromised +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/merge-identity-identifiers.mdx b/docs/api-reference/v4/endpoints/private/merge-identity-identifiers.mdx new file mode 100644 index 0000000..1d1fcbd --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/merge-identity-identifiers.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/identifiers/merge_identities +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/regenerate-actor-summaries.mdx b/docs/api-reference/v4/endpoints/private/regenerate-actor-summaries.mdx new file mode 100644 index 0000000..3ce7b62 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/regenerate-actor-summaries.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/actors/{actor_name}/regenerate-summaries +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/regenerate-forum-thread-summaries.mdx b/docs/api-reference/v4/endpoints/private/regenerate-forum-thread-summaries.mdx new file mode 100644 index 0000000..37471d3 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/regenerate-forum-thread-summaries.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/forum-threads/{forum_thread_id}/regenerate-summaries +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/reset-credential-validations.mdx b/docs/api-reference/v4/endpoints/private/reset-credential-validations.mdx new file mode 100644 index 0000000..eec45fa --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/reset-credential-validations.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/integrations/credential_validations/{tenant_id}/reset +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/revoke-sessions.mdx b/docs/api-reference/v4/endpoints/private/revoke-sessions.mdx new file mode 100644 index 0000000..bf701ea --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/revoke-sessions.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/integrations/tenant_integrations/{tenant_integration_id}/idp/revoke_sessions +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/submit-presigned-url.mdx b/docs/api-reference/v4/endpoints/private/submit-presigned-url.mdx new file mode 100644 index 0000000..e41b414 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/submit-presigned-url.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/file_analysis/submit +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/tenant-cookies-search-by-value.mdx b/docs/api-reference/v4/endpoints/private/tenant-cookies-search-by-value.mdx new file mode 100644 index 0000000..3fb2975 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/tenant-cookies-search-by-value.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/cookies/tenant/_search_by_value +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/test-tenant-integration.mdx b/docs/api-reference/v4/endpoints/private/test-tenant-integration.mdx new file mode 100644 index 0000000..826cb53 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/test-tenant-integration.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/integrations/tenant_integrations/test +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/update-alert.mdx b/docs/api-reference/v4/endpoints/private/update-alert.mdx new file mode 100644 index 0000000..ae7783f --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/update-alert.mdx @@ -0,0 +1,3 @@ +--- +openapi: patch /firework/v4/alerts/{alert_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/update-allowed-restricted-terms.mdx b/docs/api-reference/v4/endpoints/private/update-allowed-restricted-terms.mdx new file mode 100644 index 0000000..26c4594 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/update-allowed-restricted-terms.mdx @@ -0,0 +1,3 @@ +--- +openapi: put /firework/v4/admin/organizations/{organization_id}/allowed_restricted_terms/{restricted_term_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/update-channel.mdx b/docs/api-reference/v4/endpoints/private/update-channel.mdx new file mode 100644 index 0000000..51f022b --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/update-channel.mdx @@ -0,0 +1,3 @@ +--- +openapi: put /firework/v4/alerts/channels/{alert_channel_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/update-domain-identifier-properties.mdx b/docs/api-reference/v4/endpoints/private/update-domain-identifier-properties.mdx new file mode 100644 index 0000000..64ebf35 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/update-domain-identifier-properties.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/admin/identifiers/{identifier_id}/update_domain_identifier_properties +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/update-identifier-by-id.mdx b/docs/api-reference/v4/endpoints/private/update-identifier-by-id.mdx new file mode 100644 index 0000000..541bfae --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/update-identifier-by-id.mdx @@ -0,0 +1,3 @@ +--- +openapi: put /firework/v4/identifiers/{identifier_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/update-partial-tenant-integration.mdx b/docs/api-reference/v4/endpoints/private/update-partial-tenant-integration.mdx new file mode 100644 index 0000000..ea209ef --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/update-partial-tenant-integration.mdx @@ -0,0 +1,3 @@ +--- +openapi: patch /firework/v4/integrations/tenant_integrations/{tenant_integration_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/update-report-1.mdx b/docs/api-reference/v4/endpoints/private/update-report-1.mdx new file mode 100644 index 0000000..ba0694c --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/update-report-1.mdx @@ -0,0 +1,3 @@ +--- +openapi: patch /firework/v4/reports/{report_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/update-report-config.mdx b/docs/api-reference/v4/endpoints/private/update-report-config.mdx new file mode 100644 index 0000000..31e8d27 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/update-report-config.mdx @@ -0,0 +1,3 @@ +--- +openapi: patch /firework/v4/reports/{report_id}/config +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/update-report-section.mdx b/docs/api-reference/v4/endpoints/private/update-report-section.mdx new file mode 100644 index 0000000..d941561 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/update-report-section.mdx @@ -0,0 +1,3 @@ +--- +openapi: patch /firework/v4/reports/{report_id}/sections/{uid} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/update-report.mdx b/docs/api-reference/v4/endpoints/private/update-report.mdx new file mode 100644 index 0000000..3951ece --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/update-report.mdx @@ -0,0 +1,3 @@ +--- +openapi: put /firework/v4/admin/threat_flow/reports/{report_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/update-tenant-integration.mdx b/docs/api-reference/v4/endpoints/private/update-tenant-integration.mdx new file mode 100644 index 0000000..f4b3d01 --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/update-tenant-integration.mdx @@ -0,0 +1,3 @@ +--- +openapi: put /firework/v4/integrations/tenant_integrations/{tenant_integration_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/update-tenant.mdx b/docs/api-reference/v4/endpoints/private/update-tenant.mdx new file mode 100644 index 0000000..8d858fa --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/update-tenant.mdx @@ -0,0 +1,3 @@ +--- +openapi: put /firework/v4/tenants/{tenant_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/private/validate-credential.mdx b/docs/api-reference/v4/endpoints/private/validate-credential.mdx new file mode 100644 index 0000000..32fb78a --- /dev/null +++ b/docs/api-reference/v4/endpoints/private/validate-credential.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/integrations/credential_validations +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/public/alert-channels.mdx b/docs/api-reference/v4/endpoints/public/alert-channels.mdx new file mode 100644 index 0000000..9e08ddf --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/alert-channels.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/alerts/channels +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/public/create-action-for-identifier-recommendations.mdx b/docs/api-reference/v4/endpoints/public/create-action-for-identifier-recommendations.mdx new file mode 100644 index 0000000..5b3a09e --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/create-action-for-identifier-recommendations.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/identifier-recommendations/actions +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/public/create-channel.mdx b/docs/api-reference/v4/endpoints/public/create-channel.mdx new file mode 100644 index 0000000..397b02d --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/create-channel.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/alerts/channels +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/public/create-identifier.mdx b/docs/api-reference/v4/endpoints/public/create-identifier.mdx new file mode 100644 index 0000000..6689810 --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/create-identifier.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/identifiers/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/public/create-report-request.mdx b/docs/api-reference/v4/endpoints/public/create-report-request.mdx new file mode 100644 index 0000000..626f371 --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/create-report-request.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/threat_flow/reports/requests +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/public/current-tenant-feed.mdx b/docs/api-reference/v4/endpoints/public/current-tenant-feed.mdx new file mode 100644 index 0000000..c4bc79a --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/current-tenant-feed.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/events/tenant/_search +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/public/delete-report.mdx b/docs/api-reference/v4/endpoints/public/delete-report.mdx new file mode 100644 index 0000000..95ade46 --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/delete-report.mdx @@ -0,0 +1,3 @@ +--- +openapi: delete /firework/v4/threat_flow/reports/{report_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/public/download-report.mdx b/docs/api-reference/v4/endpoints/public/download-report.mdx new file mode 100644 index 0000000..fba0f35 --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/download-report.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/threat_flow/reports/{report_id}/download +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/public/event-actions.mdx b/docs/api-reference/v4/endpoints/public/event-actions.mdx new file mode 100644 index 0000000..435e429 --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/event-actions.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/events/actions +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/public/fetch-filters-risk-score.mdx b/docs/api-reference/v4/endpoints/public/fetch-filters-risk-score.mdx new file mode 100644 index 0000000..5a8a1aa --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/fetch-filters-risk-score.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/events/filters/severities +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/public/fetch-filters-source-types.mdx b/docs/api-reference/v4/endpoints/public/fetch-filters-source-types.mdx new file mode 100644 index 0000000..ff848d9 --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/fetch-filters-source-types.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/events/filters/types +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/public/fetch-identifier-recommendations.mdx b/docs/api-reference/v4/endpoints/public/fetch-identifier-recommendations.mdx new file mode 100644 index 0000000..a6480f1 --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/fetch-identifier-recommendations.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/identifier-recommendations/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/public/get-identifier.mdx b/docs/api-reference/v4/endpoints/public/get-identifier.mdx new file mode 100644 index 0000000..2937f50 --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/get-identifier.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/identifiers/{identifier_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/public/get-identifiers.mdx b/docs/api-reference/v4/endpoints/public/get-identifiers.mdx new file mode 100644 index 0000000..b908308 --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/get-identifiers.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/identifiers/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/public/get-related-conversation.mdx b/docs/api-reference/v4/endpoints/public/get-related-conversation.mdx new file mode 100644 index 0000000..8cbcd00 --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/get-related-conversation.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/threat_flow/unit_summary/related_conversation +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/public/get-report-request.mdx b/docs/api-reference/v4/endpoints/public/get-report-request.mdx new file mode 100644 index 0000000..568d2a7 --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/get-report-request.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/threat_flow/reports/requests/{request_info_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/public/get-report.mdx b/docs/api-reference/v4/endpoints/public/get-report.mdx new file mode 100644 index 0000000..b610123 --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/get-report.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/threat_flow/reports/{report_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/public/global-search.mdx b/docs/api-reference/v4/endpoints/public/global-search.mdx new file mode 100644 index 0000000..14657ba --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/global-search.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/events/global/_search +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/public/identifier-feed.mdx b/docs/api-reference/v4/endpoints/public/identifier-feed.mdx new file mode 100644 index 0000000..50e4b62 --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/identifier-feed.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/events/identifiers/{identifier_id}/_search +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/public/identifier-group-feed.mdx b/docs/api-reference/v4/endpoints/public/identifier-group-feed.mdx new file mode 100644 index 0000000..c0843c6 --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/identifier-group-feed.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/events/identifier_groups/{identifier_group_id}/_search +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/public/is-api-up-and-running.mdx b/docs/api-reference/v4/endpoints/public/is-api-up-and-running.mdx new file mode 100644 index 0000000..806c936 --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/is-api-up-and-running.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/healthz/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/public/list-reports.mdx b/docs/api-reference/v4/endpoints/public/list-reports.mdx new file mode 100644 index 0000000..48e6509 --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/list-reports.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/threat_flow/reports/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/public/tenant-alerts.mdx b/docs/api-reference/v4/endpoints/public/tenant-alerts.mdx new file mode 100644 index 0000000..74bdf64 --- /dev/null +++ b/docs/api-reference/v4/endpoints/public/tenant-alerts.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/alerts/ +--- \ No newline at end of file