diff --git a/docs/api-reference/spec/firework-v2-openapi.json b/docs/api-reference/spec/firework-v2-openapi.json index f95ee3ba..8696f891 100644 --- a/docs/api-reference/spec/firework-v2-openapi.json +++ b/docs/api-reference/spec/firework-v2-openapi.json @@ -1692,7 +1692,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: listing, ransomleak, financial_data, chat_message, blog_post, forum_topic, forum_profile, seller, stealer_log, forum_post, bot\n- open_web: docker, bucket_object, google, paste, source_code_files, service, social_media_account, source_code_secrets, stack_exchange, bucket\n- leaks: valid_credential, mitigated_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, financial_data, chat_message, forum_profile, blog_post, bot, seller, listing, stealer_log, forum_post, forum_topic\n- open_web: source_code_secrets, bucket_object, paste, stack_exchange, service, bucket, google, source_code_files, social_media_account, docker\n- leaks: leak, mitigated_credential, valid_credential, invalid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -2016,7 +2016,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: listing, ransomleak, financial_data, chat_message, blog_post, forum_topic, forum_profile, seller, stealer_log, forum_post, bot\n- open_web: docker, bucket_object, google, paste, source_code_files, service, social_media_account, source_code_secrets, stack_exchange, bucket\n- leaks: valid_credential, mitigated_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, financial_data, chat_message, forum_profile, blog_post, bot, seller, listing, stealer_log, forum_post, forum_topic\n- open_web: source_code_secrets, bucket_object, paste, stack_exchange, service, bucket, google, source_code_files, social_media_account, docker\n- leaks: leak, mitigated_credential, valid_credential, invalid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -2591,7 +2591,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: listing, ransomleak, financial_data, chat_message, blog_post, forum_topic, forum_profile, seller, stealer_log, forum_post, bot\n- open_web: docker, bucket_object, google, paste, source_code_files, service, social_media_account, source_code_secrets, stack_exchange, bucket\n- leaks: valid_credential, mitigated_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, financial_data, chat_message, forum_profile, blog_post, bot, seller, listing, stealer_log, forum_post, forum_topic\n- open_web: source_code_secrets, bucket_object, paste, stack_exchange, service, bucket, google, source_code_files, social_media_account, docker\n- leaks: leak, mitigated_credential, valid_credential, invalid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -2915,7 +2915,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: listing, ransomleak, financial_data, chat_message, blog_post, forum_topic, forum_profile, seller, stealer_log, forum_post, bot\n- open_web: docker, bucket_object, google, paste, source_code_files, service, social_media_account, source_code_secrets, stack_exchange, bucket\n- leaks: valid_credential, mitigated_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, financial_data, chat_message, forum_profile, blog_post, bot, seller, listing, stealer_log, forum_post, forum_topic\n- open_web: source_code_secrets, bucket_object, paste, stack_exchange, service, bucket, google, source_code_files, social_media_account, docker\n- leaks: leak, mitigated_credential, valid_credential, invalid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -3329,7 +3329,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: listing, ransomleak, financial_data, chat_message, blog_post, forum_topic, forum_profile, seller, stealer_log, forum_post, bot\n- open_web: docker, bucket_object, google, paste, source_code_files, service, social_media_account, source_code_secrets, stack_exchange, bucket\n- leaks: valid_credential, mitigated_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, financial_data, chat_message, forum_profile, blog_post, bot, seller, listing, stealer_log, forum_post, forum_topic\n- open_web: source_code_secrets, bucket_object, paste, stack_exchange, service, bucket, google, source_code_files, social_media_account, docker\n- leaks: leak, mitigated_credential, valid_credential, invalid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -3612,7 +3612,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: listing, ransomleak, financial_data, chat_message, blog_post, forum_topic, forum_profile, seller, stealer_log, forum_post, bot\n- open_web: docker, bucket_object, google, paste, source_code_files, service, social_media_account, source_code_secrets, stack_exchange, bucket\n- leaks: valid_credential, mitigated_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, financial_data, chat_message, forum_profile, blog_post, bot, seller, listing, stealer_log, forum_post, forum_topic\n- open_web: source_code_secrets, bucket_object, paste, stack_exchange, service, bucket, google, source_code_files, social_media_account, docker\n- leaks: leak, mitigated_credential, valid_credential, invalid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -4740,7 +4740,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: listing, ransomleak, financial_data, chat_message, blog_post, forum_topic, forum_profile, seller, stealer_log, forum_post, bot\n- open_web: docker, bucket_object, google, paste, source_code_files, service, social_media_account, source_code_secrets, stack_exchange, bucket\n- leaks: valid_credential, mitigated_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, financial_data, chat_message, forum_profile, blog_post, bot, seller, listing, stealer_log, forum_post, forum_topic\n- open_web: source_code_secrets, bucket_object, paste, stack_exchange, service, bucket, google, source_code_files, social_media_account, docker\n- leaks: leak, mitigated_credential, valid_credential, invalid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -5044,7 +5044,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: listing, ransomleak, financial_data, chat_message, blog_post, forum_topic, forum_profile, seller, stealer_log, forum_post, bot\n- open_web: docker, bucket_object, google, paste, source_code_files, service, social_media_account, source_code_secrets, stack_exchange, bucket\n- leaks: valid_credential, mitigated_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, financial_data, chat_message, forum_profile, blog_post, bot, seller, listing, stealer_log, forum_post, forum_topic\n- open_web: source_code_secrets, bucket_object, paste, stack_exchange, service, bucket, google, source_code_files, social_media_account, docker\n- leaks: leak, mitigated_credential, valid_credential, invalid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -5543,7 +5543,12 @@ "secret", "azure_tenant", "identity", - "ransomleak" + "ransomleak", + "external_id", + "address_data", + "birth_year", + "role", + "phone_number" ], "example": "domain", "type": "string" @@ -5551,33 +5556,33 @@ "search_types": { "items": { "enum": [ - "bucket_object", - "listing", - "google", - "invalid_credential", - "seller", - "stealer_log", - "domain", - "leak", - "docker", - "chat_message", - "service", - "social_media_account", - "ransomleak", - "paste", - "source_code_files", - "blog_post", - "mitigated_credential", - "forum_topic", "source_code_secrets", - "forum_post", - "bucket", "financial_data", "forum_profile", - "valid_credential", "stack_exchange", + "service", + "domain", + "invalid_credential", + "bucket", + "blog_post", + "seller", + "valid_credential", + "forum_topic", + "chat_message", "ad", + "bucket_object", "bot", + "paste", + "mitigated_credential", + "stealer_log", + "ransomleak", + "google", + "listing", + "leak", + "source_code_files", + "social_media_account", + "forum_post", + "docker", "illicit_networks", "open_web", "buckets", @@ -5591,7 +5596,7 @@ "infected_devices", "social_media" ], - "example": "bucket_object", + "example": "source_code_secrets", "type": "string" }, "type": "array" @@ -5646,7 +5651,12 @@ "secret", "azure_tenant", "identity", - "ransomleak" + "ransomleak", + "external_id", + "address_data", + "birth_year", + "role", + "phone_number" ], "example": "domain", "type": "string" @@ -5654,32 +5664,32 @@ "search_types": { "items": { "enum": [ - "bucket_object", - "listing", - "google", + "source_code_secrets", + "financial_data", + "forum_profile", + "stack_exchange", + "service", + "domain", "invalid_credential", + "bucket", + "blog_post", "seller", - "stealer_log", - "domain", - "leak", - "docker", + "valid_credential", + "forum_topic", "chat_message", - "service", - "social_media_account", - "ransomleak", + "bucket_object", + "bot", "paste", - "source_code_files", - "blog_post", "mitigated_credential", - "forum_topic", - "source_code_secrets", + "stealer_log", + "ransomleak", + "google", + "listing", + "leak", + "source_code_files", + "social_media_account", "forum_post", - "bucket", - "financial_data", - "forum_profile", - "valid_credential", - "stack_exchange", - "bot", + "docker", "illicit_networks", "open_web", "buckets", @@ -5692,7 +5702,7 @@ "infected_devices", "social_media" ], - "example": "bucket_object", + "example": "source_code_secrets", "type": "string" }, "type": "array" @@ -5740,8 +5750,7 @@ "SELF_ONBOARDING", "ATTRIBUTE", "AUTO_MONITOR", - "IDP_SYNC", - "VIP_PROTECTION" + "IDP_SYNC" ], "example": "USER", "type": "string" @@ -5965,80 +5974,6 @@ }, "type": "object" }, - "Organization": { - "properties": { - "id": { - "type": "integer" - }, - "name": { - "description": "Display name", - "type": "string" - }, - "type": { - "enum": [ - "direct", - "service-firm", - "training" - ], - "example": "direct", - "type": "string" - }, - "settings": { - "$ref": "#/components/schemas/OrganizationSettings" - }, - "file_analysis_enabled": { - "type": "boolean" - }, - "user_limit": { - "type": "integer" - }, - "access_level": { - "type": "integer" - }, - "urn": { - "description": "The uniform resource name of the organization.", - "type": "string" - }, - "access_end_at": { - "format": "date-time", - "type": "string" - }, - "archived_at": { - "format": "date-time", - "type": "string" - }, - "authorization_workflow_enabled": { - "type": "boolean" - }, - "allow_support_access": { - "type": "boolean" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "OrganizationSettings": { - "properties": { - "permissions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "through_distributor": { - "type": "boolean" - }, - "hs_takedown_properties": { - "type": "object" - } - }, - "type": "object" - }, - "OrganizationHSProperties": { - "type": "object" - }, "NewTenantInfo": { "properties": { "name": { @@ -6144,43 +6079,6 @@ }, "type": "object" }, - "AuditEvent": { - "properties": { - "id": { - "type": "integer" - }, - "user_id": { - "type": "integer" - }, - "organization_id": { - "type": "integer" - }, - "created_at": { - "format": "date-time", - "type": "string" - }, - "data": { - "properties": {}, - "type": "object" - }, - "original_data": { - "properties": {}, - "type": "object" - }, - "affected_entities": { - "properties": {}, - "type": "object" - }, - "actor_data": { - "properties": {}, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, "OrganizationMemberData": { "properties": { "name": { @@ -6337,23 +6235,6 @@ ], "type": "object" }, - "OrganizationMonthlyUsage": { - "properties": { - "timestamp": { - "type": "string" - }, - "identifier_count": { - "type": "integer" - }, - "idp_synced_identifier_count": { - "type": "integer" - }, - "global_search_calls_count": { - "type": "integer" - } - }, - "type": "object" - }, "HighlightPayload": { "properties": { "query_string": { @@ -6733,222 +6614,64 @@ ], "type": "object" }, - "GroupedFeedAlerts": { + "TenantData": { "properties": { - "key": { + "name": { + "description": "The Tenant display name", "type": "string" }, - "type": { + "description": { + "description": "The Tenant's purpose / description", "type": "string" }, - "params": { - "properties": {}, - "type": "object" - }, - "alerts": { - "$ref": "#/components/schemas/FeedAlert" - }, - "organization_settings": { - "$ref": "#/components/schemas/OrganizationSettings" - } - }, - "required": [ - "alerts", - "key", - "organization_settings", - "params", - "type" - ], - "type": "object" - }, - "AlertUpdate": { - "properties": { - "id": { + "number_of_employees": { + "description": "The number of employees for the tenant", "type": "integer" }, - "processed_at": { - "format": "date", + "industry": { + "description": "The Tenant's industry", + "enum": [ + "global", + "transport", + "education", + "energy", + "finance", + "healthcare", + "manufacturing", + "retail", + "software", + "telecommunication" + ], + "example": "global", "type": "string" }, - "last_result_date": { - "format": "date", - "type": "string" - } - }, - "type": "object" - }, - "PageView": { - "properties": { - "route": { - "type": "string" + "global_search_calls_limit": { + "description": "The number of API calls allowed for the tenant.", + "type": "integer" }, - "created_at": { - "format": "date-time", - "type": "string" + "prevent_global_search": { + "type": "boolean" } }, "required": [ - "route" + "description", + "industry", + "name", + "number_of_employees" ], "type": "object" }, - "TenantIgnoredTerms": { + "UserTenantAccessRequest": { "properties": { - "uuid": { - "type": "string" - }, - "name": { - "type": "string" - }, - "terms": { + "users": { "items": { - "type": "string" - }, - "type": "array" - }, - "search_types": { - "items": { - "enum": [ - "attachment", - "listing", - "ransomleak", - "forum_post", - "forum_topic", - "forum_profile", - "blog_post", - "seller", - "paste", - "leak", - "chat_message", - "domain", - "bot", - "stealer_log", - "infected_devices", - "driller", - "driller_forum_topic", - "driller_forum_post", - "driller_profile", - "cc", - "ccbin", - "financial_data", - "leaked_data", - "leaked_file", - "document", - "account", - "actor", - "forum_content", - "blog_content", - "profile", - "leaked_credential", - "valid_credential", - "invalid_credential", - "mitigated_credential", - "illicit_networks", - "open_web", - "domains", - "intelligence_object", - "leaks", - "social_media_account", - "social_media", - "source_code", - "source_code_secrets_np", - "source_code_secrets", - "source_code_files", - "docker", - "stack_exchange", - "google", - "service", - "driller_host", - "buckets", - "bucket", - "bucket_object", - "whois", - "ad", - "ads", - "cookie", - "pii", - "experimental" - ], - "example": "attachment", - "type": "string" - }, - "type": "array" - }, - "created_at": { - "format": "date-time", - "type": "string" - }, - "clean_past_events": { - "type": "boolean" - } - }, - "required": [ - "clean_past_events", - "created_at", - "name", - "search_types", - "uuid" - ], - "type": "object" - }, - "TenantData": { - "properties": { - "name": { - "description": "The Tenant display name", - "type": "string" - }, - "description": { - "description": "The Tenant's purpose / description", - "type": "string" - }, - "number_of_employees": { - "description": "The number of employees for the tenant", - "type": "integer" - }, - "industry": { - "description": "The Tenant's industry", - "enum": [ - "global", - "transport", - "education", - "energy", - "finance", - "healthcare", - "manufacturing", - "retail", - "software", - "telecommunication" - ], - "example": "global", - "type": "string" - }, - "global_search_calls_limit": { - "description": "The number of API calls allowed for the tenant.", - "type": "integer" - }, - "prevent_global_search": { - "type": "boolean" - } - }, - "required": [ - "description", - "industry", - "name", - "number_of_employees" - ], - "type": "object" - }, - "UserTenantAccessRequest": { - "properties": { - "users": { - "items": { - "allOf": [ - { - "$ref": "#/components/schemas/UserTenantAccess" - } - ], - "description": "User given access to a tenant.", - "type": "object" + "allOf": [ + { + "$ref": "#/components/schemas/UserTenantAccess" + } + ], + "description": "User given access to a tenant.", + "type": "object" }, "type": "array" } @@ -7024,56 +6747,6 @@ }, "type": "object" }, - "TenantDiscoveryPolicy": { - "properties": { - "id": { - "type": "integer" - }, - "tenant_id": { - "type": "integer" - }, - "type": { - "enum": [ - "auto-accept", - "ignore-pattern" - ], - "example": "auto-accept", - "type": "string" - }, - "identifier_types": { - "items": { - "enum": [ - "domain", - "name", - "keyword", - "github_repository", - "username", - "email", - "search_query", - "bin", - "ip", - "secret", - "azure_tenant", - "identity", - "ransomleak" - ], - "example": "domain", - "type": "string" - }, - "type": "array" - }, - "terms": { - "items": { - "type": "string" - }, - "type": "array" - }, - "enabled": { - "type": "boolean" - } - }, - "type": "object" - }, "NewReport": { "properties": { "title": { @@ -7154,609 +6827,6 @@ }, "type": "object" }, - "PriorityActionHeader": { - "properties": { - "uuid": { - "type": "string" - }, - "type": { - "type": "string" - }, - "status": { - "type": "string" - }, - "created_at": { - "format": "date-time", - "type": "string" - }, - "status_last_updated_at": { - "format": "date-time", - "type": "string" - }, - "snooze_until": { - "format": "date-time", - "type": "string" - }, - "title": { - "$ref": "#/components/schemas/InsightText" - }, - "summary": { - "$ref": "#/components/schemas/InsightText" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "created_at", - "snooze_until", - "status", - "status_last_updated_at", - "tags", - "title", - "type", - "uuid" - ], - "type": "object" - }, - "InsightText": { - "properties": { - "text": { - "description": "Text for the insight", - "type": "string" - }, - "params": { - "description": "Relevant data related to the text", - "properties": {}, - "type": "object" - } - }, - "required": [ - "text" - ], - "type": "object" - }, - "Details": { - "properties": { - "title": { - "$ref": "#/components/schemas/InsightText" - }, - "summary": { - "$ref": "#/components/schemas/InsightText" - } - }, - "required": [ - "title" - ], - "type": "object" - }, - "Mitre": { - "properties": { - "techniques": { - "$ref": "#/components/schemas/MitreLink" - }, - "mitigation": { - "$ref": "#/components/schemas/MitreLink" - } - }, - "required": [ - "mitigation", - "techniques" - ], - "type": "object" - }, - "MitreLink": { - "properties": { - "id": { - "description": "Mitre's id", - "type": "string" - }, - "text": { - "description": "Mitre's text", - "type": "string" - }, - "url": { - "description": "Link to the Mitre url page", - "type": "string" - } - }, - "required": [ - "id", - "text", - "url" - ], - "type": "object" - }, - "PriorityActionRelatedActivity": { - "properties": { - "uuid": { - "type": "string" - }, - "tenant_id": { - "type": "integer" - }, - "uid": { - "type": "string" - }, - "remediated": { - "type": "boolean" - } - }, - "required": [ - "remediated", - "tenant_id", - "uid", - "uuid" - ], - "type": "object" - }, - "ExportPriorityActionVisualizationData": { - "properties": { - "stream": { - "type": "string" - }, - "format": { - "enum": [ - "csv" - ], - "example": "csv", - "type": "string" - } - }, - "required": [ - "format", - "stream" - ], - "type": "object" - }, - "Insight": { - "properties": { - "type": { - "type": "string" - }, - "date": { - "format": "date-time", - "type": "string" - }, - "title": { - "$ref": "#/components/schemas/InsightText" - }, - "paragraph": { - "$ref": "#/components/schemas/InsightText" - }, - "analysis": { - "$ref": "#/components/schemas/InsightText" - }, - "visualization": { - "items": { - "$ref": "#/components/schemas/FootprintVisualizationChart" - }, - "type": "array" - } - }, - "required": [ - "analysis", - "date", - "paragraph", - "title", - "type" - ], - "type": "object" - }, - "FootprintVisualizationChart": { - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "comparison_chart", - "tabular_chart", - "radial_chart", - "line_chart", - "bar_chart", - "radar_chart" - ], - "example": "comparison_chart", - "type": "string" - }, - "data": { - "properties": {}, - "type": "object" - }, - "title": { - "type": "string" - } - }, - "required": [ - "data", - "id", - "type" - ], - "type": "object" - }, - "RansomLeakData": { - "properties": { - "uid": { - "description": "event uid of the ransomleak", - "type": "string" - }, - "breached_at": { - "description": "Date of the ransomleak", - "format": "date-time", - "type": "string" - }, - "event_created_at": { - "description": "Date of the ransomleak event in the feed", - "format": "date-time", - "type": "string" - }, - "risk_score": { - "description": "Computed risk of the ransomleak", - "type": "integer" - }, - "publisher": { - "description": "Publisher of the ransomleak", - "type": "string" - }, - "victim": { - "description": "Victim of the ransomleak", - "type": "string" - }, - "domain": { - "description": "Domain of the victim", - "type": "string" - }, - "country": { - "description": "Country of the victim", - "type": "string" - }, - "industry": { - "description": "Industry of the victim", - "type": "string" - }, - "employee_count": { - "description": "Number of employee of the victim", - "type": "integer" - }, - "user_metadata": { - "$ref": "#/components/schemas/ActivityUserMetadata" - }, - "identifiers": { - "items": { - "$ref": "#/components/schemas/RansomLeakIdentifierData" - }, - "type": "array" - } - }, - "required": [ - "breached_at", - "event_created_at", - "identifiers", - "publisher", - "risk_score", - "uid", - "victim" - ], - "type": "object" - }, - "RansomLeakIdentifierData": { - "properties": { - "id": { - "type": "integer" - }, - "identifier_type": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "type": "object" - }, - "date_count": { - "properties": { - "date": { - "format": "date-time", - "type": "string" - }, - "count": { - "type": "integer" - } - }, - "type": "object" - }, - "Import": { - "properties": { - "id": { - "type": "integer" - }, - "type": { - "enum": [ - "identifiers" - ], - "example": "identifiers", - "type": "string" - }, - "integration": { - "enum": [ - "csv" - ], - "example": "csv", - "type": "string" - }, - "tenant_id": { - "type": "integer" - } - }, - "required": [ - "id", - "integration", - "tenant_id", - "type" - ], - "type": "object" - }, - "ImportItemFailures": { - "properties": { - "type": { - "enum": [ - "unknown_identifier_type", - "bad_identifier_query", - "above_max_group_nesting", - "unknown_identifier_source", - "identifier_not_allowed", - "identifier_type_not_allowed", - "too_many_attributes", - "invalid_attribute_format", - "missing_attributes" - ], - "example": "unknown_identifier_type", - "type": "string" - }, - "message": { - "type": "string" - } - }, - "required": [ - "message", - "type" - ], - "type": "object" - }, - "Subdomains": { - "properties": { - "subdomain": { - "type": "string" - } - }, - "required": [ - "subdomain" - ], - "type": "object" - }, - "CredentialUrl": { - "properties": { - "url": { - "type": "string" - }, - "credential_hash": { - "type": "string" - }, - "domain": { - "type": "string" - }, - "is_stealer_log": { - "type": "boolean" - } - }, - "type": "object" - }, - "PartialSource": { - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "type": "object" - }, - "count_by_search_type": { - "properties": { - "search_type": { - "type": "string" - }, - "values": { - "items": { - "$ref": "#/components/schemas/date_count" - }, - "type": "array" - } - }, - "type": "object" - }, - "count_by_risk_score": { - "properties": { - "risk_score": { - "type": "integer" - }, - "values": { - "items": { - "$ref": "#/components/schemas/date_count" - }, - "type": "array" - } - }, - "type": "object" - }, - "average_by_search_type": { - "properties": { - "search_type": { - "type": "string" - }, - "values": { - "items": { - "$ref": "#/components/schemas/date_count" - }, - "type": "array" - } - }, - "type": "object" - }, - "average_by_risk_score": { - "properties": { - "risk_score": { - "type": "integer" - }, - "values": { - "items": { - "$ref": "#/components/schemas/date_count" - }, - "type": "array" - } - }, - "type": "object" - }, - "IdentifierRelationData": { - "properties": { - "identifier_id": { - "type": "integer" - }, - "asset_relation_uuid": { - "type": "string" - } - }, - "required": [ - "asset_relation_uuid", - "identifier_id" - ], - "type": "object" - }, - "ArchiveFile": { - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "source": { - "type": "string" - }, - "type": { - "type": "string" - }, - "password": { - "type": "string" - }, - "status": { - "type": "string" - }, - "data": { - "$ref": "#/components/schemas/ArchiveFileData" - }, - "ransomleak_uid": { - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/ArchiveFileMetadata" - }, - "status_updated_at": { - "format": "date-time", - "type": "string" - }, - "errors": { - "$ref": "#/components/schemas/ArchiveFileErrors" - }, - "retry_count": { - "type": "integer" - }, - "retry_after": { - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "ArchiveFileData": { - "properties": { - "parts": { - "items": { - "$ref": "#/components/schemas/MultiPartData" - }, - "type": "array" - } - }, - "type": "object" - }, - "MultiPartData": { - "properties": { - "url": { - "type": "string" - }, - "size": { - "type": "integer" - } - }, - "type": "object" - }, - "ArchiveFileMetadata": { - "properties": { - "first_crawled_at": { - "format": "date-time", - "type": "string" - }, - "last_crawled_at": { - "format": "date-time", - "type": "string" - }, - "estimated_created_at": { - "format": "date-time", - "type": "string" - }, - "scraper_id": { - "type": "string" - }, - "scraped_at": { - "format": "date-time", - "type": "string" - }, - "event_id": { - "type": "integer" - }, - "event_id_v2": { - "type": "string" - } - }, - "type": "object" - }, - "ArchiveFileErrors": { - "properties": { - "errors": { - "items": { - "$ref": "#/components/schemas/ArchiveFileErrorData" - }, - "type": "array" - } - }, - "type": "object" - }, - "ArchiveFileErrorData": { - "properties": { - "type": { - "type": "string" - }, - "traceback": { - "type": "string" - } - }, - "type": "object" - }, "get_activity_assistance_resource__activities__string_index___string_source___path_id__ai_assistance_200_response": { "properties": { "activity_ai_assistance": { diff --git a/docs/api-reference/spec/firework-v2-swagger.json b/docs/api-reference/spec/firework-v2-swagger.json index 59452ad0..96294c1f 100644 --- a/docs/api-reference/spec/firework-v2-swagger.json +++ b/docs/api-reference/spec/firework-v2-swagger.json @@ -462,32 +462,13 @@ "type": "string" } ], - "put": { + "delete": { "responses": { "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ActivityUserMetadata" - } - }, - "400": { - "description": "Query is invalid.", - "schema": { - "$ref": "#/definitions/HttpError" - } + "description": "Success" } }, - "operationId": "put_activity_user_metadata_tags_/activities////user_metadata/tags", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/ActivityUserTags" - } - } - ], + "operationId": "delete_activity_user_metadata_tags_/activities////user_metadata/tags", "tags": [ "activities" ] @@ -506,13 +487,32 @@ "activities" ] }, - "delete": { + "put": { "responses": { "200": { - "description": "Success" + "description": "Success", + "schema": { + "$ref": "#/definitions/ActivityUserMetadata" + } + }, + "400": { + "description": "Query is invalid.", + "schema": { + "$ref": "#/definitions/HttpError" + } } }, - "operationId": "delete_activity_user_metadata_tags_/activities////user_metadata/tags", + "operationId": "put_activity_user_metadata_tags_/activities////user_metadata/tags", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/ActivityUserTags" + } + } + ], "tags": [ "activities" ] @@ -1030,36 +1030,13 @@ "type": "integer" } ], - "put": { + "delete": { "responses": { "200": { - "description": "Success", - "schema": { - "properties": { - "assets_group": { - "$ref": "#/definitions/IdentifierGroup" - } - } - } - }, - "400": { - "description": "Query is invalid.", - "schema": { - "$ref": "#/definitions/HttpError" - } + "description": "Success" } }, - "operationId": "put_assets_group_api_/assets/groups/", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/UpdateGroupData" - } - } - ], + "operationId": "delete_assets_group_api_/assets/groups/", "tags": [ "Identifiers" ] @@ -1082,13 +1059,36 @@ "Identifiers" ] }, - "delete": { + "put": { "responses": { "200": { - "description": "Success" + "description": "Success", + "schema": { + "properties": { + "assets_group": { + "$ref": "#/definitions/IdentifierGroup" + } + } + } + }, + "400": { + "description": "Query is invalid.", + "schema": { + "$ref": "#/definitions/HttpError" + } } }, - "operationId": "delete_assets_group_api_/assets/groups/", + "operationId": "put_assets_group_api_/assets/groups/", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/UpdateGroupData" + } + } + ], "tags": [ "Identifiers" ] @@ -1161,6 +1161,17 @@ "type": "integer" } ], + "delete": { + "responses": { + "200": { + "description": "Success" + } + }, + "operationId": "delete_assets_group_alert_/assets/groups//alerts/", + "tags": [ + "Identifiers" + ] + }, "put": { "responses": { "200": { @@ -1184,17 +1195,6 @@ "tags": [ "Identifiers" ] - }, - "delete": { - "responses": { - "200": { - "description": "Success" - } - }, - "operationId": "delete_assets_group_alert_/assets/groups//alerts/", - "tags": [ - "Identifiers" - ] } }, "/firework/v2/assets/groups/{assets_group_id}/feed": { @@ -1284,7 +1284,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: listing, ransomleak, financial_data, chat_message, blog_post, forum_topic, forum_profile, seller, stealer_log, forum_post, bot\n- open_web: docker, bucket_object, google, paste, source_code_files, service, social_media_account, source_code_secrets, stack_exchange, bucket\n- leaks: valid_credential, mitigated_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, financial_data, chat_message, forum_profile, blog_post, bot, seller, listing, stealer_log, forum_post, forum_topic\n- open_web: source_code_secrets, bucket_object, paste, stack_exchange, service, bucket, google, source_code_files, social_media_account, docker\n- leaks: leak, mitigated_credential, valid_credential, invalid_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -1544,7 +1544,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: listing, ransomleak, financial_data, chat_message, blog_post, forum_topic, forum_profile, seller, stealer_log, forum_post, bot\n- open_web: docker, bucket_object, google, paste, source_code_files, service, social_media_account, source_code_secrets, stack_exchange, bucket\n- leaks: valid_credential, mitigated_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, financial_data, chat_message, forum_profile, blog_post, bot, seller, listing, stealer_log, forum_post, forum_topic\n- open_web: source_code_secrets, bucket_object, paste, stack_exchange, service, bucket, google, source_code_files, social_media_account, docker\n- leaks: leak, mitigated_credential, valid_credential, invalid_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -1736,36 +1736,13 @@ "type": "integer" } ], - "put": { + "delete": { "responses": { - "400": { - "description": "Query is invalid.", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, "200": { - "description": "Success", - "schema": { - "properties": { - "asset": { - "$ref": "#/definitions/Identifier" - } - } - } + "description": "Success" } }, - "operationId": "put_asset_api_/assets/", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/Identifier" - } - } - ], + "operationId": "delete_asset_api_/assets/", "tags": [ "Identifiers" ] @@ -1788,13 +1765,36 @@ "Identifiers" ] }, - "delete": { + "put": { "responses": { + "400": { + "description": "Query is invalid.", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, "200": { - "description": "Success" + "description": "Success", + "schema": { + "properties": { + "asset": { + "$ref": "#/definitions/Identifier" + } + } + } } }, - "operationId": "delete_asset_api_/assets/", + "operationId": "put_asset_api_/assets/", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/Identifier" + } + } + ], "tags": [ "Identifiers" ] @@ -1867,6 +1867,17 @@ "type": "integer" } ], + "delete": { + "responses": { + "200": { + "description": "Success" + } + }, + "operationId": "delete_asset_alert_/assets//alerts/", + "tags": [ + "Identifiers" + ] + }, "put": { "responses": { "200": { @@ -1890,17 +1901,6 @@ "tags": [ "Identifiers" ] - }, - "delete": { - "responses": { - "200": { - "description": "Success" - } - }, - "operationId": "delete_asset_alert_/assets//alerts/", - "tags": [ - "Identifiers" - ] } }, "/firework/v2/assets/{asset_id}/feed": { @@ -1990,7 +1990,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: listing, ransomleak, financial_data, chat_message, blog_post, forum_topic, forum_profile, seller, stealer_log, forum_post, bot\n- open_web: docker, bucket_object, google, paste, source_code_files, service, social_media_account, source_code_secrets, stack_exchange, bucket\n- leaks: valid_credential, mitigated_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, financial_data, chat_message, forum_profile, blog_post, bot, seller, listing, stealer_log, forum_post, forum_topic\n- open_web: source_code_secrets, bucket_object, paste, stack_exchange, service, bucket, google, source_code_files, social_media_account, docker\n- leaks: leak, mitigated_credential, valid_credential, invalid_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -2250,7 +2250,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: listing, ransomleak, financial_data, chat_message, blog_post, forum_topic, forum_profile, seller, stealer_log, forum_post, bot\n- open_web: docker, bucket_object, google, paste, source_code_files, service, social_media_account, source_code_secrets, stack_exchange, bucket\n- leaks: valid_credential, mitigated_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, financial_data, chat_message, forum_profile, blog_post, bot, seller, listing, stealer_log, forum_post, forum_topic\n- open_web: source_code_secrets, bucket_object, paste, stack_exchange, service, bucket, google, source_code_files, social_media_account, docker\n- leaks: leak, mitigated_credential, valid_credential, invalid_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -2579,7 +2579,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: listing, ransomleak, financial_data, chat_message, blog_post, forum_topic, forum_profile, seller, stealer_log, forum_post, bot\n- open_web: docker, bucket_object, google, paste, source_code_files, service, social_media_account, source_code_secrets, stack_exchange, bucket\n- leaks: valid_credential, mitigated_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, financial_data, chat_message, forum_profile, blog_post, bot, seller, listing, stealer_log, forum_post, forum_topic\n- open_web: source_code_secrets, bucket_object, paste, stack_exchange, service, bucket, google, source_code_files, social_media_account, docker\n- leaks: leak, mitigated_credential, valid_credential, invalid_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -2817,7 +2817,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: listing, ransomleak, financial_data, chat_message, blog_post, forum_topic, forum_profile, seller, stealer_log, forum_post, bot\n- open_web: docker, bucket_object, google, paste, source_code_files, service, social_media_account, source_code_secrets, stack_exchange, bucket\n- leaks: valid_credential, mitigated_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, financial_data, chat_message, forum_profile, blog_post, bot, seller, listing, stealer_log, forum_post, forum_topic\n- open_web: source_code_secrets, bucket_object, paste, stack_exchange, service, bucket, google, source_code_files, social_media_account, docker\n- leaks: leak, mitigated_credential, valid_credential, invalid_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -3064,6 +3064,17 @@ } }, "/firework/v2/me/profile": { + "get": { + "responses": { + "200": { + "description": "Returns the current user's profile" + } + }, + "operationId": "get_current_user_profile_/me/profile", + "tags": [ + "me" + ] + }, "put": { "responses": { "400": { @@ -3097,17 +3108,6 @@ "tags": [ "me" ] - }, - "get": { - "responses": { - "200": { - "description": "Returns the current user's profile" - } - }, - "operationId": "get_current_user_profile_/me/profile", - "tags": [ - "me" - ] } }, "/firework/v2/me/tenants": { @@ -3250,7 +3250,7 @@ "type": "integer" } ], - "put": { + "get": { "responses": { "200": { "description": "Success", @@ -3263,22 +3263,12 @@ } } }, - "operationId": "put_organization_member_api_/organizations//members/", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/OrganizationMember" - } - } - ], + "operationId": "get_organization_member_api_/organizations//members/", "tags": [ "organizations" ] }, - "get": { + "put": { "responses": { "200": { "description": "Success", @@ -3291,7 +3281,17 @@ } } }, - "operationId": "get_organization_member_api_/organizations//members/", + "operationId": "put_organization_member_api_/organizations//members/", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/OrganizationMember" + } + } + ], "tags": [ "organizations" ] @@ -3721,7 +3721,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: listing, ransomleak, financial_data, chat_message, blog_post, forum_topic, forum_profile, seller, stealer_log, forum_post, bot\n- open_web: docker, bucket_object, google, paste, source_code_files, service, social_media_account, source_code_secrets, stack_exchange, bucket\n- leaks: valid_credential, mitigated_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, financial_data, chat_message, forum_profile, blog_post, bot, seller, listing, stealer_log, forum_post, forum_topic\n- open_web: source_code_secrets, bucket_object, paste, stack_exchange, service, bucket, google, source_code_files, social_media_account, docker\n- leaks: leak, mitigated_credential, valid_credential, invalid_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -3973,7 +3973,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: listing, ransomleak, financial_data, chat_message, blog_post, forum_topic, forum_profile, seller, stealer_log, forum_post, bot\n- open_web: docker, bucket_object, google, paste, source_code_files, service, social_media_account, source_code_secrets, stack_exchange, bucket\n- leaks: valid_credential, mitigated_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: ransomleak, financial_data, chat_message, forum_profile, blog_post, bot, seller, listing, stealer_log, forum_post, forum_topic\n- open_web: source_code_secrets, bucket_object, paste, stack_exchange, service, bucket, google, source_code_files, social_media_account, docker\n- leaks: leak, mitigated_credential, valid_credential, invalid_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -4163,7 +4163,7 @@ "type": "integer" } ], - "put": { + "get": { "responses": { "200": { "description": "Success", @@ -4172,22 +4172,12 @@ } } }, - "operationId": "put_tenant_api_/tenants/", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/TenantData" - } - } - ], + "operationId": "get_tenant_api_/tenants/", "tags": [ "tenants" ] }, - "get": { + "put": { "responses": { "200": { "description": "Success", @@ -4196,7 +4186,17 @@ } } }, - "operationId": "get_tenant_api_/tenants/", + "operationId": "put_tenant_api_/tenants/", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/TenantData" + } + } + ], "tags": [ "tenants" ] @@ -4417,42 +4417,47 @@ "secret", "azure_tenant", "identity", - "ransomleak" + "ransomleak", + "external_id", + "address_data", + "birth_year", + "role", + "phone_number" ] }, "search_types": { "type": "array", "items": { "type": "string", - "example": "bucket_object", + "example": "source_code_secrets", "enum": [ - "bucket_object", - "listing", - "google", - "invalid_credential", - "seller", - "stealer_log", - "domain", - "leak", - "docker", - "chat_message", - "service", - "social_media_account", - "ransomleak", - "paste", - "source_code_files", - "blog_post", - "mitigated_credential", - "forum_topic", "source_code_secrets", - "forum_post", - "bucket", "financial_data", "forum_profile", - "valid_credential", "stack_exchange", + "service", + "domain", + "invalid_credential", + "bucket", + "blog_post", + "seller", + "valid_credential", + "forum_topic", + "chat_message", "ad", + "bucket_object", "bot", + "paste", + "mitigated_credential", + "stealer_log", + "ransomleak", + "google", + "listing", + "leak", + "source_code_files", + "social_media_account", + "forum_post", + "docker", "illicit_networks", "open_web", "buckets", @@ -4519,41 +4524,46 @@ "secret", "azure_tenant", "identity", - "ransomleak" + "ransomleak", + "external_id", + "address_data", + "birth_year", + "role", + "phone_number" ] }, "search_types": { "type": "array", "items": { "type": "string", - "example": "bucket_object", + "example": "source_code_secrets", "enum": [ - "bucket_object", - "listing", - "google", + "source_code_secrets", + "financial_data", + "forum_profile", + "stack_exchange", + "service", + "domain", "invalid_credential", + "bucket", + "blog_post", "seller", - "stealer_log", - "domain", - "leak", - "docker", + "valid_credential", + "forum_topic", "chat_message", - "service", - "social_media_account", - "ransomleak", + "bucket_object", + "bot", "paste", - "source_code_files", - "blog_post", "mitigated_credential", - "forum_topic", - "source_code_secrets", + "stealer_log", + "ransomleak", + "google", + "listing", + "leak", + "source_code_files", + "social_media_account", "forum_post", - "bucket", - "financial_data", - "forum_profile", - "valid_credential", - "stack_exchange", - "bot", + "docker", "illicit_networks", "open_web", "buckets", @@ -4619,8 +4629,7 @@ "SELF_ONBOARDING", "ATTRIBUTE", "AUTO_MONITOR", - "IDP_SYNC", - "VIP_PROTECTION" + "IDP_SYNC" ] }, "data_updated_at": { @@ -6198,7 +6207,12 @@ "secret", "azure_tenant", "identity", - "ransomleak" + "ransomleak", + "external_id", + "address_data", + "birth_year", + "role", + "phone_number" ] } }, diff --git a/docs/api-reference/spec/firework-v3-openapi.json b/docs/api-reference/spec/firework-v3-openapi.json index 96d6bd6f..c44b053f 100644 --- a/docs/api-reference/spec/firework-v3-openapi.json +++ b/docs/api-reference/spec/firework-v3-openapi.json @@ -291,6 +291,7 @@ "account", "azure_tenant", "bin", + "birth_year", "brand", "credentials", "cve", @@ -302,8 +303,8 @@ "file", "filename", "canonical_name", - "country", "github_repository", + "address_data", "ip", "ipv6_addr", "keyword", @@ -311,7 +312,9 @@ "mitre_technique", "mutex", "name", + "phone_number", "ransomleak", + "role", "screenshot", "search_query", "secret", @@ -350,6 +353,7 @@ "account", "azure_tenant", "bin", + "birth_year", "brand", "credentials", "cve", @@ -361,8 +365,8 @@ "file", "filename", "canonical_name", - "country", "github_repository", + "address_data", "ip", "ipv6_addr", "keyword", @@ -370,7 +374,9 @@ "mitre_technique", "mutex", "name", + "phone_number", "ransomleak", + "role", "screenshot", "search_query", "secret", @@ -563,7 +569,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, chat_message, listing, financial_data, forum_profile, stealer_log, bot, seller, blog_post, forum_topic, ransomleak\n- open_web: paste, service, social_media_account, bucket_object, bucket, source_code_files, source_code_secrets, stack_exchange, google, docker\n- leaks: mitigated_credential, leak, invalid_credential, valid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, seller, listing, forum_topic, financial_data, chat_message, forum_post, stealer_log, blog_post, ransomleak, bot\n- open_web: stack_exchange, google, bucket, service, paste, social_media_account, bucket_object, source_code_files, docker, source_code_secrets\n- leaks: invalid_credential, leak, mitigated_credential, valid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -887,7 +893,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, chat_message, listing, financial_data, forum_profile, stealer_log, bot, seller, blog_post, forum_topic, ransomleak\n- open_web: paste, service, social_media_account, bucket_object, bucket, source_code_files, source_code_secrets, stack_exchange, google, docker\n- leaks: mitigated_credential, leak, invalid_credential, valid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, seller, listing, forum_topic, financial_data, chat_message, forum_post, stealer_log, blog_post, ransomleak, bot\n- open_web: stack_exchange, google, bucket, service, paste, social_media_account, bucket_object, source_code_files, docker, source_code_secrets\n- leaks: invalid_credential, leak, mitigated_credential, valid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -1205,6 +1211,7 @@ "account", "azure_tenant", "bin", + "birth_year", "brand", "credentials", "cve", @@ -1216,8 +1223,8 @@ "file", "filename", "canonical_name", - "country", "github_repository", + "address_data", "ip", "ipv6_addr", "keyword", @@ -1225,7 +1232,9 @@ "mitre_technique", "mutex", "name", + "phone_number", "ransomleak", + "role", "screenshot", "search_query", "secret", @@ -1412,7 +1421,12 @@ "secret", "azure_tenant", "identity", - "ransomleak" + "ransomleak", + "external_id", + "address_data", + "birth_year", + "role", + "phone_number" ], "items": { "type": "string" @@ -1556,7 +1570,12 @@ "secret", "azure_tenant", "identity", - "ransomleak" + "ransomleak", + "external_id", + "address_data", + "birth_year", + "role", + "phone_number" ], "items": { "type": "string" @@ -1819,7 +1838,12 @@ "secret", "azure_tenant", "identity", - "ransomleak" + "ransomleak", + "external_id", + "address_data", + "birth_year", + "role", + "phone_number" ], "items": { "type": "string" @@ -1913,6 +1937,7 @@ "account", "azure_tenant", "bin", + "birth_year", "brand", "credentials", "cve", @@ -1924,8 +1949,8 @@ "file", "filename", "canonical_name", - "country", "github_repository", + "address_data", "ip", "ipv6_addr", "keyword", @@ -1933,7 +1958,9 @@ "mitre_technique", "mutex", "name", + "phone_number", "ransomleak", + "role", "screenshot", "search_query", "secret", @@ -2263,7 +2290,12 @@ "secret", "azure_tenant", "identity", - "ransomleak" + "ransomleak", + "external_id", + "address_data", + "birth_year", + "role", + "phone_number" ], "example": "domain", "type": "string" @@ -2380,8 +2412,7 @@ "SELF_ONBOARDING", "ATTRIBUTE", "AUTO_MONITOR", - "IDP_SYNC", - "VIP_PROTECTION" + "IDP_SYNC" ], "example": "USER", "type": "string" @@ -2539,42 +2570,6 @@ }, "type": "object" }, - "BulkActionFilters": { - "properties": { - "recommendation_state": { - "enum": [ - "recommended", - "accepted", - "rejected" - ], - "example": "recommended", - "type": "string" - }, - "types": { - "enum": [ - "domain", - "name", - "keyword", - "github_repository", - "username", - "email", - "search_query", - "bin", - "ip", - "secret", - "azure_tenant", - "identity", - "ransomleak" - ], - "example": "domain", - "type": "string" - }, - "q": { - "type": "string" - } - }, - "type": "object" - }, "PaginatedCredentials": { "properties": { "next": { @@ -2661,199 +2656,6 @@ ], "type": "object" }, - "IdentifierRecommendation": { - "properties": { - "id": { - "type": "integer" - }, - "asset_id": { - "type": "integer" - }, - "asset": { - "$ref": "#/components/schemas/Asset" - }, - "tenant_id": { - "type": "integer" - }, - "reasons": { - "items": { - "$ref": "#/components/schemas/Reason" - }, - "type": "array" - }, - "state": { - "enum": [ - "recommended", - "accepted", - "rejected" - ], - "example": "recommended", - "type": "string" - }, - "updated_at": { - "format": "date-time", - "type": "string" - }, - "asset_name": { - "type": "string" - }, - "recommendation_group_id": { - "type": "integer" - }, - "relevancy_score_type": { - "enum": [ - "HIGH", - "MEDIUM", - "LOW" - ], - "example": "HIGH", - "type": "string" - } - }, - "type": "object" - }, - "Reason": { - "properties": { - "from_identifier_id": { - "type": "integer" - }, - "from_asset_name": { - "type": "string" - }, - "recommendation_pipeline_id": { - "enum": [ - "email_from_domain", - "username_from_email", - "email_from_username", - "activity_discovery", - "subdomain_from_domain", - "azure_tenant_from_domain", - "domain_from_azure_tenant", - "llm_based" - ], - "example": "email_from_domain", - "type": "string" - }, - "seen_at": { - "format": "date-time", - "type": "string" - }, - "reason": { - "type": "string" - } - }, - "type": "object" - }, - "IdentifierRecommendationGroupWithEnrichments": { - "properties": { - "id": { - "type": "integer" - }, - "tenant_id": { - "type": "integer" - }, - "group_type": { - "enum": [ - "identifiers", - "llm" - ], - "example": "identifiers", - "type": "string" - }, - "filtered_recommendations_count": { - "type": "integer" - }, - "total_recommendations_count": { - "type": "integer" - }, - "available_asset_types": { - "items": { - "type": "string" - }, - "type": "array" - }, - "available_relevancy_score_types": { - "items": { - "type": "string" - }, - "type": "array" - }, - "last_updated_at": { - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "IdentifierRecommendationGroup": { - "properties": { - "id": { - "type": "integer" - }, - "tenant_id": { - "type": "integer" - }, - "group_type": { - "enum": [ - "identifiers", - "llm" - ], - "example": "identifiers", - "type": "string" - } - }, - "type": "object" - }, - "CollectionUpdate": { - "properties": { - "type": { - "type": "string" - }, - "date": { - "type": "string" - }, - "content": { - "type": "string" - } - }, - "type": "object" - }, - "MonitoredChannel": { - "properties": { - "conversation_id": { - "type": "integer" - }, - "conversation_uid": { - "type": "string" - }, - "source": { - "type": "string" - }, - "title": { - "type": "string" - }, - "description": { - "type": "string" - }, - "category": { - "type": "string" - }, - "subcategory": { - "type": "string" - }, - "last_crawled_at": { - "format": "date-time", - "type": "string" - }, - "message_count": { - "type": "integer" - }, - "member_count": { - "type": "integer" - } - }, - "type": "object" - }, "PaginatedCursoredCredentials": { "properties": { "next": { diff --git a/docs/api-reference/spec/firework-v3-swagger.json b/docs/api-reference/spec/firework-v3-swagger.json index f7def6e4..c15d710d 100644 --- a/docs/api-reference/spec/firework-v3-swagger.json +++ b/docs/api-reference/spec/firework-v3-swagger.json @@ -228,6 +228,7 @@ "account", "azure_tenant", "bin", + "birth_year", "brand", "credentials", "cve", @@ -239,8 +240,8 @@ "file", "filename", "canonical_name", - "country", "github_repository", + "address_data", "ip", "ipv6_addr", "keyword", @@ -248,7 +249,9 @@ "mitre_technique", "mutex", "name", + "phone_number", "ransomleak", + "role", "screenshot", "search_query", "secret", @@ -285,6 +288,7 @@ "account", "azure_tenant", "bin", + "birth_year", "brand", "credentials", "cve", @@ -296,8 +300,8 @@ "file", "filename", "canonical_name", - "country", "github_repository", + "address_data", "ip", "ipv6_addr", "keyword", @@ -305,7 +309,9 @@ "mitre_technique", "mutex", "name", + "phone_number", "ransomleak", + "role", "screenshot", "search_query", "secret", @@ -403,7 +409,7 @@ "type": "string" } ], - "get": { + "post": { "responses": { "403": { "description": "Forbidden.", @@ -424,7 +430,7 @@ } } }, - "operationId": "get_asset_feeds_api_/assets//feed", + "operationId": "post_asset_feeds_api_/assets//feed", "parameters": [ { "name": "fields", @@ -481,7 +487,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, chat_message, listing, financial_data, forum_profile, stealer_log, bot, seller, blog_post, forum_topic, ransomleak\n- open_web: paste, service, social_media_account, bucket_object, bucket, source_code_files, source_code_secrets, stack_exchange, google, docker\n- leaks: mitigated_credential, leak, invalid_credential, valid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, seller, listing, forum_topic, financial_data, chat_message, forum_post, stealer_log, blog_post, ransomleak, bot\n- open_web: stack_exchange, google, bucket, service, paste, social_media_account, bucket_object, source_code_files, docker, source_code_secrets\n- leaks: invalid_credential, leak, mitigated_credential, valid_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -663,7 +669,7 @@ "assets" ] }, - "post": { + "get": { "responses": { "403": { "description": "Forbidden.", @@ -684,7 +690,7 @@ } } }, - "operationId": "post_asset_feeds_api_/assets//feed", + "operationId": "get_asset_feeds_api_/assets//feed", "parameters": [ { "name": "fields", @@ -741,7 +747,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, chat_message, listing, financial_data, forum_profile, stealer_log, bot, seller, blog_post, forum_topic, ransomleak\n- open_web: paste, service, social_media_account, bucket_object, bucket, source_code_files, source_code_secrets, stack_exchange, google, docker\n- leaks: mitigated_credential, leak, invalid_credential, valid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, seller, listing, forum_topic, financial_data, chat_message, forum_post, stealer_log, blog_post, ransomleak, bot\n- open_web: stack_exchange, google, bucket, service, paste, social_media_account, bucket_object, source_code_files, docker, source_code_secrets\n- leaks: invalid_credential, leak, mitigated_credential, valid_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -1002,6 +1008,7 @@ "account", "azure_tenant", "bin", + "birth_year", "brand", "credentials", "cve", @@ -1013,8 +1020,8 @@ "file", "filename", "canonical_name", - "country", "github_repository", + "address_data", "ip", "ipv6_addr", "keyword", @@ -1022,7 +1029,9 @@ "mitre_technique", "mutex", "name", + "phone_number", "ransomleak", + "role", "screenshot", "search_query", "secret", @@ -1186,7 +1195,12 @@ "secret", "azure_tenant", "identity", - "ransomleak" + "ransomleak", + "external_id", + "address_data", + "birth_year", + "role", + "phone_number" ] }, { @@ -1304,7 +1318,12 @@ "secret", "azure_tenant", "identity", - "ransomleak" + "ransomleak", + "external_id", + "address_data", + "birth_year", + "role", + "phone_number" ] }, { @@ -1413,6 +1432,20 @@ "type": "integer" } ], + "post": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PaginatedCredentials" + } + } + }, + "operationId": "post_leaked_credentials_feed_endpoint_/identifiers//feed/credentials", + "tags": [ + "identifiers" + ] + }, "get": { "responses": { "200": { @@ -1439,20 +1472,6 @@ "tags": [ "identifiers" ] - }, - "post": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PaginatedCredentials" - } - } - }, - "operationId": "post_leaked_credentials_feed_endpoint_/identifiers//feed/credentials", - "tags": [ - "identifiers" - ] } }, "/firework/v3/identifiers/{identifier_id}/relations": { @@ -1513,7 +1532,12 @@ "secret", "azure_tenant", "identity", - "ransomleak" + "ransomleak", + "external_id", + "address_data", + "birth_year", + "role", + "phone_number" ] }, { @@ -1610,6 +1634,7 @@ "account", "azure_tenant", "bin", + "birth_year", "brand", "credentials", "cve", @@ -1621,8 +1646,8 @@ "file", "filename", "canonical_name", - "country", "github_repository", + "address_data", "ip", "ipv6_addr", "keyword", @@ -1630,7 +1655,9 @@ "mitre_technique", "mutex", "name", + "phone_number", "ransomleak", + "role", "screenshot", "search_query", "secret", @@ -1964,7 +1991,12 @@ "secret", "azure_tenant", "identity", - "ransomleak" + "ransomleak", + "external_id", + "address_data", + "birth_year", + "role", + "phone_number" ] }, "search_types": { @@ -2087,8 +2119,7 @@ "SELF_ONBOARDING", "ATTRIBUTE", "AUTO_MONITOR", - "IDP_SYNC", - "VIP_PROTECTION" + "IDP_SYNC" ] }, "enrichments": { @@ -2301,7 +2332,12 @@ "secret", "azure_tenant", "identity", - "ransomleak" + "ransomleak", + "external_id", + "address_data", + "birth_year", + "role", + "phone_number" ] }, "q": { diff --git a/docs/api-reference/spec/firework-v4-openapi.json b/docs/api-reference/spec/firework-v4-openapi.json index 5671645e..15b5b8ed 100644 --- a/docs/api-reference/spec/firework-v4-openapi.json +++ b/docs/api-reference/spec/firework-v4-openapi.json @@ -10,108 +10,22 @@ } ], "paths": { - "/firework/v4/admin/asset-authorization/": { - "put": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Update Request Status", - "operationId": "update_request_status_admin_asset_authorization__put", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateAuthorizationRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AuthorizationResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "post": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Search Authorization Requests", - "operationId": "search_authorization_requests_admin_asset_authorization__post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AuthorizationRequestFilters" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/AuthorizationRequestItem" - }, - "type": "array", - "title": "Response Search Authorization Requests Admin Asset Authorization Post" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/admin/organizations/{organization_id}/audit_logs/_search": { + "/firework/v4/admin/identifiers/{tenant_id}/free_trial_identifier": { "post": { "tags": [ - "private", + "public", "team=experience" ], - "summary": "Search Admin Audit Events", - "operationId": "search_admin_audit_events_admin_organizations__organization_id__audit_logs__search_post", + "summary": "Create Identifier For Free Trial", + "operationId": "create_identifier_for_free_trial_admin_identifiers__tenant_id__free_trial_identifier_post", "parameters": [ { - "name": "organization_id", + "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "integer", - "title": "Organization Id" + "title": "Tenant Id" } } ], @@ -120,7 +34,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AdminAuditEventRequestBody" + "$ref": "#/components/schemas/IdentifierRequestBody" } } } @@ -131,7 +45,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedResultsWithTotalCount_AuditEventItemResponse_str_" + "$ref": "#/components/schemas/IdentifierResponse" } } } @@ -149,113 +63,92 @@ } } }, - "/firework/v4/admin/organizations/{organization_id}/audit_logs/{audit_log_id}": { + "/firework/v4/alerts/": { "get": { "tags": [ - "private", + "public", "team=experience" ], - "summary": "Get Admin Audit Log", - "operationId": "get_admin_audit_log_admin_organizations__organization_id__audit_logs__audit_log_id__get", + "summary": "Tenant Alerts", + "operationId": "tenant_alerts_alerts__get", "parameters": [ { - "name": "organization_id", - "in": "path", - "required": true, + "name": "from", + "in": "query", + "required": false, "schema": { - "type": "integer", - "title": "Organization Id" + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "From" } }, { - "name": "audit_log_id", - "in": "path", - "required": true, + "name": "size", + "in": "query", + "required": false, "schema": { "type": "integer", - "title": "Audit Log Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AuditEventItemResponse" - } - } + "maximum": 10, + "exclusiveMinimum": 0, + "default": 10, + "title": "Size" } }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + { + "name": "order_type", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/OrderType", + "default": "asc" } - } - } - } - }, - "/firework/v4/admin/banners/": { - "get": { - "tags": [ - "private", - "team=collection-platform" - ], - "summary": "List Banners", - "operationId": "list_banners_admin_banners__get", - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ListBannersResponse" + }, + { + "name": "q", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" } - } + ], + "title": "Q" } }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" + { + "name": "feed_owner_id", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" } - } + ], + "title": "Feed Owner Id" } } - } - }, - "put": { - "tags": [ - "private", - "team=collection-platform" ], - "summary": "Set Banner", - "operationId": "set_banner_admin_banners__put", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SetBannerPayload" - } - } - } - }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BannerResponse" + "$ref": "#/components/schemas/PaginatedResults_Alert_str_" } } } @@ -271,45 +164,68 @@ } } } - }, - "delete": { + } + }, + "/firework/v4/alerts/channels": { + "get": { "tags": [ - "private", - "team=collection-platform" + "public", + "team=integration" ], - "summary": "Clear Banner", - "operationId": "clear_banner_admin_banners__delete", + "summary": "Alert Channels", + "operationId": "alert_channels_alerts_channels_get", "parameters": [ { - "name": "organization_id", + "name": "from", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Organization Id" + "title": "From" } }, { - "name": "tenant_id", + "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": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Tenant Id" + "title": "Q" } } ], @@ -318,7 +234,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/PaginatedResults_PartialAlertChannel_str_" + } } } }, @@ -333,24 +251,23 @@ } } } - } - }, - "/firework/v4/admin/events/import": { + }, "post": { "tags": [ - "private" + "public", + "team=integration" ], - "summary": "Import Event", - "operationId": "import_event_admin_events_import_post", + "summary": "Create Channel", + "operationId": "create_channel_alerts_channels_post", "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExperimentalEventModel" + "$ref": "#/components/schemas/CreateAlertChannel" } } - }, - "required": true + } }, "responses": { "200": { @@ -358,7 +275,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ImportEventResult" + "$ref": "#/components/schemas/AlertChannel" } } } @@ -376,72 +293,30 @@ } } }, - "/firework/v4/admin/cookies/configurations": { - "get": { + "/firework/v4/credentials/global/_search": { + "post": { "tags": [ - "private" + "public" ], - "summary": "List Cookie Monitoring Configurations", - "operationId": "list_cookie_monitoring_configurations_admin_cookies_configurations_get", - "parameters": [ - { - "name": "from", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "From" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Size" - } - }, - { - "name": "order_type", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/OrderType", - "default": "asc" + "summary": "Credentials Global Search", + "operationId": "credentials_global_search_credentials_global__search_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredentialsQueryPayload" + } } }, - { - "name": "tenant_id", - "in": "query", - "required": true, - "schema": { - "type": "integer", - "title": "Tenant Id" - } - } - ], + "required": true + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PagedCookieConfigurations" + "$ref": "#/components/schemas/PaginatedResults_Credential_str_" } } } @@ -459,25 +334,26 @@ } } }, - "/firework/v4/admin/cookies/monitor": { + "/firework/v4/credentials/actions": { "post": { "tags": [ - "private" + "public", + "team=experience" ], - "summary": "Create Cookie Monitoring Configuration", - "operationId": "create_cookie_monitoring_configuration_admin_cookies_monitor_post", + "summary": "Credential Actions", + "operationId": "credential_actions_credentials_actions_post", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateCookieMonitoringConfigurationItem" + "$ref": "#/components/schemas/CredentialActionRequestBody" } } }, "required": true }, "responses": { - "201": { + "200": { "description": "Successful Response", "content": { "application/json": { @@ -498,27 +374,93 @@ } } }, - "/firework/v4/admin/cookies/configurations/{id}": { - "delete": { + "/firework/v4/events/": { + "get": { "tags": [ - "private" + "public", + "team=integration" ], - "summary": "Delete Cookie Monitoring Configuration", - "operationId": "delete_cookie_monitoring_configuration_admin_cookies_configurations__id__delete", + "summary": "Get Event", + "operationId": "get_event_events__get", "parameters": [ { - "name": "id", - "in": "path", + "name": "uid", + "in": "query", "required": true, "schema": { - "type": "integer", - "title": "Id" + "type": "string", + "title": "Uid" } } ], "responses": { - "204": { - "description": "Successful Response" + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "anyOf": [ + { + "oneOf": [ + { + "$ref": "#/components/schemas/BlogPostEvent" + }, + { + "$ref": "#/components/schemas/BucketEvent" + }, + { + "$ref": "#/components/schemas/ChatMessageEvent" + }, + { + "$ref": "#/components/schemas/FinancialEvent" + }, + { + "$ref": "#/components/schemas/ForumPostEvent" + }, + { + "$ref": "#/components/schemas/ListingEvent" + }, + { + "$ref": "#/components/schemas/LookalikeDomainEvent" + }, + { + "$ref": "#/components/schemas/PasteEvent" + }, + { + "$ref": "#/components/schemas/RansomLeakEvent" + }, + { + "$ref": "#/components/schemas/SocialMediaEvent" + }, + { + "$ref": "#/components/schemas/pyro__findings__stealerlogs__datamodels__StealerLogEvent" + } + ], + "discriminator": { + "propertyName": "event_type", + "mapping": { + "blog_post": "#/components/schemas/BlogPostEvent", + "bucket": "#/components/schemas/BucketEvent", + "chat_message": "#/components/schemas/ChatMessageEvent", + "cc": "#/components/schemas/FinancialEvent", + "forum_post": "#/components/schemas/ForumPostEvent", + "listing": "#/components/schemas/ListingEvent", + "lookalike": "#/components/schemas/LookalikeDomainEvent", + "paste": "#/components/schemas/PasteEvent", + "ransomleak": "#/components/schemas/RansomLeakEvent", + "social_media_account": "#/components/schemas/SocialMediaEvent", + "stealer_log": "#/components/schemas/pyro__findings__stealerlogs__datamodels__StealerLogEvent" + } + } + }, + { + "$ref": "#/components/schemas/EmptyFireworkEvent" + } + ], + "title": "Response Get Event Events Get" + } + } + } }, "422": { "description": "Validation Error", @@ -533,42 +475,29 @@ } } }, - "/firework/v4/admin/feature_flags/": { - "get": { + "/firework/v4/events/tenant/_search": { + "post": { "tags": [ - "private" + "public" ], - "summary": "List Feature Flags", - "operationId": "list_feature_flags_admin_feature_flags__get", - "parameters": [ - { - "name": "page", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "default": 1, - "title": "Page" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "default": 100, - "title": "Size" + "summary": "Current Tenant Feed", + "operationId": "current_tenant_feed_events_tenant__search_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FeedRequestBody" + } } } - ], + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ListFeatureFlagsResponse" + "$ref": "#/components/schemas/PaginatedResults_FeedItem_str_" } } } @@ -584,22 +513,24 @@ } } } - }, + } + }, + "/firework/v4/events/global/_search": { "post": { "tags": [ - "private" + "public" ], - "summary": "Create Feature Flag", - "operationId": "create_feature_flag_admin_feature_flags__post", + "summary": "Global Search", + "operationId": "global_search_events_global__search_post", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateFeatureFlagPayload" + "$ref": "#/components/schemas/GlobalSearchRequestBody" } } - } + }, + "required": true }, "responses": { "200": { @@ -607,7 +538,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FeatureFlagResponse" + "$ref": "#/components/schemas/PaginatedResults_GlobalFeedItem_str_" } } } @@ -625,90 +556,40 @@ } } }, - "/firework/v4/admin/feature_flags/status": { - "get": { + "/firework/v4/events/identifiers/{identifier_id}/_search": { + "post": { "tags": [ - "private" + "public" ], - "summary": "Get Feature Flag Status", - "operationId": "get_feature_flag_status_admin_feature_flags_status_get", + "summary": "Identifier Feed", + "operationId": "identifier_feed_events_identifiers__identifier_id___search_post", "parameters": [ { - "name": "page", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "default": 1, - "title": "Page" - } - }, - { - "name": "size", - "in": "query", - "required": false, + "name": "identifier_id", + "in": "path", + "required": true, "schema": { "type": "integer", - "default": 100, - "title": "Size" - } - }, - { - "name": "user_id", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "User Id" - } - }, - { - "name": "tenant_id", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Tenant Id" - } - }, - { - "name": "organization_id", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Organization Id" + "title": "Identifier Id" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FeedRequestBody" + } + } + } + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ListFeatureFlagsStatusResponse" + "$ref": "#/components/schemas/PaginatedResults_FeedItem_str_" } } } @@ -726,31 +607,40 @@ } } }, - "/firework/v4/admin/feature_flags/details/{feature_flag_name}": { - "get": { + "/firework/v4/events/identifier_groups/{identifier_group_id}/_search": { + "post": { "tags": [ - "private" + "public" ], - "summary": "Get Feature Flag", - "operationId": "get_feature_flag_admin_feature_flags_details__feature_flag_name__get", + "summary": "Identifier Group Feed", + "operationId": "identifier_group_feed_events_identifier_groups__identifier_group_id___search_post", "parameters": [ { - "name": "feature_flag_name", + "name": "identifier_group_id", "in": "path", "required": true, "schema": { - "type": "string", - "title": "Feature Flag Name" + "type": "integer", + "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/FeatureFlagDefinition" + "$ref": "#/components/schemas/PaginatedResults_FeedItem_str_" } } } @@ -768,81 +658,20 @@ } } }, - "/firework/v4/admin/feature_flags/user-lists": { + "/firework/v4/events/filters/types": { "get": { "tags": [ - "private" + "public" ], - "summary": "List Feature Flag User Lists", - "operationId": "list_feature_flag_user_lists_admin_feature_flags_user_lists_get", - "parameters": [ - { - "name": "page", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "default": 1, - "title": "Page" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "default": 100, - "title": "Size" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ListFeatureFlagUserListsResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "post": { - "tags": [ - "private" - ], - "summary": "Create Feature Flag User List", - "operationId": "create_feature_flag_user_list_admin_feature_flags_user_lists_post", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateFeatureFlagUserListPayload" - } - } - } - }, + "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/FeatureFlagUserListResponse" + "$ref": "#/components/schemas/FilterSourceTypes" } } } @@ -860,31 +689,20 @@ } } }, - "/firework/v4/admin/feature_flags/user-lists/{iid}": { + "/firework/v4/events/filters/severities": { "get": { "tags": [ - "private" - ], - "summary": "Get Feature Flag User List", - "operationId": "get_feature_flag_user_list_admin_feature_flags_user_lists__iid__get", - "parameters": [ - { - "name": "iid", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Iid" - } - } + "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/FeatureFlagUserList" + "$ref": "#/components/schemas/FilterSeverities" } } } @@ -902,74 +720,24 @@ } } }, - "/firework/v4/admin/feature_flags/user-lists/{user_list_iid}": { - "put": { + "/firework/v4/events/actions": { + "post": { "tags": [ - "private" - ], - "summary": "Update Feature Flag User List", - "operationId": "update_feature_flag_user_list_admin_feature_flags_user_lists__user_list_iid__put", - "parameters": [ - { - "name": "user_list_iid", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "User List Iid" - } - } + "public", + "team=experience" ], + "summary": "Event Actions", + "operationId": "event_actions_events_actions_post", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateFeatureFlagUserListPayload" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FeatureFlagUserListResponse" - } + "$ref": "#/components/schemas/EventActionsBody" } } }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "delete": { - "tags": [ - "private" - ], - "summary": "Delete Feature Flag User List", - "operationId": "delete_feature_flag_user_list_admin_feature_flags_user_lists__user_list_iid__delete", - "parameters": [ - { - "name": "user_list_iid", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "User List Iid" - } - } - ], + "required": true + }, "responses": { "200": { "description": "Successful Response", @@ -992,21 +760,22 @@ } } }, - "/firework/v4/admin/feature_flags/by_name/{feature_flag_name}/add_member": { - "post": { + "/firework/v4/events/tenant/metadata": { + "patch": { "tags": [ - "private" + "public", + "team=experience" ], - "summary": "Add Member For Feature Flag", - "operationId": "add_member_for_feature_flag_admin_feature_flags_by_name__feature_flag_name__add_member_post", + "summary": "Update Tenant Metadata", + "operationId": "update_tenant_metadata_events_tenant_metadata_patch", "parameters": [ { - "name": "feature_flag_name", - "in": "path", + "name": "uid", + "in": "query", "required": true, "schema": { "type": "string", - "title": "Feature Flag Name" + "title": "Uid" } } ], @@ -1015,7 +784,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MemberMutationPayload" + "$ref": "#/components/schemas/UpdateTenantMetadataBody" } } } @@ -1025,7 +794,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/TenantMetadataResponse" + } } } }, @@ -1042,90 +813,77 @@ } } }, - "/firework/v4/admin/feature_flags/by_name/{feature_flag_name}/remove_member": { - "post": { + "/firework/v4/events/_expand": { + "get": { "tags": [ - "private" + "public", + "team=experience" ], - "summary": "Remove Member For Feature Flag", - "operationId": "remove_member_for_feature_flag_admin_feature_flags_by_name__feature_flag_name__remove_member_post", + "summary": "Expand Event Field", + "operationId": "expand_event_field_events__expand_get", "parameters": [ { - "name": "feature_flag_name", - "in": "path", + "name": "field", + "in": "query", "required": true, "schema": { - "type": "string", - "title": "Feature Flag Name" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MemberMutationPayload" - } + "$ref": "#/components/schemas/ExpandableField" } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } + }, + { + "name": "uid", + "in": "query", + "required": true, + "schema": { + "type": "string", + "title": "Uid" } }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" + { + "name": "from", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" } - } + ], + "title": "From" } - } - } - } - }, - "/firework/v4/admin/feature_flags/by_name/{feature_flag_name}": { - "patch": { - "tags": [ - "private" - ], - "summary": "Update Feature Flag", - "operationId": "update_feature_flag_admin_feature_flags_by_name__feature_flag_name__patch", - "parameters": [ + }, { - "name": "feature_flag_name", - "in": "path", - "required": true, + "name": "size", + "in": "query", + "required": false, "schema": { - "type": "string", - "title": "Feature Flag Name" + "type": "integer", + "maximum": 20, + "exclusiveMinimum": 0, + "default": 20, + "title": "Size" } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateFeatureFlagPayload" - } - } - } - }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "anyOf": [ + { + "$ref": "#/components/schemas/PaginatedResults_StealerLogCredential_str_" + }, + { + "$ref": "#/components/schemas/PaginatedResults_StealerLogCookie_str_" + } + ], + "title": "Response Expand Event Field Events Expand Get" + } } } }, @@ -1140,30 +898,24 @@ } } } - }, - "delete": { + } + }, + "/firework/v4/healthz/": { + "get": { "tags": [ - "private" - ], - "summary": "Delete Feature Flag", - "operationId": "delete_feature_flag_admin_feature_flags_by_name__feature_flag_name__delete", - "parameters": [ - { - "name": "feature_flag_name", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Feature Flag Name" - } - } + "public" ], + "summary": "Is Api Up And Running", + "operationId": "is_api_up_and_running_healthz__get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "type": "string", + "title": "Response Is Api Up And Running Healthz Get" + } } } }, @@ -1180,132 +932,98 @@ } } }, - "/firework/v4/admin/feature_flags/by_name/{feature_flag_name}/strategies/{strategy_id}": { - "patch": { + "/firework/v4/identifier-recommendations/": { + "get": { "tags": [ - "private" + "public", + "team=experience" ], - "summary": "Update Strategy For Feature Flag", - "operationId": "update_strategy_for_feature_flag_admin_feature_flags_by_name__feature_flag_name__strategies__strategy_id__patch", + "summary": "Fetch Identifier Recommendations", + "operationId": "fetch_identifier_recommendations_identifier_recommendations__get", "parameters": [ { - "name": "feature_flag_name", - "in": "path", - "required": true, + "name": "types", + "in": "query", + "required": false, "schema": { - "type": "string", - "title": "Feature Flag Name" + "anyOf": [ + { + "type": "array", + "items": { + "enum": [ + "domain", + "azure_tenant", + "email", + "username" + ], + "type": "string" + } + }, + { + "type": "null" + } + ], + "title": "Types" } }, { - "name": "strategy_id", - "in": "path", - "required": true, + "name": "query", + "in": "query", + "required": false, "schema": { - "type": "integer", - "title": "Strategy Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateStrategyPayload" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" } - } + ], + "title": "Query" } - } - } - } - }, - "/firework/v4/admin/feature_flags/by_name/{feature_flag_name}/strategies": { - "post": { - "tags": [ - "private" - ], - "summary": "Create Strategy For Feature Flag", - "operationId": "create_strategy_for_feature_flag_admin_feature_flags_by_name__feature_flag_name__strategies_post", - "parameters": [ + }, { - "name": "feature_flag_name", - "in": "path", - "required": true, + "name": "status", + "in": "query", + "required": false, "schema": { - "type": "string", - "title": "Feature Flag Name" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateStrategyPayload" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } + "anyOf": [ + { + "$ref": "#/components/schemas/IdentifierRecommendationState" + }, + { + "type": "null" + } + ], + "title": "Status" } }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" + { + "name": "from", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" } - } + ], + "title": "From" } - } - } - } - }, - "/firework/v4/admin/identifiers/{identifier_id}/update_domain_identifier_properties": { - "post": { - "tags": [ - "private", - "team=experience" - ], - "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", - "parameters": [ + }, { - "name": "identifier_id", - "in": "path", - "required": true, + "name": "size", + "in": "query", + "required": false, "schema": { "type": "integer", - "title": "Identifier Id" + "maximum": 100, + "exclusiveMinimum": 0, + "default": 100, + "title": "Size" } } ], @@ -1315,8 +1033,7 @@ "content": { "application/json": { "schema": { - "type": "string", - "title": "Response Update Domain Identifier Properties Admin Identifiers Identifier Id Update Domain Identifier Properties Post" + "$ref": "#/components/schemas/PaginatedResults_Recommendation_str_" } } } @@ -1334,43 +1051,30 @@ } } }, - "/firework/v4/admin/identifiers/{tenant_id}/free_trial_identifier": { + "/firework/v4/identifier-recommendations/actions": { "post": { "tags": [ "public", "team=experience" ], - "summary": "Create Identifier For Free Trial", - "operationId": "create_identifier_for_free_trial_admin_identifiers__tenant_id__free_trial_identifier_post", - "parameters": [ - { - "name": "tenant_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Tenant Id" - } - } - ], + "summary": "Create Action For Identifier Recommendations", + "operationId": "create_action_for_identifier_recommendations_identifier_recommendations_actions_post", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/IdentifierRequestBody" + "$ref": "#/components/schemas/IdentifierRecommendationActionsBody" } } - } + }, + "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/IdentifierResponse" - } + "schema": {} } } }, @@ -1387,72 +1091,20 @@ } } }, - "/firework/v4/admin/organizations/{organization_id}/allowed_restricted_terms": { - "get": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Get Allowed Restricted Terms", - "operationId": "get_allowed_restricted_terms_admin_organizations__organization_id__allowed_restricted_terms_get", - "parameters": [ - { - "name": "organization_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Organization Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetAllowedRestrictedTermsResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, + "/firework/v4/identifiers/": { "post": { "tags": [ - "private", + "public", "team=experience" ], - "summary": "Add Allowed Restricted Term", - "operationId": "add_allowed_restricted_term_admin_organizations__organization_id__allowed_restricted_terms_post", - "parameters": [ - { - "name": "organization_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Organization Id" - } - } - ], + "summary": "Create Identifier", + "operationId": "create_public_identifier_identifiers__post", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AddAllowedRestrictedTermRequest" + "$ref": "#/components/schemas/PublicIdentifierRequestBody" } } } @@ -1462,7 +1114,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/PublicIdentifierResponse" + } } } }, @@ -1477,151 +1131,139 @@ } } } - } - }, - "/firework/v4/admin/organizations/{organization_id}/allowed_restricted_terms/{restricted_term_id}": { - "delete": { + }, + "get": { "tags": [ - "private", - "team=experience" + "public", + "team=experience", + "feature=identifiers" ], - "summary": "Delete Allowed Restricted Terms", - "operationId": "delete_allowed_restricted_terms_admin_organizations__organization_id__allowed_restricted_terms__restricted_term_id__delete", + "summary": "List Identifiers", + "operationId": "list_identifiers_identifiers__get", "parameters": [ { - "name": "organization_id", - "in": "path", - "required": true, + "name": "from", + "in": "query", + "required": false, "schema": { - "type": "integer", - "title": "Organization Id" + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "From" } }, { - "name": "restricted_term_id", - "in": "path", - "required": true, + "name": "size", + "in": "query", + "required": false, "schema": { - "type": "string", - "title": "Restricted Term Id" + "type": "integer", + "maximum": 100, + "exclusiveMinimum": 0, + "default": 20, + "title": "Size" } }, { - "name": "remove_related_requests", + "name": "order_by", "in": "query", "required": false, "schema": { - "type": "boolean", - "default": true, - "title": "Remove Related Requests" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } + "$ref": "#/components/schemas/IdentifierOrderBy", + "default": "id" } }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" + { + "name": "is_disabled", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" } - } + ], + "title": "Is Disabled" } - } - } - }, - "put": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Update Allowed Restricted Terms", - "operationId": "update_allowed_restricted_terms_admin_organizations__organization_id__allowed_restricted_terms__restricted_term_id__put", - "parameters": [ + }, { - "name": "organization_id", - "in": "path", - "required": true, + "name": "group_id", + "in": "query", + "required": false, "schema": { - "type": "integer", - "title": "Organization Id" + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Group Id" } }, { - "name": "restricted_term_id", - "in": "path", - "required": true, + "name": "types", + "in": "query", + "required": false, "schema": { - "type": "string", - "title": "Restricted Term Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateAllowedRestrictedTermRequest" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } + "anyOf": [ + { + "type": "array", + "items": { + "enum": [ + "bin", + "ip", + "keyword", + "azure_tenant", + "domain", + "search_query", + "github_repository", + "secret", + "identity" + ], + "type": "string" + } + }, + { + "type": "null" + } + ], + "title": "Types" } }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" + { + "name": "authorization_status", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "$ref": "#/components/schemas/IdentifierAuthorizationStatus" + }, + { + "type": "null" } - } + ], + "title": "Authorization Status" } } - } - } - }, - "/firework/v4/admin/restricted_terms/is_allowed": { - "post": { - "tags": [ - "private", - "team=experience" ], - "summary": "Is Allowed", - "operationId": "is_allowed_admin_restricted_terms_is_allowed_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SearchQueryAllowedRequest" - } - } - }, - "required": true - }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SearchQueryAllowedResponse" + "$ref": "#/components/schemas/PaginatedResults_PublicIdentifierResponse_str_" } } } @@ -1639,23 +1281,34 @@ } } }, - "/firework/v4/admin/restricted_terms/are_allowed": { - "post": { + "/firework/v4/identifiers/{identifier_id}": { + "put": { "tags": [ - "private", + "public", "team=experience" ], - "summary": "Are Allowed", - "operationId": "are_allowed_admin_restricted_terms_are_allowed_post", + "summary": "Update Identifier", + "operationId": "update_identifier_by_id_public_identifiers__identifier_id__put", + "parameters": [ + { + "name": "identifier_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Identifier Id" + } + } + ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SearchTermsAllowedRequest" + "$ref": "#/components/schemas/PublicIdentifierUpdateRequestBody" } } - }, - "required": true + } }, "responses": { "200": { @@ -1663,7 +1316,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SearchQueryAllowedResponse" + "$ref": "#/components/schemas/PublicIdentifierResponse" } } } @@ -1679,23 +1332,32 @@ } } } - } - }, - "/firework/v4/admin/restricted_terms": { + }, "get": { "tags": [ - "private", + "public", "team=experience" ], - "summary": "Get Restricted Terms", - "operationId": "get_restricted_terms_admin_restricted_terms_get", + "summary": "Get Identifier", + "operationId": "get_identifier_public_identifiers__identifier_id__get", + "parameters": [ + { + "name": "identifier_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Identifier Id" + } + } + ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RestrictedTerms" + "$ref": "#/components/schemas/PublicIdentifierResponse" } } } @@ -1711,29 +1373,27 @@ } } } - } - }, - "/firework/v4/admin/tenants/{tenant_id}/enable": { - "post": { + }, + "delete": { "tags": [ - "private", + "public", "team=experience" ], - "summary": "Enable Tenant", - "operationId": "enable_tenant_admin_tenants__tenant_id__enable_post", + "summary": "Delete Identifier", + "operationId": "delete_identifier_identifiers__identifier_id__delete", "parameters": [ { - "name": "tenant_id", + "name": "identifier_id", "in": "path", "required": true, "schema": { "type": "integer", - "title": "Tenant Id" + "title": "Identifier Id" } } ], "responses": { - "200": { + "202": { "description": "Successful Response", "content": { "application/json": { @@ -1754,33 +1414,37 @@ } } }, - "/firework/v4/admin/tenants/{tenant_id}/flare_community": { + "/firework/v4/matching-policies": { "post": { "tags": [ - "private" - ], - "summary": "Enable Tenant Flare Community", - "operationId": "enable_tenant_flare_community_admin_tenants__tenant_id__flare_community_post", - "parameters": [ - { - "name": "tenant_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Tenant Id" - } - } + "public", + "team=data-engineering" ], + "summary": "Create Matching Policy", + "operationId": "create_matching_policy_matching_policies_post", "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EnableFlareCommunityRequest", - "default": { - "auto_provision_users": false, - "manual_users": [] - } + "anyOf": [ + { + "$ref": "#/components/schemas/CreateIncludedKeywordsBody" + }, + { + "$ref": "#/components/schemas/CreateExcludedKeywordsBody" + }, + { + "$ref": "#/components/schemas/CreateLuceneQueryBody" + }, + { + "$ref": "#/components/schemas/CreateAstpCookiesBody" + }, + { + "$ref": "#/components/schemas/CreateAstpDomainBody" + } + ], + "title": "Body" } } } @@ -1791,7 +1455,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EnableFlareCommunityResponse" + "$ref": "#/components/schemas/MatchingPolicyPayload" } } } @@ -1810,18 +1474,47 @@ }, "get": { "tags": [ - "private" + "public", + "team=data-engineering" ], - "summary": "Get Tenant Flare Community", - "operationId": "get_tenant_flare_community_admin_tenants__tenant_id__flare_community_get", + "summary": "List Matching Policies", + "operationId": "list_matching_policies_matching_policies_get", "parameters": [ { - "name": "tenant_id", - "in": "path", - "required": true, + "name": "from", + "in": "query", + "required": false, "schema": { - "type": "integer", - "title": "Tenant Id" + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "From" + } + }, + { + "name": "size", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "maximum": 25, + "exclusiveMinimum": 0, + "default": 25, + "title": "Size" + } + }, + { + "name": "order", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/OrderType", + "default": "desc" } } ], @@ -1831,7 +1524,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TenantFlareCommunityIsEnabledResponse" + "$ref": "#/components/schemas/PaginatedResults_MatchingPolicyPayload_str_" } } } @@ -1847,30 +1540,46 @@ } } } - }, - "delete": { + } + }, + "/firework/v4/matching-policies/{policy_uuid}": { + "put": { "tags": [ - "private" + "public", + "team=data-engineering" ], - "summary": "Disable Tenant Flare Community", - "operationId": "disable_tenant_flare_community_admin_tenants__tenant_id__flare_community_delete", + "summary": "Update Matching Policy", + "operationId": "update_matching_policy_matching_policies__policy_uuid__put", "parameters": [ { - "name": "tenant_id", + "name": "policy_uuid", "in": "path", "required": true, "schema": { - "type": "integer", - "title": "Tenant Id" + "type": "string", + "format": "uuid", + "title": "Policy Uuid" } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateMatchingPolicyBody" + } + } + } + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/MatchingPolicyPayload" + } } } }, @@ -1885,50 +1594,65 @@ } } } - } - }, - "/firework/v4/admin/tenants/{tenant_id}/flare_community/invite_link": { + }, "get": { "tags": [ - "private" + "public", + "team=data-engineering" ], - "summary": "Get Tenant Flare Community Invite Link", - "operationId": "get_tenant_flare_community_invite_link_admin_tenants__tenant_id__flare_community_invite_link_get", + "summary": "Get Matching Policy", + "operationId": "get_matching_policy_matching_policies__policy_uuid__get", "parameters": [ { - "name": "tenant_id", + "name": "policy_uuid", "in": "path", "required": true, "schema": { - "type": "integer", - "title": "Tenant Id" + "type": "string", + "format": "uuid", + "title": "Policy Uuid" } - }, - { - "name": "from", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MatchingPolicyPayload" } - ], - "title": "From" + } } }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "delete": { + "tags": [ + "public", + "team=data-engineering" + ], + "summary": "Delete Matching Policy", + "operationId": "delete_matching_policy_matching_policies__policy_uuid__delete", + "parameters": [ { - "name": "size", - "in": "query", - "required": false, + "name": "policy_uuid", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 10, - "title": "Size" + "type": "string", + "format": "uuid", + "title": "Policy Uuid" } } ], @@ -1937,9 +1661,7 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_InviteLinkResponse_datetime_" - } + "schema": {} } } }, @@ -1954,41 +1676,38 @@ } } } - }, - "post": { + } + }, + "/firework/v4/matching-policies/by_identifier_id/{identifier_id}": { + "get": { "tags": [ - "private" + "public", + "team=data-engineering" ], - "summary": "Create Invite Link", - "operationId": "create_invite_link_admin_tenants__tenant_id__flare_community_invite_link_post", + "summary": "List Matching Policies By Identifier Id", + "operationId": "list_matching_policies_by_identifier_id_matching_policies_by_identifier_id__identifier_id__get", "parameters": [ { - "name": "tenant_id", + "name": "identifier_id", "in": "path", "required": true, "schema": { "type": "integer", - "title": "Tenant Id" + "title": "Identifier Id" } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FlareInviteLinkRequest" - } - } - } - }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateInviteLinkResponse" + "type": "array", + "items": { + "$ref": "#/components/schemas/MatchingPolicyAssignmentPayload" + }, + "title": "Response List Matching Policies By Identifier Id Matching Policies By Identifier Id Identifier Id Get" } } } @@ -2006,21 +1725,23 @@ } } }, - "/firework/v4/admin/tenants/{tenant_id}/flare_community/users": { + "/firework/v4/matching-policies/{policy_uuid}/assignments": { "get": { "tags": [ - "private" + "public", + "team=data-engineering" ], - "summary": "Get Tenant Flare Community Users", - "operationId": "get_tenant_flare_community_users_admin_tenants__tenant_id__flare_community_users_get", + "summary": "List Policy Assignments", + "operationId": "list_policy_assignments_matching_policies__policy_uuid__assignments_get", "parameters": [ { - "name": "tenant_id", + "name": "policy_uuid", "in": "path", "required": true, "schema": { - "type": "integer", - "title": "Tenant Id" + "type": "string", + "format": "uuid", + "title": "Policy Uuid" } }, { @@ -2030,7 +1751,7 @@ "schema": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" @@ -2045,24 +1766,18 @@ "required": false, "schema": { "type": "integer", - "default": 10, + "exclusiveMinimum": 0, + "default": 25, "title": "Size" } }, { - "name": "search_query", + "name": "order", "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Search Query" + "$ref": "#/components/schemas/OrderType", + "default": "desc" } } ], @@ -2072,7 +1787,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedResults_TenantFlareCommunityUser_int_" + "$ref": "#/components/schemas/PaginatedResults_PolicyAssignedIdentifierPayload_str_" } } } @@ -2088,34 +1803,42 @@ } } } - } - }, - "/firework/v4/admin/tenants/{tenant_id}/flare_community/users/count": { - "get": { + }, + "post": { "tags": [ - "private" + "public", + "team=data-engineering" ], - "summary": "Get Tenant Flare Community Users Count", - "operationId": "get_tenant_flare_community_users_count_admin_tenants__tenant_id__flare_community_users_count_get", + "summary": "Assign Policy", + "operationId": "assign_policy_matching_policies__policy_uuid__assignments_post", "parameters": [ { - "name": "tenant_id", + "name": "policy_uuid", "in": "path", "required": true, "schema": { - "type": "integer", - "title": "Tenant Id" + "type": "string", + "format": "uuid", + "title": "Policy Uuid" } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyAssignmentsBody" + } + } + } + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantFlareCommunityUsersCountResponse" - } + "schema": {} } } }, @@ -2130,35 +1853,36 @@ } } } - } - }, - "/firework/v4/admin/tenants/{tenant_id}/flare_community/invite_link/{invite_link_id}": { + }, "delete": { "tags": [ - "private" + "public", + "team=data-engineering" ], - "summary": "Delete Invite Link", - "operationId": "delete_invite_link_admin_tenants__tenant_id__flare_community_invite_link__invite_link_id__delete", + "summary": "Unassign Policy", + "operationId": "unassign_policy_matching_policies__policy_uuid__assignments_delete", "parameters": [ { - "name": "invite_link_id", + "name": "policy_uuid", "in": "path", "required": true, "schema": { "type": "string", - "title": "Invite Link Id" - } - }, - { - "name": "tenant_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Tenant Id" + "format": "uuid", + "title": "Policy Uuid" } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyAssignmentsBody" + } + } + } + }, "responses": { "200": { "description": "Successful Response", @@ -2181,30 +1905,70 @@ } } }, - "/firework/v4/admin/tenants/{tenant_id}/flare_community/users/{user_id}": { - "delete": { + "/firework/v4/reports": { + "get": { "tags": [ - "private" + "public", + "team=data-intelligence", + "feature=reports" ], - "summary": "Delete User", - "operationId": "delete_user_admin_tenants__tenant_id__flare_community_users__user_id__delete", + "summary": "List Reports", + "operationId": "list_reports_reports_get", "parameters": [ { - "name": "user_id", - "in": "path", - "required": true, + "name": "from", + "in": "query", + "required": false, "schema": { - "type": "integer", - "title": "User Id" + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "From" } }, { - "name": "tenant_id", - "in": "path", - "required": true, + "name": "size", + "in": "query", + "required": false, "schema": { "type": "integer", - "title": "Tenant Id" + "maximum": 100, + "exclusiveMinimum": 0, + "default": 20, + "title": "Size" + } + }, + { + "name": "order_type", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/OrderType", + "default": "desc" + } + }, + { + "name": "order_by", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/pyro__reports__report_store__SortType", + "default": "updated_at" + } + }, + { + "name": "include_archived", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false, + "title": "Include Archived" } } ], @@ -2213,7 +1977,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/PaginatedResults_PublicReport_str_" + } } } }, @@ -2228,49 +1994,36 @@ } } } - }, - "patch": { + } + }, + "/firework/v4/reports/{report_id}": { + "get": { "tags": [ - "private" + "public", + "team=data-intelligence", + "feature=reports" ], - "summary": "Update User Features", - "operationId": "update_user_features_admin_tenants__tenant_id__flare_community_users__user_id__patch", + "summary": "Get Report", + "operationId": "get_report_reports__report_id__get", "parameters": [ { - "name": "user_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "User Id" - } - }, - { - "name": "tenant_id", + "name": "report_id", "in": "path", "required": true, "schema": { "type": "integer", - "title": "Tenant Id" + "title": "Report Id" } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateFlareCommunityUserFeaturesRequest" - } - } - } - }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/PublicReport" + } } } }, @@ -2287,42 +2040,47 @@ } } }, - "/firework/v4/admin/tenants/{tenant_id}/flare_community/parse_csv": { - "post": { + "/firework/v4/reports/{report_id}/download": { + "get": { "tags": [ - "private" + "public", + "team=data-intelligence", + "feature=reports" ], - "summary": "Parse Csv", - "operationId": "parse_csv_admin_tenants__tenant_id__flare_community_parse_csv_post", + "summary": "Download Report", + "operationId": "download_report_reports__report_id__download_get", "parameters": [ { - "name": "tenant_id", + "name": "report_id", "in": "path", "required": true, "schema": { "type": "integer", - "title": "Tenant Id" + "title": "Report Id" } - } - ], - "requestBody": { - "required": true, - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/Body_parse_csv_admin_tenants__tenant_id__flare_community_parse_csv_post" - } + }, + { + "name": "format", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/ReportDownloadFormat", + "choices": [ + "docx", + "pdf", + "csv", + "zip" + ], + "default": "docx" } } - }, + ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/CSVParseResponse" - } + "schema": {} } } }, @@ -2339,13 +2097,13 @@ } } }, - "/firework/v4/admin/threat_flow/reports": { + "/firework/v4/threat_flow/reports/": { "get": { "tags": [ - "private" + "public" ], "summary": "List Reports", - "operationId": "list_reports_admin_threat_flow_reports_get", + "operationId": "list_reports_threat_flow_reports__get", "parameters": [ { "name": "from", @@ -2383,28 +2141,22 @@ } }, { - "name": "order_by", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/pyro__threat_flow__core__reports__report_store__SortType", - "default": "id" - } - }, - { - "name": "query", + "name": "report_types", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "string" + "type": "array", + "items": { + "$ref": "#/components/schemas/pyro__threat_flow__core__reports__report_store__ReportType" + } }, { "type": "null" } ], - "title": "Query" + "title": "Report Types" } } ], @@ -2414,7 +2166,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedResults_ThreatFlowReportResponse_str_" + "$ref": "#/components/schemas/PaginatedResults_PydanticThreatFlowReport_str_" } } } @@ -2432,13 +2184,13 @@ } } }, - "/firework/v4/admin/threat_flow/reports/{report_id}": { + "/firework/v4/threat_flow/reports/{report_id}": { "get": { "tags": [ - "private" + "public" ], "summary": "Get Report", - "operationId": "get_report_admin_threat_flow_reports__report_id__get", + "operationId": "get_report_threat_flow_reports__report_id__get", "parameters": [ { "name": "report_id", @@ -2456,7 +2208,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ThreatFlowReportResponse" + "$ref": "#/components/schemas/pyro__threat_flow__web__v4__reports__models__ReportResponse" } } } @@ -2473,12 +2225,12 @@ } } }, - "put": { + "delete": { "tags": [ - "private" + "public" ], - "summary": "Update Report", - "operationId": "update_report_admin_threat_flow_reports__report_id__put", + "summary": "Delete Report", + "operationId": "delete_report_threat_flow_reports__report_id__delete", "parameters": [ { "name": "report_id", @@ -2490,24 +2242,12 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateReportParameters" - } - } - } - }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ThreatFlowReportResponse" - } + "schema": {} } } }, @@ -2524,23 +2264,33 @@ } } }, - "/firework/v4/admin/identifier_recommendations/llm": { - "post": { + "/firework/v4/threat_flow/reports/{report_id}/publish": { + "patch": { "tags": [ - "private", - "team=experience" + "public" + ], + "summary": "Publish Report", + "operationId": "publish_report_threat_flow_reports__report_id__publish_patch", + "parameters": [ + { + "name": "report_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Report Id" + } + } ], - "summary": "Create Llm Recommendations", - "operationId": "create_llm_recommendations_admin_identifier_recommendations_llm_post", "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateLLMRecommendationsRequest" + "$ref": "#/components/schemas/PublishReportPayload" } } - }, - "required": true + } }, "responses": { "200": { @@ -2548,7 +2298,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateLLMRecommendationsResponse" + "$ref": "#/components/schemas/pyro__threat_flow__web__v4__reports__models__ReportResponse" } } } @@ -2566,22 +2316,30 @@ } } }, - "/firework/v4/actors/{uuid}/uid": { + "/firework/v4/threat_flow/reports/{report_id}/download": { "get": { "tags": [ - "private" + "public" ], - "summary": "Get Actor Uid From Uuid", - "description": "This endpoint is temporary until we migrate all actor services to use the asset uuid.", - "operationId": "get_actor_uid_from_uuid_actors__uuid__uid_get", + "summary": "Download Report", + "operationId": "download_report_threat_flow_reports__report_id__download_get", "parameters": [ { - "name": "uuid", + "name": "report_id", "in": "path", "required": true, "schema": { - "type": "string", - "title": "Uuid" + "type": "integer", + "title": "Report Id" + } + }, + { + "name": "format", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/ThreatFlowReportDownloadFormat", + "default": "docx" } } ], @@ -2590,9 +2348,7 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ActorUid" - } + "schema": {} } } }, @@ -2609,18 +2365,18 @@ } } }, - "/firework/v4/actors/uuid": { + "/firework/v4/threat_flow/unit_summary/related_conversation": { "post": { "tags": [ - "private" + "public" ], - "summary": "Get Asset Uuid", - "operationId": "get_asset_uuid_actors_uuid_post", + "summary": "Get Related Conversation", + "operationId": "get_related_conversation_threat_flow_unit_summary_related_conversation_post", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActorBodyPayload" + "$ref": "#/components/schemas/RelatedConversationRequest" } } }, @@ -2632,8 +2388,7 @@ "content": { "application/json": { "schema": { - "type": "string", - "title": "Response Get Asset Uuid Actors Uuid Post" + "$ref": "#/components/schemas/RelatedConversationResponse" } } } @@ -2651,32 +2406,30 @@ } } }, - "/firework/v4/actors/{asset_uuid}/metadata": { - "get": { + "/firework/v4/threat_flow/reports/requests": { + "post": { "tags": [ - "private" + "public" ], - "summary": "Get Actor Metadata Endpoint", - "operationId": "get_actor_metadata_endpoint_actors__asset_uuid__metadata_get", - "parameters": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Asset Uuid" + "summary": "Create Report Request", + "operationId": "create_report_request_threat_flow_reports_requests_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReportRequestPayload" + } } - } - ], + }, + "required": true + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActorMetadata" + "$ref": "#/components/schemas/ReportRequestResponse" } } } @@ -2694,167 +2447,34 @@ } } }, - "/firework/v4/actors/{asset_uuid}/timeline": { + "/firework/v4/threat_flow/reports/requests/{request_info_id}": { "get": { "tags": [ - "private" + "public" ], - "summary": "Get Actor Timeline", - "operationId": "get_actor_timeline_actors__asset_uuid__timeline_get", + "summary": "Get Report Request", + "operationId": "get_report_request_threat_flow_reports_requests__request_info_id__get", "parameters": [ { - "name": "asset_uuid", + "name": "request_info_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", - "title": "Asset Uuid" - } - }, - { - "name": "aggregate_by", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/StatsAggregates" - }, - { - "type": "null" - } - ], - "title": "Aggregate By" - } - }, - { - "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" - } - } - ], - "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/{asset_uuid}/threads": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Actor Threads", - "operationId": "get_actor_threads_actors__asset_uuid__threads_get", - "parameters": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Asset Uuid" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ActorThread" - }, - "title": "Response Get Actor Threads Actors Asset Uuid Threads Get" - } - } + "title": "Request Info Id" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReportRequestInfoResponse" + } + } } }, "422": { @@ -2870,76 +2490,30 @@ } } }, - "/firework/v4/actors/{asset_uuid}/analysis/metadata": { - "get": { + "/firework/v4/hubspot/flare_sync_webhook": { + "post": { "tags": [ - "private" - ], - "summary": "Get Actor Analysis Metadata", - "operationId": "get_actor_analysis_metadata_actors__asset_uuid__analysis_metadata_get", - "parameters": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Asset Uuid" - } - } + "public", + "team=experience" ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActorAnalysisMetadataResponse" - } + "summary": "Handle Hubspot Flare Sync Webhook", + "operationId": "handle_hubspot_flare_sync_webhook_hubspot_flare_sync_webhook_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HubspotWebhookFlareSyncEvent" } } }, - "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" - } - } - ], + "required": true + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ActorSummariesResponse" - } + "schema": {} } } }, @@ -2956,43 +2530,30 @@ } } }, - "/firework/v4/actors/{asset_uuid}/generate-summaries": { + "/firework/v4/hubspot/flare_sync_tenant_webhook": { "post": { "tags": [ - "private" - ], - "summary": "Generate Summaries", - "operationId": "generate_summaries_actors__asset_uuid__generate_summaries_post", - "parameters": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Asset Uuid" - } - } + "public", + "team=experience" ], + "summary": "Handle Hubspot Flare Sync Tenant Webhook", + "operationId": "handle_hubspot_flare_sync_tenant_webhook_hubspot_flare_sync_tenant_webhook_post", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActorSummariesGenerationPayload" + "$ref": "#/components/schemas/HubspotWebhookFlareSyncTenantEvent" } } - } + }, + "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ActorSummariesResponse" - } + "schema": {} } } }, @@ -3008,28748 +2569,392 @@ } } } - }, - "/firework/v4/actors/{asset_uuid}/heatmap": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Actor Heatmap", - "operationId": "get_actor_heatmap_actors__asset_uuid__heatmap_get", - "parameters": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Asset Uuid" - } - }, - { - "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" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/ActorHeatmapData" - }, - { - "type": "null" - } - ], - "title": "Response Get Actor Heatmap Actors Asset Uuid Heatmap Get" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/actors/{asset_uuid}/communication-handles": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Actor Communication Handles", - "operationId": "get_actor_communication_handles_actors__asset_uuid__communication_handles_get", - "parameters": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Asset Uuid" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ActorCommunicationHandle" - }, - "title": "Response Get Actor Communication Handles Actors Asset Uuid Communication Handles Get" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/actors/network/{request_id}": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Actor Network By Request Id", - "operationId": "get_actor_network_by_request_id_actors_network__request_id__get", - "parameters": [ - { - "name": "request_id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Request Id" - } - }, - { - "name": "group_by", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/GroupByType", - "default": "relationship_nature" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActorNetworkResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/actors/{asset_uuid}/generate-network": { - "post": { - "tags": [ - "private" - ], - "summary": "Generate Network", - "operationId": "generate_network_actors__asset_uuid__generate_network_post", - "parameters": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Asset Uuid" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActorNetworkGenerationPayload" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActorNetworkResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/alerts/": { - "get": { - "tags": [ - "public", - "team=experience" - ], - "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_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "post": { - "tags": [ - "private", - "team=experience" - ], - "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", - "team=experience" - ], - "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", - "team=experience" - ], - "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", - "team=experience" - ], - "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" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/alerts/channels": { - "get": { - "tags": [ - "public", - "team=integration" - ], - "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" - } - }, - { - "name": "q", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Q" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_PartialAlertChannel_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "post": { - "tags": [ - "public", - "team=integration" - ], - "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", - "team=integration" - ], - "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", - "team=integration" - ], - "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", - "team=integration" - ], - "summary": "Get Alert Channel", - "operationId": "get_alert_channel_alerts_channels__alert_channel_id__get", - "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": { - "$ref": "#/components/schemas/AlertChannel" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/alerts/test": { - "post": { - "tags": [ - "private", - "team=integration" - ], - "summary": "Test Channel Validation", - "operationId": "test_channel_validation_alerts_test_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/AlertChannelEmailParams" - }, - { - "$ref": "#/components/schemas/AlertChannelSlackParams" - }, - { - "$ref": "#/components/schemas/AlertChannelDiscordParams" - }, - { - "$ref": "#/components/schemas/AlertChannelSplunkParams" - }, - { - "$ref": "#/components/schemas/AlertChannelChannelParams" - }, - { - "$ref": "#/components/schemas/AlertChannelLegacySentinelParams" - }, - { - "$ref": "#/components/schemas/AlertChannelSentinelV2Params" - }, - { - "$ref": "#/components/schemas/AlertChannelTeamsParams" - }, - { - "$ref": "#/components/schemas/AlertChannelJiraParams" - }, - { - "$ref": "#/components/schemas/AlertChannelServiceNowParams" - }, - { - "$ref": "#/components/schemas/AlertChannelWebhookParams" - } - ], - "title": "Test Channel Payload", - "discriminator": { - "propertyName": "type", - "mapping": { - "email": "#/components/schemas/AlertChannelEmailParams", - "slack": "#/components/schemas/AlertChannelSlackParams", - "discord": "#/components/schemas/AlertChannelDiscordParams", - "splunk": "#/components/schemas/AlertChannelSplunkParams", - "channel": "#/components/schemas/AlertChannelChannelParams", - "azure_sentinel": "#/components/schemas/AlertChannelLegacySentinelParams", - "azure_sentinel_v2": "#/components/schemas/AlertChannelSentinelV2Params", - "teams": "#/components/schemas/AlertChannelTeamsParams", - "jira": "#/components/schemas/AlertChannelJiraParams", - "servicenow": "#/components/schemas/AlertChannelServiceNowParams", - "webhook": "#/components/schemas/AlertChannelWebhookParams" - } - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AlertChannelStatusReponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/alerts/preview": { - "post": { - "tags": [ - "private", - "team=integration" - ], - "summary": "Preview Alerts", - "operationId": "preview_alerts_alerts_preview_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PreviewAlerts" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/intels/validate-topic": { - "post": { - "tags": [ - "private" - ], - "summary": "Validate Intel Topic", - "description": "UX-only guidance: validates that an intel topic does not contain PII\nbefore submission. Note that this check is not enforced server-side when\nthe intel is created", - "operationId": "validate_intel_topic_intels_validate_topic_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidateIntelTopicPayload" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidateIntelTopicResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/assets/by_data": { - "post": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Get Or Create Asset By Data", - "operationId": "get_or_create_asset_by_data_assets_by_data_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/CCBinData" - }, - { - "$ref": "#/components/schemas/IPData" - }, - { - "$ref": "#/components/schemas/BrandData" - }, - { - "$ref": "#/components/schemas/KeywordData" - }, - { - "$ref": "#/components/schemas/AzureTenantData" - }, - { - "$ref": "#/components/schemas/DomainData" - }, - { - "$ref": "#/components/schemas/NameData" - }, - { - "$ref": "#/components/schemas/SearchQueryData" - }, - { - "$ref": "#/components/schemas/GithubRepositoryData" - }, - { - "$ref": "#/components/schemas/UsernameData" - }, - { - "$ref": "#/components/schemas/EmailData" - }, - { - "$ref": "#/components/schemas/SecretData" - }, - { - "$ref": "#/components/schemas/CredentialsData" - }, - { - "$ref": "#/components/schemas/IdentityData" - }, - { - "$ref": "#/components/schemas/RansomLeakData" - } - ], - "title": "Asset Data" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AssetResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/assets/{asset_uuid}": { - "get": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Get Asset By Uuid", - "operationId": "get_asset_by_uuid_assets__asset_uuid__get", - "parameters": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Asset Uuid" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AssetResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/asset-authorization/": { - "post": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Request Authorization", - "operationId": "request_authorization_asset_authorization__post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateAuthorizationRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AuthorizationResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/requests/": { - "post": { - "tags": [ - "private" - ], - "summary": "Generate Async Request", - "operationId": "generate_async_request_requests__post", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GenerateAsyncRequestPayload" - } - } - } - }, - "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": "List Async Requests", - "operationId": "list_async_requests_requests__get", - "parameters": [ - { - "name": "request_type", - "in": "query", - "required": true, - "schema": { - "$ref": "#/components/schemas/AsyncRequestType" - } - }, - { - "name": "statuses", - "in": "query", - "required": false, - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AsyncRequestStatus" - }, - "default": [ - "pending", - "processing" - ], - "title": "Statuses" - } - }, - { - "name": "created_after", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Created After" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "maximum": 100, - "exclusiveMinimum": 0, - "default": 50, - "title": "Size" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/requests/{request_id}": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Async Request", - "operationId": "get_async_request_requests__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": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/banner/current": { - "get": { - "tags": [ - "private", - "team=collection-platform" - ], - "summary": "Get Current Banner", - "operationId": "get_current_banner_banner_current_get", - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/BannerResponse" - }, - { - "type": "null" - } - ], - "title": "Response Get Current Banner Banner Current Get" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/tasks/": { - "post": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Bulk Actions", - "operationId": "bulk_actions_tasks__post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BulkActionsRequestBody" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_EnrichedBulkAction_str_" - } - } - } - }, - "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_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/integrations/credential_validations": { - "get": { - "tags": [ - "private", - "team=integration" - ], - "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" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_CredentialValidationReponse_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "post": { - "tags": [ - "private", - "team=integration" - ], - "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": { - "$ref": "#/components/schemas/CredentialValidationReponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/integrations/credential_validations/{tenant_id}/reset": { - "post": { - "tags": [ - "private", - "team=integration" - ], - "summary": "Reset Credential Validations", - "operationId": "reset_credential_validations_integrations_credential_validations__tenant_id__reset_post", - "parameters": [ - { - "name": "tenant_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Tenant Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/credentials/bulk_action": { - "post": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Create Credential Bulk Action", - "operationId": "create_credential_bulk_action_credentials_bulk_action_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CredentialBulkActionRequestBody" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/credentials/global/_search": { - "post": { - "tags": [ - "public" - ], - "summary": "Credentials Global Search", - "operationId": "credentials_global_search_credentials_global__search_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CredentialsQueryPayload" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_Credential_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/credentials/actions": { - "post": { - "tags": [ - "public", - "team=experience" - ], - "summary": "Credential Actions", - "operationId": "credential_actions_credentials_actions_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CredentialActionRequestBody" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/entities/{asset_uuid}/alert_level": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Alert Level", - "operationId": "get_alert_level_entities__asset_uuid__alert_level_get", - "parameters": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Asset Uuid" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AlertLevelResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/entities/{asset_uuid}/alert_level/timeline": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Exposure Level Timeline", - "operationId": "get_exposure_level_timeline_entities__asset_uuid__alert_level_timeline_get", - "parameters": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Asset Uuid" - } - }, - { - "name": "time", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Time" - } - }, - { - "name": "time_zone", - "in": "query", - "required": false, - "schema": { - "type": "string", - "default": "Etc/UTC", - "title": "Time Zone" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AlertLevelTimelineResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/chat-channels/uuid": { - "post": { - "tags": [ - "private" - ], - "summary": "Get Asset Uuid", - "operationId": "get_asset_uuid_chat_channels_uuid_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChatChannelAssetUuidPayload" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "type": "string", - "title": "Response Get Asset Uuid Chat Channels Uuid Post" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/chat-channels/{asset_uuid}/metadata": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Chat Channel Metadata", - "operationId": "get_chat_channel_metadata_chat_channels__asset_uuid__metadata_get", - "parameters": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Asset Uuid" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChatChannelMetadata" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/chat-channels/{asset_uuid}/analysis/metadata": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Chat Channel Analysis Metadata", - "operationId": "get_chat_channel_analysis_metadata_chat_channels__asset_uuid__analysis_metadata_get", - "parameters": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Asset Uuid" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AnalysisMetadataResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/chat-channels/{asset_uuid}/uid": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Chat Channel Uid From Asset Uuid", - "operationId": "get_chat_channel_uid_from_asset_uuid_chat_channels__asset_uuid__uid_get", - "parameters": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Asset Uuid" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChatChannelUidWithNameResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/chat-channels/{asset_uuid}/breakdown": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Chat Channel Breakdown", - "operationId": "get_chat_channel_breakdown_chat_channels__asset_uuid__breakdown_get", - "parameters": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Asset Uuid" - } - }, - { - "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": "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/ChatChannelTimeline" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/chat-channels/{asset_uuid}/key-actors": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Chat Channel Key Actors", - "operationId": "get_chat_channel_key_actors_chat_channels__asset_uuid__key_actors_get", - "parameters": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Asset Uuid" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChatChannelKeyActorsResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/chat-channels/{asset_uuid}/mentioned-channels": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Chat Channel Mentioned Channels", - "operationId": "get_chat_channel_mentioned_channels_chat_channels__asset_uuid__mentioned_channels_get", - "parameters": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Asset Uuid" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChatChannelMentionedChannelsResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/chat-channels/{asset_uuid}/generate-summaries": { - "post": { - "tags": [ - "private" - ], - "summary": "Post Generate Chat Channel Summaries", - "operationId": "post_generate_chat_channel_summaries_chat_channels__asset_uuid__generate_summaries_post", - "parameters": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Asset Uuid" - } - }, - { - "name": "force_refresh", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false, - "title": "Force Refresh" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChatChannelSummariesResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/chat-channels/summaries/{request_id}": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Chat Channel Summaries By Request Id", - "operationId": "get_chat_channel_summaries_by_request_id_chat_channels_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/ChatChannelSummariesResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/cti/entities": { - "get": { - "tags": [ - "private" - ], - "summary": "List Entities", - "operationId": "list_entities_cti_entities_get", - "parameters": [ - { - "name": "query", - "in": "query", - "required": false, - "schema": { - "type": "string", - "default": "", - "title": "Query" - } - }, - { - "name": "types", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/EntityType" - } - }, - { - "type": "null" - } - ], - "title": "Types" - } - }, - { - "name": "updated_at_time_range", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/TimeRangeType" - }, - { - "type": "null" - } - ], - "title": "Updated At Time Range" - } - }, - { - "name": "sources", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ], - "title": "Sources" - } - }, - { - "name": "sort_by_key", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Sort By Key" - } - }, - { - "name": "sort_by_direction", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/OrderType", - "default": "desc" - } - }, - { - "name": "search_after", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Search After" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "default": 10, - "title": "Size" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_EntityAPIResponseTypes_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/cti/entities/count": { - "get": { - "tags": [ - "private" - ], - "summary": "Count Entities", - "operationId": "count_entities_cti_entities_count_get", - "parameters": [ - { - "name": "query", - "in": "query", - "required": false, - "schema": { - "type": "string", - "default": "", - "title": "Query" - } - }, - { - "name": "types", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/EntityType" - } - }, - { - "type": "null" - } - ], - "title": "Types" - } - }, - { - "name": "updated_at_time_range", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/TimeRangeType" - }, - { - "type": "null" - } - ], - "title": "Updated At Time Range" - } - }, - { - "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": "integer", - "title": "Response Count Entities Cti Entities Count Get" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/cti/entities/{asset_uuid}": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Entity", - "operationId": "get_entity_cti_entities__asset_uuid__get", - "parameters": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Asset Uuid" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntityAPIResponseTypes" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/cti/entities/{asset_uuid}/relations": { - "get": { - "tags": [ - "private" - ], - "summary": "List Entity Relations", - "operationId": "list_entity_relations_cti_entities__asset_uuid__relations_get", - "parameters": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Asset Uuid" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "default": 10, - "title": "Size" - } - }, - { - "name": "from_", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From " - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_CTIEntityRelationshipResponse_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/events/": { - "get": { - "tags": [ - "public", - "team=integration" - ], - "summary": "Get Event", - "operationId": "get_event_events__get", - "parameters": [ - { - "name": "uid", - "in": "query", - "required": true, - "schema": { - "type": "string", - "title": "Uid" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/BlogPostEvent" - }, - { - "$ref": "#/components/schemas/BucketEvent" - }, - { - "$ref": "#/components/schemas/ChatMessageEvent" - }, - { - "$ref": "#/components/schemas/FinancialEvent" - }, - { - "$ref": "#/components/schemas/ForumPostEvent" - }, - { - "$ref": "#/components/schemas/ListingEvent" - }, - { - "$ref": "#/components/schemas/LookalikeDomainEvent" - }, - { - "$ref": "#/components/schemas/PasteEvent" - }, - { - "$ref": "#/components/schemas/RansomLeakEvent" - }, - { - "$ref": "#/components/schemas/SocialMediaEvent" - }, - { - "$ref": "#/components/schemas/pyro__findings__stealerlogs__datamodels__StealerLogEvent" - } - ], - "discriminator": { - "propertyName": "event_type", - "mapping": { - "blog_post": "#/components/schemas/BlogPostEvent", - "bucket": "#/components/schemas/BucketEvent", - "chat_message": "#/components/schemas/ChatMessageEvent", - "cc": "#/components/schemas/FinancialEvent", - "forum_post": "#/components/schemas/ForumPostEvent", - "listing": "#/components/schemas/ListingEvent", - "lookalike": "#/components/schemas/LookalikeDomainEvent", - "paste": "#/components/schemas/PasteEvent", - "ransomleak": "#/components/schemas/RansomLeakEvent", - "social_media_account": "#/components/schemas/SocialMediaEvent", - "stealer_log": "#/components/schemas/pyro__findings__stealerlogs__datamodels__StealerLogEvent" - } - }, - "title": "Response Get Event Events Get" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/events/ui": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Event Ui", - "operationId": "get_event_ui_events_ui_get", - "parameters": [ - { - "name": "uid", - "in": "query", - "required": true, - "schema": { - "type": "string", - "title": "Uid" - } - }, - { - "name": "reveal_full_contents", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false, - "title": "Reveal Full Contents" - } - }, - { - "name": "search_term", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string", - "contentMediaType": "application/octet-stream", - "format": "base64url" - }, - { - "type": "null" - } - ], - "title": "Search Term" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/pyro__events__event_datamodels__StealerLogEvent" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/events/tenant/_search": { - "post": { - "tags": [ - "public" - ], - "summary": "Current Tenant Feed", - "operationId": "current_tenant_feed_events_tenant__search_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FeedRequestBody" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_FeedItem_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/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": { - "$ref": "#/components/schemas/PaginatedResults_GlobalFeedItem_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/events/identifiers/{identifier_id}/_search": { - "post": { - "tags": [ - "public" - ], - "summary": "Identifier Feed", - "operationId": "identifier_feed_events_identifiers__identifier_id___search_post", - "parameters": [ - { - "name": "identifier_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Identifier Id" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FeedRequestBody" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_FeedItem_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/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": "identifier_group_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "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/PaginatedResults_FeedItem_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/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/FilterSourceTypes" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/events/filters/severities": { - "get": { - "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/FilterSeverities" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/events/actions": { - "post": { - "tags": [ - "public", - "team=experience" - ], - "summary": "Event Actions", - "operationId": "event_actions_events_actions_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EventActionsBody" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/events/extracted_secrets": { - "post": { - "tags": [ - "private" - ], - "summary": "Fetch Extracted Secrets", - "operationId": "fetch_extracted_secrets_events_extracted_secrets_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EventSecretsBody" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_SecretItem_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/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": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Identifier" - }, - "title": "Response Get Matching Identifiers Events Matching Identifiers Get" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/events/identities": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Identities", - "operationId": "get_identities_events_identities_get", - "parameters": [ - { - "name": "event_uid", - "in": "query", - "required": true, - "schema": { - "type": "string", - "title": "Event Uid" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IdentityProfileBanner" - }, - "title": "Response Get Identities Events Identities Get" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/events/tenant/metadata": { - "patch": { - "tags": [ - "public", - "team=experience" - ], - "summary": "Update Tenant Metadata", - "operationId": "update_tenant_metadata_events_tenant_metadata_patch", - "parameters": [ - { - "name": "uid", - "in": "query", - "required": true, - "schema": { - "type": "string", - "title": "Uid" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateTenantMetadataBody" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantMetadataResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/events/html": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Event Html", - "operationId": "get_event_html_events_html_get", - "parameters": [ - { - "name": "uid", - "in": "query", - "required": true, - "schema": { - "type": "string", - "title": "Uid" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/events/_expand": { - "get": { - "tags": [ - "public", - "team=experience" - ], - "summary": "Expand Event Field", - "operationId": "expand_event_field_events__expand_get", - "parameters": [ - { - "name": "field", - "in": "query", - "required": true, - "schema": { - "$ref": "#/components/schemas/ExpandableField" - } - }, - { - "name": "uid", - "in": "query", - "required": true, - "schema": { - "type": "string", - "title": "Uid" - } - }, - { - "name": "from", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "maximum": 20, - "exclusiveMinimum": 0, - "default": 20, - "title": "Size" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/PaginatedResults_StealerLogCredential_str_" - }, - { - "$ref": "#/components/schemas/PaginatedResults_StealerLogCookie_str_" - } - ], - "title": "Response Expand Event Field Events Expand Get" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/file_analysis/submit": { - "post": { - "tags": [ - "private" - ], - "summary": "Submit Presigned Url", - "operationId": "submit_presigned_url_file_analysis_submit_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileAnalysisSubmit" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/forum-threads/uuid": { - "post": { - "tags": [ - "private" - ], - "summary": "Get Asset Uuid", - "operationId": "get_asset_uuid_forum_threads_uuid_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ForumThreadAssetUuidPayload" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "type": "string", - "title": "Response Get Asset Uuid Forum Threads Uuid Post" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/forum-threads/{uuid}/topic-uid-and-title": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Forum Thread Topic Uid And Title", - "description": "This endpoint is temporary until we migrate all forum thread services to use the asset uuid.", - "operationId": "get_forum_thread_topic_uid_and_title_forum_threads__uuid__topic_uid_and_title_get", - "parameters": [ - { - "name": "uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Uuid" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ForumThreadTopicUidAndTitlePayload" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/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": "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/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/ForumThreadAnalysisMetadataResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/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": "forum_thread_id", - "in": "path", - "required": true, - "schema": { - "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" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ForumThreadTimeline" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/forum-threads/{forum_thread_id}/indicators": { - "get": { - "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" - } - }, - { - "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" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ForumThreadIndicator" - }, - "title": "Response Get Forum Thread Indicators Forum Threads Forum Thread Id Indicators Get" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/forum-threads/{forum_thread_id}/generate-summaries": { - "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/ForumThreadSummariesGenerationPayload" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ForumThreadSummariesResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/forum-threads/{forum_thread_id}/regenerate-summaries": { - "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/ForumThreadSummariesGenerationPayload" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ForumThreadSummariesResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/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" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ForumThreadSummariesResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/free_trials/status": { - "get": { - "tags": [ - "private", - "team=growth" - ], - "summary": "Get Free Trial Status", - "operationId": "get_free_trial_status_free_trials_status_get", - "parameters": [ - { - "name": "module", - "in": "query", - "required": true, - "schema": { - "$ref": "#/components/schemas/HubspotModuleFreeTrialName" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FreeTrialStatusResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/free_trials/activate": { - "post": { - "tags": [ - "private", - "team=growth" - ], - "summary": "Activate Free Trial", - "operationId": "activate_free_trial_free_trials_activate_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActivateFreeTrialRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActivateFreeTrialResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/healthz/": { - "get": { - "tags": [ - "public" - ], - "summary": "Is Api Up And Running", - "operationId": "is_api_up_and_running_healthz__get", - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "type": "string", - "title": "Response Is Api Up And Running Healthz Get" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/identifier-recommendations/": { - "get": { - "tags": [ - "public", - "team=experience" - ], - "summary": "Fetch Identifier Recommendations", - "operationId": "fetch_identifier_recommendations_identifier_recommendations__get", - "parameters": [ - { - "name": "types", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "enum": [ - "domain", - "azure_tenant", - "email", - "username" - ], - "type": "string" - } - }, - { - "type": "null" - } - ], - "title": "Types" - } - }, - { - "name": "query", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Query" - } - }, - { - "name": "from", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "maximum": 100, - "exclusiveMinimum": 0, - "default": 100, - "title": "Size" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_Recommendation_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/identifier-recommendations/actions": { - "post": { - "tags": [ - "public", - "team=experience" - ], - "summary": "Create Action For Identifier Recommendations", - "operationId": "create_action_for_identifier_recommendations_identifier_recommendations_actions_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IdentifierRecommendationActionsBody" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/identifiers/count": { - "get": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Get Identifier Count", - "operationId": "get_identifier_count_identifiers_count_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": 100, - "exclusiveMinimum": 0, - "default": 20, - "title": "Size" - } - }, - { - "name": "order_by", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/IdentifierOrderBy", - "default": "id" - } - }, - { - "name": "query_string", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Query String" - } - }, - { - "name": "feed_owner_id", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Feed Owner Id" - } - }, - { - "name": "is_disabled", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false, - "title": "Is Disabled" - } - }, - { - "name": "parent_group_id", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Parent Group Id" - } - }, - { - "name": "source_group", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdentifierSourceGroup" - }, - { - "type": "null" - } - ], - "default": "ALL", - "title": "Source Group" - } - }, - { - "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": [ - { - "$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", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/IdentifierType" - } - }, - { - "type": "null" - } - ], - "title": "Types" - } - }, - { - "name": "authorization_statuses", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/IdentifierAuthorizationStatus" - } - }, - { - "type": "null" - } - ], - "title": "Authorization Statuses" - } - }, - { - "name": "exact_matches_only", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false, - "title": "Exact Matches Only" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResult_int_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/identifiers/": { - "post": { - "tags": [ - "public", - "team=experience" - ], - "summary": "Create Identifier", - "operationId": "create_public_identifier_identifiers__post", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PublicIdentifierRequestBody" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PublicIdentifierResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "get": { - "tags": [ - "public", - "team=experience", - "feature=identifiers" - ], - "summary": "List Identifiers", - "operationId": "list_identifiers_identifiers__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": 100, - "exclusiveMinimum": 0, - "default": 20, - "title": "Size" - } - }, - { - "name": "order_by", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/IdentifierOrderBy", - "default": "id" - } - }, - { - "name": "is_disabled", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is Disabled" - } - }, - { - "name": "group_id", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Group Id" - } - }, - { - "name": "types", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "enum": [ - "bin", - "ip", - "keyword", - "azure_tenant", - "domain", - "search_query", - "github_repository", - "secret", - "identity" - ], - "type": "string" - } - }, - { - "type": "null" - } - ], - "title": "Types" - } - }, - { - "name": "authorization_status", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdentifierAuthorizationStatus" - }, - { - "type": "null" - } - ], - "title": "Authorization Status" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_PublicIdentifierResponse_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/identifiers/ui": { - "post": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Create Identifier", - "operationId": "create_identifier_identifiers_ui_post", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IdentifierRequestBody" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IdentifierResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "get": { - "tags": [ - "private", - "team=experience", - "feature=identifiers" - ], - "summary": "Get Identifiers", - "operationId": "get_identifiers_identifiers_ui_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": 100, - "exclusiveMinimum": 0, - "default": 20, - "title": "Size" - } - }, - { - "name": "order_by", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/IdentifierOrderBy", - "default": "id" - } - }, - { - "name": "query_string", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Query String" - } - }, - { - "name": "feed_owner_id", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Feed Owner Id" - } - }, - { - "name": "is_disabled", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false, - "title": "Is Disabled" - } - }, - { - "name": "parent_group_id", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Parent Group Id" - } - }, - { - "name": "source_group", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdentifierSourceGroup" - }, - { - "type": "null" - } - ], - "default": "ALL", - "title": "Source Group" - } - }, - { - "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": [ - { - "$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", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/IdentifierType" - } - }, - { - "type": "null" - } - ], - "title": "Types" - } - }, - { - "name": "authorization_statuses", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/IdentifierAuthorizationStatus" - } - }, - { - "type": "null" - } - ], - "title": "Authorization Statuses" - } - }, - { - "name": "exact_matches_only", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false, - "title": "Exact Matches Only" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_Identifier_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/identifiers/ui/{identifier_id}": { - "put": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Update Identifier By Id", - "operationId": "update_identifier_by_id_identifiers_ui__identifier_id__put", - "parameters": [ - { - "name": "identifier_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Identifier Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IdentifierRequestBody" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IdentifierResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "get": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Get Identifier", - "operationId": "get_identifier_identifiers_ui__identifier_id__get", - "parameters": [ - { - "name": "identifier_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Identifier Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IdentifierResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/identifiers/{identifier_id}": { - "put": { - "tags": [ - "public", - "team=experience" - ], - "summary": "Update Identifier", - "operationId": "update_identifier_by_id_public_identifiers__identifier_id__put", - "parameters": [ - { - "name": "identifier_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Identifier Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PublicIdentifierUpdateRequestBody" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PublicIdentifierResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "get": { - "tags": [ - "public", - "team=experience" - ], - "summary": "Get Identifier", - "operationId": "get_identifier_public_identifiers__identifier_id__get", - "parameters": [ - { - "name": "identifier_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Identifier Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PublicIdentifierResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "delete": { - "tags": [ - "public", - "team=experience" - ], - "summary": "Delete Identifier", - "operationId": "delete_identifier_identifiers__identifier_id__delete", - "parameters": [ - { - "name": "identifier_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Identifier Id" - } - } - ], - "responses": { - "202": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/identifiers/identity_by_asset_data": { - "post": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Fetch Identifier By Asset Data", - "operationId": "fetch_identifier_by_asset_data_identifiers_identity_by_asset_data_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/CCBinData" - }, - { - "$ref": "#/components/schemas/IPData" - }, - { - "$ref": "#/components/schemas/BrandData" - }, - { - "$ref": "#/components/schemas/KeywordData" - }, - { - "$ref": "#/components/schemas/AzureTenantData" - }, - { - "$ref": "#/components/schemas/DomainData" - }, - { - "$ref": "#/components/schemas/SearchQueryData" - }, - { - "$ref": "#/components/schemas/GithubRepositoryData" - }, - { - "$ref": "#/components/schemas/CredentialsData" - }, - { - "$ref": "#/components/schemas/EmailData" - }, - { - "$ref": "#/components/schemas/UsernameData" - }, - { - "$ref": "#/components/schemas/SecretData" - }, - { - "$ref": "#/components/schemas/NameData" - } - ], - "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" - } - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IdentifierResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/identifiers/identity_by_email": { - "get": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Fetch Identity By Email", - "operationId": "fetch_identity_by_email_identifiers_identity_by_email_get", - "parameters": [ - { - "name": "email", - "in": "query", - "required": true, - "schema": { - "type": "string", - "format": "email", - "title": "Email" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IdentifierResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/identifiers/identity_by_asset_uuid": { - "get": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Fetch Identity By Asset Uuid", - "operationId": "fetch_identity_by_asset_uuid_identifiers_identity_by_asset_uuid_get", - "parameters": [ - { - "name": "asset_uuid", - "in": "query", - "required": true, - "schema": { - "type": "string", - "title": "Asset Uuid" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IdentifierResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/identifiers/entity_by_domain": { - "get": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Fetch Entity By Domain", - "operationId": "fetch_entity_by_domain_identifiers_entity_by_domain_get", - "parameters": [ - { - "name": "domain_name", - "in": "query", - "required": true, - "schema": { - "type": "string", - "title": "Domain Name" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IdentifierResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/identifiers/merge_identities": { - "post": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Merge Identity Identifiers", - "operationId": "merge_identity_identifiers_identifiers_merge_identities_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MergeIdentitiesBody" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IdentifierResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/identifiers/{identifier_id}/relations": { - "get": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Get Identifier Relations", - "operationId": "get_identifier_relations_identifiers__identifier_id__relations_get", - "parameters": [ - { - "name": "identifier_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Identifier Id" - } - }, - { - "name": "from", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "maximum": 100, - "exclusiveMinimum": 0, - "default": 20, - "title": "Size" - } - }, - { - "name": "order_by", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/IdentifierOrderBy", - "default": "id" - } - }, - { - "name": "query_string", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Query String" - } - }, - { - "name": "feed_owner_id", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Feed Owner Id" - } - }, - { - "name": "is_disabled", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false, - "title": "Is Disabled" - } - }, - { - "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": [ - { - "$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", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/IdentifierType" - } - }, - { - "type": "null" - } - ], - "title": "Types" - } - }, - { - "name": "sort_by", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/ParentIdentifierSortType", - "default": "reversed_fqdn" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_IdentifierRelation_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/identifiers/{identifier_id}/count": { - "get": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Get Identifier Count By Id", - "operationId": "get_identifier_count_by_id_identifiers__identifier_id__count_get", - "parameters": [ - { - "name": "identifier_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Identifier Id" - } - }, - { - "name": "from", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "maximum": 100, - "exclusiveMinimum": 0, - "default": 20, - "title": "Size" - } - }, - { - "name": "order_by", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/IdentifierOrderBy", - "default": "id" - } - }, - { - "name": "query_string", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Query String" - } - }, - { - "name": "feed_owner_id", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Feed Owner Id" - } - }, - { - "name": "is_disabled", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false, - "title": "Is Disabled" - } - }, - { - "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": [ - { - "$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", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/IdentifierType" - } - }, - { - "type": "null" - } - ], - "title": "Types" - } - }, - { - "name": "sort_by", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/ParentIdentifierSortType", - "default": "reversed_fqdn" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResult_int_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/matching-policies": { - "post": { - "tags": [ - "public", - "team=data-engineering" - ], - "summary": "Create Matching Policy", - "operationId": "create_matching_policy_matching_policies_post", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/CreateIncludedKeywordsBody" - }, - { - "$ref": "#/components/schemas/CreateExcludedKeywordsBody" - }, - { - "$ref": "#/components/schemas/CreateLuceneQueryBody" - }, - { - "$ref": "#/components/schemas/CreateAstpCookiesBody" - }, - { - "$ref": "#/components/schemas/CreateAstpDomainBody" - } - ], - "title": "Body" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MatchingPolicyPayload" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "get": { - "tags": [ - "public", - "team=data-engineering" - ], - "summary": "List Matching Policies", - "operationId": "list_matching_policies_matching_policies_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": 25, - "exclusiveMinimum": 0, - "default": 25, - "title": "Size" - } - }, - { - "name": "order", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/OrderType", - "default": "desc" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_MatchingPolicyPayload_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/matching-policies/{policy_uuid}": { - "put": { - "tags": [ - "public", - "team=data-engineering" - ], - "summary": "Update Matching Policy", - "operationId": "update_matching_policy_matching_policies__policy_uuid__put", - "parameters": [ - { - "name": "policy_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Policy Uuid" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateMatchingPolicyBody" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MatchingPolicyPayload" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "get": { - "tags": [ - "public", - "team=data-engineering" - ], - "summary": "Get Matching Policy", - "operationId": "get_matching_policy_matching_policies__policy_uuid__get", - "parameters": [ - { - "name": "policy_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Policy Uuid" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MatchingPolicyPayload" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "delete": { - "tags": [ - "public", - "team=data-engineering" - ], - "summary": "Delete Matching Policy", - "operationId": "delete_matching_policy_matching_policies__policy_uuid__delete", - "parameters": [ - { - "name": "policy_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Policy Uuid" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/matching-policies/by_identifier_id/{identifier_id}": { - "get": { - "tags": [ - "public", - "team=data-engineering" - ], - "summary": "List Matching Policies By Identifier Id", - "operationId": "list_matching_policies_by_identifier_id_matching_policies_by_identifier_id__identifier_id__get", - "parameters": [ - { - "name": "identifier_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Identifier Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MatchingPolicyAssignmentPayload" - }, - "title": "Response List Matching Policies By Identifier Id Matching Policies By Identifier Id Identifier Id Get" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/matching-policies/{policy_uuid}/assignments": { - "get": { - "tags": [ - "public", - "team=data-engineering" - ], - "summary": "List Policy Assignments", - "operationId": "list_policy_assignments_matching_policies__policy_uuid__assignments_get", - "parameters": [ - { - "name": "policy_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Policy Uuid" - } - }, - { - "name": "from", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "exclusiveMinimum": 0, - "default": 25, - "title": "Size" - } - }, - { - "name": "order", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/OrderType", - "default": "desc" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_PolicyAssignedIdentifierPayload_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "post": { - "tags": [ - "public", - "team=data-engineering" - ], - "summary": "Assign Policy", - "operationId": "assign_policy_matching_policies__policy_uuid__assignments_post", - "parameters": [ - { - "name": "policy_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Policy Uuid" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PolicyAssignmentsBody" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "delete": { - "tags": [ - "public", - "team=data-engineering" - ], - "summary": "Unassign Policy", - "operationId": "unassign_policy_matching_policies__policy_uuid__assignments_delete", - "parameters": [ - { - "name": "policy_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Policy Uuid" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PolicyAssignmentsBody" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/matching-policies/{policy_uuid}/assignments/count": { - "get": { - "tags": [ - "private", - "team=data-engineering" - ], - "summary": "Count Assignments", - "operationId": "count_assignments_matching_policies__policy_uuid__assignments_count_get", - "parameters": [ - { - "name": "policy_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Policy Uuid" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AssignmentCountPayload" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/identities/": { - "get": { - "tags": [ - "private" - ], - "summary": "List Identities", - "operationId": "list_identities_identities__get", - "parameters": [ - { - "name": "q", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Q" - } - }, - { - "name": "vip_only", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false, - "title": "Vip Only" - } - }, - { - "name": "entra_id_is_active", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Entra Id Is Active" - } - }, - { - "name": "severity", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "integer" - } - }, - { - "type": "null" - } - ], - "title": "Severity" - } - }, - { - "name": "role_external_ids", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ], - "title": "Role External Ids" - } - }, - { - "name": "role_tiers", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "integer" - } - }, - { - "type": "null" - } - ], - "title": "Role Tiers" - } - }, - { - "name": "group_external_ids", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ], - "title": "Group External Ids" - } - }, - { - "name": "group_tiers", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "integer" - } - }, - { - "type": "null" - } - ], - "title": "Group Tiers" - } - }, - { - "name": "application_external_ids", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ], - "title": "Application External Ids" - } - }, - { - "name": "is_on_premises_sync_enabled", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is On Premises Sync Enabled" - } - }, - { - "name": "is_guest", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is Guest" - } - }, - { - "name": "next", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - { - "name": "sort", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/pyro__entities__identities__identity_browser_sort_type__SortType", - "default": "severity" - } - }, - { - "name": "order", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/OrderType", - "default": "desc" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "maximum": 100, - "exclusiveMinimum": 0, - "default": 10, - "title": "Size" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResultsWithTotalCount_IdentityBrowserItemResponse_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/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": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Asset Uuid" - } - }, - { - "name": "time", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Time" - } - }, - { - "name": "time_zone", - "in": "query", - "required": false, - "schema": { - "type": "string", - "default": "Etc/UTC", - "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", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "default": 20, - "title": "Size" - } - }, - { - "name": "domain", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Domain" - } - }, - { - "name": "keyword", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Keyword" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_Union_EnrichedCredential__EnrichedCookie__str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/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": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Asset Uuid" - } - }, - { - "name": "time", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Time" - } - }, - { - "name": "time_zone", - "in": "query", - "required": false, - "schema": { - "type": "string", - "default": "Etc/UTC", - "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": "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": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/ApplicationExposuresGraph" - }, - { - "type": "null" - } - ], - "title": "Response Get Identity Application Exposures Graph Identities Asset Uuid Application Exposures Graph Get" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/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": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Asset Uuid" - } - }, - { - "name": "time", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Time" - } - }, - { - "name": "time_zone", - "in": "query", - "required": false, - "schema": { - "type": "string", - "default": "Etc/UTC", - "title": "Time Zone" - } - }, - { - "name": "search_type", - "in": "query", - "required": true, - "schema": { - "enum": [ - "stealer_log", - "pii", - "illicit_networks", - "open_web", - "identity_profile_password" - ], - "type": "string", - "title": "Search Type" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RecentActivityCountResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/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": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Asset Uuid" - } - }, - { - "name": "time", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Time" - } - }, - { - "name": "time_zone", - "in": "query", - "required": false, - "schema": { - "type": "string", - "default": "Etc/UTC", - "title": "Time Zone" - } - }, - { - "name": "search_type", - "in": "query", - "required": true, - "schema": { - "enum": [ - "stealer_log", - "pii", - "illicit_networks", - "open_web", - "identity_profile_password" - ], - "type": "string", - "title": "Search Type" - } - }, - { - "name": "next", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "default": 100, - "title": "Size" - } - }, - { - "name": "sort", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/pyro__entities__identities__profile__sort_type__SortType", - "default": "creation_date" - } - }, - { - "name": "order", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/OrderType", - "default": "desc" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RecentActivityResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/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": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Asset Uuid" - } - }, - { - "name": "time", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Time" - } - }, - { - "name": "time_zone", - "in": "query", - "required": false, - "schema": { - "type": "string", - "default": "Etc/UTC", - "title": "Time Zone" - } - }, - { - "name": "aggregate_by", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/StatsAggregates", - "default": "monthly" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TimelineBySearchTypeResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/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": [ - { - "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/IdentityIdPUserPayload" - }, - "title": "Response Get Idp User Data Identities Asset Uuid Idp User Data Get" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/domains/": { - "get": { - "tags": [ - "private" - ], - "summary": "List Domains", - "operationId": "list_domains_domains__get", - "parameters": [ - { - "name": "q", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Q" - } - }, - { - "name": "lookalike_only", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false, - "title": "Lookalike Only" - } - }, - { - "name": "severity", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "integer" - } - }, - { - "type": "null" - } - ], - "title": "Severity" - } - }, - { - "name": "related_domain", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ], - "title": "Related Domain" - } - }, - { - "name": "source", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ], - "title": "Source" - } - }, - { - "name": "updated_dates", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/Times" - }, - { - "type": "null" - } - ], - "title": "Updated Dates" - } - }, - { - "name": "discovered_dates", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/Times" - }, - { - "type": "null" - } - ], - "title": "Discovered Dates" - } - }, - { - "name": "registrar", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ], - "title": "Registrar" - } - }, - { - "name": "registered_dates", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/Times" - }, - { - "type": "null" - } - ], - "title": "Registered Dates" - } - }, - { - "name": "next", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - { - "name": "sort", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/pyro__entities__domain__domain_browser_sort_type__SortType", - "default": "severity" - } - }, - { - "name": "order", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/OrderType", - "default": "desc" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "maximum": 100, - "exclusiveMinimum": 0, - "default": 10, - "title": "Size" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResultsWithTotalCount_DomainBrowserItemResponse_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/domains/registrars": { - "get": { - "tags": [ - "private" - ], - "summary": "List Domain Registrars", - "operationId": "list_domain_registrars_domains_registrars_get", - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DomainRegistrarsResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/domains/{asset_uuid}": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Domain Profile", - "operationId": "get_domain_profile_domains__asset_uuid__get", - "parameters": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Asset Uuid" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DomainProfileResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/domains/{asset_uuid}/event_history": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Domain Event History", - "operationId": "get_domain_event_history_domains__asset_uuid__event_history_get", - "parameters": [ - { - "name": "asset_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Asset Uuid" - } - }, - { - "name": "next", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "default": 100, - "title": "Size" - } - }, - { - "name": "sort", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/pyro__entities__domain__profile__sort_type__SortType", - "default": "date" - } - }, - { - "name": "order", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/OrderType", - "default": "desc" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/DomainEventHistoryResponse" - }, - { - "type": "null" - } - ], - "title": "Response Get Domain Event History Domains Asset Uuid Event History Get" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/leaks/sources": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Sources", - "operationId": "get_sources_leaks_sources_get", - "parameters": [ - { - "name": "source", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Source" - } - }, - { - "name": "order_by", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/LeaksOrderBy", - "default": "name" - } - }, - { - "name": "order_type", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/OrderType", - "default": "asc" - } - }, - { - "name": "from", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "maximum": 100, - "exclusiveMinimum": 0, - "default": 20, - "title": "Size" - } - }, - { - "name": "is_verified", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is Verified" - } - }, - { - "name": "has_credentials", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Has Credentials" - } - }, - { - "name": "has_pii", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Has Pii" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_SourceWithTenantCount_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/logos/": { - "post": { - "tags": [ - "private" - ], - "summary": "Get Logos From Domains", - "operationId": "get_logos_from_domains_logos__post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LogoRequestBody" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LogoResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/organizations/{organization_id}/users/{user_id}/tenants": { - "post": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Add User To Tenants", - "operationId": "add_user_to_tenants_organizations__organization_id__users__user_id__tenants_post", - "parameters": [ - { - "name": "user_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "User Id" - } - }, - { - "name": "organization_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Organization Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BulkAddUserToTenantsRequestBody" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/organizations/{organization_id}/demo_tenant": { - "post": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Create Demo Tenant", - "operationId": "create_demo_tenant_organizations__organization_id__demo_tenant_post", - "parameters": [ - { - "name": "organization_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Organization Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateDemoTenantRequestBody" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantPayload" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/organizations/{organization_id}/events/_stats": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Event Stats", - "operationId": "get_event_stats_organizations__organization_id__events__stats_get", - "parameters": [ - { - "name": "organization_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Organization Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrganizationEventStatsResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/organizations/{organization_id}/members/{user_id}": { - "delete": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Delete Organization Member", - "operationId": "delete_organization_member_organizations__organization_id__members__user_id__delete", - "parameters": [ - { - "name": "organization_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Organization Id" - } - }, - { - "name": "user_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "User Id" - } - } - ], - "responses": { - "204": { - "description": "Successful Response" - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/organizations/{organization_id}/logo": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Organization Logo", - "operationId": "get_organization_logo_organizations__organization_id__logo_get", - "parameters": [ - { - "name": "organization_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Organization Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrganizationLogoResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "post": { - "tags": [ - "private" - ], - "summary": "Upload Organization Logo", - "operationId": "upload_organization_logo_organizations__organization_id__logo_post", - "parameters": [ - { - "name": "organization_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Organization Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/Body_upload_organization_logo_organizations__organization_id__logo_post" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrganizationLogoResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "delete": { - "tags": [ - "private" - ], - "summary": "Delete Organization Logo", - "operationId": "delete_organization_logo_organizations__organization_id__logo_delete", - "parameters": [ - { - "name": "organization_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Organization Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/organizations/{organization_id}/signup_intent": { - "patch": { - "tags": [ - "private", - "team=growth" - ], - "summary": "Update Signup Intent", - "operationId": "update_signup_intent_organizations__organization_id__signup_intent_patch", - "parameters": [ - { - "name": "organization_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Organization Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateSignupIntentRequestBody" - } - } - } - }, - "responses": { - "204": { - "description": "Successful Response" - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/query_assistant/fields": { - "get": { - "tags": [ - "private" - ], - "summary": "Get All Autocomplete Fields", - "operationId": "get_all_autocomplete_fields_query_assistant_fields_get", - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AutocompletionFieldsPayload" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/query_assistant/terms": { - "get": { - "tags": [ - "private" - ], - "summary": "Get All Autocomplete Terms", - "operationId": "get_all_autocomplete_terms_query_assistant_terms_get", - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AutocompletionTermsPayload" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/report_groups/": { - "get": { - "tags": [ - "private" - ], - "summary": "List Report Groups", - "operationId": "list_report_groups_report_groups__get", - "parameters": [ - { - "name": "from_", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From " - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "default": 20, - "title": "Size" - } - }, - { - "name": "include_archived", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false, - "title": "Include Archived" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_ReportGroupData_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/report_groups": { - "post": { - "tags": [ - "private" - ], - "summary": "Create Report Group", - "operationId": "create_report_group_report_groups_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportGroupCreationPayload" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportGroupCreationResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/report_groups/{report_group_id}": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Report Group", - "operationId": "get_report_group_report_groups__report_group_id__get", - "parameters": [ - { - "name": "report_group_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Group Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportGroupData" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "delete": { - "tags": [ - "private" - ], - "summary": "Delete Report Group", - "operationId": "delete_report_group_report_groups__report_group_id__delete", - "parameters": [ - { - "name": "report_group_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Group Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/report_groups/{report_group_id}/archive": { - "post": { - "tags": [ - "private", - "private" - ], - "summary": "Archive Report Group", - "operationId": "archive_report_group_report_groups__report_group_id__archive_post", - "parameters": [ - { - "name": "report_group_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Group Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ArchiveReportGroupParams" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/report_groups/{report_group_id}/reports": { - "get": { - "tags": [ - "private" - ], - "summary": "List Report Group Reports", - "operationId": "list_report_group_reports_report_groups__report_group_id__reports_get", - "parameters": [ - { - "name": "report_group_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Group Id" - } - }, - { - "name": "from_", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From " - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "default": 20, - "title": "Size" - } - }, - { - "name": "include_archived", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false, - "title": "Include Archived" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_ReportData_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/report_groups/{report_group_id}/alert_channels": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Report Alert Channels", - "operationId": "get_report_alert_channels_report_groups__report_group_id__alert_channels_get", - "parameters": [ - { - "name": "report_group_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Group Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ReportAlertChannelData" - }, - "title": "Response Get Report Alert Channels Report Groups Report Group Id Alert Channels Get" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "patch": { - "tags": [ - "private" - ], - "summary": "Update Report Alert Channels", - "operationId": "update_report_alert_channels_report_groups__report_group_id__alert_channels_patch", - "parameters": [ - { - "name": "report_group_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Group Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportAlertChannelUpdatePayload" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/report_groups/{report_group_id}/scheduler": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Report Scheduler", - "operationId": "get_report_scheduler_report_groups__report_group_id__scheduler_get", - "parameters": [ - { - "name": "report_group_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Group Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportSchedulerData" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "patch": { - "tags": [ - "private" - ], - "summary": "Update Report Scheduler", - "operationId": "update_report_scheduler_report_groups__report_group_id__scheduler_patch", - "parameters": [ - { - "name": "report_group_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Group Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportSchedulerUpdatePayload" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/report_groups/{report_group_id}/reports/{report_id}": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Report", - "operationId": "get_report_report_groups__report_group_id__reports__report_id__get", - "parameters": [ - { - "name": "report_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/pyro__firework__backend__api4__reports__report_groups__reports__report_datamodels__ReportResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "patch": { - "tags": [ - "private" - ], - "summary": "Update Report", - "operationId": "update_report_report_groups__report_group_id__reports__report_id__patch", - "parameters": [ - { - "name": "report_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportUpdatePayload" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/pyro__firework__backend__api4__reports__report_groups__reports__report_datamodels__ReportResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "delete": { - "tags": [ - "private" - ], - "summary": "Delete Report", - "operationId": "delete_report_report_groups__report_group_id__reports__report_id__delete", - "parameters": [ - { - "name": "report_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/pyro__firework__backend__api4__reports__report_groups__reports__report_datamodels__ReportResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/report_groups/{report_group_id}/reports/": { - "get": { - "tags": [ - "private" - ], - "summary": "List Reports", - "operationId": "list_reports_report_groups__report_group_id__reports__get", - "parameters": [ - { - "name": "from", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "maximum": 100, - "exclusiveMinimum": 0, - "default": 20, - "title": "Size" - } - }, - { - "name": "order_type", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/OrderType", - "default": "desc" - } - }, - { - "name": "order_by", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/pyro__reports__report_store__SortType", - "default": "updated_at" - } - }, - { - "name": "report_types", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/pyro__reports__report_types__ReportType" - } - }, - { - "type": "null" - } - ], - "title": "Report Types" - } - }, - { - "name": "include_archived", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false, - "title": "Include Archived" - } - }, - { - "name": "include_immutable", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false, - "title": "Include Immutable" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_Report_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/report_groups/{report_group_id}/reports/{report_id}/generate": { - "post": { - "tags": [ - "private" - ], - "summary": "Generate Report", - "operationId": "generate_report_report_groups__report_group_id__reports__report_id__generate_post", - "parameters": [ - { - "name": "report_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/report_groups/{report_group_id}/reports/{report_id}/generate_csv": { - "post": { - "tags": [ - "private" - ], - "summary": "Generate Report Csv", - "operationId": "generate_report_csv_report_groups__report_group_id__reports__report_id__generate_csv_post", - "parameters": [ - { - "name": "report_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/report_groups/{report_group_id}/reports/{report_id}/download": { - "get": { - "tags": [ - "private" - ], - "summary": "Download Report", - "operationId": "download_report_report_groups__report_group_id__reports__report_id__download_get", - "parameters": [ - { - "name": "report_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Id" - } - }, - { - "name": "format", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/ReportDownloadFormat", - "choices": [ - "docx", - "pdf", - "csv", - "zip" - ], - "default": "docx" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/report_groups/{report_group_id}/reports/{report_id}/archive": { - "patch": { - "tags": [ - "private" - ], - "summary": "Archive Report", - "operationId": "archive_report_report_groups__report_group_id__reports__report_id__archive_patch", - "parameters": [ - { - "name": "report_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/pyro__firework__backend__api4__reports__report_groups__reports__report_datamodels__ReportResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/report_groups/{report_group_id}/reports/{report_id}/config": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Report Config", - "operationId": "get_report_config_report_groups__report_group_id__reports__report_id__config_get", - "parameters": [ - { - "name": "report_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportConfigResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "patch": { - "tags": [ - "private" - ], - "summary": "Update Report Config", - "operationId": "update_report_config_report_groups__report_group_id__reports__report_id__config_patch", - "parameters": [ - { - "name": "report_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportConfigUpdatePayload" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportConfigResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/report_groups/{report_group_id}/reports/{report_id}/sections/{uid}": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Report Section", - "operationId": "get_report_section_report_groups__report_group_id__reports__report_id__sections__uid__get", - "parameters": [ - { - "name": "uid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Uid" - } - }, - { - "name": "report_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportSectionResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "patch": { - "tags": [ - "private" - ], - "summary": "Update Report Section", - "operationId": "update_report_section_report_groups__report_group_id__reports__report_id__sections__uid__patch", - "parameters": [ - { - "name": "uid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Uid" - } - }, - { - "name": "report_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportSectionUpdatePayload" - } - } - } - }, - "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/report_groups/{report_group_id}/reports/{report_id}/sections": { - "get": { - "tags": [ - "private" - ], - "summary": "List Report Sections", - "operationId": "list_report_sections_report_groups__report_group_id__reports__report_id__sections_get", - "parameters": [ - { - "name": "report_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Id" - } - }, - { - "name": "from", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "maximum": 100, - "exclusiveMinimum": 0, - "default": 30, - "title": "Size" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_ReportSectionPayload_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/report_groups/{report_group_id}/reports/{report_id}/sections/{uid}/summarize": { - "patch": { - "tags": [ - "private" - ], - "summary": "Generate Summary", - "operationId": "generate_summary_report_groups__report_group_id__reports__report_id__sections__uid__summarize_patch", - "parameters": [ - { - "name": "uid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Uid" - } - }, - { - "name": "report_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Id" - } - } - ], - "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/activity-model-names": { - "post": { - "tags": [ - "private" - ], - "summary": "Get Activity Model Names Source Stats", - "operationId": "get_activity_model_names_source_stats_sources_activity_model_names_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActivityModelNameListParams" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/ActivityModelNameSourceStats" - }, - "type": "array", - "title": "Response Get Activity Model Names Source Stats Sources Activity Model Names Post" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/sources/": { - "post": { - "tags": [ - "private" - ], - "summary": "Get Source List", - "operationId": "get_source_list_sources__post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SourceListParams" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedSources" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/sources/count-by-status": { - "post": { - "tags": [ - "private" - ], - "summary": "Get Source Counts", - "operationId": "get_source_counts_sources_count_by_status_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SourceCountByStatusParams" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SourceCountByStatus" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/sources/count-by-year": { - "post": { - "tags": [ - "private" - ], - "summary": "Get Source Count By Year", - "operationId": "get_source_count_by_year_sources_count_by_year_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SourceCountByYearParams" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/SourceCountByYear" - }, - "type": "array", - "title": "Response Get Source Count By Year Sources Count By Year Post" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/sources/histogram": { - "post": { - "tags": [ - "private" - ], - "summary": "Get Source Histogram", - "operationId": "get_source_histogram_sources_histogram_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SourceHistogramParams" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Histogram" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/sources/source-categories-histogram": { - "post": { - "tags": [ - "private" - ], - "summary": "Get Source Category Histograms", - "operationId": "get_source_category_histograms_sources_source_categories_histogram_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SourcesCategoriesStats" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "additionalProperties": { - "$ref": "#/components/schemas/CategoryStatsHistogram" - }, - "propertyNames": { - "$ref": "#/components/schemas/SourceCategoryV2" - }, - "type": "object", - "title": "Response Get Source Category Histograms Sources Source Categories Histogram Post" - } - } - } - }, - "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/SourceSummary" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/integrations/tenant_integrations": { - "get": { - "tags": [ - "private", - "team=integration" - ], - "summary": "Get Tenant Integrations", - "operationId": "get_tenant_integrations_integrations_tenant_integrations_get", - "parameters": [ - { - "name": "from", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Size" - } - }, - { - "name": "order_type", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/OrderType", - "default": "asc" - } - }, - { - "name": "tenant_id", - "in": "query", - "required": true, - "schema": { - "type": "integer", - "title": "Tenant Id" - } - }, - { - "name": "is_enabled", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is Enabled" - } - }, - { - "name": "include_params", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false, - "title": "Include Params" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_TenantIntegrationItem_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "post": { - "tags": [ - "private", - "team=integration" - ], - "summary": "Create Tenant Integration", - "operationId": "create_tenant_integration_integrations_tenant_integrations_post", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateTenantIntegrationPayload" - } - } - } - }, - "responses": { - "201": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantIntegrationItem" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/integrations/tenant_integrations/{tenant_integration_id}": { - "get": { - "tags": [ - "private", - "team=integration" - ], - "summary": "Get Tenant Integration", - "operationId": "get_tenant_integration_integrations_tenant_integrations__tenant_integration_id__get", - "parameters": [ - { - "name": "tenant_integration_id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Tenant Integration Id" - } - }, - { - "name": "include_params", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false, - "title": "Include Params" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantIntegrationItem" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "put": { - "tags": [ - "private", - "team=integration" - ], - "summary": "Update Tenant Integration", - "operationId": "update_tenant_integration_integrations_tenant_integrations__tenant_integration_id__put", - "parameters": [ - { - "name": "tenant_integration_id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Tenant Integration Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateTenantIntegrationPayload" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "patch": { - "tags": [ - "private", - "team=integration" - ], - "summary": "Update Partial Tenant Integration", - "operationId": "update_partial_tenant_integration_integrations_tenant_integrations__tenant_integration_id__patch", - "parameters": [ - { - "name": "tenant_integration_id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Tenant Integration Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdatePartialTenantIntegrationPayload" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "delete": { - "tags": [ - "private", - "team=integration" - ], - "summary": "Delete Tenant Integration", - "operationId": "delete_tenant_integration_integrations_tenant_integrations__tenant_integration_id__delete", - "parameters": [ - { - "name": "tenant_integration_id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Tenant Integration Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/integrations/tenant_integrations/test": { - "post": { - "tags": [ - "private", - "team=integration" - ], - "summary": "Test Tenant Integration", - "operationId": "test_tenant_integration_integrations_tenant_integrations_test_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TestTenantIntegrationPayload" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantIntegrationStatusResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/integrations/tenant_integrations/{tenant_integration_id}/test": { - "post": { - "tags": [ - "private", - "team=integration" - ], - "summary": "Test Existing Tenant Integration", - "operationId": "test_existing_tenant_integration_integrations_tenant_integrations__tenant_integration_id__test_post", - "parameters": [ - { - "name": "tenant_integration_id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Tenant Integration Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TestTenantIntegrationPayload" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantIntegrationStatusResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/integrations/tenant_integrations/{tenant_integration_id}/idp/revoke_sessions": { - "post": { - "tags": [ - "private", - "team=integration" - ], - "summary": "Revoke Sessions", - "operationId": "revoke_sessions_integrations_tenant_integrations__tenant_integration_id__idp_revoke_sessions_post", - "parameters": [ - { - "name": "tenant_integration_id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Tenant Integration Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RevokeSessionsPayload" - } - } - } - }, - "responses": { - "204": { - "description": "Successful Response" - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/integrations/tenant_integrations/{tenant_integration_id}/idp/disable_account": { - "post": { - "tags": [ - "private", - "team=integration" - ], - "summary": "Disable Account", - "operationId": "disable_account_integrations_tenant_integrations__tenant_integration_id__idp_disable_account_post", - "parameters": [ - { - "name": "tenant_integration_id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Tenant Integration Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DisableAccountPayload" - } - } - } - }, - "responses": { - "204": { - "description": "Successful Response" - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/integrations/tenant_integrations/{tenant_integration_id}/idp/mark_user_as_compromised": { - "post": { - "tags": [ - "private", - "team=integration" - ], - "summary": "Mark User As Compromised", - "operationId": "mark_user_as_compromised_integrations_tenant_integrations__tenant_integration_id__idp_mark_user_as_compromised_post", - "parameters": [ - { - "name": "tenant_integration_id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Tenant Integration Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MarkUserAsCompromisedPayload" - } - } - } - }, - "responses": { - "204": { - "description": "Successful Response" - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/tenants/{tenant_id}/users": { - "put": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Add Tenant Users Put", - "operationId": "add_tenant_users_put_tenants__tenant_id__users_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/BulkAddUsersToTenantRequestBody" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "post": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Create Tenant User", - "operationId": "create_tenant_user_tenants__tenant_id__users_post", - "parameters": [ - { - "name": "tenant_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Tenant Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateTenantUserPayload" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/tenants/{tenant_id}/users/{user_id}/disable": { - "post": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Disable Tenant Member", - "operationId": "disable_tenant_member_tenants__tenant_id__users__user_id__disable_post", - "parameters": [ - { - "name": "tenant_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Tenant Id" - } - }, - { - "name": "user_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "User Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/tenants/{tenant_id}/users/{user_id}/enable": { - "post": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Enable Tenant Member", - "operationId": "enable_tenant_member_tenants__tenant_id__users__user_id__enable_post", - "parameters": [ - { - "name": "tenant_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Tenant Id" - } - }, - { - "name": "user_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "User Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/tenants/{tenant_id}/role": { - "get": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Get Tenant Member Role", - "operationId": "get_tenant_member_role_tenants__tenant_id__role_get", - "parameters": [ - { - "name": "tenant_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Tenant Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantMemberRoleResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/tenants/{tenant_id}/sso_configuration": { - "get": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Get Tenant Sso Configuration", - "operationId": "get_tenant_sso_configuration_tenants__tenant_id__sso_configuration_get", - "parameters": [ - { - "name": "tenant_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Tenant Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/SAMLSSOConfigurationData-Output" - }, - { - "$ref": "#/components/schemas/GoogleSSOConfigurationData" - }, - { - "$ref": "#/components/schemas/NotConfiguredSSOConfigurationData" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "SAML": "#/components/schemas/SAMLSSOConfigurationData-Output", - "Google": "#/components/schemas/GoogleSSOConfigurationData", - "not_configured": "#/components/schemas/NotConfiguredSSOConfigurationData" - } - }, - "title": "Response Get Tenant Sso Configuration Tenants Tenant Id Sso Configuration Get" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "put": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Update Tenant Sso Configuration", - "operationId": "update_tenant_sso_configuration_tenants__tenant_id__sso_configuration_put", - "parameters": [ - { - "name": "tenant_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Tenant Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/SAMLSSOConfigurationData-Input" - }, - { - "$ref": "#/components/schemas/GoogleSSOConfigurationData" - }, - { - "$ref": "#/components/schemas/NotConfiguredSSOConfigurationData" - } - ], - "title": "Payload" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/SAMLSSOConfigurationData-Output" - }, - { - "$ref": "#/components/schemas/GoogleSSOConfigurationData" - }, - { - "$ref": "#/components/schemas/NotConfiguredSSOConfigurationData" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "SAML": "#/components/schemas/SAMLSSOConfigurationData-Output", - "Google": "#/components/schemas/GoogleSSOConfigurationData", - "not_configured": "#/components/schemas/NotConfiguredSSOConfigurationData" - } - }, - "title": "Response Update Tenant Sso Configuration Tenants Tenant Id Sso Configuration Put" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/tenants/{tenant_id}/sso_signing_certificate": { - "get": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Get Tenant Sso Signing Certificate", - "operationId": "get_tenant_sso_signing_certificate_tenants__tenant_id__sso_signing_certificate_get", - "parameters": [ - { - "name": "tenant_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Tenant Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SigningCertificateResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/tenants/{tenant_id}/sso_encryption_certificate": { - "get": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Get Tenant Sso Encryption Certificate", - "operationId": "get_tenant_sso_encryption_certificate_tenants__tenant_id__sso_encryption_certificate_get", - "parameters": [ - { - "name": "tenant_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Tenant Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EncryptionCertificateResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/tenants/{tenant_id}": { - "put": { - "tags": [ - "private", - "team=experience" - ], - "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" - } - } - } - } - } - }, - "delete": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Delete Tenant", - "operationId": "delete_tenant_tenants__tenant_id__delete", - "parameters": [ - { - "name": "tenant_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Tenant Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeleteTenantResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/threat_flow/reports/": { - "get": { - "tags": [ - "public" - ], - "summary": "List Reports", - "operationId": "list_reports_threat_flow_reports__get", - "parameters": [ - { - "name": "from", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "default": 10, - "title": "Size" - } - }, - { - "name": "order", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/OrderType", - "default": "desc" - } - }, - { - "name": "report_types", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/pyro__threat_flow__core__reports__report_store__ReportType" - } - }, - { - "type": "null" - } - ], - "title": "Report Types" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_PydanticThreatFlowReport_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/threat_flow/reports/{report_id}": { - "get": { - "tags": [ - "public" - ], - "summary": "Get Report", - "operationId": "get_report_threat_flow_reports__report_id__get", - "parameters": [ - { - "name": "report_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/pyro__threat_flow__web__v4__reports__models__ReportResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "delete": { - "tags": [ - "public" - ], - "summary": "Delete Report", - "operationId": "delete_report_threat_flow_reports__report_id__delete", - "parameters": [ - { - "name": "report_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/threat_flow/reports/{report_id}/publish": { - "patch": { - "tags": [ - "public" - ], - "summary": "Publish Report", - "operationId": "publish_report_threat_flow_reports__report_id__publish_patch", - "parameters": [ - { - "name": "report_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PublishReportPayload" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/pyro__threat_flow__web__v4__reports__models__ReportResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/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": [ - { - "name": "report_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Id" - } - }, - { - "name": "format", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/ThreatFlowReportDownloadFormat", - "default": "docx" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/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": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RelatedConversationRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RelatedConversationResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/threat_flow/tags/": { - "get": { - "tags": [ - "private" - ], - "summary": "List Tags", - "operationId": "list_tags_threat_flow_tags__get", - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TagListPayload" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/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": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ThreatFlowTenantConfigPayload" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "put": { - "tags": [ - "private" - ], - "summary": "Create Or Update Tenant Config", - "operationId": "create_or_update_tenant_config_threat_flow_tenant_config__put", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ThreatFlowTenantConfigPayload" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ThreatFlowTenantConfigPayload" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/threat_flow/conversation_summary_requests/": { - "post": { - "tags": [ - "private" - ], - "summary": "Create Conversation Summary Request", - "operationId": "create_conversation_summary_request_threat_flow_conversation_summary_requests__post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConversationSummaryRequestPayload" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConversationSummaryRequestResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/threat_flow/reports/requests": { - "post": { - "tags": [ - "public" - ], - "summary": "Create Report Request", - "operationId": "create_report_request_threat_flow_reports_requests_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportRequestPayload" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportRequestResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/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": [ - { - "name": "request_info_id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Request Info Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportRequestInfoResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/sandbox": { - "get": { - "tags": [ - "private", - "team=integration" - ], - "summary": "List Sandbox Submissions", - "operationId": "list_sandbox_submissions_sandbox_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": 100, - "exclusiveMinimum": 0, - "default": 50, - "title": "Size" - } - }, - { - "name": "order_type", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/OrderType", - "default": "desc" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_SandboxSampleSubmission_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/sandbox/submit_url": { - "post": { - "tags": [ - "private", - "team=integration" - ], - "summary": "Submit Url", - "operationId": "submit_url_sandbox_submit_url_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UrlSubmission" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SandboxSubmissionResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/sandbox/{job_id}/vnc_url": { - "get": { - "tags": [ - "private", - "team=integration" - ], - "summary": "Get Vnc Url", - "operationId": "get_vnc_url_sandbox__job_id__vnc_url_get", - "parameters": [ - { - "name": "job_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Job Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SandboxVNCUrlResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/sandbox/file_upload_url": { - "get": { - "tags": [ - "private", - "team=integration" - ], - "summary": "Get File Upload Url", - "operationId": "get_file_upload_url_sandbox_file_upload_url_get", - "parameters": [ - { - "name": "filename", - "in": "query", - "required": true, - "schema": { - "type": "string", - "title": "Filename" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SandboxUploadUrlResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/sandbox/submissions/{submission_uuid}/sample_report": { - "get": { - "tags": [ - "private", - "team=integration" - ], - "summary": "Stream Submission Sample Report", - "operationId": "stream_submission_sample_report_sandbox_submissions__submission_uuid__sample_report_get", - "parameters": [ - { - "name": "submission_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Submission Uuid" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/sandbox/submissions/{submission_uuid}/dynamic_report": { - "get": { - "tags": [ - "private", - "team=integration" - ], - "summary": "Stream Submission Dynamic Report", - "operationId": "stream_submission_dynamic_report_sandbox_submissions__submission_uuid__dynamic_report_get", - "parameters": [ - { - "name": "submission_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Submission Uuid" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/sandbox/submissions/{submission_uuid}/iocs/csv": { - "get": { - "tags": [ - "private", - "team=integration" - ], - "summary": "Stream Iocs Csv", - "operationId": "stream_iocs_csv_sandbox_submissions__submission_uuid__iocs_csv_get", - "parameters": [ - { - "name": "submission_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Submission Uuid" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/sandbox/submissions/{submission_uuid}/archive": { - "post": { - "tags": [ - "private", - "team=integration" - ], - "summary": "Archive Submission", - "operationId": "archive_submission_sandbox_submissions__submission_uuid__archive_post", - "parameters": [ - { - "name": "submission_uuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Submission Uuid" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/hubspot/flare_sync_webhook": { - "post": { - "tags": [ - "public", - "team=experience" - ], - "summary": "Handle Hubspot Flare Sync Webhook", - "operationId": "handle_hubspot_flare_sync_webhook_hubspot_flare_sync_webhook_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HubspotWebhookFlareSyncEvent" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/hubspot/flare_sync_tenant_webhook": { - "post": { - "tags": [ - "public", - "team=experience" - ], - "summary": "Handle Hubspot Flare Sync Tenant Webhook", - "operationId": "handle_hubspot_flare_sync_tenant_webhook_hubspot_flare_sync_tenant_webhook_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HubspotWebhookFlareSyncTenantEvent" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/audit_logs/_search": { - "post": { - "tags": [ - "private" - ], - "summary": "Search Audit Events", - "operationId": "search_audit_events_audit_logs__search_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AuditEventRequestBody" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResultsWithTotalCount_AuditEventItemResponse_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/audit_logs/{audit_log_id}": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Audit Log", - "operationId": "get_audit_log_audit_logs__audit_log_id__get", - "parameters": [ - { - "name": "audit_log_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Audit Log Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AuditEventItemResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/usage/global_search/by_feature": { - "get": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Get Global Search Usage By Feature", - "operationId": "get_global_search_usage_by_feature_usage_global_search_by_feature_get", - "parameters": [ - { - "name": "gte", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Gte" - } - }, - { - "name": "lte", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Lte" - } - }, - { - "name": "tenant_id", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Tenant Id" - } - }, - { - "name": "source", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/GlobalSearchSource", - "default": "all" - } - }, - { - "name": "aggregate_by", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/OverTimeInterval", - "default": "monthly" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GlobalSearchUsageByFeatureResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/usage/global_search/by_member": { - "get": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Get Global Search Usage By Member", - "operationId": "get_global_search_usage_by_member_usage_global_search_by_member_get", - "parameters": [ - { - "name": "gte", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Gte" - } - }, - { - "name": "lte", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Lte" - } - }, - { - "name": "tenant_id", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Tenant Id" - } - }, - { - "name": "source", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/GlobalSearchSource", - "default": "all" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GlobalSearchUsageByMemberData" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/usage/global_search/by_tenant": { - "get": { - "tags": [ - "private", - "team=experience" - ], - "summary": "Get Global Search Usage By Tenant", - "operationId": "get_global_search_usage_by_tenant_usage_global_search_by_tenant_get", - "parameters": [ - { - "name": "gte", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Gte" - } - }, - { - "name": "lte", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Lte" - } - }, - { - "name": "tenant_id", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Tenant Id" - } - }, - { - "name": "source", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/GlobalSearchSource", - "default": "all" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GlobalSearchUsageByTenantData" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/vip_protection/": { - "post": { - "tags": [ - "private", - "team=growth" - ], - "summary": "Create Vip Protection Identifier", - "operationId": "create_vip_protection_identifier_vip_protection__post", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VipProtectionCreateBody" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VipProtectionResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "get": { - "tags": [ - "private", - "team=growth" - ], - "summary": "List Vip Protection Identifiers", - "operationId": "list_vip_protection_identifiers_vip_protection__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": 100, - "exclusiveMinimum": 0, - "default": 20, - "title": "Size" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResultsWithTotalCount_VipProtectionListItem_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/vip_protection/{identifier_id}": { - "put": { - "tags": [ - "private", - "team=growth" - ], - "summary": "Update Vip Protection Identifier", - "operationId": "update_vip_protection_identifier_vip_protection__identifier_id__put", - "parameters": [ - { - "name": "identifier_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Identifier Id" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VipProtectionUpdateRequestBody" - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VipProtectionResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - }, - "get": { - "tags": [ - "private", - "team=growth" - ], - "summary": "Get Vip Protection Identifier", - "operationId": "get_vip_protection_identifier_vip_protection__identifier_id__get", - "parameters": [ - { - "name": "identifier_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Identifier Id" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VipProtectionResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/vip_protection/bulk_delete": { - "post": { - "tags": [ - "private", - "team=growth" - ], - "summary": "Bulk Delete Vip Protection Identifiers", - "operationId": "bulk_delete_vip_protection_identifiers_vip_protection_bulk_delete_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VipProtectionBulkDeleteBody" - } - } - }, - "required": true - }, - "responses": { - "202": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - }, - "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" - }, - "ActivateFreeTrialRequest": { - "properties": { - "module": { - "$ref": "#/components/schemas/HubspotModuleFreeTrialName" - } - }, - "type": "object", - "required": [ - "module" - ], - "title": "ActivateFreeTrialRequest" - }, - "ActivateFreeTrialResponse": { - "properties": { - "module": { - "$ref": "#/components/schemas/HubspotModuleFreeTrialName" - }, - "status": { - "$ref": "#/components/schemas/FreeTrialStatus" - }, - "end_date": { - "type": "string", - "format": "date-time", - "title": "End Date" - } - }, - "type": "object", - "required": [ - "module", - "status", - "end_date" - ], - "title": "ActivateFreeTrialResponse" - }, - "ActivityModelName": { - "type": "string", - "enum": [ - "account", - "actor", - "actor_summary", - "ad", - "attachment", - "blog_post", - "bot", - "bucket", - "bucket_object", - "cc", - "cc_bases", - "chat_channel_summary", - "chat_message", - "cookie", - "docker_image", - "docker_repository", - "document", - "domain", - "domain_certificate", - "domain_favicon", - "domain_dns_records", - "domain_ip_address", - "domain_screenshot", - "domain_title", - "domain_whois_rdap", - "driller", - "driller_forum_post", - "driller_forum_topic", - "driller_google", - "driller_profile", - "driller_source_code", - "event", - "experimental", - "forum_category", - "forum_post", - "forum_profile", - "forum_thread_summary", - "forum_topic", - "host", - "intelligence_object", - "invalid_credential", - "leak", - "leaked_credential", - "leaked_data", - "leaked_file", - "listing", - "lookalike", - "mitigated_credential", - "paste", - "ransomleak", - "ransomleak_file_listing", - "score_event", - "sdo_attack_pattern", - "sdo_campaign", - "sdo_identity", - "sdo_indicator", - "sdo_infrastructure", - "sdo_location", - "sdo_malware", - "sdo_relationship", - "sdo_external_report", - "sdo_threat_actor", - "sdo_threat_actor_group", - "sdo_tool", - "sdo_vulnerability", - "seller", - "service", - "social_media_account", - "source_code_secret", - "stealer_log", - "attachment/telegram", - "threat_flow_summary", - "valid_credential", - "whois" - ], - "title": "ActivityModelName" - }, - "ActivityModelNameListParams": { - "properties": { - "from": { - "type": "integer", - "title": "From", - "default": 0 - }, - "size": { - "type": "integer", - "title": "Size", - "default": 15 - }, - "order_by": { - "$ref": "#/components/schemas/SourceOrderBy", - "default": "title" - }, - "order_type": { - "$ref": "#/components/schemas/OrderType", - "default": "asc" - }, - "search_types": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/SearchType" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Search Types" - }, - "date_range": { - "$ref": "#/components/schemas/DateRangeType", - "default": "last_1m" - } - }, - "type": "object", - "title": "ActivityModelNameListParams" - }, - "ActivityModelNameSourceStats": { - "properties": { - "activity_model_name": { - "$ref": "#/components/schemas/ActivityModelName" - }, - "event_count": { - "type": "integer", - "title": "Event Count" - }, - "sources_stats": { - "additionalProperties": { - "type": "integer" - }, - "type": "object", - "title": "Sources Stats" - } - }, - "type": "object", - "required": [ - "activity_model_name", - "event_count", - "sources_stats" - ], - "title": "ActivityModelNameSourceStats" - }, - "ActivityNode": { - "properties": { - "name": { - "type": "string", - "enum": [ - "stealer_log", - "leak" - ], - "title": "Name" - }, - "count": { - "type": "integer", - "title": "Count" - }, - "type": { - "$ref": "#/components/schemas/ApplicationExposureNodeType", - "readOnly": true - }, - "id": { - "type": "string", - "title": "Id", - "readOnly": true - } - }, - "type": "object", - "required": [ - "name", - "count", - "type", - "id" - ], - "title": "ActivityNode" - }, - "ActivityTenantMetadataEventAction": { - "type": "string", - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ], - "title": "ActivityTenantMetadataEventAction" - }, - "ActivityUid": { - "properties": { - "model_name": { - "$ref": "#/components/schemas/ActivityModelName" - }, - "es_id": { - "type": "string", - "title": "Es Id" - } - }, - "type": "object", - "required": [ - "model_name", - "es_id" - ], - "title": "ActivityUid", - "description": "Pyro cluster document identity\n\nes_id in the Pyro cluster is / and used directly as doc _id" - }, - "ActorAPIResponse": { - "properties": { - "uuid": { - "type": "string", - "title": "Uuid" - }, - "type": { - "$ref": "#/components/schemas/EntityType" - }, - "name": { - "type": "string", - "title": "Name" - }, - "created_by": { - "type": "string", - "title": "Created By" - }, - "sources": { - "items": { - "$ref": "#/components/schemas/CTIEntitySourceAPIResponse" - }, - "type": "array", - "title": "Sources" - }, - "created_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Created At" - }, - "updated_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Updated At" - }, - "first_seen_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "First Seen At" - }, - "last_seen_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Last Seen At" - }, - "confidence": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Confidence" - }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Description" - } - }, - "type": "object", - "required": [ - "uuid", - "type", - "name", - "created_by", - "sources", - "created_at", - "updated_at", - "description" - ], - "title": "ActorAPIResponse" - }, - "ActorAnalysisMetadataResponse": { - "properties": { - "summarized_at": { - "type": "string", - "format": "date-time", - "title": "Summarized At" - }, - "summarization_start_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Summarization Start At" - }, - "summarization_end_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Summarization End At" - }, - "events_summarized_count": { - "type": "integer", - "title": "Events Summarized Count" - }, - "total_events_summary_count": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Total Events Summary 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" - }, - "ActorBodyPayload": { - "properties": { - "actor_id": { - "type": "string", - "title": "Actor Id" - }, - "actor_name": { - "type": "string", - "title": "Actor Name" - }, - "source": { - "type": "string", - "title": "Source" - } - }, - "type": "object", - "required": [ - "actor_id", - "actor_name", - "source" - ], - "title": "ActorBodyPayload" - }, - "ActorCommunicationHandle": { - "properties": { - "platform": { - "type": "string", - "title": "Platform" - }, - "handles": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Handles" - } - }, - "type": "object", - "required": [ - "platform", - "handles" - ], - "title": "ActorCommunicationHandle" - }, - "ActorHeatmapData": { - "properties": { - "per_hour": { - "items": { - "$ref": "#/components/schemas/HourData" - }, - "type": "array", - "title": "Per Hour" - }, - "total_count": { - "type": "integer", - "title": "Total Count" - } - }, - "type": "object", - "required": [ - "per_hour", - "total_count" - ], - "title": "ActorHeatmapData" - }, - "ActorMetadata": { - "properties": { - "first_seen": { - "anyOf": [ - { - "type": "string", - "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" - }, - "aliases": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Aliases", - "default": [] - }, - "actor_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Actor Id" - }, - "actor_name": { - "type": "string", - "title": "Actor Name" - }, - "source": { - "$ref": "#/components/schemas/EnrichedSource" - } - }, - "type": "object", - "required": [ - "actor_name", - "source" - ], - "title": "ActorMetadata" - }, - "ActorNetwork": { - "properties": { - "nodes": { - "items": { - "$ref": "#/components/schemas/BaseNode" - }, - "type": "array", - "title": "Nodes" - }, - "edges": { - "items": { - "$ref": "#/components/schemas/BaseEdge" - }, - "type": "array", - "title": "Edges" - } - }, - "type": "object", - "required": [ - "nodes", - "edges" - ], - "title": "ActorNetwork" - }, - "ActorNetworkGenerationPayload": { - "properties": { - "group_by": { - "$ref": "#/components/schemas/GroupByType" - }, - "force_refresh": { - "type": "boolean", - "title": "Force Refresh", - "default": false - } - }, - "type": "object", - "required": [ - "group_by" - ], - "title": "ActorNetworkGenerationPayload" - }, - "ActorNetworkResponse": { - "properties": { - "request_id": { - "anyOf": [ - { - "type": "string", - "format": "uuid" - }, - { - "type": "null" - } - ], - "title": "Request Id" - }, - "error": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Error" - }, - "network": { - "anyOf": [ - { - "$ref": "#/components/schemas/ActorNetwork" - }, - { - "type": "null" - } - ] - } - }, - "type": "object", - "required": [ - "request_id" - ], - "title": "ActorNetworkResponse" - }, - "ActorSourceDistribution": { - "properties": { - "source": { - "type": "string", - "title": "Source" - }, - "count": { - "type": "integer", - "title": "Count" - } - }, - "type": "object", - "required": [ - "source", - "count" - ], - "title": "ActorSourceDistribution" - }, - "ActorSummariesGenerationPayload": { - "properties": { - "force_refresh": { - "type": "boolean", - "title": "Force Refresh", - "default": false - } - }, - "type": "object", - "title": "ActorSummariesGenerationPayload" - }, - "ActorSummariesResponse": { - "properties": { - "request_id": { - "anyOf": [ - { - "type": "string", - "format": "uuid" - }, - { - "type": "null" - } - ], - "title": "Request Id" - }, - "error": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Error" - }, - "summarized_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Summarized At" - }, - "profile": { - "anyOf": [ - { - "$ref": "#/components/schemas/GeneralProfileSummaryOutput" - }, - { - "type": "null" - } - ] - }, - "heatmap": { - "anyOf": [ - { - "$ref": "#/components/schemas/HeatmapAnalysisOutput" - }, - { - "type": "null" - } - ] - } - }, - "type": "object", - "required": [ - "request_id" - ], - "title": "ActorSummariesResponse" - }, - "ActorThread": { - "properties": { - "thread_id": { - "type": "string", - "title": "Thread Id" - }, - "thread_type": { - "$ref": "#/components/schemas/ThreadType" - }, - "title": { - "type": "string", - "title": "Title" - }, - "source": { - "$ref": "#/components/schemas/EnrichedSource" - }, - "event_count": { - "type": "integer", - "title": "Event Count" - }, - "last_event_at": { - "type": "string", - "format": "date-time", - "title": "Last Event At" - } - }, - "type": "object", - "required": [ - "thread_id", - "thread_type", - "title", - "source", - "event_count", - "last_event_at" - ], - "title": "ActorThread" - }, - "ActorTimeline": { - "properties": { - "aggregate_by": { - "anyOf": [ - { - "$ref": "#/components/schemas/StatsAggregates" - }, - { - "type": "null" - } - ] - }, - "timeline": { - "items": { - "$ref": "#/components/schemas/ActorTimelineEntry" - }, - "type": "array", - "title": "Timeline" - }, - "total_count": { - "type": "integer", - "title": "Total Count" - } - }, - "type": "object", - "required": [ - "timeline", - "total_count" - ], - "title": "ActorTimeline" - }, - "ActorTimelineEntry": { - "properties": { - "date": { - "type": "string", - "format": "date-time", - "title": "Date" - }, - "total_count": { - "type": "integer", - "title": "Total Count" - }, - "source_distribution": { - "items": { - "$ref": "#/components/schemas/ActorSourceDistribution" - }, - "type": "array", - "title": "Source Distribution", - "default": [] - } - }, - "type": "object", - "required": [ - "date", - "total_count" - ], - "title": "ActorTimelineEntry" - }, - "ActorUid": { - "properties": { - "actor_name": { - "type": "string", - "title": "Actor Name" - }, - "actor_id": { - "type": "string", - "title": "Actor Id" - }, - "source": { - "type": "string", - "title": "Source" - } - }, - "type": "object", - "required": [ - "actor_name", - "actor_id", - "source" - ], - "title": "ActorUid" - }, - "AddAllowedRestrictedTermRequest": { - "properties": { - "restricted_term_id": { - "type": "string", - "minLength": 1, - "title": "Restricted Term Id" - }, - "tenant_ids": { - "anyOf": [ - { - "items": { - "type": "integer" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Tenant Ids" - }, - "type": { - "$ref": "#/components/schemas/AllowedRestrictedTermType" - }, - "reason": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Reason" - } - }, - "type": "object", - "required": [ - "restricted_term_id", - "tenant_ids", - "type", - "reason" - ], - "title": "AddAllowedRestrictedTermRequest" - }, - "AdminAuditEventFiltersBody": { - "properties": { - "tenant_ids": { - "anyOf": [ - { - "items": { - "type": "integer" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Tenant Ids" - }, - "user_ids": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "User Ids" - }, - "include_system_audit_events": { - "type": "boolean", - "title": "Include System Audit Events", - "default": false - }, - "action": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/AuditEventAction" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Action" - }, - "gte": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Gte" - }, - "lte": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Lte" - }, - "impersonation": { - "$ref": "#/components/schemas/ImpersonationFilter", - "default": "exclude" - }, - "q": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Q" - }, - "source": { - "$ref": "#/components/schemas/AuditEventSource", - "default": "all" - }, - "type": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/AuditEventAffectedResourceType" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Type" - } - }, - "type": "object", - "title": "AdminAuditEventFiltersBody" - }, - "AdminAuditEventRequestBody": { - "properties": { - "pagination": { - "$ref": "#/components/schemas/AuditEventPagingBody" - }, - "filters": { - "$ref": "#/components/schemas/AdminAuditEventFiltersBody" - } - }, - "type": "object", - "title": "AdminAuditEventRequestBody" - }, - "Alert": { - "properties": { - "feed_definition": { - "$ref": "#/components/schemas/FeedDefinition" - }, - "type": { - "type": "string", - "title": "Type" - }, - "created_at": { - "type": "string", - "title": "Created At" - }, - "updated_at": { - "type": "string", - "title": "Updated At" - }, - "id": { - "type": "integer", - "title": "Id" - }, - "name": { - "type": "string", - "title": "Name" - }, - "tenant_id": { - "type": "integer", - "title": "Tenant Id" - }, - "organization_id": { - "type": "integer", - "title": "Organization Id" - }, - "search_types": { - "items": { - "$ref": "#/components/schemas/SearchType" - }, - "type": "array", - "title": "Search Types" - }, - "experimental_search_types": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Experimental Search Types" - }, - "risks": { - "items": { - "$ref": "#/components/schemas/RiskScore" - }, - "type": "array", - "title": "Risks" - }, - "alert_channel_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Alert Channel Id" - }, - "alert_channel": { - "anyOf": [ - { - "$ref": "#/components/schemas/AlertChannelSummary" - }, - { - "type": "null" - } - ] - }, - "frequency": { - "type": "number", - "title": "Frequency" - }, - "start_at": { - "type": "string", - "title": "Start At" - }, - "identifier_scope": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdentifierScope" - }, - { - "type": "null" - } - ] - } - }, - "type": "object", - "required": [ - "feed_definition", - "type", - "created_at", - "updated_at", - "id", - "name", - "tenant_id", - "organization_id", - "search_types", - "experimental_search_types", - "risks", - "alert_channel_id", - "alert_channel", - "frequency", - "start_at" - ], - "title": "Alert" - }, - "AlertChannel": { - "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "name": { - "type": "string", - "title": "Name" - }, - "type": { - "$ref": "#/components/schemas/AlertType" - }, - "state": { - "$ref": "#/components/schemas/AlertChannelState" - }, - "params": { - "oneOf": [ - { - "$ref": "#/components/schemas/AlertChannelEmailParams" - }, - { - "$ref": "#/components/schemas/AlertChannelSlackParams" - }, - { - "$ref": "#/components/schemas/AlertChannelDiscordParams" - }, - { - "$ref": "#/components/schemas/AlertChannelSplunkParams" - }, - { - "$ref": "#/components/schemas/AlertChannelChannelParams" - }, - { - "$ref": "#/components/schemas/AlertChannelLegacySentinelParams" - }, - { - "$ref": "#/components/schemas/AlertChannelSentinelV2Params" - }, - { - "$ref": "#/components/schemas/AlertChannelTeamsParams" - }, - { - "$ref": "#/components/schemas/AlertChannelJiraParams" - }, - { - "$ref": "#/components/schemas/AlertChannelServiceNowParams" - }, - { - "$ref": "#/components/schemas/AlertChannelWebhookParams" - } - ], - "title": "Params", - "discriminator": { - "propertyName": "type", - "mapping": { - "azure_sentinel": "#/components/schemas/AlertChannelLegacySentinelParams", - "azure_sentinel_v2": "#/components/schemas/AlertChannelSentinelV2Params", - "channel": "#/components/schemas/AlertChannelChannelParams", - "discord": "#/components/schemas/AlertChannelDiscordParams", - "email": "#/components/schemas/AlertChannelEmailParams", - "jira": "#/components/schemas/AlertChannelJiraParams", - "servicenow": "#/components/schemas/AlertChannelServiceNowParams", - "slack": "#/components/schemas/AlertChannelSlackParams", - "splunk": "#/components/schemas/AlertChannelSplunkParams", - "teams": "#/components/schemas/AlertChannelTeamsParams", - "webhook": "#/components/schemas/AlertChannelWebhookParams" - } - } - } - }, - "type": "object", - "required": [ - "id", - "name", - "type", - "state", - "params" - ], - "title": "AlertChannel" - }, - "AlertChannelChannelParams": { - "properties": { - "type": { - "type": "string", - "const": "channel", - "title": "Type" - }, - "alert_channel_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Alert Channel Id" - } - }, - "type": "object", - "required": [ - "type", - "alert_channel_id" - ], - "title": "AlertChannelChannelParams" - }, - "AlertChannelDiscordParams": { - "properties": { - "type": { - "type": "string", - "const": "discord", - "title": "Type" - }, - "webhook_url": { - "type": "string", - "title": "Webhook Url" - } - }, - "type": "object", - "required": [ - "type", - "webhook_url" - ], - "title": "AlertChannelDiscordParams" - }, - "AlertChannelEmailParams": { - "properties": { - "type": { - "type": "string", - "const": "email", - "title": "Type" - }, - "email": { - "type": "string", - "title": "Email" - }, - "json_attachment": { - "type": "boolean", - "title": "Json Attachment", - "default": false - }, - "csv_attachment": { - "type": "boolean", - "title": "Csv Attachment", - "default": false - }, - "subject_tag": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Subject Tag" - }, - "language": { - "$ref": "#/components/schemas/Language", - "default": "en" - } - }, - "type": "object", - "required": [ - "type", - "email" - ], - "title": "AlertChannelEmailParams" - }, - "AlertChannelJiraParams": { - "properties": { - "type": { - "type": "string", - "const": "jira", - "title": "Type" - }, - "server_netloc": { - "type": "string", - "title": "Server Netloc" - }, - "email": { - "type": "string", - "title": "Email" - }, - "api_token": { - "type": "string", - "title": "Api Token" - }, - "project_key": { - "type": "string", - "title": "Project Key" - }, - "labels": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Labels", - "default": [] - }, - "issue_type": { - "type": "string", - "title": "Issue Type" - } - }, - "type": "object", - "required": [ - "type", - "server_netloc", - "email", - "api_token", - "project_key", - "issue_type" - ], - "title": "AlertChannelJiraParams" - }, - "AlertChannelLegacySentinelParams": { - "properties": { - "type": { - "type": "string", - "const": "azure_sentinel", - "title": "Type" - }, - "workspace_id": { - "type": "string", - "title": "Workspace Id" - }, - "shared_key": { - "type": "string", - "title": "Shared Key" - } - }, - "type": "object", - "required": [ - "type", - "workspace_id", - "shared_key" - ], - "title": "AlertChannelLegacySentinelParams" - }, - "AlertChannelSentinelV2Params": { - "properties": { - "type": { - "type": "string", - "const": "azure_sentinel_v2", - "title": "Type" - }, - "entra_client_id": { - "type": "string", - "title": "Entra Client Id" - }, - "entra_tenant_id": { - "type": "string", - "title": "Entra Tenant Id" - }, - "entra_secret": { - "type": "string", - "title": "Entra Secret" - }, - "url": { - "type": "string", - "title": "Url" - } - }, - "type": "object", - "required": [ - "type", - "entra_client_id", - "entra_tenant_id", - "entra_secret", - "url" - ], - "title": "AlertChannelSentinelV2Params" - }, - "AlertChannelServiceNowParams": { - "properties": { - "type": { - "type": "string", - "const": "servicenow", - "title": "Type" - }, - "server_url": { - "type": "string", - "title": "Server Url" - }, - "api_key": { - "type": "string", - "title": "Api Key" - }, - "table_name": { - "type": "string", - "title": "Table Name" - } - }, - "type": "object", - "required": [ - "type", - "server_url", - "api_key", - "table_name" - ], - "title": "AlertChannelServiceNowParams" - }, - "AlertChannelSlackParams": { - "properties": { - "type": { - "type": "string", - "const": "slack", - "title": "Type" - }, - "webhook_url": { - "type": "string", - "title": "Webhook Url" - } - }, - "type": "object", - "required": [ - "type", - "webhook_url" - ], - "title": "AlertChannelSlackParams" - }, - "AlertChannelSplunkParams": { - "properties": { - "type": { - "type": "string", - "const": "splunk", - "title": "Type" - }, - "api_token": { - "type": "string", - "title": "Api Token" - }, - "netloc": { - "type": "string", - "title": "Netloc" - }, - "index": { - "type": "string", - "title": "Index" - }, - "labels": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Labels", - "default": [] - } - }, - "type": "object", - "required": [ - "type", - "api_token", - "netloc", - "index" - ], - "title": "AlertChannelSplunkParams" - }, - "AlertChannelState": { - "properties": { - "status": { - "$ref": "#/components/schemas/AlertChannelStatus" - }, - "message": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Message" - } - }, - "type": "object", - "required": [ - "status" - ], - "title": "AlertChannelState" - }, - "AlertChannelStatus": { - "type": "string", - "enum": [ - "untested", - "error", - "success" - ], - "title": "AlertChannelStatus" - }, - "AlertChannelStatusReponse": { - "properties": { - "status": { - "$ref": "#/components/schemas/AlertChannelStatus" - }, - "message": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Message" - } - }, - "type": "object", - "required": [ - "status", - "message" - ], - "title": "AlertChannelStatusReponse" - }, - "AlertChannelSummary": { - "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "name": { - "type": "string", - "title": "Name" - } - }, - "type": "object", - "required": [ - "id", - "name" - ], - "title": "AlertChannelSummary" - }, - "AlertChannelTeamsParams": { - "properties": { - "type": { - "type": "string", - "const": "teams", - "title": "Type" - }, - "teams_webhook_url": { - "type": "string", - "title": "Teams Webhook Url" - } - }, - "type": "object", - "required": [ - "type", - "teams_webhook_url" - ], - "title": "AlertChannelTeamsParams" - }, - "AlertChannelWebhookParams": { - "properties": { - "type": { - "type": "string", - "const": "webhook", - "title": "Type" - }, - "webhook_url": { - "type": "string", - "title": "Webhook Url" - }, - "secret": { - "type": "string", - "title": "Secret" - }, - "basic_auth": { - "anyOf": [ - { - "$ref": "#/components/schemas/WebhookBasicAuth" - }, - { - "type": "null" - } - ] - }, - "custom_headers": { - "anyOf": [ - { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Custom Headers" - } - }, - "type": "object", - "required": [ - "type", - "webhook_url", - "secret" - ], - "title": "AlertChannelWebhookParams" - }, - "AlertLevelResponse": { - "properties": { - "risk_score": { - "$ref": "#/components/schemas/RiskScore" - } - }, - "type": "object", - "required": [ - "risk_score" - ], - "title": "AlertLevelResponse" - }, - "AlertLevelTimelineItem": { - "properties": { - "alert_level": { - "$ref": "#/components/schemas/RiskScore" - }, - "spans": { - "items": { - "$ref": "#/components/schemas/AlertLevelTimelineSpan" - }, - "type": "array", - "title": "Spans" - } - }, - "type": "object", - "required": [ - "alert_level", - "spans" - ], - "title": "AlertLevelTimelineItem" - }, - "AlertLevelTimelineResponse": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/AlertLevelTimelineItem" - }, - "type": "array", - "title": "Items" - } - }, - "type": "object", - "required": [ - "items" - ], - "title": "AlertLevelTimelineResponse" - }, - "AlertLevelTimelineSpan": { - "properties": { - "from": { - "type": "string", - "format": "date-time", - "title": "From" - }, - "to": { - "type": "string", - "format": "date-time", - "title": "To" - }, - "event_count": { - "type": "integer", - "title": "Event Count" - } - }, - "type": "object", - "required": [ - "from", - "to", - "event_count" - ], - "title": "AlertLevelTimelineSpan" - }, - "AlertType": { - "type": "string", - "enum": [ - "email", - "channel", - "azure_sentinel", - "azure_sentinel_v2", - "slack", - "discord", - "splunk", - "jira", - "teams", - "servicenow", - "webhook" - ], - "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" - }, - "reason": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Reason" - }, - "source": { - "$ref": "#/components/schemas/AllowedRestrictedTermSource" - }, - "asset_uuid": { - "anyOf": [ - { - "type": "string", - "format": "uuid" - }, - { - "type": "null" - } - ], - "title": "Asset Uuid" - } - }, - "type": "object", - "required": [ - "organization_id", - "tenant_id", - "restricted_term_id", - "type", - "reason", - "source" - ], - "title": "AllowedRestrictedTerm" - }, - "AllowedRestrictedTermSource": { - "type": "string", - "enum": [ - "entra_integration", - "manual_entry", - "requested_by_user", - "self_authorized_by_user", - "organization_domain" - ], - "title": "AllowedRestrictedTermSource" - }, - "AllowedRestrictedTermType": { - "type": "string", - "enum": [ - "restricted_term", - "noisy_term", - "domain", - "keyword" - ], - "title": "AllowedRestrictedTermType" - }, - "AnalysisMetadataResponse": { - "properties": { - "summarized_at": { - "type": "string", - "format": "date-time", - "title": "Summarized At" - }, - "summarization_start_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Summarization Start At" - }, - "summarization_end_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Summarization End At" - }, - "events_summarized_count": { - "type": "integer", - "title": "Events Summarized Count" - }, - "total_events_summary_count": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Total Events Summary 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": "AnalysisMetadataResponse" - }, - "ApiReport": { - "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "format_type": { - "$ref": "#/components/schemas/ThreatFlowReportFormatType", - "default": "simple_summary" - }, - "title": { - "type": "string", - "title": "Title" - }, - "subtitle": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Subtitle" - }, - "summary": { - "type": "string", - "title": "Summary" - }, - "content": { - "type": "string", - "title": "Content" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Tags" - }, - "highlights": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Highlights" - }, - "related_activity_uids": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Related Activity Uids" - }, - "created_at": { - "type": "string", - "format": "date-time", - "title": "Created At" - }, - "tenant_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Tenant Id" - } - }, - "type": "object", - "required": [ - "id", - "title", - "subtitle", - "summary", - "content", - "tags", - "highlights", - "related_activity_uids", - "created_at", - "tenant_id" - ], - "title": "ApiReport" - }, - "ApplicationExposureEdge": { - "properties": { - "source_id": { - "type": "string", - "title": "Source Id" - }, - "target_id": { - "type": "string", - "title": "Target Id" - }, - "id": { - "type": "string", - "title": "Id", - "readOnly": true - } - }, - "type": "object", - "required": [ - "source_id", - "target_id", - "id" - ], - "title": "ApplicationExposureEdge" - }, - "ApplicationExposureNodeType": { - "type": "string", - "enum": [ - "identity", - "activity", - "leak", - "application", - "grouped_application", - "idp_application" - ], - "title": "ApplicationExposureNodeType" - }, - "ApplicationExposuresGraph": { - "properties": { - "identity_nodes": { - "items": { - "$ref": "#/components/schemas/IdentityNode" - }, - "type": "array", - "title": "Identity Nodes" - }, - "activity_nodes": { - "items": { - "$ref": "#/components/schemas/ActivityNode" - }, - "type": "array", - "title": "Activity Nodes" - }, - "leak_nodes": { - "items": { - "$ref": "#/components/schemas/LeakNode" - }, - "type": "array", - "title": "Leak Nodes" - }, - "application_nodes": { - "items": { - "$ref": "#/components/schemas/ApplicationNode" - }, - "type": "array", - "title": "Application Nodes" - }, - "grouped_application_node": { - "anyOf": [ - { - "$ref": "#/components/schemas/GroupedApplicationNode" - }, - { - "type": "null" - } - ] - }, - "idp_application_nodes": { - "items": { - "$ref": "#/components/schemas/IdPApplicationNode" - }, - "type": "array", - "title": "Idp Application Nodes" - }, - "identity_activity_edges": { - "items": { - "$ref": "#/components/schemas/ApplicationExposureEdge" - }, - "type": "array", - "title": "Identity Activity Edges" - }, - "activity_leak_edges": { - "items": { - "$ref": "#/components/schemas/ApplicationExposureEdge" - }, - "type": "array", - "title": "Activity Leak Edges" - }, - "leak_application_edges": { - "items": { - "$ref": "#/components/schemas/ApplicationExposureEdge" - }, - "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" - }, - "type": "array", - "title": "Application Idp Edges" - } - }, - "type": "object", - "required": [ - "identity_nodes", - "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" - }, - "ApplicationNode": { - "properties": { - "domain": { - "type": "string", - "title": "Domain" - }, - "name": { - "type": "string", - "title": "Name" - }, - "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" - }, - "risk_score": { - "$ref": "#/components/schemas/RiskScore" - }, - "most_recent_leaked_at": { - "type": "string", - "format": "date-time", - "title": "Most Recent Leaked At" - }, - "idp_type": { - "anyOf": [ - { - "$ref": "#/components/schemas/TenantIntegrationType" - }, - { - "type": "null" - } - ] - }, - "type": { - "$ref": "#/components/schemas/ApplicationExposureNodeType", - "readOnly": true - }, - "id": { - "type": "string", - "title": "Id", - "readOnly": true - } - }, - "type": "object", - "required": [ - "domain", - "name", - "activity_types", - "leak_types", - "risk_score", - "most_recent_leaked_at", - "type", - "id" - ], - "title": "ApplicationNode" - }, - "ArchiveReportGroupParams": { - "properties": { - "is_archived": { - "type": "boolean", - "title": "Is Archived" - } - }, - "type": "object", - "required": [ - "is_archived" - ], - "title": "ArchiveReportGroupParams" - }, - "Asset": { - "properties": { - "uuid": { - "type": "string", - "title": "Uuid" - }, - "data": { - "oneOf": [ - { - "$ref": "#/components/schemas/CCBinData" - }, - { - "$ref": "#/components/schemas/IPData" - }, - { - "$ref": "#/components/schemas/BrandData" - }, - { - "$ref": "#/components/schemas/KeywordData" - }, - { - "$ref": "#/components/schemas/AzureTenantData" - }, - { - "$ref": "#/components/schemas/DomainData" - }, - { - "$ref": "#/components/schemas/NameData" - }, - { - "$ref": "#/components/schemas/SearchQueryData" - }, - { - "$ref": "#/components/schemas/GithubRepositoryData" - }, - { - "$ref": "#/components/schemas/UsernameData" - }, - { - "$ref": "#/components/schemas/EmailData" - }, - { - "$ref": "#/components/schemas/SecretData" - }, - { - "$ref": "#/components/schemas/CredentialsData" - }, - { - "$ref": "#/components/schemas/IdentityData" - }, - { - "$ref": "#/components/schemas/RansomLeakData" - } - ], - "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", - "ransomleak": "#/components/schemas/RansomLeakData", - "search_query": "#/components/schemas/SearchQueryData", - "secret": "#/components/schemas/SecretData", - "username": "#/components/schemas/UsernameData" - } - } - }, - "is_authorized": { - "type": "boolean", - "title": "Is Authorized" - }, - "is_restricted": { - "type": "boolean", - "title": "Is Restricted" - } - }, - "type": "object", - "required": [ - "uuid", - "data", - "is_authorized", - "is_restricted" - ], - "title": "Asset" - }, - "AssetEnrichmentType": { - "type": "string", - "enum": [ - "domain" - ], - "title": "AssetEnrichmentType" - }, - "AssetRelationType": { - "type": "string", - "enum": [ - "analysis_of", - "attributed_to", - "authored_by", - "based_on", - "beacons_to", - "characterizes", - "commits_with", - "communicates_with", - "compromises", - "consists_of", - "contributed_to", - "controls", - "delivers", - "downloads", - "drops", - "dynamic_analysis_of", - "exfiltrate_to", - "exploits", - "found_from", - "has", - "has_account_on", - "has_favicon", - "has_screenshot", - "hosts", - "impersonates", - "indicates", - "investigates", - "links_to_azure_tenant", - "located_at", - "looks_like", - "mentioned_in", - "mitigates", - "originates_from", - "owns", - "related_to", - "resolves_to", - "static_analysis_of", - "subdomain_of", - "targets", - "uses", - "variant_of" - ], - "title": "AssetRelationType" - }, - "AssetResponse": { - "properties": { - "asset": { - "anyOf": [ - { - "$ref": "#/components/schemas/Asset" - }, - { - "type": "null" - } - ] - } - }, - "type": "object", - "required": [ - "asset" - ], - "title": "AssetResponse" - }, - "AssetType": { - "type": "string", - "enum": [ - "account", - "azure_tenant", - "bin", - "brand", - "credentials", - "cve", - "directory", - "domain", - "email", - "external_id", - "favicon", - "file", - "filename", - "canonical_name", - "country", - "github_repository", - "ip", - "ipv6_addr", - "keyword", - "mac_addr", - "mitre_technique", - "mutex", - "name", - "ransomleak", - "screenshot", - "search_query", - "secret", - "thread", - "url", - "user_id", - "username", - "windows_registry_key", - "x509_certificate", - "actor", - "attack_pattern", - "chat_channel", - "campaign", - "external_report", - "forum_thread", - "identity", - "indicator", - "infrastructure", - "location", - "malware", - "organization", - "threat_actor", - "threat_actor_group", - "tool", - "vulnerability" - ], - "title": "AssetType" - }, - "AssignmentCountPayload": { - "properties": { - "count": { - "type": "integer", - "title": "Count", - "description": "The number of identifiers this policy is assigned to" - } - }, - "type": "object", - "required": [ - "count" - ], - "title": "AssignmentCountPayload" - }, - "AstpCookiesValue": { - "properties": { - "cookie_names": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Cookie Names", - "description": "The cookie names to monitor" - }, - "match_subdomains": { - "type": "boolean", - "title": "Match Subdomains", - "description": "Whether this policy will be applied to monitor subdomains of the assigned domain identifiers", - "default": false - } - }, - "type": "object", - "required": [ - "cookie_names" - ], - "title": "AstpCookiesValue" - }, - "AstpDomainValue": { - "properties": { - "match_mode": { - "$ref": "#/components/schemas/DomainMatchMode", - "description": "The domain match mode for this policy", - "default": "email_domain_only" - } - }, - "type": "object", - "title": "AstpDomainValue" - }, - "AsyncRequestStatus": { - "type": "string", - "enum": [ - "pending", - "processing", - "completed", - "error" - ], - "title": "AsyncRequestStatus" - }, - "AsyncRequestType": { - "type": "string", - "enum": [ - "actor_summary", - "chat_channel_summary", - "chat_channel_topic_classification", - "delete_tenant", - "intel", - "event_translation" - ], - "title": "AsyncRequestType" - }, - "AttackPatternEntityAPIResponse": { - "properties": { - "uuid": { - "type": "string", - "title": "Uuid" - }, - "type": { - "$ref": "#/components/schemas/EntityType" - }, - "name": { - "type": "string", - "title": "Name" - }, - "created_by": { - "type": "string", - "title": "Created By" - }, - "sources": { - "items": { - "$ref": "#/components/schemas/CTIEntitySourceAPIResponse" - }, - "type": "array", - "title": "Sources" - }, - "created_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Created At" - }, - "updated_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Updated At" - }, - "first_seen_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "First Seen At" - }, - "last_seen_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Last Seen At" - }, - "confidence": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Confidence" - }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Description" - }, - "kill_chain_phases": { - "items": { - "$ref": "#/components/schemas/KillChainAPIResponse" - }, - "type": "array", - "title": "Kill Chain Phases" - }, - "marking_definitions": { - "items": { - "$ref": "#/components/schemas/MarkingDefinition" - }, - "type": "array", - "title": "Marking Definitions" - } - }, - "type": "object", - "required": [ - "uuid", - "type", - "name", - "created_by", - "sources", - "created_at", - "updated_at", - "description", - "kill_chain_phases", - "marking_definitions" - ], - "title": "AttackPatternEntityAPIResponse" - }, - "AuditEventAction": { - "type": "string", - "enum": [ - "created", - "updated", - "deleted", - "viewed" - ], - "title": "AuditEventAction" - }, - "AuditEventActorData": { - "properties": { - "user_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "User Id" - }, - "user_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "User Name" - }, - "user_email": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "User Email" - }, - "organization_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Organization Id" - }, - "tenant_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Tenant Id" - }, - "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" - }, - "cloudfront_headers": { - "anyOf": [ - { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Cloudfront Headers" - }, - "impersonator_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Impersonator Id" - }, - "impersonator_email": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Impersonator Email" - }, - "impersonator_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Impersonator Name" - } - }, - "type": "object", - "required": [ - "user_id", - "user_name", - "user_email", - "organization_id", - "tenant_id", - "ip", - "user_agent", - "flare_referer", - "cloudfront_headers" - ], - "title": "AuditEventActorData" - }, - "AuditEventAffectedEntitiesResponse": { - "properties": { - "affected_organization_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Affected Organization Id" - }, - "affected_tenant_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Affected Tenant Id" - }, - "affected_tenant_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Affected Tenant Name" - }, - "affected_user_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Affected User Id" - } - }, - "type": "object", - "required": [ - "affected_organization_id", - "affected_tenant_id", - "affected_tenant_name", - "affected_user_id" - ], - "title": "AuditEventAffectedEntitiesResponse" - }, - "AuditEventAffectedResourceType": { - "type": "string", - "enum": [ - "event", - "alert", - "alert_channel", - "asset_relation", - "authorize_asset_request", - "blacklisted_term", - "credential", - "identifier", - "identifier_recommendation", - "integration", - "user", - "organization", - "page_view", - "priority_action", - "sandbox", - "global_search", - "sensitive_data", - "tenant", - "tenant_membership", - "threat_flow", - "allowed_restricted_term", - "hubspot", - "feature_flag", - "app_banner" - ], - "title": "AuditEventAffectedResourceType" - }, - "AuditEventFiltersBody": { - "properties": { - "tenant_ids": { - "anyOf": [ - { - "items": { - "type": "integer" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Tenant Ids" - }, - "user_ids": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "User Ids" - }, - "include_system_audit_events": { - "type": "boolean", - "title": "Include System Audit Events", - "default": false - }, - "action": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/AuditEventAction" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Action" - }, - "gte": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Gte" - }, - "lte": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Lte" - }, - "impersonation": { - "$ref": "#/components/schemas/ImpersonationFilter", - "default": "exclude" - }, - "q": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Q" - }, - "source": { - "$ref": "#/components/schemas/AuditEventSource", - "default": "all" - }, - "type": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/PublicAuditEventAffectedResourceType" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Type" - } - }, - "type": "object", - "title": "AuditEventFiltersBody" - }, - "AuditEventItemResponse": { - "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "created_at": { - "type": "string", - "format": "date-time", - "title": "Created At" - }, - "data": { - "additionalProperties": true, - "type": "object", - "title": "Data" - }, - "original_data": { - "anyOf": [ - { - "additionalProperties": true, - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Original Data" - }, - "affected_entities": { - "$ref": "#/components/schemas/AuditEventAffectedEntitiesResponse" - }, - "actor_data": { - "anyOf": [ - { - "$ref": "#/components/schemas/AuditEventActorData" - }, - { - "type": "null" - } - ] - }, - "type": { - "$ref": "#/components/schemas/AuditEventAffectedResourceType" - }, - "action": { - "anyOf": [ - { - "$ref": "#/components/schemas/AuditEventAction" - }, - { - "type": "null" - } - ] - }, - "source": { - "anyOf": [ - { - "$ref": "#/components/schemas/AuditEventSource" - }, - { - "type": "null" - } - ] - }, - "is_impersonated": { - "type": "boolean", - "title": "Is Impersonated", - "default": false - } - }, - "type": "object", - "required": [ - "id", - "created_at", - "data", - "original_data", - "affected_entities", - "actor_data", - "type", - "action", - "source" - ], - "title": "AuditEventItemResponse" - }, - "AuditEventPagingBody": { - "properties": { - "from_": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From" - }, - "order": { - "$ref": "#/components/schemas/OrderType", - "default": "desc" - }, - "size": { - "type": "integer", - "title": "Size", - "default": 50 - } - }, - "type": "object", - "title": "AuditEventPagingBody" - }, - "AuditEventRequestBody": { - "properties": { - "pagination": { - "$ref": "#/components/schemas/AuditEventPagingBody" - }, - "filters": { - "$ref": "#/components/schemas/AuditEventFiltersBody" - } - }, - "type": "object", - "title": "AuditEventRequestBody" - }, - "AuditEventSource": { - "type": "string", - "enum": [ - "all", - "api", - "platform" - ], - "title": "AuditEventSource" - }, - "AuthDomainQuery": { - "properties": { - "type": { - "type": "string", - "const": "auth_domain", - "title": "Type" - }, - "fqdn": { - "type": "string", - "title": "Fqdn" - } - }, - "type": "object", - "required": [ - "type", - "fqdn" - ], - "title": "AuthDomainQuery" - }, - "AuthorizationRequestFilters": { - "properties": { - "value": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Value" - }, - "status": { - "anyOf": [ - { - "$ref": "#/components/schemas/AuthorizeAssetRequestStatus" - }, - { - "type": "null" - } - ] - }, - "tenant_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Tenant Id" - }, - "organization_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Organization Id" - } - }, - "type": "object", - "title": "AuthorizationRequestFilters" - }, - "AuthorizationRequestItem": { - "properties": { - "organization_id": { - "type": "integer", - "title": "Organization Id" - }, - "status": { - "$ref": "#/components/schemas/AuthorizeAssetRequestStatus" - }, - "requested_by": { - "$ref": "#/components/schemas/AuthorizationRequestItemRequestedBy" - }, - "tenant": { - "$ref": "#/components/schemas/AuthorizationRequestItemTenant" - }, - "reason": { - "type": "string", - "title": "Reason" - }, - "requested_at": { - "type": "string", - "format": "date-time", - "title": "Requested At" - }, - "asset": { - "$ref": "#/components/schemas/AuthorizationRequestItemAsset" - }, - "reviewed_by": { - "anyOf": [ - { - "$ref": "#/components/schemas/AuthorizationRequestItemReviewedBy" - }, - { - "type": "null" - } - ] - } - }, - "type": "object", - "required": [ - "organization_id", - "status", - "requested_by", - "tenant", - "reason", - "requested_at", - "asset", - "reviewed_by" - ], - "title": "AuthorizationRequestItem" - }, - "AuthorizationRequestItemAsset": { - "properties": { - "type": { - "$ref": "#/components/schemas/AssetType" - }, - "uuid": { - "type": "string", - "title": "Uuid" - }, - "value": { - "type": "string", - "title": "Value" - } - }, - "type": "object", - "required": [ - "type", - "uuid", - "value" - ], - "title": "AuthorizationRequestItemAsset" - }, - "AuthorizationRequestItemRequestedBy": { - "properties": { - "user_id": { - "type": "integer", - "title": "User Id" - }, - "user_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "User Name" - } - }, - "type": "object", - "required": [ - "user_id", - "user_name" - ], - "title": "AuthorizationRequestItemRequestedBy" - }, - "AuthorizationRequestItemReviewedBy": { - "properties": { - "user_id": { - "type": "integer", - "title": "User Id" - }, - "user_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "User Name" - }, - "reviewed_at": { - "type": "string", - "format": "date-time", - "title": "Reviewed At" - } - }, - "type": "object", - "required": [ - "user_id", - "user_name", - "reviewed_at" - ], - "title": "AuthorizationRequestItemReviewedBy" - }, - "AuthorizationRequestItemTenant": { - "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "name": { - "type": "string", - "title": "Name" - } - }, - "type": "object", - "required": [ - "id", - "name" - ], - "title": "AuthorizationRequestItemTenant" - }, - "AuthorizationResponse": { - "properties": { - "success": { - "type": "boolean", - "title": "Success" - }, - "error_message": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Error Message" - } - }, - "type": "object", - "required": [ - "success", - "error_message" - ], - "title": "AuthorizationResponse" - }, - "AuthorizeAssetRequestStatus": { - "type": "string", - "enum": [ - "pending", - "approved", - "rejected" - ], - "title": "AuthorizeAssetRequestStatus" - }, - "AutocompletionField": { - "properties": { - "value": { - "type": "string", - "title": "Value" - }, - "description": { - "type": "string", - "title": "Description" - } - }, - "type": "object", - "required": [ - "value", - "description" - ], - "title": "AutocompletionField" - }, - "AutocompletionFieldsPayload": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/AutocompletionField" - }, - "type": "array", - "title": "Items" - } - }, - "type": "object", - "required": [ - "items" - ], - "title": "AutocompletionFieldsPayload" - }, - "AutocompletionTerm": { - "properties": { - "value": { - "type": "string", - "title": "Value" - }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Description" - } - }, - "type": "object", - "required": [ - "value" - ], - "title": "AutocompletionTerm" - }, - "AutocompletionTermsPayload": { - "properties": { - "items": { - "additionalProperties": { - "items": { - "$ref": "#/components/schemas/AutocompletionTerm" - }, - "type": "array" - }, - "type": "object", - "title": "Items" - } - }, - "type": "object", - "required": [ - "items" - ], - "title": "AutocompletionTermsPayload" - }, - "AzureTenantData": { - "properties": { - "type": { - "type": "string", - "const": "azure_tenant", - "title": "Type", - "default": "azure_tenant" - }, - "tenant_id": { - "type": "string", - "minLength": 1, - "title": "Tenant Id" - } - }, - "type": "object", - "required": [ - "tenant_id" - ], - "title": "AzureTenantData" - }, - "AzureTenantQuery": { - "properties": { - "type": { - "type": "string", - "const": "azure_tenant", - "title": "Type" - }, - "tenant_id": { - "type": "string", - "title": "Tenant Id" - } - }, - "type": "object", - "required": [ - "type", - "tenant_id" - ], - "title": "AzureTenantQuery" - }, - "BannerResponse": { - "properties": { - "message": { - "type": "string", - "title": "Message" - }, - "variant": { - "$ref": "#/components/schemas/BannerVariant" - }, - "scope": { - "$ref": "#/components/schemas/BannerScope" - } - }, - "type": "object", - "required": [ - "message", - "variant", - "scope" - ], - "title": "BannerResponse" - }, - "BannerScope": { - "type": "string", - "enum": [ - "global", - "organization", - "tenant" - ], - "title": "BannerScope" - }, - "BannerVariant": { - "type": "string", - "enum": [ - "info", - "warning", - "critical" - ], - "title": "BannerVariant" - }, - "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": { - "type": "string", - "const": "bin", - "title": "Type" - }, - "bin": { - "type": "string", - "title": "Bin" - } - }, - "type": "object", - "required": [ - "type", - "bin" - ], - "title": "BinQuery" - }, - "BlogPostData": { - "properties": { - "url": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Url", - "description": "The URL of the blog post." - }, - "content": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Content", - "description": "The content of the blog post." - }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Description", - "description": "The description of the blog post." - }, - "posted_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Posted At", - "description": "The date and time the blog post was posted." - } - }, - "type": "object", - "required": [ - "url", - "content", - "description", - "posted_at" - ], - "title": "BlogPostData" - }, - "BlogPostEvent": { - "properties": { - "event_type": { - "type": "string", - "const": "blog_post", - "title": "Event Type", - "default": "blog_post" - }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" - }, - "data": { - "$ref": "#/components/schemas/BlogPostData" - } - }, - "type": "object", - "required": [ - "metadata", - "data" - ], - "title": "Blog Post" - }, - "Body_parse_csv_admin_tenants__tenant_id__flare_community_parse_csv_post": { - "properties": { - "csv_file": { - "type": "string", - "contentMediaType": "application/octet-stream", - "title": "Csv File" - } - }, - "type": "object", - "required": [ - "csv_file" - ], - "title": "Body_parse_csv_admin_tenants__tenant_id__flare_community_parse_csv_post" - }, - "Body_upload_organization_logo_organizations__organization_id__logo_post": { - "properties": { - "logo": { - "type": "string", - "contentMediaType": "application/octet-stream", - "title": "Logo" - } - }, - "type": "object", - "required": [ - "logo" - ], - "title": "Body_upload_organization_logo_organizations__organization_id__logo_post" - }, - "BrandData": { - "properties": { - "type": { - "type": "string", - "const": "brand", - "title": "Type", - "default": "brand" - }, - "name": { - "type": "string", - "minLength": 1, - "title": "Name" - } - }, - "type": "object", - "required": [ - "name" - ], - "title": "BrandData" - }, - "BrandQuery": { - "properties": { - "type": { - "type": "string", - "const": "brand", - "title": "Type" - }, - "name": { - "type": "string", - "title": "Name" - } - }, - "type": "object", - "required": [ - "type", - "name" - ], - "title": "BrandQuery" - }, - "BucketData": { - "properties": { - "host": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Host", - "description": "The host of the bucket." - }, - "provider": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Provider", - "description": "The provider of the bucket." - } - }, - "type": "object", - "required": [ - "host", - "provider" - ], - "title": "BucketData" - }, - "BucketEvent": { - "properties": { - "event_type": { - "type": "string", - "const": "bucket", - "title": "Event Type", - "default": "bucket" - }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" - }, - "data": { - "$ref": "#/components/schemas/BucketEventData" - } - }, - "type": "object", - "required": [ - "metadata", - "data" - ], - "title": "Bucket" - }, - "BucketEventData": { - "properties": { - "url": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Url", - "description": "The URL to the bucket." - }, - "bucket": { - "$ref": "#/components/schemas/BucketData" - } - }, - "type": "object", - "required": [ - "url", - "bucket" - ], - "title": "BucketEventData" - }, - "BulkActionStatus": { - "type": "string", - "enum": [ - "ongoing", - "completed", - "pending" - ], - "title": "BulkActionStatus" - }, - "BulkActionTargetType": { - "type": "string", - "enum": [ - "identifier", - "feed", - "group", - "identifier_recommendation", - "identifier_recommendation_group", - "credential", - "tenant_integration", - "event" - ], - "title": "BulkActionTargetType" - }, - "BulkActionType": { - "type": "string", - "enum": [ - "clean_feed", - "move_feed", - "materializing", - "enable", - "disable", - "disable_tenant", - "delete", - "export", - "move", - "edit", - "edit_event", - "update_count", - "accept_recommendation", - "reject_recommendation", - "remediate", - "unremediate", - "ignore", - "unignore", - "validate_with_idp", - "authorize" - ], - "title": "BulkActionType" - }, - "BulkActionsRequestBody": { - "properties": { - "statuses": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/BulkActionStatus" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Statuses" - }, - "include_errors": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Include Errors" - }, - "created_after": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Created After", - "default": "2026-06-07T18:47:16.905035Z" - }, - "from": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From" - }, - "size": { - "type": "integer", - "maximum": 20.0, - "exclusiveMinimum": 0.0, - "title": "Size", - "default": 20 - } - }, - "type": "object", - "title": "BulkActionsRequestBody" - }, - "BulkAddUserToTenantsRequestBody": { - "properties": { - "tenants": { - "items": { - "$ref": "#/components/schemas/TenantUserAccess" - }, - "type": "array", - "title": "Tenants" - } - }, - "type": "object", - "required": [ - "tenants" - ], - "title": "BulkAddUserToTenantsRequestBody" - }, - "BulkAddUsersToTenantRequestBody": { - "properties": { - "users": { - "items": { - "$ref": "#/components/schemas/UserTenantAccess" - }, - "type": "array", - "title": "Users" - } - }, - "type": "object", - "required": [ - "users" - ], - "title": "BulkAddUsersToTenantRequestBody" - }, - "CCBinData": { - "properties": { - "type": { - "type": "string", - "const": "bin", - "title": "Type", - "default": "bin" - }, - "bin": { - "type": "string", - "minLength": 1, - "title": "Bin" - } - }, - "type": "object", - "required": [ - "bin" - ], - "title": "CCBinData" - }, - "CSVParseResponse": { - "properties": { - "users": { - "items": { - "$ref": "#/components/schemas/ProvisionUserItemRequest" - }, - "type": "array", - "title": "Users" - }, - "count": { - "type": "integer", - "title": "Count" - } - }, - "type": "object", - "required": [ - "users", - "count" - ], - "title": "CSVParseResponse" - }, - "CTIEntityRelationshipResponse": { - "properties": { - "source_entity": { - "$ref": "#/components/schemas/EntityData" - }, - "target_entity": { - "$ref": "#/components/schemas/EntityData" - }, - "relation_type": { - "$ref": "#/components/schemas/AssetRelationType" - }, - "sources": { - "items": { - "$ref": "#/components/schemas/CTIEntitySourceAPIResponse" - }, - "type": "array", - "title": "Sources" - }, - "modified_at": { - "type": "string", - "format": "date-time", - "title": "Modified At" - }, - "valid_from": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Valid From" - }, - "valid_until": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Valid Until" - } - }, - "type": "object", - "required": [ - "source_entity", - "target_entity", - "relation_type", - "sources", - "modified_at" - ], - "title": "CTIEntityRelationshipResponse" - }, - "CTIEntitySourceAPIResponse": { - "properties": { - "id": { - "type": "string", - "title": "Id" - }, - "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Name" - }, - "confidence": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Confidence" - } - }, - "type": "object", - "required": [ - "id" - ], - "title": "CTIEntitySourceAPIResponse" - }, - "CTIEntityType": { - "type": "string", - "enum": [ - "actor", - "attack_pattern", - "campaign", - "chat_channel", - "external_report", - "forum_thread", - "indicator", - "infrastructure", - "location", - "malware", - "threat_actor", - "threat_actor_group", - "tool", - "vulnerability" - ] - }, - "CampaignEntityAPIResponse": { - "properties": { - "uuid": { - "type": "string", - "title": "Uuid" - }, - "type": { - "$ref": "#/components/schemas/EntityType" - }, - "name": { - "type": "string", - "title": "Name" - }, - "created_by": { - "type": "string", - "title": "Created By" - }, - "sources": { - "items": { - "$ref": "#/components/schemas/CTIEntitySourceAPIResponse" - }, - "type": "array", - "title": "Sources" - }, - "created_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Created At" - }, - "updated_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Updated At" - }, - "first_seen_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "First Seen At" - }, - "last_seen_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Last Seen At" - }, - "confidence": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Confidence" - }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Description" - }, - "marking_definitions": { - "items": { - "$ref": "#/components/schemas/MarkingDefinition" - }, - "type": "array", - "title": "Marking Definitions" - } - }, - "type": "object", - "required": [ - "uuid", - "type", - "name", - "created_by", - "sources", - "created_at", - "updated_at", - "description", - "marking_definitions" - ], - "title": "CampaignEntityAPIResponse" - }, - "CategoryStatsHistogram": { - "properties": { - "histogram": { - "additionalProperties": { - "type": "integer" - }, - "propertyNames": { - "format": "date-time" - }, - "type": "object", - "title": "Histogram" - }, - "event_count": { - "type": "integer", - "title": "Event Count" - }, - "category": { - "$ref": "#/components/schemas/SourceCategoryV2" - }, - "unique_sources": { - "type": "integer", - "title": "Unique Sources" - } - }, - "type": "object", - "required": [ - "histogram", - "event_count", - "category", - "unique_sources" - ], - "title": "CategoryStatsHistogram" - }, - "ChatChannelActor": { - "properties": { - "actor_uid": { - "$ref": "#/components/schemas/ActorUid" - }, - "asset_uuid": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Asset Uuid" - }, - "last_message_at": { - "type": "string", - "format": "date-time", - "title": "Last Message At" - }, - "message_count": { - "type": "integer", - "title": "Message Count" - } - }, - "type": "object", - "required": [ - "actor_uid", - "last_message_at", - "message_count" - ], - "title": "ChatChannelActor" - }, - "ChatChannelAssetUuidPayload": { - "properties": { - "thread_id": { - "type": "string", - "title": "Thread Id" - }, - "source": { - "type": "string", - "title": "Source" - } - }, - "type": "object", - "required": [ - "thread_id", - "source" - ], - "title": "ChatChannelAssetUuidPayload" - }, - "ChatChannelEntityAPIResponse": { - "properties": { - "uuid": { - "type": "string", - "title": "Uuid" - }, - "type": { - "$ref": "#/components/schemas/EntityType" - }, - "name": { - "type": "string", - "title": "Name" - }, - "created_by": { - "type": "string", - "title": "Created By" - }, - "sources": { - "items": { - "$ref": "#/components/schemas/CTIEntitySourceAPIResponse" - }, - "type": "array", - "title": "Sources" - }, - "created_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Created At" - }, - "updated_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Updated At" - }, - "first_seen_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "First Seen At" - }, - "last_seen_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Last Seen At" - }, - "confidence": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Confidence" - }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Description" - }, - "conversation_link": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Conversation Link" - } - }, - "type": "object", - "required": [ - "uuid", - "type", - "name", - "created_by", - "sources", - "created_at", - "updated_at", - "description", - "conversation_link" - ], - "title": "ChatChannelEntityAPIResponse" - }, - "ChatChannelKeyActorsResponse": { - "properties": { - "key_actors": { - "items": { - "$ref": "#/components/schemas/ChatChannelActor" - }, - "type": "array", - "title": "Key Actors" - } - }, - "type": "object", - "required": [ - "key_actors" - ], - "title": "ChatChannelKeyActorsResponse" - }, - "ChatChannelMentionedChannelsResponse": { - "properties": { - "mentioned_channels": { - "items": { - "$ref": "#/components/schemas/CommunicationHandle" - }, - "type": "array", - "title": "Mentioned Channels" - } - }, - "type": "object", - "required": [ - "mentioned_channels" - ], - "title": "ChatChannelMentionedChannelsResponse" - }, - "ChatChannelMetadata": { - "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" - }, - "uid": { - "$ref": "#/components/schemas/ChatChannelUid" - }, - "name": { - "type": "string", - "title": "Name" - }, - "source": { - "$ref": "#/components/schemas/EnrichedSource" - }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Description" - }, - "conversation_link": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Conversation Link" - }, - "chat_type": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Chat Type" - }, - "member_count": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Member Count" - }, - "topics": { - "items": { - "$ref": "#/components/schemas/ChatChannelTopic" - }, - "type": "array", - "title": "Topics" - } - }, - "type": "object", - "required": [ - "uid", - "name", - "source" - ], - "title": "ChatChannelMetadata" - }, - "ChatChannelSummariesResponse": { - "properties": { - "request_id": { - "anyOf": [ - { - "type": "string", - "format": "uuid" - }, - { - "type": "null" - } - ], - "title": "Request Id" - }, - "error": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Error" - }, - "summarized_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Summarized At" - }, - "profile": { - "anyOf": [ - { - "$ref": "#/components/schemas/ChatChannelSummaryOutput" - }, - { - "type": "null" - } - ] - } - }, - "type": "object", - "required": [ - "request_id" - ], - "title": "ChatChannelSummariesResponse" - }, - "ChatChannelSummaryOutput": { - "properties": { - "overview": { - "type": "string", - "title": "Overview", - "description": "Single paragraph providing an overview of the chat channel." - }, - "content_and_activity": { - "type": "string", - "title": "Content And Activity", - "description": "Single paragraph summarizing the observed content and activity." - }, - "nature_and_sophistication": { - "type": "string", - "title": "Nature And Sophistication", - "description": "Single paragraph characterizing the channel's function and sophistication." - } - }, - "type": "object", - "required": [ - "overview", - "content_and_activity", - "nature_and_sophistication" - ], - "title": "ChatChannelSummaryOutput" - }, - "ChatChannelTimeline": { - "properties": { - "aggregate_by": { - "anyOf": [ - { - "$ref": "#/components/schemas/StatsAggregates" - }, - { - "type": "null" - } - ] - }, - "timeline": { - "items": { - "$ref": "#/components/schemas/ChatChannelTimelineEntry" - }, - "type": "array", - "title": "Timeline" - }, - "total_count": { - "type": "integer", - "title": "Total Count" - } - }, - "type": "object", - "required": [ - "timeline", - "total_count" - ], - "title": "ChatChannelTimeline" - }, - "ChatChannelTimelineEntry": { - "properties": { - "date": { - "type": "string", - "format": "date-time", - "title": "Date" - }, - "total_count": { - "type": "integer", - "title": "Total Count" - } - }, - "type": "object", - "required": [ - "date", - "total_count" - ], - "title": "ChatChannelTimelineEntry" - }, - "ChatChannelTopic": { - "properties": { - "topic_id": { - "type": "string", - "title": "Topic Id" - }, - "label": { - "type": "string", - "title": "Label" - } - }, - "type": "object", - "required": [ - "topic_id", - "label" - ], - "title": "ChatChannelTopic" - }, - "ChatChannelUid": { - "properties": { - "thread_id": { - "type": "string", - "title": "Thread Id" - }, - "source": { - "type": "string", - "title": "Source" - } - }, - "type": "object", - "required": [ - "thread_id", - "source" - ], - "title": "ChatChannelUid" - }, - "ChatChannelUidWithNameResponse": { - "properties": { - "thread_id": { - "type": "string", - "title": "Thread Id" - }, - "source": { - "type": "string", - "title": "Source" - }, - "name": { - "type": "string", - "title": "Name" - } - }, - "type": "object", - "required": [ - "thread_id", - "source", - "name" - ], - "title": "ChatChannelUidWithNameResponse" - }, - "ChatMessageEvent": { - "properties": { - "event_type": { - "type": "string", - "const": "chat_message", - "title": "Event Type", - "default": "chat_message" - }, - "data": { - "$ref": "#/components/schemas/ChatMessageEventData" - }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" - } - }, - "type": "object", - "required": [ - "data", - "metadata" - ], - "title": "Chat Message" - }, - "ChatMessageEventData": { - "properties": { - "posted_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Posted At", - "description": "The time the chat message was posted." - }, - "actor": { - "$ref": "#/components/schemas/pyro__findings__chat_messages__datamodels__ChatMessageEventData__Actor", - "description": "Collection of data about the actor of the chat message." - }, - "context": { - "$ref": "#/components/schemas/pyro__findings__chat_messages__datamodels__ChatMessageEventData__Context", - "description": "Collection of data about the context of the chat message." - }, - "content": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Content", - "description": "The content of the chat message." - }, - "parent_context": { - "$ref": "#/components/schemas/ParentContext", - "description": "Collection of data about the context of the parent chat message." - }, - "forward_info": { - "$ref": "#/components/schemas/ForwardInfo", - "description": "Collection of data about the forward information of the chat message." - }, - "was_forwarded": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Was Forwarded", - "description": "Whether the chat message was forwarded." - } - }, - "type": "object", - "title": "ChatMessageEventData" - }, - "Classes": { - "properties": { - "is_carding": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is Carding", - "description": "Whether the listing is classified as carding." - }, - "is_bypass": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is Bypass", - "description": "Whether the listing is classified as a bypass." - }, - "is_ident_fraud": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is Ident Fraud", - "description": "Whether the listing is classified as identity fraud." - }, - "is_doc_fraud": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is Doc Fraud", - "description": "Whether the listing is classified as document fraud." - }, - "is_phishing": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is Phishing", - "description": "Whether the listing is classified as phishing." - }, - "is_money_xfer": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is Money Xfer", - "description": "Whether the listing is classified as money transfer." - }, - "is_cashout": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is Cashout", - "description": "Whether the listing is classified as a cashout." - }, - "is_virt_currency": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is Virt Currency", - "description": "Whether the listing is classified as a virtual currency transaction." - }, - "is_hacking": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is Hacking", - "description": "Whether the listing is classified as hacking activities." - }, - "is_misc_financial": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is Misc Financial", - "description": "Whether the listing is classified as miscellaneous financial activities." - } - }, - "type": "object", - "title": "Classes" - }, - "Classification": { - "properties": { - "classes": { - "$ref": "#/components/schemas/Classes", - "description": "Data about the classes identified in the listing." - }, - "types": { - "$ref": "#/components/schemas/Types", - "description": "Data about the possible listing type." - } - }, - "type": "object", - "title": "Classification" - }, - "CommunicationHandle": { - "properties": { - "platform": { - "type": "string", - "title": "Platform" - }, - "handles": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Handles" - } - }, - "type": "object", - "required": [ - "platform", - "handles" - ], - "title": "CommunicationHandle" - }, - "ConversationMessage": { - "properties": { - "uid": { - "type": "string", - "title": "Uid" - }, - "message": { - "type": "string", - "title": "Message" - }, - "message_en": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Message En" - }, - "author_name": { - "type": "string", - "title": "Author Name" - }, - "date_time": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Date Time" - } - }, - "type": "object", - "required": [ - "uid", - "message", - "author_name", - "date_time" - ], - "title": "ConversationMessage" - }, - "ConversationSearchAfterDirection": { - "type": "string", - "enum": [ - "next", - "previous" - ], - "title": "ConversationSearchAfterDirection" - }, - "ConversationSummaryRequestPayload": { - "properties": { - "conversation_uid": { - "type": "string", - "title": "Conversation Uid" - }, - "report_title": { - "type": "string", - "title": "Report Title" - }, - "time_range_type": { - "$ref": "#/components/schemas/TimeRangeType", - "default": "last_24h" - }, - "time_range_from": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Time Range From" - }, - "time_range_to": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Time Range To" - } - }, - "type": "object", - "required": [ - "conversation_uid", - "report_title" - ], - "title": "ConversationSummaryRequestPayload" - }, - "ConversationSummaryRequestResponse": { - "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "conversation_uid": { - "type": "string", - "title": "Conversation Uid" - }, - "created_at": { - "type": "string", - "format": "date-time", - "title": "Created At" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "title": "Updated At" - }, - "report_title": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Report Title" - }, - "tenant_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Tenant Id" - }, - "time_range_from": { - "type": "string", - "format": "date-time", - "title": "Time Range From" - }, - "time_range_to": { - "type": "string", - "format": "date-time", - "title": "Time Range To" - } - }, - "type": "object", - "required": [ - "id", - "conversation_uid", - "created_at", - "updated_at", - "report_title", - "tenant_id", - "time_range_from", - "time_range_to" - ], - "title": "ConversationSummaryRequestResponse" - }, - "CookieExpirationStatus": { - "type": "string", - "enum": [ - "active", - "expired" - ], - "title": "CookieExpirationStatus" - }, - "CookieMonitoringConfigurationItem": { - "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "domain": { - "type": "string", - "title": "Domain" - }, - "tenant_id": { - "type": "integer", - "title": "Tenant Id" - }, - "names": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Names" - } - }, - "type": "object", - "required": [ - "id", - "domain", - "tenant_id" - ], - "title": "CookieMonitoringConfigurationItem" - }, - "CookiesTenantSearchBody": { - "properties": { - "value": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Value" - }, - "from_": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From" - }, - "size": { - "type": "integer", - "title": "Size", - "default": 100 - } - }, - "type": "object", - "title": "CookiesTenantSearchBody" - }, - "CrawlingFrequency": { - "properties": { - "value": { - "type": "integer", - "title": "Value" - }, - "unit": { - "$ref": "#/components/schemas/CrawlingFrequencyUnit" - } - }, - "type": "object", - "required": [ - "value", - "unit" - ], - "title": "CrawlingFrequency" - }, - "CrawlingFrequencyUnit": { - "type": "string", - "enum": [ - "minute", - "hour" - ], - "title": "CrawlingFrequencyUnit" - }, - "CreateAlert": { - "properties": { - "feed_definition": { - "$ref": "#/components/schemas/FeedDefinition" - }, - "name": { - "type": "string", - "title": "Name" - }, - "search_types": { - "items": { - "$ref": "#/components/schemas/SearchType" - }, - "type": "array", - "title": "Search Types" - }, - "experimental_search_types": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Experimental Search Types" - }, - "risks": { - "items": { - "$ref": "#/components/schemas/RiskScore" - }, - "type": "array", - "title": "Risks" - }, - "frequency": { - "type": "number", - "title": "Frequency" - }, - "start_at": { - "type": "string", - "format": "date-time", - "title": "Start At" - }, - "alert_channel_id": { - "type": "integer", - "title": "Alert Channel Id" - } - }, - "type": "object", - "required": [ - "feed_definition", - "name", - "search_types", - "experimental_search_types", - "risks", - "frequency", - "start_at", - "alert_channel_id" - ], - "title": "CreateAlert" - }, - "CreateAlertChannel": { - "properties": { - "name": { - "type": "string", - "title": "Name" - }, - "params": { - "oneOf": [ - { - "$ref": "#/components/schemas/AlertChannelEmailParams" - }, - { - "$ref": "#/components/schemas/AlertChannelSlackParams" - }, - { - "$ref": "#/components/schemas/AlertChannelDiscordParams" - }, - { - "$ref": "#/components/schemas/AlertChannelSplunkParams" - }, - { - "$ref": "#/components/schemas/AlertChannelChannelParams" - }, - { - "$ref": "#/components/schemas/AlertChannelLegacySentinelParams" - }, - { - "$ref": "#/components/schemas/AlertChannelSentinelV2Params" - }, - { - "$ref": "#/components/schemas/AlertChannelTeamsParams" - }, - { - "$ref": "#/components/schemas/AlertChannelJiraParams" - }, - { - "$ref": "#/components/schemas/AlertChannelServiceNowParams" - }, - { - "$ref": "#/components/schemas/AlertChannelWebhookParams" - } - ], - "title": "Params", - "discriminator": { - "propertyName": "type", - "mapping": { - "azure_sentinel": "#/components/schemas/AlertChannelLegacySentinelParams", - "azure_sentinel_v2": "#/components/schemas/AlertChannelSentinelV2Params", - "channel": "#/components/schemas/AlertChannelChannelParams", - "discord": "#/components/schemas/AlertChannelDiscordParams", - "email": "#/components/schemas/AlertChannelEmailParams", - "jira": "#/components/schemas/AlertChannelJiraParams", - "servicenow": "#/components/schemas/AlertChannelServiceNowParams", - "slack": "#/components/schemas/AlertChannelSlackParams", - "splunk": "#/components/schemas/AlertChannelSplunkParams", - "teams": "#/components/schemas/AlertChannelTeamsParams", - "webhook": "#/components/schemas/AlertChannelWebhookParams" - } - } - }, - "state": { - "anyOf": [ - { - "$ref": "#/components/schemas/AlertChannelState" - }, - { - "type": "null" - } - ] - } - }, - "type": "object", - "required": [ - "name", - "params" - ], - "title": "CreateAlertChannel" - }, - "CreateAstpCookiesBody": { - "properties": { - "name": { - "type": "string", - "minLength": 1, - "title": "Name", - "description": "The name of the matching policy" - }, - "type": { - "type": "string", - "const": "ASTP_COOKIES", - "title": "Type" - }, - "value": { - "$ref": "#/components/schemas/AstpCookiesValue", - "description": "The value of the matching policy in the form of cookie names" - } - }, - "type": "object", - "required": [ - "name", - "type", - "value" - ], - "title": "CreateAstpCookiesBody" - }, - "CreateAstpDomainBody": { - "properties": { - "name": { - "type": "string", - "minLength": 1, - "title": "Name", - "description": "The name of the matching policy" - }, - "type": { - "type": "string", - "const": "ASTP_DOMAIN", - "title": "Type" - }, - "value": { - "$ref": "#/components/schemas/AstpDomainValue", - "description": "The value of the matching policy in the form of a domain match mode" - } - }, - "type": "object", - "required": [ - "name", - "type", - "value" - ], - "title": "CreateAstpDomainBody" - }, - "CreateAuthorizationRequest": { - "properties": { - "asset_uuid": { - "type": "string", - "format": "uuid", - "title": "Asset Uuid" - }, - "reason": { - "type": "string", - "title": "Reason" - } - }, - "type": "object", - "required": [ - "asset_uuid", - "reason" - ], - "title": "CreateAuthorizationRequest" - }, - "CreateCookieMonitoringConfigurationItem": { - "properties": { - "domain": { - "type": "string", - "title": "Domain" - }, - "tenant_id": { - "type": "integer", - "title": "Tenant Id" - }, - "names": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Names" - } - }, - "type": "object", - "required": [ - "domain", - "tenant_id" - ], - "title": "CreateCookieMonitoringConfigurationItem" - }, - "CreateDemoTenantRequestBody": { - "properties": { - "name": { - "type": "string", - "minLength": 2, - "title": "Name" - }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Description" - }, - "industry": { - "anyOf": [ - { - "$ref": "#/components/schemas/TenantIndustry" - }, - { - "type": "null" - } - ] - }, - "number_of_employees": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Number Of Employees" - } - }, - "type": "object", - "required": [ - "name", - "description", - "industry", - "number_of_employees" - ], - "title": "CreateDemoTenantRequestBody" - }, - "CreateExcludedKeywordsBody": { - "properties": { - "name": { - "type": "string", - "minLength": 1, - "title": "Name", - "description": "The name of the matching policy" - }, - "type": { - "type": "string", - "const": "EXCLUDED_KEYWORDS", - "title": "Type" - }, - "value": { - "$ref": "#/components/schemas/KeywordsValue", - "description": "The value of the matching policy in the form of keywords" - } - }, - "type": "object", - "required": [ - "name", - "type", - "value" - ], - "title": "CreateExcludedKeywordsBody" - }, - "CreateFeatureFlagPayload": { - "properties": { - "name": { - "type": "string", - "minLength": 1, - "title": "Name" - }, - "active": { - "type": "boolean", - "title": "Active" - }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Description" - } - }, - "type": "object", - "required": [ - "name", - "active", - "description" - ], - "title": "CreateFeatureFlagPayload" - }, - "CreateFeatureFlagUserListPayload": { - "properties": { - "name": { - "type": "string", - "minLength": 1, - "title": "Name" - }, - "members": { - "items": { - "$ref": "#/components/schemas/StrategyMember" - }, - "type": "array", - "title": "Members" - } - }, - "type": "object", - "required": [ - "name", - "members" - ], - "title": "CreateFeatureFlagUserListPayload" - }, - "CreateIncludedKeywordsBody": { - "properties": { - "name": { - "type": "string", - "minLength": 1, - "title": "Name", - "description": "The name of the matching policy" - }, - "type": { - "type": "string", - "const": "INCLUDED_KEYWORDS", - "title": "Type" - }, - "value": { - "$ref": "#/components/schemas/KeywordsValue", - "description": "The value of the matching policy in the form of keywords" - } - }, - "type": "object", - "required": [ - "name", - "type", - "value" - ], - "title": "CreateIncludedKeywordsBody" - }, - "CreateInviteLinkResponse": { - "properties": { - "invite_magic_link": { - "type": "string", - "title": "Invite Magic Link" - } - }, - "type": "object", - "required": [ - "invite_magic_link" - ], - "title": "CreateInviteLinkResponse" - }, - "CreateLLMRecommendationsRequest": { - "properties": { - "recommendations": { - "items": { - "$ref": "#/components/schemas/LLMRecommendationRequest" - }, - "type": "array", - "title": "Recommendations" - } - }, - "type": "object", - "required": [ - "recommendations" - ], - "title": "CreateLLMRecommendationsRequest" - }, - "CreateLLMRecommendationsResponse": { - "properties": { - "success": { - "type": "boolean", - "title": "Success" - }, - "recommendation_created": { - "type": "integer", - "title": "Recommendation Created" - } - }, - "type": "object", - "required": [ - "success", - "recommendation_created" - ], - "title": "CreateLLMRecommendationsResponse" - }, - "CreateLuceneQueryBody": { - "properties": { - "name": { - "type": "string", - "minLength": 1, - "title": "Name", - "description": "The name of the matching policy" - }, - "type": { - "type": "string", - "const": "LUCENE_QUERY", - "title": "Type" - }, - "value": { - "$ref": "#/components/schemas/LuceneValue", - "description": "The value of the matching policy in the form of a Lucene query" - } - }, - "type": "object", - "required": [ - "name", - "type", - "value" - ], - "title": "CreateLuceneQueryBody" - }, - "CreateStrategyPayload": { - "properties": { - "strategy_type": { - "$ref": "#/components/schemas/GitlabFeatureFlagStrategyName" - }, - "scopes": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/UpdateGitlabFeatureFlagScopePayload" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Scopes" - }, - "members": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/StrategyMember" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Members" - }, - "user_list_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "User List Id" - } - }, - "type": "object", - "required": [ - "strategy_type" - ], - "title": "CreateStrategyPayload" - }, - "CreateTenantIntegrationPayload": { - "properties": { - "name": { - "type": "string", - "maxLength": 255, - "minLength": 1, - "title": "Name" - }, - "tenant_id": { - "type": "integer", - "title": "Tenant Id" - }, - "is_enabled": { - "type": "boolean", - "title": "Is Enabled", - "default": true - }, - "params": { - "oneOf": [ - { - "$ref": "#/components/schemas/EntraIDInputParams" - }, - { - "$ref": "#/components/schemas/ForetraceInputParams" - }, - { - "$ref": "#/components/schemas/OktaInputParams" - } - ], - "title": "Params", - "discriminator": { - "propertyName": "params_type", - "mapping": { - "entra_id": "#/components/schemas/EntraIDInputParams", - "flare_community": "#/components/schemas/ForetraceInputParams", - "okta": "#/components/schemas/OktaInputParams" - } - } - }, - "status": { - "anyOf": [ - { - "$ref": "#/components/schemas/TenantIntegrationStatus" - }, - { - "type": "null" - } - ] - } - }, - "type": "object", - "required": [ - "name", - "tenant_id", - "params" - ], - "title": "CreateTenantIntegrationPayload" - }, - "CreateTenantUserPayload": { - "properties": { - "name": { - "type": "string", - "title": "Name" - }, - "surname": { - "type": "string", - "title": "Surname" - }, - "email": { - "type": "string", - "title": "Email" - }, - "role": { - "$ref": "#/components/schemas/TenantRoleType" - } - }, - "type": "object", - "required": [ - "name", - "surname", - "email", - "role" - ], - "title": "CreateTenantUserPayload" - }, - "Credential": { - "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "identity_name": { - "type": "string", - "title": "Identity Name" - }, - "domain": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Domain" - }, - "source_id": { - "type": "string", - "title": "Source Id" - }, - "imported_at": { - "type": "string", - "title": "Imported At" - }, - "hash": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Hash" - }, - "hash_type": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Hash Type" - }, - "source": { - "anyOf": [ - { - "$ref": "#/components/schemas/SourceV2" - }, - { - "type": "null" - } - ] - }, - "known_password_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Known Password Id" - }, - "credential_hash": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Credential Hash" - }, - "event_uid": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Event Uid" - }, - "auth_domains": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Auth Domains" - } - }, - "type": "object", - "required": [ - "id", - "identity_name", - "domain", - "source_id", - "imported_at", - "hash", - "hash_type", - "source", - "known_password_id", - "credential_hash", - "event_uid" - ], - "title": "Credential" - }, - "CredentialActionBody": { - "properties": { - "type": { - "$ref": "#/components/schemas/LeakedCredentialsBulkActionType" - } - }, - "type": "object", - "required": [ - "type" - ], - "title": "CredentialActionBody" - }, - "CredentialActionRequestBody": { - "properties": { - "targets": { - "items": { - "$ref": "#/components/schemas/CredentialActionTarget" - }, - "type": "array", - "maxItems": 100, - "title": "Targets" - }, - "action": { - "$ref": "#/components/schemas/CredentialActionBody" - } - }, - "type": "object", - "required": [ - "targets", - "action" - ], - "title": "CredentialActionRequestBody" - }, - "CredentialActionTarget": { - "properties": { - "credential_hash": { - "type": "string", - "title": "Credential Hash" - } - }, - "type": "object", - "required": [ - "credential_hash" - ], - "title": "CredentialActionTarget" - }, - "CredentialBulkActionFilters": { - "properties": { - "query_type": { - "$ref": "#/components/schemas/CredentialsQueryType", - "default": "domain" - }, - "term": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Term" - }, - "source_term": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Source Term" - }, - "search_after": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Search After" - }, - "time": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Time" - }, - "source_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Source Id" - }, - "ignored_source_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Ignored Source Id" - }, - "size": { - "type": "integer", - "title": "Size", - "default": 10 - }, - "states": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/ActivityTenantMetadataEventAction" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "States" - }, - "password_policies": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/PasswordPolicy" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Password Policies" - }, - "password_policy_operator": { - "anyOf": [ - { - "$ref": "#/components/schemas/PasswordPolicyOperator" - }, - { - "type": "null" - } - ] - }, - "include_validations": { - "type": "boolean", - "title": "Include Validations", - "default": false - }, - "idp_verification_states": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/CredentialValidationStatusFilter" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Idp Verification States" - }, - "first_occurrence_only": { - "type": "boolean", - "title": "First Occurrence Only", - "default": false - }, - "feed_definition": { - "$ref": "#/components/schemas/FeedDefinition" - } - }, - "type": "object", - "required": [ - "feed_definition" - ], - "title": "CredentialBulkActionFilters" - }, - "CredentialBulkActionRequestBody": { - "properties": { - "type": { - "$ref": "#/components/schemas/BulkActionType" - }, - "ids": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Ids" - }, - "filters": { - "anyOf": [ - { - "$ref": "#/components/schemas/CredentialBulkActionFilters" - }, - { - "type": "null" - } - ] - }, - "action_params": { - "anyOf": [ - { - "$ref": "#/components/schemas/ValidateByIDPActionParams" - }, - { - "type": "null" - } - ] - } - }, - "type": "object", - "required": [ - "type", - "ids", - "filters", - "action_params" - ], - "title": "CredentialBulkActionRequestBody" - }, - "CredentialFilters": { - "properties": { - "query_string": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Query String" - }, - "type": { - "type": "string", - "const": "credential", - "title": "Type", - "default": "credential" - }, - "query_type": { - "anyOf": [ - { - "$ref": "#/components/schemas/CredentialsQueryType" - }, - { - "type": "null" - } - ] - }, - "time": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Time" - }, - "source_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Source Id" - }, - "ignored_source_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Ignored Source Id" - }, - "password_policies": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/PasswordPolicy" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Password Policies" - }, - "password_policy_operator": { - "anyOf": [ - { - "$ref": "#/components/schemas/PasswordPolicyOperator" - }, - { - "type": "null" - } - ] - }, - "feed_definition": { - "anyOf": [ - { - "$ref": "#/components/schemas/FeedDefinition" - }, - { - "type": "null" - } - ] - }, - "states": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/ActivityTenantMetadataEventAction" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "States" - }, - "idp_verification_states": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/CredentialValidationStatusFilter" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Idp Verification States" - } - }, - "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": { - "type": "string", - "format": "uuid", - "title": "Tenant Integration Id" - }, - "credential_hash": { - "type": "string", - "title": "Credential Hash" - }, - "tenant_id": { - "type": "integer", - "title": "Tenant Id" - }, - "uuid": { - "type": "string", - "format": "uuid", - "title": "Uuid" - }, - "status": { - "$ref": "#/components/schemas/CredentialValidationStatus" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "title": "Updated At" - } - }, - "type": "object", - "required": [ - "tenant_integration_id", - "credential_hash", - "tenant_id", - "uuid", - "status", - "updated_at" - ], - "title": "CredentialValidationReponse" - }, - "CredentialValidationRequestBody": { - "properties": { - "tenant_integration_id": { - "type": "string", - "format": "uuid", - "title": "Tenant Integration Id" - }, - "credential_hash": { - "type": "string", - "title": "Credential Hash" - } - }, - "type": "object", - "required": [ - "tenant_integration_id", - "credential_hash" - ], - "title": "CredentialValidationRequestBody" - }, - "CredentialValidationStatus": { - "type": "string", - "enum": [ - "match", - "no_match", - "unknown", - "failed", - "not_found", - "mitigated", - "throttled" - ], - "title": "CredentialValidationStatus" - }, - "CredentialValidationStatusFilter": { - "type": "string", - "enum": [ - "match", - "no_match", - "unknown", - "throttled", - "failed", - "not_found", - "mitigated", - "pending" - ], - "title": "CredentialValidationStatusFilter" - }, - "CredentialValidationThresholdPolicy": { - "properties": { - "max_attempts": { - "type": "integer", - "title": "Max Attempts", - "default": 10 - }, - "period_seconds": { - "type": "integer", - "minimum": 1.0, - "title": "Period Seconds", - "default": 3600 - } - }, - "type": "object", - "title": "CredentialValidationThresholdPolicy" - }, - "CredentialsData": { - "properties": { - "type": { - "type": "string", - "const": "credentials", - "title": "Type", - "default": "credentials" - }, - "username": { - "type": "string", - "minLength": 1, - "title": "Username" - }, - "password": { - "type": "string", - "minLength": 1, - "title": "Password" - } - }, - "type": "object", - "required": [ - "username", - "password" - ], - "title": "CredentialsData" - }, - "CredentialsDateFilter": { - "properties": { - "gte": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Gte" - }, - "lte": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Lte" - } - }, - "type": "object", - "title": "CredentialsDateFilter" - }, - "CredentialsQuery": { - "properties": { - "type": { - "type": "string", - "const": "credentials", - "title": "Type" - }, - "username": { - "type": "string", - "title": "Username" - }, - "password": { - "type": "string", - "title": "Password" - } - }, - "type": "object", - "required": [ - "type", - "username", - "password" - ], - "title": "CredentialsQuery" - }, - "CredentialsQueryFilters": { - "properties": { - "imported_at": { - "$ref": "#/components/schemas/CredentialsDateFilter" - } - }, - "type": "object", - "title": "CredentialsQueryFilters" - }, - "CredentialsQueryPayload": { - "properties": { - "query": { - "oneOf": [ - { - "$ref": "#/components/schemas/DomainQuery" - }, - { - "$ref": "#/components/schemas/EmailQuery" - }, - { - "$ref": "#/components/schemas/KeywordQuery" - }, - { - "$ref": "#/components/schemas/SecretQuery" - }, - { - "$ref": "#/components/schemas/AuthDomainQuery" - } - ], - "title": "Query", - "discriminator": { - "propertyName": "type", - "mapping": { - "auth_domain": "#/components/schemas/AuthDomainQuery", - "domain": "#/components/schemas/DomainQuery", - "email": "#/components/schemas/EmailQuery", - "keyword": "#/components/schemas/KeywordQuery", - "secret": "#/components/schemas/SecretQuery" - } - } - }, - "filters": { - "$ref": "#/components/schemas/CredentialsQueryFilters" - }, - "from": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From" - }, - "size": { - "type": "integer", - "maximum": 10000.0, - "minimum": 1.0, - "title": "Size", - "default": 10 - }, - "include": { - "items": { - "$ref": "#/components/schemas/IncludeOptions" - }, - "type": "array", - "title": "Include" - }, - "order": { - "$ref": "#/components/schemas/OrderType", - "default": "desc" - } - }, - "type": "object", - "required": [ - "query" - ], - "title": "CredentialsQueryPayload" - }, - "CredentialsQueryType": { - "type": "string", - "enum": [ - "email", - "username", - "domain", - "password", - "url" - ], - "title": "CredentialsQueryType" - }, - "DateRangeType": { - "type": "string", - "enum": [ - "last_7d", - "last_1m", - "last_3m", - "last_6m", - "all_time" - ], - "title": "DateRangeType" - }, - "DayOfWeekData": { - "properties": { - "day_of_week": { - "type": "integer", - "maximum": 7.0, - "minimum": 1.0, - "title": "Day Of Week", - "description": "The day of the week, from 1 to 7, where 1 is Monday and 7 is Sunday." - }, - "count": { - "type": "integer", - "title": "Count" - } - }, - "type": "object", - "required": [ - "day_of_week", - "count" - ], - "title": "DayOfWeekData" - }, - "DeleteTenantResponse": { - "properties": { - "request_id": { - "type": "string", - "format": "uuid", - "title": "Request Id" - }, - "status": { - "$ref": "#/components/schemas/AsyncRequestStatus" - } - }, - "type": "object", - "required": [ - "request_id", - "status" - ], - "title": "DeleteTenantResponse" - }, - "DisableAccountPayload": { - "properties": { - "credential_hash": { - "type": "string", - "title": "Credential Hash" - } - }, - "type": "object", - "required": [ - "credential_hash" - ], - "title": "DisableAccountPayload" - }, - "DnsRecordsInfo": { - "properties": { - "a_records": { - "items": { - "type": "string" - }, - "type": "array", - "title": "A Records" - }, - "aaaa_records": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Aaaa Records" - }, - "mx_records": { - "items": { - "$ref": "#/components/schemas/MxRecord" - }, - "type": "array", - "title": "Mx Records" - }, - "ns_records": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Ns Records" - }, - "txt_records": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Txt Records" - }, - "has_dmarc": { - "type": "boolean", - "title": "Has Dmarc", - "default": false - }, - "has_spf": { - "type": "boolean", - "title": "Has Spf", - "default": false - } - }, - "type": "object", - "title": "DnsRecordsInfo" - }, - "DomainAssetEnrichment": { - "properties": { - "type": { - "$ref": "#/components/schemas/AssetEnrichmentType" - }, - "sources": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Sources" - }, - "entries": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Entries" - }, - "tags": { - "items": { - "$ref": "#/components/schemas/SubdomainTag" - }, - "type": "array", - "title": "Tags" - }, - "statuses": { - "items": { - "$ref": "#/components/schemas/SubdomainStatus" - }, - "type": "array", - "title": "Statuses" - }, - "external_links": { - "items": { - "type": "string" - }, - "type": "array", - "title": "External Links" - }, - "title": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Title" - } - }, - "type": "object", - "required": [ - "type", - "sources", - "entries", - "tags", - "statuses", - "external_links", - "title" - ], - "title": "DomainAssetEnrichment" - }, - "DomainBrowserItemResponse": { - "properties": { - "asset_uuid": { - "type": "string", - "title": "Asset Uuid" - }, - "risk": { - "type": "integer", - "title": "Risk" - }, - "fqdn": { - "type": "string", - "title": "Fqdn" - }, - "registrar": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Registrar" - }, - "registered_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Registered At" - }, - "related_domain": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Related Domain" - }, - "sources": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Sources" - }, - "discovered_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Discovered At" - }, - "updated_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Updated At" - } - }, - "type": "object", - "required": [ - "asset_uuid", - "risk", - "fqdn", - "registrar", - "registered_at", - "related_domain", - "sources", - "discovered_at", - "updated_at" - ], - "title": "DomainBrowserItemResponse" - }, - "DomainData": { - "properties": { - "type": { - "type": "string", - "const": "domain", - "title": "Type", - "default": "domain" - }, - "fqdn": { - "type": "string", - "minLength": 1, - "title": "Fqdn" - } - }, - "type": "object", - "required": [ - "fqdn" - ], - "title": "DomainData" - }, - "DomainEventHistoryResponse": { - "properties": { - "events": { - "items": { - "$ref": "#/components/schemas/DomainProfileEvent" - }, - "type": "array", - "title": "Events" - }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - }, - "total_count": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Total Count" - } - }, - "type": "object", - "required": [ - "events", - "next" - ], - "title": "DomainEventHistoryResponse" - }, - "DomainMatchMode": { - "type": "string", - "enum": [ - "email_domain_only", - "auth_domain_and_email_domain", - "auth_domain_only" - ], - "title": "DomainMatchMode" - }, - "DomainProfileCertificateResponse": { - "properties": { - "subject": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Subject" - }, - "issuer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Issuer" - }, - "not_before": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Not Before" - }, - "not_after": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Not After" - }, - "authority_info_access": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Authority Info Access" - }, - "subject_alt_names": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Subject Alt Names" - }, - "is_extended_validation": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is Extended Validation" - } - }, - "type": "object", - "required": [ - "subject", - "issuer", - "not_before", - "not_after", - "authority_info_access", - "subject_alt_names", - "is_extended_validation" - ], - "title": "DomainProfileCertificateResponse" - }, - "DomainProfileDnsRecordsResponse": { - "properties": { - "a_records": { - "items": { - "type": "string" - }, - "type": "array", - "title": "A Records" - }, - "aaaa_records": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Aaaa Records" - }, - "mx_records": { - "items": { - "$ref": "#/components/schemas/DomainProfileMxRecordResponse" - }, - "type": "array", - "title": "Mx Records" - }, - "ns_records": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Ns Records" - }, - "txt_records": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Txt Records" - }, - "has_spf": { - "type": "boolean", - "title": "Has Spf" - }, - "has_dmarc": { - "type": "boolean", - "title": "Has Dmarc" - } - }, - "type": "object", - "required": [ - "a_records", - "aaaa_records", - "mx_records", - "ns_records", - "txt_records", - "has_spf", - "has_dmarc" - ], - "title": "DomainProfileDnsRecordsResponse" - }, - "DomainProfileEvent": { - "properties": { - "uid": { - "type": "string", - "title": "Uid" - }, - "date": { - "type": "string", - "format": "date-time", - "title": "Date" - }, - "event_type": { - "type": "string", - "title": "Event Type" - }, - "risk_score": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Risk Score" - }, - "change": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "$ref": "#/components/schemas/FaviconInfo" - }, - "type": "array" - }, - { - "items": { - "$ref": "#/components/schemas/ScreenshotInfo" - }, - "type": "array" - }, - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "$ref": "#/components/schemas/DnsRecordsInfo" - }, - { - "$ref": "#/components/schemas/WhoisRdapInfo" - }, - { - "type": "null" - } - ], - "title": "Change" - } - }, - "type": "object", - "required": [ - "uid", - "date", - "event_type", - "risk_score", - "change" - ], - "title": "DomainProfileEvent" - }, - "DomainProfileMetadataResponse": { - "properties": { - "url": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Url" - }, - "current_title": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Current Title" - }, - "current_favicon": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Current Favicon" - }, - "current_screenshot": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Current Screenshot" - }, - "first_seen_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "First Seen At" - }, - "sources": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Sources" - } - }, - "type": "object", - "required": [ - "url", - "current_title", - "current_favicon", - "current_screenshot", - "first_seen_at", - "sources" - ], - "title": "DomainProfileMetadataResponse" - }, - "DomainProfileMxRecordResponse": { - "properties": { - "priority": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Priority" - }, - "exchange": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Exchange" - } - }, - "type": "object", - "required": [ - "priority", - "exchange" - ], - "title": "DomainProfileMxRecordResponse" - }, - "DomainProfileResponse": { - "properties": { - "asset_uuid": { - "type": "string", - "title": "Asset Uuid" - }, - "fqdn": { - "type": "string", - "title": "Fqdn" - }, - "risk": { - "type": "integer", - "title": "Risk" - }, - "metadata": { - "$ref": "#/components/schemas/DomainProfileMetadataResponse" - }, - "certificate": { - "anyOf": [ - { - "$ref": "#/components/schemas/DomainProfileCertificateResponse" - }, - { - "type": "null" - } - ] - }, - "dns_records": { - "anyOf": [ - { - "$ref": "#/components/schemas/DomainProfileDnsRecordsResponse" - }, - { - "type": "null" - } - ] - }, - "whois_rdap": { - "anyOf": [ - { - "$ref": "#/components/schemas/DomainProfileWhoisRdapResponse" - }, - { - "type": "null" - } - ] - } - }, - "type": "object", - "required": [ - "asset_uuid", - "fqdn", - "risk", - "metadata", - "certificate", - "dns_records", - "whois_rdap" - ], - "title": "DomainProfileResponse" - }, - "DomainProfileWhoisRdapResponse": { - "properties": { - "registrar": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Registrar" - }, - "contact_email": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Contact Email" - }, - "epp_status": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Epp Status" - }, - "registered_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Registered At" - }, - "updated_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Updated At" - }, - "expires_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Expires At" - } - }, - "type": "object", - "required": [ - "registrar", - "contact_email", - "epp_status", - "registered_at", - "updated_at", - "expires_at" - ], - "title": "DomainProfileWhoisRdapResponse" - }, - "DomainQuery": { - "properties": { - "type": { - "type": "string", - "const": "domain", - "title": "Type" - }, - "fqdn": { - "type": "string", - "title": "Fqdn" - } - }, - "type": "object", - "required": [ - "type", - "fqdn" - ], - "title": "DomainQuery" - }, - "DomainRegistrarsResponse": { - "properties": { - "registrars": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Registrars" - } - }, - "type": "object", - "required": [ - "registrars" - ], - "title": "DomainRegistrarsResponse" - }, - "DomainRestrictedTerm": { - "properties": { - "type": { - "type": "string", - "const": "domain", - "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": "DomainRestrictedTerm" - }, - "DomainStatus": { - "type": "string", - "enum": [ - "found", - "resolves", - "reachable" - ], - "title": "DomainStatus" - }, - "EmailData": { - "properties": { - "type": { - "type": "string", - "const": "email", - "title": "Type", - "default": "email" - }, - "email": { - "type": "string", - "format": "email", - "title": "Email" - } - }, - "type": "object", - "required": [ - "email" - ], - "title": "EmailData" - }, - "EmailQuery": { - "properties": { - "type": { - "type": "string", - "const": "email", - "title": "Type" - }, - "email": { - "type": "string", - "title": "Email" - } - }, - "type": "object", - "required": [ - "type", - "email" - ], - "title": "EmailQuery" - }, - "EnableFlareCommunityRequest": { - "properties": { - "auto_provision_users": { - "type": "boolean", - "title": "Auto Provision Users", - "default": false - }, - "manual_users": { - "items": { - "$ref": "#/components/schemas/ProvisionUserItemRequest" - }, - "type": "array", - "title": "Manual Users" - } - }, - "type": "object", - "title": "EnableFlareCommunityRequest" - }, - "EnableFlareCommunityResponse": { - "properties": { - "provisioned_users_created": { - "type": "integer", - "title": "Provisioned Users Created", - "default": 0 - }, - "provisioned_users_already_existed": { - "type": "integer", - "title": "Provisioned Users Already Existed", - "default": 0 - } - }, - "type": "object", - "title": "EnableFlareCommunityResponse" - }, - "EncryptionCertificateResponse": { - "properties": { - "encryption_certificate": { - "type": "string", - "title": "Encryption Certificate" - } - }, - "type": "object", - "required": [ - "encryption_certificate" - ], - "title": "EncryptionCertificateResponse" - }, - "EnrichedBulkAction": { - "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "type": { - "$ref": "#/components/schemas/BulkActionType" - }, - "status": { - "$ref": "#/components/schemas/BulkActionStatus" - }, - "error": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Error" - }, - "targets": { - "items": { - "$ref": "#/components/schemas/EnrichedBulkActionTarget" - }, - "type": "array", - "title": "Targets" - } - }, - "type": "object", - "required": [ - "id", - "type", - "status", - "error", - "targets" - ], - "title": "EnrichedBulkAction" - }, - "EnrichedBulkActionTarget": { - "properties": { - "type": { - "$ref": "#/components/schemas/BulkActionTargetType" - }, - "item_ids": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Item Ids" - }, - "filters": { - "anyOf": [ - { - "oneOf": [ - { - "$ref": "#/components/schemas/IdentifierRecommendationFilters" - }, - { - "$ref": "#/components/schemas/IdentifierRecommendationGroupFilters" - }, - { - "$ref": "#/components/schemas/GroupFilters" - }, - { - "$ref": "#/components/schemas/IdentifierFilters" - }, - { - "$ref": "#/components/schemas/CredentialFilters" - }, - { - "$ref": "#/components/schemas/TenantIntegrationFilters" - }, - { - "$ref": "#/components/schemas/EventFilters" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "credential": "#/components/schemas/CredentialFilters", - "event": "#/components/schemas/EventFilters", - "group": "#/components/schemas/GroupFilters", - "identifier": "#/components/schemas/IdentifierFilters", - "identifier_recommendation": "#/components/schemas/IdentifierRecommendationFilters", - "identifier_recommendation_group": "#/components/schemas/IdentifierRecommendationGroupFilters", - "tenant_integration": "#/components/schemas/TenantIntegrationFilters" - } - } - }, - { - "type": "null" - } - ], - "title": "Filters" - }, - "is_completed": { - "type": "boolean", - "title": "Is Completed" - }, - "error": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Error" - } - }, - "type": "object", - "required": [ - "type", - "item_ids", - "filters", - "is_completed", - "error" - ], - "title": "EnrichedBulkActionTarget" - }, - "EnrichedCookie": { - "properties": { - "domain": { - "type": "string", - "title": "Domain" - }, - "activity_uid": { - "$ref": "#/components/schemas/ActivityUid" - }, - "leaked_at": { - "type": "string", - "format": "date-time", - "title": "Leaked At" - }, - "risk_score": { - "$ref": "#/components/schemas/RiskScore" - }, - "application_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Application Name" - }, - "host_key": { - "type": "string", - "title": "Host Key" - }, - "path": { - "type": "string", - "title": "Path" - }, - "expires_utc": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Expires Utc" - }, - "name": { - "type": "string", - "title": "Name" - }, - "value": { - "type": "string", - "title": "Value" - }, - "type": { - "type": "string", - "const": "cookie", - "title": "Type", - "default": "cookie" - } - }, - "type": "object", - "required": [ - "domain", - "activity_uid", - "leaked_at", - "risk_score", - "host_key", - "path", - "expires_utc", - "name", - "value" - ], - "title": "EnrichedCookie" - }, - "EnrichedCredential": { - "properties": { - "domain": { - "type": "string", - "title": "Domain" - }, - "activity_uid": { - "$ref": "#/components/schemas/ActivityUid" - }, - "leaked_at": { - "type": "string", - "format": "date-time", - "title": "Leaked At" - }, - "risk_score": { - "$ref": "#/components/schemas/RiskScore" - }, - "application_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Application Name" - }, - "type": { - "type": "string", - "const": "leaked_credential", - "title": "Type", - "default": "leaked_credential" - }, - "url": { - "type": "string", - "title": "Url" - }, - "username": { - "type": "string", - "title": "Username" - }, - "password": { - "type": "string", - "title": "Password" - }, - "hash": { - "type": "string", - "title": "Hash" - } - }, - "type": "object", - "required": [ - "domain", - "activity_uid", - "leaked_at", - "risk_score", - "url", - "username", - "password", - "hash" - ], - "title": "EnrichedCredential" - }, - "EnrichedSource": { - "properties": { - "name": { - "type": "string", - "title": "Name" - }, - "title": { - "type": "string", - "title": "Title" - } - }, - "type": "object", - "required": [ - "name", - "title" - ], - "title": "EnrichedSource" - }, - "EntityAPIResponseTypes": { - "anyOf": [ - { - "$ref": "#/components/schemas/ActorAPIResponse" - }, - { - "$ref": "#/components/schemas/AttackPatternEntityAPIResponse" - }, - { - "$ref": "#/components/schemas/CampaignEntityAPIResponse" - }, - { - "$ref": "#/components/schemas/ChatChannelEntityAPIResponse" - }, - { - "$ref": "#/components/schemas/ExternalReportEntityAPIResponse" - }, - { - "$ref": "#/components/schemas/ForumThreadAPIResponse" - }, - { - "$ref": "#/components/schemas/IndicatorEntityAPIResponse" - }, - { - "$ref": "#/components/schemas/InfrastructureEntityAPIResponse" - }, - { - "$ref": "#/components/schemas/LocationEntityAPIResponse" - }, - { - "$ref": "#/components/schemas/MalwareEntityAPIResponse" - }, - { - "$ref": "#/components/schemas/ThreatActorEntityAPIResponse" - }, - { - "$ref": "#/components/schemas/ThreatActorGroupEntityAPIResponse" - }, - { - "$ref": "#/components/schemas/ToolEntityAPIResponse" - }, - { - "$ref": "#/components/schemas/VulnerabilityEntityAPIResponse" - } - ] - }, - "EntityData": { - "properties": { - "asset_uuid": { - "type": "string", - "title": "Asset Uuid" - }, - "entity_type": { - "$ref": "#/components/schemas/CTIEntityType" - }, - "name": { - "type": "string", - "title": "Name" - }, - "confidence": { - "type": "integer", - "title": "Confidence" - } - }, - "type": "object", - "required": [ - "asset_uuid", - "entity_type", - "name", - "confidence" - ], - "title": "EntityData" - }, - "EntityType": { - "type": "string", - "enum": [ - "attack_pattern", - "actor", - "campaign", - "chat_channel", - "external_report", - "forum_thread", - "identity", - "indicator", - "infrastructure", - "domain", - "location", - "malware", - "organization", - "threat_actor", - "threat_actor_group", - "tool", - "vulnerability" - ], - "title": "EntityType" - }, - "EntraIDFailedValidationDetails": { - "properties": { - "invalid_parameter_field": { - "anyOf": [ - { - "$ref": "#/components/schemas/EntraIDInvalidParameterField" - }, - { - "type": "null" - } - ] - }, - "invalid_group_ids": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - { - "type": "null" - } - ], - "title": "Invalid Group Ids" - } - }, - "type": "object", - "title": "EntraIDFailedValidationDetails" - }, - "EntraIDInputParams": { - "properties": { - "params_type": { - "type": "string", - "const": "entra_id", - "title": "Params Type", - "default": "entra_id" - }, - "entra_client_id": { - "type": "string", - "title": "Entra Client Id" - }, - "entra_tenant_id": { - "type": "string", - "title": "Entra Tenant Id" - }, - "get_users_additional_params": { - "anyOf": [ - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ] - }, - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Get Users Additional Params" - }, - "group_id_for_user_sync": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Group Id For User Sync" - }, - "group_id_for_automatically_disable_account": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Group Id For Automatically Disable Account" - }, - "group_id_for_automatically_mark_as_compromised": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Group Id For Automatically Mark As Compromised" - }, - "group_id_for_automatically_revoke_sessions": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Group Id For Automatically Revoke Sessions" - }, - "enable_full_idp_sync": { - "type": "boolean", - "title": "Enable Full Idp Sync", - "default": false - }, - "features": { - "items": { - "$ref": "#/components/schemas/IdPFeature" - }, - "type": "array", - "uniqueItems": true, - "title": "Features" - }, - "lockout_policy": { - "anyOf": [ - { - "$ref": "#/components/schemas/CredentialValidationThresholdPolicy" - }, - { - "type": "null" - } - ] - }, - "entra_client_secret": { - "anyOf": [ - { - "type": "string", - "format": "password", - "writeOnly": true - }, - { - "type": "null" - } - ], - "title": "Entra Client Secret" - } - }, - "type": "object", - "required": [ - "entra_client_id", - "entra_tenant_id" - ], - "title": "EntraIDInputParams" - }, - "EntraIDInvalidParameterField": { - "type": "string", - "enum": [ - "entra_client_id", - "entra_client_secret", - "entra_tenant_id" - ], - "title": "EntraIDInvalidParameterField" - }, - "EntraIDParams": { - "properties": { - "params_type": { - "type": "string", - "const": "entra_id", - "title": "Params Type", - "default": "entra_id" - }, - "entra_client_id": { - "type": "string", - "title": "Entra Client Id" - }, - "entra_tenant_id": { - "type": "string", - "title": "Entra Tenant Id" - }, - "get_users_additional_params": { - "anyOf": [ - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ] - }, - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Get Users Additional Params" - }, - "group_id_for_user_sync": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Group Id For User Sync" - }, - "group_id_for_automatically_disable_account": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Group Id For Automatically Disable Account" - }, - "group_id_for_automatically_mark_as_compromised": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Group Id For Automatically Mark As Compromised" - }, - "group_id_for_automatically_revoke_sessions": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Group Id For Automatically Revoke Sessions" - }, - "enable_full_idp_sync": { - "type": "boolean", - "title": "Enable Full Idp Sync", - "default": false - }, - "features": { - "items": { - "$ref": "#/components/schemas/IdPFeature" - }, - "type": "array", - "uniqueItems": true, - "title": "Features" - }, - "lockout_policy": { - "anyOf": [ - { - "$ref": "#/components/schemas/CredentialValidationThresholdPolicy" - }, - { - "type": "null" - } - ] - }, - "entra_client_secret": { - "type": "string", - "format": "password", - "title": "Entra Client Secret", - "deprecated": true, - "writeOnly": true - }, - "entra_client_secret_encrypted": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Entra Client Secret Encrypted" - } - }, - "type": "object", - "required": [ - "entra_client_id", - "entra_tenant_id", - "entra_client_secret" - ], - "title": "EntraIDParams" - }, - "EventAction": { - "properties": { - "type": { - "type": "string", - "enum": [ - "remediate", - "unremediate", - "ignore", - "unignore" - ], - "title": "Type" - } - }, - "type": "object", - "required": [ - "type" - ], - "title": "EventAction" - }, - "EventActionTarget": { - "properties": { - "uid": { - "type": "string", - "title": "Uid" - } - }, - "type": "object", - "required": [ - "uid" - ], - "title": "EventActionTarget" - }, - "EventActionsBody": { - "properties": { - "targets": { - "items": { - "$ref": "#/components/schemas/EventActionTarget" - }, - "type": "array", - "maxItems": 10, - "title": "Targets" - }, - "action": { - "$ref": "#/components/schemas/EventAction" - } - }, - "type": "object", - "required": [ - "action" - ], - "title": "EventActionsBody" - }, - "EventFilters": { - "properties": { - "type": { - "type": "string", - "const": "event", - "title": "Type", - "default": "event" - }, - "event_uids": { - "items": { - "type": "string" - }, - "type": "array", - "minItems": 1, - "title": "Event Uids" - } - }, - "type": "object", - "required": [ - "event_uids" - ], - "title": "EventFilters" - }, - "EventMetadata": { - "properties": { - "estimated_created_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Estimated Created At" - }, - "flare_url": { - "type": "string", - "maxLength": 2083, - "minLength": 1, - "format": "uri", - "title": "Flare Url" - }, - "matched_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Matched At" - }, - "severity": { - "$ref": "#/components/schemas/EventSeverity" - }, - "uid": { - "type": "string", - "title": "Uid" - } - }, - "type": "object", - "required": [ - "estimated_created_at", - "flare_url", - "matched_at", - "severity", - "uid" - ], - "title": "EventMetadata" - }, - "EventSecretsBody": { - "properties": { - "uid": { - "type": "string", - "title": "Uid" - }, - "from": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From" - }, - "size": { - "type": "integer", - "maximum": 50.0, - "exclusiveMinimum": 0.0, - "title": "Size", - "default": 10 - } - }, - "type": "object", - "required": [ - "uid" - ], - "title": "EventSecretsBody" - }, - "EventSeverity": { - "type": "string", - "enum": [ - "info", - "low", - "medium", - "high", - "critical" - ], - "title": "EventSeverity" - }, - "ExpandableField": { - "type": "string", - "enum": [ - "credentials", - "cookies" - ], - "title": "ExpandableField" - }, - "ExperimentalEventMetadata": { - "properties": { - "source": { - "type": "string", - "minLength": 1, - "title": "Source" - }, - "id": { - "type": "string", - "minLength": 1, - "title": "Id" - }, - "url": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Url" - }, - "extra": { - "anyOf": [ - { - "additionalProperties": true, - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Extra" - }, - "estimated_created_at": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Estimated Created At" - } - }, - "type": "object", - "required": [ - "source", - "id" - ], - "title": "ExperimentalEventMetadata" - }, - "ExternalReportEntityAPIResponse": { - "properties": { - "uuid": { - "type": "string", - "title": "Uuid" - }, - "type": { - "$ref": "#/components/schemas/EntityType" - }, - "name": { - "type": "string", - "title": "Name" - }, - "created_by": { - "type": "string", - "title": "Created By" - }, - "sources": { - "items": { - "$ref": "#/components/schemas/CTIEntitySourceAPIResponse" - }, - "type": "array", - "title": "Sources" - }, - "created_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Created At" - }, - "updated_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Updated At" - }, - "first_seen_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "First Seen At" - }, - "last_seen_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Last Seen At" - }, - "confidence": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Confidence" - }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Description" - }, - "report_types": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Report Types" - }, - "published": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Published" - }, - "marking_definitions": { - "items": { - "$ref": "#/components/schemas/MarkingDefinition" - }, - "type": "array", - "title": "Marking Definitions" - } - }, - "type": "object", - "required": [ - "uuid", - "type", - "name", - "created_by", - "sources", - "created_at", - "updated_at", - "description", - "report_types", - "published", - "marking_definitions" - ], - "title": "ExternalReportEntityAPIResponse" - }, - "FaviconHashType": { - "type": "string", - "enum": [ - "average_hash", - "phash", - "phash_simple", - "whash", - "dhash", - "mmh3" - ], - "title": "FaviconHashType" - }, - "FaviconInfo": { - "properties": { - "asset_hash": { - "type": "string", - "title": "Asset Hash" - }, - "hashes": { - "additionalProperties": { - "type": "string" - }, - "propertyNames": { - "$ref": "#/components/schemas/FaviconHashType" - }, - "type": "object", - "title": "Hashes" - } - }, - "type": "object", - "required": [ - "asset_hash", - "hashes" - ], - "title": "FaviconInfo" - }, - "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": "FeatureFlagDefinition" - }, - "FeatureFlagMetrics": { - "properties": { - "user_count": { - "type": "integer", - "title": "User Count", - "default": 0 - }, - "tenant_count": { - "type": "integer", - "title": "Tenant Count", - "default": 0 - }, - "organization_count": { - "type": "integer", - "title": "Organization Count", - "default": 0 - } - }, - "type": "object", - "title": "FeatureFlagMetrics" - }, - "FeatureFlagResponse": { - "properties": { - "feature_flag": { - "$ref": "#/components/schemas/FeatureFlagDefinition" - } - }, - "type": "object", - "required": [ - "feature_flag" - ], - "title": "FeatureFlagResponse" - }, - "FeatureFlagStatus": { - "properties": { - "name": { - "type": "string", - "title": "Name" - }, - "description": { - "type": "string", - "title": "Description" - }, - "enabled": { - "type": "boolean", - "title": "Enabled" - }, - "enabled_by": { - "anyOf": [ - { - "$ref": "#/components/schemas/FeatureFlagStatusEnabledByTenant" - }, - { - "$ref": "#/components/schemas/FeatureFlagStatusEnabledByOrganization" - }, - { - "$ref": "#/components/schemas/FeatureFlagStatusEnabledByGlobal" - }, - { - "$ref": "#/components/schemas/FeatureFlagStatusEnabledByUser" - }, - { - "type": "null" - } - ], - "title": "Enabled By" - } - }, - "type": "object", - "required": [ - "name", - "description", - "enabled", - "enabled_by" - ], - "title": "FeatureFlagStatus" - }, - "FeatureFlagStatusEnabledByGlobal": { - "properties": { - "source": { - "type": "string", - "const": "global", - "title": "Source", - "default": "global" - } - }, - "type": "object", - "title": "FeatureFlagStatusEnabledByGlobal" - }, - "FeatureFlagStatusEnabledByOrganization": { - "properties": { - "source": { - "type": "string", - "const": "organization", - "title": "Source", - "default": "organization" - }, - "organization_id": { - "type": "integer", - "title": "Organization Id" - }, - "is_user_list": { - "type": "boolean", - "title": "Is User List" - } - }, - "type": "object", - "required": [ - "organization_id", - "is_user_list" - ], - "title": "FeatureFlagStatusEnabledByOrganization" - }, - "FeatureFlagStatusEnabledByTenant": { - "properties": { - "source": { - "type": "string", - "const": "tenant", - "title": "Source", - "default": "tenant" - }, - "tenant_id": { - "type": "integer", - "title": "Tenant Id" - }, - "is_user_list": { - "type": "boolean", - "title": "Is User List" - } - }, - "type": "object", - "required": [ - "tenant_id", - "is_user_list" - ], - "title": "FeatureFlagStatusEnabledByTenant" - }, - "FeatureFlagStatusEnabledByUser": { - "properties": { - "source": { - "type": "string", - "const": "user", - "title": "Source", - "default": "user" - }, - "user_id": { - "type": "integer", - "title": "User Id" - }, - "is_user_list": { - "type": "boolean", - "title": "Is User List" - } - }, - "type": "object", - "required": [ - "user_id", - "is_user_list" - ], - "title": "FeatureFlagStatusEnabledByUser" - }, - "FeatureFlagStrategy": { - "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "type": { - "$ref": "#/components/schemas/GitlabFeatureFlagStrategyName" - }, - "members": { - "items": { - "$ref": "#/components/schemas/StrategyMember" - }, - "type": "array", - "title": "Members" - }, - "scopes": { - "items": { - "$ref": "#/components/schemas/GitlabFeatureFlagScope" - }, - "type": "array", - "title": "Scopes" - }, - "user_list": { - "anyOf": [ - { - "$ref": "#/components/schemas/FeatureFlagUserList" - }, - { - "type": "null" - } - ] - } - }, - "type": "object", - "required": [ - "id", - "type", - "members", - "scopes" - ], - "title": "FeatureFlagStrategy" - }, - "FeatureFlagUserList": { - "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "iid": { - "type": "integer", - "title": "Iid" - }, - "name": { - "type": "string", - "title": "Name" - }, - "members": { - "items": { - "$ref": "#/components/schemas/StrategyMember" - }, - "type": "array", - "title": "Members" - }, - "metrics": { - "$ref": "#/components/schemas/FeatureFlagMetrics" - } - }, - "type": "object", - "required": [ - "id", - "iid", - "name", - "members", - "metrics" - ], - "title": "FeatureFlagUserList" - }, - "FeatureFlagUserListResponse": { - "properties": { - "user_list": { - "$ref": "#/components/schemas/FeatureFlagUserList" - } - }, - "type": "object", - "required": [ - "user_list" - ], - "title": "FeatureFlagUserListResponse" - }, - "Features": { - "type": "string", - "enum": [ - "standard", - "takedown", - "browser_extension" - ], - "title": "Features" - }, - "FeedConfiguration": { - "properties": { - "search_types": { - "items": { - "$ref": "#/components/schemas/SearchType" - }, - "type": "array", - "title": "Search Types" - }, - "experimental_search_types": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Experimental Search Types" - }, - "risks": { - "items": { - "$ref": "#/components/schemas/RiskScore" - }, - "type": "array", - "title": "Risks" - }, - "blacklist": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Blacklist" - } - }, - "type": "object", - "required": [ - "search_types", - "experimental_search_types", - "risks", - "blacklist" - ], - "title": "FeedConfiguration" - }, - "FeedDateFilter": { - "properties": { - "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": "FeedDateFilter" - }, - "FeedDefinition": { - "properties": { - "type": { - "$ref": "#/components/schemas/FeedType" - }, - "id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Id" - } - }, - "type": "object", - "required": [ - "type" - ], - "title": "FeedDefinition" - }, - "FeedFilters": { - "properties": { - "severity": { - "anyOf": [ - { - "$ref": "#/components/schemas/Severity" - }, - { - "items": { - "$ref": "#/components/schemas/Severity" - }, - "type": "array" - } - ], - "title": "Severity" - }, - "type": { - "items": { - "$ref": "#/components/schemas/SearchType" - }, - "type": "array", - "title": "Type" - }, - "estimated_created_at": { - "$ref": "#/components/schemas/FeedDateFilter" - }, - "materialized_at": { - "$ref": "#/components/schemas/FeedDateFilter" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Tags" - }, - "is_ignored": { - "type": "boolean", - "title": "Is Ignored", - "default": false - }, - "is_remediated": { - "type": "boolean", - "title": "Is Remediated", - "default": false - } - }, - "type": "object", - "title": "FeedFilters" - }, - "FeedItem": { - "properties": { - "metadata": { - "$ref": "#/components/schemas/FeedItemMetadata" - }, - "tenant_metadata": { - "$ref": "#/components/schemas/FeedItemTenantMetadata" - }, - "identifiers": { - "items": { - "$ref": "#/components/schemas/FeedItemIdentifier" - }, - "type": "array", - "title": "Identifiers" - }, - "highlights": { - "additionalProperties": { - "items": { - "type": "string" - }, - "type": "array" - }, - "type": "object", - "title": "Highlights" - } - }, - "type": "object", - "required": [ - "metadata" - ], - "title": "FeedItem" - }, - "FeedItemIdentifier": { - "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "name": { - "type": "string", - "title": "Name" - } - }, - "type": "object", - "required": [ - "id", - "name" - ], - "title": "FeedItemIdentifier" - }, - "FeedItemMetadata": { - "properties": { - "uid": { - "type": "string", - "title": "Uid" - }, - "estimated_created_at": { - "type": "string", - "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" - }, - "severity": { - "$ref": "#/components/schemas/Severity" - }, - "flare_url": { - "type": "string", - "title": "Flare Url" - } - }, - "type": "object", - "required": [ - "uid", - "estimated_created_at", - "matched_at", - "type", - "severity", - "flare_url" - ], - "title": "FeedItemMetadata" - }, - "FeedItemTenantMetadata": { - "properties": { - "severity": { - "anyOf": [ - { - "$ref": "#/components/schemas/FeedItemTenantMetadataSeverity" - }, - { - "type": "null" - } - ] - }, - "notes": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Notes" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Tags" - }, - "remediated_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Remediated At" - }, - "ignored_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Ignored At" - } - }, - "type": "object", - "title": "FeedItemTenantMetadata" - }, - "FeedItemTenantMetadataSeverity": { - "properties": { - "original": { - "$ref": "#/components/schemas/Severity" - }, - "override": { - "$ref": "#/components/schemas/Severity" - } - }, - "type": "object", - "required": [ - "original", - "override" - ], - "title": "FeedItemTenantMetadataSeverity" - }, - "FeedOrder": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "title": "FeedOrder" - }, - "FeedRequestBody": { - "properties": { - "query": { - "anyOf": [ - { - "oneOf": [ - { - "$ref": "#/components/schemas/GithubRepositoryQuery" - }, - { - "$ref": "#/components/schemas/UsernameQuery" - }, - { - "$ref": "#/components/schemas/DomainQuery" - }, - { - "$ref": "#/components/schemas/BrandQuery" - }, - { - "$ref": "#/components/schemas/NameQuery" - }, - { - "$ref": "#/components/schemas/KeywordQuery" - }, - { - "$ref": "#/components/schemas/QueryStringQuery" - }, - { - "$ref": "#/components/schemas/BinQuery" - }, - { - "$ref": "#/components/schemas/IpQuery" - }, - { - "$ref": "#/components/schemas/EmailQuery" - }, - { - "$ref": "#/components/schemas/SecretQuery" - }, - { - "$ref": "#/components/schemas/CredentialsQuery" - }, - { - "$ref": "#/components/schemas/AzureTenantQuery" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "azure_tenant": "#/components/schemas/AzureTenantQuery", - "bin": "#/components/schemas/BinQuery", - "brand": "#/components/schemas/BrandQuery", - "credentials": "#/components/schemas/CredentialsQuery", - "domain": "#/components/schemas/DomainQuery", - "email": "#/components/schemas/EmailQuery", - "github_repository": "#/components/schemas/GithubRepositoryQuery", - "ip": "#/components/schemas/IpQuery", - "keyword": "#/components/schemas/KeywordQuery", - "name": "#/components/schemas/NameQuery", - "query_string": "#/components/schemas/QueryStringQuery", - "secret": "#/components/schemas/SecretQuery", - "username": "#/components/schemas/UsernameQuery" - } - } - }, - { - "type": "null" - } - ], - "title": "Query", - "examples": [ - { - "fqdn": "test.com", - "type": "domain" - } - ] - }, - "filters": { - "$ref": "#/components/schemas/FeedFilters" - }, - "order": { - "$ref": "#/components/schemas/FeedOrder", - "default": "desc" - }, - "from": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From" - }, - "size": { - "type": "integer", - "maximum": 10.0, - "exclusiveMinimum": 0.0, - "title": "Size", - "default": 10 - } - }, - "type": "object", - "title": "FeedRequestBody" - }, - "FeedType": { - "type": "string", - "enum": [ - "tenant", - "identifier", - "group" - ], - "title": "FeedType" - }, - "FileAnalysisSubmit": { - "properties": { - "i_agree_to_tos": { - "type": "boolean", - "title": "I Agree To Tos" - }, - "activity_uid": { - "type": "string", - "title": "Activity Uid" - } - }, - "type": "object", - "required": [ - "i_agree_to_tos", - "activity_uid" - ], - "title": "FileAnalysisSubmit" - }, - "FilterSeverities": { - "properties": { - "severities": { - "items": { - "$ref": "#/components/schemas/FilterSeverity" - }, - "type": "array", - "title": "Severities" - } - }, - "type": "object", - "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" - }, - "FinancialEvent": { - "properties": { - "event_type": { - "type": "string", - "const": "cc", - "title": "Event Type", - "default": "cc" - }, - "data": { - "$ref": "#/components/schemas/FinancialEventData" - }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" - } - }, - "type": "object", - "required": [ - "data", - "metadata" - ], - "title": "Credit Card" - }, - "FinancialEventData": { - "properties": { - "bank": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Bank", - "description": "The bank associated with the leaked credit card." - }, - "bin": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Bin", - "description": "The BIN (Bank Identification Number) of the credit card." - }, - "brand": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Brand", - "description": "The brand of the leakedcredit card. Ex: VISA" - }, - "country": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Country", - "description": "The country the leakedcredit card was issued in." - }, - "expiration": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Expiration", - "description": "The expiration date of the leaked credit card." - }, - "owner": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Owner", - "description": "The owner of the leaked credit card." - }, - "state_code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "State Code", - "description": "The state code tied to the leaked credit card." - }, - "zip": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Zip", - "description": "The zip code tied to the leaked credit card." - }, - "has_cvv": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Has Cvv", - "description": "Whether the CVV was included in the leaked data." - }, - "has_date_of_birth": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Has Date Of Birth", - "description": "Whether the date of birth was included in the leaked data." - }, - "has_mother_maiden_name": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Has Mother Maiden Name", - "description": "Whether the mother's maiden name was included in the leaked data." - }, - "has_phone": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Has Phone", - "description": "Whether the phone number was included in the leaked data." - }, - "has_pin": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Has Pin", - "description": "Whether the card's PIN was included in the leaked data." - }, - "has_ssn": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Has Ssn", - "description": "Whether the card owner's SSN was included in the leaked data." - }, - "has_track_1": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Has Track 1", - "description": "Whether the card's track 1 (magnetic stripe data) was included in the leaked data." - }, - "has_vbv": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Has Vbv", - "description": "Whether the card's VBV (Verified by Visa) data was included in the leaked data." - } - }, - "type": "object", - "required": [ - "bank", - "bin", - "brand", - "country", - "expiration", - "owner", - "state_code", - "zip", - "has_cvv", - "has_date_of_birth", - "has_mother_maiden_name", - "has_phone", - "has_pin", - "has_ssn", - "has_track_1", - "has_vbv" - ], - "title": "FinancialEventData" - }, - "FlareInviteLinkRequest": { - "properties": { - "organization_name": { - "type": "string", - "title": "Organization Name" - }, - "domains": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Domains" - }, - "features": { - "items": { - "$ref": "#/components/schemas/Features" - }, - "type": "array", - "title": "Features" - } - }, - "type": "object", - "required": [ - "organization_name", - "domains" - ], - "title": "FlareInviteLinkRequest" - }, - "ForetraceInputParams": { - "properties": { - "params_type": { - "type": "string", - "const": "flare_community", - "title": "Params Type", - "default": "flare_community" - } - }, - "type": "object", - "title": "ForetraceInputParams" - }, - "ForetraceParams": { - "properties": { - "params_type": { - "type": "string", - "const": "flare_community", - "title": "Params Type", - "default": "flare_community" - } - }, - "type": "object", - "title": "ForetraceParams" - }, - "ForumPostData": { - "properties": { - "actor": { - "$ref": "#/components/schemas/pyro__findings__forum_posts__datamodels__ForumPostData__Actor", - "description": "Details about the author of the forum post." - }, - "context": { - "$ref": "#/components/schemas/pyro__findings__forum_posts__datamodels__ForumPostData__Context", - "description": "Details about the context of the forum post." - }, - "posted_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Posted At", - "description": "Date and time the forum post was made." - }, - "content": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Content", - "description": "Content of the forum post." - }, - "url": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Url", - "description": "URL to the forum post." - } - }, - "type": "object", - "required": [ - "actor", - "context", - "posted_at", - "content", - "url" - ], - "title": "ForumPostData" - }, - "ForumPostEvent": { - "properties": { - "event_type": { - "type": "string", - "const": "forum_post", - "title": "Event Type", - "default": "forum_post" - }, - "data": { - "$ref": "#/components/schemas/ForumPostData" - }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" - } - }, - "type": "object", - "required": [ - "data", - "metadata" - ], - "title": "Forum Post" - }, - "ForumThreadAPIResponse": { - "properties": { - "uuid": { - "type": "string", - "title": "Uuid" - }, - "type": { - "$ref": "#/components/schemas/EntityType" - }, - "name": { - "type": "string", - "title": "Name" - }, - "created_by": { - "type": "string", - "title": "Created By" - }, - "sources": { - "items": { - "$ref": "#/components/schemas/CTIEntitySourceAPIResponse" - }, - "type": "array", - "title": "Sources" - }, - "created_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Created At" - }, - "updated_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Updated At" - }, - "first_seen_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "First Seen At" - }, - "last_seen_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Last Seen At" - }, - "confidence": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Confidence" - }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Description" - } - }, - "type": "object", - "required": [ - "uuid", - "type", - "name", - "created_by", - "sources", - "created_at", - "updated_at", - "description" - ], - "title": "ForumThreadAPIResponse" - }, - "ForumThreadAnalysisMetadataResponse": { - "properties": { - "summarized_at": { - "type": "string", - "format": "date-time", - "title": "Summarized At" - }, - "summarization_start_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Summarization Start At" - }, - "summarization_end_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Summarization End At" - }, - "events_summarized_count": { - "type": "integer", - "title": "Events Summarized Count" - }, - "total_events_count": { - "type": "integer", - "title": "Total Events Count" - } - }, - "type": "object", - "required": [ - "summarized_at", - "summarization_start_at", - "summarization_end_at", - "events_summarized_count", - "total_events_count" - ], - "title": "ForumThreadAnalysisMetadataResponse" - }, - "ForumThreadAssetUuidPayload": { - "properties": { - "forum_thread_id": { - "type": "string", - "title": "Forum Thread Id" - }, - "source": { - "type": "string", - "title": "Source" - } - }, - "type": "object", - "required": [ - "forum_thread_id", - "source" - ], - "title": "ForumThreadAssetUuidPayload" - }, - "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_actor_name": { - "type": "string", - "title": "Creator Actor Name" - }, - "creator_actor_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Creator Actor Id" - }, - "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_actor_name", - "source" - ], - "title": "ForumThreadMetadata" - }, - "ForumThreadSummariesGenerationPayload": { - "properties": { - "source": { - "type": "string", - "title": "Source" - } - }, - "type": "object", - "required": [ - "source" - ], - "title": "ForumThreadSummariesGenerationPayload" - }, - "ForumThreadSummariesResponse": { - "properties": { - "request_id": { - "anyOf": [ - { - "type": "string", - "format": "uuid" - }, - { - "type": "null" - } - ], - "title": "Request Id" - }, - "error": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Error" - }, - "summarized_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Summarized At" - }, - "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": [ - "request_id" - ], - "title": "ForumThreadSummariesResponse" - }, - "ForumThreadTimeline": { - "properties": { - "aggregate_by": { - "anyOf": [ - { - "$ref": "#/components/schemas/StatsAggregates" - }, - { - "type": "null" - } - ] - }, - "timeline": { - "items": { - "$ref": "#/components/schemas/ForumThreadTimelineEntry" - }, - "type": "array", - "title": "Timeline" - }, - "total_count": { - "type": "integer", - "title": "Total Count" - } - }, - "type": "object", - "required": [ - "timeline", - "total_count" - ], - "title": "ForumThreadTimeline" - }, - "ForumThreadTimelineEntry": { - "properties": { - "date": { - "type": "string", - "format": "date-time", - "title": "Date" - }, - "total_count": { - "type": "integer", - "title": "Total Count" - } - }, - "type": "object", - "required": [ - "date", - "total_count" - ], - "title": "ForumThreadTimelineEntry" - }, - "ForumThreadTopicUidAndTitlePayload": { - "properties": { - "forum_topic_uid": { - "type": "string", - "title": "Forum Topic Uid" - }, - "title": { - "type": "string", - "title": "Title" - } - }, - "type": "object", - "required": [ - "forum_topic_uid", - "title" - ], - "title": "ForumThreadTopicUidAndTitlePayload" - }, - "ForwardInfo": { - "properties": { - "forwarded_from": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Forwarded From", - "description": "The username of the chat message forwarder." - }, - "forwarded_from_author_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Forwarded From Author Id", - "description": "The ID of the chat message forwarder." - }, - "forwarded_from_chat_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Forwarded From Chat Id", - "description": "The ID of the chat the message is being forwarded from." - }, - "forwarded_from_conversation_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Forwarded From Conversation Id", - "description": "The conversation ID the message is being forwarded from." - }, - "forwarded_from_user_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Forwarded From User Id", - "description": "The ID of the user the message is being forwarded from." - }, - "forwarded_from_username": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Forwarded From Username", - "description": "The username of the user the message is being forwarded from." - }, - "forwarded_message_time": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Forwarded Message Time", - "description": "The time the message was forwarded." - } - }, - "type": "object", - "title": "ForwardInfo" - }, - "FreeTrialStatus": { - "type": "string", - "enum": [ - "no_trial", - "active", - "expired" - ], - "title": "FreeTrialStatus" - }, - "FreeTrialStatusResponse": { - "properties": { - "module": { - "$ref": "#/components/schemas/HubspotModuleFreeTrialName" - }, - "status": { - "$ref": "#/components/schemas/FreeTrialStatus" - }, - "end_date": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "End Date" - } - }, - "type": "object", - "required": [ - "module", - "status", - "end_date" - ], - "title": "FreeTrialStatusResponse" - }, - "GeneralProfileSummaryOutput": { - "properties": { - "overview": { - "type": "string", - "title": "Overview", - "description": "Paragraph about the general description of the actor activity, using the high level context of the actor to produce your analysis." - }, - "main_activities_and_motives": { - "type": "string", - "title": "Main Activities And Motives", - "description": "A concise, analytical paragraph describing the actor's main activities, technical sophistication indicators, and specific threats to sectors. Write in a narrative style without numbered lists or bullet points. Keep it shorter and more focused than a detailed breakdown." - }, - "potential_associations": { - "type": "string", - "title": "Potential Associations", - "description": "Paragraph about the potential associations of the actor if relevant. Identify what groups the actor is associated with (if any). If none are identified, state that clearly." - } - }, - "type": "object", - "required": [ - "overview", - "main_activities_and_motives", - "potential_associations" - ], - "title": "GeneralProfileSummaryOutput" - }, - "GenerateAsyncRequestPayload": { - "properties": { - "request_type": { - "$ref": "#/components/schemas/AsyncRequestType" - }, - "request_payload": { - "additionalProperties": true, - "type": "object", - "title": "Request Payload" - } - }, - "type": "object", - "required": [ - "request_type", - "request_payload" - ], - "title": "GenerateAsyncRequestPayload" - }, - "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", - "default": "github_repository" - }, - "repo_name": { - "type": "string", - "minLength": 1, - "title": "Repo Name" - }, - "repo_owner": { - "type": "string", - "minLength": 1, - "title": "Repo Owner" - } - }, - "type": "object", - "required": [ - "repo_name", - "repo_owner" - ], - "title": "GithubRepositoryData" - }, - "GithubRepositoryQuery": { - "properties": { - "type": { - "type": "string", - "const": "github_repository", - "title": "Type" - }, - "repo_owner": { - "type": "string", - "title": "Repo Owner" - }, - "repo_name": { - "type": "string", - "title": "Repo Name" - } - }, - "type": "object", - "required": [ - "type", - "repo_owner", - "repo_name" - ], - "title": "GithubRepositoryQuery" - }, - "GitlabEnvironmentScope": { - "type": "string", - "enum": [ - "*", - "development", - "staging", - "production" - ], - "title": "GitlabEnvironmentScope" - }, - "GitlabFeatureFlagScope": { - "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "environment_scope": { - "$ref": "#/components/schemas/GitlabEnvironmentScope" - } - }, - "type": "object", - "required": [ - "id", - "environment_scope" - ], - "title": "GitlabFeatureFlagScope" - }, - "GitlabFeatureFlagStrategyName": { - "type": "string", - "enum": [ - "default", - "flexibleRollout", - "gradualRolloutUserId", - "userWithId", - "gitlabUserList" - ], - "title": "GitlabFeatureFlagStrategyName" - }, - "GlobalFeedItem": { - "properties": { - "metadata": { - "$ref": "#/components/schemas/FeedItemMetadata" - }, - "tenant_metadata": { - "$ref": "#/components/schemas/FeedItemTenantMetadata" - }, - "highlights": { - "additionalProperties": { - "items": { - "type": "string" - }, - "type": "array" - }, - "type": "object", - "title": "Highlights" - } - }, - "type": "object", - "required": [ - "metadata" - ], - "title": "GlobalFeedItem" - }, - "GlobalSearchFeature": { - "type": "string", - "enum": [ - "events", - "credentials" - ], - "title": "GlobalSearchFeature" - }, - "GlobalSearchRequestBody": { - "properties": { - "query": { - "oneOf": [ - { - "$ref": "#/components/schemas/GithubRepositoryQuery" - }, - { - "$ref": "#/components/schemas/UsernameQuery" - }, - { - "$ref": "#/components/schemas/DomainQuery" - }, - { - "$ref": "#/components/schemas/BrandQuery" - }, - { - "$ref": "#/components/schemas/NameQuery" - }, - { - "$ref": "#/components/schemas/KeywordQuery" - }, - { - "$ref": "#/components/schemas/QueryStringQuery" - }, - { - "$ref": "#/components/schemas/BinQuery" - }, - { - "$ref": "#/components/schemas/IpQuery" - }, - { - "$ref": "#/components/schemas/EmailQuery" - }, - { - "$ref": "#/components/schemas/SecretQuery" - }, - { - "$ref": "#/components/schemas/CredentialsQuery" - }, - { - "$ref": "#/components/schemas/AzureTenantQuery" - } - ], - "title": "Query", - "examples": [ - { - "fqdn": "test.com", - "type": "domain" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "azure_tenant": "#/components/schemas/AzureTenantQuery", - "bin": "#/components/schemas/BinQuery", - "brand": "#/components/schemas/BrandQuery", - "credentials": "#/components/schemas/CredentialsQuery", - "domain": "#/components/schemas/DomainQuery", - "email": "#/components/schemas/EmailQuery", - "github_repository": "#/components/schemas/GithubRepositoryQuery", - "ip": "#/components/schemas/IpQuery", - "keyword": "#/components/schemas/KeywordQuery", - "name": "#/components/schemas/NameQuery", - "query_string": "#/components/schemas/QueryStringQuery", - "secret": "#/components/schemas/SecretQuery", - "username": "#/components/schemas/UsernameQuery" - } - } - }, - "filters": { - "$ref": "#/components/schemas/FeedFilters" - }, - "order": { - "$ref": "#/components/schemas/FeedOrder", - "default": "desc" - }, - "from": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From" - }, - "size": { - "type": "integer", - "maximum": 10.0, - "exclusiveMinimum": 0.0, - "title": "Size", - "default": 10 - } - }, - "type": "object", - "required": [ - "query" - ], - "title": "GlobalSearchRequestBody" - }, - "GlobalSearchSource": { - "type": "string", - "enum": [ - "all", - "api", - "flare_platform" - ], - "title": "GlobalSearchSource" - }, - "GlobalSearchUsageByFeatureResponse": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/GlobalSearchUsageFeature" - }, - "type": "array", - "title": "Items" - } - }, - "type": "object", - "required": [ - "items" - ], - "title": "GlobalSearchUsageByFeatureResponse" - }, - "GlobalSearchUsageByMemberData": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/GlobalSearchUsageByMemberDataPoint" - }, - "type": "array", - "title": "Items" - } - }, - "type": "object", - "required": [ - "items" - ], - "title": "GlobalSearchUsageByMemberData" - }, - "GlobalSearchUsageByMemberDataPoint": { - "properties": { - "user_id": { - "type": "integer", - "title": "User Id" - }, - "member": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Member" - }, - "count": { - "type": "integer", - "title": "Count" - } - }, - "type": "object", - "required": [ - "user_id", - "member", - "count" - ], - "title": "GlobalSearchUsageByMemberDataPoint" - }, - "GlobalSearchUsageByTenantData": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/GlobalSearchUsageByTenantDataPoint" - }, - "type": "array", - "title": "Items" - } - }, - "type": "object", - "required": [ - "items" - ], - "title": "GlobalSearchUsageByTenantData" - }, - "GlobalSearchUsageByTenantDataPoint": { - "properties": { - "tenant_id": { - "type": "integer", - "title": "Tenant Id" - }, - "tenant_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Tenant Name" - }, - "count": { - "type": "integer", - "title": "Count" - }, - "is_deleted": { - "type": "boolean", - "title": "Is Deleted" - } - }, - "type": "object", - "required": [ - "tenant_id", - "tenant_name", - "count", - "is_deleted" - ], - "title": "GlobalSearchUsageByTenantDataPoint" - }, - "GlobalSearchUsageFeature": { - "properties": { - "feature": { - "$ref": "#/components/schemas/GlobalSearchFeature" - }, - "values": { - "items": { - "$ref": "#/components/schemas/GlobalSearchUsageFeatureValue" - }, - "type": "array", - "title": "Values" - } - }, - "type": "object", - "required": [ - "feature", - "values" - ], - "title": "GlobalSearchUsageFeature" - }, - "GlobalSearchUsageFeatureValue": { - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "title": "Timestamp" - }, - "count": { - "type": "integer", - "title": "Count" - } - }, - "type": "object", - "required": [ - "timestamp", - "count" - ], - "title": "GlobalSearchUsageFeatureValue" - }, - "GoogleSSOConfigurationData": { - "properties": { - "is_enabled": { - "type": "boolean", - "title": "Is Enabled" - }, - "is_mandatory": { - "type": "boolean", - "title": "Is Mandatory" - }, - "type": { - "type": "string", - "const": "Google", - "title": "Type" - } - }, - "type": "object", - "required": [ - "is_enabled", - "is_mandatory", - "type" - ], - "title": "GoogleSSOConfigurationData" - }, - "GroupByType": { - "type": "string", - "enum": [ - "ungrouped", - "relationship_nature" - ], - "title": "GroupByType" - }, - "GroupFilters": { - "properties": { - "query_string": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Query String" - }, - "identifier_types": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/IdentifierType" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Identifier Types" - }, - "enable_states": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/IdentifierEnableState" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Enable States" - }, - "properties": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/IdentifierProperty" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Properties" - }, - "reachable_dates": { - "anyOf": [ - { - "$ref": "#/components/schemas/Times" - }, - { - "type": "null" - } - ] - }, - "resolves_dates": { - "anyOf": [ - { - "$ref": "#/components/schemas/Times" - }, - { - "type": "null" - } - ] - }, - "source_group": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdentifierSourceGroup" - }, - { - "type": "null" - } - ] - }, - "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" - }, - "full_delete": { - "type": "boolean", - "title": "Full Delete", - "default": false - } - }, - "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" - }, - "count": { - "type": "integer", - "title": "Count" - }, - "type": { - "$ref": "#/components/schemas/ApplicationExposureNodeType", - "readOnly": true - }, - "id": { - "type": "string", - "title": "Id", - "readOnly": true - } - }, - "type": "object", - "required": [ - "activity_types", - "leak_types", - "top_domains", - "count", - "type", - "id" - ], - "title": "GroupedApplicationNode" - }, - "HTTPValidationError": { - "properties": { - "detail": { - "items": { - "$ref": "#/components/schemas/ValidationError" - }, - "type": "array", - "title": "Detail" - } - }, - "type": "object", - "title": "HTTPValidationError" - }, - "HeatmapAnalysisOutput": { - "properties": { - "general_analysis": { - "type": "string", - "title": "General Analysis", - "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": "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", - "required": [ - "general_analysis", - "precise_analysis" - ], - "title": "HeatmapAnalysisOutput" - }, - "Histogram": { - "properties": { - "histogram": { - "additionalProperties": { - "type": "integer" - }, - "propertyNames": { - "format": "date-time" - }, - "type": "object", - "title": "Histogram" - }, - "event_count": { - "type": "integer", - "title": "Event Count" - } - }, - "type": "object", - "required": [ - "histogram", - "event_count" - ], - "title": "Histogram" - }, - "HourData": { - "properties": { - "hour": { - "type": "integer", - "maximum": 23.0, - "minimum": 0.0, - "title": "Hour", - "description": "The hour of the day, from 0 to 23." - }, - "count": { - "type": "integer", - "title": "Count" - }, - "per_day": { - "items": { - "$ref": "#/components/schemas/DayOfWeekData" - }, - "type": "array", - "title": "Per Day" - } - }, - "type": "object", - "required": [ - "hour", - "count", - "per_day" - ], - "title": "HourData" - }, - "HubspotLifecycleStage": { - "type": "string", - "enum": [ - "1281177943" - ], - "title": "HubspotLifecycleStage" - }, - "HubspotModuleFreeTrialName": { - "type": "string", - "enum": [ - "cti" - ], - "title": "HubspotModuleFreeTrialName" - }, - "HubspotWebhookFlareSyncEvent": { - "properties": { - "hubspot_id": { - "type": "integer", - "title": "Hubspot Id" - }, - "domain": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Domain" - }, - "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Name" - }, - "organization_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Organization Id" - }, - "lifecycle_stage": { - "anyOf": [ - { - "$ref": "#/components/schemas/HubspotLifecycleStage" - }, - { - "type": "null" - } - ] - }, - "merged_object_ids": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Merged Object Ids", - "default": [] - } - }, - "type": "object", - "required": [ - "hubspot_id" - ], - "title": "HubspotWebhookFlareSyncEvent" - }, - "HubspotWebhookFlareSyncTenantEvent": { - "properties": { - "hubspot_company_id": { - "type": "integer", - "title": "Hubspot Company Id" - }, - "hubspot_tenant_id": { - "type": "integer", - "title": "Hubspot Tenant Id" - }, - "merged_object_ids": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Merged Object Ids", - "default": [] - }, - "flare_tenant_name": { - "type": "string", - "title": "Flare Tenant Name" - }, - "organization_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Organization Id" - }, - "tenant_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Tenant Id" - } - }, - "type": "object", - "required": [ - "hubspot_company_id", - "hubspot_tenant_id", - "flare_tenant_name" - ], - "title": "HubspotWebhookFlareSyncTenantEvent" - }, - "IPData": { - "properties": { - "type": { - "type": "string", - "const": "ip", - "title": "Type", - "default": "ip" - }, - "ip": { - "type": "string", - "minLength": 1, - "title": "Ip" - } - }, - "type": "object", - "required": [ - "ip" - ], - "title": "IPData" - }, - "IdPApplicationNode": { - "properties": { - "application_uuid": { - "type": "string", - "format": "uuid", - "title": "Application Uuid" - }, - "domain": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Domain" - }, - "name": { - "type": "string", - "title": "Name" - }, - "idp_type": { - "$ref": "#/components/schemas/TenantIntegrationType" - }, - "labels": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Labels" - }, - "risk_score": { - "$ref": "#/components/schemas/RiskScore" - }, - "type": { - "$ref": "#/components/schemas/ApplicationExposureNodeType", - "readOnly": true - }, - "id": { - "type": "string", - "title": "Id", - "readOnly": true - } - }, - "type": "object", - "required": [ - "application_uuid", - "domain", - "name", - "idp_type", - "labels", - "risk_score", - "type", - "id" - ], - "title": "IdPApplicationNode" - }, - "IdPFeature": { - "type": "string", - "enum": [ - "full_idp_sync", - "manually_disable_accounts", - "manually_mark_as_compromised", - "manually_revoke_sessions", - "automatically_validate_credentials", - "automatically_disable_accounts", - "automatically_mark_as_compromised", - "automatically_revoke_sessions" - ], - "title": "IdPFeature" - }, - "IdPUserAccountType": { - "type": "string", - "enum": [ - "Member", - "Guest" - ], - "title": "IdPUserAccountType" - }, - "Identifier": { - "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "name": { - "type": "string", - "title": "Name" - }, - "tenant_id": { - "type": "integer", - "title": "Tenant Id" - }, - "type": { - "$ref": "#/components/schemas/IdentifierType" - }, - "feed": { - "$ref": "#/components/schemas/IdentifierFeed" - }, - "feed_config": { - "$ref": "#/components/schemas/FeedConfiguration" - }, - "asset_uuid": { - "type": "string", - "title": "Asset Uuid" - }, - "data": { - "oneOf": [ - { - "$ref": "#/components/schemas/CCBinData" - }, - { - "$ref": "#/components/schemas/IPData" - }, - { - "$ref": "#/components/schemas/BrandData" - }, - { - "$ref": "#/components/schemas/KeywordData" - }, - { - "$ref": "#/components/schemas/AzureTenantData" - }, - { - "$ref": "#/components/schemas/DomainData" - }, - { - "$ref": "#/components/schemas/NameData" - }, - { - "$ref": "#/components/schemas/SearchQueryData" - }, - { - "$ref": "#/components/schemas/GithubRepositoryData" - }, - { - "$ref": "#/components/schemas/UsernameData" - }, - { - "$ref": "#/components/schemas/EmailData" - }, - { - "$ref": "#/components/schemas/SecretData" - }, - { - "$ref": "#/components/schemas/CredentialsData" - }, - { - "$ref": "#/components/schemas/IdentityData" - }, - { - "$ref": "#/components/schemas/RansomLeakData" - } - ], - "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", - "ransomleak": "#/components/schemas/RansomLeakData", - "search_query": "#/components/schemas/SearchQueryData", - "secret": "#/components/schemas/SecretData", - "username": "#/components/schemas/UsernameData" - } - } - }, - "collection": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdentifierCollectionGroupId" - }, - { - "$ref": "#/components/schemas/IdentifierCollectionGroupType" - } - ], - "title": "Collection" - }, - "urn": { - "type": "string", - "title": "Urn" - }, - "entity": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdentityIdentifierEntity" - }, - { - "type": "null" - } - ] - }, - "enrichments": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/DomainAssetEnrichment" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Enrichments" - }, - "metadata": { - "$ref": "#/components/schemas/IdentifierMetadata" - }, - "state": { - "$ref": "#/components/schemas/IdentifierState" - } - }, - "type": "object", - "required": [ - "id", - "name", - "tenant_id", - "type", - "feed", - "feed_config", - "asset_uuid", - "data", - "collection", - "urn", - "entity", - "enrichments", - "metadata", - "state" - ], - "title": "Identifier" - }, - "IdentifierAuthorizationRequestStatus": { - "type": "string", - "enum": [ - "pending", - "rejected" - ], - "title": "IdentifierAuthorizationRequestStatus" - }, - "IdentifierAuthorizationStatus": { - "type": "string", - "enum": [ - "pending", - "rejected", - "authorized" - ], - "title": "IdentifierAuthorizationStatus" - }, - "IdentifierCollectionGroupId": { - "properties": { - "type": { - "type": "string", - "const": "group_id", - "title": "Type" - }, - "group_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Group Id" - } - }, - "type": "object", - "required": [ - "type", - "group_id" - ], - "title": "IdentifierCollectionGroupId" - }, - "IdentifierCollectionGroupType": { - "properties": { - "type": { - "type": "string", - "const": "group_type", - "title": "Type" - }, - "group_type": { - "$ref": "#/components/schemas/IdentifierGroupType" - } - }, - "type": "object", - "required": [ - "type", - "group_type" - ], - "title": "IdentifierCollectionGroupType" - }, - "IdentifierEnableState": { - "type": "string", - "enum": [ - "ENABLED", - "DISABLED", - "DISABLED_ORPHAN", - "DISABLED_TENANT" - ], - "title": "IdentifierEnableState" - }, - "IdentifierEnrichments": { - "properties": { - "domain_reachable_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Domain Reachable At" - }, - "domain_resolves_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Domain Resolves At" - }, - "usage_count": { - "type": "integer", - "title": "Usage Count" - }, - "event_count": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Event Count" - }, - "authorization_status": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdentifierAuthorizationStatus" - }, - { - "type": "null" - } - ], - "examples": [ - "authorized", - "pending", - "rejected" - ] - } - }, - "type": "object", - "required": [ - "domain_reachable_at", - "domain_resolves_at", - "usage_count", - "event_count", - "authorization_status" - ], - "title": "IdentifierEnrichments" - }, - "IdentifierEntityType": { - "type": "string", - "enum": [ - "identity" - ], - "title": "IdentifierEntityType" - }, - "IdentifierFeed": { - "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "owner_id": { - "type": "integer", - "title": "Owner Id" - } - }, - "type": "object", - "required": [ - "id", - "owner_id" - ], - "title": "IdentifierFeed" - }, - "IdentifierFeedRateLimit": { - "properties": { - "activity_type": { - "type": "string", - "title": "Activity Type" - }, - "first_rate_limited_at": { - "type": "string", - "format": "date-time", - "title": "First Rate Limited At" - }, - "last_rate_limited_at": { - "type": "string", - "format": "date-time", - "title": "Last Rate Limited At" - } - }, - "type": "object", - "required": [ - "activity_type", - "first_rate_limited_at", - "last_rate_limited_at" - ], - "title": "IdentifierFeedRateLimit" - }, - "IdentifierFeedRateLimits": { - "properties": { - "first_rate_limited_at": { - "type": "string", - "format": "date-time", - "title": "First Rate Limited At" - }, - "last_rate_limited_at": { - "type": "string", - "format": "date-time", - "title": "Last Rate Limited At" - }, - "activity_types": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Activity Types" - }, - "items": { - "items": { - "$ref": "#/components/schemas/IdentifierFeedRateLimit" - }, - "type": "array", - "title": "Items" - } - }, - "type": "object", - "required": [ - "first_rate_limited_at", - "last_rate_limited_at", - "activity_types", - "items" - ], - "title": "IdentifierFeedRateLimits" - }, - "IdentifierFilters": { - "properties": { - "query_string": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Query String" - }, - "identifier_types": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/IdentifierType" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Identifier Types" - }, - "enable_states": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/IdentifierEnableState" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Enable States" - }, - "properties": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/IdentifierProperty" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Properties" - }, - "reachable_dates": { - "anyOf": [ - { - "$ref": "#/components/schemas/Times" - }, - { - "type": "null" - } - ] - }, - "resolves_dates": { - "anyOf": [ - { - "$ref": "#/components/schemas/Times" - }, - { - "type": "null" - } - ] - }, - "source_group": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdentifierSourceGroup" - }, - { - "type": "null" - } - ] - }, - "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": "identifier", - "title": "Type", - "default": "identifier" - } - }, - "type": "object", - "title": "IdentifierFilters" - }, - "IdentifierGroupType": { - "type": "string", - "enum": [ - "person", - "corporate_identities" - ], - "title": "IdentifierGroupType" - }, - "IdentifierMatchingPolicyBody": { - "properties": { - "matching_policy_uuid": { - "type": "string", - "format": "uuid", - "title": "Matching Policy Uuid" - }, - "clean_past_events": { - "type": "boolean", - "title": "Clean Past Events", - "description": "Determines whether or not this policy should be applied to events that have already matched this identifier.", - "default": false - } - }, - "type": "object", - "required": [ - "matching_policy_uuid" - ], - "title": "IdentifierMatchingPolicyBody" - }, - "IdentifierMetadata": { - "properties": { - "critical": { - "type": "boolean", - "title": "Critical" - }, - "is_disabled": { - "type": "boolean", - "title": "Is Disabled" - } - }, - "type": "object", - "required": [ - "critical", - "is_disabled" - ], - "title": "IdentifierMetadata" - }, - "IdentifierOrderBy": { - "type": "string", - "enum": [ - "id", - "name", - "type" - ], - "title": "IdentifierOrderBy" - }, - "IdentifierProperty": { - "type": "string", - "enum": [ - "recent", - "interest", - "resolves", - "reachable", - "unresolvable", - "unreachable" - ], - "title": "IdentifierProperty" - }, - "IdentifierRecommendationAction": { - "properties": { - "type": { - "$ref": "#/components/schemas/IdentifierRecommendationActionType" - } - }, - "type": "object", - "required": [ - "type" - ], - "title": "IdentifierRecommendationAction" - }, - "IdentifierRecommendationActionTarget": { - "properties": { - "id": { - "type": "integer", - "title": "Id" - } - }, - "type": "object", - "required": [ - "id" - ], - "title": "IdentifierRecommendationActionTarget" - }, - "IdentifierRecommendationActionType": { - "type": "string", - "enum": [ - "accept", - "reject" - ], - "title": "IdentifierRecommendationActionType" - }, - "IdentifierRecommendationActionsBody": { - "properties": { - "targets": { - "items": { - "$ref": "#/components/schemas/IdentifierRecommendationActionTarget" - }, - "type": "array", - "maxItems": 100, - "title": "Targets" - }, - "action": { - "$ref": "#/components/schemas/IdentifierRecommendationAction" - } - }, - "type": "object", - "required": [ - "action" - ], - "title": "IdentifierRecommendationActionsBody" - }, - "IdentifierRecommendationFilters": { - "properties": { - "query_string": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Query String" - }, - "asset_types": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/AssetType" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Asset Types" - }, - "recommendation_state": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdentifierRecommendationState" - }, - { - "type": "null" - } - ] - }, - "relevancy_score_types": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/RecommendationRelevancyScoreType" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Relevancy Score Types" - }, - "type": { - "type": "string", - "const": "identifier_recommendation", - "title": "Type", - "default": "identifier_recommendation" - }, - "identifier_recommendation_group_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Identifier Recommendation Group Id" - } - }, - "type": "object", - "title": "IdentifierRecommendationFilters" - }, - "IdentifierRecommendationGroupFilters": { - "properties": { - "query_string": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Query String" - }, - "asset_types": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/AssetType" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Asset Types" - }, - "recommendation_state": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdentifierRecommendationState" - }, - { - "type": "null" - } - ] - }, - "relevancy_score_types": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/RecommendationRelevancyScoreType" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Relevancy Score Types" - }, - "type": { - "type": "string", - "const": "identifier_recommendation_group", - "title": "Type", - "default": "identifier_recommendation_group" - } - }, - "type": "object", - "title": "IdentifierRecommendationGroupFilters" - }, - "IdentifierRecommendationState": { - "type": "string", - "enum": [ - "recommended", - "accepted", - "rejected" - ], - "title": "IdentifierRecommendationState" - }, - "IdentifierRelation": { - "properties": { - "identifier": { - "$ref": "#/components/schemas/Identifier" - }, - "metadata": { - "$ref": "#/components/schemas/IdentifierRelationMetadata" - } - }, - "type": "object", - "required": [ - "identifier", - "metadata" - ], - "title": "IdentifierRelation" - }, - "IdentifierRelationMetadata": { - "properties": { - "first_seen_at": { - "type": "string", - "format": "date-time", - "title": "First Seen At" - }, - "last_seen_at": { - "type": "string", - "format": "date-time", - "title": "Last Seen At" - }, - "target_asset_id": { - "type": "integer", - "title": "Target Asset Id" - }, - "source_asset_id": { - "type": "integer", - "title": "Source Asset Id" - } - }, - "type": "object", - "required": [ - "first_seen_at", - "last_seen_at", - "target_asset_id", - "source_asset_id" - ], - "title": "IdentifierRelationMetadata" - }, - "IdentifierRequestBody": { - "properties": { - "data": { - "oneOf": [ - { - "$ref": "#/components/schemas/CCBinData" - }, - { - "$ref": "#/components/schemas/IPData" - }, - { - "$ref": "#/components/schemas/BrandData" - }, - { - "$ref": "#/components/schemas/KeywordData" - }, - { - "$ref": "#/components/schemas/AzureTenantData" - }, - { - "$ref": "#/components/schemas/DomainData" - }, - { - "$ref": "#/components/schemas/SearchQueryData" - }, - { - "$ref": "#/components/schemas/GithubRepositoryData" - }, - { - "$ref": "#/components/schemas/CredentialsData" - }, - { - "$ref": "#/components/schemas/EmailData" - }, - { - "$ref": "#/components/schemas/UsernameData" - }, - { - "$ref": "#/components/schemas/SecretData" - }, - { - "$ref": "#/components/schemas/NameData" - }, - { - "$ref": "#/components/schemas/IdentityDataRequestBody" - } - ], - "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/IdentityDataRequestBody", - "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" - } - } - }, - "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Name" - }, - "feed_config": { - "$ref": "#/components/schemas/FeedConfiguration" - }, - "collection": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdentifierCollectionGroupId" - }, - { - "$ref": "#/components/schemas/IdentifierCollectionGroupType" - } - ], - "title": "Collection" - }, - "metadata": { - "$ref": "#/components/schemas/IdentifierMetadata" - }, - "matching_policies": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/IdentifierMatchingPolicyBody" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Matching Policies" - } - }, - "type": "object", - "required": [ - "data", - "name", - "feed_config", - "collection", - "metadata" - ], - "title": "IdentifierRequestBody" - }, - "IdentifierResponse": { - "properties": { - "identifier": { - "anyOf": [ - { - "$ref": "#/components/schemas/Identifier" - }, - { - "type": "null" - } - ] - }, - "is_materialized": { - "type": "boolean", - "title": "Is Materialized", - "default": false - }, - "created_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Created At" - }, - "last_updated_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Last Updated At" - } - }, - "type": "object", - "title": "IdentifierResponse" - }, - "IdentifierScope": { - "properties": { - "name": { - "type": "string", - "title": "Name" - }, - "is_disabled": { - "type": "boolean", - "title": "Is Disabled", - "default": false - } - }, - "type": "object", - "required": [ - "name" - ], - "title": "IdentifierScope" - }, - "IdentifierSource": { - "type": "string", - "enum": [ - "USER", - "SYSTEM_RELATION", - "SELF_ONBOARDING", - "ATTRIBUTE", - "AUTO_MONITOR", - "IDP_SYNC", - "VIP_PROTECTION" - ], - "title": "IdentifierSource" - }, - "IdentifierSourceGroup": { - "type": "string", - "enum": [ - "ALL", - "USER", - "COUNTED", - "SYSTEM", - "USER_AND_ATTRIBUTE", - "USER_AND_SYSTEM", - "AUTO_MONITOR" - ], - "title": "IdentifierSourceGroup" - }, - "IdentifierState": { - "properties": { - "source": { - "$ref": "#/components/schemas/IdentifierSource" - }, - "data_updated_at": { - "type": "string", - "format": "date-time", - "title": "Data Updated At" - }, - "event_count": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Event Count" - }, - "usage_count": { - "type": "integer", - "title": "Usage Count" - }, - "rate_limits": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdentifierFeedRateLimits" - }, - { - "type": "null" - } - ] - }, - "validation_status": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdentifierValidationStatus" - }, - { - "type": "null" - } - ] - }, - "authorization_request_status": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdentifierAuthorizationRequestStatus" - }, - { - "type": "null" - } - ] - } - }, - "type": "object", - "required": [ - "source", - "data_updated_at", - "event_count", - "usage_count", - "rate_limits", - "validation_status", - "authorization_request_status" - ], - "title": "IdentifierState" - }, - "IdentifierType": { - "type": "string", - "enum": [ - "domain", - "name", - "keyword", - "github_repository", - "username", - "email", - "search_query", - "bin", - "ip", - "secret", - "azure_tenant", - "identity", - "ransomleak" - ], - "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" - }, - "IdentityBrowserCounts": { - "properties": { - "passwords": { - "type": "integer", - "title": "Passwords" - }, - "stealer_logs": { - "type": "integer", - "title": "Stealer Logs" - }, - "pii": { - "type": "integer", - "title": "Pii" - }, - "illicit_networks": { - "type": "integer", - "title": "Illicit Networks" - }, - "open_web": { - "type": "integer", - "title": "Open Web" - } - }, - "type": "object", - "required": [ - "passwords", - "stealer_logs", - "pii", - "illicit_networks", - "open_web" - ], - "title": "IdentityBrowserCounts" - }, - "IdentityBrowserItemResponse": { - "properties": { - "asset_uuid": { - "type": "string", - "title": "Asset Uuid" - }, - "risk": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Risk" - }, - "email": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Email" - }, - "display_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Display Name" - }, - "title": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Title" - }, - "department": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Department" - }, - "account_type": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Account Type" - }, - "is_active": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is Active" - }, - "vip": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Vip" - }, - "is_on_premises_sync_enabled": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is On Premises Sync Enabled" - }, - "last_seen_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Last Seen At" - }, - "counts": { - "$ref": "#/components/schemas/IdentityBrowserCounts" - }, - "role_external_ids": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Role External Ids", - "default": [] - } - }, - "type": "object", - "required": [ - "asset_uuid", - "risk", - "email", - "display_name", - "title", - "department", - "account_type", - "is_active", - "vip", - "is_on_premises_sync_enabled", - "last_seen_at", - "counts" - ], - "title": "IdentityBrowserItemResponse" - }, - "IdentityData": { - "properties": { - "type": { - "type": "string", - "const": "identity", - "title": "Type", - "default": "identity" - }, - "uuid": { - "type": "string", - "minLength": 1, - "title": "Uuid" - } - }, - "type": "object", - "required": [ - "uuid" - ], - "title": "IdentityData" - }, - "IdentityDataRequestBody": { - "properties": { - "type": { - "type": "string", - "const": "identity", - "title": "Type" - }, - "attributes": { - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/EmailData" - }, - { - "$ref": "#/components/schemas/UsernameData" - }, - { - "$ref": "#/components/schemas/NameData" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "email": "#/components/schemas/EmailData", - "name": "#/components/schemas/NameData", - "username": "#/components/schemas/UsernameData" - } - } - }, - "type": "array", - "maxItems": 10, - "minItems": 1, - "title": "Attributes" - } - }, - "type": "object", - "required": [ - "type", - "attributes" - ], - "title": "IdentityDataRequestBody" - }, - "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": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Display Name" - }, - "account_type": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdPUserAccountType" - }, - { - "type": "null" - } - ] - }, - "department": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Department" - }, - "is_on_premises_sync_enabled": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is On Premises Sync Enabled" - }, - "password_changed_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Password Changed At" - }, - "account_created_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Account Created At" - }, - "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" - }, - "last_synced_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Last Synced At" - }, - "password_policies": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Password Policies" - }, - "is_active": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is Active" - }, - "last_login_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Last Login At" - }, - "tenant_integration_type": { - "$ref": "#/components/schemas/TenantIntegrationType" - } - }, - "type": "object", - "required": [ - "uuid", - "email", - "username", - "title", - "display_name", - "account_type", - "department", - "is_on_premises_sync_enabled", - "password_changed_at", - "account_created_at", - "refresh_tokens_valid_from", - "sign_in_sessions_valid_from", - "last_synced_at", - "password_policies", - "is_active", - "last_login_at", - "tenant_integration_type" - ], - "title": "IdentityIdPUserPayload" - }, - "IdentityIdentifierEntity": { - "properties": { - "type": { - "$ref": "#/components/schemas/IdentifierEntityType" - }, - "attributes": { - "items": { - "$ref": "#/components/schemas/IdentityAttribute" - }, - "type": "array", - "title": "Attributes" - } - }, - "type": "object", - "required": [ - "type", - "attributes" - ], - "title": "IdentityIdentifierEntity" - }, - "IdentityNode": { - "properties": { - "primary_email": { - "type": "string", - "title": "Primary Email" - }, - "first_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "First Name" - }, - "last_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Last Name" - }, - "type": { - "$ref": "#/components/schemas/ApplicationExposureNodeType", - "readOnly": true - }, - "id": { - "type": "string", - "title": "Id", - "readOnly": true - } - }, - "type": "object", - "required": [ - "primary_email", - "first_name", - "last_name", - "type", - "id" - ], - "title": "IdentityNode" - }, - "IdentityProfileBanner": { - "properties": { - "uuid": { - "type": "string", - "format": "uuid", - "title": "Uuid" - }, - "email": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Email" - }, - "display_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Display Name" - }, - "account_type": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdPUserAccountType" - }, - { - "type": "null" - } - ] - }, - "is_on_premises_sync_enabled": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is On Premises Sync Enabled" - }, - "is_active": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is Active" - }, - "vip": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Vip" - }, - "alert_level": { - "anyOf": [ - { - "$ref": "#/components/schemas/RiskScore" - }, - { - "type": "null" - } - ] - } - }, - "type": "object", - "required": [ - "uuid", - "email", - "display_name", - "account_type", - "is_on_premises_sync_enabled", - "is_active", - "vip", - "alert_level" - ], - "title": "IdentityProfileBanner" - }, - "ImpersonationFilter": { - "type": "string", - "enum": [ - "include", - "exclude", - "only" - ], - "title": "ImpersonationFilter" - }, - "ImportEventResult": { - "properties": { - "success": { - "type": "boolean", - "title": "Success" - } - }, - "type": "object", - "required": [ - "success" - ], - "title": "ImportEventResult" - }, - "ImportExperimentalEventModel": { - "properties": { - "metadata": { - "$ref": "#/components/schemas/ExperimentalEventMetadata" - }, - "data": { - "additionalProperties": true, - "type": "object", - "title": "Data" - }, - "content": { - "type": "string", - "title": "Content" - }, - "tenant_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Tenant Id" - } - }, - "type": "object", - "required": [ - "metadata", - "data", - "content" - ], - "title": "ImportExperimentalEventModel" - }, - "IncludeOptions": { - "type": "string", - "enum": [ - "known_password_id", - "auth_domains" - ], - "title": "IncludeOptions" - }, - "IndicatorEntityAPIResponse": { - "properties": { - "uuid": { - "type": "string", - "title": "Uuid" - }, - "type": { - "$ref": "#/components/schemas/EntityType" - }, - "name": { - "type": "string", - "title": "Name" - }, - "created_by": { - "type": "string", - "title": "Created By" - }, - "sources": { - "items": { - "$ref": "#/components/schemas/CTIEntitySourceAPIResponse" - }, - "type": "array", - "title": "Sources" - }, - "created_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Created At" - }, - "updated_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Updated At" - }, - "first_seen_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "First Seen At" - }, - "last_seen_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Last Seen At" - }, - "confidence": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Confidence" - }, - "pattern": { - "type": "string", - "title": "Pattern" - }, - "pattern_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Pattern Version" - }, - "indicator_types": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Indicator Types" - }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Description" - }, - "valid_from": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Valid From" - }, - "valid_until": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Valid Until" - }, - "kill_chain_phases": { - "items": { - "$ref": "#/components/schemas/KillChainAPIResponse" - }, - "type": "array", - "title": "Kill Chain Phases" - }, - "marking_definitions": { - "items": { - "$ref": "#/components/schemas/MarkingDefinition" - }, - "type": "array", - "title": "Marking Definitions" - } - }, - "type": "object", - "required": [ - "uuid", - "type", - "name", - "created_by", - "sources", - "created_at", - "updated_at", - "pattern", - "pattern_version", - "indicator_types", - "description", - "valid_from", - "valid_until", - "kill_chain_phases", - "marking_definitions" - ], - "title": "IndicatorEntityAPIResponse" - }, - "IndicatorType": { - "type": "string", - "enum": [ - "URL" - ], - "title": "IndicatorType" - }, - "InfrastructureEntityAPIResponse": { - "properties": { - "uuid": { - "type": "string", - "title": "Uuid" - }, - "type": { - "$ref": "#/components/schemas/EntityType" - }, - "name": { - "type": "string", - "title": "Name" - }, - "created_by": { - "type": "string", - "title": "Created By" - }, - "sources": { - "items": { - "$ref": "#/components/schemas/CTIEntitySourceAPIResponse" - }, - "type": "array", - "title": "Sources" - }, - "created_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Created At" - }, - "updated_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Updated At" - }, - "first_seen_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "First Seen At" - }, - "last_seen_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Last Seen At" - }, - "confidence": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Confidence" - }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Description" - }, - "infrastructure_types": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Infrastructure Types" - }, - "kill_chain_phases": { - "items": { - "$ref": "#/components/schemas/KillChainAPIResponse" - }, - "type": "array", - "title": "Kill Chain Phases" - }, - "marking_definitions": { - "items": { - "$ref": "#/components/schemas/MarkingDefinition" - }, - "type": "array", - "title": "Marking Definitions" - } - }, - "type": "object", - "required": [ - "uuid", - "type", - "name", - "created_by", - "sources", - "created_at", - "updated_at", - "description", - "infrastructure_types", - "kill_chain_phases", - "marking_definitions" - ], - "title": "InfrastructureEntityAPIResponse" - }, - "IntelType": { - "type": "string", - "enum": [ - "unit_summary_based", - "custom_intel" - ], - "title": "IntelType" - }, - "InviteLinkResponse": { - "properties": { - "invite_magic_link": { - "type": "string", - "title": "Invite Magic Link" - }, - "domains": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Domains" - }, - "created_at": { - "type": "string", - "format": "date-time", - "title": "Created At" - }, - "connected_users": { - "type": "integer", - "title": "Connected Users" - }, - "features": { - "items": { - "$ref": "#/components/schemas/Features" - }, - "type": "array", - "title": "Features" - } - }, - "type": "object", - "required": [ - "invite_magic_link", - "domains", - "created_at", - "connected_users", - "features" - ], - "title": "InviteLinkResponse" - }, - "IpQuery": { - "properties": { - "type": { - "type": "string", - "const": "ip", - "title": "Type" - }, - "ip": { - "type": "string", - "title": "Ip" - } - }, - "type": "object", - "required": [ - "type", - "ip" - ], - "title": "IpQuery" - }, - "KeywordData": { - "properties": { - "type": { - "type": "string", - "const": "keyword", - "title": "Type", - "default": "keyword" - }, - "keyword": { - "type": "string", - "minLength": 1, - "title": "Keyword" - } - }, - "type": "object", - "required": [ - "keyword" - ], - "title": "KeywordData" - }, - "KeywordQuery": { - "properties": { - "type": { - "type": "string", - "const": "keyword", - "title": "Type" - }, - "keyword": { - "type": "string", - "title": "Keyword" - } - }, - "type": "object", - "required": [ - "type", - "keyword" - ], - "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" - }, - "KeywordsValue": { - "properties": { - "keywords": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Keywords" - } - }, - "type": "object", - "required": [ - "keywords" - ], - "title": "KeywordsValue" - }, - "KillChainAPIResponse": { - "properties": { - "kill_chain_name": { - "type": "string", - "title": "Kill Chain Name" - }, - "phase_name": { - "type": "string", - "title": "Phase Name" - } - }, - "type": "object", - "required": [ - "kill_chain_name", - "phase_name" - ], - "title": "KillChainAPIResponse" - }, - "LLMRecommendationRequest": { - "properties": { - "asset": { - "oneOf": [ - { - "$ref": "#/components/schemas/CCBinData" - }, - { - "$ref": "#/components/schemas/IPData" - }, - { - "$ref": "#/components/schemas/BrandData" - }, - { - "$ref": "#/components/schemas/KeywordData" - }, - { - "$ref": "#/components/schemas/AzureTenantData" - }, - { - "$ref": "#/components/schemas/DomainData" - }, - { - "$ref": "#/components/schemas/SearchQueryData" - }, - { - "$ref": "#/components/schemas/GithubRepositoryData" - }, - { - "$ref": "#/components/schemas/CredentialsData" - }, - { - "$ref": "#/components/schemas/EmailData" - }, - { - "$ref": "#/components/schemas/UsernameData" - }, - { - "$ref": "#/components/schemas/SecretData" - }, - { - "$ref": "#/components/schemas/NameData" - }, - { - "$ref": "#/components/schemas/IdentityDataRequestBody" - } - ], - "title": "Asset", - "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/IdentityDataRequestBody", - "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" - } - } - }, - "tenant_id": { - "type": "integer", - "title": "Tenant Id" - }, - "reason": { - "type": "string", - "title": "Reason" - }, - "relevancy_score": { - "type": "integer", - "maximum": 100.0, - "minimum": 0.0, - "title": "Relevancy Score" - }, - "seen_at": { - "type": "string", - "format": "date-time", - "title": "Seen At" - } - }, - "type": "object", - "required": [ - "asset", - "tenant_id", - "reason", - "relevancy_score", - "seen_at" - ], - "title": "LLMRecommendationRequest" - }, - "Language": { - "type": "string", - "enum": [ - "en", - "fr" - ], - "title": "Language" - }, - "LeakNode": { - "properties": { - "leak_type": { - "type": "string", - "enum": [ - "cookie", - "leaked_credential" - ], - "title": "Leak Type" - }, - "count": { - "type": "integer", - "title": "Count" - }, - "activity_types": { - "items": { - "type": "string", - "enum": [ - "stealer_log", - "leak" - ] - }, - "type": "array", - "uniqueItems": true, - "title": "Activity Types" - }, - "type": { - "$ref": "#/components/schemas/ApplicationExposureNodeType", - "readOnly": true - }, - "id": { - "type": "string", - "title": "Id", - "readOnly": true - } - }, - "type": "object", - "required": [ - "leak_type", - "count", - "activity_types", - "type", - "id" - ], - "title": "LeakNode" - }, - "LeakedCredentialsBulkActionType": { - "type": "string", - "enum": [ - "remediate", - "unremediate", - "ignore", - "unignore" - ], - "title": "LeakedCredentialsBulkActionType" - }, - "LeaksOrderBy": { - "type": "string", - "enum": [ - "name", - "leaked_at", - "breached_at", - "count" - ], - "title": "LeaksOrderBy" - }, - "ListBannersResponse": { - "properties": { - "global_": { - "anyOf": [ - { - "$ref": "#/components/schemas/BannerResponse" - }, - { - "type": "null" - } - ] - }, - "organizations": { - "items": { - "$ref": "#/components/schemas/OrganizationBanner" - }, - "type": "array", - "title": "Organizations" - }, - "tenants": { - "items": { - "$ref": "#/components/schemas/TenantBanner" - }, - "type": "array", - "title": "Tenants" - } - }, - "type": "object", - "required": [ - "global_", - "organizations", - "tenants" - ], - "title": "ListBannersResponse" - }, - "ListFeatureFlagUserListsResponse": { - "properties": { - "user_lists": { - "items": { - "$ref": "#/components/schemas/FeatureFlagUserList" - }, - "type": "array", - "title": "User Lists" - }, - "total": { - "type": "integer", - "title": "Total" - }, - "next_page": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Next Page" - } - }, - "type": "object", - "required": [ - "user_lists", - "total" - ], - "title": "ListFeatureFlagUserListsResponse" - }, - "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" - }, - "ListFeatureFlagsStatusResponse": { - "properties": { - "feature_flags": { - "items": { - "$ref": "#/components/schemas/FeatureFlagStatus" - }, - "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": "ListFeatureFlagsStatusResponse" - }, - "ListingEvent": { - "properties": { - "event_type": { - "type": "string", - "const": "listing", - "title": "Event Type", - "default": "listing" - }, - "data": { - "$ref": "#/components/schemas/ListingEventData" - }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" - } - }, - "type": "object", - "required": [ - "data", - "metadata" - ], - "title": "Listing" - }, - "ListingEventData": { - "properties": { - "url": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Url", - "description": "The URL to the listing." - }, - "title": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Title", - "description": "The title of the listing." - }, - "content": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Content", - "description": "The content within the listing." - }, - "currency": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Currency", - "description": "The currency expected in the listing." - }, - "escrow": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Escrow", - "description": "Whether the listing requires escrow." - }, - "price": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Price", - "description": "The price of the listing." - }, - "ship_to": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Ship To", - "description": "The countries eligible for shipping.", - "default": [] - }, - "ship_from": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Ship From", - "description": "The countries eligible for shipping.", - "default": [] - }, - "stock_count": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Stock Count", - "description": "The quantity of the items or service in stock." - }, - "actor": { - "$ref": "#/components/schemas/pyro__findings__listing__datamodels__ListingEventData__Actor", - "description": "Data about the seller." - }, - "classification": { - "$ref": "#/components/schemas/Classification", - "description": "Data about the possible classifications of the listing." - }, - "context": { - "$ref": "#/components/schemas/pyro__findings__listing__datamodels__ListingEventData__Context", - "description": "Data offering context to the listing." - } - }, - "type": "object", - "title": "ListingEventData" - }, - "LocationEntityAPIResponse": { - "properties": { - "uuid": { - "type": "string", - "title": "Uuid" - }, - "type": { - "$ref": "#/components/schemas/EntityType" - }, - "name": { - "type": "string", - "title": "Name" - }, - "created_by": { - "type": "string", - "title": "Created By" - }, - "sources": { - "items": { - "$ref": "#/components/schemas/CTIEntitySourceAPIResponse" - }, - "type": "array", - "title": "Sources" - }, - "created_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Created At" - }, - "updated_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Updated At" - }, - "first_seen_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "First Seen At" - }, - "last_seen_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Last Seen At" - }, - "confidence": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Confidence" - }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Description" - }, - "country_code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Country Code" - }, - "marking_definitions": { - "items": { - "$ref": "#/components/schemas/MarkingDefinition" - }, - "type": "array", - "title": "Marking Definitions" - } - }, - "type": "object", - "required": [ - "uuid", - "type", - "name", - "created_by", - "sources", - "created_at", - "updated_at", - "description", - "country_code", - "marking_definitions" - ], - "title": "LocationEntityAPIResponse" - }, - "LogoRequestBody": { - "properties": { - "domains": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Domains" - }, - "size": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Size" - } - }, - "type": "object", - "required": [ - "domains" - ], - "title": "LogoRequestBody" - }, - "LogoResponse": { - "properties": { - "results": { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "type": "object", - "title": "Results" - } - }, - "type": "object", - "required": [ - "results" - ], - "title": "LogoResponse" - }, - "LookalikeDomainEvent": { - "properties": { - "event_type": { - "type": "string", - "const": "lookalike", - "title": "Event Type", - "default": "lookalike" - }, - "data": { - "$ref": "#/components/schemas/LookalikeDomainEventData" - }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" - } - }, - "type": "object", - "required": [ - "data", - "metadata" - ], - "title": "Lookalike Domain" - }, - "LookalikeDomainEventData": { - "properties": { - "domain": { - "type": "string", - "title": "Domain", - "description": "The domain of the lookalike domain." - }, - "registered_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Registered At", - "description": "The date and time the lookalike domain was registered." - }, - "identifier_domains": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Identifier Domains", - "description": "Domain identifiers matching the lookalike domains" - }, - "feed": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Feed", - "description": "The feed where the lookalike domain was found" - }, - "cert_data": { - "anyOf": [ - { - "additionalProperties": true, - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Cert Data", - "description": "The certificate data of the lookalike domain." - }, - "subject": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Subject", - "description": "The subject of the certificate of the lookalike domain." - }, - "issuer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Issuer", - "description": "The issuer of the certificate of the lookalike domain." - } - }, - "type": "object", - "required": [ - "domain", - "registered_at", - "identifier_domains", - "feed", - "cert_data", - "subject", - "issuer" - ], - "title": "LookalikeDomainEventData" - }, - "LuceneValue": { - "properties": { - "query": { - "type": "string", - "title": "Query", - "description": "The lucene query of the matching policy" - } - }, - "type": "object", - "required": [ - "query" - ], - "title": "LuceneValue" - }, - "MalwareEntityAPIResponse": { - "properties": { - "uuid": { - "type": "string", - "title": "Uuid" - }, - "type": { - "$ref": "#/components/schemas/EntityType" - }, - "name": { - "type": "string", - "title": "Name" - }, - "created_by": { - "type": "string", - "title": "Created By" - }, - "sources": { - "items": { - "$ref": "#/components/schemas/CTIEntitySourceAPIResponse" - }, - "type": "array", - "title": "Sources" - }, - "created_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Created At" - }, - "updated_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Updated At" - }, - "first_seen_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "First Seen At" - }, - "last_seen_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Last Seen At" - }, - "confidence": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Confidence" - }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Description" - }, - "malware_types": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Malware Types" - }, - "kill_chain_phases": { - "items": { - "$ref": "#/components/schemas/KillChainAPIResponse" - }, - "type": "array", - "title": "Kill Chain Phases" - }, - "marking_definitions": { - "items": { - "$ref": "#/components/schemas/MarkingDefinition" - }, - "type": "array", - "title": "Marking Definitions" - } - }, - "type": "object", - "required": [ - "uuid", - "type", - "name", - "created_by", - "sources", - "created_at", - "updated_at", - "description", - "malware_types", - "kill_chain_phases", - "marking_definitions" - ], - "title": "MalwareEntityAPIResponse" - }, - "MalwareInformation": { - "properties": { - "malware_family": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Malware Family", - "description": "The malware family used for device infection." - }, - "build_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Build Id", - "description": "The build ID of the malware used for device infection." - }, - "file_location": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "File Location", - "description": "The file location of the malware used for device infection." - }, - "infected_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Infected At", - "description": "The date and time the malware was used to infect the victim's device." - } - }, - "type": "object", - "required": [ - "malware_family", - "build_id", - "file_location", - "infected_at" - ], - "title": "MalwareInformation" - }, - "MarkUserAsCompromisedPayload": { - "properties": { - "credential_hash": { - "type": "string", - "title": "Credential Hash" - } - }, - "type": "object", - "required": [ - "credential_hash" - ], - "title": "MarkUserAsCompromisedPayload" - }, - "MarkingDefinition": { - "properties": { - "id": { - "type": "string", - "title": "Id" - }, - "definition_type": { - "$ref": "#/components/schemas/MarkingDefinitionType" - }, - "name": { - "type": "string", - "title": "Name" - } - }, - "type": "object", - "required": [ - "id", - "definition_type", - "name" - ], - "title": "MarkingDefinition" - }, - "MarkingDefinitionType": { - "type": "string", - "enum": [ - "tlp" - ], - "title": "MarkingDefinitionType" - }, - "MatchingPolicyAssignmentPayload": { - "properties": { - "matching_policy": { - "$ref": "#/components/schemas/MatchingPolicyPayload" - }, - "assigned_at": { - "type": "string", - "format": "date-time", - "title": "Assigned At", - "description": "The date and time this policy was assigned to the identifier" - }, - "clean_past_events": { - "type": "boolean", - "title": "Clean Past Events", - "description": "Whether this policy has been applied to historical events" - } - }, - "type": "object", - "required": [ - "matching_policy", - "assigned_at", - "clean_past_events" - ], - "title": "MatchingPolicyAssignmentPayload" - }, - "MatchingPolicyPayload": { - "properties": { - "uuid": { - "type": "string", - "format": "uuid4", - "title": "Uuid", - "description": "The UUID of the matching policy" - }, - "name": { - "type": "string", - "title": "Name", - "description": "The name of the matching policy" - }, - "policy_type": { - "$ref": "#/components/schemas/MatchingPolicyType", - "description": "The type of the matching policy" - }, - "value": { - "$ref": "#/components/schemas/PolicyValue", - "description": "The value of the matching policy depending on its type" - }, - "created_at": { - "type": "string", - "format": "date-time", - "title": "Created At", - "description": "The date and time the matching policy was created" - }, - "last_updated_at": { - "type": "string", - "format": "date-time", - "title": "Last Updated At", - "description": "The date and time the matching policy was last updated" - } - }, - "type": "object", - "required": [ - "uuid", - "name", - "policy_type", - "value", - "created_at", - "last_updated_at" - ], - "title": "MatchingPolicyPayload" - }, - "MatchingPolicyType": { - "type": "string", - "enum": [ - "INCLUDED_KEYWORDS", - "EXCLUDED_KEYWORDS", - "LUCENE_QUERY", - "ASTP_COOKIES", - "ASTP_DOMAIN" - ], - "title": "MatchingPolicyType" - }, - "MemberMutationPayload": { - "properties": { - "member": { - "$ref": "#/components/schemas/StrategyMember" - } - }, - "type": "object", - "required": [ - "member" - ], - "title": "MemberMutationPayload" - }, - "MergeIdentitiesBody": { - "properties": { - "from_identifier_id": { - "type": "integer", - "title": "From Identifier Id" - }, - "to_identifier_id": { - "type": "integer", - "title": "To Identifier Id" - } - }, - "type": "object", - "required": [ - "from_identifier_id", - "to_identifier_id" - ], - "title": "MergeIdentitiesBody" - }, - "MxRecord": { - "properties": { - "priority": { - "type": "integer", - "title": "Priority" - }, - "exchange": { - "type": "string", - "title": "Exchange" - } - }, - "type": "object", - "required": [ - "priority", - "exchange" - ], - "title": "MxRecord" - }, - "NameData": { - "properties": { - "type": { - "type": "string", - "const": "name", - "title": "Type", - "default": "name" - }, - "first_name": { - "type": "string", - "title": "First Name" - }, - "last_name": { - "type": "string", - "title": "Last Name" - }, - "is_strict": { - "type": "boolean", - "title": "Is Strict" - } - }, - "type": "object", - "required": [ - "first_name", - "last_name", - "is_strict" - ], - "title": "NameData" - }, - "NameQuery": { - "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" - } - }, - "type": "object", - "required": [ - "type", - "first_name", - "last_name", - "is_strict" - ], - "title": "NameQuery" - }, - "NotConfiguredSSOConfigurationData": { - "properties": { - "is_enabled": { - "type": "boolean", - "title": "Is Enabled" - }, - "is_mandatory": { - "type": "boolean", - "title": "Is Mandatory" - }, - "type": { - "type": "string", - "const": "not_configured", - "title": "Type" - } - }, - "type": "object", - "required": [ - "is_enabled", - "is_mandatory", - "type" - ], - "title": "NotConfiguredSSOConfigurationData" - }, - "OktaFailedValidationDetails": { - "properties": { - "invalid_parameter_field": { - "anyOf": [ - { - "$ref": "#/components/schemas/OktaInvalidParameterField" - }, - { - "type": "null" - } - ] - } - }, - "type": "object", - "title": "OktaFailedValidationDetails" - }, - "OktaInputParams": { - "properties": { - "params_type": { - "type": "string", - "const": "okta", - "title": "Params Type", - "default": "okta" - }, - "okta_domain": { - "type": "string", - "title": "Okta Domain" - }, - "okta_service_app_client_id": { - "anyOf": [ - { - "type": "string", - "minLength": 1 - }, - { - "type": "null" - } - ], - "title": "Okta Service App Client Id" - }, - "features": { - "items": { - "$ref": "#/components/schemas/IdPFeature" - }, - "type": "array", - "uniqueItems": true, - "title": "Features" - }, - "lockout_policy": { - "anyOf": [ - { - "$ref": "#/components/schemas/CredentialValidationThresholdPolicy" - }, - { - "type": "null" - } - ] - } - }, - "type": "object", - "required": [ - "okta_domain" - ], - "title": "OktaInputParams" - }, - "OktaInvalidParameterField": { - "type": "string", - "enum": [ - "okta_domain", - "okta_service_app_client_id" - ], - "title": "OktaInvalidParameterField" - }, - "OktaParams": { - "properties": { - "params_type": { - "type": "string", - "const": "okta", - "title": "Params Type", - "default": "okta" - }, - "okta_domain": { - "type": "string", - "title": "Okta Domain" - }, - "okta_service_app_client_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Okta Service App Client Id" - }, - "features": { - "items": { - "$ref": "#/components/schemas/IdPFeature" - }, - "type": "array", - "uniqueItems": true, - "title": "Features" - }, - "lockout_policy": { - "anyOf": [ - { - "$ref": "#/components/schemas/CredentialValidationThresholdPolicy" - }, - { - "type": "null" - } - ] - } - }, - "type": "object", - "required": [ - "okta_domain" - ], - "title": "OktaParams" - }, - "OrderType": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "title": "OrderType" - }, - "OrganizationBanner": { - "properties": { - "organization_id": { - "type": "integer", - "title": "Organization Id" - }, - "organization_name": { - "type": "string", - "title": "Organization Name" - }, - "message": { - "type": "string", - "title": "Message" - }, - "variant": { - "$ref": "#/components/schemas/BannerVariant" - } - }, - "type": "object", - "required": [ - "organization_id", - "organization_name", - "message", - "variant" - ], - "title": "OrganizationBanner" - }, - "OrganizationEventStatsResponse": { - "properties": { - "organization_id": { - "type": "integer", - "title": "Organization Id" - }, - "total_count": { - "type": "integer", - "title": "Total Count" - }, - "identifier_ratio": { - "type": "number", - "title": "Identifier Ratio" - } - }, - "type": "object", - "required": [ - "organization_id", - "total_count", - "identifier_ratio" - ], - "title": "OrganizationEventStatsResponse" - }, - "OrganizationLogoResponse": { - "properties": { - "url": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Url" - } - }, - "type": "object", - "required": [ - "url" - ], - "title": "OrganizationLogoResponse" - }, - "OriginalPostSummaryOutput": { - "properties": { - "overview": { - "type": "string", - "title": "Overview", - "description": "Single paragraph providing an analytical summary of the post." - }, - "actor_intent": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Actor Intent", - "description": "Single paragraph summarizing the actor's intent. If the actor's intent is not clear, return None." - } - }, - "type": "object", - "required": [ - "overview" - ], - "title": "OriginalPostSummaryOutput" - }, - "OtherSectionType": { - "type": "string", - "enum": [ - "appendix", - "executive_summary" - ], - "title": "OtherSectionType" - }, - "OverTimeInterval": { - "type": "string", - "enum": [ - "daily", - "weekly", - "monthly", - "yearly" - ], - "title": "OverTimeInterval" - }, - "PagedCookieConfigurations": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/CookieMonitoringConfigurationItem" - }, - "type": "array", - "title": "Items" - }, - "next": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PagedCookieConfigurations" - }, - "PaginatedResult_int_str_": { - "properties": { - "item": { - "type": "integer", - "title": "Item" - }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "item", - "next" - ], - "title": "PaginatedResult[int, str]" - }, - "PaginatedResultsWithTotalCount_AuditEventItemResponse_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/AuditEventItemResponse" - }, - "type": "array", - "title": "Items" - }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - }, - "total_count": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Total Count" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResultsWithTotalCount[AuditEventItemResponse, str]" - }, - "PaginatedResultsWithTotalCount_DomainBrowserItemResponse_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/DomainBrowserItemResponse" - }, - "type": "array", - "title": "Items" - }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - }, - "total_count": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Total Count" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResultsWithTotalCount[DomainBrowserItemResponse, str]" - }, - "PaginatedResultsWithTotalCount_IdentityBrowserItemResponse_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/IdentityBrowserItemResponse" - }, - "type": "array", - "title": "Items" - }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - }, - "total_count": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Total Count" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResultsWithTotalCount[IdentityBrowserItemResponse, str]" - }, - "PaginatedResultsWithTotalCount_VipProtectionListItem_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/VipProtectionListItem" - }, - "type": "array", - "title": "Items" - }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - }, - "total_count": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Total Count" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResultsWithTotalCount[VipProtectionListItem, str]" - }, - "PaginatedResults_ASTPCookiePayload_str_": { - "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, str]" - }, - "PaginatedResults_Alert_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/Alert" - }, - "type": "array", - "title": "Items" - }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[Alert, str]" - }, - "PaginatedResults_CTIEntityRelationshipResponse_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/CTIEntityRelationshipResponse" - }, - "type": "array", - "title": "Items" - }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[CTIEntityRelationshipResponse, str]" - }, - "PaginatedResults_CredentialValidationReponse_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/CredentialValidationReponse" - }, - "type": "array", - "title": "Items" - }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[CredentialValidationReponse, str]" - }, - "PaginatedResults_Credential_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/Credential" - }, - "type": "array", - "title": "Items" - }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[Credential, str]" - }, - "PaginatedResults_EnrichedBulkAction_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/EnrichedBulkAction" - }, - "type": "array", - "title": "Items" - }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[EnrichedBulkAction, str]" - }, - "PaginatedResults_EntityAPIResponseTypes_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/EntityAPIResponseTypes" - }, - "type": "array", - "title": "Items" - }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[EntityAPIResponseTypes, str]" - }, - "PaginatedResults_FeedItem_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/FeedItem" - }, - "type": "array", - "title": "Items" - }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[FeedItem, str]" - }, - "PaginatedResults_GlobalFeedItem_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/GlobalFeedItem" - }, - "type": "array", - "title": "Items" - }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[GlobalFeedItem, str]" - }, - "PaginatedResults_IdentifierRelation_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/IdentifierRelation" - }, - "type": "array", - "title": "Items" - }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" + } + }, + "components": { + "schemas": { + "ActivityModelName": { + "type": "string", + "enum": [ + "account", + "actor", + "actor_summary", + "ad", + "attachment", + "blog_post", + "bot", + "bucket", + "bucket_object", + "cc", + "cc_bases", + "chat_channel_summary", + "chat_message", + "cookie", + "docker_image", + "docker_repository", + "document", + "domain", + "domain_certificate", + "domain_favicon", + "domain_dns_records", + "domain_ip_address", + "domain_screenshot", + "domain_title", + "domain_whois_rdap", + "driller", + "driller_forum_post", + "driller_forum_topic", + "driller_google", + "driller_profile", + "driller_source_code", + "entity_classification", + "event", + "experimental", + "forum_category", + "forum_post", + "forum_profile", + "forum_thread_summary", + "forum_topic", + "host", + "intelligence_object", + "invalid_credential", + "leak", + "leaked_credential", + "leaked_data", + "leaked_file", + "listing", + "lookalike", + "mitigated_credential", + "paste", + "ransomleak", + "ransomleak_file_listing", + "score_event", + "sdo_attack_pattern", + "sdo_campaign", + "sdo_identity", + "sdo_indicator", + "sdo_infrastructure", + "sdo_location", + "sdo_malware", + "sdo_relationship", + "sdo_external_report", + "sdo_threat_actor", + "sdo_threat_actor_group", + "sdo_tool", + "sdo_vulnerability", + "seller", + "service", + "social_media_account", + "source_code_secret", + "stealer_log", + "attachment/telegram", + "threat_flow_summary", + "valid_credential", + "whois" ], - "title": "PaginatedResults[IdentifierRelation, str]" + "title": "ActivityModelName" }, - "PaginatedResults_Identifier_str_": { + "AddressData": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/Identifier" - }, - "type": "array", - "title": "Items" + "type": { + "type": "string", + "const": "address_data", + "title": "Type", + "default": "address_data" }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[Identifier, str]" - }, - "PaginatedResults_InviteLinkResponse_datetime_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/InviteLinkResponse" - }, - "type": "array", - "title": "Items" + "street": { + "type": "string", + "minLength": 1, + "title": "Street" }, - "next": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[InviteLinkResponse, datetime]" - }, - "PaginatedResults_MatchingPolicyPayload_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/MatchingPolicyPayload" - }, - "type": "array", - "title": "Items" + "city": { + "type": "string", + "minLength": 1, + "title": "City" }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[MatchingPolicyPayload, str]" - }, - "PaginatedResults_PartialAlertChannel_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/PartialAlertChannel" - }, - "type": "array", - "title": "Items" + "country": { + "type": "string", + "maxLength": 2, + "minLength": 2, + "title": "Country" }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" + "state": { + "type": "string", + "minLength": 1, + "title": "State" } }, "type": "object", "required": [ - "items", - "next" + "street", + "city", + "country", + "state" ], - "title": "PaginatedResults[PartialAlertChannel, str]" + "title": "AddressData" }, - "PaginatedResults_PolicyAssignedIdentifierPayload_str_": { + "Alert": { "properties": { - "items": { + "feed_definition": { + "$ref": "#/components/schemas/FeedDefinition" + }, + "type": { + "type": "string", + "title": "Type" + }, + "created_at": { + "type": "string", + "title": "Created At" + }, + "updated_at": { + "type": "string", + "title": "Updated At" + }, + "id": { + "type": "integer", + "title": "Id" + }, + "name": { + "type": "string", + "title": "Name" + }, + "tenant_id": { + "type": "integer", + "title": "Tenant Id" + }, + "organization_id": { + "type": "integer", + "title": "Organization Id" + }, + "search_types": { "items": { - "$ref": "#/components/schemas/PolicyAssignedIdentifierPayload" + "$ref": "#/components/schemas/SearchType" }, "type": "array", - "title": "Items" + "title": "Search Types" }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[PolicyAssignedIdentifierPayload, str]" - }, - "PaginatedResults_PublicIdentifierResponse_str_": { - "properties": { - "items": { + "experimental_search_types": { "items": { - "$ref": "#/components/schemas/PublicIdentifierResponse" + "type": "string" }, "type": "array", - "title": "Items" + "title": "Experimental Search Types" }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[PublicIdentifierResponse, str]" - }, - "PaginatedResults_PydanticThreatFlowReport_str_": { - "properties": { - "items": { + "risks": { "items": { - "$ref": "#/components/schemas/PydanticThreatFlowReport" + "$ref": "#/components/schemas/RiskScore" }, "type": "array", - "title": "Items" + "title": "Risks" }, - "next": { + "alert_channel_id": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[PydanticThreatFlowReport, str]" - }, - "PaginatedResults_Recommendation_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/Recommendation" - }, - "type": "array", - "title": "Items" + "title": "Alert Channel Id" }, - "next": { + "alert_channel": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/AlertChannelSummary" }, { "type": "null" } - ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[Recommendation, str]" - }, - "PaginatedResults_ReportData_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/ReportData" - }, - "type": "array", - "title": "Items" + ] }, - "next": { + "frequency": { + "type": "number", + "title": "Frequency" + }, + "start_at": { + "type": "string", + "title": "Start At" + }, + "identifier_scope": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/IdentifierScope" }, { "type": "null" } - ], - "title": "Next" + ] } }, "type": "object", "required": [ - "items", - "next" + "feed_definition", + "type", + "created_at", + "updated_at", + "id", + "name", + "tenant_id", + "organization_id", + "search_types", + "experimental_search_types", + "risks", + "alert_channel_id", + "alert_channel", + "frequency", + "start_at" ], - "title": "PaginatedResults[ReportData, str]" + "title": "Alert" }, - "PaginatedResults_ReportGroupData_str_": { + "AlertChannel": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/ReportGroupData" - }, - "type": "array", - "title": "Items" + "id": { + "type": "integer", + "title": "Id" }, - "next": { - "anyOf": [ + "name": { + "type": "string", + "title": "Name" + }, + "type": { + "$ref": "#/components/schemas/AlertType" + }, + "state": { + "$ref": "#/components/schemas/AlertChannelState" + }, + "params": { + "oneOf": [ { - "type": "string" + "$ref": "#/components/schemas/AlertChannelEmailParams" }, { - "type": "null" - } - ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[ReportGroupData, str]" - }, - "PaginatedResults_ReportSectionPayload_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/ReportSectionPayload" - }, - "type": "array", - "title": "Items" - }, - "next": { - "anyOf": [ + "$ref": "#/components/schemas/AlertChannelSlackParams" + }, { - "type": "string" + "$ref": "#/components/schemas/AlertChannelDiscordParams" }, { - "type": "null" + "$ref": "#/components/schemas/AlertChannelSplunkParams" + }, + { + "$ref": "#/components/schemas/AlertChannelChannelParams" + }, + { + "$ref": "#/components/schemas/AlertChannelLegacySentinelParams" + }, + { + "$ref": "#/components/schemas/AlertChannelSentinelV2Params" + }, + { + "$ref": "#/components/schemas/AlertChannelTeamsParams" + }, + { + "$ref": "#/components/schemas/AlertChannelJiraParams" + }, + { + "$ref": "#/components/schemas/AlertChannelServiceNowParams" + }, + { + "$ref": "#/components/schemas/AlertChannelWebhookParams" + } + ], + "title": "Params", + "discriminator": { + "propertyName": "type", + "mapping": { + "azure_sentinel": "#/components/schemas/AlertChannelLegacySentinelParams", + "azure_sentinel_v2": "#/components/schemas/AlertChannelSentinelV2Params", + "channel": "#/components/schemas/AlertChannelChannelParams", + "discord": "#/components/schemas/AlertChannelDiscordParams", + "email": "#/components/schemas/AlertChannelEmailParams", + "jira": "#/components/schemas/AlertChannelJiraParams", + "servicenow": "#/components/schemas/AlertChannelServiceNowParams", + "slack": "#/components/schemas/AlertChannelSlackParams", + "splunk": "#/components/schemas/AlertChannelSplunkParams", + "teams": "#/components/schemas/AlertChannelTeamsParams", + "webhook": "#/components/schemas/AlertChannelWebhookParams" } - ], - "title": "Next" + } } }, "type": "object", "required": [ - "items", - "next" + "id", + "name", + "type", + "state", + "params" ], - "title": "PaginatedResults[ReportSectionPayload, str]" + "title": "AlertChannel" }, - "PaginatedResults_Report_str_": { + "AlertChannelChannelParams": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/Report" - }, - "type": "array", - "title": "Items" + "type": { + "type": "string", + "const": "channel", + "title": "Type" }, - "next": { + "alert_channel_id": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Next" + "title": "Alert Channel Id" } }, "type": "object", "required": [ - "items", - "next" + "type", + "alert_channel_id" ], - "title": "PaginatedResults[Report, str]" + "title": "AlertChannelChannelParams" }, - "PaginatedResults_SandboxSampleSubmission_str_": { + "AlertChannelDiscordParams": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/SandboxSampleSubmission" - }, - "type": "array", - "title": "Items" + "type": { + "type": "string", + "const": "discord", + "title": "Type" }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" + "webhook_url": { + "type": "string", + "title": "Webhook Url" } }, "type": "object", "required": [ - "items", - "next" + "type", + "webhook_url" ], - "title": "PaginatedResults[SandboxSampleSubmission, str]" + "title": "AlertChannelDiscordParams" }, - "PaginatedResults_SecretItem_str_": { + "AlertChannelEmailParams": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/SecretItem" - }, - "type": "array", - "title": "Items" + "type": { + "type": "string", + "const": "email", + "title": "Type" }, - "next": { + "email": { + "type": "string", + "title": "Email" + }, + "json_attachment": { + "type": "boolean", + "title": "Json Attachment", + "default": false + }, + "csv_attachment": { + "type": "boolean", + "title": "Csv Attachment", + "default": false + }, + "subject_tag": { "anyOf": [ { "type": "string" @@ -31758,201 +2963,230 @@ "type": "null" } ], - "title": "Next" + "title": "Subject Tag" + }, + "language": { + "$ref": "#/components/schemas/Language", + "default": "en" } }, "type": "object", "required": [ - "items", - "next" + "type", + "email" ], - "title": "PaginatedResults[SecretItem, str]" + "title": "AlertChannelEmailParams" }, - "PaginatedResults_SourceWithTenantCount_str_": { + "AlertChannelJiraParams": { "properties": { - "items": { + "type": { + "type": "string", + "const": "jira", + "title": "Type" + }, + "server_netloc": { + "type": "string", + "title": "Server Netloc" + }, + "email": { + "type": "string", + "title": "Email" + }, + "api_token": { + "type": "string", + "title": "Api Token" + }, + "project_key": { + "type": "string", + "title": "Project Key" + }, + "labels": { "items": { - "$ref": "#/components/schemas/SourceWithTenantCount" + "type": "string" }, "type": "array", - "title": "Items" + "title": "Labels", + "default": [] }, - "next": { + "issue_type": { + "type": "string", + "title": "Issue Type" + }, + "custom_fields": { "anyOf": [ { - "type": "string" + "additionalProperties": { + "type": "string" + }, + "type": "object" }, { "type": "null" } ], - "title": "Next" + "title": "Custom Fields" } }, "type": "object", "required": [ - "items", - "next" + "type", + "server_netloc", + "email", + "api_token", + "project_key", + "issue_type" ], - "title": "PaginatedResults[SourceWithTenantCount, str]" + "title": "AlertChannelJiraParams" }, - "PaginatedResults_StealerLogCookie_str_": { + "AlertChannelLegacySentinelParams": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/StealerLogCookie" - }, - "type": "array", - "title": "Items" + "type": { + "type": "string", + "const": "azure_sentinel", + "title": "Type" }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" + "workspace_id": { + "type": "string", + "title": "Workspace Id" + }, + "shared_key": { + "type": "string", + "title": "Shared Key" } }, "type": "object", "required": [ - "items", - "next" + "type", + "workspace_id", + "shared_key" ], - "title": "PaginatedResults[StealerLogCookie, str]" + "title": "AlertChannelLegacySentinelParams" }, - "PaginatedResults_StealerLogCredential_str_": { + "AlertChannelSentinelV2Params": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/StealerLogCredential" - }, - "type": "array", - "title": "Items" + "type": { + "type": "string", + "const": "azure_sentinel_v2", + "title": "Type" }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" + "entra_client_id": { + "type": "string", + "title": "Entra Client Id" + }, + "entra_tenant_id": { + "type": "string", + "title": "Entra Tenant Id" + }, + "entra_secret": { + "type": "string", + "title": "Entra Secret" + }, + "url": { + "type": "string", + "title": "Url" } }, "type": "object", "required": [ - "items", - "next" + "type", + "entra_client_id", + "entra_tenant_id", + "entra_secret", + "url" ], - "title": "PaginatedResults[StealerLogCredential, str]" + "title": "AlertChannelSentinelV2Params" }, - "PaginatedResults_TenantFlareCommunityUser_int_": { + "AlertChannelServiceNowParams": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/TenantFlareCommunityUser" - }, - "type": "array", - "title": "Items" + "type": { + "type": "string", + "const": "servicenow", + "title": "Type" + }, + "server_url": { + "type": "string", + "title": "Server Url" + }, + "api_key": { + "type": "string", + "title": "Api Key" }, - "next": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Next" + "table_name": { + "type": "string", + "title": "Table Name" } }, "type": "object", "required": [ - "items", - "next" + "type", + "server_url", + "api_key", + "table_name" ], - "title": "PaginatedResults[TenantFlareCommunityUser, int]" + "title": "AlertChannelServiceNowParams" }, - "PaginatedResults_TenantIntegrationItem_str_": { + "AlertChannelSlackParams": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/TenantIntegrationItem" - }, - "type": "array", - "title": "Items" + "type": { + "type": "string", + "const": "slack", + "title": "Type" }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" + "webhook_url": { + "type": "string", + "title": "Webhook Url" } }, "type": "object", "required": [ - "items", - "next" + "type", + "webhook_url" ], - "title": "PaginatedResults[TenantIntegrationItem, str]" + "title": "AlertChannelSlackParams" }, - "PaginatedResults_ThreatFlowReportResponse_str_": { + "AlertChannelSplunkParams": { "properties": { - "items": { + "type": { + "type": "string", + "const": "splunk", + "title": "Type" + }, + "api_token": { + "type": "string", + "title": "Api Token" + }, + "netloc": { + "type": "string", + "title": "Netloc" + }, + "index": { + "type": "string", + "title": "Index" + }, + "labels": { "items": { - "$ref": "#/components/schemas/ThreatFlowReportResponse" + "type": "string" }, "type": "array", - "title": "Items" - }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" + "title": "Labels", + "default": [] } }, "type": "object", "required": [ - "items", - "next" + "type", + "api_token", + "netloc", + "index" ], - "title": "PaginatedResults[ThreatFlowReportResponse, str]" + "title": "AlertChannelSplunkParams" }, - "PaginatedResults_Union_EnrichedCredential__EnrichedCookie__str_": { + "AlertChannelState": { "properties": { - "items": { - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/EnrichedCredential" - }, - { - "$ref": "#/components/schemas/EnrichedCookie" - } - ] - }, - "type": "array", - "title": "Items" + "status": { + "$ref": "#/components/schemas/AlertChannelStatus" }, - "next": { + "message": { "anyOf": [ { "type": "string" @@ -31961,173 +3195,186 @@ "type": "null" } ], - "title": "Next" + "title": "Message" } }, "type": "object", "required": [ - "items", - "next" + "status" ], - "title": "PaginatedResults[Union[EnrichedCredential, EnrichedCookie], str]" + "title": "AlertChannelState" + }, + "AlertChannelStatus": { + "type": "string", + "enum": [ + "untested", + "error", + "success" + ], + "title": "AlertChannelStatus" }, - "PaginatedSources": { + "AlertChannelSummary": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/Source" - }, - "type": "array", - "title": "Items" - }, - "next": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Next" - }, - "total_count": { + "id": { "type": "integer", - "title": "Total Count" + "title": "Id" + }, + "name": { + "type": "string", + "title": "Name" } }, "type": "object", "required": [ - "items", - "next", - "total_count" + "id", + "name" ], - "title": "PaginatedSources" + "title": "AlertChannelSummary" }, - "ParentContext": { + "AlertChannelTeamsParams": { "properties": { - "parent_uid": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Parent Uid" + "type": { + "type": "string", + "const": "teams", + "title": "Type" }, - "parent_type": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Parent Type" + "teams_webhook_url": { + "type": "string", + "title": "Teams Webhook Url" } }, "type": "object", - "title": "ParentContext" - }, - "ParentIdentifierSortType": { - "type": "string", - "enum": [ - "reversed_fqdn" + "required": [ + "type", + "teams_webhook_url" ], - "title": "ParentIdentifierSortType" + "title": "AlertChannelTeamsParams" }, - "PartialAlert": { + "AlertChannelWebhookParams": { "properties": { - "feed_definition": { - "anyOf": [ - { - "$ref": "#/components/schemas/FeedDefinition" - }, - { - "type": "null" - } - ] + "type": { + "type": "string", + "const": "webhook", + "title": "Type" }, - "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Name" + "webhook_url": { + "type": "string", + "title": "Webhook Url" }, - "search_types": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/SearchType" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Search Types" + "secret": { + "type": "string", + "title": "Secret" }, - "experimental_search_types": { + "basic_auth": { "anyOf": [ { - "items": { - "type": "string" - }, - "type": "array" + "$ref": "#/components/schemas/WebhookBasicAuth" }, { "type": "null" } - ], - "title": "Experimental Search Types" + ] }, - "risks": { + "custom_headers": { "anyOf": [ { - "items": { - "$ref": "#/components/schemas/RiskScore" + "additionalProperties": { + "type": "string" }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Risks" - }, - "frequency": { - "anyOf": [ - { - "type": "number" + "type": "object" }, { "type": "null" } ], - "title": "Frequency" + "title": "Custom Headers" + } + }, + "type": "object", + "required": [ + "type", + "webhook_url", + "secret" + ], + "title": "AlertChannelWebhookParams" + }, + "AlertType": { + "type": "string", + "enum": [ + "email", + "channel", + "azure_sentinel", + "azure_sentinel_v2", + "slack", + "discord", + "splunk", + "jira", + "teams", + "servicenow", + "webhook" + ], + "title": "AlertType" + }, + "ApiReport": { + "properties": { + "id": { + "type": "integer", + "title": "Id" }, - "start_at": { + "format_type": { + "$ref": "#/components/schemas/ThreatFlowReportFormatType", + "default": "simple_summary" + }, + "title": { + "type": "string", + "title": "Title" + }, + "subtitle": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Start At" + "title": "Subtitle" }, - "alert_channel_id": { + "summary": { + "type": "string", + "title": "Summary" + }, + "content": { + "type": "string", + "title": "Content" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Tags" + }, + "highlights": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Highlights" + }, + "related_activity_uids": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Related Activity Uids" + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "Created At" + }, + "tenant_id": { "anyOf": [ { "type": "integer" @@ -32136,98 +3383,166 @@ "type": "null" } ], - "title": "Alert Channel Id" + "title": "Tenant Id" } }, "type": "object", - "title": "PartialAlert" + "required": [ + "id", + "title", + "subtitle", + "summary", + "content", + "tags", + "highlights", + "related_activity_uids", + "created_at", + "tenant_id" + ], + "title": "ApiReport" }, - "PartialAlertChannel": { + "AssetEnrichmentType": { + "type": "string", + "enum": [ + "domain" + ], + "title": "AssetEnrichmentType" + }, + "AstpCookiesValue": { "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "name": { - "type": "string", - "title": "Name" + "cookie_names": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Cookie Names", + "description": "The cookie names to monitor" }, + "match_subdomains": { + "type": "boolean", + "title": "Match Subdomains", + "description": "Whether this policy will be applied to monitor subdomains of the assigned domain identifiers", + "default": false + } + }, + "type": "object", + "required": [ + "cookie_names" + ], + "title": "AstpCookiesValue" + }, + "AstpDomainValue": { + "properties": { + "match_mode": { + "$ref": "#/components/schemas/DomainMatchMode", + "description": "The domain match mode for this policy", + "default": "email_domain_only" + } + }, + "type": "object", + "title": "AstpDomainValue" + }, + "AuthDomainQuery": { + "properties": { "type": { - "$ref": "#/components/schemas/AlertType" - }, - "state": { - "$ref": "#/components/schemas/AlertChannelState" + "type": "string", + "const": "auth_domain", + "title": "Type" }, - "alert_count": { - "type": "integer", - "title": "Alert Count" + "fqdn": { + "type": "string", + "title": "Fqdn" } }, "type": "object", "required": [ - "id", - "name", "type", - "state", - "alert_count" + "fqdn" ], - "title": "PartialAlertChannel" + "title": "AuthDomainQuery" }, - "PasswordPolicy": { - "type": "string", - "enum": [ - "min_eight_chars", - "special_symbols", - "uppercase", - "lowercase", - "number" + "AzureTenantData": { + "properties": { + "type": { + "type": "string", + "const": "azure_tenant", + "title": "Type", + "default": "azure_tenant" + }, + "tenant_id": { + "type": "string", + "minLength": 1, + "title": "Tenant Id" + } + }, + "type": "object", + "required": [ + "tenant_id" ], - "title": "PasswordPolicy" + "title": "AzureTenantData" }, - "PasswordPolicyOperator": { - "type": "string", - "enum": [ - "include", - "exclude" + "AzureTenantQuery": { + "properties": { + "type": { + "type": "string", + "const": "azure_tenant", + "title": "Type" + }, + "tenant_id": { + "type": "string", + "title": "Tenant Id" + } + }, + "type": "object", + "required": [ + "type", + "tenant_id" ], - "title": "PasswordPolicyOperator" + "title": "AzureTenantQuery" }, - "PasteEvent": { + "BinQuery": { "properties": { - "event_type": { + "type": { "type": "string", - "const": "paste", - "title": "Event Type", - "default": "paste" - }, - "data": { - "$ref": "#/components/schemas/PasteEventData" + "const": "bin", + "title": "Type" }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" + "bin": { + "type": "string", + "title": "Bin" } }, "type": "object", "required": [ - "data", - "metadata" + "type", + "bin" ], - "title": "Paste" + "title": "BinQuery" }, - "PasteEventData": { + "BirthYearData": { "properties": { - "url": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Url" + "type": { + "type": "string", + "const": "birth_year", + "title": "Type", + "default": "birth_year" }, - "title": { + "year": { + "type": "integer", + "maximum": 2100.0, + "minimum": 1900.0, + "title": "Year" + } + }, + "type": "object", + "required": [ + "year" + ], + "title": "BirthYearData" + }, + "BlogPostData": { + "properties": { + "url": { "anyOf": [ { "type": "string" @@ -32236,7 +3551,8 @@ "type": "null" } ], - "title": "Title" + "title": "Url", + "description": "The URL of the blog post." }, "content": { "anyOf": [ @@ -32247,19 +3563,22 @@ "type": "null" } ], - "title": "Content" + "title": "Content", + "description": "The content of the blog post." }, - "actor": { + "description": { "anyOf": [ { - "$ref": "#/components/schemas/pyro__findings__paste__datamodels__PasteEventData__Actor" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Description", + "description": "The description of the blog post." }, - "expires_at": { + "posted_at": { "anyOf": [ { "type": "string", @@ -32269,153 +3588,139 @@ "type": "null" } ], - "title": "Expires At" - }, - "syntax": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Syntax" + "title": "Posted At", + "description": "The date and time the blog post was posted." } }, "type": "object", - "title": "PasteEventData" + "required": [ + "url", + "content", + "description", + "posted_at" + ], + "title": "BlogPostData" }, - "PiiCollection_StealerLogFindingCookie_": { + "BlogPostEvent": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/StealerLogFindingCookie" - }, - "type": "array", - "title": "Items" + "event_type": { + "type": "string", + "const": "blog_post", + "title": "Event Type", + "default": "blog_post" }, - "hidden_count": { - "type": "integer", - "title": "Hidden Count" + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + }, + "data": { + "$ref": "#/components/schemas/BlogPostData" } }, "type": "object", "required": [ - "items", - "hidden_count" + "metadata", + "data" ], - "title": "PiiCollection[StealerLogFindingCookie]" + "title": "Blog Post" }, - "PiiCollection_StealerLogFindingCredential_": { + "BrandData": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/StealerLogFindingCredential" - }, - "type": "array", - "title": "Items" + "type": { + "type": "string", + "const": "brand", + "title": "Type", + "default": "brand" }, - "hidden_count": { - "type": "integer", - "title": "Hidden Count" + "name": { + "type": "string", + "minLength": 1, + "title": "Name" } }, "type": "object", "required": [ - "items", - "hidden_count" + "name" ], - "title": "PiiCollection[StealerLogFindingCredential]" + "title": "BrandData" }, - "PolicyAssignedIdentifierPayload": { + "BrandQuery": { "properties": { - "identifier_id": { - "type": "integer", - "title": "Identifier Id", - "description": "The ID of the identifier this policy is assigned to" - }, - "identifier_name": { + "type": { "type": "string", - "title": "Identifier Name", - "description": "The name of the identifier this policy is assigned to" - }, - "clean_past_events": { - "type": "boolean", - "title": "Clean Past Events", - "description": "Whether this policy has been applied to historical events" + "const": "brand", + "title": "Type" }, - "assigned_at": { + "name": { "type": "string", - "format": "date-time", - "title": "Assigned At", - "description": "The date and time this policy was assigned to the identifier" + "title": "Name" } }, "type": "object", "required": [ - "identifier_id", - "identifier_name", - "clean_past_events", - "assigned_at" + "type", + "name" ], - "title": "PolicyAssignedIdentifierPayload" + "title": "BrandQuery" }, - "PolicyAssignmentsBody": { + "BucketData": { "properties": { - "identifier_ids": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Identifier Ids", - "description": "The IDs of the identifiers to assign the policy to" + "host": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Host", + "description": "The host of the bucket." }, - "clean_past_events": { - "type": "boolean", - "title": "Clean Past Events", - "description": "Whether this policy will be applied to historical events", - "default": false + "provider": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Provider", + "description": "The provider of the bucket." } }, "type": "object", "required": [ - "identifier_ids" + "host", + "provider" ], - "title": "PolicyAssignmentsBody" + "title": "BucketData" }, - "PolicyValue": { - "anyOf": [ - { - "$ref": "#/components/schemas/KeywordsValue" - }, - { - "$ref": "#/components/schemas/LuceneValue" + "BucketEvent": { + "properties": { + "event_type": { + "type": "string", + "const": "bucket", + "title": "Event Type", + "default": "bucket" }, - { - "$ref": "#/components/schemas/AstpCookiesValue" + "metadata": { + "$ref": "#/components/schemas/EventMetadata" }, - { - "$ref": "#/components/schemas/AstpDomainValue" + "data": { + "$ref": "#/components/schemas/BucketEventData" } - ] + }, + "type": "object", + "required": [ + "metadata", + "data" + ], + "title": "Bucket" }, - "PresetRestrictedTerm": { + "BucketEventData": { "properties": { - "type": { - "type": "string", - "const": "preset", - "title": "Type" - }, - "id": { - "type": "string", - "title": "Id" - }, - "display_name": { - "type": "string", - "title": "Display Name" - }, - "description": { + "url": { "anyOf": [ { "type": "string" @@ -32424,174 +3729,86 @@ "type": "null" } ], - "title": "Description" + "title": "Url", + "description": "The URL to the bucket." }, - "terms": { - "items": { - "$ref": "#/components/schemas/PresetRestrictedTermItem" - }, - "type": "array", - "title": "Terms" + "bucket": { + "$ref": "#/components/schemas/BucketData" } }, "type": "object", "required": [ - "type", - "id", - "display_name", - "terms" + "url", + "bucket" ], - "title": "PresetRestrictedTerm" + "title": "BucketEventData" }, - "PresetRestrictedTermItem": { + "CCBinData": { "properties": { "type": { "type": "string", - "enum": [ - "keyword", - "domain" - ], - "title": "Type" + "const": "bin", + "title": "Type", + "default": "bin" }, - "term": { + "bin": { "type": "string", - "title": "Term" - } - }, - "type": "object", - "required": [ - "type", - "term" - ], - "title": "PresetRestrictedTermItem" - }, - "PreviewAlerts": { - "properties": { - "alert_channel_id": { - "type": "integer", - "title": "Alert Channel Id" - }, - "event_uids": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Event Uids" + "minLength": 1, + "title": "Bin" } }, "type": "object", "required": [ - "alert_channel_id", - "event_uids" + "bin" ], - "title": "PreviewAlerts" + "title": "CCBinData" }, - "ProvisionUserItemRequest": { + "ChatMessageEvent": { "properties": { - "email": { + "event_type": { "type": "string", - "title": "Email" + "const": "chat_message", + "title": "Event Type", + "default": "chat_message" }, - "idp_user_uuid": { - "anyOf": [ - { - "type": "string", - "format": "uuid" - }, - { - "type": "null" - } - ], - "title": "Idp User Uuid" + "data": { + "$ref": "#/components/schemas/ChatMessageEventData" }, - "full_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Full Name" + "metadata": { + "$ref": "#/components/schemas/EventMetadata" } }, "type": "object", "required": [ - "email" + "data", + "metadata" ], - "title": "ProvisionUserItemRequest" - }, - "PublicAuditEventAffectedResourceType": { - "type": "string", - "enum": [ - "event", - "alert", - "alert_channel", - "authorize_asset_request", - "credential", - "identifier", - "identifier_recommendation", - "integration", - "user", - "organization", - "priority_action", - "sandbox", - "global_search", - "tenant", - "tenant_membership", - "threat_flow" - ] + "title": "Chat Message" }, - "PublicIdentifierRequestBody": { + "ChatMessageEventData": { "properties": { - "data": { - "oneOf": [ - { - "$ref": "#/components/schemas/CCBinData" - }, - { - "$ref": "#/components/schemas/IPData" - }, - { - "$ref": "#/components/schemas/KeywordData" - }, - { - "$ref": "#/components/schemas/AzureTenantData" - }, - { - "$ref": "#/components/schemas/DomainData" - }, - { - "$ref": "#/components/schemas/SearchQueryData" - }, - { - "$ref": "#/components/schemas/GithubRepositoryData" - }, + "posted_at": { + "anyOf": [ { - "$ref": "#/components/schemas/SecretData" + "type": "string", + "format": "date-time" }, { - "$ref": "#/components/schemas/PublicIdentityData" + "type": "null" } ], - "title": "Data", - "discriminator": { - "propertyName": "type", - "mapping": { - "azure_tenant": "#/components/schemas/AzureTenantData", - "bin": "#/components/schemas/CCBinData", - "domain": "#/components/schemas/DomainData", - "github_repository": "#/components/schemas/GithubRepositoryData", - "identity": "#/components/schemas/PublicIdentityData", - "ip": "#/components/schemas/IPData", - "keyword": "#/components/schemas/KeywordData", - "search_query": "#/components/schemas/SearchQueryData", - "secret": "#/components/schemas/SecretData" - } - } + "title": "Posted At", + "description": "The time the chat message was posted." }, - "name": { + "actor": { + "$ref": "#/components/schemas/pyro__findings__chat_messages__datamodels__ChatMessageEventData__Actor", + "description": "Collection of data about the actor of the chat message." + }, + "context": { + "$ref": "#/components/schemas/pyro__findings__chat_messages__datamodels__ChatMessageEventData__Context", + "description": "Collection of data about the context of the chat message." + }, + "content": { "anyOf": [ { "type": "string" @@ -32600,270 +3817,144 @@ "type": "null" } ], - "title": "Name" - }, - "categories": { - "items": { - "$ref": "#/components/schemas/SearchType" - }, - "type": "array", - "title": "Categories" + "title": "Content", + "description": "The content of the chat message." }, - "emerging_categories": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Emerging Categories" + "parent_context": { + "$ref": "#/components/schemas/ParentContext", + "description": "Collection of data about the context of the parent chat message." }, - "severities": { - "items": { - "$ref": "#/components/schemas/Severity" - }, - "type": "array", - "title": "Severities" + "forward_info": { + "$ref": "#/components/schemas/ForwardInfo", + "description": "Collection of data about the forward information of the chat message." }, - "group_id": { + "was_forwarded": { "anyOf": [ { - "type": "integer" + "type": "boolean" }, { "type": "null" } ], - "title": "Group Id" + "title": "Was Forwarded", + "description": "Whether the chat message was forwarded." } }, "type": "object", - "required": [ - "data", - "categories", - "emerging_categories", - "severities" - ], - "title": "PublicIdentifierRequestBody" + "title": "ChatMessageEventData" }, - "PublicIdentifierResponse": { + "Classes": { "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "name": { - "type": "string", - "title": "Name" - }, - "tenant_id": { - "type": "integer", - "title": "Tenant Id" - }, - "data": { - "oneOf": [ - { - "$ref": "#/components/schemas/CCBinData" - }, - { - "$ref": "#/components/schemas/IPData" - }, - { - "$ref": "#/components/schemas/KeywordData" - }, - { - "$ref": "#/components/schemas/AzureTenantData" - }, - { - "$ref": "#/components/schemas/DomainData" - }, - { - "$ref": "#/components/schemas/SearchQueryData" - }, - { - "$ref": "#/components/schemas/GithubRepositoryData" - }, + "is_carding": { + "anyOf": [ { - "$ref": "#/components/schemas/SecretData" + "type": "boolean" }, { - "$ref": "#/components/schemas/PublicIdentityData" + "type": "null" } ], - "title": "Data", - "discriminator": { - "propertyName": "type", - "mapping": { - "azure_tenant": "#/components/schemas/AzureTenantData", - "bin": "#/components/schemas/CCBinData", - "domain": "#/components/schemas/DomainData", - "github_repository": "#/components/schemas/GithubRepositoryData", - "identity": "#/components/schemas/PublicIdentityData", - "ip": "#/components/schemas/IPData", - "keyword": "#/components/schemas/KeywordData", - "search_query": "#/components/schemas/SearchQueryData", - "secret": "#/components/schemas/SecretData" - } - } - }, - "categories": { - "items": { - "$ref": "#/components/schemas/SearchType" - }, - "type": "array", - "title": "Categories" - }, - "emerging_categories": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Emerging Categories" - }, - "severities": { - "items": { - "$ref": "#/components/schemas/Severity" - }, - "type": "array", - "title": "Severities" + "title": "Is Carding", + "description": "Whether the listing is classified as carding." }, - "group_id": { + "is_bypass": { "anyOf": [ { - "type": "integer" + "type": "boolean" }, { "type": "null" } ], - "title": "Group Id" + "title": "Is Bypass", + "description": "Whether the listing is classified as a bypass." }, - "enrichments": { + "is_ident_fraud": { "anyOf": [ { - "$ref": "#/components/schemas/IdentifierEnrichments" + "type": "boolean" }, { "type": "null" } - ] - }, - "is_disabled": { - "type": "boolean", - "title": "Is Disabled" + ], + "title": "Is Ident Fraud", + "description": "Whether the listing is classified as identity fraud." }, - "updated_at": { - "type": "string", - "format": "date-time", - "title": "Updated At" - } - }, - "type": "object", - "required": [ - "id", - "name", - "tenant_id", - "data", - "categories", - "emerging_categories", - "severities", - "group_id", - "enrichments", - "is_disabled", - "updated_at" - ], - "title": "IdentifierResponse" - }, - "PublicIdentifierUpdateRequestBody": { - "properties": { - "data": { - "oneOf": [ - { - "$ref": "#/components/schemas/CCBinData" - }, + "is_doc_fraud": { + "anyOf": [ { - "$ref": "#/components/schemas/IPData" + "type": "boolean" }, { - "$ref": "#/components/schemas/KeywordData" - }, + "type": "null" + } + ], + "title": "Is Doc Fraud", + "description": "Whether the listing is classified as document fraud." + }, + "is_phishing": { + "anyOf": [ { - "$ref": "#/components/schemas/AzureTenantData" + "type": "boolean" }, { - "$ref": "#/components/schemas/DomainData" - }, + "type": "null" + } + ], + "title": "Is Phishing", + "description": "Whether the listing is classified as phishing." + }, + "is_money_xfer": { + "anyOf": [ { - "$ref": "#/components/schemas/SearchQueryData" + "type": "boolean" }, { - "$ref": "#/components/schemas/GithubRepositoryData" - }, + "type": "null" + } + ], + "title": "Is Money Xfer", + "description": "Whether the listing is classified as money transfer." + }, + "is_cashout": { + "anyOf": [ { - "$ref": "#/components/schemas/SecretData" + "type": "boolean" }, { - "$ref": "#/components/schemas/PublicIdentityData" + "type": "null" } ], - "title": "Data", - "discriminator": { - "propertyName": "type", - "mapping": { - "azure_tenant": "#/components/schemas/AzureTenantData", - "bin": "#/components/schemas/CCBinData", - "domain": "#/components/schemas/DomainData", - "github_repository": "#/components/schemas/GithubRepositoryData", - "identity": "#/components/schemas/PublicIdentityData", - "ip": "#/components/schemas/IPData", - "keyword": "#/components/schemas/KeywordData", - "search_query": "#/components/schemas/SearchQueryData", - "secret": "#/components/schemas/SecretData" - } - } + "title": "Is Cashout", + "description": "Whether the listing is classified as a cashout." }, - "name": { + "is_virt_currency": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Name" - }, - "categories": { - "items": { - "$ref": "#/components/schemas/SearchType" - }, - "type": "array", - "title": "Categories" - }, - "emerging_categories": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Emerging Categories" - }, - "severities": { - "items": { - "$ref": "#/components/schemas/Severity" - }, - "type": "array", - "title": "Severities" + "title": "Is Virt Currency", + "description": "Whether the listing is classified as a virtual currency transaction." }, - "group_id": { + "is_hacking": { "anyOf": [ { - "type": "integer" + "type": "boolean" }, { "type": "null" } ], - "title": "Group Id" + "title": "Is Hacking", + "description": "Whether the listing is classified as hacking activities." }, - "is_disabled": { + "is_misc_financial": { "anyOf": [ { "type": "boolean" @@ -32872,63 +3963,38 @@ "type": "null" } ], - "title": "Is Disabled" + "title": "Is Misc Financial", + "description": "Whether the listing is classified as miscellaneous financial activities." } }, "type": "object", - "required": [ - "data", - "categories", - "emerging_categories", - "severities" - ], - "title": "PublicIdentifierUpdateRequestBody" + "title": "Classes" }, - "PublicIdentityData": { + "Classification": { "properties": { - "type": { - "type": "string", - "const": "identity", - "title": "Type", - "default": "identity" + "classes": { + "$ref": "#/components/schemas/Classes", + "description": "Data about the classes identified in the listing." }, - "attributes": { - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/EmailData" - }, - { - "$ref": "#/components/schemas/UsernameData" - }, - { - "$ref": "#/components/schemas/NameData" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "email": "#/components/schemas/EmailData", - "name": "#/components/schemas/NameData", - "username": "#/components/schemas/UsernameData" - } - } - }, - "type": "array", - "maxItems": 10, - "minItems": 1, - "title": "Attributes" + "types": { + "$ref": "#/components/schemas/Types", + "description": "Data about the possible listing type." } }, "type": "object", - "required": [ - "attributes" - ], - "title": "IdentityData" + "title": "Classification" }, - "PublishReportPayload": { + "ConversationMessage": { "properties": { - "title": { + "uid": { + "type": "string", + "title": "Uid" + }, + "message": { + "type": "string", + "title": "Message" + }, + "message_en": { "anyOf": [ { "type": "string" @@ -32937,220 +4003,261 @@ "type": "null" } ], - "title": "Title" - } - }, - "type": "object", - "title": "PublishReportPayload" - }, - "PydanticThreatFlowReport": { - "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "format_type": { - "$ref": "#/components/schemas/ThreatFlowReportFormatType", - "default": "simple_summary" - }, - "intel_type": { - "$ref": "#/components/schemas/IntelType", - "default": "unit_summary_based" + "title": "Message En" }, - "title": { + "author_name": { "type": "string", - "title": "Title" + "title": "Author Name" }, - "subtitle": { + "date_time": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Subtitle" - }, - "summary": { - "type": "string", - "title": "Summary" - }, - "content": { + "title": "Date Time" + } + }, + "type": "object", + "required": [ + "uid", + "message", + "author_name", + "date_time" + ], + "title": "ConversationMessage" + }, + "ConversationSearchAfterDirection": { + "type": "string", + "enum": [ + "next", + "previous" + ], + "title": "ConversationSearchAfterDirection" + }, + "CreateAlertChannel": { + "properties": { + "name": { "type": "string", - "title": "Content" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Tags" - }, - "highlights": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Highlights" - }, - "related_activity_uids": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Related Activity Uids" + "title": "Name" }, - "prompt_preset_uid": { - "anyOf": [ + "params": { + "oneOf": [ + { + "$ref": "#/components/schemas/AlertChannelEmailParams" + }, + { + "$ref": "#/components/schemas/AlertChannelSlackParams" + }, + { + "$ref": "#/components/schemas/AlertChannelDiscordParams" + }, { - "type": "string" + "$ref": "#/components/schemas/AlertChannelSplunkParams" }, { - "type": "null" - } - ], - "title": "Prompt Preset Uid" - }, - "created_at": { - "type": "string", - "format": "date-time", - "title": "Created At" - }, - "published_at": { - "anyOf": [ + "$ref": "#/components/schemas/AlertChannelChannelParams" + }, { - "type": "string", - "format": "date-time" + "$ref": "#/components/schemas/AlertChannelLegacySentinelParams" }, { - "type": "null" - } - ], - "title": "Published At" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "title": "Updated At" - }, - "reading_time": { - "type": "integer", - "title": "Reading Time" - }, - "tenant_id": { - "anyOf": [ + "$ref": "#/components/schemas/AlertChannelSentinelV2Params" + }, { - "type": "integer" + "$ref": "#/components/schemas/AlertChannelTeamsParams" }, { - "type": "null" + "$ref": "#/components/schemas/AlertChannelJiraParams" + }, + { + "$ref": "#/components/schemas/AlertChannelServiceNowParams" + }, + { + "$ref": "#/components/schemas/AlertChannelWebhookParams" } ], - "title": "Tenant Id" + "title": "Params", + "discriminator": { + "propertyName": "type", + "mapping": { + "azure_sentinel": "#/components/schemas/AlertChannelLegacySentinelParams", + "azure_sentinel_v2": "#/components/schemas/AlertChannelSentinelV2Params", + "channel": "#/components/schemas/AlertChannelChannelParams", + "discord": "#/components/schemas/AlertChannelDiscordParams", + "email": "#/components/schemas/AlertChannelEmailParams", + "jira": "#/components/schemas/AlertChannelJiraParams", + "servicenow": "#/components/schemas/AlertChannelServiceNowParams", + "slack": "#/components/schemas/AlertChannelSlackParams", + "splunk": "#/components/schemas/AlertChannelSplunkParams", + "teams": "#/components/schemas/AlertChannelTeamsParams", + "webhook": "#/components/schemas/AlertChannelWebhookParams" + } + } }, - "organization_id": { + "state": { "anyOf": [ { - "type": "integer" + "$ref": "#/components/schemas/AlertChannelState" }, { "type": "null" } - ], - "title": "Organization Id" + ] } }, "type": "object", "required": [ - "id", - "title", - "subtitle", - "summary", - "content", - "tags", - "highlights", - "related_activity_uids", - "prompt_preset_uid", - "created_at", - "published_at", - "updated_at", - "reading_time", - "tenant_id", - "organization_id" + "name", + "params" ], - "title": "PydanticThreatFlowReport" + "title": "CreateAlertChannel" }, - "QueryStringQuery": { + "CreateAstpCookiesBody": { "properties": { + "name": { + "type": "string", + "minLength": 1, + "title": "Name", + "description": "The name of the matching policy" + }, "type": { "type": "string", - "const": "query_string", + "const": "ASTP_COOKIES", "title": "Type" }, - "query_string": { - "type": "string", - "title": "Query String" + "value": { + "$ref": "#/components/schemas/AstpCookiesValue", + "description": "The value of the matching policy in the form of cookie names" } }, "type": "object", "required": [ + "name", "type", - "query_string" + "value" ], - "title": "QueryStringQuery" + "title": "CreateAstpCookiesBody" }, - "RansomLeakData": { + "CreateAstpDomainBody": { "properties": { + "name": { + "type": "string", + "minLength": 1, + "title": "Name", + "description": "The name of the matching policy" + }, "type": { "type": "string", - "const": "ransomleak", - "title": "Type", - "default": "ransomleak" + "const": "ASTP_DOMAIN", + "title": "Type" }, - "source": { + "value": { + "$ref": "#/components/schemas/AstpDomainValue", + "description": "The value of the matching policy in the form of a domain match mode" + } + }, + "type": "object", + "required": [ + "name", + "type", + "value" + ], + "title": "CreateAstpDomainBody" + }, + "CreateExcludedKeywordsBody": { + "properties": { + "name": { "type": "string", "minLength": 1, - "title": "Source" + "title": "Name", + "description": "The name of the matching policy" }, - "id": { + "type": { + "type": "string", + "const": "EXCLUDED_KEYWORDS", + "title": "Type" + }, + "value": { + "$ref": "#/components/schemas/KeywordsValue", + "description": "The value of the matching policy in the form of keywords" + } + }, + "type": "object", + "required": [ + "name", + "type", + "value" + ], + "title": "CreateExcludedKeywordsBody" + }, + "CreateIncludedKeywordsBody": { + "properties": { + "name": { "type": "string", "minLength": 1, - "title": "Id" + "title": "Name", + "description": "The name of the matching policy" + }, + "type": { + "type": "string", + "const": "INCLUDED_KEYWORDS", + "title": "Type" + }, + "value": { + "$ref": "#/components/schemas/KeywordsValue", + "description": "The value of the matching policy in the form of keywords" } }, "type": "object", "required": [ - "source", - "id" + "name", + "type", + "value" ], - "title": "RansomLeakData" + "title": "CreateIncludedKeywordsBody" }, - "RansomLeakEvent": { + "CreateLuceneQueryBody": { "properties": { - "event_type": { + "name": { "type": "string", - "const": "ransomleak", - "title": "Event Type", - "default": "ransomleak" + "minLength": 1, + "title": "Name", + "description": "The name of the matching policy" }, - "data": { - "$ref": "#/components/schemas/RansomLeakEventData" + "type": { + "type": "string", + "const": "LUCENE_QUERY", + "title": "Type" }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" + "value": { + "$ref": "#/components/schemas/LuceneValue", + "description": "The value of the matching policy in the form of a Lucene query" } }, "type": "object", "required": [ - "data", - "metadata" + "name", + "type", + "value" ], - "title": "Ransom Leak" + "title": "CreateLuceneQueryBody" }, - "RansomLeakEventData": { + "Credential": { "properties": { - "url": { + "id": { + "type": "integer", + "title": "Id" + }, + "identity_name": { + "type": "string", + "title": "Identity Name" + }, + "domain": { "anyOf": [ { "type": "string" @@ -33159,10 +4266,17 @@ "type": "null" } ], - "title": "Url", - "description": "The URL of the ransom leak post." + "title": "Domain" }, - "response_url": { + "source_id": { + "type": "string", + "title": "Source Id" + }, + "imported_at": { + "type": "string", + "title": "Imported At" + }, + "hash": { "anyOf": [ { "type": "string" @@ -33171,34 +4285,41 @@ "type": "null" } ], - "title": "Response Url", - "description": "The URL of the response to the ransom leak post." + "title": "Hash" }, - "title": { + "hash_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Hash Type" + }, + "source": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/SourceV2" }, { "type": "null" } - ], - "title": "Title", - "description": "The title of the ransom leak post." + ] }, - "content": { + "known_password_id": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Content", - "description": "The content of the ransom leak post." + "title": "Known Password Id" }, - "body": { + "credential_hash": { "anyOf": [ { "type": "string" @@ -33207,309 +4328,221 @@ "type": "null" } ], - "title": "Body", - "description": "The body of the ransom leak post." + "title": "Credential Hash" }, - "victim_information": { + "event_uid": { "anyOf": [ { - "$ref": "#/components/schemas/pyro__findings__ransomleaks__datamodels__VictimInformation" + "type": "string" }, { "type": "null" } ], - "description": "The information relating to the victim of the ransom leak." + "title": "Event Uid" + }, + "auth_domains": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Auth Domains" + }, + "urls": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Urls" } }, "type": "object", "required": [ - "url", - "response_url", - "title", - "content", - "body", - "victim_information" + "id", + "identity_name", + "domain", + "source_id", + "imported_at", + "hash", + "hash_type", + "source", + "known_password_id", + "credential_hash", + "event_uid" ], - "title": "RansomLeakEventData" + "title": "Credential" }, - "RecentActivityCountResponse": { + "CredentialActionBody": { "properties": { - "count": { - "type": "integer", - "title": "Count" + "type": { + "$ref": "#/components/schemas/LeakedCredentialsBulkActionType" } }, "type": "object", "required": [ - "count" + "type" ], - "title": "RecentActivityCountResponse" + "title": "CredentialActionBody" }, - "RecentActivityExposedPII": { + "CredentialActionRequestBody": { "properties": { - "type": { - "$ref": "#/components/schemas/SearchType" - }, - "uid": { - "type": "string", - "title": "Uid" - }, - "leaked_date": { - "type": "string", - "format": "date-time", - "title": "Leaked Date" - }, - "attribute": { - "type": "string", - "title": "Attribute" - }, - "information_type": { - "type": "string", - "title": "Information Type" + "targets": { + "items": { + "$ref": "#/components/schemas/CredentialActionTarget" + }, + "type": "array", + "maxItems": 100, + "title": "Targets" }, - "source_name": { - "type": "string", - "title": "Source Name" + "action": { + "$ref": "#/components/schemas/CredentialActionBody" } }, "type": "object", "required": [ - "type", - "uid", - "leaked_date", - "attribute", - "information_type", - "source_name" + "targets", + "action" ], - "title": "RecentActivityExposedPII" + "title": "CredentialActionRequestBody" }, - "RecentActivityOpenWebIllicitNetwork": { + "CredentialActionTarget": { "properties": { - "type": { - "$ref": "#/components/schemas/SearchType" - }, - "uid": { - "type": "string", - "title": "Uid" - }, - "creation_date": { - "type": "string", - "format": "date-time", - "title": "Creation Date" - }, - "attribute": { - "type": "string", - "title": "Attribute" - }, - "event_type": { - "type": "string", - "title": "Event Type" - }, - "source_name": { + "credential_hash": { "type": "string", - "title": "Source Name" + "title": "Credential Hash" } }, "type": "object", "required": [ - "type", - "uid", - "creation_date", - "attribute", - "event_type", - "source_name" + "credential_hash" ], - "title": "RecentActivityOpenWebIllicitNetwork" + "title": "CredentialActionTarget" }, - "RecentActivityPassword": { + "CredentialsData": { "properties": { "type": { "type": "string", + "const": "credentials", "title": "Type", - "default": "identity_profile_password" - }, - "last_seen": { - "type": "string", - "format": "date-time", - "title": "Last Seen" + "default": "credentials" }, - "attribute": { + "username": { "type": "string", - "title": "Attribute" + "minLength": 1, + "title": "Username" }, "password": { "type": "string", + "minLength": 1, "title": "Password" - }, - "source_count": { - "type": "integer", - "title": "Source Count" - }, - "validation": { - "anyOf": [ - { - "$ref": "#/components/schemas/CredentialValidation" - }, - { - "type": "null" - } - ] } }, "type": "object", "required": [ - "last_seen", - "attribute", - "password", - "source_count", - "validation" + "username", + "password" ], - "title": "RecentActivityPassword" + "title": "CredentialsData" }, - "RecentActivityResponse": { + "CredentialsDateFilter": { "properties": { - "items": { - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/RecentActivityStealerLog" - }, - { - "$ref": "#/components/schemas/RecentActivityExposedPII" - }, - { - "$ref": "#/components/schemas/RecentActivityOpenWebIllicitNetwork" - }, - { - "$ref": "#/components/schemas/RecentActivityPassword" - } - ] - }, - "type": "array", - "title": "Items" + "gte": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Gte" }, - "next": { + "lte": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Next" + "title": "Lte" } }, "type": "object", - "required": [ - "items" - ], - "title": "RecentActivityResponse" + "title": "CredentialsDateFilter" }, - "RecentActivityStealerLog": { + "CredentialsQuery": { "properties": { "type": { - "$ref": "#/components/schemas/SearchType" - }, - "uid": { "type": "string", - "title": "Uid" - }, - "creation_date": { - "type": "string", - "format": "date-time", - "title": "Creation Date" + "const": "credentials", + "title": "Type" }, - "attribute": { + "username": { "type": "string", - "title": "Attribute" + "title": "Username" }, - "ip_address": { + "password": { "type": "string", - "title": "Ip Address" - }, - "credentials_count": { - "type": "integer", - "title": "Credentials Count" + "title": "Password" } }, "type": "object", "required": [ "type", - "uid", - "creation_date", - "attribute", - "ip_address", - "credentials_count" + "username", + "password" ], - "title": "RecentActivityStealerLog" + "title": "CredentialsQuery" }, - "Recommendation": { + "CredentialsQueryFilters": { "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "data": { + "imported_at": { + "$ref": "#/components/schemas/CredentialsDateFilter" + } + }, + "type": "object", + "title": "CredentialsQueryFilters" + }, + "CredentialsQueryPayload": { + "properties": { + "query": { "oneOf": [ { - "$ref": "#/components/schemas/DomainData" + "$ref": "#/components/schemas/DomainQuery" }, { - "$ref": "#/components/schemas/AzureTenantData" + "$ref": "#/components/schemas/EmailQuery" }, { - "$ref": "#/components/schemas/EmailData" + "$ref": "#/components/schemas/KeywordQuery" }, { - "$ref": "#/components/schemas/UsernameData" - } - ], - "title": "Data", - "discriminator": { - "propertyName": "type", - "mapping": { - "azure_tenant": "#/components/schemas/AzureTenantData", - "domain": "#/components/schemas/DomainData", - "email": "#/components/schemas/EmailData", - "username": "#/components/schemas/UsernameData" + "$ref": "#/components/schemas/SecretQuery" + }, + { + "$ref": "#/components/schemas/AuthDomainQuery" } - } - } - }, - "type": "object", - "required": [ - "id", - "data" - ], - "title": "Recommendation" - }, - "RecommendationRelevancyScoreType": { - "type": "string", - "enum": [ - "HIGH", - "MEDIUM", - "LOW" - ], - "title": "RecommendationRelevancyScoreType" - }, - "RelatedConversationRequest": { - "properties": { - "uid": { - "type": "string", - "title": "Uid" - }, - "direction": { - "$ref": "#/components/schemas/ConversationSearchAfterDirection", - "default": "next" + ], + "title": "Query", + "discriminator": { + "propertyName": "type", + "mapping": { + "auth_domain": "#/components/schemas/AuthDomainQuery", + "domain": "#/components/schemas/DomainQuery", + "email": "#/components/schemas/EmailQuery", + "keyword": "#/components/schemas/KeywordQuery", + "secret": "#/components/schemas/SecretQuery" + } + } }, - "size": { - "type": "integer", - "title": "Size", - "default": 10 + "filters": { + "$ref": "#/components/schemas/CredentialsQueryFilters" }, - "search_after": { + "from": { "anyOf": [ { "type": "string" @@ -33518,56 +4551,74 @@ "type": "null" } ], - "title": "Search After" + "title": "From" }, - "should_translate": { - "type": "boolean", - "title": "Should Translate", - "default": false + "size": { + "type": "integer", + "maximum": 10000.0, + "minimum": 1.0, + "title": "Size", + "default": 10 + }, + "include": { + "items": { + "$ref": "#/components/schemas/IncludeOptions" + }, + "type": "array", + "title": "Include" + }, + "order": { + "$ref": "#/components/schemas/OrderType", + "default": "desc" } }, "type": "object", "required": [ - "uid" + "query" ], - "title": "RelatedConversationRequest" + "title": "CredentialsQueryPayload" }, - "RelatedConversationResponse": { + "DomainAssetEnrichment": { "properties": { - "conversation_messages": { + "type": { + "$ref": "#/components/schemas/AssetEnrichmentType" + }, + "sources": { "items": { - "$ref": "#/components/schemas/ConversationMessage" + "type": "string" }, "type": "array", - "title": "Conversation Messages" + "title": "Sources" }, - "conversation_name": { - "type": "string", - "title": "Conversation Name" + "entries": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Entries" }, - "conversation_name_en": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Conversation Name En" + "tags": { + "items": { + "$ref": "#/components/schemas/SubdomainTag" + }, + "type": "array", + "title": "Tags" }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" + "statuses": { + "items": { + "$ref": "#/components/schemas/SubdomainStatus" + }, + "type": "array", + "title": "Statuses" }, - "previous": { + "external_links": { + "items": { + "type": "string" + }, + "type": "array", + "title": "External Links" + }, + "title": { "anyOf": [ { "type": "string" @@ -33576,258 +4627,193 @@ "type": "null" } ], - "title": "Previous" + "title": "Title" } }, "type": "object", "required": [ - "conversation_messages", - "conversation_name" + "type", + "sources", + "entries", + "tags", + "statuses", + "external_links", + "title" ], - "title": "RelatedConversationResponse" + "title": "DomainAssetEnrichment" }, - "RepliesSummaryOutput": { + "DomainData": { "properties": { - "overview": { + "type": { "type": "string", - "title": "Overview", - "description": "Single paragraph summarizing the replies." + "const": "domain", + "title": "Type", + "default": "domain" }, - "sentiment_analysis": { + "fqdn": { "type": "string", - "title": "Sentiment Analysis", - "description": "Single paragraph analyzing the sentiment in the replies." + "minLength": 1, + "title": "Fqdn" } }, "type": "object", "required": [ - "overview", - "sentiment_analysis" + "fqdn" + ], + "title": "DomainData" + }, + "DomainMatchMode": { + "type": "string", + "enum": [ + "email_domain_only", + "auth_domain_and_email_domain", + "auth_domain_only" ], - "title": "RepliesSummaryOutput" + "title": "DomainMatchMode" }, - "Report": { + "DomainQuery": { "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "report_group_id": { - "type": "integer", - "title": "Report Group Id" - }, - "tenant_id": { - "type": "integer", - "title": "Tenant Id" - }, - "title": { + "type": { "type": "string", - "title": "Title" + "const": "domain", + "title": "Type" }, - "author": { + "fqdn": { "type": "string", - "title": "Author" - }, - "report_type": { - "$ref": "#/components/schemas/ReportType-Output" - }, - "created_at": { + "title": "Fqdn" + } + }, + "type": "object", + "required": [ + "type", + "fqdn" + ], + "title": "DomainQuery" + }, + "DomainStatus": { + "type": "string", + "enum": [ + "found", + "resolves", + "reachable" + ], + "title": "DomainStatus" + }, + "EmailData": { + "properties": { + "type": { "type": "string", - "format": "date-time", - "title": "Created At" + "const": "email", + "title": "Type", + "default": "email" }, - "updated_at": { + "email": { "type": "string", - "format": "date-time", - "title": "Updated At" - }, - "uri_docx": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Uri Docx" - }, - "uri_pdf": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Uri Pdf" - }, - "uri_csv": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Uri Csv" - }, - "is_archived": { - "type": "boolean", - "title": "Is Archived", - "default": false + "format": "email", + "title": "Email" + } + }, + "type": "object", + "required": [ + "email" + ], + "title": "EmailData" + }, + "EmailQuery": { + "properties": { + "type": { + "type": "string", + "const": "email", + "title": "Type" }, - "status": { - "$ref": "#/components/schemas/ReportStatus", - "default": "draft" + "email": { + "type": "string", + "title": "Email" + } + }, + "type": "object", + "required": [ + "type", + "email" + ], + "title": "EmailQuery" + }, + "EmptyFireworkEvent": { + "properties": { + "event_type": { + "$ref": "#/components/schemas/ActivityModelName" }, - "is_ready_for_download": { - "type": "boolean", - "title": "Is Ready For Download", - "default": false + "metadata": { + "$ref": "#/components/schemas/EventMetadata" }, - "is_mutable": { - "type": "boolean", - "title": "Is Mutable", - "default": true + "data": { + "additionalProperties": true, + "type": "object", + "title": "Data" } }, "type": "object", "required": [ - "id", - "report_group_id", - "tenant_id", - "title", - "author", - "report_type", - "created_at", - "updated_at" + "event_type", + "metadata" ], - "title": "Report" + "title": "EmptyFireworkEvent" }, - "ReportAlertChannelData": { + "EventAction": { "properties": { - "report_group_id": { - "type": "integer", - "title": "Report Group Id" - }, - "tenant_id": { - "type": "integer", - "title": "Tenant Id" - }, - "alert_channel_id": { - "type": "integer", - "title": "Alert Channel Id" - }, - "created_at": { + "type": { "type": "string", - "format": "date-time", - "title": "Created At" + "enum": [ + "remediate", + "unremediate", + "ignore", + "unignore" + ], + "title": "Type" } }, "type": "object", "required": [ - "report_group_id", - "tenant_id", - "alert_channel_id", - "created_at" + "type" ], - "title": "ReportAlertChannelData" + "title": "EventAction" }, - "ReportAlertChannelUpdatePayload": { + "EventActionTarget": { "properties": { - "alert_channel_ids": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Alert Channel Ids" + "uid": { + "type": "string", + "title": "Uid" } }, "type": "object", "required": [ - "alert_channel_ids" + "uid" ], - "title": "ReportAlertChannelUpdatePayload" - }, - "ReportAnalyticSectionType": { - "type": "string", - "enum": [ - "analytics", - "cumulative_event_growth", - "remediated_and_ignored_events", - "event_distribution", - "mean_time_to_remediation", - "total_enabled_identifiers_per_category", - "total_identifiers" - ], - "title": "ReportAnalyticSectionType" + "title": "EventActionTarget" }, - "ReportConfigResponse": { + "EventActionsBody": { "properties": { - "report_config": { - "$ref": "#/components/schemas/ReportFeedConfigPayload" + "targets": { + "items": { + "$ref": "#/components/schemas/EventActionTarget" + }, + "type": "array", + "maxItems": 10, + "title": "Targets" + }, + "action": { + "$ref": "#/components/schemas/EventAction" } }, "type": "object", "required": [ - "report_config" + "action" ], - "title": "ReportConfigResponse" + "title": "EventActionsBody" }, - "ReportConfigUpdatePayload": { + "EventMetadata": { "properties": { - "feed_definition": { - "anyOf": [ - { - "$ref": "#/components/schemas/FeedDefinition" - }, - { - "type": "null" - } - ] - }, - "search_types": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/SearchType" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Search Types" - }, - "risks": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/RiskScore" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Risks" - }, - "time_range_type": { - "anyOf": [ - { - "$ref": "#/components/schemas/TimeRangeType" - }, - { - "type": "null" - } - ] - }, - "time_range_from": { + "estimated_created_at": { "anyOf": [ { "type": "string", @@ -33837,9 +4823,16 @@ "type": "null" } ], - "title": "Time Range From" + "title": "Estimated Created At" }, - "time_range_to": { + "flare_url": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Flare Url" + }, + "matched_at": { "anyOf": [ { "type": "string", @@ -33849,81 +4842,121 @@ "type": "null" } ], - "title": "Time Range To" - }, - "time_zone": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Time Zone" + "title": "Matched At" }, - "include_flare_event_links": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Include Flare Event Links" + "severity": { + "$ref": "#/components/schemas/EventSeverity" }, - "include_flare_ai_summaries": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Include Flare Ai Summaries" + "uid": { + "type": "string", + "title": "Uid" } }, "type": "object", - "title": "ReportConfigUpdatePayload" + "required": [ + "estimated_created_at", + "flare_url", + "matched_at", + "severity", + "uid" + ], + "title": "EventMetadata" + }, + "EventSeverity": { + "type": "string", + "enum": [ + "info", + "low", + "medium", + "high", + "critical" + ], + "title": "EventSeverity" + }, + "ExpandableField": { + "type": "string", + "enum": [ + "credentials", + "cookies" + ], + "title": "ExpandableField" }, - "ReportData": { + "ExternalIdData": { "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "report_group_id": { - "type": "integer", - "title": "Report Group Id" - }, - "tenant_id": { - "type": "integer", - "title": "Tenant Id" - }, - "title": { + "type": { "type": "string", - "title": "Title" + "const": "external_id", + "title": "Type", + "default": "external_id" }, - "author": { + "id": { "type": "string", - "title": "Author" - }, - "report_type": { - "$ref": "#/components/schemas/ReportType-Output" + "minLength": 1, + "title": "Id" }, - "created_at": { + "source": { "type": "string", - "format": "date-time", - "title": "Created At" + "minLength": 1, + "title": "Source" + } + }, + "type": "object", + "required": [ + "id", + "source" + ], + "title": "ExternalIdData" + }, + "FeedConfiguration": { + "properties": { + "search_types": { + "items": { + "$ref": "#/components/schemas/SearchType" + }, + "type": "array", + "title": "Search Types" }, - "updated_at": { - "type": "string", - "format": "date-time", - "title": "Updated At" + "experimental_search_types": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Experimental Search Types" + }, + "risks": { + "items": { + "$ref": "#/components/schemas/RiskScore" + }, + "type": "array", + "title": "Risks" }, - "generated_at": { + "blacklist": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Blacklist" + } + }, + "type": "object", + "required": [ + "search_types", + "experimental_search_types", + "risks", + "blacklist" + ], + "title": "FeedConfiguration" + }, + "FeedDateFilter": { + "properties": { + "gt": { "anyOf": [ { "type": "string", @@ -33933,117 +4966,54 @@ "type": "null" } ], - "title": "Generated At" + "title": "Gt" }, - "uri_docx": { + "gte": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Uri Docx" + "title": "Gte" }, - "uri_pdf": { + "lt": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Uri Pdf" + "title": "Lt" }, - "uri_csv": { + "lte": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Uri Csv" - }, - "is_archived": { - "type": "boolean", - "title": "Is Archived", - "default": false - }, - "status": { - "$ref": "#/components/schemas/ReportStatus", - "default": "draft" - }, - "is_ready_for_download": { - "type": "boolean", - "title": "Is Ready For Download", - "default": false - }, - "is_mutable": { - "type": "boolean", - "title": "Is Mutable", - "default": true + "title": "Lte" } }, "type": "object", - "required": [ - "id", - "report_group_id", - "tenant_id", - "title", - "author", - "report_type", - "created_at", - "updated_at" - ], - "title": "ReportData" - }, - "ReportDownloadFormat": { - "type": "string", - "enum": [ - "docx", - "pdf", - "csv", - "zip" - ], - "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" + "title": "FeedDateFilter" }, - "ReportFeedConfigPayload": { + "FeedDefinition": { "properties": { - "report_id": { - "type": "integer", - "title": "Report Id" - }, - "tenant_id": { - "type": "integer", - "title": "Tenant Id" + "type": { + "$ref": "#/components/schemas/FeedType" }, - "feed_id": { + "id": { "anyOf": [ { "type": "integer" @@ -34052,250 +5022,173 @@ "type": "null" } ], - "title": "Feed Id" - }, - "feed_definition": { - "anyOf": [ - { - "$ref": "#/components/schemas/FeedDefinition" - }, - { - "type": "null" - } - ] - }, - "identifier_scope": { + "title": "Id" + } + }, + "type": "object", + "required": [ + "type" + ], + "title": "FeedDefinition" + }, + "FeedFilters": { + "properties": { + "severity": { "anyOf": [ { - "$ref": "#/components/schemas/IdentifierScope" + "$ref": "#/components/schemas/Severity" }, { - "type": "null" + "items": { + "$ref": "#/components/schemas/Severity" + }, + "type": "array" } - ] + ], + "title": "Severity" }, - "report_event_types": { + "type": { "items": { - "$ref": "#/components/schemas/ReportEventType" + "$ref": "#/components/schemas/SearchType" }, "type": "array", - "uniqueItems": true, - "title": "Report Event Types" + "title": "Type" }, - "available_report_event_types": { - "items": { - "$ref": "#/components/schemas/ReportEventType" - }, - "type": "array", - "uniqueItems": true, - "title": "Available Report Event Types" + "estimated_created_at": { + "$ref": "#/components/schemas/FeedDateFilter" }, - "risks": { + "materialized_at": { + "$ref": "#/components/schemas/FeedDateFilter" + }, + "tags": { "items": { - "$ref": "#/components/schemas/RiskScore" + "type": "string" }, "type": "array", - "title": "Risks" - }, - "time_range_type": { - "$ref": "#/components/schemas/TimeRangeType" - }, - "time_range_from": { - "type": "string", - "format": "date-time", - "title": "Time Range From" - }, - "time_range_to": { - "type": "string", - "format": "date-time", - "title": "Time Range To" - }, - "time_zone": { - "type": "string", - "title": "Time Zone" + "title": "Tags" }, - "include_flare_event_links": { + "is_ignored": { "type": "boolean", - "title": "Include Flare Event Links" + "title": "Is Ignored", + "default": false }, - "include_flare_ai_summaries": { + "is_remediated": { "type": "boolean", - "title": "Include Flare Ai Summaries" - }, - "created_at": { - "type": "string", - "format": "date-time", - "title": "Created At" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "title": "Updated At" - }, - "search_types": { - "items": { - "$ref": "#/components/schemas/SearchType" - }, - "type": "array", - "title": "Search Types" - }, - "available_search_types": { - "items": { - "$ref": "#/components/schemas/SearchType" - }, - "type": "array", - "title": "Available Search Types" - } - }, - "type": "object", - "required": [ - "report_id", - "tenant_id", - "feed_id", - "feed_definition", - "identifier_scope", - "report_event_types", - "available_report_event_types", - "risks", - "time_range_type", - "time_range_from", - "time_range_to", - "time_zone", - "include_flare_event_links", - "include_flare_ai_summaries", - "created_at", - "updated_at", - "search_types", - "available_search_types" - ], - "title": "ReportFeedConfigPayload" - }, - "ReportGenerateSummaryPayload": { - "properties": { - "stats_aggregates": { - "anyOf": [ - { - "$ref": "#/components/schemas/StatsAggregates" - }, - { - "type": "null" - } - ] + "title": "Is Remediated", + "default": false } }, "type": "object", - "title": "ReportGenerateSummaryPayload" + "title": "FeedFilters" }, - "ReportGroupCreationPayload": { + "FeedItem": { "properties": { - "title": { - "type": "string", - "minLength": 1, - "title": "Title" + "metadata": { + "$ref": "#/components/schemas/FeedItemMetadata" }, - "author": { - "type": "string", - "minLength": 1, - "title": "Author" + "tenant_metadata": { + "$ref": "#/components/schemas/FeedItemTenantMetadata" }, - "time_zone": { - "type": "string", - "title": "Time Zone", - "default": "Etc/UTC" - } - }, - "type": "object", - "required": [ - "title", - "author" - ], - "title": "ReportGroupCreationPayload" - }, - "ReportGroupCreationResponse": { - "properties": { - "report_group_id": { - "type": "integer", - "title": "Report Group Id" + "identifiers": { + "items": { + "$ref": "#/components/schemas/FeedItemIdentifier" + }, + "type": "array", + "title": "Identifiers" }, - "report_id": { - "type": "integer", - "title": "Report Id" + "highlights": { + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + }, + "type": "object", + "title": "Highlights" } }, "type": "object", "required": [ - "report_group_id", - "report_id" + "metadata" ], - "title": "ReportGroupCreationResponse" + "title": "FeedItem" }, - "ReportGroupData": { + "FeedItemIdentifier": { "properties": { "id": { "type": "integer", "title": "Id" }, - "tenant_id": { - "type": "integer", - "title": "Tenant Id" - }, - "created_at": { + "name": { "type": "string", - "format": "date-time", - "title": "Created At" - }, - "report_count": { - "type": "integer", - "title": "Report Count" - }, - "is_scheduled": { - "type": "boolean", - "title": "Is Scheduled" - }, - "latest_report": { - "$ref": "#/components/schemas/ReportData" + "title": "Name" } }, "type": "object", "required": [ "id", - "tenant_id", - "created_at", - "report_count", - "is_scheduled", - "latest_report" + "name" ], - "title": "ReportGroupData" + "title": "FeedItemIdentifier" }, - "ReportRequestInfoResponse": { + "FeedItemMetadata": { "properties": { - "status": { - "$ref": "#/components/schemas/RequestStatus" + "uid": { + "type": "string", + "title": "Uid" }, - "report": { + "estimated_created_at": { + "type": "string", + "format": "date-time", + "title": "Estimated Created At" + }, + "matched_at": { "anyOf": [ { - "$ref": "#/components/schemas/ApiReport" + "type": "string", + "format": "date-time" }, { "type": "null" } - ] + ], + "title": "Matched At" + }, + "type": { + "$ref": "#/components/schemas/ActivityModelName" + }, + "severity": { + "$ref": "#/components/schemas/Severity" + }, + "flare_url": { + "type": "string", + "title": "Flare Url" } }, "type": "object", "required": [ - "status" + "uid", + "estimated_created_at", + "matched_at", + "type", + "severity", + "flare_url" ], - "title": "ReportRequestInfoResponse" + "title": "FeedItemMetadata" }, - "ReportRequestPayload": { + "FeedItemTenantMetadata": { "properties": { - "report_title": { - "type": "string", - "title": "Report Title" + "severity": { + "anyOf": [ + { + "$ref": "#/components/schemas/FeedItemTenantMetadataSeverity" + }, + { + "type": "null" + } + ] }, - "question": { + "notes": { "anyOf": [ { "type": "string" @@ -34304,13 +5197,16 @@ "type": "null" } ], - "title": "Question" + "title": "Notes" }, - "time_range_type": { - "$ref": "#/components/schemas/TimeRangeType", - "default": "all" + "tags": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Tags" }, - "time_range_from": { + "remediated_at": { "anyOf": [ { "type": "string", @@ -34320,9 +5216,9 @@ "type": "null" } ], - "title": "Time Range From" + "title": "Remediated At" }, - "time_range_to": { + "ignored_at": { "anyOf": [ { "type": "string", @@ -34332,161 +5228,268 @@ "type": "null" } ], - "title": "Time Range To" + "title": "Ignored At" + } + }, + "type": "object", + "title": "FeedItemTenantMetadata" + }, + "FeedItemTenantMetadataSeverity": { + "properties": { + "original": { + "$ref": "#/components/schemas/Severity" }, - "included_keywords": { + "override": { + "$ref": "#/components/schemas/Severity" + } + }, + "type": "object", + "required": [ + "original", + "override" + ], + "title": "FeedItemTenantMetadataSeverity" + }, + "FeedOrder": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "title": "FeedOrder" + }, + "FeedRequestBody": { + "properties": { + "query": { "anyOf": [ { - "items": { - "type": "string" - }, - "type": "array" + "oneOf": [ + { + "$ref": "#/components/schemas/GithubRepositoryQuery" + }, + { + "$ref": "#/components/schemas/UsernameQuery" + }, + { + "$ref": "#/components/schemas/DomainQuery" + }, + { + "$ref": "#/components/schemas/BrandQuery" + }, + { + "$ref": "#/components/schemas/NameQuery" + }, + { + "$ref": "#/components/schemas/KeywordQuery" + }, + { + "$ref": "#/components/schemas/QueryStringQuery" + }, + { + "$ref": "#/components/schemas/BinQuery" + }, + { + "$ref": "#/components/schemas/IpQuery" + }, + { + "$ref": "#/components/schemas/EmailQuery" + }, + { + "$ref": "#/components/schemas/SecretQuery" + }, + { + "$ref": "#/components/schemas/CredentialsQuery" + }, + { + "$ref": "#/components/schemas/AzureTenantQuery" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "azure_tenant": "#/components/schemas/AzureTenantQuery", + "bin": "#/components/schemas/BinQuery", + "brand": "#/components/schemas/BrandQuery", + "credentials": "#/components/schemas/CredentialsQuery", + "domain": "#/components/schemas/DomainQuery", + "email": "#/components/schemas/EmailQuery", + "github_repository": "#/components/schemas/GithubRepositoryQuery", + "ip": "#/components/schemas/IpQuery", + "keyword": "#/components/schemas/KeywordQuery", + "name": "#/components/schemas/NameQuery", + "query_string": "#/components/schemas/QueryStringQuery", + "secret": "#/components/schemas/SecretQuery", + "username": "#/components/schemas/UsernameQuery" + } + } }, { "type": "null" } ], - "title": "Included Keywords" + "title": "Query", + "examples": [ + { + "fqdn": "test.com", + "type": "domain" + } + ] }, - "excluded_keywords": { + "filters": { + "$ref": "#/components/schemas/FeedFilters" + }, + "order": { + "$ref": "#/components/schemas/FeedOrder", + "default": "desc" + }, + "from": { "anyOf": [ { - "items": { - "type": "string" - }, - "type": "array" + "type": "string" }, { "type": "null" } ], - "title": "Excluded Keywords" + "title": "From" + }, + "size": { + "type": "integer", + "maximum": 10.0, + "exclusiveMinimum": 0.0, + "title": "Size", + "default": 10 + } + }, + "type": "object", + "title": "FeedRequestBody" + }, + "FeedType": { + "type": "string", + "enum": [ + "tenant", + "identifier", + "group" + ], + "title": "FeedType" + }, + "FilterSeverities": { + "properties": { + "severities": { + "items": { + "$ref": "#/components/schemas/FilterSeverity" + }, + "type": "array", + "title": "Severities" + } + }, + "type": "object", + "title": "FilterSeverities" + }, + "FilterSeverity": { + "properties": { + "value": { + "type": "string", + "title": "Value" + }, + "label": { + "type": "string", + "title": "Label" + }, + "color": { + "type": "string", + "title": "Color" } }, "type": "object", "required": [ - "report_title" + "value", + "label", + "color" ], - "title": "ReportRequestPayload" + "title": "FilterSeverity" }, - "ReportRequestResponse": { + "FilterSourceType": { "properties": { - "request_id": { + "value": { "type": "string", - "format": "uuid", - "title": "Request Id" + "title": "Value" + }, + "label": { + "type": "string", + "title": "Label" } }, "type": "object", "required": [ - "request_id" + "value", + "label" ], - "title": "ReportRequestResponse" + "title": "FilterSourceType" }, - "ReportSchedulerData": { + "FilterSourceTypeCategory": { "properties": { - "report_group_id": { - "type": "integer", - "title": "Report Group Id" - }, - "tenant_id": { - "type": "integer", - "title": "Tenant Id" - }, - "active": { - "type": "boolean", - "title": "Active" - }, - "rrule": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Rrule" - }, - "next_run_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Next Run At" - }, - "created_at": { + "value": { "type": "string", - "format": "date-time", - "title": "Created At" + "title": "Value" }, - "updated_at": { + "label": { "type": "string", - "format": "date-time", - "title": "Updated At" + "title": "Label" + }, + "types": { + "items": { + "$ref": "#/components/schemas/FilterSourceType" + }, + "type": "array", + "title": "Types" } }, "type": "object", "required": [ - "report_group_id", - "tenant_id", - "active", - "rrule", - "next_run_at", - "created_at", - "updated_at" + "value", + "label" ], - "title": "ReportSchedulerData" + "title": "FilterSourceTypeCategory" }, - "ReportSchedulerUpdatePayload": { + "FilterSourceTypes": { "properties": { - "active": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Active" - }, - "rrule": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Rrule" + "categories": { + "items": { + "$ref": "#/components/schemas/FilterSourceTypeCategory" + }, + "type": "array", + "title": "Categories" } }, "type": "object", - "title": "ReportSchedulerUpdatePayload" + "title": "FilterSourceTypes" }, - "ReportSectionPayload": { + "FinancialEvent": { "properties": { - "uid": { + "event_type": { "type": "string", - "format": "uuid", - "title": "Uid" - }, - "report_id": { - "type": "integer", - "title": "Report Id" + "const": "cc", + "title": "Event Type", + "default": "cc" }, - "tenant_id": { - "type": "integer", - "title": "Tenant Id" + "data": { + "$ref": "#/components/schemas/FinancialEventData" }, - "content": { + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + } + }, + "type": "object", + "required": [ + "data", + "metadata" + ], + "title": "Credit Card" + }, + "FinancialEventData": { + "properties": { + "bank": { "anyOf": [ { "type": "string" @@ -34495,13 +5498,10 @@ "type": "null" } ], - "title": "Content" - }, - "number_of_events_shown": { - "type": "integer", - "title": "Number Of Events Shown" + "title": "Bank", + "description": "The bank associated with the leaked credit card." }, - "image_uri": { + "bin": { "anyOf": [ { "type": "string" @@ -34510,9 +5510,10 @@ "type": "null" } ], - "title": "Image Uri" + "title": "Bin", + "description": "The BIN (Bank Identification Number) of the credit card." }, - "image_html_id": { + "brand": { "anyOf": [ { "type": "string" @@ -34521,121 +5522,47 @@ "type": "null" } ], - "title": "Image Html Id" - }, - "enabled": { - "type": "boolean", - "title": "Enabled" - }, - "visible": { - "type": "boolean", - "title": "Visible" + "title": "Brand", + "description": "The brand of the leakedcredit card. Ex: VISA" }, - "processed_at": { + "country": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Processed At" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "title": "Updated At" - }, - "highlighted_events": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Highlighted Events" + "title": "Country", + "description": "The country the leakedcredit card was issued in." }, - "main_category": { + "expiration": { "anyOf": [ { "type": "string", - "const": "illicit_networks" - }, - { - "type": "string", - "const": "open_web" - }, - { - "type": "string", - "const": "leak" - }, - { - "type": "string", - "const": "ad" - }, - { - "type": "string", - "const": "domain" - }, - { - "type": "string", - "const": "analytics" + "format": "date-time" }, { - "$ref": "#/components/schemas/OtherSectionType" + "type": "null" } ], - "title": "Main Category" + "title": "Expiration", + "description": "The expiration date of the leaked credit card." }, - "sub_category": { + "owner": { "anyOf": [ { - "$ref": "#/components/schemas/ReportAnalyticSectionType" - }, - { - "$ref": "#/components/schemas/OtherSectionType" + "type": "string" }, { - "$ref": "#/components/schemas/SearchType" + "type": "null" } ], - "title": "Sub Category" - } - }, - "type": "object", - "required": [ - "uid", - "report_id", - "tenant_id", - "content", - "number_of_events_shown", - "image_uri", - "image_html_id", - "enabled", - "visible", - "processed_at", - "updated_at", - "highlighted_events", - "main_category", - "sub_category" - ], - "title": "ReportSectionPayload" - }, - "ReportSectionResponse": { - "properties": { - "report_section": { - "$ref": "#/components/schemas/ReportSectionPayload" - } - }, - "type": "object", - "required": [ - "report_section" - ], - "title": "ReportSectionResponse" - }, - "ReportSectionUpdatePayload": { - "properties": { - "content": { + "title": "Owner", + "description": "The owner of the leaked credit card." + }, + "state_code": { "anyOf": [ { "type": "string" @@ -34644,253 +5571,163 @@ "type": "null" } ], - "title": "Content" + "title": "State Code", + "description": "The state code tied to the leaked credit card." }, - "number_of_events_shown": { + "zip": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Number Of Events Shown" + "title": "Zip", + "description": "The zip code tied to the leaked credit card." }, - "enabled": { + "has_cvv": { "anyOf": [ { "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Enabled" - } - }, - "type": "object", - "title": "ReportSectionUpdatePayload" - }, - "ReportStatus": { - "type": "string", - "enum": [ - "draft", - "processing", - "completed", - "scheduled", - "paused" - ], - "title": "ReportStatus" - }, - "ReportType-Output": { - "type": "string", - "enum": [ - "v1", - "event_based", - "feed_based" - ], - "title": "ReportType" - }, - "ReportUpdatePayload": { - "properties": { - "title": { + }, + { + "type": "null" + } + ], + "title": "Has Cvv", + "description": "Whether the CVV was included in the leaked data." + }, + "has_date_of_birth": { "anyOf": [ { - "type": "string", - "minLength": 1 + "type": "boolean" }, { "type": "null" } ], - "title": "Title" + "title": "Has Date Of Birth", + "description": "Whether the date of birth was included in the leaked data." }, - "author": { + "has_mother_maiden_name": { "anyOf": [ { - "type": "string", - "minLength": 1 + "type": "boolean" }, { "type": "null" } ], - "title": "Author" + "title": "Has Mother Maiden Name", + "description": "Whether the mother's maiden name was included in the leaked data." }, - "report_type": { + "has_phone": { "anyOf": [ { - "$ref": "#/components/schemas/pyro__reports__report_types__ReportType" + "type": "boolean" }, { "type": "null" } - ] - } - }, - "type": "object", - "title": "ReportUpdatePayload" - }, - "RequestSigningAlgorithm": { - "type": "string", - "enum": [ - "rsa-sha256" - ], - "title": "RequestSigningAlgorithm" - }, - "RequestStatus": { - "type": "string", - "enum": [ - "processing", - "completed", - "error" - ], - "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" + ], + "title": "Has Phone", + "description": "Whether the phone number was included in the leaked data." }, - "freemail": { - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/DomainRestrictedTerm" - }, - { - "$ref": "#/components/schemas/KeywordRestrictedTerm" - }, - { - "$ref": "#/components/schemas/PresetRestrictedTerm" - } - ] - }, - "type": "array", - "title": "Freemail" - } - }, - "type": "object", - "required": [ - "restricted", - "noisy", - "freemail" - ], - "title": "RestrictedTerms" - }, - "RevokeSessionsPayload": { - "properties": { - "credential_hash": { - "type": "string", - "title": "Credential Hash" - } - }, - "type": "object", - "required": [ - "credential_hash" - ], - "title": "RevokeSessionsPayload" - }, - "RiskScore": { - "type": "integer", - "enum": [ - 1, - 2, - 3, - 4, - 5 - ], - "title": "RiskScore" - }, - "SAMLConfigurationData-Input": { - "properties": { - "MetadataURL": { + "has_pin": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Metadataurl" + "title": "Has Pin", + "description": "Whether the card's PIN was included in the leaked data." }, - "MetadataFile": { + "has_ssn": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Metadatafile" + "title": "Has Ssn", + "description": "Whether the card owner's SSN was included in the leaked data." }, - "EncryptedResponses": { - "type": "boolean", - "title": "Encryptedresponses", - "default": false + "has_track_1": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Has Track 1", + "description": "Whether the card's track 1 (magnetic stripe data) was included in the leaked data." }, - "RequestSigningAlgorithm": { + "has_vbv": { "anyOf": [ { - "$ref": "#/components/schemas/RequestSigningAlgorithm" + "type": "boolean" }, { "type": "null" } - ] + ], + "title": "Has Vbv", + "description": "Whether the card's VBV (Verified by Visa) data was included in the leaked data." } }, "type": "object", - "title": "SAMLConfigurationData" + "required": [ + "bank", + "bin", + "brand", + "country", + "expiration", + "owner", + "state_code", + "zip", + "has_cvv", + "has_date_of_birth", + "has_mother_maiden_name", + "has_phone", + "has_pin", + "has_ssn", + "has_track_1", + "has_vbv" + ], + "title": "FinancialEventData" }, - "SAMLConfigurationData-Output": { + "ForumPostData": { "properties": { - "MetadataURL": { + "actor": { + "$ref": "#/components/schemas/pyro__findings__forum_posts__datamodels__ForumPostData__Actor", + "description": "Details about the author of the forum post." + }, + "context": { + "$ref": "#/components/schemas/pyro__findings__forum_posts__datamodels__ForumPostData__Context", + "description": "Details about the context of the forum post." + }, + "posted_at": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Metadataurl" + "title": "Posted At", + "description": "Date and time the forum post was made." }, - "MetadataFile": { + "content": { "anyOf": [ { "type": "string" @@ -34899,154 +5736,81 @@ "type": "null" } ], - "title": "Metadatafile" - }, - "EncryptedResponses": { - "type": "boolean", - "title": "Encryptedresponses", - "default": "false" + "title": "Content", + "description": "Content of the forum post." }, - "RequestSigningAlgorithm": { + "url": { "anyOf": [ { - "$ref": "#/components/schemas/RequestSigningAlgorithm" + "type": "string" }, { "type": "null" } - ] - } - }, - "type": "object", - "title": "SAMLConfigurationData" - }, - "SAMLConfigurationMappings": { - "properties": { - "email": { - "type": "string", - "title": "Email" - } - }, - "type": "object", - "required": [ - "email" - ], - "title": "SAMLConfigurationMappings" - }, - "SAMLSSOConfigurationData-Input": { - "properties": { - "is_enabled": { - "type": "boolean", - "title": "Is Enabled" - }, - "is_mandatory": { - "type": "boolean", - "title": "Is Mandatory" - }, - "type": { - "type": "string", - "const": "SAML", - "title": "Type" - }, - "configuration": { - "$ref": "#/components/schemas/SAMLConfigurationData-Input" - }, - "mappings": { - "$ref": "#/components/schemas/SAMLConfigurationMappings" - } - }, - "type": "object", - "required": [ - "is_enabled", - "is_mandatory", - "type", - "configuration", - "mappings" - ], - "title": "SAMLSSOConfigurationData" - }, - "SAMLSSOConfigurationData-Output": { - "properties": { - "is_enabled": { - "type": "boolean", - "title": "Is Enabled" - }, - "is_mandatory": { - "type": "boolean", - "title": "Is Mandatory" - }, - "type": { - "type": "string", - "const": "SAML", - "title": "Type" - }, - "configuration": { - "$ref": "#/components/schemas/SAMLConfigurationData-Output" - }, - "mappings": { - "$ref": "#/components/schemas/SAMLConfigurationMappings" + ], + "title": "Url", + "description": "URL to the forum post." } }, "type": "object", "required": [ - "is_enabled", - "is_mandatory", - "type", - "configuration", - "mappings" + "actor", + "context", + "posted_at", + "content", + "url" ], - "title": "SAMLSSOConfigurationData" + "title": "ForumPostData" }, - "SandboxSampleSubmission": { + "ForumPostEvent": { "properties": { - "uuid": { - "type": "string", - "format": "uuid", - "title": "Uuid" - }, - "tenant_id": { - "type": "integer", - "title": "Tenant Id" - }, - "name": { - "type": "string", - "title": "Name" - }, - "sample_url": { - "type": "string", - "title": "Sample Url" - }, - "type": { - "type": "string", - "title": "Type" - }, - "submitted_by": { + "event_type": { "type": "string", - "title": "Submitted By" - }, - "status": { - "$ref": "#/components/schemas/SandboxSubmissionStatus" + "const": "forum_post", + "title": "Event Type", + "default": "forum_post" }, - "external_submission_id": { - "type": "integer", - "title": "External Submission Id" + "data": { + "$ref": "#/components/schemas/ForumPostData" }, - "external_sample_id": { - "type": "integer", - "title": "External Sample Id" + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + } + }, + "type": "object", + "required": [ + "data", + "metadata" + ], + "title": "Forum Post" + }, + "ForwardInfo": { + "properties": { + "forwarded_from": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Forwarded From", + "description": "The username of the chat message forwarder." }, - "external_job_id": { + "forwarded_from_author_id": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "External Job Id" + "title": "Forwarded From Author Id", + "description": "The ID of the chat message forwarder." }, - "size": { + "forwarded_from_chat_id": { "anyOf": [ { "type": "integer" @@ -35055,67 +5819,22 @@ "type": "null" } ], - "title": "Size" - }, - "submitted_at": { - "type": "string", - "format": "date-time", - "title": "Submitted At" - }, - "sample_report_status": { - "$ref": "#/components/schemas/SandboxSubmissionReportStatus" - }, - "dynamic_report_status": { - "$ref": "#/components/schemas/SandboxSubmissionReportStatus" + "title": "Forwarded From Chat Id", + "description": "The ID of the chat the message is being forwarded from." }, - "verdict": { + "forwarded_from_conversation_id": { "anyOf": [ { - "$ref": "#/components/schemas/SandboxSubmissionVerdict" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Forwarded From Conversation Id", + "description": "The conversation ID the message is being forwarded from." }, - "is_archived": { - "type": "boolean", - "title": "Is Archived" - } - }, - "type": "object", - "required": [ - "uuid", - "tenant_id", - "name", - "sample_url", - "type", - "submitted_by", - "status", - "external_submission_id", - "external_sample_id", - "external_job_id", - "size", - "submitted_at", - "sample_report_status", - "dynamic_report_status", - "verdict", - "is_archived" - ], - "title": "SandboxSampleSubmission" - }, - "SandboxSubmissionReportStatus": { - "type": "string", - "enum": [ - "pending", - "ready", - "error" - ], - "title": "SandboxSubmissionReportStatus" - }, - "SandboxSubmissionResponse": { - "properties": { - "job_id": { + "forwarded_from_user_id": { "anyOf": [ { "type": "integer" @@ -35124,9 +5843,10 @@ "type": "null" } ], - "title": "Job Id" + "title": "Forwarded From User Id", + "description": "The ID of the user the message is being forwarded from." }, - "job_status": { + "forwarded_from_username": { "anyOf": [ { "type": "string" @@ -35135,229 +5855,179 @@ "type": "null" } ], - "title": "Job Status" + "title": "Forwarded From Username", + "description": "The username of the user the message is being forwarded from." + }, + "forwarded_message_time": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Forwarded Message Time", + "description": "The time the message was forwarded." } }, "type": "object", - "required": [ - "job_id", - "job_status" - ], - "title": "SandboxSubmissionResponse" - }, - "SandboxSubmissionStatus": { - "type": "string", - "enum": [ - "warning", - "in_progress", - "queued", - "success", - "temporary_error", - "error" - ], - "title": "SandboxSubmissionStatus" - }, - "SandboxSubmissionVerdict": { - "type": "string", - "enum": [ - "clean", - "malicious", - "suspicious", - "pending", - "temporary_error", - "error", - "not_applicable" - ], - "title": "SandboxSubmissionVerdict" + "title": "ForwardInfo" }, - "SandboxUploadUrlResponse": { + "GithubRepositoryData": { "properties": { - "upload_url": { + "type": { "type": "string", - "title": "Upload Url" + "const": "github_repository", + "title": "Type", + "default": "github_repository" }, - "upload_fields": { - "additionalProperties": true, - "type": "object", - "title": "Upload Fields" + "repo_name": { + "type": "string", + "minLength": 1, + "title": "Repo Name" + }, + "repo_owner": { + "type": "string", + "minLength": 1, + "title": "Repo Owner" } }, "type": "object", "required": [ - "upload_url", - "upload_fields" + "repo_name", + "repo_owner" ], - "title": "SandboxUploadUrlResponse" + "title": "GithubRepositoryData" }, - "SandboxVNCUrlResponse": { + "GithubRepositoryQuery": { "properties": { - "vnc_url": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Vnc Url" + "type": { + "type": "string", + "const": "github_repository", + "title": "Type" + }, + "repo_owner": { + "type": "string", + "title": "Repo Owner" }, - "job_status": { + "repo_name": { "type": "string", - "title": "Job Status" + "title": "Repo Name" } }, "type": "object", "required": [ - "vnc_url", - "job_status" + "type", + "repo_owner", + "repo_name" ], - "title": "SandboxVNCUrlResponse" - }, - "Scope": { - "type": "string", - "enum": [ - "firework", - "leaksdb", - "astp-credentials", - "astp-cookies", - "astp-show-passwords", - "ioc-feeds", - "do-not-track", - "admin", - "ratelimited", - "bypass-mfa", - "search-unrestricted", - "private-endpoints", - "impersonation" - ], - "title": "Scope" - }, - "ScreenshotHashType": { - "type": "string", - "enum": [ - "average_hash", - "phash", - "phash_simple", - "whash", - "dhash", - "mmh3" - ], - "title": "ScreenshotHashType" + "title": "GithubRepositoryQuery" }, - "ScreenshotInfo": { + "GlobalFeedItem": { "properties": { - "asset_hash": { - "type": "string", - "title": "Asset Hash" + "metadata": { + "$ref": "#/components/schemas/FeedItemMetadata" + }, + "tenant_metadata": { + "$ref": "#/components/schemas/FeedItemTenantMetadata" }, - "hashes": { + "highlights": { "additionalProperties": { - "type": "string" - }, - "propertyNames": { - "$ref": "#/components/schemas/ScreenshotHashType" + "items": { + "type": "string" + }, + "type": "array" }, "type": "object", - "title": "Hashes" + "title": "Highlights" } }, "type": "object", "required": [ - "asset_hash", - "hashes" + "metadata" ], - "title": "ScreenshotInfo" + "title": "GlobalFeedItem" }, - "SearchQueryAllowedRequest": { + "GlobalSearchRequestBody": { "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": [ + "query": { + "oneOf": [ { - "type": "string" + "$ref": "#/components/schemas/GithubRepositoryQuery" }, { - "type": "null" - } - ], - "title": "Ip" - }, - "user_agent": { - "anyOf": [ + "$ref": "#/components/schemas/UsernameQuery" + }, { - "type": "string" + "$ref": "#/components/schemas/DomainQuery" }, { - "type": "null" + "$ref": "#/components/schemas/BrandQuery" + }, + { + "$ref": "#/components/schemas/NameQuery" + }, + { + "$ref": "#/components/schemas/KeywordQuery" + }, + { + "$ref": "#/components/schemas/QueryStringQuery" + }, + { + "$ref": "#/components/schemas/BinQuery" + }, + { + "$ref": "#/components/schemas/IpQuery" + }, + { + "$ref": "#/components/schemas/EmailQuery" + }, + { + "$ref": "#/components/schemas/SecretQuery" + }, + { + "$ref": "#/components/schemas/CredentialsQuery" + }, + { + "$ref": "#/components/schemas/AzureTenantQuery" + } + ], + "title": "Query", + "examples": [ + { + "fqdn": "test.com", + "type": "domain" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "azure_tenant": "#/components/schemas/AzureTenantQuery", + "bin": "#/components/schemas/BinQuery", + "brand": "#/components/schemas/BrandQuery", + "credentials": "#/components/schemas/CredentialsQuery", + "domain": "#/components/schemas/DomainQuery", + "email": "#/components/schemas/EmailQuery", + "github_repository": "#/components/schemas/GithubRepositoryQuery", + "ip": "#/components/schemas/IpQuery", + "keyword": "#/components/schemas/KeywordQuery", + "name": "#/components/schemas/NameQuery", + "query_string": "#/components/schemas/QueryStringQuery", + "secret": "#/components/schemas/SecretQuery", + "username": "#/components/schemas/UsernameQuery" } - ], - "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" + "filters": { + "$ref": "#/components/schemas/FeedFilters" + }, + "order": { + "$ref": "#/components/schemas/FeedOrder", + "default": "desc" }, - "restricted_term": { + "from": { "anyOf": [ { "type": "string" @@ -35366,73 +6036,49 @@ "type": "null" } ], - "title": "Restricted Term" + "title": "From" + }, + "size": { + "type": "integer", + "maximum": 10.0, + "exclusiveMinimum": 0.0, + "title": "Size", + "default": 10 } }, "type": "object", "required": [ - "is_allowed", - "restricted_term" + "query" ], - "title": "SearchQueryAllowedResponse" + "title": "GlobalSearchRequestBody" }, - "SearchQueryData": { + "HTTPValidationError": { "properties": { - "type": { - "type": "string", - "const": "search_query", - "title": "Type", - "default": "search_query" - }, - "search_query": { - "type": "string", - "minLength": 1, - "title": "Search Query" + "detail": { + "items": { + "$ref": "#/components/schemas/ValidationError" + }, + "type": "array", + "title": "Detail" } }, "type": "object", - "required": [ - "search_query" + "title": "HTTPValidationError" + }, + "HubspotLifecycleStage": { + "type": "string", + "enum": [ + "1281177943" ], - "title": "SearchQueryData" + "title": "HubspotLifecycleStage" }, - "SearchTermsAllowedRequest": { + "HubspotWebhookFlareSyncEvent": { "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": { + "hubspot_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" + "title": "Hubspot Id" }, - "ip": { + "domain": { "anyOf": [ { "type": "string" @@ -35441,9 +6087,9 @@ "type": "null" } ], - "title": "Ip" + "title": "Domain" }, - "user_agent": { + "name": { "anyOf": [ { "type": "string" @@ -35452,363 +6098,66 @@ "type": "null" } ], - "title": "User Agent" + "title": "Name" }, - "flare_referer": { + "organization_id": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "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": "SearchTermsAllowedRequest" - }, - "SearchType": { - "type": "string", - "enum": [ - "attachment", - "listing", - "ransomleak", - "forum_post", - "forum_topic", - "forum_profile", - "blog_post", - "seller", - "paste", - "leak", - "chat_message", - "domain", - "bot", - "stealer_log", - "infected_devices", - "driller", - "driller_forum_topic", - "driller_forum_post", - "driller_profile", - "cc", - "ccbin", - "financial_data", - "leaked_data", - "leaked_file", - "document", - "account", - "actor", - "forum_content", - "blog_content", - "profile", - "leaked_credential", - "valid_credential", - "invalid_credential", - "mitigated_credential", - "illicit_networks", - "open_web", - "domains", - "intelligence_object", - "leaks", - "social_media_account", - "social_media", - "source_code", - "source_code_secrets_np", - "source_code_secrets", - "source_code_files", - "docker", - "stack_exchange", - "google", - "service", - "driller_host", - "buckets", - "bucket", - "bucket_object", - "whois", - "ad", - "ads", - "cookie", - "pii", - "experimental" - ], - "title": "SearchType" - }, - "SecretData": { - "properties": { - "type": { - "type": "string", - "const": "secret", - "title": "Type", - "default": "secret" - }, - "secret": { - "type": "string", - "minLength": 1, - "title": "Secret" - } - }, - "type": "object", - "required": [ - "secret" - ], - "title": "SecretData" - }, - "SecretDetectionRule": { - "type": "string", - "enum": [ - "adafruit_io_key", - "adobe_oauth_client_secret", - "age_recipient_x25519_public_key", - "age_identity_x22519_secret_key", - "anthropic_api_key", - "aws_appsync_api_key", - "amazon_resource_name", - "artifactory_api_key", - "auth0_application_credentials", - "aws_api_key", - "aws_secret_access_key", - "aws_account_id", - "aws_session_token", - "amazon_mws_auth_token", - "aws_api_credentials", - "azure_connection_string", - "azure_app_configuration_connection_string", - "azure_personal_access_token", - "bitbucket_app_password", - "blynk_device_access_token", - "blynk_organization_access_token", - "blynk_organization_client_credentials", - "codeclimate_reporter_id", - "crates_io_api_key", - "databricks_personal_access_token", - "digitalocean_application_access_token", - "digitalocean_personal_access_token", - "digitalocean_refresh_token", - "django_secret_key", - "docker_hub_personal_access_token", - "doppler_cli_token", - "doppler_personal_token", - "doppler_service_token", - "doppler_service_account_token", - "doppler_scim_token", - "doppler_audit_token", - "dropbox_access_token", - "dependency_track_api_key", - "dynatrace_token", - "facebook_secret_key", - "facebook_access_token", - "figma_personal_access_token", - "firecrawl_api_key", - "google_cloud_storage_bucket", - "generic_secret", - "connection_string_in_net_configuration", - "generic_password", - "generic_username_and_password", - "generic_api_key", - "credentials_in_net_system_net_networkcredential", - "credentials_in_net_system_directoryservices_directoryentry", - "sensitive_value_in_net_configuration", - "gitalk_oauth_credentials", - "github_personal_access_token", - "github_oauth_access_token", - "github_app_token", - "github_refresh_token", - "github_client_id", - "github_secret_key", - "gitlab_runner_registration_token", - "gitlab_personal_access_token", - "gitlab_pipeline_trigger_token", - "google_client_id", - "google_oauth_client_secret", - "google_oauth_access_token", - "google_api_key", - "google_oauth_credentials", - "hardcoded_gradle_credentials", - "grafana_api_token", - "grafana_cloud_api_token", - "grafana_service_account_token", - "groq_api_key", - "hashicorp_vault_service_token", - "hashicorp_vault_batch_token", - "hashicorp_vault_recovery_token", - "hashicorp_vault_unseal_key", - "heroku_api_key", - "http_basic_authentication", - "http_bearer_token", - "huggingface_user_access_token", - "jenkins_token_or_crumb", - "jenkins_setup_admin_password", - "jina_search_foundation_api_key", - "json_web_token_secret", - "kagi_api_key", - "password_hash_kerberos", - "kubernetes_bootstrap_token", - "linkedin_client_id", - "linkedin_secret_key", - "mailchimp_api_key", - "mailgun_api_key", - "mapbox_public_access_token", - "mapbox_secret_access_token", - "mapbox_temporary_access_token", - "credentials_in_mongodb_connection_string", - "microsoft_teams_webhook", - "netrc_credentials", - "new_relic_license_key", - "new_relic_api_service_key", - "new_relic_admin_api_key", - "new_relic_insights_insert_key", - "new_relic_insights_query_key", - "new_relic_rest_api_key", - "new_relic_pixie_api_key", - "new_relic_pixie_deploy_key", - "npm_access_token", - "nuget_api_key", - "credentials_in_odbc_connection_string", - "okta_api_token", - "openai_api_key", - "particle_io_access_token", - "pem_encoded_private_key", - "phpmailer_credentials", - "credentials_in_postgresql_connection_uri", - "postman_api_key", - "postmark_api_token", - "credentials_in_psexec_invocation", - "password_hash_md5crypt", - "password_hash_bcrypt", - "password_hash_sha256crypt", - "password_hash_sha512crypt", - "password_hash_cisco_ios_pbkdf2_with_sha256", - "pypi_upload_token", - "react_app_username", - "react_app_password", - "rubygems_api_key", - "aws_s3_bucket", - "salesforce_access_token", - "sauce_token", - "segment_public_api_token", - "sendgrid_api_key", - "shopify_domain", - "shopify_app_secret", - "shopify_access_token", - "slack_bot_token", - "slack_webhook", - "slack_user_token", - "slack_app_token", - "slack_legacy_bot_token", - "sonarqube_token", - "sourcegraph_access_token", - "square_access_token", - "square_oauth_secret", - "stackhawk_api_key", - "stripe_api_key", - "stripe_api_test_key", - "tavily_api_key", - "teamcity_api_token", - "telegram_bot_token", - "thingsboard_access_token", - "thingsboard_provision_device_key", - "thingsboard_provision_device_secret", - "truenas_api_key_websocket", - "truenas_api_key_rest_api", - "twilio_api_key", - "twitter_client_id", - "twitter_secret_key", - "credentials_in_connect_viserver_invocation", - "wireguard_private_key", - "wireguard_preshared_key" - ], - "title": "SecretDetectionRule" - }, - "SecretItem": { - "properties": { - "type": { - "$ref": "#/components/schemas/SecretDetectionRule" + "title": "Organization Id" }, - "content": { - "type": "string", - "title": "Content" + "lifecycle_stage": { + "anyOf": [ + { + "$ref": "#/components/schemas/HubspotLifecycleStage" + }, + { + "type": "null" + } + ] }, - "extracted_secrets": { + "merged_object_ids": { "items": { - "type": "string" + "type": "integer" }, "type": "array", - "title": "Extracted Secrets" - }, - "position": { - "$ref": "#/components/schemas/SecretPosition" - } - }, - "type": "object", - "required": [ - "type", - "content", - "position" - ], - "title": "SecretItem" - }, - "SecretPosition": { - "properties": { - "start_line": { - "type": "integer", - "title": "Start Line" - }, - "start_column": { - "type": "integer", - "title": "Start Column" - }, - "end_line": { - "type": "integer", - "title": "End Line" - }, - "end_column": { - "type": "integer", - "title": "End Column" - } - }, - "type": "object", - "required": [ - "start_line", - "start_column", - "end_line", - "end_column" - ], - "title": "SecretPosition" - }, - "SecretQuery": { - "properties": { - "type": { - "type": "string", - "const": "secret", - "title": "Type" - }, - "secret": { - "type": "string", - "title": "Secret" + "title": "Merged Object Ids", + "default": [] } }, "type": "object", "required": [ - "type", - "secret" + "hubspot_id" ], - "title": "SecretQuery" + "title": "HubspotWebhookFlareSyncEvent" }, - "SetBannerPayload": { + "HubspotWebhookFlareSyncTenantEvent": { "properties": { + "hubspot_company_id": { + "type": "integer", + "title": "Hubspot Company Id" + }, + "hubspot_tenant_id": { + "type": "integer", + "title": "Hubspot Tenant Id" + }, + "merged_object_ids": { + "items": { + "type": "integer" + }, + "type": "array", + "title": "Merged Object Ids", + "default": [] + }, + "flare_tenant_name": { + "type": "string", + "title": "Flare Tenant Name" + }, "organization_id": { "anyOf": [ { @@ -35830,140 +6179,282 @@ } ], "title": "Tenant Id" - }, - "message": { - "type": "string", - "title": "Message" - }, - "variant": { - "$ref": "#/components/schemas/BannerVariant" } }, "type": "object", "required": [ - "message", - "variant" - ], - "title": "SetBannerPayload" - }, - "Severity": { - "type": "string", - "enum": [ - "info", - "low", - "medium", - "high", - "critical" + "hubspot_company_id", + "hubspot_tenant_id", + "flare_tenant_name" ], - "title": "Severity" + "title": "HubspotWebhookFlareSyncTenantEvent" }, - "SigningCertificateResponse": { + "IPData": { "properties": { - "signing_certificate": { + "type": { + "type": "string", + "const": "ip", + "title": "Type", + "default": "ip" + }, + "ip": { "type": "string", - "title": "Signing Certificate" + "minLength": 1, + "title": "Ip" } }, "type": "object", "required": [ - "signing_certificate" - ], - "title": "SigningCertificateResponse" - }, - "SignupIntent": { - "type": "string", - "enum": [ - "identity_exposure_management", - "brand_protection", - "dark_web_monitoring", - "attack_surface_management", - "other" + "ip" ], - "title": "SignupIntent" + "title": "IPData" }, - "SocialMediaEvent": { + "Identifier": { "properties": { - "event_type": { + "id": { + "type": "integer", + "title": "Id" + }, + "name": { "type": "string", - "const": "social_media_account", - "title": "Event Type", - "default": "social_media_account" + "title": "Name" + }, + "tenant_id": { + "type": "integer", + "title": "Tenant Id" + }, + "type": { + "$ref": "#/components/schemas/IdentifierType" + }, + "feed": { + "$ref": "#/components/schemas/IdentifierFeed" + }, + "feed_config": { + "$ref": "#/components/schemas/FeedConfiguration" + }, + "asset_uuid": { + "type": "string", + "title": "Asset Uuid" }, "data": { - "$ref": "#/components/schemas/SocialMediaEventData" + "oneOf": [ + { + "$ref": "#/components/schemas/CCBinData" + }, + { + "$ref": "#/components/schemas/IPData" + }, + { + "$ref": "#/components/schemas/BrandData" + }, + { + "$ref": "#/components/schemas/KeywordData" + }, + { + "$ref": "#/components/schemas/AzureTenantData" + }, + { + "$ref": "#/components/schemas/DomainData" + }, + { + "$ref": "#/components/schemas/NameData" + }, + { + "$ref": "#/components/schemas/SearchQueryData" + }, + { + "$ref": "#/components/schemas/GithubRepositoryData" + }, + { + "$ref": "#/components/schemas/UsernameData" + }, + { + "$ref": "#/components/schemas/EmailData" + }, + { + "$ref": "#/components/schemas/SecretData" + }, + { + "$ref": "#/components/schemas/CredentialsData" + }, + { + "$ref": "#/components/schemas/IdentityData" + }, + { + "$ref": "#/components/schemas/RansomLeakData" + }, + { + "$ref": "#/components/schemas/AddressData" + }, + { + "$ref": "#/components/schemas/BirthYearData" + }, + { + "$ref": "#/components/schemas/RoleData" + }, + { + "$ref": "#/components/schemas/PhoneNumberData" + }, + { + "$ref": "#/components/schemas/ExternalIdData" + } + ], + "title": "Data", + "discriminator": { + "propertyName": "type", + "mapping": { + "address_data": "#/components/schemas/AddressData", + "azure_tenant": "#/components/schemas/AzureTenantData", + "bin": "#/components/schemas/CCBinData", + "birth_year": "#/components/schemas/BirthYearData", + "brand": "#/components/schemas/BrandData", + "credentials": "#/components/schemas/CredentialsData", + "domain": "#/components/schemas/DomainData", + "email": "#/components/schemas/EmailData", + "external_id": "#/components/schemas/ExternalIdData", + "github_repository": "#/components/schemas/GithubRepositoryData", + "identity": "#/components/schemas/IdentityData", + "ip": "#/components/schemas/IPData", + "keyword": "#/components/schemas/KeywordData", + "name": "#/components/schemas/NameData", + "phone_number": "#/components/schemas/PhoneNumberData", + "ransomleak": "#/components/schemas/RansomLeakData", + "role": "#/components/schemas/RoleData", + "search_query": "#/components/schemas/SearchQueryData", + "secret": "#/components/schemas/SecretData", + "username": "#/components/schemas/UsernameData" + } + } }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" - } - }, - "type": "object", - "required": [ - "data", - "metadata" - ], - "title": "Social Media Account" - }, - "SocialMediaEventData": { - "properties": { - "url": { + "collection": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/IdentifierCollectionGroupId" }, { - "type": "null" + "$ref": "#/components/schemas/IdentifierCollectionGroupType" } ], - "title": "Url", - "description": "The URL to the profile page of the social media account." + "title": "Collection" }, - "site": { + "urn": { + "type": "string", + "title": "Urn" + }, + "entity": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/IdentityIdentifierEntity" + }, + { + "type": "null" + } + ] + }, + "enrichments": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/DomainAssetEnrichment" + }, + "type": "array" }, { "type": "null" } ], - "title": "Site", - "description": "The name of the platform where the account was found." + "title": "Enrichments" + }, + "metadata": { + "$ref": "#/components/schemas/IdentifierMetadata" + }, + "state": { + "$ref": "#/components/schemas/IdentifierState" + } + }, + "type": "object", + "required": [ + "id", + "name", + "tenant_id", + "type", + "feed", + "feed_config", + "asset_uuid", + "data", + "collection", + "urn", + "entity", + "enrichments", + "metadata", + "state" + ], + "title": "Identifier" + }, + "IdentifierAuthorizationRequestStatus": { + "type": "string", + "enum": [ + "pending", + "rejected" + ], + "title": "IdentifierAuthorizationRequestStatus" + }, + "IdentifierAuthorizationStatus": { + "type": "string", + "enum": [ + "pending", + "rejected", + "authorized" + ], + "title": "IdentifierAuthorizationStatus" + }, + "IdentifierCollectionGroupId": { + "properties": { + "type": { + "type": "string", + "const": "group_id", + "title": "Type" }, - "username": { + "group_id": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Username", - "description": "The username of the account that was found." + "title": "Group Id" } }, "type": "object", - "title": "SocialMediaEventData" + "required": [ + "type", + "group_id" + ], + "title": "IdentifierCollectionGroupId" }, - "Source": { + "IdentifierCollectionGroupType": { "properties": { - "sphere": { - "type": "string", - "title": "Sphere" - }, - "title": { - "type": "string", - "title": "Title" - }, - "category": { - "type": "string", - "title": "Category" - }, - "category_v2": { + "type": { "type": "string", - "title": "Category V2" + "const": "group_type", + "title": "Type" }, - "crawled_since": { + "group_type": { + "$ref": "#/components/schemas/IdentifierGroupType" + } + }, + "type": "object", + "required": [ + "type", + "group_type" + ], + "title": "IdentifierCollectionGroupType" + }, + "IdentifierEnrichments": { + "properties": { + "domain_reachable_at": { "anyOf": [ { "type": "string", @@ -35973,9 +6464,9 @@ "type": "null" } ], - "title": "Crawled Since" + "title": "Domain Reachable At" }, - "last_updated_at": { + "domain_resolves_at": { "anyOf": [ { "type": "string", @@ -35985,10 +6476,11 @@ "type": "null" } ], - "title": "Last Updated At" + "title": "Domain Resolves At" }, - "status": { - "$ref": "#/components/schemas/SourceStatusV2" + "usage_count": { + "type": "integer", + "title": "Usage Count" }, "event_count": { "anyOf": [ @@ -36001,386 +6493,304 @@ ], "title": "Event Count" }, - "total_event_count": { + "authorization_status": { "anyOf": [ { - "type": "integer" + "$ref": "#/components/schemas/IdentifierAuthorizationStatus" }, { "type": "null" } ], - "title": "Total Event Count" - }, - "is_new": { - "type": "boolean", - "title": "Is New" - }, - "crawling_frequency": { - "$ref": "#/components/schemas/CrawlingFrequency" + "examples": [ + "authorized", + "pending", + "rejected" + ] } }, "type": "object", "required": [ - "sphere", - "title", - "category", - "category_v2", - "crawled_since", - "last_updated_at", - "status", + "domain_reachable_at", + "domain_resolves_at", + "usage_count", "event_count", - "total_event_count", - "is_new", - "crawling_frequency" + "authorization_status" ], - "title": "Source" + "title": "IdentifierEnrichments" }, - "SourceCategoryV2": { + "IdentifierEntityType": { "type": "string", "enum": [ - "Stealer Logs", - "Leaked Credentials", - "Forums", - "Imageboards", - "Messaging Apps", - "Darkweb Rooms", - "Ransomware", - "Financial Data", - "Infected Devices", - "Listings", - "Blogs", - "Doxing", - "Defacement", - "Pastes", - "Open Web" - ], - "title": "SourceCategoryV2" + "identity" + ], + "title": "IdentifierEntityType" }, - "SourceCountByStatus": { + "IdentifierFeed": { "properties": { - "total_count": { + "id": { "type": "integer", - "title": "Total Count" + "title": "Id" }, - "new_count": { + "owner_id": { "type": "integer", - "title": "New Count" + "title": "Owner Id" + } + }, + "type": "object", + "required": [ + "id", + "owner_id" + ], + "title": "IdentifierFeed" + }, + "IdentifierFeedRateLimit": { + "properties": { + "activity_type": { + "type": "string", + "title": "Activity Type" }, - "offline_count": { - "type": "integer", - "title": "Offline Count" + "first_rate_limited_at": { + "type": "string", + "format": "date-time", + "title": "First Rate Limited At" }, - "defunct_count": { - "type": "integer", - "title": "Defunct Count" + "last_rate_limited_at": { + "type": "string", + "format": "date-time", + "title": "Last Rate Limited At" } }, "type": "object", "required": [ - "total_count", - "new_count", - "offline_count", - "defunct_count" + "activity_type", + "first_rate_limited_at", + "last_rate_limited_at" ], - "title": "SourceCountByStatus" + "title": "IdentifierFeedRateLimit" }, - "SourceCountByStatusParams": { + "IdentifierFeedRateLimits": { "properties": { - "date_range": { - "$ref": "#/components/schemas/DateRangeType", - "default": "last_1m" + "first_rate_limited_at": { + "type": "string", + "format": "date-time", + "title": "First Rate Limited At" + }, + "last_rate_limited_at": { + "type": "string", + "format": "date-time", + "title": "Last Rate Limited At" + }, + "activity_types": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Activity Types" + }, + "items": { + "items": { + "$ref": "#/components/schemas/IdentifierFeedRateLimit" + }, + "type": "array", + "title": "Items" } }, "type": "object", - "title": "SourceCountByStatusParams" + "required": [ + "first_rate_limited_at", + "last_rate_limited_at", + "activity_types", + "items" + ], + "title": "IdentifierFeedRateLimits" + }, + "IdentifierGroupType": { + "type": "string", + "enum": [ + "person", + "corporate_identities" + ], + "title": "IdentifierGroupType" }, - "SourceCountByYear": { + "IdentifierMatchingPolicyBody": { "properties": { - "year": { - "type": "integer", - "title": "Year" + "matching_policy_uuid": { + "type": "string", + "format": "uuid", + "title": "Matching Policy Uuid" }, - "count": { - "type": "integer", - "title": "Count" + "clean_past_events": { + "type": "boolean", + "title": "Clean Past Events", + "description": "Determines whether or not this policy should be applied to events that have already matched this identifier.", + "default": false } }, "type": "object", "required": [ - "year", - "count" + "matching_policy_uuid" ], - "title": "SourceCountByYear" + "title": "IdentifierMatchingPolicyBody" }, - "SourceCountByYearParams": { + "IdentifierMetadata": { "properties": { - "start_year": { - "type": "integer", - "title": "Start Year" + "critical": { + "type": "boolean", + "title": "Critical" + }, + "is_disabled": { + "type": "boolean", + "title": "Is Disabled" } }, "type": "object", "required": [ - "start_year" + "critical", + "is_disabled" ], - "title": "SourceCountByYearParams" + "title": "IdentifierMetadata" }, - "SourceFilterByDateRange": { + "IdentifierOrderBy": { "type": "string", "enum": [ - "crawled_since", - "last_updated_at" + "id", + "name", + "type" ], - "title": "SourceFilterByDateRange" + "title": "IdentifierOrderBy" }, - "SourceHistogramParams": { + "IdentifierRecommendationAction": { "properties": { - "date_range": { - "$ref": "#/components/schemas/DateRangeType" - }, - "timezone": { - "type": "string", - "title": "Timezone", - "default": "America/New_York" + "type": { + "$ref": "#/components/schemas/IdentifierRecommendationActionType" } }, "type": "object", "required": [ - "date_range" + "type" ], - "title": "SourceHistogramParams" + "title": "IdentifierRecommendationAction" }, - "SourceListParams": { + "IdentifierRecommendationActionTarget": { "properties": { - "from": { - "type": "integer", - "title": "From", - "default": 0 - }, - "size": { + "id": { "type": "integer", - "title": "Size", - "default": 15 - }, - "order_by": { - "$ref": "#/components/schemas/SourceOrderBy", - "default": "title" - }, - "order_type": { - "$ref": "#/components/schemas/OrderType", - "default": "asc" - }, - "q": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Q" - }, - "categories": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/SourceCategoryV2" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Categories" - }, - "status": { - "anyOf": [ - { - "$ref": "#/components/schemas/SourceStatusV2" - }, - { - "type": "null" - } - ] - }, - "date_range": { - "$ref": "#/components/schemas/DateRangeType", - "default": "last_1m" - }, - "filter_by_date_range": { - "anyOf": [ - { - "$ref": "#/components/schemas/SourceFilterByDateRange" - }, - { - "type": "null" - } - ] + "title": "Id" } }, "type": "object", - "title": "SourceListParams" - }, - "SourceOrderBy": { - "type": "string", - "enum": [ - "title", - "category_v2", - "status", - "crawled_since", - "last_updated_at", - "event_count", - "total_event_count" + "required": [ + "id" ], - "title": "SourceOrderBy" + "title": "IdentifierRecommendationActionTarget" }, - "SourceStatusV2": { + "IdentifierRecommendationActionType": { "type": "string", "enum": [ - "inactive", - "active", - "degraded", - "offline", - "defunct" + "accept", + "reject" ], - "title": "SourceStatusV2" + "title": "IdentifierRecommendationActionType" }, - "SourceSummary": { + "IdentifierRecommendationActionsBody": { "properties": { - "is_defunct": { - "type": "boolean", - "title": "Is Defunct" + "targets": { + "items": { + "$ref": "#/components/schemas/IdentifierRecommendationActionTarget" + }, + "type": "array", + "maxItems": 100, + "title": "Targets" + }, + "action": { + "$ref": "#/components/schemas/IdentifierRecommendationAction" } }, "type": "object", "required": [ - "is_defunct" + "action" ], - "title": "SourceSummary" + "title": "IdentifierRecommendationActionsBody" }, - "SourceV2": { + "IdentifierRecommendationState": { + "type": "string", + "enum": [ + "recommended", + "accepted", + "rejected" + ], + "title": "IdentifierRecommendationState" + }, + "IdentifierRequestBody": { "properties": { - "id": { - "type": "string", - "title": "Id" - }, - "name": { - "anyOf": [ + "data": { + "oneOf": [ { - "type": "string" + "$ref": "#/components/schemas/CCBinData" }, { - "type": "null" - } - ], - "title": "Name" - }, - "description_en": { - "anyOf": [ + "$ref": "#/components/schemas/IPData" + }, { - "type": "string" + "$ref": "#/components/schemas/BrandData" }, { - "type": "null" - } - ], - "title": "Description En" - }, - "description_fr": { - "anyOf": [ + "$ref": "#/components/schemas/KeywordData" + }, { - "type": "string" + "$ref": "#/components/schemas/AzureTenantData" }, { - "type": "null" - } - ], - "title": "Description Fr" - }, - "breached_at": { - "anyOf": [ + "$ref": "#/components/schemas/DomainData" + }, { - "type": "string" + "$ref": "#/components/schemas/SearchQueryData" }, { - "type": "null" - } - ], - "title": "Breached At" - }, - "leaked_at": { - "anyOf": [ + "$ref": "#/components/schemas/GithubRepositoryData" + }, { - "type": "string" + "$ref": "#/components/schemas/CredentialsData" }, { - "type": "null" - } - ], - "title": "Leaked At" - }, - "is_alert_enabled": { - "type": "boolean", - "title": "Is Alert Enabled" - }, - "pii_tags": { - "anyOf": [ + "$ref": "#/components/schemas/EmailData" + }, { - "items": { - "type": "string" - }, - "type": "array" + "$ref": "#/components/schemas/UsernameData" }, { - "type": "null" - } - ], - "title": "Pii Tags" - }, - "url": { - "anyOf": [ + "$ref": "#/components/schemas/SecretData" + }, { - "type": "string" + "$ref": "#/components/schemas/NameData" }, { - "type": "null" + "$ref": "#/components/schemas/IdentityDataRequestBody" } ], - "title": "Url" - } - }, - "type": "object", - "required": [ - "id", - "name", - "description_en", - "description_fr", - "breached_at", - "leaked_at", - "is_alert_enabled", - "pii_tags", - "url" - ], - "title": "SourceV2" - }, - "SourceWithTenantCount": { - "properties": { - "id": { - "type": "string", - "title": "Id" - }, - "count": { - "type": "integer", - "title": "Count" + "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/IdentityDataRequestBody", + "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" + } + } }, "name": { - "type": "string", - "title": "Name" - }, - "description": { "anyOf": [ { "type": "string" @@ -36389,37 +6799,30 @@ "type": "null" } ], - "title": "Description" + "title": "Name" }, - "leaked_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Leaked At" + "feed_config": { + "$ref": "#/components/schemas/FeedConfiguration" }, - "breached_at": { + "collection": { "anyOf": [ { - "type": "string", - "format": "date-time" + "$ref": "#/components/schemas/IdentifierCollectionGroupId" }, { - "type": "null" + "$ref": "#/components/schemas/IdentifierCollectionGroupType" } ], - "title": "Breached At" + "title": "Collection" }, - "pii_tags": { + "metadata": { + "$ref": "#/components/schemas/IdentifierMetadata" + }, + "matching_policies": { "anyOf": [ { "items": { - "type": "string" + "$ref": "#/components/schemas/IdentifierMatchingPolicyBody" }, "type": "array" }, @@ -36427,122 +6830,37 @@ "type": "null" } ], - "title": "Pii Tags" - }, - "domain": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Domain" - }, - "is_test": { - "type": "boolean", - "title": "Is Test" - }, - "is_verified": { - "type": "boolean", - "title": "Is Verified" - }, - "has_credentials": { - "type": "boolean", - "title": "Has Credentials" - }, - "has_pii": { - "type": "boolean", - "title": "Has Pii" - }, - "is_unparsed_breach": { - "type": "boolean", - "title": "Is Unparsed Breach" + "title": "Matching Policies" } }, "type": "object", "required": [ - "id", - "count", + "data", "name", - "description", - "leaked_at", - "breached_at", - "pii_tags", - "domain", - "is_test", - "is_verified", - "has_credentials", - "has_pii", - "is_unparsed_breach" - ], - "title": "SourceWithTenantCount" - }, - "SourcesCategoriesStats": { - "properties": { - "categories": { - "items": { - "$ref": "#/components/schemas/SourceCategoryV2" - }, - "type": "array", - "title": "Categories", - "default": [] - }, - "date_range": { - "$ref": "#/components/schemas/DateRangeType" - } - }, - "type": "object", - "required": [ - "date_range" - ], - "title": "SourcesCategoriesStats" - }, - "StatsAggregates": { - "type": "string", - "enum": [ - "daily", - "weekly", - "monthly", - "yearly" + "feed_config", + "collection", + "metadata" ], - "title": "StatsAggregates" + "title": "IdentifierRequestBody" }, - "StealerLogActions": { + "IdentifierResponse": { "properties": { - "can_reveal_full_contents": { - "type": "boolean", - "title": "Can Reveal Full Contents" - }, - "can_download_files": { - "type": "boolean", - "title": "Can Download Files" + "identifier": { + "anyOf": [ + { + "$ref": "#/components/schemas/Identifier" + }, + { + "type": "null" + } + ] }, - "can_display_pii_tags": { + "is_materialized": { "type": "boolean", - "title": "Can Display Pii Tags" - } - }, - "type": "object", - "required": [ - "can_reveal_full_contents", - "can_download_files", - "can_display_pii_tags" - ], - "title": "StealerLogActions" - }, - "StealerLogCookie": { - "properties": { - "host_key": { - "type": "string", - "title": "Host Key" - }, - "path": { - "type": "string", - "title": "Path" + "title": "Is Materialized", + "default": false }, - "expires_utc": { + "created_at": { "anyOf": [ { "type": "string", @@ -36552,656 +6870,445 @@ "type": "null" } ], - "title": "Expires Utc" + "title": "Created At" }, + "last_updated_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Updated At" + } + }, + "type": "object", + "title": "IdentifierResponse" + }, + "IdentifierScope": { + "properties": { "name": { "type": "string", "title": "Name" }, - "value": { - "type": "string", - "title": "Value" + "is_disabled": { + "type": "boolean", + "title": "Is Disabled", + "default": false } }, "type": "object", "required": [ - "host_key", - "path", - "expires_utc", - "name", - "value" + "name" ], - "title": "StealerLogCookie" + "title": "IdentifierScope" }, - "StealerLogCookieExpiration": { + "IdentifierSource": { "type": "string", "enum": [ - "all", - "expired", - "active" + "USER", + "SYSTEM_RELATION", + "SELF_ONBOARDING", + "ATTRIBUTE", + "AUTO_MONITOR", + "IDP_SYNC" ], - "title": "StealerLogCookieExpiration" + "title": "IdentifierSource" }, - "StealerLogCredential": { + "IdentifierState": { "properties": { - "url": { - "type": "string", - "title": "Url" - }, - "username": { - "type": "string", - "title": "Username" - }, - "password": { - "type": "string", - "title": "Password" + "source": { + "$ref": "#/components/schemas/IdentifierSource" }, - "application": { + "data_updated_at": { "type": "string", - "title": "Application" - } - }, - "type": "object", - "required": [ - "url", - "username", - "password", - "application" - ], - "title": "StealerLogCredential" - }, - "StealerLogData": { - "properties": { - "credentials": { - "$ref": "#/components/schemas/PiiCollection_StealerLogFindingCredential_" + "format": "date-time", + "title": "Data Updated At" }, - "cookies": { - "$ref": "#/components/schemas/PiiCollection_StealerLogFindingCookie_" - } - }, - "type": "object", - "required": [ - "credentials", - "cookies" - ], - "title": "StealerLogData" - }, - "StealerLogEventData": { - "properties": { - "victim_information": { + "event_count": { "anyOf": [ { - "$ref": "#/components/schemas/pyro__findings__stealerlogs__datamodels__VictimInformation" + "type": "integer" }, { "type": "null" } ], - "description": "Collection of data that relates to the victim and their infected device." + "title": "Event Count" }, - "malware_information": { + "usage_count": { + "type": "integer", + "title": "Usage Count" + }, + "rate_limits": { "anyOf": [ { - "$ref": "#/components/schemas/MalwareInformation" + "$ref": "#/components/schemas/IdentifierFeedRateLimits" }, { "type": "null" } - ], - "description": "Collection of data that relates to the malware that was used to infect the victim's device." - } - }, - "type": "object", - "required": [ - "victim_information", - "malware_information" - ], - "title": "StealerLogEventData" - }, - "StealerLogFindingCookie": { - "properties": { - "host_key": { - "type": "string", - "title": "Host Key" - }, - "path": { - "type": "string", - "title": "Path" + ] }, - "expires_utc": { + "validation_status": { "anyOf": [ { - "type": "string", - "format": "date-time" + "$ref": "#/components/schemas/IdentifierValidationStatus" }, { "type": "null" } - ], - "title": "Expires Utc" - }, - "name": { - "type": "string", - "title": "Name" + ] }, - "value": { - "type": "string", - "title": "Value" + "authorization_request_status": { + "anyOf": [ + { + "$ref": "#/components/schemas/IdentifierAuthorizationRequestStatus" + }, + { + "type": "null" + } + ] } }, "type": "object", "required": [ - "host_key", - "path", - "expires_utc", - "name", - "value" + "source", + "data_updated_at", + "event_count", + "usage_count", + "rate_limits", + "validation_status", + "authorization_request_status" ], - "title": "StealerLogFindingCookie" + "title": "IdentifierState" }, - "StealerLogFindingCredential": { - "properties": { - "url": { - "type": "string", - "title": "Url" - }, - "username": { - "type": "string", - "title": "Username" - }, - "password": { - "type": "string", - "title": "Password" - }, - "hash": { - "type": "string", - "title": "Hash" - }, - "application": { - "type": "string", - "title": "Application" - } - }, - "type": "object", - "required": [ - "url", + "IdentifierType": { + "type": "string", + "enum": [ + "domain", + "name", + "keyword", + "github_repository", "username", - "password", - "hash", - "application" + "email", + "search_query", + "bin", + "ip", + "secret", + "azure_tenant", + "identity", + "ransomleak", + "external_id", + "address_data", + "birth_year", + "role", + "phone_number" + ], + "title": "IdentifierType" + }, + "IdentifierValidationStatus": { + "type": "string", + "enum": [ + "FIRST_PARTY" ], - "title": "StealerLogFindingCredential" + "title": "IdentifierValidationStatus" }, - "StrategyMember": { + "IdentityAttribute": { "properties": { - "type": { - "$ref": "#/components/schemas/StrategyMemberType" - }, - "id": { - "type": "integer", - "title": "Id" + "asset_uuid": { + "type": "string", + "title": "Asset Uuid" }, - "name": { - "anyOf": [ + "data": { + "oneOf": [ + { + "$ref": "#/components/schemas/EmailData" + }, + { + "$ref": "#/components/schemas/UsernameData" + }, + { + "$ref": "#/components/schemas/NameData" + }, + { + "$ref": "#/components/schemas/ExternalIdData" + }, + { + "$ref": "#/components/schemas/AddressData" + }, + { + "$ref": "#/components/schemas/BirthYearData" + }, { - "type": "string" + "$ref": "#/components/schemas/RoleData" }, { - "type": "null" + "$ref": "#/components/schemas/PhoneNumberData" } ], - "title": "Name" - } - }, - "type": "object", - "required": [ - "type", - "id" - ], - "title": "StrategyMember" - }, - "StrategyMemberType": { - "type": "string", - "enum": [ - "user", - "tenant", - "organization" - ], - "title": "StrategyMemberType" - }, - "SubdomainStatus": { - "properties": { - "status": { - "$ref": "#/components/schemas/DomainStatus" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "title": "Updated At" + "title": "Data", + "discriminator": { + "propertyName": "type", + "mapping": { + "address_data": "#/components/schemas/AddressData", + "birth_year": "#/components/schemas/BirthYearData", + "email": "#/components/schemas/EmailData", + "external_id": "#/components/schemas/ExternalIdData", + "name": "#/components/schemas/NameData", + "phone_number": "#/components/schemas/PhoneNumberData", + "role": "#/components/schemas/RoleData", + "username": "#/components/schemas/UsernameData" + } + } } }, "type": "object", "required": [ - "status", - "updated_at" + "asset_uuid", + "data" ], - "title": "SubdomainStatus" + "title": "IdentityAttribute" }, - "SubdomainTag": { + "IdentityData": { "properties": { - "label": { + "type": { "type": "string", - "title": "Label" + "const": "identity", + "title": "Type", + "default": "identity" }, - "keyword": { + "uuid": { "type": "string", - "title": "Keyword" - }, - "span": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Span" - } - }, - "type": "object", - "required": [ - "label", - "keyword", - "span" - ], - "title": "SubdomainTag" - }, - "TagListPayload": { - "properties": { - "tags": { - "items": { - "$ref": "#/components/schemas/TagPayload" - }, - "type": "array", - "title": "Tags" + "minLength": 1, + "title": "Uuid" } }, "type": "object", "required": [ - "tags" + "uuid" ], - "title": "TagListPayload" + "title": "IdentityData" }, - "TagPayload": { + "IdentityDataRequestBody": { "properties": { - "id": { - "type": "string", - "title": "Id" - }, - "name": { - "type": "string", - "title": "Name" - }, "type": { "type": "string", + "const": "identity", "title": "Type" }, - "description": { - "type": "string", - "title": "Description" - }, - "is_visible": { - "type": "boolean", - "title": "Is Visible" + "attributes": { + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/EmailData" + }, + { + "$ref": "#/components/schemas/UsernameData" + }, + { + "$ref": "#/components/schemas/NameData" + }, + { + "$ref": "#/components/schemas/ExternalIdData" + }, + { + "$ref": "#/components/schemas/AddressData" + }, + { + "$ref": "#/components/schemas/BirthYearData" + }, + { + "$ref": "#/components/schemas/RoleData" + }, + { + "$ref": "#/components/schemas/PhoneNumberData" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "address_data": "#/components/schemas/AddressData", + "birth_year": "#/components/schemas/BirthYearData", + "email": "#/components/schemas/EmailData", + "external_id": "#/components/schemas/ExternalIdData", + "name": "#/components/schemas/NameData", + "phone_number": "#/components/schemas/PhoneNumberData", + "role": "#/components/schemas/RoleData", + "username": "#/components/schemas/UsernameData" + } + } + }, + "type": "array", + "maxItems": 15, + "minItems": 1, + "title": "Attributes" } }, "type": "object", "required": [ - "id", - "name", "type", - "description", - "is_visible" - ], - "title": "TagPayload" - }, - "TenantBanner": { - "properties": { - "tenant_id": { - "type": "integer", - "title": "Tenant Id" - }, - "tenant_name": { - "type": "string", - "title": "Tenant Name" - }, - "message": { - "type": "string", - "title": "Message" - }, - "variant": { - "$ref": "#/components/schemas/BannerVariant" - } - }, - "type": "object", - "required": [ - "tenant_id", - "tenant_name", - "message", - "variant" - ], - "title": "TenantBanner" - }, - "TenantFlareCommunityIsEnabledResponse": { - "properties": { - "flare_community_enabled": { - "type": "boolean", - "title": "Flare Community Enabled" - } - }, - "type": "object", - "required": [ - "flare_community_enabled" + "attributes" ], - "title": "TenantFlareCommunityIsEnabledResponse" + "title": "IdentityDataRequestBody" }, - "TenantFlareCommunityUser": { + "IdentityIdentifierEntity": { "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "primary_email": { - "type": "string", - "title": "Primary Email" - }, - "invite_type": { - "type": "string", - "title": "Invite Type" - }, - "created_at": { - "type": "string", - "format": "date-time", - "title": "Created At" + "type": { + "$ref": "#/components/schemas/IdentifierEntityType" }, - "features": { + "attributes": { "items": { - "$ref": "#/components/schemas/Features" + "$ref": "#/components/schemas/IdentityAttribute" }, "type": "array", - "title": "Features" + "title": "Attributes" } }, "type": "object", "required": [ - "id", - "primary_email", - "invite_type", - "created_at", - "features" + "type", + "attributes" ], - "title": "TenantFlareCommunityUser" + "title": "IdentityIdentifierEntity" }, - "TenantFlareCommunityUsersCountResponse": { - "properties": { - "count": { - "type": "integer", - "title": "Count" - } - }, - "type": "object", - "required": [ - "count" + "IncludeOptions": { + "type": "string", + "enum": [ + "known_password_id", + "auth_domains", + "urls" ], - "title": "TenantFlareCommunityUsersCountResponse" + "title": "IncludeOptions" }, - "TenantIndustry": { + "IntelType": { "type": "string", "enum": [ - "global", - "transport", - "education", - "energy", - "finance", - "healthcare", - "manufacturing", - "retail", - "software", - "telecommunication" - ], - "title": "TenantIndustry" + "unit_summary_based", + "custom_intel" + ], + "title": "IntelType" }, - "TenantIntegrationFilters": { + "IpQuery": { "properties": { "type": { "type": "string", - "const": "tenant_integration", - "title": "Type", - "default": "tenant_integration" + "const": "ip", + "title": "Type" }, - "tenant_integration_ids": { - "items": { - "type": "string", - "format": "uuid" - }, - "type": "array", - "maxItems": 1, - "minItems": 1, - "title": "Tenant Integration Ids" + "ip": { + "type": "string", + "title": "Ip" } }, "type": "object", "required": [ - "tenant_integration_ids" + "type", + "ip" ], - "title": "TenantIntegrationFilters" + "title": "IpQuery" }, - "TenantIntegrationItem": { + "KeywordData": { "properties": { - "id": { - "type": "string", - "format": "uuid", - "title": "Id" - }, - "name": { - "type": "string", - "title": "Name" - }, - "tenant_id": { - "type": "integer", - "title": "Tenant Id" - }, "type": { - "$ref": "#/components/schemas/TenantIntegrationType" - }, - "params": { - "anyOf": [ - { - "$ref": "#/components/schemas/EntraIDParams" - }, - { - "$ref": "#/components/schemas/ForetraceParams" - }, - { - "$ref": "#/components/schemas/OktaParams" - }, - { - "type": "null" - } - ], - "title": "Params" - }, - "state": { - "$ref": "#/components/schemas/TenantIntegrationState" - }, - "is_enabled": { - "type": "boolean", - "title": "Is Enabled" - }, - "created_at": { "type": "string", - "format": "date-time", - "title": "Created At" + "const": "keyword", + "title": "Type", + "default": "keyword" }, - "updated_at": { + "keyword": { "type": "string", - "format": "date-time", - "title": "Updated At" + "minLength": 1, + "title": "Keyword" } }, "type": "object", "required": [ - "id", - "name", - "tenant_id", - "type", - "params", - "state", - "is_enabled", - "created_at", - "updated_at" + "keyword" ], - "title": "TenantIntegrationItem" + "title": "KeywordData" }, - "TenantIntegrationState": { + "KeywordQuery": { "properties": { - "status": { - "$ref": "#/components/schemas/TenantIntegrationStatus" - }, - "message": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Message" - }, - "failed_attempts": { - "type": "integer", - "title": "Failed Attempts", - "default": 0 - }, - "failed_validation_details": { - "anyOf": [ - { - "$ref": "#/components/schemas/EntraIDFailedValidationDetails" - }, - { - "$ref": "#/components/schemas/OktaFailedValidationDetails" - }, - { - "type": "null" - } - ], - "title": "Failed Validation Details" + "type": { + "type": "string", + "const": "keyword", + "title": "Type" }, - "last_synchronized_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Last Synchronized At" + "keyword": { + "type": "string", + "title": "Keyword" } }, "type": "object", "required": [ - "status" - ], - "title": "TenantIntegrationState" - }, - "TenantIntegrationStatus": { - "type": "string", - "enum": [ - "untested", - "error", - "success", - "marked_for_deletion" + "type", + "keyword" ], - "title": "TenantIntegrationStatus" + "title": "KeywordQuery" }, - "TenantIntegrationStatusResponse": { + "KeywordsValue": { "properties": { - "status": { - "$ref": "#/components/schemas/TenantIntegrationStatus" - }, - "message": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Message" - }, - "failed_validation_details": { - "anyOf": [ - { - "$ref": "#/components/schemas/EntraIDFailedValidationDetails" - }, - { - "$ref": "#/components/schemas/OktaFailedValidationDetails" - }, - { - "type": "null" - } - ], - "title": "Failed Validation Details" + "keywords": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Keywords" } }, "type": "object", "required": [ - "status", - "message" + "keywords" + ], + "title": "KeywordsValue" + }, + "Language": { + "type": "string", + "enum": [ + "en", + "fr" ], - "title": "TenantIntegrationStatusResponse" + "title": "Language" }, - "TenantIntegrationType": { + "LeakedCredentialsBulkActionType": { "type": "string", "enum": [ - "entra_id", - "flare_community", - "okta" + "remediate", + "unremediate", + "ignore", + "unignore" ], - "title": "TenantIntegrationType" + "title": "LeakedCredentialsBulkActionType" }, - "TenantMemberRoleResponse": { + "ListingEvent": { "properties": { - "role": { - "anyOf": [ - { - "$ref": "#/components/schemas/TenantRoleType" - }, - { - "type": "null" - } - ] + "event_type": { + "type": "string", + "const": "listing", + "title": "Event Type", + "default": "listing" }, - "is_organization_admin": { - "type": "boolean", - "title": "Is Organization Admin" + "data": { + "$ref": "#/components/schemas/ListingEventData" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" } }, "type": "object", "required": [ - "role", - "is_organization_admin" + "data", + "metadata" ], - "title": "TenantMemberRoleResponse" + "title": "Listing" }, - "TenantMetadataResponse": { + "ListingEventData": { "properties": { - "uid": { - "type": "string", - "title": "Uid" - }, - "notes": { + "url": { "anyOf": [ { "type": "string" @@ -37210,16 +7317,10 @@ "type": "null" } ], - "title": "Notes" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Tags" + "title": "Url", + "description": "The URL to the listing." }, - "severity": { + "title": { "anyOf": [ { "type": "string" @@ -37228,33 +7329,10 @@ "type": "null" } ], - "title": "Severity" - } - }, - "type": "object", - "required": [ - "uid", - "notes", - "tags", - "severity" - ], - "title": "TenantMetadataResponse" - }, - "TenantPayload": { - "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "name": { - "type": "string", - "title": "Name" - }, - "type": { - "type": "string", - "title": "Type" + "title": "Title", + "description": "The title of the listing." }, - "description": { + "content": { "anyOf": [ { "type": "string" @@ -37263,85 +7341,64 @@ "type": "null" } ], - "title": "Description" - }, - "organization_id": { - "type": "integer", - "title": "Organization Id" - }, - "urn": { - "type": "string", - "title": "Urn" + "title": "Content", + "description": "The content within the listing." }, - "number_of_employees": { + "currency": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Number Of Employees" + "title": "Currency", + "description": "The currency expected in the listing." }, - "industry": { + "escrow": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Industry" - }, - "is_disabled": { - "type": "boolean", - "title": "Is Disabled" - }, - "is_archived": { - "type": "boolean", - "title": "Is Archived" - }, - "feed_id": { - "type": "integer", - "title": "Feed Id" + "title": "Escrow", + "description": "Whether the listing requires escrow." }, - "identifier_limit": { + "price": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Identifier Limit" + "title": "Price", + "description": "The price of the listing." }, - "permissions": { + "ship_to": { "items": { - "$ref": "#/components/schemas/UserPermissions" + "type": "string" }, "type": "array", - "title": "Permissions" - }, - "prevent_global_search": { - "type": "boolean", - "title": "Prevent Global Search" + "title": "Ship To", + "description": "The countries eligible for shipping.", + "default": [] }, - "access_end_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Access End At" + "ship_from": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Ship From", + "description": "The countries eligible for shipping.", + "default": [] }, - "hubspot_tenant_id": { + "stock_count": { "anyOf": [ { "type": "integer" @@ -37350,260 +7407,197 @@ "type": "null" } ], - "title": "Hubspot Tenant Id" + "title": "Stock Count", + "description": "The quantity of the items or service in stock." + }, + "actor": { + "$ref": "#/components/schemas/pyro__findings__listing__datamodels__ListingEventData__Actor", + "description": "Data about the seller." + }, + "classification": { + "$ref": "#/components/schemas/Classification", + "description": "Data about the possible classifications of the listing." + }, + "context": { + "$ref": "#/components/schemas/pyro__findings__listing__datamodels__ListingEventData__Context", + "description": "Data offering context to the listing." } }, "type": "object", - "required": [ - "id", - "name", - "type", - "description", - "organization_id", - "urn", - "number_of_employees", - "industry", - "is_disabled", - "is_archived", - "feed_id", - "identifier_limit", - "permissions", - "prevent_global_search", - "access_end_at", - "hubspot_tenant_id" - ], - "title": "TenantPayload" - }, - "TenantRoleType": { - "type": "string", - "enum": [ - "viewer", - "editor", - "admin" - ], - "title": "TenantRoleType" + "title": "ListingEventData" }, - "TenantUserAccess": { + "LookalikeDomainEvent": { "properties": { - "tenant_id": { - "type": "integer", - "title": "Tenant Id" + "event_type": { + "type": "string", + "const": "lookalike", + "title": "Event Type", + "default": "lookalike" }, - "tenant_role": { - "$ref": "#/components/schemas/TenantRoleType" + "data": { + "$ref": "#/components/schemas/LookalikeDomainEventData" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" } }, "type": "object", "required": [ - "tenant_id", - "tenant_role" + "data", + "metadata" ], - "title": "TenantUserAccess" + "title": "Lookalike Domain" }, - "TenantWithEnrichmentsPayload": { + "LookalikeDomainEventData": { "properties": { - "tenant": { - "$ref": "#/components/schemas/TenantPayload" + "domain": { + "type": "string", + "title": "Domain", + "description": "The domain of the lookalike domain." }, - "user_count": { + "registered_at": { "anyOf": [ { - "type": "integer" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "User Count" + "title": "Registered At", + "description": "The date and time the lookalike domain was registered." }, - "identifier_count": { + "identifier_domains": { "anyOf": [ { - "type": "integer" + "items": { + "type": "string" + }, + "type": "array" }, { "type": "null" } ], - "title": "Identifier Count" + "title": "Identifier Domains", + "description": "Domain identifiers matching the lookalike domains" }, - "identifier_limit": { + "feed": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Identifier Limit" + "title": "Feed", + "description": "The feed where the lookalike domain was found" }, - "global_search_calls_limit": { + "cert_data": { "anyOf": [ { - "type": "integer" + "additionalProperties": true, + "type": "object" }, { "type": "null" } ], - "title": "Global Search Calls Limit" + "title": "Cert Data", + "description": "The certificate data of the lookalike domain." }, - "global_search_calls_count": { + "subject": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Global Search Calls Count" - }, - "identifier_rotation_count": { - "type": "integer", - "title": "Identifier Rotation Count" + "title": "Subject", + "description": "The subject of the certificate of the lookalike domain." }, - "identifier_rotation_limit": { + "issuer": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Identifier Rotation Limit" - }, - "identities_limit": { - "type": "integer", - "title": "Identities Limit" - }, - "sandbox_submissions_usage": { - "type": "integer", - "title": "Sandbox Submissions Usage" - }, - "sandbox_submissions_limit": { - "type": "integer", - "title": "Sandbox Submissions Limit" + "title": "Issuer", + "description": "The issuer of the certificate of the lookalike domain." } }, "type": "object", "required": [ - "tenant", - "user_count", - "identifier_count", - "identifier_limit", - "global_search_calls_limit", - "global_search_calls_count", - "identifier_rotation_count", - "identifier_rotation_limit", - "identities_limit", - "sandbox_submissions_usage", - "sandbox_submissions_limit" - ], - "title": "TenantWithEnrichmentsPayload" + "domain", + "registered_at", + "identifier_domains", + "feed", + "cert_data", + "subject", + "issuer" + ], + "title": "LookalikeDomainEventData" }, - "TestTenantIntegrationPayload": { + "LuceneValue": { "properties": { - "params": { - "oneOf": [ - { - "$ref": "#/components/schemas/EntraIDInputParams" - }, - { - "$ref": "#/components/schemas/ForetraceInputParams" - }, - { - "$ref": "#/components/schemas/OktaInputParams" - } - ], - "title": "Params", - "discriminator": { - "propertyName": "params_type", - "mapping": { - "entra_id": "#/components/schemas/EntraIDInputParams", - "flare_community": "#/components/schemas/ForetraceInputParams", - "okta": "#/components/schemas/OktaInputParams" - } - } + "query": { + "type": "string", + "title": "Query", + "description": "The lucene query of the matching policy" } }, "type": "object", "required": [ - "params" - ], - "title": "TestTenantIntegrationPayload" - }, - "ThreadType": { - "type": "string", - "enum": [ - "chat_channel", - "forum_thread" + "query" ], - "title": "ThreadType" + "title": "LuceneValue" }, - "ThreatActorEntityAPIResponse": { + "MalwareInformation": { "properties": { - "uuid": { - "type": "string", - "title": "Uuid" - }, - "type": { - "$ref": "#/components/schemas/EntityType" - }, - "name": { - "type": "string", - "title": "Name" - }, - "created_by": { - "type": "string", - "title": "Created By" - }, - "sources": { - "items": { - "$ref": "#/components/schemas/CTIEntitySourceAPIResponse" - }, - "type": "array", - "title": "Sources" - }, - "created_at": { + "malware_family": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Created At" + "title": "Malware Family", + "description": "The malware family used for device infection." }, - "updated_at": { + "build_id": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Updated At" + "title": "Build Id", + "description": "The build ID of the malware used for device infection." }, - "first_seen_at": { + "file_location": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "First Seen At" + "title": "File Location", + "description": "The file location of the malware used for device infection." }, - "last_seen_at": { + "infected_at": { "anyOf": [ { "type": "string", @@ -37613,220 +7607,316 @@ "type": "null" } ], - "title": "Last Seen At" - }, - "confidence": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Confidence" - }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Description" - }, - "threat_actor_types": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Threat Actor Types" - }, - "aliases": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Aliases" - }, - "roles": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Roles" + "title": "Infected At", + "description": "The date and time the malware was used to infect the victim's device." + } + }, + "type": "object", + "required": [ + "malware_family", + "build_id", + "file_location", + "infected_at" + ], + "title": "MalwareInformation" + }, + "MatchingPolicyAssignmentPayload": { + "properties": { + "matching_policy": { + "$ref": "#/components/schemas/MatchingPolicyPayload" }, - "goals": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Goals" + "assigned_at": { + "type": "string", + "format": "date-time", + "title": "Assigned At", + "description": "The date and time this policy was assigned to the identifier" }, - "sophistication": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Sophistication" + "clean_past_events": { + "type": "boolean", + "title": "Clean Past Events", + "description": "Whether this policy has been applied to historical events" + } + }, + "type": "object", + "required": [ + "matching_policy", + "assigned_at", + "clean_past_events" + ], + "title": "MatchingPolicyAssignmentPayload" + }, + "MatchingPolicyPayload": { + "properties": { + "uuid": { + "type": "string", + "format": "uuid4", + "title": "Uuid", + "description": "The UUID of the matching policy" }, - "resource_level": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Resource Level" + "name": { + "type": "string", + "title": "Name", + "description": "The name of the matching policy" }, - "primary_motivation": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Primary Motivation" + "policy_type": { + "$ref": "#/components/schemas/MatchingPolicyType", + "description": "The type of the matching policy" }, - "secondary_motivation": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Secondary Motivation" + "value": { + "$ref": "#/components/schemas/PolicyValue", + "description": "The value of the matching policy depending on its type" }, - "personal_motivations": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Personal Motivations" + "created_at": { + "type": "string", + "format": "date-time", + "title": "Created At", + "description": "The date and time the matching policy was created" }, - "marking_definitions": { - "items": { - "$ref": "#/components/schemas/MarkingDefinition" - }, - "type": "array", - "title": "Marking Definitions" + "last_updated_at": { + "type": "string", + "format": "date-time", + "title": "Last Updated At", + "description": "The date and time the matching policy was last updated" } }, "type": "object", "required": [ "uuid", - "type", "name", - "created_by", - "sources", + "policy_type", + "value", "created_at", - "updated_at", - "description", - "threat_actor_types", - "aliases", - "roles", - "goals", - "sophistication", - "resource_level", - "primary_motivation", - "secondary_motivation", - "personal_motivations", - "marking_definitions" - ], - "title": "ThreatActorEntityAPIResponse" + "last_updated_at" + ], + "title": "MatchingPolicyPayload" }, - "ThreatActorGroupEntityAPIResponse": { + "MatchingPolicyType": { + "type": "string", + "enum": [ + "INCLUDED_KEYWORDS", + "EXCLUDED_KEYWORDS", + "LUCENE_QUERY", + "ASTP_COOKIES", + "ASTP_DOMAIN" + ], + "title": "MatchingPolicyType" + }, + "NameData": { "properties": { - "uuid": { + "type": { "type": "string", - "title": "Uuid" + "const": "name", + "title": "Type", + "default": "name" + }, + "first_name": { + "type": "string", + "title": "First Name" + }, + "last_name": { + "type": "string", + "title": "Last Name" }, + "is_strict": { + "type": "boolean", + "title": "Is Strict" + } + }, + "type": "object", + "required": [ + "first_name", + "last_name", + "is_strict" + ], + "title": "NameData" + }, + "NameQuery": { + "properties": { "type": { - "$ref": "#/components/schemas/EntityType" + "type": "string", + "const": "name", + "title": "Type" }, - "name": { + "first_name": { "type": "string", - "title": "Name" + "title": "First Name" }, - "created_by": { + "last_name": { "type": "string", - "title": "Created By" + "title": "Last Name" }, - "sources": { + "is_strict": { + "type": "boolean", + "title": "Is Strict" + } + }, + "type": "object", + "required": [ + "type", + "first_name", + "last_name", + "is_strict" + ], + "title": "NameQuery" + }, + "OrderType": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "title": "OrderType" + }, + "PaginatedResults_Alert_str_": { + "properties": { + "items": { "items": { - "$ref": "#/components/schemas/CTIEntitySourceAPIResponse" + "$ref": "#/components/schemas/Alert" }, "type": "array", - "title": "Sources" + "title": "Items" }, - "created_at": { + "next": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Created At" + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[Alert, str]" + }, + "PaginatedResults_Credential_str_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/Credential" + }, + "type": "array", + "title": "Items" }, - "updated_at": { + "next": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Updated At" + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[Credential, str]" + }, + "PaginatedResults_FeedItem_str_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/FeedItem" + }, + "type": "array", + "title": "Items" }, - "first_seen_at": { + "next": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "First Seen At" + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[FeedItem, str]" + }, + "PaginatedResults_GlobalFeedItem_str_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/GlobalFeedItem" + }, + "type": "array", + "title": "Items" }, - "last_seen_at": { + "next": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Last Seen At" + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[GlobalFeedItem, str]" + }, + "PaginatedResults_MatchingPolicyPayload_str_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/MatchingPolicyPayload" + }, + "type": "array", + "title": "Items" }, - "confidence": { + "next": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Confidence" + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[MatchingPolicyPayload, str]" + }, + "PaginatedResults_PartialAlertChannel_str_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/PartialAlertChannel" + }, + "type": "array", + "title": "Items" }, - "description": { + "next": { "anyOf": [ { "type": "string" @@ -37835,30 +7925,26 @@ "type": "null" } ], - "title": "Description" - }, - "aliases": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Aliases" - }, - "goals": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Goals" - }, - "resource_level": { + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[PartialAlertChannel, str]" + }, + "PaginatedResults_PolicyAssignedIdentifierPayload_str_": { + "properties": { + "items": { "items": { - "type": "string" + "$ref": "#/components/schemas/PolicyAssignedIdentifierPayload" }, "type": "array", - "title": "Resource Level" + "title": "Items" }, - "primary_motivation": { + "next": { "anyOf": [ { "type": "string" @@ -37867,70 +7953,26 @@ "type": "null" } ], - "title": "Primary Motivation" - }, - "secondary_motivations": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Secondary Motivations" - }, - "marking_definitions": { - "items": { - "$ref": "#/components/schemas/MarkingDefinition" - }, - "type": "array", - "title": "Marking Definitions" + "title": "Next" } }, "type": "object", "required": [ - "uuid", - "type", - "name", - "created_by", - "sources", - "created_at", - "updated_at", - "description", - "aliases", - "goals", - "resource_level", - "primary_motivation", - "secondary_motivations", - "marking_definitions" - ], - "title": "ThreatActorGroupEntityAPIResponse" - }, - "ThreatFlowReportDownloadFormat": { - "type": "string", - "enum": [ - "docx", - "pdf" - ], - "title": "ThreatFlowReportDownloadFormat" - }, - "ThreatFlowReportFormatType": { - "type": "string", - "enum": [ - "simple_summary", - "expanded_summary", - "finished_intel_standard" + "items", + "next" ], - "title": "ThreatFlowReportFormatType" + "title": "PaginatedResults[PolicyAssignedIdentifierPayload, str]" }, - "ThreatFlowReportResponse": { + "PaginatedResults_PublicIdentifierResponse_str_": { "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "title": { - "type": "string", - "title": "Title" + "items": { + "items": { + "$ref": "#/components/schemas/PublicIdentifierResponse" + }, + "type": "array", + "title": "Items" }, - "subtitle": { + "next": { "anyOf": [ { "type": "string" @@ -37939,60 +7981,54 @@ "type": "null" } ], - "title": "Subtitle" - }, - "content": { - "type": "string", - "title": "Content" - }, - "created_at": { - "type": "string", - "format": "date-time", - "title": "Created At" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Tags" - }, - "highlights": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Highlights" - }, - "related_activity_uids": { + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[PublicIdentifierResponse, str]" + }, + "PaginatedResults_PublicReport_str_": { + "properties": { + "items": { "items": { - "type": "string" + "$ref": "#/components/schemas/PublicReport" }, "type": "array", - "title": "Related Activity Uids" + "title": "Items" }, - "published_at": { + "next": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Published At" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "title": "Updated At" - }, - "summary": { - "type": "string", - "title": "Summary" + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[PublicReport, str]" + }, + "PaginatedResults_PydanticThreatFlowReport_str_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/PydanticThreatFlowReport" + }, + "type": "array", + "title": "Items" }, - "prompt_preset_uid": { + "next": { "anyOf": [ { "type": "string" @@ -38001,184 +8037,227 @@ "type": "null" } ], - "title": "Prompt Preset Uid" + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[PydanticThreatFlowReport, str]" + }, + "PaginatedResults_Recommendation_str_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/Recommendation" + }, + "type": "array", + "title": "Items" }, - "tenant_id": { + "next": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Tenant Id" + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[Recommendation, str]" + }, + "PaginatedResults_StealerLogCookie_str_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/StealerLogCookie" + }, + "type": "array", + "title": "Items" }, - "organization_id": { + "next": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Organization Id" - }, - "format_type": { - "$ref": "#/components/schemas/ThreatFlowReportFormatType" + "title": "Next" } }, "type": "object", "required": [ - "id", - "title", - "subtitle", - "content", - "created_at", - "tags", - "highlights", - "related_activity_uids", - "published_at", - "updated_at", - "summary", - "prompt_preset_uid", - "tenant_id", - "organization_id", - "format_type" + "items", + "next" ], - "title": "ThreatFlowReportResponse" + "title": "PaginatedResults[StealerLogCookie, str]" }, - "ThreatFlowTenantConfigPayload": { + "PaginatedResults_StealerLogCredential_str_": { "properties": { - "ignored_tags": { + "items": { "items": { - "type": "string" + "$ref": "#/components/schemas/StealerLogCredential" }, "type": "array", - "title": "Ignored Tags" - }, - "subscribed_to_newsletter": { - "type": "boolean", - "title": "Subscribed To Newsletter" + "title": "Items" }, - "emails": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Emails" + "next": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Next" } }, "type": "object", "required": [ - "ignored_tags", - "subscribed_to_newsletter", - "emails" - ], - "title": "ThreatFlowTenantConfigPayload" - }, - "TimeRangeType": { - "type": "string", - "enum": [ - "all", - "last_24h", - "last_2d", - "last_7d", - "last_1m", - "last_3m", - "last_6m", - "range" + "items", + "next" ], - "title": "TimeRangeType" + "title": "PaginatedResults[StealerLogCredential, str]" }, - "TimelineBySearchTypeResponse": { + "ParentContext": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/TimelineSearchTypeWithValues" - }, - "type": "array", - "title": "Items" + "parent_uid": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Parent Uid" + }, + "parent_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Parent Type" } }, "type": "object", - "required": [ - "items" - ], - "title": "TimelineBySearchTypeResponse" + "title": "ParentContext" }, - "TimelineDateCount": { + "PartialAlertChannel": { "properties": { - "date": { + "id": { + "type": "integer", + "title": "Id" + }, + "name": { "type": "string", - "format": "date-time", - "title": "Date" + "title": "Name" + }, + "type": { + "$ref": "#/components/schemas/AlertType" }, - "count": { + "state": { + "$ref": "#/components/schemas/AlertChannelState" + }, + "alert_count": { "type": "integer", - "title": "Count" + "title": "Alert Count" } }, "type": "object", "required": [ - "date", - "count" + "id", + "name", + "type", + "state", + "alert_count" ], - "title": "TimelineDateCount" + "title": "PartialAlertChannel" }, - "TimelineSearchTypeWithValues": { + "PasteEvent": { "properties": { - "search_type": { - "$ref": "#/components/schemas/SearchType" + "event_type": { + "type": "string", + "const": "paste", + "title": "Event Type", + "default": "paste" }, - "values": { - "items": { - "$ref": "#/components/schemas/TimelineDateCount" - }, - "type": "array", - "title": "Values" + "data": { + "$ref": "#/components/schemas/PasteEventData" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" } }, "type": "object", "required": [ - "search_type", - "values" + "data", + "metadata" ], - "title": "TimelineSearchTypeWithValues" + "title": "Paste" }, - "Times": { + "PasteEventData": { "properties": { - "field": { - "type": "string", - "title": "Field", - "default": "metadata.estimated_created_at" + "url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Url" }, - "gt": { + "title": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Gt" + "title": "Title" }, - "gte": { + "content": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Gte" + "title": "Content" }, - "lt": { + "actor": { + "anyOf": [ + { + "$ref": "#/components/schemas/pyro__findings__paste__datamodels__PasteEventData__Actor" + }, + { + "type": "null" + } + ] + }, + "expires_at": { "anyOf": [ { "type": "string", @@ -38188,108 +8267,164 @@ "type": "null" } ], - "title": "Lt" + "title": "Expires At" }, - "lte": { + "syntax": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Lte" + "title": "Syntax" } }, "type": "object", - "title": "Times" + "title": "PasteEventData" }, - "ToolEntityAPIResponse": { + "PhoneNumberData": { "properties": { - "uuid": { - "type": "string", - "title": "Uuid" - }, "type": { - "$ref": "#/components/schemas/EntityType" + "type": "string", + "const": "phone_number", + "title": "Type", + "default": "phone_number" }, - "name": { + "phone_number": { "type": "string", - "title": "Name" + "minLength": 7, + "title": "Phone Number" + } + }, + "type": "object", + "required": [ + "phone_number" + ], + "title": "PhoneNumberData" + }, + "PolicyAssignedIdentifierPayload": { + "properties": { + "identifier_id": { + "type": "integer", + "title": "Identifier Id", + "description": "The ID of the identifier this policy is assigned to" }, - "created_by": { + "identifier_name": { "type": "string", - "title": "Created By" + "title": "Identifier Name", + "description": "The name of the identifier this policy is assigned to" }, - "sources": { + "clean_past_events": { + "type": "boolean", + "title": "Clean Past Events", + "description": "Whether this policy has been applied to historical events" + }, + "assigned_at": { + "type": "string", + "format": "date-time", + "title": "Assigned At", + "description": "The date and time this policy was assigned to the identifier" + } + }, + "type": "object", + "required": [ + "identifier_id", + "identifier_name", + "clean_past_events", + "assigned_at" + ], + "title": "PolicyAssignedIdentifierPayload" + }, + "PolicyAssignmentsBody": { + "properties": { + "identifier_ids": { "items": { - "$ref": "#/components/schemas/CTIEntitySourceAPIResponse" + "type": "integer" }, "type": "array", - "title": "Sources" + "title": "Identifier Ids", + "description": "The IDs of the identifiers to assign the policy to" }, - "created_at": { - "anyOf": [ + "clean_past_events": { + "type": "boolean", + "title": "Clean Past Events", + "description": "Whether this policy will be applied to historical events", + "default": false + } + }, + "type": "object", + "required": [ + "identifier_ids" + ], + "title": "PolicyAssignmentsBody" + }, + "PolicyValue": { + "anyOf": [ + { + "$ref": "#/components/schemas/KeywordsValue" + }, + { + "$ref": "#/components/schemas/LuceneValue" + }, + { + "$ref": "#/components/schemas/AstpCookiesValue" + }, + { + "$ref": "#/components/schemas/AstpDomainValue" + } + ] + }, + "PublicIdentifierRequestBody": { + "properties": { + "data": { + "oneOf": [ { - "type": "string", - "format": "date-time" + "$ref": "#/components/schemas/CCBinData" }, { - "type": "null" - } - ], - "title": "Created At" - }, - "updated_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" + "$ref": "#/components/schemas/IPData" }, { - "type": "null" - } - ], - "title": "Updated At" - }, - "first_seen_at": { - "anyOf": [ + "$ref": "#/components/schemas/KeywordData" + }, { - "type": "string", - "format": "date-time" + "$ref": "#/components/schemas/AzureTenantData" }, { - "type": "null" - } - ], - "title": "First Seen At" - }, - "last_seen_at": { - "anyOf": [ + "$ref": "#/components/schemas/DomainData" + }, { - "type": "string", - "format": "date-time" + "$ref": "#/components/schemas/SearchQueryData" }, { - "type": "null" - } - ], - "title": "Last Seen At" - }, - "confidence": { - "anyOf": [ + "$ref": "#/components/schemas/GithubRepositoryData" + }, { - "type": "integer" + "$ref": "#/components/schemas/SecretData" }, { - "type": "null" + "$ref": "#/components/schemas/PublicIdentityData" + } + ], + "title": "Data", + "discriminator": { + "propertyName": "type", + "mapping": { + "azure_tenant": "#/components/schemas/AzureTenantData", + "bin": "#/components/schemas/CCBinData", + "domain": "#/components/schemas/DomainData", + "github_repository": "#/components/schemas/GithubRepositoryData", + "identity": "#/components/schemas/PublicIdentityData", + "ip": "#/components/schemas/IPData", + "keyword": "#/components/schemas/KeywordData", + "search_query": "#/components/schemas/SearchQueryData", + "secret": "#/components/schemas/SecretData" } - ], - "title": "Confidence" + } }, - "description": { + "name": { "anyOf": [ { "type": "string" @@ -38298,270 +8433,393 @@ "type": "null" } ], - "title": "Description" + "title": "Name" + }, + "categories": { + "items": { + "$ref": "#/components/schemas/SearchType" + }, + "type": "array", + "title": "Categories" }, - "tool_types": { + "emerging_categories": { "items": { "type": "string" }, "type": "array", - "title": "Tool Types" + "title": "Emerging Categories" }, - "kill_chain_phases": { + "severities": { "items": { - "$ref": "#/components/schemas/KillChainAPIResponse" + "$ref": "#/components/schemas/Severity" }, "type": "array", - "title": "Kill Chain Phases" + "title": "Severities" }, - "tool_version": { + "group_id": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Tool Version" - }, - "marking_definitions": { - "items": { - "$ref": "#/components/schemas/MarkingDefinition" - }, - "type": "array", - "title": "Marking Definitions" + "title": "Group Id" } }, "type": "object", "required": [ - "uuid", - "type", - "name", - "created_by", - "sources", - "created_at", - "updated_at", - "description", - "tool_types", - "kill_chain_phases", - "tool_version", - "marking_definitions" + "data", + "categories", + "emerging_categories", + "severities" ], - "title": "ToolEntityAPIResponse" + "title": "PublicIdentifierRequestBody" }, - "TopActorsSummaryOutput": { + "PublicIdentifierResponse": { "properties": { - "top_actors": { + "id": { + "type": "integer", + "title": "Id" + }, + "name": { "type": "string", - "title": "Top Actors", - "description": "Single paragraph summarizing the most active actors in the forum thread." - } - }, - "type": "object", - "required": [ - "top_actors" - ], - "title": "TopActorsSummaryOutput" - }, - "Types": { - "properties": { - "is_guide": { - "anyOf": [ + "title": "Name" + }, + "tenant_id": { + "type": "integer", + "title": "Tenant Id" + }, + "data": { + "oneOf": [ { - "type": "boolean" + "$ref": "#/components/schemas/CCBinData" }, { - "type": "null" - } - ], - "title": "Is Guide", - "description": "Whether the listing is a guide. Ex: 'How to extort a website'" - }, - "is_service": { - "anyOf": [ + "$ref": "#/components/schemas/IPData" + }, { - "type": "boolean" + "$ref": "#/components/schemas/KeywordData" }, { - "type": "null" - } - ], - "title": "Is Service", - "description": "Whether the listing is offering a service. Ex: 'I will help you extort a website'" - }, - "is_software": { - "anyOf": [ + "$ref": "#/components/schemas/AzureTenantData" + }, { - "type": "boolean" + "$ref": "#/components/schemas/DomainData" }, { - "type": "null" + "$ref": "#/components/schemas/SearchQueryData" + }, + { + "$ref": "#/components/schemas/GithubRepositoryData" + }, + { + "$ref": "#/components/schemas/SecretData" + }, + { + "$ref": "#/components/schemas/PublicIdentityData" } ], - "title": "Is Software", - "description": "Whether the listing is offering software. Ex: 'I will sell you a software to extort a website'" + "title": "Data", + "discriminator": { + "propertyName": "type", + "mapping": { + "azure_tenant": "#/components/schemas/AzureTenantData", + "bin": "#/components/schemas/CCBinData", + "domain": "#/components/schemas/DomainData", + "github_repository": "#/components/schemas/GithubRepositoryData", + "identity": "#/components/schemas/PublicIdentityData", + "ip": "#/components/schemas/IPData", + "keyword": "#/components/schemas/KeywordData", + "search_query": "#/components/schemas/SearchQueryData", + "secret": "#/components/schemas/SecretData" + } + } }, - "is_hardware": { + "categories": { + "items": { + "$ref": "#/components/schemas/SearchType" + }, + "type": "array", + "title": "Categories" + }, + "emerging_categories": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Emerging Categories" + }, + "severities": { + "items": { + "$ref": "#/components/schemas/Severity" + }, + "type": "array", + "title": "Severities" + }, + "group_id": { "anyOf": [ { - "type": "boolean" + "type": "integer" }, { "type": "null" } ], - "title": "Is Hardware", - "description": "Whether the listing is offering hardware. Ex: 'I will sell you a hardware'" + "title": "Group Id" }, - "is_data": { + "enrichments": { "anyOf": [ { - "type": "boolean" + "$ref": "#/components/schemas/IdentifierEnrichments" }, { "type": "null" } - ], - "title": "Is Data", - "description": "Whether the listing is offering data. Ex: 'I will sell you victim data'" + ] + }, + "is_disabled": { + "type": "boolean", + "title": "Is Disabled" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "title": "Updated At" } }, "type": "object", - "title": "Types" + "required": [ + "id", + "name", + "tenant_id", + "data", + "categories", + "emerging_categories", + "severities", + "group_id", + "enrichments", + "is_disabled", + "updated_at" + ], + "title": "IdentifierResponse" }, - "UpdateAlertChannel": { + "PublicIdentifierUpdateRequestBody": { "properties": { - "name": { - "type": "string", - "title": "Name" - }, - "params": { + "data": { "oneOf": [ { - "$ref": "#/components/schemas/AlertChannelEmailParams" - }, - { - "$ref": "#/components/schemas/AlertChannelSlackParams" - }, - { - "$ref": "#/components/schemas/AlertChannelDiscordParams" + "$ref": "#/components/schemas/CCBinData" }, { - "$ref": "#/components/schemas/AlertChannelSplunkParams" + "$ref": "#/components/schemas/IPData" }, { - "$ref": "#/components/schemas/AlertChannelChannelParams" + "$ref": "#/components/schemas/KeywordData" }, { - "$ref": "#/components/schemas/AlertChannelLegacySentinelParams" + "$ref": "#/components/schemas/AzureTenantData" }, { - "$ref": "#/components/schemas/AlertChannelSentinelV2Params" + "$ref": "#/components/schemas/DomainData" }, { - "$ref": "#/components/schemas/AlertChannelTeamsParams" + "$ref": "#/components/schemas/SearchQueryData" }, { - "$ref": "#/components/schemas/AlertChannelJiraParams" + "$ref": "#/components/schemas/GithubRepositoryData" }, { - "$ref": "#/components/schemas/AlertChannelServiceNowParams" + "$ref": "#/components/schemas/SecretData" }, { - "$ref": "#/components/schemas/AlertChannelWebhookParams" + "$ref": "#/components/schemas/PublicIdentityData" } ], - "title": "Params", + "title": "Data", "discriminator": { "propertyName": "type", "mapping": { - "azure_sentinel": "#/components/schemas/AlertChannelLegacySentinelParams", - "azure_sentinel_v2": "#/components/schemas/AlertChannelSentinelV2Params", - "channel": "#/components/schemas/AlertChannelChannelParams", - "discord": "#/components/schemas/AlertChannelDiscordParams", - "email": "#/components/schemas/AlertChannelEmailParams", - "jira": "#/components/schemas/AlertChannelJiraParams", - "servicenow": "#/components/schemas/AlertChannelServiceNowParams", - "slack": "#/components/schemas/AlertChannelSlackParams", - "splunk": "#/components/schemas/AlertChannelSplunkParams", - "teams": "#/components/schemas/AlertChannelTeamsParams", - "webhook": "#/components/schemas/AlertChannelWebhookParams" + "azure_tenant": "#/components/schemas/AzureTenantData", + "bin": "#/components/schemas/CCBinData", + "domain": "#/components/schemas/DomainData", + "github_repository": "#/components/schemas/GithubRepositoryData", + "identity": "#/components/schemas/PublicIdentityData", + "ip": "#/components/schemas/IPData", + "keyword": "#/components/schemas/KeywordData", + "search_query": "#/components/schemas/SearchQueryData", + "secret": "#/components/schemas/SecretData" } } }, - "state": { - "$ref": "#/components/schemas/AlertChannelState" - } - }, - "type": "object", - "required": [ - "name", - "params", - "state" - ], - "title": "UpdateAlertChannel" - }, - "UpdateAllowedRestrictedTermRequest": { - "properties": { - "tenant_ids": { + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name" + }, + "categories": { + "items": { + "$ref": "#/components/schemas/SearchType" + }, + "type": "array", + "title": "Categories" + }, + "emerging_categories": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Emerging Categories" + }, + "severities": { + "items": { + "$ref": "#/components/schemas/Severity" + }, + "type": "array", + "title": "Severities" + }, + "group_id": { "anyOf": [ { - "items": { - "type": "integer" - }, - "type": "array" + "type": "integer" }, { "type": "null" } ], - "title": "Tenant Ids" + "title": "Group Id" }, - "reason": { + "is_disabled": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Reason" + "title": "Is Disabled" } }, "type": "object", "required": [ - "tenant_ids" + "data", + "categories", + "emerging_categories", + "severities" ], - "title": "UpdateAllowedRestrictedTermRequest" + "title": "PublicIdentifierUpdateRequestBody" }, - "UpdateAuthorizationRequest": { + "PublicIdentityData": { "properties": { - "asset_uuid": { + "type": { "type": "string", - "format": "uuid", - "title": "Asset Uuid" + "const": "identity", + "title": "Type", + "default": "identity" }, - "status": { - "$ref": "#/components/schemas/AuthorizeAssetRequestStatus" + "attributes": { + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/EmailData" + }, + { + "$ref": "#/components/schemas/UsernameData" + }, + { + "$ref": "#/components/schemas/NameData" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "email": "#/components/schemas/EmailData", + "name": "#/components/schemas/NameData", + "username": "#/components/schemas/UsernameData" + } + } + }, + "type": "array", + "maxItems": 15, + "minItems": 1, + "title": "Attributes" + } + }, + "type": "object", + "required": [ + "attributes" + ], + "title": "IdentityData" + }, + "PublicReport": { + "properties": { + "id": { + "type": "integer", + "title": "Id" + }, + "title": { + "type": "string", + "title": "Title" + }, + "author": { + "type": "string", + "title": "Author" }, "tenant_id": { "type": "integer", "title": "Tenant Id" + }, + "report_group_id": { + "type": "integer", + "title": "Report Group Id" + }, + "report_type": { + "$ref": "#/components/schemas/ReportType-Output" + }, + "status": { + "$ref": "#/components/schemas/ReportStatus" + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "Created At" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "title": "Updated At" + }, + "is_archived": { + "type": "boolean", + "title": "Is Archived" } }, "type": "object", "required": [ - "asset_uuid", + "id", + "title", + "author", + "tenant_id", + "report_group_id", + "report_type", "status", - "tenant_id" + "created_at", + "updated_at", + "is_archived" ], - "title": "UpdateAuthorizationRequest" + "title": "PublicReport" }, - "UpdateFeatureFlagPayload": { + "PublishReportPayload": { "properties": { - "name": { + "title": { "anyOf": [ { "type": "string" @@ -38570,20 +8828,71 @@ "type": "null" } ], - "title": "Name" + "title": "Title" + } + }, + "type": "object", + "title": "PublishReportPayload" + }, + "PydanticThreatFlowReport": { + "properties": { + "id": { + "type": "integer", + "title": "Id" + }, + "format_type": { + "$ref": "#/components/schemas/ThreatFlowReportFormatType", + "default": "simple_summary" + }, + "intel_type": { + "$ref": "#/components/schemas/IntelType", + "default": "unit_summary_based" + }, + "title": { + "type": "string", + "title": "Title" }, - "active": { + "subtitle": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "type": "null" } ], - "title": "Active" + "title": "Subtitle" }, - "description": { + "summary": { + "type": "string", + "title": "Summary" + }, + "content": { + "type": "string", + "title": "Content" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Tags" + }, + "highlights": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Highlights" + }, + "related_activity_uids": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Related Activity Uids" + }, + "prompt_preset_uid": { "anyOf": [ { "type": "string" @@ -38592,120 +8901,148 @@ "type": "null" } ], - "title": "Description" - } - }, - "type": "object", - "title": "UpdateFeatureFlagPayload" - }, - "UpdateFeatureFlagUserListPayload": { - "properties": { - "name": { + "title": "Prompt Preset Uid" + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "Created At" + }, + "published_at": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Name" + "title": "Published At" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "title": "Updated At" + }, + "reading_time": { + "type": "integer", + "title": "Reading Time" }, - "members": { + "tenant_id": { "anyOf": [ { - "items": { - "$ref": "#/components/schemas/StrategyMember" - }, - "type": "array" + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Tenant Id" + }, + "organization_id": { + "anyOf": [ + { + "type": "integer" }, { "type": "null" } ], - "title": "Members" + "title": "Organization Id" } }, "type": "object", - "title": "UpdateFeatureFlagUserListPayload" + "required": [ + "id", + "title", + "subtitle", + "summary", + "content", + "tags", + "highlights", + "related_activity_uids", + "prompt_preset_uid", + "created_at", + "published_at", + "updated_at", + "reading_time", + "tenant_id", + "organization_id" + ], + "title": "PydanticThreatFlowReport" }, - "UpdateFlareCommunityUserFeaturesRequest": { + "QueryStringQuery": { "properties": { - "features": { - "items": { - "$ref": "#/components/schemas/Features" - }, - "type": "array", - "title": "Features" + "type": { + "type": "string", + "const": "query_string", + "title": "Type" + }, + "query_string": { + "type": "string", + "maxLength": 10000, + "title": "Query String" } }, "type": "object", "required": [ - "features" + "type", + "query_string" ], - "title": "UpdateFlareCommunityUserFeaturesRequest" + "title": "QueryStringQuery" }, - "UpdateGitlabFeatureFlagScopePayload": { + "RansomLeakData": { "properties": { - "id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Id" + "type": { + "type": "string", + "const": "ransomleak", + "title": "Type", + "default": "ransomleak" }, - "environment_scope": { - "anyOf": [ - { - "$ref": "#/components/schemas/GitlabEnvironmentScope" - }, - { - "type": "null" - } - ] + "source": { + "type": "string", + "minLength": 1, + "title": "Source" }, - "_destroy": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Destroy" + "id": { + "type": "string", + "minLength": 1, + "title": "Id" } }, "type": "object", - "title": "UpdateGitlabFeatureFlagScopePayload" + "required": [ + "source", + "id" + ], + "title": "RansomLeakData" }, - "UpdateMatchingPolicyBody": { + "RansomLeakEvent": { "properties": { - "name": { + "event_type": { "type": "string", - "minLength": 1, - "title": "Name", - "description": "The new name of the matching policy" + "const": "ransomleak", + "title": "Event Type", + "default": "ransomleak" }, - "value": { - "$ref": "#/components/schemas/PolicyValue", - "description": "The new value of the matching policy depending on its type" + "data": { + "$ref": "#/components/schemas/RansomLeakEventData" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" } }, "type": "object", "required": [ - "name", - "value" + "data", + "metadata" ], - "title": "UpdateMatchingPolicyBody" + "title": "Ransom Leak" }, - "UpdatePartialTenantIntegrationPayload": { + "RansomLeakEventData": { "properties": { - "name": { + "url": { "anyOf": [ { "type": "string" @@ -38714,22 +9051,10 @@ "type": "null" } ], - "title": "Name" + "title": "Url", + "description": "The URL of the ransom leak post." }, - "is_enabled": { - "type": "boolean", - "title": "Is Enabled" - } - }, - "type": "object", - "required": [ - "is_enabled" - ], - "title": "UpdatePartialTenantIntegrationPayload" - }, - "UpdateReportParameters": { - "properties": { - "title": { + "response_url": { "anyOf": [ { "type": "string" @@ -38738,9 +9063,10 @@ "type": "null" } ], - "title": "Title" + "title": "Response Url", + "description": "The URL of the response to the ransom leak post." }, - "content": { + "title": { "anyOf": [ { "type": "string" @@ -38749,9 +9075,10 @@ "type": "null" } ], - "title": "Content" + "title": "Title", + "description": "The title of the ransom leak post." }, - "summary": { + "content": { "anyOf": [ { "type": "string" @@ -38760,51 +9087,100 @@ "type": "null" } ], - "title": "Summary" + "title": "Content", + "description": "The content of the ransom leak post." }, - "tags": { + "body": { "anyOf": [ { - "items": { - "type": "string" - }, - "type": "array" + "type": "string" }, { "type": "null" } ], - "title": "Tags" + "title": "Body", + "description": "The body of the ransom leak post." }, - "highlights": { + "victim_information": { "anyOf": [ { - "items": { - "type": "string" - }, - "type": "array" + "$ref": "#/components/schemas/pyro__findings__ransomleaks__datamodels__VictimInformation" }, { "type": "null" } ], - "title": "Highlights" + "description": "The information relating to the victim of the ransom leak." + } + }, + "type": "object", + "required": [ + "url", + "response_url", + "title", + "content", + "body", + "victim_information" + ], + "title": "RansomLeakEventData" + }, + "Recommendation": { + "properties": { + "id": { + "type": "integer", + "title": "Id" }, - "related_activity_uids": { - "anyOf": [ + "data": { + "oneOf": [ { - "items": { - "type": "string" - }, - "type": "array" + "$ref": "#/components/schemas/DomainData" }, { - "type": "null" + "$ref": "#/components/schemas/AzureTenantData" + }, + { + "$ref": "#/components/schemas/EmailData" + }, + { + "$ref": "#/components/schemas/UsernameData" } ], - "title": "Related Activity Uids" + "title": "Data", + "discriminator": { + "propertyName": "type", + "mapping": { + "azure_tenant": "#/components/schemas/AzureTenantData", + "domain": "#/components/schemas/DomainData", + "email": "#/components/schemas/EmailData", + "username": "#/components/schemas/UsernameData" + } + } + } + }, + "type": "object", + "required": [ + "id", + "data" + ], + "title": "Recommendation" + }, + "RelatedConversationRequest": { + "properties": { + "uid": { + "type": "string", + "title": "Uid" }, - "prompt_preset_uid": { + "direction": { + "$ref": "#/components/schemas/ConversationSearchAfterDirection", + "default": "next" + }, + "size": { + "type": "integer", + "title": "Size", + "default": 10 + }, + "search_after": { "anyOf": [ { "type": "string" @@ -38813,9 +9189,34 @@ "type": "null" } ], - "title": "Prompt Preset Uid" + "title": "Search After" }, - "subtitle": { + "should_translate": { + "type": "boolean", + "title": "Should Translate", + "default": false + } + }, + "type": "object", + "required": [ + "uid" + ], + "title": "RelatedConversationRequest" + }, + "RelatedConversationResponse": { + "properties": { + "conversation_messages": { + "items": { + "$ref": "#/components/schemas/ConversationMessage" + }, + "type": "array", + "title": "Conversation Messages" + }, + "conversation_name": { + "type": "string", + "title": "Conversation Name" + }, + "conversation_name_en": { "anyOf": [ { "type": "string" @@ -38824,209 +9225,408 @@ "type": "null" } ], - "title": "Subtitle" + "title": "Conversation Name En" }, - "published_at": { + "next": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Published At" + "title": "Next" }, - "tenant_id": { + "previous": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Tenant Id" + "title": "Previous" } }, "type": "object", "required": [ - "title", - "content", - "summary", - "tags", - "highlights", - "related_activity_uids", - "prompt_preset_uid", - "subtitle", - "published_at", - "tenant_id" + "conversation_messages", + "conversation_name" + ], + "title": "RelatedConversationResponse" + }, + "ReportDownloadFormat": { + "type": "string", + "enum": [ + "docx", + "pdf", + "csv", + "zip" ], - "title": "UpdateReportParameters" + "title": "ReportDownloadFormat" }, - "UpdateSignupIntentRequestBody": { + "ReportRequestInfoResponse": { "properties": { - "intents": { - "items": { - "$ref": "#/components/schemas/SignupIntent" - }, - "type": "array", - "title": "Intents" + "status": { + "$ref": "#/components/schemas/RequestStatus" + }, + "report": { + "anyOf": [ + { + "$ref": "#/components/schemas/ApiReport" + }, + { + "type": "null" + } + ] } }, "type": "object", "required": [ - "intents" + "status" ], - "title": "UpdateSignupIntentRequestBody" + "title": "ReportRequestInfoResponse" }, - "UpdateStrategyPayload": { + "ReportRequestPayload": { "properties": { - "strategy_type": { + "report_title": { + "type": "string", + "title": "Report Title" + }, + "question": { "anyOf": [ { - "$ref": "#/components/schemas/GitlabFeatureFlagStrategyName" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Question" + }, + "time_range_type": { + "$ref": "#/components/schemas/TimeRangeType", + "default": "all" }, - "scopes": { + "time_range_from": { "anyOf": [ { - "items": { - "$ref": "#/components/schemas/UpdateGitlabFeatureFlagScopePayload" - }, - "type": "array" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Scopes" + "title": "Time Range From" }, - "members": { + "time_range_to": { "anyOf": [ { - "items": { - "$ref": "#/components/schemas/StrategyMember" - }, - "type": "array" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Members" + "title": "Time Range To" }, - "user_list_id": { + "included_keywords": { "anyOf": [ { - "type": "integer" + "items": { + "type": "string" + }, + "type": "array" }, { "type": "null" } ], - "title": "User List Id" + "title": "Included Keywords" }, - "_destroy": { + "excluded_keywords": { "anyOf": [ { - "type": "boolean" + "items": { + "type": "string" + }, + "type": "array" }, { "type": "null" } ], - "title": "Destroy" + "title": "Excluded Keywords" + } + }, + "type": "object", + "required": [ + "report_title" + ], + "title": "ReportRequestPayload" + }, + "ReportRequestResponse": { + "properties": { + "request_id": { + "type": "string", + "format": "uuid", + "title": "Request Id" + } + }, + "type": "object", + "required": [ + "request_id" + ], + "title": "ReportRequestResponse" + }, + "ReportStatus": { + "type": "string", + "enum": [ + "draft", + "processing", + "completed", + "scheduled", + "paused" + ], + "title": "ReportStatus" + }, + "ReportType-Output": { + "type": "string", + "enum": [ + "v1", + "event_based", + "feed_based" + ], + "title": "ReportType" + }, + "RequestStatus": { + "type": "string", + "enum": [ + "processing", + "completed", + "error" + ], + "title": "RequestStatus" + }, + "RiskScore": { + "type": "integer", + "enum": [ + 1, + 2, + 3, + 4, + 5 + ], + "title": "RiskScore" + }, + "RoleData": { + "properties": { + "type": { + "type": "string", + "const": "role", + "title": "Type", + "default": "role" + }, + "role": { + "type": "string", + "minLength": 1, + "title": "Role" + } + }, + "type": "object", + "required": [ + "role" + ], + "title": "RoleData" + }, + "SearchQueryData": { + "properties": { + "type": { + "type": "string", + "const": "search_query", + "title": "Type", + "default": "search_query" + }, + "search_query": { + "type": "string", + "minLength": 1, + "title": "Search Query" + } + }, + "type": "object", + "required": [ + "search_query" + ], + "title": "SearchQueryData" + }, + "SearchType": { + "type": "string", + "enum": [ + "attachment", + "listing", + "ransomleak", + "forum_post", + "forum_topic", + "forum_profile", + "blog_post", + "seller", + "paste", + "leak", + "chat_message", + "domain", + "bot", + "stealer_log", + "infected_devices", + "driller", + "driller_forum_topic", + "driller_forum_post", + "driller_profile", + "cc", + "ccbin", + "financial_data", + "leaked_data", + "leaked_file", + "document", + "account", + "actor", + "forum_content", + "blog_content", + "profile", + "leaked_credential", + "valid_credential", + "invalid_credential", + "mitigated_credential", + "illicit_networks", + "open_web", + "domains", + "intelligence_object", + "leaks", + "social_media_account", + "social_media", + "source_code", + "source_code_secrets_np", + "source_code_secrets", + "source_code_files", + "docker", + "stack_exchange", + "google", + "service", + "driller_host", + "buckets", + "bucket", + "bucket_object", + "whois", + "ad", + "ads", + "cookie", + "pii", + "experimental" + ], + "title": "SearchType" + }, + "SecretData": { + "properties": { + "type": { + "type": "string", + "const": "secret", + "title": "Type", + "default": "secret" + }, + "secret": { + "type": "string", + "minLength": 1, + "title": "Secret" + } + }, + "type": "object", + "required": [ + "secret" + ], + "title": "SecretData" + }, + "SecretQuery": { + "properties": { + "type": { + "type": "string", + "const": "secret", + "title": "Type" + }, + "secret": { + "type": "string", + "title": "Secret" } }, "type": "object", - "title": "UpdateStrategyPayload" + "required": [ + "type", + "secret" + ], + "title": "SecretQuery" + }, + "Severity": { + "type": "string", + "enum": [ + "info", + "low", + "medium", + "high", + "critical" + ], + "title": "Severity" }, - "UpdateTenantIntegrationPayload": { + "SocialMediaEvent": { "properties": { - "name": { + "event_type": { "type": "string", - "maxLength": 255, - "minLength": 1, - "title": "Name" - }, - "is_enabled": { - "type": "boolean", - "title": "Is Enabled", - "default": true + "const": "social_media_account", + "title": "Event Type", + "default": "social_media_account" }, - "params": { - "oneOf": [ - { - "$ref": "#/components/schemas/EntraIDInputParams" - }, - { - "$ref": "#/components/schemas/ForetraceInputParams" - }, - { - "$ref": "#/components/schemas/OktaInputParams" - } - ], - "title": "Params", - "discriminator": { - "propertyName": "params_type", - "mapping": { - "entra_id": "#/components/schemas/EntraIDInputParams", - "flare_community": "#/components/schemas/ForetraceInputParams", - "okta": "#/components/schemas/OktaInputParams" - } - } + "data": { + "$ref": "#/components/schemas/SocialMediaEventData" }, - "status": { - "anyOf": [ - { - "$ref": "#/components/schemas/TenantIntegrationStatus" - }, - { - "type": "null" - } - ] + "metadata": { + "$ref": "#/components/schemas/EventMetadata" } }, "type": "object", "required": [ - "name", - "params" + "data", + "metadata" ], - "title": "UpdateTenantIntegrationPayload" + "title": "Social Media Account" }, - "UpdateTenantMetadataBody": { + "SocialMediaEventData": { "properties": { - "tags": { + "url": { "anyOf": [ { - "items": { - "type": "string" - }, - "type": "array" + "type": "string" }, { "type": "null" } ], - "title": "Tags" + "title": "Url", + "description": "The URL to the profile page of the social media account." }, - "severity": { + "site": { "anyOf": [ { - "$ref": "#/components/schemas/Severity" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Site", + "description": "The name of the platform where the account was found." }, - "notes": { + "username": { "anyOf": [ { "type": "string" @@ -39035,20 +9635,20 @@ "type": "null" } ], - "title": "Notes" + "title": "Username", + "description": "The username of the account that was found." } }, "type": "object", - "title": "UpdateTenantMetadataBody" + "title": "SocialMediaEventData" }, - "UpdateTenantRequestBody": { + "SourceV2": { "properties": { - "name": { + "id": { "type": "string", - "minLength": 1, - "title": "Name" + "title": "Id" }, - "description": { + "name": { "anyOf": [ { "type": "string" @@ -39057,403 +9657,248 @@ "type": "null" } ], - "title": "Description" + "title": "Name" }, - "number_of_employees": { + "description_en": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Number Of Employees" - }, - "industry": { - "$ref": "#/components/schemas/TenantIndustry" + "title": "Description En" }, - "identifier_limit": { + "description_fr": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Identifier Limit" + "title": "Description Fr" }, - "prevent_global_search": { + "breached_at": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "type": "null" } ], - "title": "Prevent Global Search" - } - }, - "type": "object", - "required": [ - "name", - "description", - "number_of_employees", - "industry", - "identifier_limit", - "prevent_global_search" - ], - "title": "UpdateTenantRequestBody" - }, - "UrlSubmission": { - "properties": { - "url": { - "type": "string", - "title": "Url" - }, - "live_interaction": { - "type": "boolean", - "title": "Live Interaction", - "default": false - } - }, - "type": "object", - "required": [ - "url" - ], - "title": "UrlSubmission" - }, - "UserPermissions": { - "type": "string", - "enum": [ - "firework.identifiers.search_query", - "firework.global_search", - "firework.identifiers.search_query.regex", - "leaksdb", - "leaksdb.show-passwords", - "ads", - "do-not-track", - "firework.api.can_use_apikeys", - "bypass-mfa", - "audit_log", - "audit_log_reveal_impersonations", - "partner_portal", - "partner_portal_redirect", - "pendo", - "qa", - "qa.test-bench", - "ai-assist-disabled", - "leaked_files.allow_download", - "file_transfers", - "supply_chain_monitoring", - "threat_flow_custom_reports", - "firework.identifiers.discovery_policy", - "integrations", - "alert_channels", - "ioc_feeds", - "query_identifier_count_legacy", - "enable_identifier_count_deduplication", - "white_labeling", - "github_account_sync", - "illicit_political_content", - "phishing_content", - "law_enforcement_content", - "disable_search_restrictions", - "firework.global_search_package_quota_only_count_api", - "enforce_global_search_limit", - "mask_pii", - "disable_rate_limit_csm_notification", - "referrals_hidden", - "astp_credentials_access", - "astp_cookies_access", - "full_text_contents_view", - "full_text_contents_download", - "foretrace", - "labs", - "iem.credentials_browser", - "iem.identity_sync", - "iem.credentials_browser_bulk_validation", - "advanced_security_mode", - "llm_recommendations", - "retain_audit_log_indefinitely", - "brand" - ], - "title": "UserPermissions" - }, - "UserTenantAccess": { - "properties": { - "user_id": { - "type": "integer", - "title": "User Id" - }, - "tenant_role": { - "$ref": "#/components/schemas/TenantRoleType" - } - }, - "type": "object", - "required": [ - "user_id", - "tenant_role" - ], - "title": "UserTenantAccess" - }, - "UsernameData": { - "properties": { - "type": { - "type": "string", - "const": "username", - "title": "Type", - "default": "username" - }, - "username": { - "type": "string", - "minLength": 1, - "title": "Username" - } - }, - "type": "object", - "required": [ - "username" - ], - "title": "UsernameData" - }, - "UsernameQuery": { - "properties": { - "type": { - "type": "string", - "const": "username", - "title": "Type" + "title": "Breached At" }, - "username": { - "type": "string", - "title": "Username" - } - }, - "type": "object", - "required": [ - "type", - "username" - ], - "title": "UsernameQuery" - }, - "ValidateByIDPActionParams": { - "properties": { - "type": { - "type": "string", - "const": "validate_with_idp", - "title": "Type" + "leaked_at": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Leaked At" }, - "tenant_integration_id": { - "type": "string", - "format": "uuid", - "title": "Tenant Integration Id" - } - }, - "type": "object", - "required": [ - "type", - "tenant_integration_id" - ], - "title": "ValidateByIDPActionParams" - }, - "ValidateIntelTopicPayload": { - "properties": { - "topic": { - "type": "string", - "title": "Topic" - } - }, - "type": "object", - "required": [ - "topic" - ], - "title": "ValidateIntelTopicPayload" - }, - "ValidateIntelTopicResponse": { - "properties": { - "valid": { + "is_alert_enabled": { "type": "boolean", - "title": "Valid" + "title": "Is Alert Enabled" }, - "violations": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Violations" - } - }, - "type": "object", - "required": [ - "valid", - "violations" - ], - "title": "ValidateIntelTopicResponse" - }, - "ValidationError": { - "properties": { - "loc": { - "items": { - "anyOf": [ - { + "pii_tags": { + "anyOf": [ + { + "items": { "type": "string" }, - { - "type": "integer" - } - ] - }, - "type": "array", - "title": "Location" - }, - "msg": { - "type": "string", - "title": "Message" - }, - "type": { - "type": "string", - "title": "Error Type" - }, - "input": { - "title": "Input" + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Pii Tags" }, - "ctx": { - "type": "object", - "title": "Context" + "url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Url" } }, "type": "object", "required": [ - "loc", - "msg", - "type" + "id", + "name", + "description_en", + "description_fr", + "breached_at", + "leaked_at", + "is_alert_enabled", + "pii_tags", + "url" ], - "title": "ValidationError" + "title": "SourceV2" }, - "VipIdentityDataRequestBody": { + "StealerLogCookie": { "properties": { - "type": { + "host_key": { "type": "string", - "const": "identity", - "title": "Type" + "title": "Host Key" }, - "attributes": { - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/EmailData" - }, - { - "$ref": "#/components/schemas/NameData" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "email": "#/components/schemas/EmailData", - "name": "#/components/schemas/NameData" - } + "path": { + "type": "string", + "title": "Path" + }, + "expires_utc": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" } - }, - "type": "array", - "maxItems": 10, - "minItems": 1, - "title": "Attributes" + ], + "title": "Expires Utc" + }, + "name": { + "type": "string", + "title": "Name" + }, + "value": { + "type": "string", + "title": "Value" } }, "type": "object", "required": [ - "type", - "attributes" + "host_key", + "path", + "expires_utc", + "name", + "value" ], - "title": "VipIdentityDataRequestBody" + "title": "StealerLogCookie" }, - "VipProtectionBulkDeleteBody": { + "StealerLogCredential": { "properties": { - "identifier_ids": { - "items": { - "type": "integer" - }, - "type": "array", - "minItems": 1, - "title": "Identifier Ids" + "url": { + "type": "string", + "title": "Url" + }, + "username": { + "type": "string", + "title": "Username" + }, + "password": { + "type": "string", + "title": "Password" + }, + "application": { + "type": "string", + "title": "Application" } }, "type": "object", "required": [ - "identifier_ids" + "url", + "username", + "password", + "application" ], - "title": "VipProtectionBulkDeleteBody" + "title": "StealerLogCredential" }, - "VipProtectionCreateBody": { + "StealerLogEventData": { "properties": { - "data": { - "$ref": "#/components/schemas/VipIdentityDataRequestBody" + "victim_information": { + "anyOf": [ + { + "$ref": "#/components/schemas/pyro__findings__stealerlogs__datamodels__VictimInformation" + }, + { + "type": "null" + } + ], + "description": "Collection of data that relates to the victim and their infected device." }, - "name": { + "malware_information": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/MalwareInformation" }, { "type": "null" } ], - "title": "Name" + "description": "Collection of data that relates to the malware that was used to infect the victim's device." } }, "type": "object", "required": [ - "data" + "victim_information", + "malware_information" ], - "title": "VipProtectionCreateBody" + "title": "StealerLogEventData" }, - "VipProtectionListItem": { + "SubdomainStatus": { "properties": { - "id": { - "type": "integer", - "title": "Id" + "status": { + "$ref": "#/components/schemas/DomainStatus" }, - "name": { + "updated_at": { "type": "string", - "title": "Name" - }, - "email": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Email" + "format": "date-time", + "title": "Updated At" } }, "type": "object", "required": [ - "id", - "name", - "email" + "status", + "updated_at" ], - "title": "VipProtectionListItem" + "title": "SubdomainStatus" }, - "VipProtectionResponse": { + "SubdomainTag": { "properties": { - "identifier": { - "$ref": "#/components/schemas/Identifier" + "label": { + "type": "string", + "title": "Label" + }, + "keyword": { + "type": "string", + "title": "Keyword" + }, + "span": { + "items": { + "type": "integer" + }, + "type": "array", + "title": "Span" } }, "type": "object", "required": [ - "identifier" + "label", + "keyword", + "span" ], - "title": "VipProtectionResponse" + "title": "SubdomainTag" }, - "VipProtectionUpdateRequestBody": { + "TenantMetadataResponse": { "properties": { - "data": { - "$ref": "#/components/schemas/VipIdentityDataRequestBody" + "uid": { + "type": "string", + "title": "Uid" }, - "name": { + "notes": { "anyOf": [ { "type": "string" @@ -39462,285 +9907,290 @@ "type": "null" } ], - "title": "Name" - } - }, - "type": "object", - "required": [ - "data" - ], - "title": "VipProtectionUpdateRequestBody" - }, - "VulnerabilityEntityAPIResponse": { - "properties": { - "uuid": { - "type": "string", - "title": "Uuid" - }, - "type": { - "$ref": "#/components/schemas/EntityType" - }, - "name": { - "type": "string", - "title": "Name" - }, - "created_by": { - "type": "string", - "title": "Created By" + "title": "Notes" }, - "sources": { + "tags": { "items": { - "$ref": "#/components/schemas/CTIEntitySourceAPIResponse" + "type": "string" }, "type": "array", - "title": "Sources" + "title": "Tags" }, - "created_at": { + "severity": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Created At" - }, - "updated_at": { + "title": "Severity" + } + }, + "type": "object", + "required": [ + "uid", + "notes", + "tags", + "severity" + ], + "title": "TenantMetadataResponse" + }, + "ThreatFlowReportDownloadFormat": { + "type": "string", + "enum": [ + "docx", + "pdf" + ], + "title": "ThreatFlowReportDownloadFormat" + }, + "ThreatFlowReportFormatType": { + "type": "string", + "enum": [ + "simple_summary", + "expanded_summary", + "finished_intel_standard" + ], + "title": "ThreatFlowReportFormatType" + }, + "TimeRangeType": { + "type": "string", + "enum": [ + "all", + "last_24h", + "last_2d", + "last_7d", + "last_1m", + "last_3m", + "last_6m", + "range" + ], + "title": "TimeRangeType" + }, + "Types": { + "properties": { + "is_guide": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "boolean" }, { "type": "null" } ], - "title": "Updated At" + "title": "Is Guide", + "description": "Whether the listing is a guide. Ex: 'How to extort a website'" }, - "first_seen_at": { + "is_service": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "boolean" }, { "type": "null" } ], - "title": "First Seen At" + "title": "Is Service", + "description": "Whether the listing is offering a service. Ex: 'I will help you extort a website'" }, - "last_seen_at": { + "is_software": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "boolean" }, { "type": "null" } ], - "title": "Last Seen At" + "title": "Is Software", + "description": "Whether the listing is offering software. Ex: 'I will sell you a software to extort a website'" }, - "confidence": { + "is_hardware": { "anyOf": [ { - "type": "integer" + "type": "boolean" }, { "type": "null" } ], - "title": "Confidence" + "title": "Is Hardware", + "description": "Whether the listing is offering hardware. Ex: 'I will sell you a hardware'" }, - "description": { + "is_data": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Description" - }, - "marking_definitions": { - "items": { - "$ref": "#/components/schemas/MarkingDefinition" - }, - "type": "array", - "title": "Marking Definitions" + "title": "Is Data", + "description": "Whether the listing is offering data. Ex: 'I will sell you victim data'" } }, "type": "object", - "required": [ - "uuid", - "type", - "name", - "created_by", - "sources", - "created_at", - "updated_at", - "description", - "marking_definitions" - ], - "title": "VulnerabilityEntityAPIResponse" + "title": "Types" }, - "WebhookBasicAuth": { + "UpdateMatchingPolicyBody": { "properties": { - "username": { + "name": { "type": "string", - "title": "Username" + "minLength": 1, + "title": "Name", + "description": "The new name of the matching policy" }, - "password": { - "type": "string", - "title": "Password" + "value": { + "$ref": "#/components/schemas/PolicyValue", + "description": "The new value of the matching policy depending on its type" } }, "type": "object", "required": [ - "username", - "password" + "name", + "value" ], - "title": "WebhookBasicAuth" + "title": "UpdateMatchingPolicyBody" }, - "WhoisRdapInfo": { + "UpdateTenantMetadataBody": { "properties": { - "registrar": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Registrar" - }, - "contact_email": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Contact Email" - }, - "epp_status": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Epp Status" - }, - "registered_date": { + "tags": { "anyOf": [ { - "type": "string", - "format": "date-time" + "items": { + "type": "string" + }, + "type": "array" }, { "type": "null" } ], - "title": "Registered Date" + "title": "Tags" }, - "updated_date": { + "severity": { "anyOf": [ { - "type": "string", - "format": "date-time" + "$ref": "#/components/schemas/Severity" }, { "type": "null" } - ], - "title": "Updated Date" + ] }, - "expires_date": { + "notes": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Expires Date" + "title": "Notes" } }, "type": "object", - "title": "WhoisRdapInfo" - }, - "pyro__entities__domain__domain_browser_sort_type__SortType": { - "type": "string", - "enum": [ - "severity", - "fqdn", - "discovered_at", - "updated_at" - ], - "title": "SortType" - }, - "pyro__entities__domain__profile__sort_type__SortType": { - "type": "string", - "enum": [ - "date", - "event_type", - "severity" - ], - "title": "SortType" + "title": "UpdateTenantMetadataBody" }, - "pyro__entities__identities__identity_browser_sort_type__SortType": { - "type": "string", - "enum": [ - "severity", - "name", - "email", - "last_seen_at" + "UsernameData": { + "properties": { + "type": { + "type": "string", + "const": "username", + "title": "Type", + "default": "username" + }, + "username": { + "type": "string", + "minLength": 1, + "title": "Username" + } + }, + "type": "object", + "required": [ + "username" ], - "title": "SortType" + "title": "UsernameData" }, - "pyro__entities__identities__profile__sort_type__SortType": { - "type": "string", - "enum": [ - "creation_date", - "credentials_count", - "event_type", - "information_type", - "ip_address", - "last_seen", - "leaked_date", - "password", - "source_name" + "UsernameQuery": { + "properties": { + "type": { + "type": "string", + "const": "username", + "title": "Type" + }, + "username": { + "type": "string", + "title": "Username" + } + }, + "type": "object", + "required": [ + "type", + "username" ], - "title": "SortType" + "title": "UsernameQuery" }, - "pyro__events__event_datamodels__StealerLogEvent": { + "ValidationError": { "properties": { + "loc": { + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ] + }, + "type": "array", + "title": "Location" + }, + "msg": { + "type": "string", + "title": "Message" + }, "type": { "type": "string", - "const": "stealer_log", - "title": "Type", - "default": "stealer_log" + "title": "Error Type" }, - "data": { - "$ref": "#/components/schemas/StealerLogData" + "input": { + "title": "Input" }, - "actions": { - "$ref": "#/components/schemas/StealerLogActions" + "ctx": { + "type": "object", + "title": "Context" } }, "type": "object", "required": [ - "data", - "actions" + "loc", + "msg", + "type" + ], + "title": "ValidationError" + }, + "WebhookBasicAuth": { + "properties": { + "username": { + "type": "string", + "title": "Username" + }, + "password": { + "type": "string", + "title": "Password" + } + }, + "type": "object", + "required": [ + "username", + "password" ], - "title": "StealerLogEvent" + "title": "WebhookBasicAuth" }, "pyro__findings__chat_messages__datamodels__ChatMessageEventData__Actor": { "properties": { @@ -40371,18 +10821,6 @@ ], "title": "VictimInformation" }, - "pyro__firework__backend__api4__reports__report_groups__reports__report_datamodels__ReportResponse": { - "properties": { - "report": { - "$ref": "#/components/schemas/Report" - } - }, - "type": "object", - "required": [ - "report" - ], - "title": "ReportResponse" - }, "pyro__reports__report_store__SortType": { "type": "string", "enum": [ @@ -40395,15 +10833,6 @@ ], "title": "SortType" }, - "pyro__reports__report_types__ReportType": { - "type": "string", - "enum": [ - "v1", - "event_based", - "feed_based" - ], - "title": "ReportType" - }, "pyro__threat_flow__core__reports__report_store__ReportType": { "type": "string", "enum": [ @@ -40412,16 +10841,6 @@ ], "title": "ReportType" }, - "pyro__threat_flow__core__reports__report_store__SortType": { - "type": "string", - "enum": [ - "id", - "published_at", - "organization_id", - "tenant_id" - ], - "title": "SortType" - }, "pyro__threat_flow__web__v4__reports__models__ReportResponse": { "properties": { "report": { diff --git a/docs/api-reference/v4/endpoints/bulk-actions.mdx b/docs/api-reference/v4/endpoints/bulk-actions.mdx deleted file mode 100644 index 9f20c296..00000000 --- a/docs/api-reference/v4/endpoints/bulk-actions.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: firework-v4-openapi post /firework/v4/tasks/ ---- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/create-conversation-summary-request.mdx b/docs/api-reference/v4/endpoints/create-conversation-summary-request.mdx deleted file mode 100644 index 41abc99e..00000000 --- a/docs/api-reference/v4/endpoints/create-conversation-summary-request.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: firework-v4-openapi put /firework/v4/threat_flow/conversation_summary_requests/ ---- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/delete-alert.mdx b/docs/api-reference/v4/endpoints/delete-alert.mdx deleted file mode 100644 index a046a02f..00000000 --- a/docs/api-reference/v4/endpoints/delete-alert.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: firework-v4-openapi delete /firework/v4/alerts/{alert_id} ---- \ No newline at end of file diff --git a/scripts/openapi-post-process.py b/scripts/openapi-post-process.py index f6c315b1..f403eb36 100755 --- a/scripts/openapi-post-process.py +++ b/scripts/openapi-post-process.py @@ -3,6 +3,68 @@ import json import sys +from typing import Any + +HTTP_METHODS = {"get", "put", "post", "delete", "options", "head", "patch", "trace"} + + +def remove_private_operations(openapi_schema: dict) -> None: + for path in list(openapi_schema["paths"].keys()): + path_item = openapi_schema["paths"][path] + + for method in list(path_item.keys()): + if method not in HTTP_METHODS: + continue + if "private" in path_item[method].get("tags", []): + del path_item[method] + + if not any(method in path_item for method in HTTP_METHODS): + del openapi_schema["paths"][path] + + +def find_schema_refs(obj: Any) -> set[str]: + refs: set[str] = set() + + if isinstance(obj, dict): + ref = obj.get("$ref") + if isinstance(ref, str) and ref.startswith("#/components/schemas/"): + refs.add(ref.removeprefix("#/components/schemas/")) + for value in obj.values(): + refs |= find_schema_refs(value) + elif isinstance(obj, list): + for item in obj: + refs |= find_schema_refs(item) + + return refs + + +def remove_unused_schemas(openapi_schema: dict) -> None: + schemas = openapi_schema.get("components", {}).get("schemas", {}) + if not schemas: + return + + used = find_schema_refs(openapi_schema["paths"]) + + # Schemas can reference other schemas, so keep expanding until no new + # schema names are discovered. + frontier = used + while frontier: + frontier = ( + set().union( + *( + find_schema_refs(schemas[name]) + for name in frontier + if name in schemas + ) + ) + - used + ) + used |= frontier + + for name in list(schemas.keys()): + if name not in used: + del schemas[name] + def main() -> None: if len(sys.argv) != 2: @@ -13,6 +75,9 @@ def main() -> None: with open(path, "r") as f: openapi_schema = json.loads(f.read()) + remove_private_operations(openapi_schema) + remove_unused_schemas(openapi_schema) + openapi_schema["components"]["securitySchemes"] = { "BearerAuth": { "type": "http",