From 89b2cac6f8b2ac661668170c32fa7f7cbdd5f484 Mon Sep 17 00:00:00 2001 From: Matei Date: Tue, 7 Jul 2026 13:05:20 -0400 Subject: [PATCH 1/9] Create docker repository schema --- .../docker_repository.mdx | 31 +++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 docs/snippets/event_model_examples/docker_repository.mdx diff --git a/docs/snippets/event_model_examples/docker_repository.mdx b/docs/snippets/event_model_examples/docker_repository.mdx new file mode 100644 index 0000000..6f295ec --- /dev/null +++ b/docs/snippets/event_model_examples/docker_repository.mdx @@ -0,0 +1,31 @@ +{/* + If you are in pyro: + - If this file changes, you should also modify the API docs. + - https://github.com/flared/docs-api/ + + If you are in mintlify: + - Don't edit this directly, edit the generator in pyro. + - pyro/pyro/mintlify/test_firework_event_models.py +*/} + +```json Docker Repository +{ + "event_type": "docker_repository", + "data": { + "url": "https://hub.docker.com/r/flared/docker", + "star_count": 5, + "pull_count": 10000, + "collaborator_count": 2, + "last_updated_at": "2026-01-01T00:00:00", + "last_modified_at": "2025-01-01T00:00:00", + "registered_at": "2024-01-01T00:00:00" + }, + "metadata": { + "estimated_created_at": "2025-01-01T00:00:00", + "flare_url": "https://app.flare.io/#/uid", + "matched_at": null, + "severity": "info", + "uid": "index/source/id" + } +} +``` From 8e5e1c1e86ffdc9008cc624cb45f6e23c2cc5987 Mon Sep 17 00:00:00 2001 From: Matei Date: Tue, 7 Jul 2026 13:15:01 -0400 Subject: [PATCH 2/9] Add docker repository to docs --- .../spec/firework-v4-openapi.json | 32007 +++++++++++++--- docs/docs.json | 1 + docs/event-types-v2/docker_repository.mdx | 10 + docs/event-types-v2/overview.mdx | 1 + .../event_model_examples/docker_image.mdx | 41 + .../event_model_examples/events_overview.mdx | 8 +- 6 files changed, 26102 insertions(+), 5966 deletions(-) create mode 100644 docs/event-types-v2/docker_repository.mdx create mode 100644 docs/snippets/event_model_examples/docker_image.mdx diff --git a/docs/api-reference/spec/firework-v4-openapi.json b/docs/api-reference/spec/firework-v4-openapi.json index 5e14d2b..625f4a9 100644 --- a/docs/api-reference/spec/firework-v4-openapi.json +++ b/docs/api-reference/spec/firework-v4-openapi.json @@ -10,22 +10,108 @@ } ], "paths": { - "/firework/v4/admin/identifiers/{tenant_id}/free_trial_identifier": { + "/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": [ - "public", + "private", "team=experience" ], - "summary": "Create Identifier For Free Trial", - "operationId": "create_identifier_for_free_trial_admin_identifiers__tenant_id__free_trial_identifier_post", + "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": { + "post": { + "tags": [ + "private", + "team=experience" + ], + "summary": "Search Admin Audit Events", + "operationId": "search_admin_audit_events_admin_organizations__organization_id__audit_logs__search_post", "parameters": [ { - "name": "tenant_id", + "name": "organization_id", "in": "path", "required": true, "schema": { "type": "integer", - "title": "Tenant Id" + "title": "Organization Id" } } ], @@ -34,7 +120,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/IdentifierRequestBody" + "$ref": "#/components/schemas/AdminAuditEventRequestBody" } } } @@ -45,7 +131,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/IdentifierResponse" + "$ref": "#/components/schemas/PaginatedResultsWithTotalCount_AuditEventItemResponse_str_" } } } @@ -63,92 +149,113 @@ } } }, - "/firework/v4/alerts/": { + "/firework/v4/admin/organizations/{organization_id}/audit_logs/{audit_log_id}": { "get": { "tags": [ - "public", + "private", "team=experience" ], - "summary": "Tenant Alerts", - "operationId": "tenant_alerts_alerts__get", + "summary": "Get Admin Audit Log", + "operationId": "get_admin_audit_log_admin_organizations__organization_id__audit_logs__audit_log_id__get", "parameters": [ { - "name": "from", - "in": "query", - "required": false, + "name": "organization_id", + "in": "path", + "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From" + "type": "integer", + "title": "Organization Id" } }, { - "name": "size", - "in": "query", - "required": false, + "name": "audit_log_id", + "in": "path", + "required": true, "schema": { "type": "integer", - "maximum": 10, - "exclusiveMinimum": 0, - "default": 10, - "title": "Size" + "title": "Audit Log Id" } - }, - { - "name": "order_type", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/OrderType", - "default": "asc" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AuditEventItemResponse" + } + } } }, - { - "name": "q", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" } - ], - "title": "Q" + } + } + } + } + } + }, + "/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": "feed_owner_id", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" } - ], - "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/PaginatedResults_Alert_str_" + "$ref": "#/components/schemas/BannerResponse" } } } @@ -164,68 +271,45 @@ } } } - } - }, - "/firework/v4/alerts/channels": { - "get": { + }, + "delete": { "tags": [ - "public", - "team=integration" + "private", + "team=collection-platform" ], - "summary": "Alert Channels", - "operationId": "alert_channels_alerts_channels_get", + "summary": "Clear Banner", + "operationId": "clear_banner_admin_banners__delete", "parameters": [ { - "name": "from", + "name": "organization_id", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "From" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "maximum": 10, - "exclusiveMinimum": 0, - "default": 10, - "title": "Size" + "title": "Organization Id" } }, { - "name": "order_type", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/OrderType", - "default": "asc" - } - }, - { - "name": "q", + "name": "tenant_id", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Q" + "title": "Tenant Id" } } ], @@ -234,9 +318,7 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_PartialAlertChannel_str_" - } + "schema": {} } } }, @@ -251,23 +333,24 @@ } } } - }, + } + }, + "/firework/v4/admin/events/import": { "post": { "tags": [ - "public", - "team=integration" + "private" ], - "summary": "Create Channel", - "operationId": "create_channel_alerts_channels_post", + "summary": "Import Event", + "operationId": "import_event_admin_events_import_post", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateAlertChannel" + "$ref": "#/components/schemas/ImportExperimentalEventModel" } } - } + }, + "required": true }, "responses": { "200": { @@ -275,7 +358,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AlertChannel" + "$ref": "#/components/schemas/ImportEventResult" } } } @@ -293,30 +376,72 @@ } } }, - "/firework/v4/credentials/global/_search": { - "post": { + "/firework/v4/admin/cookies/configurations": { + "get": { "tags": [ - "public" + "private" ], - "summary": "Credentials Global Search", - "operationId": "credentials_global_search_credentials_global__search_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CredentialsQueryPayload" - } + "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" } }, - "required": true - }, + { + "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" + } + } + ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedResults_Credential_str_" + "$ref": "#/components/schemas/PagedCookieConfigurations" } } } @@ -334,26 +459,25 @@ } } }, - "/firework/v4/credentials/actions": { + "/firework/v4/admin/cookies/monitor": { "post": { "tags": [ - "public", - "team=experience" + "private" ], - "summary": "Credential Actions", - "operationId": "credential_actions_credentials_actions_post", + "summary": "Create Cookie Monitoring Configuration", + "operationId": "create_cookie_monitoring_configuration_admin_cookies_monitor_post", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CredentialActionRequestBody" + "$ref": "#/components/schemas/CreateCookieMonitoringConfigurationItem" } } }, "required": true }, "responses": { - "200": { + "201": { "description": "Successful Response", "content": { "application/json": { @@ -374,113 +498,27 @@ } } }, - "/firework/v4/events/": { - "get": { + "/firework/v4/admin/cookies/configurations/{id}": { + "delete": { "tags": [ - "public", - "team=integration" + "private" ], - "summary": "Get Event", - "operationId": "get_event_events__get", + "summary": "Delete Cookie Monitoring Configuration", + "operationId": "delete_cookie_monitoring_configuration_admin_cookies_configurations__id__delete", "parameters": [ { - "name": "uid", - "in": "query", + "name": "id", + "in": "path", "required": true, "schema": { - "type": "string", - "title": "Uid" + "type": "integer", + "title": "Id" } } ], "responses": { - "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/InvalidCredentialEvent" - }, - { - "$ref": "#/components/schemas/LeakedCredentialEvent" - }, - { - "$ref": "#/components/schemas/ListingEvent" - }, - { - "$ref": "#/components/schemas/LookalikeDomainEvent" - }, - { - "$ref": "#/components/schemas/MitigatedCredentialEvent" - }, - { - "$ref": "#/components/schemas/PasteEvent" - }, - { - "$ref": "#/components/schemas/RansomLeakEvent" - }, - { - "$ref": "#/components/schemas/ServiceEvent" - }, - { - "$ref": "#/components/schemas/SocialMediaEvent" - }, - { - "$ref": "#/components/schemas/pyro__findings__stealerlogs__datamodels__StealerLogEvent" - }, - { - "$ref": "#/components/schemas/ValidCredentialEvent" - } - ], - "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", - "invalid_credential": "#/components/schemas/InvalidCredentialEvent", - "leaked_credential": "#/components/schemas/LeakedCredentialEvent", - "listing": "#/components/schemas/ListingEvent", - "lookalike": "#/components/schemas/LookalikeDomainEvent", - "mitigated_credential": "#/components/schemas/MitigatedCredentialEvent", - "paste": "#/components/schemas/PasteEvent", - "ransomleak": "#/components/schemas/RansomLeakEvent", - "service": "#/components/schemas/ServiceEvent", - "social_media_account": "#/components/schemas/SocialMediaEvent", - "stealer_log": "#/components/schemas/pyro__findings__stealerlogs__datamodels__StealerLogEvent", - "valid_credential": "#/components/schemas/ValidCredentialEvent" - } - } - }, - { - "$ref": "#/components/schemas/EmptyFireworkEvent" - } - ], - "title": "Response Get Event Events Get" - } - } - } + "204": { + "description": "Successful Response" }, "422": { "description": "Validation Error", @@ -495,29 +533,42 @@ } } }, - "/firework/v4/events/tenant/_search": { - "post": { + "/firework/v4/admin/feature_flags/": { + "get": { "tags": [ - "public" + "private" ], - "summary": "Current Tenant Feed", - "operationId": "current_tenant_feed_events_tenant__search_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FeedRequestBody" - } + "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" } } - }, + ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedResults_FeedItem_str_" + "$ref": "#/components/schemas/ListFeatureFlagsResponse" } } } @@ -533,24 +584,22 @@ } } } - } - }, - "/firework/v4/events/global/_search": { + }, "post": { "tags": [ - "public" + "private" ], - "summary": "Global Search", - "operationId": "global_search_events_global__search_post", + "summary": "Create Feature Flag", + "operationId": "create_feature_flag_admin_feature_flags__post", "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GlobalSearchRequestBody" + "$ref": "#/components/schemas/CreateFeatureFlagPayload" } } - }, - "required": true + } }, "responses": { "200": { @@ -558,7 +607,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedResults_GlobalFeedItem_str_" + "$ref": "#/components/schemas/FeatureFlagResponse" } } } @@ -576,40 +625,90 @@ } } }, - "/firework/v4/events/identifiers/{identifier_id}/_search": { - "post": { + "/firework/v4/admin/feature_flags/status": { + "get": { "tags": [ - "public" + "private" ], - "summary": "Identifier Feed", - "operationId": "identifier_feed_events_identifiers__identifier_id___search_post", + "summary": "Get Feature Flag Status", + "operationId": "get_feature_flag_status_admin_feature_flags_status_get", "parameters": [ { - "name": "identifier_id", - "in": "path", - "required": true, + "name": "page", + "in": "query", + "required": false, "schema": { "type": "integer", - "title": "Identifier Id" + "default": 1, + "title": "Page" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FeedRequestBody" - } + }, + { + "name": "size", + "in": "query", + "required": false, + "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" } } - }, + ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedResults_FeedItem_str_" + "$ref": "#/components/schemas/ListFeatureFlagsStatusResponse" } } } @@ -627,40 +726,31 @@ } } }, - "/firework/v4/events/identifier_groups/{identifier_group_id}/_search": { - "post": { + "/firework/v4/admin/feature_flags/details/{feature_flag_name}": { + "get": { "tags": [ - "public" + "private" ], - "summary": "Identifier Group Feed", - "operationId": "identifier_group_feed_events_identifier_groups__identifier_group_id___search_post", + "summary": "Get Feature Flag", + "operationId": "get_feature_flag_admin_feature_flags_details__feature_flag_name__get", "parameters": [ { - "name": "identifier_group_id", + "name": "feature_flag_name", "in": "path", "required": true, "schema": { - "type": "integer", - "title": "Identifier Group Id" + "type": "string", + "title": "Feature Flag Name" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FeedRequestBody" - } - } - } - }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedResults_FeedItem_str_" + "$ref": "#/components/schemas/FeatureFlagDefinition" } } } @@ -678,25 +768,47 @@ } } }, - "/firework/v4/events/filters/types": { + "/firework/v4/admin/feature_flags/user-lists": { "get": { "tags": [ - "public" + "private" ], - "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": { + "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": { @@ -707,22 +819,30 @@ } } } - } - }, - "/firework/v4/events/filters/severities": { - "get": { + }, + "post": { "tags": [ - "public" + "private" ], - "summary": "Fetch Filters Risk Score", - "operationId": "fetch_filters_risk_score_events_filters_severities_get", + "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" + } + } + } + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FilterSeverities" + "$ref": "#/components/schemas/FeatureFlagUserListResponse" } } } @@ -740,30 +860,32 @@ } } }, - "/firework/v4/events/actions": { - "post": { + "/firework/v4/admin/feature_flags/user-lists/{iid}": { + "get": { "tags": [ - "public", - "team=experience" + "private" ], - "summary": "Event Actions", - "operationId": "event_actions_events_actions_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EventActionsBody" - } + "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" } - }, - "required": true - }, + } + ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/FeatureFlagUserList" + } } } }, @@ -780,22 +902,21 @@ } } }, - "/firework/v4/events/tenant/metadata": { - "patch": { + "/firework/v4/admin/feature_flags/user-lists/{user_list_iid}": { + "put": { "tags": [ - "public", - "team=experience" + "private" ], - "summary": "Update Tenant Metadata", - "operationId": "update_tenant_metadata_events_tenant_metadata_patch", + "summary": "Update Feature Flag User List", + "operationId": "update_feature_flag_user_list_admin_feature_flags_user_lists__user_list_iid__put", "parameters": [ { - "name": "uid", - "in": "query", + "name": "user_list_iid", + "in": "path", "required": true, "schema": { - "type": "string", - "title": "Uid" + "type": "integer", + "title": "User List Iid" } } ], @@ -804,7 +925,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateTenantMetadataBody" + "$ref": "#/components/schemas/UpdateFeatureFlagUserListPayload" } } } @@ -815,7 +936,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TenantMetadataResponse" + "$ref": "#/components/schemas/FeatureFlagUserListResponse" } } } @@ -831,79 +952,130 @@ } } } - } - }, - "/firework/v4/events/_expand": { - "get": { + }, + "delete": { "tags": [ - "public", - "team=experience" + "private" ], - "summary": "Expand Event Field", - "operationId": "expand_event_field_events__expand_get", + "summary": "Delete Feature Flag User List", + "operationId": "delete_feature_flag_user_list_admin_feature_flags_user_lists__user_list_iid__delete", "parameters": [ { - "name": "field", - "in": "query", + "name": "user_list_iid", + "in": "path", "required": true, "schema": { - "$ref": "#/components/schemas/ExpandableField" + "type": "integer", + "title": "User List Iid" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } } }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/admin/feature_flags/by_name/{feature_flag_name}/add_member": { + "post": { + "tags": [ + "private" + ], + "summary": "Add Member For Feature Flag", + "operationId": "add_member_for_feature_flag_admin_feature_flags_by_name__feature_flag_name__add_member_post", + "parameters": [ { - "name": "uid", - "in": "query", + "name": "feature_flag_name", + "in": "path", "required": true, "schema": { "type": "string", - "title": "Uid" + "title": "Feature Flag Name" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MemberMutationPayload" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } } }, - { - "name": "from", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" } - ], - "title": "From" + } } - }, + } + } + } + }, + "/firework/v4/admin/feature_flags/by_name/{feature_flag_name}/remove_member": { + "post": { + "tags": [ + "private" + ], + "summary": "Remove Member For Feature Flag", + "operationId": "remove_member_for_feature_flag_admin_feature_flags_by_name__feature_flag_name__remove_member_post", + "parameters": [ { - "name": "size", - "in": "query", - "required": false, + "name": "feature_flag_name", + "in": "path", + "required": true, "schema": { - "type": "integer", - "maximum": 20, - "exclusiveMinimum": 0, - "default": 20, - "title": "Size" + "type": "string", + "title": "Feature Flag Name" } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MemberMutationPayload" + } + } + } + }, "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" - } + "schema": {} } } }, @@ -920,22 +1092,40 @@ } } }, - "/firework/v4/healthz/": { - "get": { + "/firework/v4/admin/feature_flags/by_name/{feature_flag_name}": { + "patch": { "tags": [ - "public" + "private" ], - "summary": "Is Api Up And Running", - "operationId": "is_api_up_and_running_healthz__get", + "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, + "schema": { + "type": "string", + "title": "Feature Flag Name" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateFeatureFlagPayload" + } + } + } + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": { - "type": "string", - "title": "Response Is Api Up And Running Healthz Get" - } + "schema": {} } } }, @@ -950,111 +1140,89 @@ } } } - } - }, - "/firework/v4/identifier-recommendations/": { - "get": { + }, + "delete": { "tags": [ - "public", - "team=experience" + "private" ], - "summary": "Fetch Identifier Recommendations", - "operationId": "fetch_identifier_recommendations_identifier_recommendations__get", + "summary": "Delete Feature Flag", + "operationId": "delete_feature_flag_admin_feature_flags_by_name__feature_flag_name__delete", "parameters": [ { - "name": "types", - "in": "query", - "required": false, + "name": "feature_flag_name", + "in": "path", + "required": true, "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "enum": [ - "domain", - "azure_tenant", - "email", - "username" - ], - "type": "string" - } - }, - { - "type": "null" - } - ], - "title": "Types" + "type": "string", + "title": "Feature Flag Name" } - }, - { - "name": "query", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Query" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } } }, - { - "name": "status", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdentifierRecommendationState" - }, - { - "type": "null" + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" } - ], - "title": "Status" + } } - }, + } + } + } + }, + "/firework/v4/admin/feature_flags/by_name/{feature_flag_name}/strategies/{strategy_id}": { + "patch": { + "tags": [ + "private" + ], + "summary": "Update Strategy For Feature Flag", + "operationId": "update_strategy_for_feature_flag_admin_feature_flags_by_name__feature_flag_name__strategies__strategy_id__patch", + "parameters": [ { - "name": "from", - "in": "query", - "required": false, + "name": "feature_flag_name", + "in": "path", + "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "From" + "type": "string", + "title": "Feature Flag Name" } }, { - "name": "size", - "in": "query", - "required": false, + "name": "strategy_id", + "in": "path", + "required": true, "schema": { "type": "integer", - "maximum": 100, - "exclusiveMinimum": 0, - "default": 100, - "title": "Size" + "title": "Strategy Id" } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateStrategyPayload" + } + } + } + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_Recommendation_str_" - } + "schema": {} } } }, @@ -1071,23 +1239,33 @@ } } }, - "/firework/v4/identifier-recommendations/actions": { + "/firework/v4/admin/feature_flags/by_name/{feature_flag_name}/strategies": { "post": { "tags": [ - "public", - "team=experience" + "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, + "schema": { + "type": "string", + "title": "Feature Flag Name" + } + } ], - "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/IdentifierRecommendationActionsBody" + "$ref": "#/components/schemas/CreateStrategyPayload" } } - }, - "required": true + } }, "responses": { "200": { @@ -1111,20 +1289,76 @@ } } }, - "/firework/v4/identifiers/": { + "/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, + "schema": { + "type": "integer", + "title": "Identifier Id" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "type": "string", + "title": "Response Update Domain Identifier Properties Admin Identifiers Identifier Id Update Domain Identifier Properties Post" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/admin/identifiers/{tenant_id}/free_trial_identifier": { "post": { "tags": [ "public", "team=experience" ], - "summary": "Create Identifier", - "operationId": "create_public_identifier_identifiers__post", + "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" + } + } + ], "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PublicIdentifierRequestBody" + "$ref": "#/components/schemas/IdentifierRequestBody" } } } @@ -1135,7 +1369,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PublicIdentifierResponse" + "$ref": "#/components/schemas/IdentifierResponse" } } } @@ -1151,129 +1385,135 @@ } } } - }, + } + }, + "/firework/v4/admin/organizations/{organization_id}/allowed_restricted_terms": { "get": { "tags": [ - "public", - "team=experience", - "feature=identifiers" + "private", + "team=experience" ], - "summary": "List Identifiers", - "operationId": "list_identifiers_identifiers__get", + "summary": "Get Allowed Restricted Terms", + "operationId": "get_allowed_restricted_terms_admin_organizations__organization_id__allowed_restricted_terms_get", "parameters": [ { - "name": "from", - "in": "query", - "required": false, + "name": "organization_id", + "in": "path", + "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" + "type": "integer", + "title": "Organization Id" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAllowedRestrictedTermsResponse" } - ], - "title": "From" + } } }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "post": { + "tags": [ + "private", + "team=experience" + ], + "summary": "Add Allowed Restricted Term", + "operationId": "add_allowed_restricted_term_admin_organizations__organization_id__allowed_restricted_terms_post", + "parameters": [ { - "name": "size", - "in": "query", - "required": false, + "name": "organization_id", + "in": "path", + "required": true, "schema": { "type": "integer", - "maximum": 100, - "exclusiveMinimum": 0, - "default": 20, - "title": "Size" + "title": "Organization Id" } - }, - { - "name": "order_by", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/IdentifierOrderBy", - "default": "id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddAllowedRestrictedTermRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } } }, - { - "name": "is_disabled", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" } - ], - "title": "Is Disabled" + } } - }, + } + } + } + }, + "/firework/v4/admin/organizations/{organization_id}/allowed_restricted_terms/{restricted_term_id}": { + "delete": { + "tags": [ + "private", + "team=experience" + ], + "summary": "Delete Allowed Restricted Terms", + "operationId": "delete_allowed_restricted_terms_admin_organizations__organization_id__allowed_restricted_terms__restricted_term_id__delete", + "parameters": [ { - "name": "group_id", - "in": "query", - "required": false, + "name": "organization_id", + "in": "path", + "required": true, "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Group Id" + "type": "integer", + "title": "Organization Id" } }, { - "name": "types", - "in": "query", - "required": false, + "name": "restricted_term_id", + "in": "path", + "required": true, "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "enum": [ - "bin", - "ip", - "keyword", - "azure_tenant", - "domain", - "search_query", - "github_repository", - "secret", - "identity" - ], - "type": "string" - } - }, - { - "type": "null" - } - ], - "title": "Types" + "type": "string", + "title": "Restricted Term Id" } }, { - "name": "authorization_status", + "name": "remove_related_requests", "in": "query", "required": false, "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdentifierAuthorizationStatus" - }, - { - "type": "null" - } - ], - "title": "Authorization Status" + "type": "boolean", + "default": true, + "title": "Remove Related Requests" } } ], @@ -1282,9 +1522,7 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_PublicIdentifierResponse_str_" - } + "schema": {} } } }, @@ -1299,24 +1537,31 @@ } } } - } - }, - "/firework/v4/identifiers/{identifier_id}": { + }, "put": { "tags": [ - "public", + "private", "team=experience" ], - "summary": "Update Identifier", - "operationId": "update_identifier_by_id_public_identifiers__identifier_id__put", + "summary": "Update Allowed Restricted Terms", + "operationId": "update_allowed_restricted_terms_admin_organizations__organization_id__allowed_restricted_terms__restricted_term_id__put", "parameters": [ { - "name": "identifier_id", + "name": "organization_id", "in": "path", "required": true, "schema": { "type": "integer", - "title": "Identifier Id" + "title": "Organization Id" + } + }, + { + "name": "restricted_term_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Restricted Term Id" } } ], @@ -1325,7 +1570,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PublicIdentifierUpdateRequestBody" + "$ref": "#/components/schemas/UpdateAllowedRestrictedTermRequest" } } } @@ -1335,9 +1580,7 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/PublicIdentifierResponse" - } + "schema": {} } } }, @@ -1352,32 +1595,33 @@ } } } - }, - "get": { + } + }, + "/firework/v4/admin/restricted_terms/is_allowed": { + "post": { "tags": [ - "public", + "private", "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" + "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/PublicIdentifierResponse" + "$ref": "#/components/schemas/SearchQueryAllowedResponse" } } } @@ -1393,31 +1637,34 @@ } } } - }, - "delete": { + } + }, + "/firework/v4/admin/restricted_terms/are_allowed": { + "post": { "tags": [ - "public", + "private", "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" + "summary": "Are Allowed", + "operationId": "are_allowed_admin_restricted_terms_are_allowed_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchTermsAllowedRequest" + } } - } - ], + }, + "required": true + }, "responses": { - "202": { + "200": { "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/SearchQueryAllowedResponse" + } } } }, @@ -1434,48 +1681,21 @@ } } }, - "/firework/v4/matching-policies": { - "post": { + "/firework/v4/admin/restricted_terms": { + "get": { "tags": [ - "public", - "team=data-engineering" + "private", + "team=experience" ], - "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" - } - } - } - }, + "summary": "Get Restricted Terms", + "operationId": "get_restricted_terms_admin_restricted_terms_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MatchingPolicyPayload" + "$ref": "#/components/schemas/RestrictedTerms" } } } @@ -1491,50 +1711,24 @@ } } } - }, - "get": { + } + }, + "/firework/v4/admin/tenants/{tenant_id}/enable": { + "post": { "tags": [ - "public", - "team=data-engineering" + "private", + "team=experience" ], - "summary": "List Matching Policies", - "operationId": "list_matching_policies_matching_policies_get", + "summary": "Enable Tenant", + "operationId": "enable_tenant_admin_tenants__tenant_id__enable_post", "parameters": [ { - "name": "from", - "in": "query", - "required": false, + "name": "tenant_id", + "in": "path", + "required": true, "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" + "type": "integer", + "title": "Tenant Id" } } ], @@ -1543,9 +1737,7 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_MatchingPolicyPayload_str_" - } + "schema": {} } } }, @@ -1562,32 +1754,33 @@ } } }, - "/firework/v4/matching-policies/{policy_uuid}": { - "put": { + "/firework/v4/admin/tenants/{tenant_id}/flare_community": { + "post": { "tags": [ - "public", - "team=data-engineering" + "private" ], - "summary": "Update Matching Policy", - "operationId": "update_matching_policy_matching_policies__policy_uuid__put", + "summary": "Enable Tenant Flare Community", + "operationId": "enable_tenant_flare_community_admin_tenants__tenant_id__flare_community_post", "parameters": [ { - "name": "policy_uuid", + "name": "tenant_id", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid", - "title": "Policy Uuid" + "type": "integer", + "title": "Tenant Id" } } ], "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateMatchingPolicyBody" + "$ref": "#/components/schemas/EnableFlareCommunityRequest", + "default": { + "auto_provision_users": false, + "manual_users": [] + } } } } @@ -1598,7 +1791,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MatchingPolicyPayload" + "$ref": "#/components/schemas/EnableFlareCommunityResponse" } } } @@ -1617,20 +1810,18 @@ }, "get": { "tags": [ - "public", - "team=data-engineering" + "private" ], - "summary": "Get Matching Policy", - "operationId": "get_matching_policy_matching_policies__policy_uuid__get", + "summary": "Get Tenant Flare Community", + "operationId": "get_tenant_flare_community_admin_tenants__tenant_id__flare_community_get", "parameters": [ { - "name": "policy_uuid", + "name": "tenant_id", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid", - "title": "Policy Uuid" + "type": "integer", + "title": "Tenant Id" } } ], @@ -1640,7 +1831,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MatchingPolicyPayload" + "$ref": "#/components/schemas/TenantFlareCommunityIsEnabledResponse" } } } @@ -1659,20 +1850,18 @@ }, "delete": { "tags": [ - "public", - "team=data-engineering" + "private" ], - "summary": "Delete Matching Policy", - "operationId": "delete_matching_policy_matching_policies__policy_uuid__delete", + "summary": "Disable Tenant Flare Community", + "operationId": "disable_tenant_flare_community_admin_tenants__tenant_id__flare_community_delete", "parameters": [ { - "name": "policy_uuid", + "name": "tenant_id", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid", - "title": "Policy Uuid" + "type": "integer", + "title": "Tenant Id" } } ], @@ -1698,70 +1887,21 @@ } } }, - "/firework/v4/matching-policies/by_identifier_id/{identifier_id}": { + "/firework/v4/admin/tenants/{tenant_id}/flare_community/invite_link": { "get": { "tags": [ - "public", - "team=data-engineering" + "private" ], - "summary": "List Matching Policies By Identifier Id", - "operationId": "list_matching_policies_by_identifier_id_matching_policies_by_identifier_id__identifier_id__get", + "summary": "Get Tenant Flare Community Invite Link", + "operationId": "get_tenant_flare_community_invite_link_admin_tenants__tenant_id__flare_community_invite_link_get", "parameters": [ { - "name": "identifier_id", + "name": "tenant_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" + "title": "Tenant Id" } }, { @@ -1771,7 +1911,8 @@ "schema": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" @@ -1786,19 +1927,9 @@ "required": false, "schema": { "type": "integer", - "exclusiveMinimum": 0, - "default": 25, + "default": 10, "title": "Size" } - }, - { - "name": "order", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/OrderType", - "default": "desc" - } } ], "responses": { @@ -1807,7 +1938,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedResults_PolicyAssignedIdentifierPayload_str_" + "$ref": "#/components/schemas/PaginatedResults_InviteLinkResponse_datetime_" } } } @@ -1826,20 +1957,18 @@ }, "post": { "tags": [ - "public", - "team=data-engineering" + "private" ], - "summary": "Assign Policy", - "operationId": "assign_policy_matching_policies__policy_uuid__assignments_post", + "summary": "Create Invite Link", + "operationId": "create_invite_link_admin_tenants__tenant_id__flare_community_invite_link_post", "parameters": [ { - "name": "policy_uuid", + "name": "tenant_id", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid", - "title": "Policy Uuid" + "type": "integer", + "title": "Tenant Id" } } ], @@ -1848,7 +1977,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PolicyAssignmentsBody" + "$ref": "#/components/schemas/FlareInviteLinkRequest" } } } @@ -1858,7 +1987,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/CreateInviteLinkResponse" + } } } }, @@ -1873,68 +2004,25 @@ } } } - }, - "delete": { + } + }, + "/firework/v4/admin/tenants/{tenant_id}/flare_community/users": { + "get": { "tags": [ - "public", - "team=data-engineering" + "private" ], - "summary": "Unassign Policy", - "operationId": "unassign_policy_matching_policies__policy_uuid__assignments_delete", + "summary": "Get Tenant Flare Community Users", + "operationId": "get_tenant_flare_community_users_admin_tenants__tenant_id__flare_community_users_get", "parameters": [ { - "name": "policy_uuid", + "name": "tenant_id", "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": {} - } + "type": "integer", + "title": "Tenant Id" } }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/reports": { - "get": { - "tags": [ - "public", - "team=data-intelligence", - "feature=reports" - ], - "summary": "List Reports", - "operationId": "list_reports_reports_get", - "parameters": [ { "name": "from", "in": "query", @@ -1942,7 +2030,7 @@ "schema": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" @@ -1957,38 +2045,24 @@ "required": false, "schema": { "type": "integer", - "maximum": 100, - "exclusiveMinimum": 0, - "default": 20, + "default": 10, "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", + "name": "search_query", "in": "query", "required": false, "schema": { - "type": "boolean", - "default": false, - "title": "Include Archived" + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Search Query" } } ], @@ -1998,7 +2072,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedResults_PublicReport_str_" + "$ref": "#/components/schemas/PaginatedResults_TenantFlareCommunityUser_int_" } } } @@ -2016,23 +2090,21 @@ } } }, - "/firework/v4/reports/{report_id}": { + "/firework/v4/admin/tenants/{tenant_id}/flare_community/users/count": { "get": { "tags": [ - "public", - "team=data-intelligence", - "feature=reports" + "private" ], - "summary": "Get Report", - "operationId": "get_report_reports__report_id__get", + "summary": "Get Tenant Flare Community Users Count", + "operationId": "get_tenant_flare_community_users_count_admin_tenants__tenant_id__flare_community_users_count_get", "parameters": [ { - "name": "report_id", + "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "integer", - "title": "Report Id" + "title": "Tenant Id" } } ], @@ -2042,7 +2114,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PublicReport" + "$ref": "#/components/schemas/TenantFlareCommunityUsersCountResponse" } } } @@ -2060,41 +2132,139 @@ } } }, - "/firework/v4/reports/{report_id}/download": { - "get": { + "/firework/v4/admin/tenants/{tenant_id}/flare_community/invite_link/{invite_link_id}": { + "delete": { "tags": [ - "public", - "team=data-intelligence", - "feature=reports" + "private" ], - "summary": "Download Report", - "operationId": "download_report_reports__report_id__download_get", + "summary": "Delete Invite Link", + "operationId": "delete_invite_link_admin_tenants__tenant_id__flare_community_invite_link__invite_link_id__delete", "parameters": [ { - "name": "report_id", + "name": "invite_link_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Invite Link Id" + } + }, + { + "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "integer", - "title": "Report Id" + "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/admin/tenants/{tenant_id}/flare_community/users/{user_id}": { + "delete": { + "tags": [ + "private" + ], + "summary": "Delete User", + "operationId": "delete_user_admin_tenants__tenant_id__flare_community_users__user_id__delete", + "parameters": [ { - "name": "format", - "in": "query", - "required": false, + "name": "user_id", + "in": "path", + "required": true, "schema": { - "$ref": "#/components/schemas/ReportDownloadFormat", - "choices": [ - "docx", - "pdf", - "csv", - "zip" - ], - "default": "docx" + "type": "integer", + "title": "User Id" + } + }, + { + "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" + } + } + } + } + } + }, + "patch": { + "tags": [ + "private" + ], + "summary": "Update User Features", + "operationId": "update_user_features_admin_tenants__tenant_id__flare_community_users__user_id__patch", + "parameters": [ + { + "name": "user_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "User Id" + } + }, + { + "name": "tenant_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Tenant Id" } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateFlareCommunityUserFeaturesRequest" + } + } + } + }, "responses": { "200": { "description": "Successful Response", @@ -2117,13 +2287,65 @@ } } }, - "/firework/v4/threat_flow/reports/": { + "/firework/v4/admin/tenants/{tenant_id}/flare_community/parse_csv": { + "post": { + "tags": [ + "private" + ], + "summary": "Parse Csv", + "operationId": "parse_csv_admin_tenants__tenant_id__flare_community_parse_csv_post", + "parameters": [ + { + "name": "tenant_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Tenant Id" + } + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/Body_parse_csv_admin_tenants__tenant_id__flare_community_parse_csv_post" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CSVParseResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/admin/threat_flow/reports": { "get": { "tags": [ - "public" + "private" ], "summary": "List Reports", - "operationId": "list_reports_threat_flow_reports__get", + "operationId": "list_reports_admin_threat_flow_reports_get", "parameters": [ { "name": "from", @@ -2161,22 +2383,28 @@ } }, { - "name": "report_types", + "name": "order_by", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/pyro__threat_flow__core__reports__report_store__SortType", + "default": "id" + } + }, + { + "name": "query", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/pyro__threat_flow__core__reports__report_store__ReportType" - } + "type": "string" }, { "type": "null" } ], - "title": "Report Types" + "title": "Query" } } ], @@ -2186,7 +2414,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedResults_PydanticThreatFlowReport_str_" + "$ref": "#/components/schemas/PaginatedResults_ThreatFlowReportResponse_str_" } } } @@ -2204,13 +2432,13 @@ } } }, - "/firework/v4/threat_flow/reports/{report_id}": { + "/firework/v4/admin/threat_flow/reports/{report_id}": { "get": { "tags": [ - "public" + "private" ], "summary": "Get Report", - "operationId": "get_report_threat_flow_reports__report_id__get", + "operationId": "get_report_admin_threat_flow_reports__report_id__get", "parameters": [ { "name": "report_id", @@ -2228,7 +2456,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/pyro__threat_flow__web__v4__reports__models__ReportResponse" + "$ref": "#/components/schemas/ThreatFlowReportResponse" } } } @@ -2245,12 +2473,12 @@ } } }, - "delete": { + "put": { "tags": [ - "public" + "private" ], - "summary": "Delete Report", - "operationId": "delete_report_threat_flow_reports__report_id__delete", + "summary": "Update Report", + "operationId": "update_report_admin_threat_flow_reports__report_id__put", "parameters": [ { "name": "report_id", @@ -2262,12 +2490,24 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateReportParameters" + } + } + } + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/ThreatFlowReportResponse" + } } } }, @@ -2284,33 +2524,23 @@ } } }, - "/firework/v4/threat_flow/reports/{report_id}/publish": { - "patch": { + "/firework/v4/admin/identifier_recommendations/llm": { + "post": { "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" - } - } + "private", + "team=experience" ], + "summary": "Create Llm Recommendations", + "operationId": "create_llm_recommendations_admin_identifier_recommendations_llm_post", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PublishReportPayload" + "$ref": "#/components/schemas/CreateLLMRecommendationsRequest" } } - } + }, + "required": true }, "responses": { "200": { @@ -2318,7 +2548,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/pyro__threat_flow__web__v4__reports__models__ReportResponse" + "$ref": "#/components/schemas/CreateLLMRecommendationsResponse" } } } @@ -2336,30 +2566,22 @@ } } }, - "/firework/v4/threat_flow/reports/{report_id}/download": { + "/firework/v4/actors/{uuid}/uid": { "get": { "tags": [ - "public" + "private" ], - "summary": "Download Report", - "operationId": "download_report_threat_flow_reports__report_id__download_get", + "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", "parameters": [ { - "name": "report_id", + "name": "uuid", "in": "path", "required": true, "schema": { - "type": "integer", - "title": "Report Id" - } - }, - { - "name": "format", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/ThreatFlowReportDownloadFormat", - "default": "docx" + "type": "string", + "title": "Uuid" } } ], @@ -2368,7 +2590,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/ActorUid" + } } } }, @@ -2385,18 +2609,18 @@ } } }, - "/firework/v4/threat_flow/unit_summary/related_conversation": { + "/firework/v4/actors/uuid": { "post": { "tags": [ - "public" + "private" ], - "summary": "Get Related Conversation", - "operationId": "get_related_conversation_threat_flow_unit_summary_related_conversation_post", + "summary": "Get Asset Uuid", + "operationId": "get_asset_uuid_actors_uuid_post", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RelatedConversationRequest" + "$ref": "#/components/schemas/ActorBodyPayload" } } }, @@ -2408,7 +2632,8 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RelatedConversationResponse" + "type": "string", + "title": "Response Get Asset Uuid Actors Uuid Post" } } } @@ -2426,30 +2651,161 @@ } } }, - "/firework/v4/threat_flow/reports/requests": { - "post": { + "/firework/v4/actors/{asset_uuid}/metadata": { + "get": { "tags": [ - "public" + "private" ], - "summary": "Create Report Request", - "operationId": "create_report_request_threat_flow_reports_requests_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportRequestPayload" + "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" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActorMetadata" + } } } }, - "required": true - }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/actors/{asset_uuid}/timeline": { + "get": { + "tags": [ + "private" + ], + "summary": "Get Actor Timeline", + "operationId": "get_actor_timeline_actors__asset_uuid__timeline_get", + "parameters": [ + { + "name": "asset_uuid", + "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/ReportRequestResponse" + "$ref": "#/components/schemas/ActorTimeline" } } } @@ -2467,22 +2823,22 @@ } } }, - "/firework/v4/threat_flow/reports/requests/{request_info_id}": { + "/firework/v4/actors/{asset_uuid}/threads": { "get": { "tags": [ - "public" + "private" ], - "summary": "Get Report Request", - "operationId": "get_report_request_threat_flow_reports_requests__request_info_id__get", + "summary": "Get Actor Threads", + "operationId": "get_actor_threads_actors__asset_uuid__threads_get", "parameters": [ { - "name": "request_info_id", + "name": "asset_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", - "title": "Request Info Id" + "title": "Asset Uuid" } } ], @@ -2492,7 +2848,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ReportRequestInfoResponse" + "type": "array", + "items": { + "$ref": "#/components/schemas/ActorThread" + }, + "title": "Response Get Actor Threads Actors Asset Uuid Threads Get" } } } @@ -2510,30 +2870,76 @@ } } }, - "/firework/v4/hubspot/flare_sync_webhook": { - "post": { + "/firework/v4/actors/{asset_uuid}/analysis/metadata": { + "get": { "tags": [ - "public", - "team=experience" + "private" ], - "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" + "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" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActorAnalysisMetadataResponse" + } } } }, - "required": true - }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/actors/summaries/{request_id}": { + "get": { + "tags": [ + "private" + ], + "summary": "Get Actor Summaries By Request Id", + "operationId": "get_actor_summaries_by_request_id_actors_summaries__request_id__get", + "parameters": [ + { + "name": "request_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Request Id" + } + } + ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/ActorSummariesResponse" + } } } }, @@ -2550,30 +2956,43 @@ } } }, - "/firework/v4/hubspot/flare_sync_tenant_webhook": { + "/firework/v4/actors/{asset_uuid}/generate-summaries": { "post": { "tags": [ - "public", - "team=experience" + "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" + } + } ], - "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/HubspotWebhookFlareSyncTenantEvent" + "$ref": "#/components/schemas/ActorSummariesGenerationPayload" } } - }, - "required": true + } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/ActorSummariesResponse" + } } } }, @@ -2589,37 +3008,10647 @@ } } } - } - }, - "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", + }, + "/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" + } + } + } + } + } + } + }, + "/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/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/_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/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": "status", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "$ref": "#/components/schemas/IdentifierRecommendationState" + }, + { + "type": "null" + } + ], + "title": "Status" + } + }, + { + "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/": { + "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/{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/reports": { + "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_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", + "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" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaginatedResults_PublicReport_str_" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/reports/{report_id}": { + "get": { + "tags": [ + "public", + "team=data-intelligence", + "feature=reports" + ], + "summary": "Get Report", + "operationId": "get_report_reports__report_id__get", + "parameters": [ + { + "name": "report_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Report Id" + } + }, + { + "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/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/reports/{report_id}/download": { + "get": { + "tags": [ + "public", + "team=data-intelligence", + "feature=reports" + ], + "summary": "Download Report", + "operationId": "download_report_reports__report_id__download_get", + "parameters": [ + { + "name": "report_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Report Id" + } + }, + { + "name": "report_group_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Report Group 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/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/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", @@ -2627,587 +13656,7813 @@ "driller_google", "driller_profile", "driller_source_code", - "entity_classification", - "entity_summarization", "event", - "experimental", - "forum_category", - "forum_post", - "forum_profile", - "forum_thread_summary", - "forum_topic", + "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" + }, + "AddressData": { + "properties": { + "type": { + "type": "string", + "const": "address_data", + "title": "Type", + "default": "address_data" + }, + "street": { + "type": "string", + "minLength": 1, + "title": "Street" + }, + "city": { + "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", + "maxLength": 2, + "minLength": 2, + "title": "Country" + }, + "state": { + "type": "string", + "minLength": 1, + "title": "State" + } + }, + "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" + }, + "custom_fields": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], + "title": "Custom Fields" + } + }, + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "BinQuery": { + "properties": { + "type": { + "type": "string", + "const": "bin", + "title": "Type" + }, + "bin": { + "type": "string", + "title": "Bin" + } + }, + "type": "object", + "required": [ + "type", + "bin" + ], + "title": "BinQuery" + }, + "BirthYearData": { + "properties": { + "type": { + "type": "string", + "const": "birth_year", + "title": "Type", + "default": "birth_year" + }, + "year": { + "type": "integer", + "maximum": 2100.0, + "minimum": 1900.0, + "title": "Year" + } + }, + "type": "object", + "required": [ + "year" + ], + "title": "BirthYearData" + }, + "BinaryInputContent": { + "properties": { + "type": { + "type": "string", + "const": "binary", + "title": "Type", + "default": "binary" + }, + "mimeType": { + "type": "string", + "title": "Mimetype" + }, + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Id" + }, + "url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Url" + }, + "data": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Data" + }, + "filename": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Filename" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "mimeType" + ], + "title": "BinaryInputContent", + "description": "A deprecated binary payload reference in a multimodal user message." + }, + "BirthYearData": { + "properties": { + "type": { + "type": "string", + "const": "birth_year", + "title": "Type", + "default": "birth_year" + }, + "year": { + "type": "integer", + "maximum": 2100.0, + "minimum": 1900.0, + "title": "Year" + } + }, + "type": "object", + "required": [ + "year" + ], + "title": "BirthYearData" + }, + "BlacklistedTermLocation": { + "type": "string", + "enum": [ + "identifier_creation", + "identifier_update", + "event_search", + "credentials_browser_search", + "leaks_browser_api_search", + "entities_search" + ], + "title": "BlacklistedTermLocation" + }, + "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", - "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" + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "urls": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Urls" + } + }, + "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" + }, + "CredentialEventData": { + "properties": { + "identity_name": { + "type": "string", + "title": "Identity Name", + "description": "The email or username associated with the credential." + }, + "credential_hash": { + "type": "string", + "title": "Credential Hash", + "description": "A hash uniquely identifying the credential." + }, + "tenant_integration_id": { + "type": "string", + "title": "Tenant Integration Id", + "description": "The UUID of the tenant's IdP integration that validated the credential." + } + }, + "type": "object", + "required": [ + "identity_name", + "credential_hash", + "tenant_integration_id" + ], + "title": "CredentialEventData" + }, + "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" + }, + "DomainMatchMode": { + "type": "string", + "enum": [ + "email_domain_only", + "auth_domain_and_email_domain", + "auth_domain_only" + ], + "title": "DomainMatchMode" + }, + "DomainQuery": { + "properties": { + "type": { + "type": "string", + "const": "domain", + "title": "Type" + }, + "fqdn": { + "type": "string", + "title": "Fqdn" + } + }, + "type": "object", + "required": [ + "type", + "fqdn" + ], + "title": "DomainQuery" + }, + "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": { + "event_type": { + "$ref": "#/components/schemas/ActivityModelName" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + }, + "data": { + "additionalProperties": true, + "type": "object", + "title": "Data" + } + }, + "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" + }, + "EventSeverity": { + "type": "string", + "enum": [ + "info", + "low", + "medium", + "high", + "critical" + ], + "title": "EventSeverity" + }, + "ExpandableField": { + "type": "string", + "enum": [ + "credentials", + "cookies" + ], + "title": "ExpandableField" + }, + "ExternalIdData": { + "properties": { + "type": { + "type": "string", + "const": "external_id", + "title": "Type", + "default": "external_id" + }, + "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", + "minLength": 1, + "title": "Source" + } + }, + "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": "ExternalIdData" + }, + "FeedAlertChannelParams": { + "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": "FeedAlertChannelParams" + }, + "FeedAlertDiscordParams": { + "properties": { + "type": { + "type": "string", + "const": "discord", + "title": "Type" + }, + "webhook_url": { + "type": "string", + "title": "Webhook Url" + } + }, + "type": "object", + "required": [ + "type", + "webhook_url" + ], + "title": "FeedAlertDiscordParams" + }, + "FeedAlertEmailParams": { + "properties": { + "type": { + "type": "string", + "const": "email", + "title": "Type" + }, + "email": { + "type": "string", + "title": "Email" + }, + "json_attachment": { + "type": "boolean", + "title": "Json Attachment" + }, + "csv_attachment": { + "type": "boolean", + "title": "Csv Attachment" + }, + "subject_tag": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Subject Tag" + }, + "language": { + "$ref": "#/components/schemas/Language" + } + }, + "type": "object", + "required": [ + "type", + "email", + "json_attachment", + "csv_attachment", + "subject_tag", + "language" + ], + "title": "FeedAlertEmailParams" + }, + "FeedAlertJiraParams": { + "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" + }, + "issue_type": { + "type": "string", + "title": "Issue Type" + }, + "custom_fields": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], + "title": "Custom Fields" + } + }, + "type": "object", + "required": [ + "type", + "server_netloc", + "email", + "api_token", + "project_key", + "labels", + "issue_type", + "custom_fields" + ], + "title": "FeedAlertJiraParams" + }, + "FeedAlertLegacySentinelParams": { + "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": "FeedAlertLegacySentinelParams" + }, + "FeedAlertSentinelV2Params": { + "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": "FeedAlertSentinelV2Params" + }, + "FeedAlertServiceNowParams": { + "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": "FeedAlertServiceNowParams" + }, + "FeedAlertSlackParams": { + "properties": { + "type": { + "type": "string", + "const": "slack", + "title": "Type" + }, + "webhook_url": { + "type": "string", + "title": "Webhook Url" + } + }, + "type": "object", + "required": [ + "type", + "webhook_url" + ], + "title": "FeedAlertSlackParams" + }, + "FeedAlertSplunkParams": { + "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" + } + }, + "type": "object", + "required": [ + "type", + "api_token", + "netloc", + "index", + "labels" + ], + "title": "FeedAlertSplunkParams" + }, + "FeedAlertTeamsParams": { + "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": "FeedAlertTeamsParams" + }, + "FeedAlertWebhookParams": { + "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/FeedWebhookBasicAuth" + }, + { + "type": "null" + } + ] + }, + "custom_headers": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], + "title": "Custom Headers" + } + }, + "type": "object", + "required": [ + "type", + "webhook_url", + "secret", + "basic_auth", + "custom_headers" + ], + "title": "FeedAlertWebhookParams" + }, + "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": "ActivityModelName" + "title": "FeedItemMetadata" }, - "AddressData": { + "FeedItemTenantMetadata": { "properties": { - "type": { - "type": "string", - "const": "address_data", - "title": "Type", - "default": "address_data" + "severity": { + "anyOf": [ + { + "$ref": "#/components/schemas/FeedItemTenantMetadataSeverity" + }, + { + "type": "null" + } + ] }, - "street": { - "type": "string", - "minLength": 1, - "title": "Street" + "notes": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Notes" }, - "city": { + "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", - "minLength": 1, - "title": "City" + "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" }, - "country": { + "label": { "type": "string", - "maxLength": 2, - "minLength": 2, - "title": "Country" + "title": "Label" }, - "state": { + "color": { "type": "string", - "minLength": 1, - "title": "State" + "title": "Color" } }, "type": "object", "required": [ - "street", - "city", - "country", - "state" + "value", + "label", + "color" ], - "title": "AddressData" + "title": "FilterSeverity" }, - "Alert": { + "FilterSourceType": { "properties": { - "feed_definition": { - "$ref": "#/components/schemas/FeedDefinition" - }, - "type": { + "value": { "type": "string", - "title": "Type" + "title": "Value" }, - "created_at": { + "label": { "type": "string", - "title": "Created At" - }, - "updated_at": { + "title": "Label" + } + }, + "type": "object", + "required": [ + "value", + "label" + ], + "title": "FilterSourceType" + }, + "FilterSourceTypeCategory": { + "properties": { + "value": { "type": "string", - "title": "Updated At" - }, - "id": { - "type": "integer", - "title": "Id" + "title": "Value" }, - "name": { + "label": { "type": "string", - "title": "Name" - }, - "tenant_id": { - "type": "integer", - "title": "Tenant Id" - }, - "organization_id": { - "type": "integer", - "title": "Organization Id" + "title": "Label" }, - "search_types": { + "types": { "items": { - "$ref": "#/components/schemas/SearchType" + "$ref": "#/components/schemas/FilterSourceType" }, "type": "array", - "title": "Search Types" - }, - "experimental_search_types": { + "title": "Types" + } + }, + "type": "object", + "required": [ + "value", + "label" + ], + "title": "FilterSourceTypeCategory" + }, + "FilterSourceTypes": { + "properties": { + "categories": { "items": { - "type": "string" + "$ref": "#/components/schemas/FilterSourceTypeCategory" }, "type": "array", - "title": "Experimental Search Types" + "title": "Categories" + } + }, + "type": "object", + "title": "FilterSourceTypes" + }, + "FinancialEvent": { + "properties": { + "event_type": { + "type": "string", + "const": "cc", + "title": "Event Type", + "default": "cc" }, - "risks": { - "items": { - "$ref": "#/components/schemas/RiskScore" - }, - "type": "array", - "title": "Risks" + "data": { + "$ref": "#/components/schemas/FinancialEventData" }, - "alert_channel_id": { + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + } + }, + "type": "object", + "required": [ + "data", + "metadata" + ], + "title": "Credit Card" + }, + "FinancialEventData": { + "properties": { + "bank": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Alert Channel Id" + "title": "Bank", + "description": "The bank associated with the leaked credit card." }, - "alert_channel": { + "bin": { "anyOf": [ { - "$ref": "#/components/schemas/AlertChannelSummary" + "type": "string" }, { "type": "null" } - ] - }, - "frequency": { - "type": "number", - "title": "Frequency" - }, - "start_at": { - "type": "string", - "title": "Start At" + ], + "title": "Bin", + "description": "The BIN (Bank Identification Number) of the credit card." }, - "identifier_scope": { + "brand": { "anyOf": [ { - "$ref": "#/components/schemas/IdentifierScope" + "type": "string" }, { "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" + ], + "title": "Brand", + "description": "The brand of the leakedcredit card. Ex: VISA" }, - "type": { - "$ref": "#/components/schemas/AlertType" + "country": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Country", + "description": "The country the leakedcredit card was issued in." }, - "state": { - "$ref": "#/components/schemas/AlertChannelState" + "expiration": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Expiration", + "description": "The expiration date of the leaked credit card." }, - "params": { - "oneOf": [ + "owner": { + "anyOf": [ { - "$ref": "#/components/schemas/AlertChannelEmailParams" + "type": "string" }, { - "$ref": "#/components/schemas/AlertChannelSlackParams" + "type": "null" + } + ], + "title": "Owner", + "description": "The owner of the leaked credit card." + }, + "state_code": { + "anyOf": [ + { + "type": "string" }, { - "$ref": "#/components/schemas/AlertChannelDiscordParams" + "type": "null" + } + ], + "title": "State Code", + "description": "The state code tied to the leaked credit card." + }, + "zip": { + "anyOf": [ + { + "type": "string" }, { - "$ref": "#/components/schemas/AlertChannelSplunkParams" + "type": "null" + } + ], + "title": "Zip", + "description": "The zip code tied to the leaked credit card." + }, + "has_cvv": { + "anyOf": [ + { + "type": "boolean" }, { - "$ref": "#/components/schemas/AlertChannelChannelParams" + "type": "null" + } + ], + "title": "Has Cvv", + "description": "Whether the CVV was included in the leaked data." + }, + "has_date_of_birth": { + "anyOf": [ + { + "type": "boolean" }, { - "$ref": "#/components/schemas/AlertChannelLegacySentinelParams" + "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" }, { - "$ref": "#/components/schemas/AlertChannelSentinelV2Params" - }, + "type": "null" + } + ], + "title": "Has Mother Maiden Name", + "description": "Whether the mother's maiden name was included in the leaked data." + }, + "has_phone": { + "anyOf": [ { - "$ref": "#/components/schemas/AlertChannelTeamsParams" + "type": "boolean" }, { - "$ref": "#/components/schemas/AlertChannelJiraParams" - }, + "type": "null" + } + ], + "title": "Has Phone", + "description": "Whether the phone number was included in the leaked data." + }, + "has_pin": { + "anyOf": [ { - "$ref": "#/components/schemas/AlertChannelServiceNowParams" + "type": "boolean" }, { - "$ref": "#/components/schemas/AlertChannelWebhookParams" + "type": "null" } ], - "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" + "title": "Has Pin", + "description": "Whether the card's PIN was included in the leaked data." }, - "alert_channel_id": { + "has_ssn": { "anyOf": [ { - "type": "integer" + "type": "boolean" }, { "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 + "title": "Has Ssn", + "description": "Whether the card owner's SSN was included in the leaked data." }, - "subject_tag": { + "has_track_1": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "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" + "title": "Has Track 1", + "description": "Whether the card's track 1 (magnetic stripe data) was included in the leaked data." }, - "custom_fields": { + "has_vbv": { "anyOf": [ { - "additionalProperties": { - "type": "string" - }, - "type": "object" + "type": "boolean" }, { "type": "null" } ], - "title": "Custom Fields" - } - }, - "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" + "title": "Has Vbv", + "description": "Whether the card's VBV (Verified by Visa) data was included in the leaked data." } }, "type": "object", "required": [ - "type", - "entra_client_id", - "entra_tenant_id", - "entra_secret", - "url" + "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": "AlertChannelSentinelV2Params" + "title": "FinancialEventData" }, - "AlertChannelServiceNowParams": { + "FlareInviteLinkRequest": { "properties": { - "type": { - "type": "string", - "const": "servicenow", - "title": "Type" - }, - "server_url": { + "organization_name": { "type": "string", - "title": "Server Url" + "title": "Organization Name" }, - "api_key": { - "type": "string", - "title": "Api Key" + "domains": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Domains" }, - "table_name": { - "type": "string", - "title": "Table Name" + "features": { + "items": { + "$ref": "#/components/schemas/Features" + }, + "type": "array", + "title": "Features" } }, "type": "object", "required": [ - "type", - "server_url", - "api_key", - "table_name" + "organization_name", + "domains" ], - "title": "AlertChannelServiceNowParams" + "title": "FlareInviteLinkRequest" }, - "AlertChannelSlackParams": { + "ForetraceInputParams": { "properties": { - "type": { - "type": "string", - "const": "slack", - "title": "Type" - }, - "webhook_url": { + "params_type": { "type": "string", - "title": "Webhook Url" + "const": "flare_community", + "title": "Params Type", + "default": "flare_community" } }, "type": "object", - "required": [ - "type", - "webhook_url" - ], - "title": "AlertChannelSlackParams" + "title": "ForetraceInputParams" }, - "AlertChannelSplunkParams": { + "ForetraceParams": { "properties": { - "type": { - "type": "string", - "const": "splunk", - "title": "Type" - }, - "api_token": { - "type": "string", - "title": "Api Token" - }, - "netloc": { - "type": "string", - "title": "Netloc" - }, - "index": { + "params_type": { "type": "string", - "title": "Index" - }, - "labels": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Labels", - "default": [] + "const": "flare_community", + "title": "Params Type", + "default": "flare_community" } }, "type": "object", - "required": [ - "type", - "api_token", - "netloc", - "index" - ], - "title": "AlertChannelSplunkParams" + "title": "ForetraceParams" }, - "AlertChannelState": { + "ForumPostData": { "properties": { - "status": { - "$ref": "#/components/schemas/AlertChannelStatus" + "actor": { + "$ref": "#/components/schemas/pyro__findings__forum_posts__datamodels__ForumPostData__Actor", + "description": "Details about the author of the forum post." }, - "message": { + "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" @@ -3216,488 +21471,468 @@ "type": "null" } ], - "title": "Message" - } - }, - "type": "object", - "required": [ - "status" - ], - "title": "AlertChannelState" - }, - "AlertChannelStatus": { - "type": "string", - "enum": [ - "untested", - "error", - "success" - ], - "title": "AlertChannelStatus" - }, - "AlertChannelSummary": { - "properties": { - "id": { - "type": "integer", - "title": "Id" + "title": "Content", + "description": "Content of the forum post." }, - "name": { - "type": "string", - "title": "Name" + "url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Url", + "description": "URL to the forum post." } }, "type": "object", "required": [ - "id", - "name" + "actor", + "context", + "posted_at", + "content", + "url" ], - "title": "AlertChannelSummary" + "title": "ForumPostData" }, - "AlertChannelTeamsParams": { + "ForumPostEvent": { "properties": { - "type": { + "event_type": { "type": "string", - "const": "teams", - "title": "Type" + "const": "forum_post", + "title": "Event Type", + "default": "forum_post" }, - "teams_webhook_url": { - "type": "string", - "title": "Teams Webhook Url" + "data": { + "$ref": "#/components/schemas/ForumPostData" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" } }, "type": "object", "required": [ - "type", - "teams_webhook_url" + "data", + "metadata" ], - "title": "AlertChannelTeamsParams" + "title": "Forum Post" }, - "AlertChannelWebhookParams": { + "ForwardInfo": { "properties": { - "type": { - "type": "string", - "const": "webhook", - "title": "Type" - }, - "webhook_url": { - "type": "string", - "title": "Webhook Url" - }, - "secret": { - "type": "string", - "title": "Secret" - }, - "basic_auth": { + "forwarded_from": { "anyOf": [ { - "$ref": "#/components/schemas/WebhookBasicAuth" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Forwarded From", + "description": "The username of the chat message forwarder." }, - "custom_headers": { + "forwarded_from_author_id": { "anyOf": [ { - "additionalProperties": { - "type": "string" - }, - "type": "object" + "type": "string" }, { "type": "null" } ], - "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" - }, - "format_type": { - "$ref": "#/components/schemas/ThreatFlowReportFormatType", - "default": "simple_summary" - }, - "title": { - "type": "string", - "title": "Title" + "title": "Forwarded From Author Id", + "description": "The ID of the chat message forwarder." }, - "subtitle": { + "forwarded_from_chat_id": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Subtitle" - }, - "summary": { - "type": "string", - "title": "Summary" - }, - "content": { - "type": "string", - "title": "Content" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Tags" + "title": "Forwarded From Chat Id", + "description": "The ID of the chat the message is being forwarded from." }, - "highlights": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Highlights" + "forwarded_from_conversation_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Forwarded From Conversation Id", + "description": "The conversation ID the message is being forwarded from." }, - "related_activity_uids": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Related Activity Uids" + "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." }, - "created_at": { - "type": "string", - "format": "date-time", - "title": "Created At" + "forwarded_from_username": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Forwarded From Username", + "description": "The username of the user the message is being forwarded from." }, - "tenant_id": { + "forwarded_message_time": { "anyOf": [ { - "type": "integer" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Tenant Id" + "title": "Forwarded Message Time", + "description": "The time the message was forwarded." } }, "type": "object", - "required": [ - "id", - "title", - "subtitle", - "summary", - "content", - "tags", - "highlights", - "related_activity_uids", - "created_at", - "tenant_id" - ], - "title": "ApiReport" + "title": "ForwardInfo" }, - "AssetEnrichmentType": { + "FreeTrialStatus": { "type": "string", "enum": [ - "domain" + "no_trial", + "active", + "expired" ], - "title": "AssetEnrichmentType" + "title": "FreeTrialStatus" }, - "AstpCookiesValue": { + "FreeTrialStatusResponse": { "properties": { - "cookie_names": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Cookie Names", - "description": "The cookie names to monitor" + "module": { + "$ref": "#/components/schemas/HubspotModuleFreeTrialName" }, - "match_subdomains": { - "type": "boolean", - "title": "Match Subdomains", - "description": "Whether this policy will be applied to monitor subdomains of the assigned domain identifiers", - "default": false + "status": { + "$ref": "#/components/schemas/FreeTrialStatus" + }, + "end_date": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "End Date" } }, "type": "object", "required": [ - "cookie_names" + "module", + "status", + "end_date" ], - "title": "AstpCookiesValue" + "title": "FreeTrialStatusResponse" }, - "AstpDomainValue": { + "GeneralProfileSummaryOutput": { "properties": { - "match_mode": { - "$ref": "#/components/schemas/DomainMatchMode", - "description": "The domain match mode for this policy", - "default": "email_domain_only" + "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", - "title": "AstpDomainValue" + "required": [ + "overview", + "main_activities_and_motives", + "potential_associations" + ], + "title": "GeneralProfileSummaryOutput" }, - "AuthDomainQuery": { + "GenerateAsyncRequestPayload": { "properties": { - "type": { - "type": "string", - "const": "auth_domain", - "title": "Type" + "request_type": { + "$ref": "#/components/schemas/AsyncRequestType" }, - "fqdn": { - "type": "string", - "title": "Fqdn" + "request_payload": { + "additionalProperties": true, + "type": "object", + "title": "Request Payload" } }, "type": "object", "required": [ - "type", - "fqdn" + "request_type", + "request_payload" ], - "title": "AuthDomainQuery" + "title": "GenerateAsyncRequestPayload" }, - "AzureTenantData": { + "GetAllowedRestrictedTermsResponse": { "properties": { - "type": { - "type": "string", - "const": "azure_tenant", - "title": "Type", - "default": "azure_tenant" - }, - "tenant_id": { - "type": "string", - "minLength": 1, - "title": "Tenant Id" + "allowed_restricted_terms": { + "items": { + "$ref": "#/components/schemas/AllowedRestrictedTerm" + }, + "type": "array", + "title": "Allowed Restricted Terms" } }, "type": "object", "required": [ - "tenant_id" + "allowed_restricted_terms" ], - "title": "AzureTenantData" + "title": "GetAllowedRestrictedTermsResponse" }, - "AzureTenantQuery": { + "GithubRepositoryData": { "properties": { "type": { "type": "string", - "const": "azure_tenant", - "title": "Type" + "const": "github_repository", + "title": "Type", + "default": "github_repository" }, - "tenant_id": { + "repo_name": { "type": "string", - "title": "Tenant Id" + "minLength": 1, + "title": "Repo Name" + }, + "repo_owner": { + "type": "string", + "minLength": 1, + "title": "Repo Owner" } }, "type": "object", "required": [ - "type", - "tenant_id" + "repo_name", + "repo_owner" ], - "title": "AzureTenantQuery" + "title": "GithubRepositoryData" }, - "BinQuery": { + "GithubRepositoryQuery": { "properties": { "type": { "type": "string", - "const": "bin", + "const": "github_repository", "title": "Type" }, - "bin": { + "repo_owner": { "type": "string", - "title": "Bin" + "title": "Repo Owner" + }, + "repo_name": { + "type": "string", + "title": "Repo Name" } }, "type": "object", "required": [ "type", - "bin" + "repo_owner", + "repo_name" ], - "title": "BinQuery" + "title": "GithubRepositoryQuery" }, - "BirthYearData": { + "GlobalFeedItem": { "properties": { - "type": { - "type": "string", - "const": "birth_year", - "title": "Type", - "default": "birth_year" + "metadata": { + "$ref": "#/components/schemas/FeedItemMetadata" }, - "year": { - "type": "integer", - "maximum": 2100.0, - "minimum": 1900.0, - "title": "Year" + "tenant_metadata": { + "$ref": "#/components/schemas/FeedItemTenantMetadata" + }, + "highlights": { + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + }, + "type": "object", + "title": "Highlights" } }, "type": "object", "required": [ - "year" + "metadata" ], - "title": "BirthYearData" + "title": "GlobalFeedItem" }, - "BlogPostData": { + "GlobalSearchRequestBody": { "properties": { - "url": { - "anyOf": [ + "query": { + "oneOf": [ + { + "$ref": "#/components/schemas/GithubRepositoryQuery" + }, + { + "$ref": "#/components/schemas/UsernameQuery" + }, + { + "$ref": "#/components/schemas/DomainQuery" + }, + { + "$ref": "#/components/schemas/BrandQuery" + }, + { + "$ref": "#/components/schemas/NameQuery" + }, { - "type": "string" + "$ref": "#/components/schemas/KeywordQuery" }, { - "type": "null" - } - ], - "title": "Url", - "description": "The URL of the blog post." - }, - "content": { - "anyOf": [ + "$ref": "#/components/schemas/QueryStringQuery" + }, { - "type": "string" + "$ref": "#/components/schemas/BinQuery" }, { - "type": "null" - } - ], - "title": "Content", - "description": "The content of the blog post." - }, - "description": { - "anyOf": [ + "$ref": "#/components/schemas/IpQuery" + }, { - "type": "string" + "$ref": "#/components/schemas/EmailQuery" }, { - "type": "null" + "$ref": "#/components/schemas/SecretQuery" + }, + { + "$ref": "#/components/schemas/CredentialsQuery" + }, + { + "$ref": "#/components/schemas/AzureTenantQuery" } ], - "title": "Description", - "description": "The description of the blog post." + "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" + } + } }, - "posted_at": { + "filters": { + "$ref": "#/components/schemas/FeedFilters" + }, + "order": { + "$ref": "#/components/schemas/FeedOrder", + "default": "desc" + }, + "from": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Posted At", - "description": "The date and time the blog post was posted." + "title": "From" + }, + "size": { + "type": "integer", + "maximum": 10.0, + "exclusiveMinimum": 0.0, + "title": "Size", + "default": 10 } }, "type": "object", "required": [ - "url", - "content", - "description", - "posted_at" + "query" ], - "title": "BlogPostData" + "title": "GlobalSearchRequestBody" }, - "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" + "GlobalSearchSource": { + "type": "string", + "enum": [ + "all", + "api", + "flare_platform" ], - "title": "Blog Post" + "title": "GlobalSearchSource" }, - "BrandData": { + "GlobalSearchUsageByFeatureResponse": { "properties": { - "type": { - "type": "string", - "const": "brand", - "title": "Type", - "default": "brand" - }, - "name": { - "type": "string", - "minLength": 1, - "title": "Name" + "items": { + "items": { + "$ref": "#/components/schemas/GlobalSearchUsageFeature" + }, + "type": "array", + "title": "Items" } }, "type": "object", "required": [ - "name" + "items" ], - "title": "BrandData" + "title": "GlobalSearchUsageByFeatureResponse" }, - "BrandQuery": { + "GlobalSearchUsageByMemberData": { "properties": { - "type": { - "type": "string", - "const": "brand", - "title": "Type" - }, - "name": { - "type": "string", - "title": "Name" + "items": { + "items": { + "$ref": "#/components/schemas/GlobalSearchUsageByMemberDataPoint" + }, + "type": "array", + "title": "Items" } }, "type": "object", "required": [ - "type", - "name" + "items" ], - "title": "BrandQuery" + "title": "GlobalSearchUsageByMemberData" }, - "BucketData": { + "GlobalSearchUsageByMemberDataPoint": { "properties": { - "host": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Host", - "description": "The host of the bucket." + "user_id": { + "type": "integer", + "title": "User Id" }, - "provider": { + "member": { "anyOf": [ { "type": "string" @@ -3706,42 +21941,44 @@ "type": "null" } ], - "title": "Provider", - "description": "The provider of the bucket." + "title": "Member" + }, + "count": { + "type": "integer", + "title": "Count" } }, "type": "object", "required": [ - "host", - "provider" + "user_id", + "member", + "count" ], - "title": "BucketData" + "title": "GlobalSearchUsageByMemberDataPoint" }, - "BucketEvent": { + "GlobalSearchUsageByTenantData": { "properties": { - "event_type": { - "type": "string", - "const": "bucket", - "title": "Event Type", - "default": "bucket" - }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" - }, - "data": { - "$ref": "#/components/schemas/BucketEventData" + "items": { + "items": { + "$ref": "#/components/schemas/GlobalSearchUsageByTenantDataPoint" + }, + "type": "array", + "title": "Items" } }, "type": "object", "required": [ - "metadata", - "data" + "items" ], - "title": "Bucket" + "title": "GlobalSearchUsageByTenantData" }, - "BucketEventData": { + "GlobalSearchUsageByTenantDataPoint": { "properties": { - "url": { + "tenant_id": { + "type": "integer", + "title": "Tenant Id" + }, + "tenant_name": { "anyOf": [ { "type": "string" @@ -3750,272 +21987,447 @@ "type": "null" } ], - "title": "Url", - "description": "The URL to the bucket." + "title": "Tenant Name" }, - "bucket": { - "$ref": "#/components/schemas/BucketData" + "count": { + "type": "integer", + "title": "Count" + }, + "is_deleted": { + "type": "boolean", + "title": "Is Deleted" } }, "type": "object", "required": [ - "url", - "bucket" + "tenant_id", + "tenant_name", + "count", + "is_deleted" ], - "title": "BucketEventData" + "title": "GlobalSearchUsageByTenantDataPoint" }, - "CCBinData": { + "GlobalSearchUsageFeature": { "properties": { - "type": { - "type": "string", - "const": "bin", - "title": "Type", - "default": "bin" + "feature": { + "$ref": "#/components/schemas/GlobalSearchFeature" }, - "bin": { - "type": "string", - "minLength": 1, - "title": "Bin" + "values": { + "items": { + "$ref": "#/components/schemas/GlobalSearchUsageFeatureValue" + }, + "type": "array", + "title": "Values" } }, "type": "object", "required": [ - "bin" + "feature", + "values" ], - "title": "CCBinData" + "title": "GlobalSearchUsageFeature" }, - "ChatMessageEvent": { + "GlobalSearchUsageFeatureValue": { "properties": { - "event_type": { + "timestamp": { "type": "string", - "const": "chat_message", - "title": "Event Type", - "default": "chat_message" + "format": "date-time", + "title": "Timestamp" }, - "data": { - "$ref": "#/components/schemas/ChatMessageEventData" + "count": { + "type": "integer", + "title": "Count" + } + }, + "type": "object", + "required": [ + "timestamp", + "count" + ], + "title": "GlobalSearchUsageFeatureValue" + }, + "GoogleSSOConfigurationData": { + "properties": { + "is_enabled": { + "type": "boolean", + "title": "Is Enabled" }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" + "is_mandatory": { + "type": "boolean", + "title": "Is Mandatory" + }, + "type": { + "type": "string", + "const": "Google", + "title": "Type" } }, "type": "object", "required": [ - "data", - "metadata" + "is_enabled", + "is_mandatory", + "type" ], - "title": "Chat Message" + "title": "GoogleSSOConfigurationData" + }, + "GroupByType": { + "type": "string", + "enum": [ + "ungrouped", + "relationship_nature" + ], + "title": "GroupByType" }, - "ChatMessageEventData": { + "GroupFilters": { "properties": { - "posted_at": { + "query_string": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "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." + "title": "Query String" }, - "content": { + "identifier_types": { "anyOf": [ { - "type": "string" + "items": { + "$ref": "#/components/schemas/IdentifierType" + }, + "type": "array" }, { "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." + "title": "Identifier Types" }, - "was_forwarded": { + "enable_states": { "anyOf": [ { - "type": "boolean" + "items": { + "$ref": "#/components/schemas/IdentifierEnableState" + }, + "type": "array" }, { "type": "null" } ], - "title": "Was Forwarded", - "description": "Whether the chat message was forwarded." - } - }, - "type": "object", - "title": "ChatMessageEventData" - }, - "Classes": { - "properties": { - "is_carding": { + "title": "Enable States" + }, + "properties": { "anyOf": [ { - "type": "boolean" + "items": { + "$ref": "#/components/schemas/IdentifierProperty" + }, + "type": "array" }, { "type": "null" } ], - "title": "Is Carding", - "description": "Whether the listing is classified as carding." + "title": "Properties" }, - "is_bypass": { + "reachable_dates": { "anyOf": [ { - "type": "boolean" + "$ref": "#/components/schemas/Times" }, { "type": "null" } - ], - "title": "Is Bypass", - "description": "Whether the listing is classified as a bypass." + ] }, - "is_ident_fraud": { + "resolves_dates": { "anyOf": [ { - "type": "boolean" + "$ref": "#/components/schemas/Times" }, { "type": "null" } - ], - "title": "Is Ident Fraud", - "description": "Whether the listing is classified as identity fraud." + ] }, - "is_doc_fraud": { + "source_group": { "anyOf": [ { - "type": "boolean" + "$ref": "#/components/schemas/IdentifierSourceGroup" + }, + { + "type": "null" + } + ] + }, + "group_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "string", + "const": "NO_GROUP" }, { "type": "null" } ], - "title": "Is Doc Fraud", - "description": "Whether the listing is classified as document fraud." + "title": "Group Id", + "default": "NO_GROUP" }, - "is_phishing": { + "parent_identifier_id": { "anyOf": [ { - "type": "boolean" + "type": "integer" }, { "type": "null" } ], - "title": "Is Phishing", - "description": "Whether the listing is classified as phishing." + "title": "Parent Identifier Id" }, - "is_money_xfer": { + "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" + }, + "HubspotLifecycleStage": { + "type": "string", + "enum": [ + "1281177943" + ], + "title": "HubspotLifecycleStage" + }, + "HubspotWebhookFlareSyncEvent": { + "properties": { + "hubspot_id": { + "type": "integer", + "title": "Hubspot Id" + }, + "domain": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "type": "null" } ], - "title": "Is Money Xfer", - "description": "Whether the listing is classified as money transfer." + "title": "Domain" }, - "is_cashout": { + "name": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "type": "null" } ], - "title": "Is Cashout", - "description": "Whether the listing is classified as a cashout." + "title": "Name" }, - "is_virt_currency": { + "organization_id": { "anyOf": [ { - "type": "boolean" + "type": "integer" }, { "type": "null" } ], - "title": "Is Virt Currency", - "description": "Whether the listing is classified as a virtual currency transaction." + "title": "Organization Id" }, - "is_hacking": { + "lifecycle_stage": { "anyOf": [ { - "type": "boolean" + "$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": "Is Hacking", - "description": "Whether the listing is classified as hacking activities." + "title": "Organization Id" }, - "is_misc_financial": { + "tenant_id": { "anyOf": [ { - "type": "boolean" + "type": "integer" }, { "type": "null" } ], - "title": "Is Misc Financial", - "description": "Whether the listing is classified as miscellaneous financial activities." + "title": "Tenant Id" } }, "type": "object", - "title": "Classes" + "required": [ + "hubspot_company_id", + "hubspot_tenant_id", + "flare_tenant_name" + ], + "title": "HubspotWebhookFlareSyncTenantEvent" }, - "Classification": { + "IPData": { "properties": { - "classes": { - "$ref": "#/components/schemas/Classes", - "description": "Data about the classes identified in the listing." + "type": { + "type": "string", + "const": "ip", + "title": "Type", + "default": "ip" }, - "types": { - "$ref": "#/components/schemas/Types", - "description": "Data about the possible listing type." + "ip": { + "type": "string", + "minLength": 1, + "title": "Ip" } }, "type": "object", - "title": "Classification" + "required": [ + "ip" + ], + "title": "IPData" }, - "ConversationMessage": { + "IdPApplicationNode": { "properties": { - "uid": { - "type": "string", - "title": "Uid" - }, - "message": { + "application_uuid": { "type": "string", - "title": "Message" + "format": "uuid", + "title": "Application Uuid" }, - "message_en": { + "domain": { "anyOf": [ { "type": "string" @@ -4024,312 +22436,344 @@ "type": "null" } ], - "title": "Message En" + "title": "Domain" }, - "author_name": { + "name": { "type": "string", - "title": "Author Name" + "title": "Name" }, - "date_time": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Date Time" + "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": [ - "uid", - "message", - "author_name", - "date_time" + "application_uuid", + "domain", + "name", + "idp_type", + "labels", + "risk_score", + "type", + "id" ], - "title": "ConversationMessage" + "title": "IdPApplicationNode" }, - "ConversationSearchAfterDirection": { + "IdPFeature": { "type": "string", "enum": [ - "next", - "previous" + "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": "ConversationSearchAfterDirection" + "title": "IdPUserAccountType" }, - "CreateAlertChannel": { + "Identifier": { "properties": { + "id": { + "type": "integer", + "title": "Id" + }, "name": { "type": "string", "title": "Name" }, - "params": { + "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/AlertChannelEmailParams" + "$ref": "#/components/schemas/CCBinData" }, { - "$ref": "#/components/schemas/AlertChannelSlackParams" + "$ref": "#/components/schemas/IPData" }, { - "$ref": "#/components/schemas/AlertChannelDiscordParams" + "$ref": "#/components/schemas/BrandData" }, { - "$ref": "#/components/schemas/AlertChannelSplunkParams" + "$ref": "#/components/schemas/KeywordData" }, { - "$ref": "#/components/schemas/AlertChannelChannelParams" + "$ref": "#/components/schemas/AzureTenantData" }, { - "$ref": "#/components/schemas/AlertChannelLegacySentinelParams" + "$ref": "#/components/schemas/DomainData" }, { - "$ref": "#/components/schemas/AlertChannelSentinelV2Params" + "$ref": "#/components/schemas/NameData" }, { - "$ref": "#/components/schemas/AlertChannelTeamsParams" + "$ref": "#/components/schemas/SearchQueryData" }, { - "$ref": "#/components/schemas/AlertChannelJiraParams" + "$ref": "#/components/schemas/GithubRepositoryData" }, { - "$ref": "#/components/schemas/AlertChannelServiceNowParams" + "$ref": "#/components/schemas/UsernameData" }, { - "$ref": "#/components/schemas/AlertChannelWebhookParams" + "$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": "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" + "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" } } }, - "state": { + "collection": { "anyOf": [ { - "$ref": "#/components/schemas/AlertChannelState" + "$ref": "#/components/schemas/IdentifierCollectionGroupId" }, { - "type": "null" + "$ref": "#/components/schemas/IdentifierCollectionGroupType" } - ] - } - }, - "type": "object", - "required": [ - "name", - "params" - ], - "title": "CreateAlertChannel" - }, - "CreateAstpCookiesBody": { - "properties": { - "name": { - "type": "string", - "minLength": 1, - "title": "Name", - "description": "The name of the matching policy" + ], + "title": "Collection" }, - "type": { + "urn": { "type": "string", - "const": "ASTP_COOKIES", - "title": "Type" + "title": "Urn" }, - "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" + "entity": { + "anyOf": [ + { + "$ref": "#/components/schemas/IdentityIdentifierEntity" + }, + { + "type": "null" + } + ] }, - "type": { - "type": "string", - "const": "ASTP_DOMAIN", - "title": "Type" + "enrichments": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/DomainAssetEnrichment" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Enrichments" + }, + "metadata": { + "$ref": "#/components/schemas/IdentifierMetadata" }, - "value": { - "$ref": "#/components/schemas/AstpDomainValue", - "description": "The value of the matching policy in the form of a domain match mode" + "state": { + "$ref": "#/components/schemas/IdentifierState" } }, "type": "object", "required": [ + "id", "name", + "tenant_id", "type", - "value" + "feed", + "feed_config", + "asset_uuid", + "data", + "collection", + "urn", + "entity", + "enrichments", + "metadata", + "state" ], - "title": "CreateAstpDomainBody" + "title": "Identifier" }, - "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" + "IdentifierAuthorizationRequestStatus": { + "type": "string", + "enum": [ + "pending", + "rejected" ], - "title": "CreateExcludedKeywordsBody" + "title": "IdentifierAuthorizationRequestStatus" }, - "CreateIncludedKeywordsBody": { + "IdentifierAuthorizationStatus": { + "type": "string", + "enum": [ + "pending", + "rejected", + "authorized" + ], + "title": "IdentifierAuthorizationStatus" + }, + "IdentifierCollectionGroupId": { "properties": { - "name": { - "type": "string", - "minLength": 1, - "title": "Name", - "description": "The name of the matching policy" - }, "type": { "type": "string", - "const": "INCLUDED_KEYWORDS", + "const": "group_id", "title": "Type" }, - "value": { - "$ref": "#/components/schemas/KeywordsValue", - "description": "The value of the matching policy in the form of keywords" + "group_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Group Id" } }, "type": "object", "required": [ - "name", "type", - "value" + "group_id" ], - "title": "CreateIncludedKeywordsBody" + "title": "IdentifierCollectionGroupId" }, - "CreateLuceneQueryBody": { + "IdentifierCollectionGroupType": { "properties": { - "name": { - "type": "string", - "minLength": 1, - "title": "Name", - "description": "The name of the matching policy" - }, "type": { "type": "string", - "const": "LUCENE_QUERY", + "const": "group_type", "title": "Type" }, - "value": { - "$ref": "#/components/schemas/LuceneValue", - "description": "The value of the matching policy in the form of a Lucene query" + "group_type": { + "$ref": "#/components/schemas/IdentifierGroupType" } }, "type": "object", "required": [ - "name", "type", - "value" + "group_type" ], - "title": "CreateLuceneQueryBody" + "title": "IdentifierCollectionGroupType" }, - "Credential": { + "IdentifierEnrichments": { "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": { + "domain_reachable_at": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Hash" + "title": "Domain Reachable At" }, - "hash_type": { + "domain_resolves_at": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Hash Type" + "title": "Domain Resolves At" }, - "source": { - "anyOf": [ - { - "$ref": "#/components/schemas/SourceV2" - }, - { - "type": "null" - } - ] + "usage_count": { + "type": "integer", + "title": "Usage Count" }, - "known_password_id": { + "event_count": { "anyOf": [ { "type": "integer" @@ -4338,162 +22782,376 @@ "type": "null" } ], - "title": "Known Password Id" + "title": "Event Count" }, - "credential_hash": { + "authorization_status": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/IdentifierAuthorizationStatus" }, { "type": "null" } ], - "title": "Credential Hash" + "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" }, - "event_uid": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Event Uid" + "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" }, - "auth_domains": { + "activity_types": { "items": { "type": "string" }, "type": "array", - "title": "Auth Domains" + "title": "Activity Types" }, - "urls": { + "items": { "items": { - "type": "string" + "$ref": "#/components/schemas/IdentifierFeedRateLimit" }, "type": "array", - "title": "Urls" + "title": "Items" } }, "type": "object", "required": [ - "id", - "identity_name", - "domain", - "source_id", - "imported_at", - "hash", - "hash_type", - "source", - "known_password_id", - "credential_hash", - "event_uid" + "first_rate_limited_at", + "last_rate_limited_at", + "activity_types", + "items" ], - "title": "Credential" + "title": "IdentifierFeedRateLimits" }, - "CredentialActionBody": { + "IdentifierGroupType": { + "type": "string", + "enum": [ + "person", + "corporate_identities" + ], + "title": "IdentifierGroupType" + }, + "IdentifierMatchingPolicyBody": { "properties": { - "type": { - "$ref": "#/components/schemas/LeakedCredentialsBulkActionType" + "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": [ - "type" + "matching_policy_uuid" ], - "title": "CredentialActionBody" + "title": "IdentifierMatchingPolicyBody" }, - "CredentialActionRequestBody": { + "IdentifierMetadata": { "properties": { - "targets": { - "items": { - "$ref": "#/components/schemas/CredentialActionTarget" - }, - "type": "array", - "maxItems": 100, - "title": "Targets" + "critical": { + "type": "boolean", + "title": "Critical" }, - "action": { - "$ref": "#/components/schemas/CredentialActionBody" + "is_disabled": { + "type": "boolean", + "title": "Is Disabled" } }, "type": "object", "required": [ - "targets", - "action" + "critical", + "is_disabled" ], - "title": "CredentialActionRequestBody" + "title": "IdentifierMetadata" }, - "CredentialActionTarget": { + "IdentifierOrderBy": { + "type": "string", + "enum": [ + "id", + "name", + "type" + ], + "title": "IdentifierOrderBy" + }, + "IdentifierRecommendationAction": { "properties": { - "credential_hash": { - "type": "string", - "title": "Credential Hash" + "type": { + "$ref": "#/components/schemas/IdentifierRecommendationActionType" } }, "type": "object", "required": [ - "credential_hash" + "type" ], - "title": "CredentialActionTarget" + "title": "IdentifierRecommendationAction" }, - "CredentialEventData": { + "IdentifierRecommendationActionTarget": { "properties": { - "identity_name": { - "type": "string", - "title": "Identity Name", - "description": "The email or username associated with the credential." - }, - "credential_hash": { - "type": "string", - "title": "Credential Hash", - "description": "A hash uniquely identifying the credential." + "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" }, - "tenant_integration_id": { - "type": "string", - "title": "Tenant Integration Id", - "description": "The UUID of the tenant's IdP integration that validated the credential." + "action": { + "$ref": "#/components/schemas/IdentifierRecommendationAction" } }, "type": "object", "required": [ - "identity_name", - "credential_hash", - "tenant_integration_id" + "action" ], - "title": "CredentialEventData" + "title": "IdentifierRecommendationActionsBody" }, - "CredentialsData": { + "IdentifierRecommendationState": { + "type": "string", + "enum": [ + "recommended", + "accepted", + "rejected" + ], + "title": "IdentifierRecommendationState" + }, + "IdentifierRequestBody": { "properties": { - "type": { - "type": "string", - "const": "credentials", - "title": "Type", - "default": "credentials" + "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" }, - "username": { - "type": "string", - "minLength": 1, - "title": "Username" + "metadata": { + "$ref": "#/components/schemas/IdentifierMetadata" }, - "password": { - "type": "string", - "minLength": 1, - "title": "Password" + "matching_policies": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/IdentifierMatchingPolicyBody" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Matching Policies" } }, "type": "object", "required": [ - "username", - "password" + "data", + "name", + "feed_config", + "collection", + "metadata" ], - "title": "CredentialsData" + "title": "IdentifierRequestBody" }, - "CredentialsDateFilter": { + "IdentifierResponse": { "properties": { - "gte": { + "identifier": { + "anyOf": [ + { + "$ref": "#/components/schemas/Identifier" + }, + { + "type": "null" + } + ] + }, + "is_materialized": { + "type": "boolean", + "title": "Is Materialized", + "default": false + }, + "created_at": { "anyOf": [ { "type": "string", @@ -4503,9 +23161,9 @@ "type": "null" } ], - "title": "Gte" + "title": "Created At" }, - "lte": { + "last_updated_at": { "anyOf": [ { "type": "string", @@ -4515,681 +23173,581 @@ "type": "null" } ], - "title": "Lte" + "title": "Last Updated At" } }, "type": "object", - "title": "CredentialsDateFilter" + "title": "IdentifierResponse" }, - "CredentialsQuery": { + "IdentifierScope": { "properties": { - "type": { - "type": "string", - "const": "credentials", - "title": "Type" - }, - "username": { + "name": { "type": "string", - "title": "Username" + "title": "Name" }, - "password": { - "type": "string", - "title": "Password" + "is_disabled": { + "type": "boolean", + "title": "Is Disabled", + "default": false } }, "type": "object", "required": [ - "type", - "username", - "password" + "name" ], - "title": "CredentialsQuery" + "title": "IdentifierScope" }, - "CredentialsQueryFilters": { - "properties": { - "imported_at": { - "$ref": "#/components/schemas/CredentialsDateFilter" - } - }, - "type": "object", - "title": "CredentialsQueryFilters" + "IdentifierSource": { + "type": "string", + "enum": [ + "USER", + "SYSTEM_RELATION", + "SELF_ONBOARDING", + "ATTRIBUTE", + "AUTO_MONITOR", + "IDP_SYNC" + ], + "title": "IdentifierSource" }, - "CredentialsQueryPayload": { + "IdentifierState": { "properties": { - "query": { - "oneOf": [ - { - "$ref": "#/components/schemas/DomainQuery" - }, - { - "$ref": "#/components/schemas/EmailQuery" - }, - { - "$ref": "#/components/schemas/KeywordQuery" - }, + "source": { + "$ref": "#/components/schemas/IdentifierSource" + }, + "data_updated_at": { + "type": "string", + "format": "date-time", + "title": "Data Updated At" + }, + "event_count": { + "anyOf": [ { - "$ref": "#/components/schemas/SecretQuery" + "type": "integer" }, { - "$ref": "#/components/schemas/AuthDomainQuery" + "type": "null" } ], - "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" - } - } + "title": "Event Count" }, - "filters": { - "$ref": "#/components/schemas/CredentialsQueryFilters" + "usage_count": { + "type": "integer", + "title": "Usage Count" }, - "from": { + "rate_limits": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/IdentifierFeedRateLimits" }, { "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" - }, - "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": { + "validation_status": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/IdentifierValidationStatus" }, { "type": "null" } - ], - "title": "Title" - } - }, - "type": "object", - "required": [ - "type", - "sources", - "entries", - "tags", - "statuses", - "external_links", - "title" - ], - "title": "DomainAssetEnrichment" - }, - "DomainData": { - "properties": { - "type": { - "type": "string", - "const": "domain", - "title": "Type", - "default": "domain" + ] }, - "fqdn": { - "type": "string", - "minLength": 1, - "title": "Fqdn" + "authorization_request_status": { + "anyOf": [ + { + "$ref": "#/components/schemas/IdentifierAuthorizationRequestStatus" + }, + { + "type": "null" + } + ] } }, "type": "object", "required": [ - "fqdn" + "source", + "data_updated_at", + "event_count", + "usage_count", + "rate_limits", + "validation_status", + "authorization_request_status" ], - "title": "DomainData" + "title": "IdentifierState" }, - "DomainMatchMode": { + "IdentifierType": { "type": "string", "enum": [ - "email_domain_only", - "auth_domain_and_email_domain", - "auth_domain_only" - ], - "title": "DomainMatchMode" - }, - "DomainQuery": { - "properties": { - "type": { - "type": "string", - "const": "domain", - "title": "Type" - }, - "fqdn": { - "type": "string", - "title": "Fqdn" - } - }, - "type": "object", - "required": [ - "type", - "fqdn" + "domain", + "name", + "keyword", + "github_repository", + "username", + "email", + "search_query", + "bin", + "ip", + "secret", + "azure_tenant", + "identity", + "ransomleak", + "external_id", + "address_data", + "birth_year", + "role", + "phone_number" ], - "title": "DomainQuery" + "title": "IdentifierType" }, - "DomainStatus": { + "IdentifierValidationStatus": { "type": "string", "enum": [ - "found", - "resolves", - "reachable" + "FIRST_PARTY" ], - "title": "DomainStatus" + "title": "IdentifierValidationStatus" }, - "EmailData": { + "IdentityAttribute": { "properties": { - "type": { + "asset_uuid": { "type": "string", - "const": "email", - "title": "Type", - "default": "email" + "title": "Asset Uuid" }, - "email": { - "type": "string", - "format": "email", - "title": "Email" + "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": [ - "email" + "asset_uuid", + "data" ], - "title": "EmailData" + "title": "IdentityAttribute" }, - "EmailQuery": { + "IdentityBrowserCounts": { "properties": { - "type": { - "type": "string", - "const": "email", - "title": "Type" + "passwords": { + "type": "integer", + "title": "Passwords" }, - "email": { - "type": "string", - "title": "Email" + "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": [ - "type", - "email" + "passwords", + "stealer_logs", + "pii", + "illicit_networks", + "open_web" ], - "title": "EmailQuery" + "title": "IdentityBrowserCounts" }, - "EmptyFireworkEvent": { + "IdentityBrowserItemResponse": { "properties": { - "event_type": { - "$ref": "#/components/schemas/ActivityModelName" - }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" + "asset_uuid": { + "type": "string", + "title": "Asset Uuid" }, - "data": { - "additionalProperties": true, - "type": "object", - "title": "Data" + "risk": { + "anyOf": [ + { + "$ref": "#/components/schemas/PhoneNumberData" + } + ], + "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": [ - "event_type", - "metadata" + "asset_uuid", + "data" ], - "title": "EmptyFireworkEvent" + "title": "IdentityAttribute" }, - "EventAction": { + "IdentityData": { "properties": { "type": { "type": "string", - "enum": [ - "remediate", - "unremediate", - "ignore", - "unignore" - ], - "title": "Type" + "const": "identity", + "title": "Type", + "default": "identity" + }, + "uuid": { + "type": "string", + "minLength": 1, + "title": "Uuid" } }, "type": "object", "required": [ - "type" + "uuid" ], - "title": "EventAction" + "title": "IdentityData" }, - "EventActionTarget": { + "IdentityDataRequestBody": { "properties": { - "uid": { + "type": { "type": "string", - "title": "Uid" + "const": "identity", + "title": "Type" + }, + "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": [ - "uid" + "type", + "attributes" ], - "title": "EventActionTarget" + "title": "IdentityDataRequestBody" }, - "EventActionsBody": { + "IdentityIdentifierEntity": { "properties": { - "targets": { + "type": { + "$ref": "#/components/schemas/IdentifierEntityType" + }, + "attributes": { "items": { - "$ref": "#/components/schemas/EventActionTarget" + "$ref": "#/components/schemas/IdentityAttribute" }, "type": "array", - "maxItems": 10, - "title": "Targets" - }, - "action": { - "$ref": "#/components/schemas/EventAction" + "title": "Attributes" } }, "type": "object", "required": [ - "action" + "type", + "attributes" ], - "title": "EventActionsBody" + "title": "IdentityIdentifierEntity" }, - "EventMetadata": { + "IdentityNode": { "properties": { - "estimated_created_at": { + "primary_email": { + "type": "string", + "title": "Primary Email" + }, + "first_name": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Estimated Created At" - }, - "flare_url": { - "type": "string", - "maxLength": 2083, - "minLength": 1, - "format": "uri", - "title": "Flare Url" + "title": "First Name" }, - "matched_at": { + "last_name": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Matched At" - }, - "severity": { - "$ref": "#/components/schemas/EventSeverity" + "title": "Last Name" }, - "uid": { - "type": "string", - "title": "Uid" - } - }, - "type": "object", - "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" - }, - "ExternalIdData": { - "properties": { "type": { - "type": "string", - "const": "external_id", - "title": "Type", - "default": "external_id" + "$ref": "#/components/schemas/ApplicationExposureNodeType", + "readOnly": true }, "id": { "type": "string", - "minLength": 1, - "title": "Id" - }, - "source": { - "type": "string", - "minLength": 1, - "title": "Source" + "title": "Id", + "readOnly": true } }, "type": "object", "required": [ - "id", - "source" + "primary_email", + "first_name", + "last_name", + "type", + "id" ], - "title": "ExternalIdData" + "title": "IdentityNode" }, - "FeedConfiguration": { + "IdentityProfileBanner": { "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" + "uuid": { + "type": "string", + "format": "uuid", + "title": "Uuid" }, - "blacklist": { + "email": { "anyOf": [ { - "items": { - "type": "string" - }, - "type": "array" + "type": "string" }, { "type": "null" } ], - "title": "Blacklist" - } - }, - "type": "object", - "required": [ - "search_types", - "experimental_search_types", - "risks", - "blacklist" - ], - "title": "FeedConfiguration" - }, - "FeedDateFilter": { - "properties": { - "gt": { + "title": "Email" + }, + "display_name": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Gt" + "title": "Display Name" }, - "gte": { + "account_type": { "anyOf": [ { - "type": "string", - "format": "date-time" + "$ref": "#/components/schemas/IdPUserAccountType" }, { "type": "null" } - ], - "title": "Gte" + ] }, - "lt": { + "is_on_premises_sync_enabled": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "boolean" }, { "type": "null" } ], - "title": "Lt" + "title": "Is On Premises Sync Enabled" }, - "lte": { + "is_active": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "boolean" }, { "type": "null" } ], - "title": "Lte" - } - }, - "type": "object", - "title": "FeedDateFilter" - }, - "FeedDefinition": { - "properties": { - "type": { - "$ref": "#/components/schemas/FeedType" + "title": "Is Active" }, - "id": { + "vip": { "anyOf": [ { - "type": "integer" + "type": "boolean" }, { "type": "null" } ], - "title": "Id" - } - }, - "type": "object", - "required": [ - "type" - ], - "title": "FeedDefinition" - }, - "FeedFilters": { - "properties": { - "severity": { + "title": "Vip" + }, + "alert_level": { "anyOf": [ { - "$ref": "#/components/schemas/Severity" + "$ref": "#/components/schemas/RiskScore" }, { - "items": { - "$ref": "#/components/schemas/Severity" - }, - "type": "array" + "type": "null" } - ], - "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" + "required": [ + "uuid", + "email", + "display_name", + "account_type", + "is_on_premises_sync_enabled", + "is_active", + "vip", + "alert_level" + ], + "title": "IdentityProfileBanner" }, - "FeedItem": { + "ImpersonationFilter": { + "type": "string", + "enum": [ + "include", + "exclude", + "only" + ], + "title": "ImpersonationFilter" + }, + "ImportEventResult": { "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" + "success": { + "type": "boolean", + "title": "Success" } }, "type": "object", "required": [ - "metadata" + "success" ], - "title": "FeedItem" + "title": "ImportEventResult" }, - "FeedItemIdentifier": { + "ImportExperimentalEventModel": { "properties": { - "id": { - "type": "integer", - "title": "Id" + "metadata": { + "$ref": "#/components/schemas/ExperimentalEventMetadata" }, - "name": { + "data": { + "additionalProperties": true, + "type": "object", + "title": "Data" + }, + "content": { "type": "string", - "title": "Name" + "title": "Content" + }, + "tenant_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Tenant Id" } }, "type": "object", "required": [ - "id", - "name" + "metadata", + "data", + "content" ], - "title": "FeedItemIdentifier" + "title": "ImportExperimentalEventModel" }, - "FeedItemMetadata": { + "IncludeOptions": { + "type": "string", + "enum": [ + "known_password_id", + "auth_domains", + "urls" + ], + "title": "IncludeOptions" + }, + "IndicatorEntityAPIResponse": { "properties": { - "uid": { + "uuid": { "type": "string", - "title": "Uid" + "title": "Uuid" }, - "estimated_created_at": { + "type": { + "$ref": "#/components/schemas/EntityType" + }, + "name": { "type": "string", - "format": "date-time", - "title": "Estimated Created At" + "title": "Name" }, - "matched_at": { + "created_by": { + "type": "string", + "title": "Created By" + }, + "sources": { + "items": { + "$ref": "#/components/schemas/CTIEntitySourceAPIResponse" + }, + "type": "array", + "title": "Sources" + }, + "created_at": { "anyOf": [ { "type": "string", @@ -5199,43 +23757,60 @@ "type": "null" } ], - "title": "Matched At" + "title": "Created At" }, - "type": { - "$ref": "#/components/schemas/ActivityModelName" + "updated_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Updated At" }, - "severity": { - "$ref": "#/components/schemas/Severity" + "first_seen_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "First Seen At" }, - "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": { + "last_seen_at": { "anyOf": [ { - "$ref": "#/components/schemas/FeedItemTenantMetadataSeverity" + "type": "string", + "format": "date-time" }, { "type": "null" } - ] + ], + "title": "Last Seen At" }, - "notes": { + "confidence": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Confidence" + }, + "pattern": { + "type": "string", + "title": "Pattern" + }, + "pattern_version": { "anyOf": [ { "type": "string" @@ -5244,16 +23819,27 @@ "type": "null" } ], - "title": "Notes" + "title": "Pattern Version" }, - "tags": { + "indicator_types": { "items": { "type": "string" }, "type": "array", - "title": "Tags" + "title": "Indicator Types" }, - "remediated_at": { + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Description" + }, + "valid_from": { "anyOf": [ { "type": "string", @@ -5263,9 +23849,9 @@ "type": "null" } ], - "title": "Remediated At" + "title": "Valid From" }, - "ignored_at": { + "valid_until": { "anyOf": [ { "type": "string", @@ -5275,121 +23861,134 @@ "type": "null" } ], - "title": "Ignored At" - } - }, - "type": "object", - "title": "FeedItemTenantMetadata" - }, - "FeedItemTenantMetadataSeverity": { - "properties": { - "original": { - "$ref": "#/components/schemas/Severity" + "title": "Valid Until" }, - "override": { - "$ref": "#/components/schemas/Severity" + "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": [ - "original", - "override" + "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": "FeedItemTenantMetadataSeverity" + "title": "IndicatorEntityAPIResponse" }, - "FeedOrder": { + "IndicatorType": { "type": "string", "enum": [ - "asc", - "desc" + "URL" ], - "title": "FeedOrder" + "title": "IndicatorType" }, - "FeedRequestBody": { + "InfrastructureEntityAPIResponse": { "properties": { - "query": { + "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": [ { - "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": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Query", - "examples": [ + "title": "Created At" + }, + "updated_at": { + "anyOf": [ { - "fqdn": "test.com", - "type": "domain" + "type": "string", + "format": "date-time" + }, + { + "type": "null" } - ] + ], + "title": "Updated At" }, - "filters": { - "$ref": "#/components/schemas/FeedFilters" + "first_seen_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "First Seen At" }, - "order": { - "$ref": "#/components/schemas/FeedOrder", - "default": "desc" + "last_seen_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Seen At" }, - "from": { + "confidence": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Confidence" + }, + "description": { "anyOf": [ { "type": "string" @@ -5398,130 +23997,252 @@ "type": "null" } ], - "title": "From" + "title": "Description" }, - "size": { - "type": "integer", - "maximum": 10.0, - "exclusiveMinimum": 0.0, - "title": "Size", - "default": 10 + "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", - "title": "FeedRequestBody" + "required": [ + "uuid", + "type", + "name", + "created_by", + "sources", + "created_at", + "updated_at", + "description", + "infrastructure_types", + "kill_chain_phases", + "marking_definitions" + ], + "title": "InfrastructureEntityAPIResponse" }, - "FeedType": { + "IntelType": { "type": "string", "enum": [ - "tenant", - "identifier", - "group" + "unit_summary_based", + "custom_intel" ], - "title": "FeedType" + "title": "IntelType" }, - "FilterSeverities": { + "InvalidCredentialEvent": { "properties": { - "severities": { - "items": { - "$ref": "#/components/schemas/FilterSeverity" - }, - "type": "array", - "title": "Severities" + "event_type": { + "type": "string", + "const": "invalid_credential", + "title": "Event Type", + "default": "invalid_credential" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + }, + "data": { + "$ref": "#/components/schemas/CredentialEventData" } }, "type": "object", - "title": "FilterSeverities" + "required": [ + "metadata", + "data" + ], + "title": "Invalid Credential" }, - "FilterSeverity": { + "IpQuery": { "properties": { - "value": { - "type": "string", - "title": "Value" - }, - "label": { + "type": { "type": "string", - "title": "Label" + "const": "ip", + "title": "Type" }, - "color": { + "ip": { "type": "string", - "title": "Color" + "title": "Ip" } }, "type": "object", "required": [ - "value", - "label", - "color" + "type", + "ip" ], - "title": "FilterSeverity" + "title": "IpQuery" }, - "FilterSourceType": { + "KeywordData": { "properties": { - "value": { + "type": { "type": "string", - "title": "Value" + "const": "keyword", + "title": "Type", + "default": "keyword" }, - "label": { + "keyword": { "type": "string", - "title": "Label" + "minLength": 1, + "title": "Keyword" } }, "type": "object", "required": [ - "value", - "label" + "keyword" ], - "title": "FilterSourceType" + "title": "KeywordData" }, - "FilterSourceTypeCategory": { + "KeywordQuery": { "properties": { - "value": { + "type": { "type": "string", - "title": "Value" + "const": "keyword", + "title": "Type" }, - "label": { + "keyword": { "type": "string", - "title": "Label" - }, - "types": { - "items": { - "$ref": "#/components/schemas/FilterSourceType" - }, - "type": "array", - "title": "Types" + "title": "Keyword" } }, "type": "object", "required": [ - "value", - "label" + "type", + "keyword" ], - "title": "FilterSourceTypeCategory" + "title": "KeywordQuery" }, - "FilterSourceTypes": { + "KeywordsValue": { "properties": { - "categories": { + "keywords": { "items": { - "$ref": "#/components/schemas/FilterSourceTypeCategory" + "type": "string" }, "type": "array", - "title": "Categories" + "title": "Keywords" + } + }, + "type": "object", + "required": [ + "keywords" + ], + "title": "KeywordsValue" + }, + "Language": { + "type": "string", + "enum": [ + "en", + "fr" + ], + "title": "Language" + }, + "LeakedCredentialEvent": { + "properties": { + "event_type": { + "type": "string", + "const": "leaked_credential", + "title": "Event Type", + "default": "leaked_credential" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + }, + "data": { + "$ref": "#/components/schemas/LeakedCredentialEventData" + } + }, + "type": "object", + "required": [ + "metadata", + "data" + ], + "title": "Leaked Credential" + }, + "LeakedCredentialEventData": { + "properties": { + "identity_name": { + "type": "string", + "title": "Identity Name", + "description": "The email or username associated with the leaked credential." + }, + "imported_at": { + "type": "string", + "format": "date-time", + "title": "Imported At", + "description": "When the credential was imported into Flare." + }, + "password": { + "type": "string", + "title": "Password", + "description": "The leaked password, or its hash if not available in cleartext." + }, + "source": { + "$ref": "#/components/schemas/LeakedCredentialEventSource", + "description": "The source the credential was leaked from." + } + }, + "type": "object", + "required": [ + "identity_name", + "imported_at", + "password", + "source" + ], + "title": "LeakedCredentialEventData" + }, + "LeakedCredentialEventSource": { + "properties": { + "id": { + "type": "string", + "title": "Id", + "description": "The identifier of the leak source category." + }, + "name": { + "type": "string", + "title": "Name", + "description": "The name of the leak source category." } }, "type": "object", - "title": "FilterSourceTypes" + "required": [ + "id", + "name" + ], + "title": "LeakedCredentialEventSource" }, - "FinancialEvent": { + "LeakedCredentialsBulkActionType": { + "type": "string", + "enum": [ + "remediate", + "unremediate", + "ignore", + "unignore" + ], + "title": "LeakedCredentialsBulkActionType" + }, + "ListingEvent": { "properties": { "event_type": { "type": "string", - "const": "cc", + "const": "listing", "title": "Event Type", - "default": "cc" + "default": "listing" }, "data": { - "$ref": "#/components/schemas/FinancialEventData" + "$ref": "#/components/schemas/ListingEventData" }, "metadata": { "$ref": "#/components/schemas/EventMetadata" @@ -5532,11 +24253,11 @@ "data", "metadata" ], - "title": "Credit Card" + "title": "Listing" }, - "FinancialEventData": { + "ListingEventData": { "properties": { - "bank": { + "url": { "anyOf": [ { "type": "string" @@ -5545,10 +24266,10 @@ "type": "null" } ], - "title": "Bank", - "description": "The bank associated with the leaked credit card." + "title": "Url", + "description": "The URL to the listing." }, - "bin": { + "title": { "anyOf": [ { "type": "string" @@ -5557,10 +24278,10 @@ "type": "null" } ], - "title": "Bin", - "description": "The BIN (Bank Identification Number) of the credit card." + "title": "Title", + "description": "The title of the listing." }, - "brand": { + "content": { "anyOf": [ { "type": "string" @@ -5569,10 +24290,10 @@ "type": "null" } ], - "title": "Brand", - "description": "The brand of the leakedcredit card. Ex: VISA" + "title": "Content", + "description": "The content within the listing." }, - "country": { + "currency": { "anyOf": [ { "type": "string" @@ -5581,10 +24302,109 @@ "type": "null" } ], - "title": "Country", - "description": "The country the leakedcredit card was issued in." + "title": "Currency", + "description": "The currency expected in the listing." }, - "expiration": { + "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" + }, + "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", @@ -5594,22 +24414,25 @@ "type": "null" } ], - "title": "Expiration", - "description": "The expiration date of the leaked credit card." + "title": "Registered At", + "description": "The date and time the lookalike domain was registered." }, - "owner": { + "identifier_domains": { "anyOf": [ { - "type": "string" + "items": { + "type": "string" + }, + "type": "array" }, { "type": "null" } ], - "title": "Owner", - "description": "The owner of the leaked credit card." + "title": "Identifier Domains", + "description": "Domain identifiers matching the lookalike domains" }, - "state_code": { + "feed": { "anyOf": [ { "type": "string" @@ -5618,163 +24441,220 @@ "type": "null" } ], - "title": "State Code", - "description": "The state code tied to the leaked credit card." + "title": "Feed", + "description": "The feed where the lookalike domain was found" }, - "zip": { + "cert_data": { "anyOf": [ { - "type": "string" + "additionalProperties": true, + "type": "object" }, { "type": "null" } ], - "title": "Zip", - "description": "The zip code tied to the leaked credit card." + "title": "Cert Data", + "description": "The certificate data of the lookalike domain." }, - "has_cvv": { + "subject": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "type": "null" } ], - "title": "Has Cvv", - "description": "Whether the CVV was included in the leaked data." + "title": "Subject", + "description": "The subject of the certificate of the lookalike domain." }, - "has_date_of_birth": { + "issuer": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "type": "null" } ], - "title": "Has Date Of Birth", - "description": "Whether the date of birth was included in the leaked data." + "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" }, - "has_mother_maiden_name": { + "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": "boolean" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Has Mother Maiden Name", - "description": "Whether the mother's maiden name was included in the leaked data." + "title": "Created At" }, - "has_phone": { + "updated_at": { "anyOf": [ { - "type": "boolean" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Has Phone", - "description": "Whether the phone number was included in the leaked data." + "title": "Updated At" }, - "has_pin": { + "first_seen_at": { "anyOf": [ { - "type": "boolean" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Has Pin", - "description": "Whether the card's PIN was included in the leaked data." + "title": "First Seen At" }, - "has_ssn": { + "last_seen_at": { "anyOf": [ { - "type": "boolean" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Has Ssn", - "description": "Whether the card owner's SSN was included in the leaked data." + "title": "Last Seen At" }, - "has_track_1": { + "confidence": { "anyOf": [ { - "type": "boolean" + "type": "integer" }, { "type": "null" } ], - "title": "Has Track 1", - "description": "Whether the card's track 1 (magnetic stripe data) was included in the leaked data." + "title": "Confidence" }, - "has_vbv": { + "description": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "type": "null" } ], - "title": "Has Vbv", - "description": "Whether the card's VBV (Verified by Visa) data was included in the leaked data." + "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": [ - "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" + "uuid", + "type", + "name", + "created_by", + "sources", + "created_at", + "updated_at", + "description", + "malware_types", + "kill_chain_phases", + "marking_definitions" ], - "title": "FinancialEventData" + "title": "MalwareEntityAPIResponse" }, - "ForumPostData": { + "MalwareInformation": { "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": { + "malware_family": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Posted At", - "description": "Date and time the forum post was made." + "title": "Malware Family", + "description": "The malware family used for device infection." }, - "content": { + "build_id": { "anyOf": [ { "type": "string" @@ -5783,10 +24663,10 @@ "type": "null" } ], - "title": "Content", - "description": "Content of the forum post." + "title": "Build Id", + "description": "The build ID of the malware used for device infection." }, - "url": { + "file_location": { "anyOf": [ { "type": "string" @@ -5795,337 +24675,543 @@ "type": "null" } ], - "title": "Url", - "description": "URL to the forum post." + "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": [ - "actor", - "context", - "posted_at", - "content", - "url" + "malware_family", + "build_id", + "file_location", + "infected_at" ], - "title": "ForumPostData" + "title": "MalwareInformation" }, - "ForumPostEvent": { + "MatchingPolicyAssignmentPayload": { "properties": { - "event_type": { - "type": "string", - "const": "forum_post", - "title": "Event Type", - "default": "forum_post" + "matching_policy": { + "$ref": "#/components/schemas/MatchingPolicyPayload" }, - "data": { - "$ref": "#/components/schemas/ForumPostData" + "assigned_at": { + "type": "string", + "format": "date-time", + "title": "Assigned At", + "description": "The date and time this policy was assigned to the identifier" }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" + "clean_past_events": { + "type": "boolean", + "title": "Clean Past Events", + "description": "Whether this policy has been applied to historical events" } }, "type": "object", "required": [ - "data", - "metadata" + "matching_policy", + "assigned_at", + "clean_past_events" ], - "title": "Forum Post" + "title": "MatchingPolicyAssignmentPayload" }, - "ForwardInfo": { + "MatchingPolicyPayload": { "properties": { - "forwarded_from": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Forwarded From", - "description": "The username of the chat message forwarder." + "uuid": { + "type": "string", + "format": "uuid4", + "title": "Uuid", + "description": "The UUID of the matching policy" }, - "forwarded_from_author_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Forwarded From Author Id", - "description": "The ID of the chat message forwarder." + "name": { + "type": "string", + "title": "Name", + "description": "The name of the matching policy" }, - "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." + "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" + }, + "MitigatedCredentialEvent": { + "properties": { + "event_type": { + "type": "string", + "const": "mitigated_credential", + "title": "Event Type", + "default": "mitigated_credential" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" }, - "forwarded_from_conversation_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Forwarded From Conversation Id", - "description": "The conversation ID the message is being forwarded from." + "data": { + "$ref": "#/components/schemas/MitigatedCredentialEventData" + } + }, + "type": "object", + "required": [ + "metadata", + "data" + ], + "title": "Mitigated Credential" + }, + "MitigatedCredentialEventData": { + "properties": { + "identity_name": { + "type": "string", + "title": "Identity Name", + "description": "The email or username associated with the credential." }, - "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." + "credential_hash": { + "type": "string", + "title": "Credential Hash", + "description": "A hash uniquely identifying the credential." }, - "forwarded_from_username": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Forwarded From Username", - "description": "The username of the user the message is being forwarded from." + "tenant_integration_id": { + "type": "string", + "title": "Tenant Integration Id", + "description": "The UUID of the tenant's IdP integration that validated the credential." }, - "forwarded_message_time": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Forwarded Message Time", - "description": "The time the message was forwarded." + "mitigation_action": { + "type": "string", + "title": "Mitigation Action", + "description": "The action the tenant's IdP integration took to mitigate the credential" } }, "type": "object", - "title": "ForwardInfo" + "required": [ + "identity_name", + "credential_hash", + "tenant_integration_id", + "mitigation_action" + ], + "title": "MitigatedCredentialEventData" }, - "GithubRepositoryData": { + "NameBody": { + "properties": { + "first_name": { + "type": "string", + "title": "First Name", + "default": "" + }, + "last_name": { + "type": "string", + "title": "Last Name", + "default": "" + } + }, + "type": "object", + "title": "NameBody" + }, + "NameData": { "properties": { "type": { "type": "string", - "const": "github_repository", + "const": "name", "title": "Type", - "default": "github_repository" + "default": "name" }, - "repo_name": { + "first_name": { "type": "string", - "minLength": 1, - "title": "Repo Name" + "title": "First Name" }, - "repo_owner": { + "last_name": { "type": "string", - "minLength": 1, - "title": "Repo Owner" + "title": "Last Name" + }, + "is_strict": { + "type": "boolean", + "title": "Is Strict" } }, "type": "object", "required": [ - "repo_name", - "repo_owner" + "first_name", + "last_name", + "is_strict" ], - "title": "GithubRepositoryData" + "title": "NameData" }, - "GithubRepositoryQuery": { + "NameQuery": { "properties": { "type": { "type": "string", - "const": "github_repository", + "const": "name", "title": "Type" }, - "repo_owner": { + "first_name": { "type": "string", - "title": "Repo Owner" + "title": "First Name" }, - "repo_name": { + "last_name": { "type": "string", - "title": "Repo Name" + "title": "Last Name" + }, + "is_strict": { + "type": "boolean", + "title": "Is Strict" } }, "type": "object", "required": [ "type", - "repo_owner", - "repo_name" + "first_name", + "last_name", + "is_strict" ], - "title": "GithubRepositoryQuery" + "title": "NameQuery" }, - "GlobalFeedItem": { + "OrderType": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "title": "OrderType" + }, + "OrganizationBanner": { "properties": { - "metadata": { - "$ref": "#/components/schemas/FeedItemMetadata" + "organization_id": { + "type": "integer", + "title": "Organization Id" }, - "tenant_metadata": { - "$ref": "#/components/schemas/FeedItemTenantMetadata" + "organization_name": { + "type": "string", + "title": "Organization Name" }, - "highlights": { - "additionalProperties": { - "items": { - "type": "string" - }, - "type": "array" - }, - "type": "object", - "title": "Highlights" + "message": { + "type": "string", + "title": "Message" + }, + "variant": { + "$ref": "#/components/schemas/BannerVariant" } }, "type": "object", "required": [ - "metadata" + "organization_id", + "organization_name", + "message", + "variant" ], - "title": "GlobalFeedItem" + "title": "OrganizationBanner" }, - "GlobalSearchRequestBody": { + "OrganizationEventStatsResponse": { "properties": { - "query": { - "oneOf": [ - { - "$ref": "#/components/schemas/GithubRepositoryQuery" - }, + "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": [ { - "$ref": "#/components/schemas/UsernameQuery" + "type": "string" }, { - "$ref": "#/components/schemas/DomainQuery" - }, + "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": [ { - "$ref": "#/components/schemas/BrandQuery" + "type": "string" }, { - "$ref": "#/components/schemas/NameQuery" - }, + "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": [ { - "$ref": "#/components/schemas/KeywordQuery" + "type": "integer" }, { - "$ref": "#/components/schemas/QueryStringQuery" - }, + "type": "null" + } + ], + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PagedCookieConfigurations" + }, + "PaginatedResult_int_str_": { + "properties": { + "item": { + "type": "integer", + "title": "Item" + }, + "next": { + "anyOf": [ { - "$ref": "#/components/schemas/BinQuery" + "type": "string" }, { - "$ref": "#/components/schemas/IpQuery" - }, + "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": [ { - "$ref": "#/components/schemas/EmailQuery" + "type": "string" }, { - "$ref": "#/components/schemas/SecretQuery" - }, + "type": "null" + } + ], + "title": "Next" + }, + "total_count": { + "anyOf": [ { - "$ref": "#/components/schemas/CredentialsQuery" + "type": "integer" }, { - "$ref": "#/components/schemas/AzureTenantQuery" + "type": "null" } ], - "title": "Query", - "examples": [ + "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": [ { - "fqdn": "test.com", - "type": "domain" + "type": "string" + }, + { + "type": "null" } ], - "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" + "title": "Next" }, - "from": { + "total_count": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "From" - }, - "size": { - "type": "integer", - "maximum": 10.0, - "exclusiveMinimum": 0.0, - "title": "Size", - "default": 10 + "title": "Total Count" } }, "type": "object", "required": [ - "query" + "items", + "next" ], - "title": "GlobalSearchRequestBody" + "title": "PaginatedResultsWithTotalCount[DomainBrowserItemResponse, str]" }, - "HTTPValidationError": { + "PaginatedResultsWithTotalCount_IdentityBrowserItemResponse_str_": { "properties": { - "detail": { + "items": { "items": { - "$ref": "#/components/schemas/ValidationError" + "$ref": "#/components/schemas/IdentityBrowserItemResponse" }, "type": "array", - "title": "Detail" + "title": "Items" + }, + "next": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Next" + }, + "total_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Total Count" } }, "type": "object", - "title": "HTTPValidationError" - }, - "HubspotLifecycleStage": { - "type": "string", - "enum": [ - "1281177943" + "required": [ + "items", + "next" ], - "title": "HubspotLifecycleStage" + "title": "PaginatedResultsWithTotalCount[IdentityBrowserItemResponse, str]" }, - "HubspotWebhookFlareSyncEvent": { + "PaginatedResultsWithTotalCount_VipProtectionListItem_str_": { "properties": { - "hubspot_id": { - "type": "integer", - "title": "Hubspot Id" + "items": { + "items": { + "$ref": "#/components/schemas/VipProtectionListItem" + }, + "type": "array", + "title": "Items" }, - "domain": { + "next": { "anyOf": [ { "type": "string" @@ -6134,710 +25220,794 @@ "type": "null" } ], - "title": "Domain" + "title": "Next" }, - "name": { + "total_count": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Name" + "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" }, - "organization_id": { + "next": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Organization Id" + "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" }, - "lifecycle_stage": { + "next": { "anyOf": [ { - "$ref": "#/components/schemas/HubspotLifecycleStage" + "type": "string" }, { "type": "null" } - ] - }, - "merged_object_ids": { + ], + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[Alert, str]" + }, + "PaginatedResults_CTIEntityRelationshipResponse_str_": { + "properties": { + "items": { "items": { - "type": "integer" + "$ref": "#/components/schemas/CTIEntityRelationshipResponse" }, "type": "array", - "title": "Merged Object Ids", - "default": [] + "title": "Items" + }, + "next": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Next" } }, "type": "object", "required": [ - "hubspot_id" + "items", + "next" ], - "title": "HubspotWebhookFlareSyncEvent" + "title": "PaginatedResults[CTIEntityRelationshipResponse, str]" }, - "HubspotWebhookFlareSyncTenantEvent": { + "PaginatedResults_CredentialValidationReponse_str_": { "properties": { - "hubspot_company_id": { - "type": "integer", - "title": "Hubspot Company Id" - }, - "hubspot_tenant_id": { - "type": "integer", - "title": "Hubspot Tenant Id" - }, - "merged_object_ids": { + "items": { "items": { - "type": "integer" + "$ref": "#/components/schemas/CredentialValidationReponse" }, "type": "array", - "title": "Merged Object Ids", - "default": [] - }, - "flare_tenant_name": { - "type": "string", - "title": "Flare Tenant Name" + "title": "Items" }, - "organization_id": { + "next": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Organization Id" + "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" }, - "tenant_id": { + "next": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Tenant Id" + "title": "Next" } }, "type": "object", "required": [ - "hubspot_company_id", - "hubspot_tenant_id", - "flare_tenant_name" + "items", + "next" ], - "title": "HubspotWebhookFlareSyncTenantEvent" + "title": "PaginatedResults[Credential, str]" }, - "IPData": { + "PaginatedResults_FeedItem_str_": { "properties": { - "type": { - "type": "string", - "const": "ip", - "title": "Type", - "default": "ip" + "items": { + "items": { + "$ref": "#/components/schemas/FeedItem" + }, + "type": "array", + "title": "Items" }, - "ip": { - "type": "string", - "minLength": 1, - "title": "Ip" + "next": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Next" } }, "type": "object", "required": [ - "ip" + "items", + "next" ], - "title": "IPData" + "title": "PaginatedResults[FeedItem, str]" }, - "Identifier": { + "PaginatedResults_GlobalFeedItem_str_": { "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" + "items": { + "items": { + "$ref": "#/components/schemas/GlobalFeedItem" + }, + "type": "array", + "title": "Items" }, - "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" - }, - { - "$ref": "#/components/schemas/AddressData" - }, - { - "$ref": "#/components/schemas/BirthYearData" - }, - { - "$ref": "#/components/schemas/RoleData" - }, + "next": { + "anyOf": [ { - "$ref": "#/components/schemas/PhoneNumberData" + "type": "string" }, { - "$ref": "#/components/schemas/ExternalIdData" + "type": "null" } ], - "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" - } - } + "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" }, - "collection": { + "next": { "anyOf": [ { - "$ref": "#/components/schemas/IdentifierCollectionGroupId" + "type": "string" }, { - "$ref": "#/components/schemas/IdentifierCollectionGroupType" + "type": "null" } ], - "title": "Collection" - }, - "urn": { - "type": "string", - "title": "Urn" + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[IdentifierRelation, str]" + }, + "PaginatedResults_Identifier_str_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/Identifier" + }, + "type": "array", + "title": "Items" }, - "entity": { + "next": { "anyOf": [ { - "$ref": "#/components/schemas/IdentityIdentifierEntity" + "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" }, - "enrichments": { + "next": { "anyOf": [ { - "items": { - "$ref": "#/components/schemas/DomainAssetEnrichment" - }, - "type": "array" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Enrichments" - }, - "metadata": { - "$ref": "#/components/schemas/IdentifierMetadata" - }, - "state": { - "$ref": "#/components/schemas/IdentifierState" + "title": "Next" } }, "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" + "items", + "next" ], - "title": "IdentifierAuthorizationStatus" + "title": "PaginatedResults[InviteLinkResponse, datetime]" }, - "IdentifierCollectionGroupId": { + "PaginatedResults_MatchingPolicyPayload_str_": { "properties": { - "type": { - "type": "string", - "const": "group_id", - "title": "Type" + "items": { + "items": { + "$ref": "#/components/schemas/MatchingPolicyPayload" + }, + "type": "array", + "title": "Items" }, - "group_id": { + "next": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Group Id" + "title": "Next" } }, "type": "object", "required": [ - "type", - "group_id" + "items", + "next" ], - "title": "IdentifierCollectionGroupId" + "title": "PaginatedResults[MatchingPolicyPayload, str]" }, - "IdentifierCollectionGroupType": { + "PaginatedResults_PartialAlertChannel_str_": { "properties": { - "type": { - "type": "string", - "const": "group_type", - "title": "Type" + "items": { + "items": { + "$ref": "#/components/schemas/PartialAlertChannel" + }, + "type": "array", + "title": "Items" }, - "group_type": { - "$ref": "#/components/schemas/IdentifierGroupType" + "next": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Next" } }, "type": "object", "required": [ - "type", - "group_type" + "items", + "next" ], - "title": "IdentifierCollectionGroupType" + "title": "PaginatedResults[PartialAlertChannel, str]" }, - "IdentifierEnrichments": { + "PaginatedResults_PolicyAssignedIdentifierPayload_str_": { "properties": { - "domain_reachable_at": { + "items": { + "items": { + "$ref": "#/components/schemas/PolicyAssignedIdentifierPayload" + }, + "type": "array", + "title": "Items" + }, + "next": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Domain Reachable At" + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[PolicyAssignedIdentifierPayload, str]" + }, + "PaginatedResults_PortfolioItemResponse_str_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/PortfolioItemResponse" + }, + "type": "array", + "title": "Items" }, - "domain_resolves_at": { + "next": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Domain Resolves At" - }, - "usage_count": { - "type": "integer", - "title": "Usage Count" + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[PortfolioItemResponse, str]" + }, + "PaginatedResults_PublicIdentifierResponse_str_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/PublicIdentifierResponse" + }, + "type": "array", + "title": "Items" }, - "event_count": { + "next": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Event Count" + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[PublicIdentifierResponse, str]" + }, + "PaginatedResults_PydanticThreatFlowReport_str_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/PublicReport" + }, + "type": "array", + "title": "Items" }, - "authorization_status": { + "next": { "anyOf": [ { - "$ref": "#/components/schemas/IdentifierAuthorizationStatus" + "type": "string" }, { "type": "null" } ], - "examples": [ - "authorized", - "pending", - "rejected" - ] + "title": "Next" } }, "type": "object", "required": [ - "domain_reachable_at", - "domain_resolves_at", - "usage_count", - "event_count", - "authorization_status" - ], - "title": "IdentifierEnrichments" - }, - "IdentifierEntityType": { - "type": "string", - "enum": [ - "identity" + "items", + "next" ], - "title": "IdentifierEntityType" + "title": "PaginatedResults[PublicReport, str]" }, - "IdentifierFeed": { + "PaginatedResults_PydanticThreatFlowReport_str_": { "properties": { - "id": { - "type": "integer", - "title": "Id" + "items": { + "items": { + "$ref": "#/components/schemas/PydanticThreatFlowReport" + }, + "type": "array", + "title": "Items" }, - "owner_id": { - "type": "integer", - "title": "Owner Id" + "next": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Next" } }, "type": "object", "required": [ - "id", - "owner_id" + "items", + "next" ], - "title": "IdentifierFeed" + "title": "PaginatedResults[PydanticThreatFlowReport, str]" }, - "IdentifierFeedRateLimit": { + "PaginatedResults_Recommendation_str_": { "properties": { - "activity_type": { - "type": "string", - "title": "Activity Type" - }, - "first_rate_limited_at": { - "type": "string", - "format": "date-time", - "title": "First Rate Limited At" + "items": { + "items": { + "$ref": "#/components/schemas/Recommendation" + }, + "type": "array", + "title": "Items" }, - "last_rate_limited_at": { - "type": "string", - "format": "date-time", - "title": "Last Rate Limited At" + "next": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Next" } }, "type": "object", "required": [ - "activity_type", - "first_rate_limited_at", - "last_rate_limited_at" + "items", + "next" ], - "title": "IdentifierFeedRateLimit" + "title": "PaginatedResults[ReportData, str]" }, - "IdentifierFeedRateLimits": { + "PaginatedResults_ReportGroupData_str_": { "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" + "$ref": "#/components/schemas/ReportGroupData" }, "type": "array", "title": "Items" + }, + "next": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Next" } }, "type": "object", "required": [ - "first_rate_limited_at", - "last_rate_limited_at", - "activity_types", - "items" - ], - "title": "IdentifierFeedRateLimits" - }, - "IdentifierGroupType": { - "type": "string", - "enum": [ - "person", - "corporate_identities" + "items", + "next" ], - "title": "IdentifierGroupType" + "title": "PaginatedResults[ReportGroupData, str]" }, - "IdentifierMatchingPolicyBody": { + "PaginatedResults_ReportSectionPayload_str_": { "properties": { - "matching_policy_uuid": { - "type": "string", - "format": "uuid", - "title": "Matching Policy Uuid" + "items": { + "items": { + "$ref": "#/components/schemas/ReportSectionPayload" + }, + "type": "array", + "title": "Items" }, - "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 + "next": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Next" } }, "type": "object", "required": [ - "matching_policy_uuid" + "items", + "next" ], - "title": "IdentifierMatchingPolicyBody" + "title": "PaginatedResults[ReportSectionPayload, str]" }, - "IdentifierMetadata": { + "PaginatedResults_Report_str_": { "properties": { - "critical": { - "type": "boolean", - "title": "Critical" + "items": { + "items": { + "$ref": "#/components/schemas/Report" + }, + "type": "array", + "title": "Items" }, - "is_disabled": { - "type": "boolean", - "title": "Is Disabled" + "next": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Next" } }, "type": "object", "required": [ - "critical", - "is_disabled" - ], - "title": "IdentifierMetadata" - }, - "IdentifierOrderBy": { - "type": "string", - "enum": [ - "id", - "name", - "type" + "items", + "next" ], - "title": "IdentifierOrderBy" + "title": "PaginatedResults[Report, str]" }, - "IdentifierRecommendationAction": { + "PaginatedResults_SandboxSampleSubmission_str_": { "properties": { - "type": { - "$ref": "#/components/schemas/IdentifierRecommendationActionType" + "items": { + "items": { + "$ref": "#/components/schemas/SandboxSampleSubmission" + }, + "type": "array", + "title": "Items" + }, + "next": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Next" } }, "type": "object", "required": [ - "type" + "items", + "next" ], - "title": "IdentifierRecommendationAction" + "title": "PaginatedResults[SandboxSampleSubmission, str]" }, - "IdentifierRecommendationActionTarget": { + "PaginatedResults_SecretItem_str_": { "properties": { - "id": { - "type": "integer", - "title": "Id" + "items": { + "items": { + "$ref": "#/components/schemas/SecretItem" + }, + "type": "array", + "title": "Items" + }, + "next": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Next" } }, "type": "object", "required": [ - "id" - ], - "title": "IdentifierRecommendationActionTarget" - }, - "IdentifierRecommendationActionType": { - "type": "string", - "enum": [ - "accept", - "reject" + "items", + "next" ], - "title": "IdentifierRecommendationActionType" + "title": "PaginatedResults[SecretItem, str]" }, - "IdentifierRecommendationActionsBody": { + "PaginatedResults_SourceWithTenantCount_str_": { "properties": { - "targets": { + "items": { "items": { - "$ref": "#/components/schemas/IdentifierRecommendationActionTarget" + "$ref": "#/components/schemas/SourceWithTenantCount" }, "type": "array", - "maxItems": 100, - "title": "Targets" + "title": "Items" }, - "action": { - "$ref": "#/components/schemas/IdentifierRecommendationAction" + "next": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Next" } }, "type": "object", "required": [ - "action" - ], - "title": "IdentifierRecommendationActionsBody" - }, - "IdentifierRecommendationState": { - "type": "string", - "enum": [ - "recommended", - "accepted", - "rejected" + "items", + "next" ], - "title": "IdentifierRecommendationState" + "title": "PaginatedResults[SourceWithTenantCount, str]" }, - "IdentifierRequestBody": { + "PaginatedResults_StealerLogCookie_str_": { "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" - }, + "items": { + "items": { + "$ref": "#/components/schemas/StealerLogCookie" + }, + "type": "array", + "title": "Items" + }, + "next": { + "anyOf": [ { - "$ref": "#/components/schemas/CredentialsData" + "type": "string" }, { - "$ref": "#/components/schemas/EmailData" - }, + "type": "null" + } + ], + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[StealerLogCookie, str]" + }, + "PaginatedResults_StealerLogCredential_str_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/StealerLogCredential" + }, + "type": "array", + "title": "Items" + }, + "next": { + "anyOf": [ { - "$ref": "#/components/schemas/UsernameData" + "type": "string" }, { - "$ref": "#/components/schemas/SecretData" - }, + "type": "null" + } + ], + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[StealerLogCredential, str]" + }, + "PaginatedResults_TenantFlareCommunityUser_int_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/TenantFlareCommunityUser" + }, + "type": "array", + "title": "Items" + }, + "next": { + "anyOf": [ { - "$ref": "#/components/schemas/NameData" + "type": "integer" }, { - "$ref": "#/components/schemas/IdentityDataRequestBody" + "type": "null" } ], - "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" - } - } + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[TenantFlareCommunityUser, int]" + }, + "PaginatedResults_TenantIntegrationItem_str_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/TenantIntegrationItem" + }, + "type": "array", + "title": "Items" }, - "name": { + "next": { "anyOf": [ { "type": "string" @@ -6846,702 +26016,870 @@ "type": "null" } ], - "title": "Name" - }, - "feed_config": { - "$ref": "#/components/schemas/FeedConfiguration" + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[TenantIntegrationItem, str]" + }, + "PaginatedResults_ThreatFlowReportResponse_str_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/ThreatFlowReportResponse" + }, + "type": "array", + "title": "Items" }, - "collection": { + "next": { "anyOf": [ { - "$ref": "#/components/schemas/IdentifierCollectionGroupId" + "type": "string" }, { - "$ref": "#/components/schemas/IdentifierCollectionGroupType" + "type": "null" } ], - "title": "Collection" - }, - "metadata": { - "$ref": "#/components/schemas/IdentifierMetadata" + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[ThreatFlowReportResponse, str]" + }, + "PaginatedResults_Union_EnrichedCredential__EnrichedCookie__str_": { + "properties": { + "items": { + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/EnrichedCredential" + }, + { + "$ref": "#/components/schemas/EnrichedCookie" + } + ] + }, + "type": "array", + "title": "Items" }, - "matching_policies": { + "next": { "anyOf": [ { - "items": { - "$ref": "#/components/schemas/IdentifierMatchingPolicyBody" - }, - "type": "array" + "type": "string" }, { "type": "null" } ], - "title": "Matching Policies" + "title": "Next" } }, "type": "object", "required": [ - "data", - "name", - "feed_config", - "collection", - "metadata" + "items", + "next" ], - "title": "IdentifierRequestBody" + "title": "PaginatedResults[Union[EnrichedCredential, EnrichedCookie], str]" }, - "IdentifierResponse": { + "PaginatedSources": { "properties": { - "identifier": { + "items": { + "items": { + "$ref": "#/components/schemas/Source" + }, + "type": "array", + "title": "Items" + }, + "next": { "anyOf": [ { - "$ref": "#/components/schemas/Identifier" + "type": "integer" }, { "type": "null" } - ] - }, - "is_materialized": { - "type": "boolean", - "title": "Is Materialized", - "default": false + ], + "title": "Next" }, - "created_at": { + "total_count": { + "type": "integer", + "title": "Total Count" + } + }, + "type": "object", + "required": [ + "items", + "next", + "total_count" + ], + "title": "PaginatedSources" + }, + "ParentContext": { + "properties": { + "parent_uid": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Created At" + "title": "Parent Uid" }, - "last_updated_at": { + "parent_type": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Last Updated At" + "title": "Parent Type" } }, "type": "object", - "title": "IdentifierResponse" + "title": "ParentContext" }, - "IdentifierScope": { + "PartialAlertChannel": { "properties": { + "id": { + "type": "integer", + "title": "Id" + }, "name": { "type": "string", "title": "Name" }, - "is_disabled": { - "type": "boolean", - "title": "Is Disabled", - "default": false + "type": { + "$ref": "#/components/schemas/AlertType" + }, + "state": { + "$ref": "#/components/schemas/AlertChannelState" + }, + "alert_count": { + "type": "integer", + "title": "Alert Count" + } + }, + "type": "object", + "required": [ + "id", + "name", + "type", + "state", + "alert_count" + ], + "title": "PartialAlertChannel" + }, + "PasswordPolicy": { + "type": "string", + "enum": [ + "min_eight_chars", + "special_symbols", + "uppercase", + "lowercase", + "number" + ], + "title": "PasswordPolicy" + }, + "PasswordPolicyOperator": { + "type": "string", + "enum": [ + "include", + "exclude" + ], + "title": "PasswordPolicyOperator" + }, + "PasteEvent": { + "properties": { + "event_type": { + "type": "string", + "const": "paste", + "title": "Event Type", + "default": "paste" + }, + "data": { + "$ref": "#/components/schemas/PasteEventData" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" } }, "type": "object", "required": [ - "name" - ], - "title": "IdentifierScope" - }, - "IdentifierSource": { - "type": "string", - "enum": [ - "USER", - "SYSTEM_RELATION", - "SELF_ONBOARDING", - "ATTRIBUTE", - "AUTO_MONITOR", - "IDP_SYNC" + "data", + "metadata" ], - "title": "IdentifierSource" + "title": "Paste" }, - "IdentifierState": { + "PasteEventData": { "properties": { - "source": { - "$ref": "#/components/schemas/IdentifierSource" - }, - "data_updated_at": { - "type": "string", - "format": "date-time", - "title": "Data Updated At" - }, - "event_count": { + "url": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Event Count" - }, - "usage_count": { - "type": "integer", - "title": "Usage Count" + "title": "Url" }, - "rate_limits": { + "title": { "anyOf": [ { - "$ref": "#/components/schemas/IdentifierFeedRateLimits" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Title" }, - "validation_status": { + "content": { "anyOf": [ { - "$ref": "#/components/schemas/IdentifierValidationStatus" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Content" }, - "authorization_request_status": { + "actor": { "anyOf": [ { - "$ref": "#/components/schemas/IdentifierAuthorizationRequestStatus" + "$ref": "#/components/schemas/pyro__findings__paste__datamodels__PasteEventData__Actor" }, { "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", - "external_id", - "address_data", - "birth_year", - "role", - "phone_number" - ], - "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" - }, - { - "$ref": "#/components/schemas/ExternalIdData" - }, - { - "$ref": "#/components/schemas/AddressData" - }, - { - "$ref": "#/components/schemas/BirthYearData" - }, + "expires_at": { + "anyOf": [ { - "$ref": "#/components/schemas/RoleData" + "type": "string", + "format": "date-time" }, { - "$ref": "#/components/schemas/PhoneNumberData" + "type": "null" } ], - "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": [ - "asset_uuid", - "data" - ], - "title": "IdentityAttribute" - }, - "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" - }, - { - "$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": [ - "type", - "attributes" - ], - "title": "IdentityDataRequestBody" - }, - "IdentityIdentifierEntity": { - "properties": { - "type": { - "$ref": "#/components/schemas/IdentifierEntityType" + "title": "Expires At" }, - "attributes": { - "items": { - "$ref": "#/components/schemas/IdentityAttribute" - }, - "type": "array", - "title": "Attributes" + "syntax": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Syntax" } }, "type": "object", - "required": [ - "type", - "attributes" - ], - "title": "IdentityIdentifierEntity" - }, - "IncludeOptions": { - "type": "string", - "enum": [ - "known_password_id", - "auth_domains", - "urls" - ], - "title": "IncludeOptions" - }, - "IntelType": { - "type": "string", - "enum": [ - "unit_summary_based", - "custom_intel" - ], - "title": "IntelType" + "title": "PasteEventData" }, - "InvalidCredentialEvent": { + "PiiCollection_StealerLogFindingCookie_": { "properties": { - "event_type": { + "type": { "type": "string", - "const": "invalid_credential", - "title": "Event Type", - "default": "invalid_credential" - }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" + "const": "phone_number", + "title": "Type", + "default": "phone_number" }, - "data": { - "$ref": "#/components/schemas/CredentialEventData" + "phone_number": { + "type": "string", + "minLength": 7, + "title": "Phone Number" } }, "type": "object", "required": [ - "metadata", - "data" + "phone_number" ], - "title": "Invalid Credential" + "title": "PhoneNumberData" }, - "IpQuery": { + "PiiExposureItem": { "properties": { + "created_at": { + "type": "string", + "format": "date-time", + "title": "Created At" + }, + "affected_identity": { + "type": "string", + "title": "Affected Identity" + }, + "website": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Website" + }, "type": { "type": "string", - "const": "ip", "title": "Type" }, - "ip": { + "pii_category": { "type": "string", - "title": "Ip" + "title": "Pii Category" } }, "type": "object", "required": [ + "created_at", + "affected_identity", + "website", "type", - "ip" + "pii_category" ], - "title": "IpQuery" + "title": "PiiExposureItem" }, - "KeywordData": { + "PolicyAssignedIdentifierPayload": { "properties": { - "type": { + "identifier_id": { + "type": "integer", + "title": "Identifier Id", + "description": "The ID of the identifier this policy is assigned to" + }, + "identifier_name": { "type": "string", - "const": "keyword", - "title": "Type", - "default": "keyword" + "title": "Identifier Name", + "description": "The name of the identifier this policy is assigned to" }, - "keyword": { + "clean_past_events": { + "type": "boolean", + "title": "Clean Past Events", + "description": "Whether this policy has been applied to historical events" + }, + "assigned_at": { "type": "string", - "minLength": 1, - "title": "Keyword" + "format": "date-time", + "title": "Assigned At", + "description": "The date and time this policy was assigned to the identifier" } }, "type": "object", "required": [ - "keyword" + "identifier_id", + "identifier_name", + "clean_past_events", + "assigned_at" ], - "title": "KeywordData" + "title": "PolicyAssignedIdentifierPayload" }, - "KeywordQuery": { + "PolicyAssignmentsBody": { "properties": { - "type": { - "type": "string", - "const": "keyword", - "title": "Type" + "identifier_ids": { + "items": { + "type": "integer" + }, + "type": "array", + "title": "Identifier Ids", + "description": "The IDs of the identifiers to assign the policy to" }, - "keyword": { - "type": "string", - "title": "Keyword" + "clean_past_events": { + "type": "boolean", + "title": "Clean Past Events", + "description": "Whether this policy will be applied to historical events", + "default": false } }, "type": "object", "required": [ - "type", - "keyword" + "identifier_ids" ], - "title": "KeywordQuery" + "title": "PolicyAssignmentsBody" }, - "KeywordsValue": { + "PolicyValue": { + "anyOf": [ + { + "$ref": "#/components/schemas/KeywordsValue" + }, + { + "$ref": "#/components/schemas/LuceneValue" + }, + { + "$ref": "#/components/schemas/AstpCookiesValue" + }, + { + "$ref": "#/components/schemas/AstpDomainValue" + } + ] + }, + "PresetRestrictedTerm": { "properties": { - "keywords": { + "type": { + "type": "string", + "const": "preset", + "title": "Type" + }, + "id": { + "type": "string", + "title": "Id" + }, + "display_name": { + "type": "string", + "title": "Display Name" + }, + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Description" + }, + "terms": { "items": { - "type": "string" + "$ref": "#/components/schemas/PresetRestrictedTermItem" }, "type": "array", - "title": "Keywords" + "title": "Terms" } }, "type": "object", "required": [ - "keywords" - ], - "title": "KeywordsValue" - }, - "Language": { - "type": "string", - "enum": [ - "en", - "fr" + "type", + "id", + "display_name", + "terms" ], - "title": "Language" + "title": "PresetRestrictedTerm" }, - "LeakedCredentialEvent": { + "PresetRestrictedTermItem": { "properties": { - "event_type": { + "type": { "type": "string", - "const": "leaked_credential", - "title": "Event Type", - "default": "leaked_credential" - }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" + "enum": [ + "keyword", + "domain" + ], + "title": "Type" }, - "data": { - "$ref": "#/components/schemas/LeakedCredentialEventData" + "term": { + "type": "string", + "title": "Term" } }, "type": "object", "required": [ - "metadata", - "data" + "type", + "term" ], - "title": "Leaked Credential" + "title": "PresetRestrictedTermItem" }, - "LeakedCredentialEventData": { + "PreviewAlerts": { "properties": { - "identity_name": { - "type": "string", - "title": "Identity Name", - "description": "The email or username associated with the leaked credential." - }, - "imported_at": { - "type": "string", - "format": "date-time", - "title": "Imported At", - "description": "When the credential was imported into Flare." - }, - "password": { - "type": "string", - "title": "Password", - "description": "The leaked password, or its hash if not available in cleartext." + "alert_channel_id": { + "type": "integer", + "title": "Alert Channel Id" }, - "source": { - "$ref": "#/components/schemas/LeakedCredentialEventSource", - "description": "The source the credential was leaked from." + "event_uids": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Event Uids" } }, "type": "object", "required": [ - "identity_name", - "imported_at", - "password", - "source" + "alert_channel_id", + "event_uids" ], - "title": "LeakedCredentialEventData" + "title": "PreviewAlerts" }, - "LeakedCredentialEventSource": { + "ProvisionUserItemRequest": { "properties": { - "id": { + "email": { "type": "string", - "title": "Id", - "description": "The identifier of the leak source category." + "title": "Email" + }, + "idp_user_uuid": { + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], + "title": "Idp User Uuid" }, - "name": { - "type": "string", - "title": "Name", - "description": "The name of the leak source category." + "full_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Full Name" } }, "type": "object", "required": [ - "id", - "name" + "email" ], - "title": "LeakedCredentialEventSource" + "title": "ProvisionUserItemRequest" }, - "LeakedCredentialsBulkActionType": { + "PublicAuditEventAffectedResourceType": { "type": "string", "enum": [ - "remediate", - "unremediate", - "ignore", - "unignore" - ], - "title": "LeakedCredentialsBulkActionType" + "event", + "alert", + "alert_channel", + "authorize_asset_request", + "credential", + "identifier", + "identifier_recommendation", + "integration", + "user", + "organization", + "priority_action", + "sandbox", + "global_search", + "tenant", + "tenant_membership", + "threat_flow" + ] }, - "ListingEvent": { + "PublicIdentifierRequestBody": { "properties": { - "event_type": { - "type": "string", - "const": "listing", - "title": "Event Type", - "default": "listing" - }, "data": { - "$ref": "#/components/schemas/ListingEventData" + "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" + }, + { + "$ref": "#/components/schemas/SecretData" + }, + { + "$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" + } + } }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" + "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": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Group Id" } }, "type": "object", "required": [ "data", - "metadata" + "categories", + "emerging_categories", + "severities" ], - "title": "Listing" + "title": "PublicIdentifierRequestBody" }, - "ListingEventData": { + "PublicIdentifierResponse": { "properties": { - "url": { + "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" + }, + { + "$ref": "#/components/schemas/SecretData" + }, + { + "$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" + } + } + }, + "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": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Url", - "description": "The URL to the listing." + "title": "Group Id" }, - "title": { + "enrichments": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/IdentifierEnrichments" + }, + { + "type": "null" + } + ] + }, + "is_disabled": { + "type": "boolean", + "title": "Is Disabled" + }, + "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" }, { - "type": "null" - } - ], - "title": "Title", - "description": "The title of the listing." - }, - "content": { - "anyOf": [ + "$ref": "#/components/schemas/IPData" + }, { - "type": "string" + "$ref": "#/components/schemas/KeywordData" }, { - "type": "null" - } - ], - "title": "Content", - "description": "The content within the listing." - }, - "currency": { - "anyOf": [ + "$ref": "#/components/schemas/AzureTenantData" + }, { - "type": "string" + "$ref": "#/components/schemas/DomainData" }, { - "type": "null" - } - ], - "title": "Currency", - "description": "The currency expected in the listing." - }, - "escrow": { - "anyOf": [ + "$ref": "#/components/schemas/SearchQueryData" + }, { - "type": "boolean" + "$ref": "#/components/schemas/GithubRepositoryData" }, { - "type": "null" + "$ref": "#/components/schemas/SecretData" + }, + { + "$ref": "#/components/schemas/PublicIdentityData" } ], - "title": "Escrow", - "description": "Whether the listing requires escrow." + "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" + } + } }, - "price": { + "name": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Price", - "description": "The price of the listing." + "title": "Name" }, - "ship_to": { + "categories": { "items": { - "type": "string" + "$ref": "#/components/schemas/SearchType" }, "type": "array", - "title": "Ship To", - "description": "The countries eligible for shipping.", - "default": [] + "title": "Categories" }, - "ship_from": { + "emerging_categories": { "items": { "type": "string" }, "type": "array", - "title": "Ship From", - "description": "The countries eligible for shipping.", - "default": [] + "title": "Emerging Categories" }, - "stock_count": { + "severities": { + "items": { + "$ref": "#/components/schemas/Severity" + }, + "type": "array", + "title": "Severities" + }, + "group_id": { "anyOf": [ { "type": "integer" @@ -7550,83 +26888,205 @@ "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." + "title": "Group Id" }, - "context": { - "$ref": "#/components/schemas/pyro__findings__listing__datamodels__ListingEventData__Context", - "description": "Data offering context to the listing." + "is_disabled": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Is Disabled" } }, "type": "object", - "title": "ListingEventData" + "required": [ + "data", + "categories", + "emerging_categories", + "severities" + ], + "title": "PublicIdentifierUpdateRequestBody" }, - "LookalikeDomainEvent": { + "PublicIdentityData": { "properties": { - "event_type": { + "type": { "type": "string", - "const": "lookalike", - "title": "Event Type", - "default": "lookalike" - }, - "data": { - "$ref": "#/components/schemas/LookalikeDomainEventData" + "const": "identity", + "title": "Type", + "default": "identity" }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" + "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": [ - "data", - "metadata" + "attributes" ], - "title": "Lookalike Domain" + "title": "IdentityData" }, - "LookalikeDomainEventData": { + "PublicReport": { "properties": { - "domain": { + "id": { + "type": "integer", + "title": "Id" + }, + "title": { "type": "string", - "title": "Domain", - "description": "The domain of the lookalike domain." + "title": "Title" }, - "registered_at": { + "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": [ + "id", + "title", + "author", + "tenant_id", + "report_group_id", + "report_type", + "status", + "created_at", + "updated_at", + "is_archived" + ], + "title": "PublicReport" + }, + "PublishReportPayload": { + "properties": { + "title": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Registered At", - "description": "The date and time the lookalike domain was registered." + "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" }, - "identifier_domains": { + "title": { + "type": "string", + "title": "Title" + }, + "subtitle": { "anyOf": [ { - "items": { - "type": "string" - }, - "type": "array" + "type": "string" }, { "type": "null" } ], - "title": "Identifier Domains", - "description": "Domain identifiers matching the lookalike domains" + "title": "Subtitle" }, - "feed": { + "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" @@ -7635,76 +27095,148 @@ "type": "null" } ], - "title": "Feed", - "description": "The feed where the lookalike domain was found" + "title": "Prompt Preset Uid" }, - "cert_data": { + "created_at": { + "type": "string", + "format": "date-time", + "title": "Created At" + }, + "published_at": { "anyOf": [ { - "additionalProperties": true, - "type": "object" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Cert Data", - "description": "The certificate data of the lookalike domain." + "title": "Published At" }, - "subject": { + "updated_at": { + "type": "string", + "format": "date-time", + "title": "Updated At" + }, + "reading_time": { + "type": "integer", + "title": "Reading Time" + }, + "tenant_id": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Subject", - "description": "The subject of the certificate of the lookalike domain." + "title": "Tenant Id" }, - "issuer": { + "organization_id": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Issuer", - "description": "The issuer of the certificate of the lookalike domain." + "title": "Organization Id" } }, "type": "object", "required": [ - "domain", - "registered_at", - "identifier_domains", - "feed", - "cert_data", - "subject", - "issuer" + "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": "LookalikeDomainEventData" + "title": "PydanticThreatFlowReport" }, - "LuceneValue": { + "QueryStringQuery": { "properties": { - "query": { + "type": { "type": "string", - "title": "Query", - "description": "The lucene query of the matching policy" + "const": "query_string", + "title": "Type" + }, + "query_string": { + "type": "string", + "maxLength": 10000, + "title": "Query String" } }, "type": "object", "required": [ - "query" + "type", + "query_string" ], - "title": "LuceneValue" + "title": "QueryStringQuery" }, - "MalwareInformation": { + "RansomLeakData": { "properties": { - "malware_family": { + "type": { + "type": "string", + "const": "ransomleak", + "title": "Type", + "default": "ransomleak" + }, + "source": { + "type": "string", + "minLength": 1, + "title": "Source" + }, + "id": { + "type": "string", + "minLength": 1, + "title": "Id" + } + }, + "type": "object", + "required": [ + "source", + "id" + ], + "title": "RansomLeakData" + }, + "RansomLeakEvent": { + "properties": { + "event_type": { + "type": "string", + "const": "ransomleak", + "title": "Event Type", + "default": "ransomleak" + }, + "data": { + "$ref": "#/components/schemas/RansomLeakEventData" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + } + }, + "type": "object", + "required": [ + "data", + "metadata" + ], + "title": "Ransom Leak" + }, + "RansomLeakEventData": { + "properties": { + "url": { "anyOf": [ { "type": "string" @@ -7713,10 +27245,10 @@ "type": "null" } ], - "title": "Malware Family", - "description": "The malware family used for device infection." + "title": "Url", + "description": "The URL of the ransom leak post." }, - "build_id": { + "response_url": { "anyOf": [ { "type": "string" @@ -7725,10 +27257,10 @@ "type": "null" } ], - "title": "Build Id", - "description": "The build ID of the malware used for device infection." + "title": "Response Url", + "description": "The URL of the response to the ransom leak post." }, - "file_location": { + "title": { "anyOf": [ { "type": "string" @@ -7737,271 +27269,324 @@ "type": "null" } ], - "title": "File Location", - "description": "The file location of the malware used for device infection." + "title": "Title", + "description": "The title of the ransom leak post." }, - "infected_at": { + "content": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Infected At", - "description": "The date and time the malware was used to infect the victim's device." + "title": "Content", + "description": "The content of the ransom leak post." + }, + "body": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Body", + "description": "The body of the ransom leak post." + }, + "victim_information": { + "anyOf": [ + { + "$ref": "#/components/schemas/pyro__findings__ransomleaks__datamodels__VictimInformation" + }, + { + "type": "null" + } + ], + "description": "The information relating to the victim of the ransom leak." } }, "type": "object", "required": [ - "malware_family", - "build_id", - "file_location", - "infected_at" - ], - "title": "MalwareInformation" - }, - "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" + "url", + "response_url", + "title", + "content", + "body", + "victim_information" + ], + "title": "RansomLeakEventData" + }, + "RecentActivityCountResponse": { + "properties": { + "count": { + "type": "integer", + "title": "Count" } }, "type": "object", "required": [ - "matching_policy", - "assigned_at", - "clean_past_events" + "count" ], - "title": "MatchingPolicyAssignmentPayload" + "title": "RecentActivityCountResponse" }, - "MatchingPolicyPayload": { + "RecentActivityExposedPII": { "properties": { - "uuid": { - "type": "string", - "format": "uuid4", - "title": "Uuid", - "description": "The UUID of the matching policy" + "type": { + "$ref": "#/components/schemas/SearchType" }, - "name": { + "uid": { "type": "string", - "title": "Name", - "description": "The name of the matching policy" + "title": "Uid" }, - "policy_type": { - "$ref": "#/components/schemas/MatchingPolicyType", - "description": "The type of the matching policy" + "leaked_date": { + "type": "string", + "format": "date-time", + "title": "Leaked Date" }, - "value": { - "$ref": "#/components/schemas/PolicyValue", - "description": "The value of the matching policy depending on its type" + "attribute": { + "type": "string", + "title": "Attribute" }, - "created_at": { + "information_type": { "type": "string", - "format": "date-time", - "title": "Created At", - "description": "The date and time the matching policy was created" + "title": "Information Type" }, - "last_updated_at": { + "source_name": { "type": "string", - "format": "date-time", - "title": "Last Updated At", - "description": "The date and time the matching policy was last updated" + "title": "Source Name" } }, "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" + "type", + "uid", + "leaked_date", + "attribute", + "information_type", + "source_name" ], - "title": "MatchingPolicyType" + "title": "RecentActivityExposedPII" }, - "MitigatedCredentialEvent": { + "RecentActivityOpenWebIllicitNetwork": { "properties": { - "event_type": { + "type": { + "$ref": "#/components/schemas/SearchType" + }, + "uid": { "type": "string", - "const": "mitigated_credential", - "title": "Event Type", - "default": "mitigated_credential" + "title": "Uid" }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" + "creation_date": { + "type": "string", + "format": "date-time", + "title": "Creation Date" }, - "data": { - "$ref": "#/components/schemas/MitigatedCredentialEventData" + "attribute": { + "type": "string", + "title": "Attribute" + }, + "event_type": { + "type": "string", + "title": "Event Type" + }, + "source_name": { + "type": "string", + "title": "Source Name" } }, "type": "object", "required": [ - "metadata", - "data" + "type", + "uid", + "creation_date", + "attribute", + "event_type", + "source_name" ], - "title": "Mitigated Credential" + "title": "RecentActivityOpenWebIllicitNetwork" }, - "MitigatedCredentialEventData": { + "RecentActivityPassword": { "properties": { - "identity_name": { + "type": { "type": "string", - "title": "Identity Name", - "description": "The email or username associated with the credential." + "title": "Type", + "default": "identity_profile_password" }, - "credential_hash": { + "last_seen": { "type": "string", - "title": "Credential Hash", - "description": "A hash uniquely identifying the credential." + "format": "date-time", + "title": "Last Seen" }, - "tenant_integration_id": { + "attribute": { "type": "string", - "title": "Tenant Integration Id", - "description": "The UUID of the tenant's IdP integration that validated the credential." + "title": "Attribute" }, - "mitigation_action": { + "password": { "type": "string", - "title": "Mitigation Action", - "description": "The action the tenant's IdP integration took to mitigate the credential" + "title": "Password" + }, + "source_count": { + "type": "integer", + "title": "Source Count" + }, + "validation": { + "anyOf": [ + { + "$ref": "#/components/schemas/CredentialValidation" + }, + { + "type": "null" + } + ] } }, "type": "object", "required": [ - "identity_name", - "credential_hash", - "tenant_integration_id", - "mitigation_action" + "last_seen", + "attribute", + "password", + "source_count", + "validation" ], - "title": "MitigatedCredentialEventData" + "title": "RecentActivityPassword" }, - "NameData": { + "RecentActivityResponse": { "properties": { - "type": { - "type": "string", - "const": "name", - "title": "Type", - "default": "name" - }, - "first_name": { - "type": "string", - "title": "First Name" - }, - "last_name": { - "type": "string", - "title": "Last Name" + "items": { + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/RecentActivityStealerLog" + }, + { + "$ref": "#/components/schemas/RecentActivityExposedPII" + }, + { + "$ref": "#/components/schemas/RecentActivityOpenWebIllicitNetwork" + }, + { + "$ref": "#/components/schemas/RecentActivityPassword" + } + ] + }, + "type": "array", + "title": "Items" }, - "is_strict": { - "type": "boolean", - "title": "Is Strict" + "next": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Next" } }, "type": "object", "required": [ - "first_name", - "last_name", - "is_strict" + "items" ], - "title": "NameData" + "title": "RecentActivityResponse" }, - "NameQuery": { + "RecentActivityStealerLog": { "properties": { "type": { + "$ref": "#/components/schemas/SearchType" + }, + "uid": { "type": "string", - "const": "name", - "title": "Type" + "title": "Uid" }, - "first_name": { + "creation_date": { "type": "string", - "title": "First Name" + "format": "date-time", + "title": "Creation Date" }, - "last_name": { + "attribute": { "type": "string", - "title": "Last Name" + "title": "Attribute" }, - "is_strict": { - "type": "boolean", - "title": "Is Strict" + "ip_address": { + "type": "string", + "title": "Ip Address" + }, + "credentials_count": { + "type": "integer", + "title": "Credentials Count" } }, "type": "object", "required": [ "type", - "first_name", - "last_name", - "is_strict" - ], - "title": "NameQuery" - }, - "OrderType": { - "type": "string", - "enum": [ - "asc", - "desc" + "uid", + "creation_date", + "attribute", + "ip_address", + "credentials_count" ], - "title": "OrderType" + "title": "RecentActivityStealerLog" }, - "PaginatedResults_Alert_str_": { + "Recommendation": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/Alert" - }, - "type": "array", - "title": "Items" + "id": { + "type": "integer", + "title": "Id" }, - "next": { - "anyOf": [ + "data": { + "oneOf": [ { - "type": "string" + "$ref": "#/components/schemas/DomainData" }, { - "type": "null" + "$ref": "#/components/schemas/AzureTenantData" + }, + { + "$ref": "#/components/schemas/EmailData" + }, + { + "$ref": "#/components/schemas/UsernameData" } ], - "title": "Next" + "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": [ - "items", - "next" + "id", + "data" ], - "title": "PaginatedResults[Alert, str]" + "title": "Recommendation" }, - "PaginatedResults_Credential_str_": { + "RelatedConversationRequest": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/Credential" - }, - "type": "array", - "title": "Items" + "uid": { + "type": "string", + "title": "Uid" + }, + "direction": { + "$ref": "#/components/schemas/ConversationSearchAfterDirection", + "default": "next" }, - "next": { + "size": { + "type": "integer", + "title": "Size", + "default": 10 + }, + "search_after": { "anyOf": [ { "type": "string" @@ -8010,26 +27595,34 @@ "type": "null" } ], - "title": "Next" + "title": "Search After" + }, + "should_translate": { + "type": "boolean", + "title": "Should Translate", + "default": false } }, "type": "object", "required": [ - "items", - "next" + "uid" ], - "title": "PaginatedResults[Credential, str]" + "title": "RelatedConversationRequest" }, - "PaginatedResults_FeedItem_str_": { + "RelatedConversationResponse": { "properties": { - "items": { + "conversation_messages": { "items": { - "$ref": "#/components/schemas/FeedItem" + "$ref": "#/components/schemas/ConversationMessage" }, "type": "array", - "title": "Items" + "title": "Conversation Messages" }, - "next": { + "conversation_name": { + "type": "string", + "title": "Conversation Name" + }, + "conversation_name_en": { "anyOf": [ { "type": "string" @@ -8038,24 +27631,7 @@ "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" + "title": "Conversation Name En" }, "next": { "anyOf": [ @@ -8067,25 +27643,8 @@ } ], "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" }, - "next": { + "previous": { "anyOf": [ { "type": "string" @@ -8094,54 +27653,55 @@ "type": "null" } ], - "title": "Next" + "title": "Previous" } }, "type": "object", "required": [ - "items", - "next" + "conversation_messages", + "conversation_name" ], - "title": "PaginatedResults[MatchingPolicyPayload, str]" + "title": "RelatedConversationResponse" }, - "PaginatedResults_PartialAlertChannel_str_": { + "ReportDownloadFormat": { + "type": "string", + "enum": [ + "docx", + "pdf", + "csv", + "zip" + ], + "title": "ReportDownloadFormat" + }, + "ReportRequestInfoResponse": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/PartialAlertChannel" - }, - "type": "array", - "title": "Items" + "status": { + "$ref": "#/components/schemas/RequestStatus" }, - "next": { + "report": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/ApiReport" }, { "type": "null" } - ], - "title": "Next" + ] } }, "type": "object", "required": [ - "items", - "next" + "status" ], - "title": "PaginatedResults[PartialAlertChannel, str]" + "title": "ReportRequestInfoResponse" }, - "PaginatedResults_PolicyAssignedIdentifierPayload_str_": { + "ReportRequestPayload": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/PolicyAssignedIdentifierPayload" - }, - "type": "array", - "title": "Items" + "report_title": { + "type": "string", + "title": "Report Title" }, - "next": { + "question": { "anyOf": [ { "type": "string" @@ -8150,138 +27710,279 @@ "type": "null" } ], - "title": "Next" + "title": "Question" + }, + "time_range_type": { + "$ref": "#/components/schemas/TimeRangeType", + "default": "all" + }, + "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" + }, + "included_keywords": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Included Keywords" + }, + "excluded_keywords": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "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" + }, + "SAMLConfigurationData-Input": { + "properties": { + "type": { + "type": "string", + "const": "role", + "title": "Type", + "default": "role" + }, + "role": { + "type": "string", + "minLength": 1, + "title": "Role" } }, "type": "object", "required": [ - "items", - "next" + "is_enabled", + "is_mandatory", + "type", + "configuration", + "mappings" ], - "title": "PaginatedResults[PolicyAssignedIdentifierPayload, str]" + "title": "SAMLSSOConfigurationData" }, - "PaginatedResults_PublicIdentifierResponse_str_": { + "SandboxSampleSubmission": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/PublicIdentifierResponse" - }, - "type": "array", - "title": "Items" + "uuid": { + "type": "string", + "format": "uuid", + "title": "Uuid" }, - "next": { + "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": { + "type": "string", + "title": "Submitted By" + }, + "status": { + "$ref": "#/components/schemas/SandboxSubmissionStatus" + }, + "external_submission_id": { + "type": "integer", + "title": "External Submission Id" + }, + "external_sample_id": { + "type": "integer", + "title": "External Sample Id" + }, + "external_job_id": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[PublicIdentifierResponse, str]" - }, - "PaginatedResults_PublicReport_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/PublicReport" - }, - "type": "array", - "title": "Items" + "title": "External Job Id" }, - "next": { + "size": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "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" + "title": "Size" }, - "next": { + "submitted_at": { + "type": "string", + "format": "date-time", + "title": "Submitted At" + }, + "sample_report_status": { + "$ref": "#/components/schemas/SandboxSubmissionReportStatus" + }, + "dynamic_report_status": { + "$ref": "#/components/schemas/SandboxSubmissionReportStatus" + }, + "verdict": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/SandboxSubmissionVerdict" }, { "type": "null" } - ], - "title": "Next" + ] + }, + "is_archived": { + "type": "boolean", + "title": "Is Archived" } }, "type": "object", "required": [ - "items", - "next" + "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": "PaginatedResults[PydanticThreatFlowReport, str]" + "title": "SandboxSampleSubmission" }, - "PaginatedResults_Recommendation_str_": { + "SandboxSubmissionReportStatus": { + "type": "string", + "enum": [ + "pending", + "ready", + "error" + ], + "title": "SandboxSubmissionReportStatus" + }, + "SandboxSubmissionResponse": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/Recommendation" - }, - "type": "array", - "title": "Items" - }, - "next": { + "job_id": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "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" + "title": "Job Id" }, - "next": { + "job_status": { "anyOf": [ { "type": "string" @@ -8290,58 +27991,63 @@ "type": "null" } ], - "title": "Next" + "title": "Job Status" } }, "type": "object", "required": [ - "items", - "next" + "job_id", + "job_status" ], - "title": "PaginatedResults[StealerLogCookie, str]" + "title": "SandboxSubmissionResponse" }, - "PaginatedResults_StealerLogCredential_str_": { + "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" + }, + "SandboxUploadUrlResponse": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/StealerLogCredential" - }, - "type": "array", - "title": "Items" + "upload_url": { + "type": "string", + "title": "Upload Url" }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" + "upload_fields": { + "additionalProperties": true, + "type": "object", + "title": "Upload Fields" } }, "type": "object", "required": [ - "items", - "next" + "upload_url", + "upload_fields" ], - "title": "PaginatedResults[StealerLogCredential, str]" + "title": "SandboxUploadUrlResponse" }, - "ParentContext": { + "SandboxVNCUrlResponse": { "properties": { - "parent_uid": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Parent Uid" - }, - "parent_type": { + "vnc_url": { "anyOf": [ { "type": "string" @@ -8350,79 +28056,109 @@ "type": "null" } ], - "title": "Parent Type" - } - }, - "type": "object", - "title": "ParentContext" - }, - "PartialAlertChannel": { - "properties": { - "id": { - "type": "integer", - "title": "Id" + "title": "Vnc Url" }, - "name": { + "job_status": { "type": "string", - "title": "Name" - }, - "type": { - "$ref": "#/components/schemas/AlertType" - }, - "state": { - "$ref": "#/components/schemas/AlertChannelState" - }, - "alert_count": { - "type": "integer", - "title": "Alert Count" + "title": "Job Status" } }, "type": "object", "required": [ - "id", - "name", - "type", - "state", - "alert_count" + "vnc_url", + "job_status" ], - "title": "PartialAlertChannel" + "title": "SandboxVNCUrlResponse" }, - "PasteEvent": { + "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" + }, + "ScreenshotInfo": { "properties": { - "event_type": { + "asset_hash": { "type": "string", - "const": "paste", - "title": "Event Type", - "default": "paste" + "title": "Asset Hash" }, - "data": { - "$ref": "#/components/schemas/PasteEventData" - }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" + "hashes": { + "additionalProperties": { + "type": "string" + }, + "propertyNames": { + "$ref": "#/components/schemas/ScreenshotHashType" + }, + "type": "object", + "title": "Hashes" } }, "type": "object", "required": [ - "data", - "metadata" + "asset_hash", + "hashes" ], - "title": "Paste" + "title": "ScreenshotInfo" }, - "PasteEventData": { + "SearchQueryAllowedRequest": { "properties": { - "url": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Url" + "search_query": { + "type": "string", + "title": "Search Query" + }, + "organization_id": { + "type": "integer", + "title": "Organization Id" }, - "title": { + "tenant_id": { + "type": "integer", + "title": "Tenant Id" + }, + "user_id": { + "type": "integer", + "title": "User Id" + }, + "include_restricted_domains": { + "type": "boolean", + "title": "Include Restricted Domains" + }, + "include_noisy_domains": { + "type": "boolean", + "title": "Include Noisy Domains" + }, + "scopes": { + "items": { + "$ref": "#/components/schemas/Scope" + }, + "type": "array", + "title": "Scopes" + }, + "ip": { "anyOf": [ { "type": "string" @@ -8431,9 +28167,9 @@ "type": "null" } ], - "title": "Title" + "title": "Ip" }, - "content": { + "user_agent": { "anyOf": [ { "type": "string" @@ -8442,31 +28178,42 @@ "type": "null" } ], - "title": "Content" - }, - "actor": { - "anyOf": [ - { - "$ref": "#/components/schemas/pyro__findings__paste__datamodels__PasteEventData__Actor" - }, - { - "type": "null" - } - ] + "title": "User Agent" }, - "expires_at": { + "flare_referer": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Expires At" + "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" }, - "syntax": { + "restricted_term": { "anyOf": [ { "type": "string" @@ -8475,153 +28222,249 @@ "type": "null" } ], - "title": "Syntax" + "title": "Restricted Term" } }, "type": "object", - "title": "PasteEventData" + "required": [ + "is_allowed", + "restricted_term" + ], + "title": "SearchQueryAllowedResponse" }, - "PhoneNumberData": { + "SearchQueryData": { "properties": { "type": { "type": "string", - "const": "phone_number", + "const": "search_query", "title": "Type", - "default": "phone_number" + "default": "search_query" }, - "phone_number": { + "search_query": { "type": "string", - "minLength": 7, - "title": "Phone Number" + "minLength": 1, + "title": "Search Query" } }, "type": "object", "required": [ - "phone_number" + "search_query" ], - "title": "PhoneNumberData" + "title": "SearchQueryData" }, - "PolicyAssignedIdentifierPayload": { + "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": { - "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": "secret", + "title": "Type", + "default": "secret" }, - "assigned_at": { + "secret": { "type": "string", - "format": "date-time", - "title": "Assigned At", - "description": "The date and time this policy was assigned to the identifier" + "minLength": 1, + "title": "Secret" } }, "type": "object", "required": [ - "identifier_id", - "identifier_name", - "clean_past_events", - "assigned_at" + "secret" ], - "title": "PolicyAssignedIdentifierPayload" + "title": "SecretData" }, - "PolicyAssignmentsBody": { + "SecretQuery": { "properties": { - "identifier_ids": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Identifier Ids", - "description": "The IDs of the identifiers to assign the policy to" + "type": { + "type": "string", + "const": "secret", + "title": "Type" }, - "clean_past_events": { - "type": "boolean", - "title": "Clean Past Events", - "description": "Whether this policy will be applied to historical events", - "default": false + "secret": { + "type": "string", + "title": "Secret" } }, "type": "object", "required": [ - "identifier_ids" + "type", + "secret" ], - "title": "PolicyAssignmentsBody" + "title": "SecretQuery" }, - "PolicyValue": { - "anyOf": [ - { - "$ref": "#/components/schemas/KeywordsValue" - }, - { - "$ref": "#/components/schemas/LuceneValue" +"ServiceEvent": { + "properties": { + "event_type": { + "type": "string", + "const": "service", + "title": "Event Type", + "default": "service" }, - { - "$ref": "#/components/schemas/AstpCookiesValue" + "data": { + "$ref": "#/components/schemas/ServiceEventData" }, - { - "$ref": "#/components/schemas/AstpDomainValue" + "metadata": { + "$ref": "#/components/schemas/EventMetadata" } - ] + }, + "type": "object", + "required": [ + "data", + "metadata" + ], + "title": "Service" }, - "PublicIdentifierRequestBody": { + "ServiceEventData": { "properties": { - "data": { - "oneOf": [ + "url": { + "anyOf": [ { - "$ref": "#/components/schemas/CCBinData" + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Url", + "description": "The URL to the service. This may be an IP address and port combination." + }, + "asn": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Asn", + "description": "The Autonomous System Number." + }, + "content": { + "anyOf": [ + { + "type": "string" }, { - "$ref": "#/components/schemas/IPData" - }, + "type": "null" + } + ], + "title": "Content", + "description": "The raw content returned by the service." + }, + "service": { + "anyOf": [ { - "$ref": "#/components/schemas/KeywordData" + "type": "string" }, { - "$ref": "#/components/schemas/AzureTenantData" - }, + "type": "null" + } + ], + "title": "Service", + "description": "The protocol of the service e.g. https" + }, + "product": { + "anyOf": [ { - "$ref": "#/components/schemas/DomainData" + "type": "string" }, { - "$ref": "#/components/schemas/SearchQueryData" - }, + "type": "null" + } + ], + "title": "Product", + "description": "The software product that powers the service e.g. Apache httpd" + }, + "port": { + "anyOf": [ { - "$ref": "#/components/schemas/GithubRepositoryData" + "type": "integer" }, { - "$ref": "#/components/schemas/SecretData" + "type": "null" + } + ], + "title": "Port", + "description": "The port the service listens on." + }, + "ip_address": { + "anyOf": [ + { + "type": "string" }, { - "$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": "Ip Address", + "description": "The IP address of the service." }, - "name": { + "organization": { "anyOf": [ { "type": "string" @@ -8630,227 +28473,171 @@ "type": "null" } ], - "title": "Name" - }, - "categories": { - "items": { - "$ref": "#/components/schemas/SearchType" - }, - "type": "array", - "title": "Categories" - }, - "emerging_categories": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Emerging Categories" + "title": "Organization", + "description": "The organization that manages the IP address, often a hosting provider." }, - "severities": { - "items": { - "$ref": "#/components/schemas/Severity" - }, - "type": "array", - "title": "Severities" + "hostname": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Hostname", + "description": "The hostname the service is served under." }, - "group_id": { + "country_code": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Group Id" + "title": "Country Code", + "description": "The country code of the IP address." + }, + "vulnerabilities": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Vulnerabilities", + "description": "CVE identifiers of vulnerabilities the service is potentially affected by." } }, "type": "object", - "required": [ - "data", - "categories", - "emerging_categories", - "severities" + "title": "ServiceEventData" + }, + "Severity": { + "type": "string", + "enum": [ + "info", + "low", + "medium", + "high", + "critical" ], - "title": "PublicIdentifierRequestBody" + "title": "Severity" }, - "PublicIdentifierResponse": { + "SocialMediaEvent": { "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "name": { + "event_type": { "type": "string", - "title": "Name" - }, - "tenant_id": { - "type": "integer", - "title": "Tenant Id" + "const": "social_media_account", + "title": "Event Type", + "default": "social_media_account" }, "data": { - "oneOf": [ - { - "$ref": "#/components/schemas/CCBinData" - }, - { - "$ref": "#/components/schemas/IPData" - }, - { - "$ref": "#/components/schemas/KeywordData" - }, + "$ref": "#/components/schemas/SocialMediaEventData" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + } + }, + "type": "object", + "required": [ + "data", + "metadata" + ], + "title": "Social Media Account" + }, + "SocialMediaEventData": { + "properties": { + "url": { + "anyOf": [ { - "$ref": "#/components/schemas/AzureTenantData" + "type": "string" }, { - "$ref": "#/components/schemas/DomainData" - }, + "type": "null" + } + ], + "title": "Url", + "description": "The URL to the profile page of the social media account." + }, + "site": { + "anyOf": [ { - "$ref": "#/components/schemas/SearchQueryData" + "type": "string" }, { - "$ref": "#/components/schemas/GithubRepositoryData" - }, + "type": "null" + } + ], + "title": "Site", + "description": "The name of the platform where the account was found." + }, + "username": { + "anyOf": [ { - "$ref": "#/components/schemas/SecretData" + "type": "string" }, { - "$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": "Username", + "description": "The username of the account that was found." + } + }, + "type": "object", + "title": "SocialMediaEventData" + }, + "SourceV2": { + "properties": { + "id": { + "type": "string", + "title": "Id" }, - "group_id": { + "name": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Group Id" + "title": "Name" }, - "enrichments": { + "description_en": { "anyOf": [ { - "$ref": "#/components/schemas/IdentifierEnrichments" + "type": "string" }, { "type": "null" } - ] - }, - "is_disabled": { - "type": "boolean", - "title": "Is Disabled" + ], + "title": "Description En" }, - "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" - }, - { - "$ref": "#/components/schemas/IPData" - }, - { - "$ref": "#/components/schemas/KeywordData" - }, - { - "$ref": "#/components/schemas/AzureTenantData" - }, - { - "$ref": "#/components/schemas/DomainData" - }, + "description_fr": { + "anyOf": [ { - "$ref": "#/components/schemas/SearchQueryData" + "type": "string" }, { - "$ref": "#/components/schemas/GithubRepositoryData" - }, + "type": "null" + } + ], + "title": "Description Fr" + }, + "breached_at": { + "anyOf": [ { - "$ref": "#/components/schemas/SecretData" + "type": "string" }, { - "$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": "Breached At" }, - "name": { + "leaked_at": { "anyOf": [ { "type": "string" @@ -8859,164 +28646,200 @@ "type": "null" } ], - "title": "Name" - }, - "categories": { - "items": { - "$ref": "#/components/schemas/SearchType" - }, - "type": "array", - "title": "Categories" + "title": "Leaked At" }, - "emerging_categories": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Emerging Categories" + "is_alert_enabled": { + "type": "boolean", + "title": "Is Alert Enabled" }, - "severities": { - "items": { - "$ref": "#/components/schemas/Severity" - }, - "type": "array", - "title": "Severities" + "pii_tags": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Pii Tags" }, - "group_id": { + "url": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Group Id" + "title": "Url" + } + }, + "type": "object", + "required": [ + "id", + "name", + "description_en", + "description_fr", + "breached_at", + "leaked_at", + "is_alert_enabled", + "pii_tags", + "url" + ], + "title": "SourceV2" + }, + "StealerLogCookie": { + "properties": { + "host_key": { + "type": "string", + "title": "Host Key" }, - "is_disabled": { + "path": { + "type": "string", + "title": "Path" + }, + "expires_utc": { "anyOf": [ { - "type": "boolean" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Is Disabled" + "title": "Expires Utc" + }, + "name": { + "type": "string", + "title": "Name" + }, + "value": { + "type": "string", + "title": "Value" } }, "type": "object", "required": [ - "data", - "categories", - "emerging_categories", - "severities" + "host_key", + "path", + "expires_utc", + "name", + "value" ], - "title": "PublicIdentifierUpdateRequestBody" + "title": "StealerLogCookie" }, - "PublicIdentityData": { + "StealerLogCredential": { "properties": { - "type": { + "url": { "type": "string", - "const": "identity", - "title": "Type", - "default": "identity" + "title": "Url" }, - "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" - } + "username": { + "type": "string", + "title": "Username" + }, + "password": { + "type": "string", + "title": "Password" + }, + "application": { + "type": "string", + "title": "Application" + } + }, + "type": "object", + "required": [ + "url", + "username", + "password", + "application" + ], + "title": "StealerLogCredential" + }, + "StealerLogEventData": { + "properties": { + "victim_information": { + "anyOf": [ + { + "$ref": "#/components/schemas/pyro__findings__stealerlogs__datamodels__VictimInformation" + }, + { + "type": "null" } - }, - "type": "array", - "maxItems": 15, - "minItems": 1, - "title": "Attributes" + ], + "description": "Collection of data that relates to the victim and their infected device." + }, + "malware_information": { + "anyOf": [ + { + "$ref": "#/components/schemas/MalwareInformation" + }, + { + "type": "null" + } + ], + "description": "Collection of data that relates to the malware that was used to infect the victim's device." } }, "type": "object", "required": [ - "attributes" + "victim_information", + "malware_information" ], - "title": "IdentityData" + "title": "StealerLogEventData" }, - "PublicReport": { + "SubdomainStatus": { "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" + "$ref": "#/components/schemas/DomainStatus" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" - }, - "is_archived": { - "type": "boolean", - "title": "Is Archived" } }, "type": "object", "required": [ - "id", - "title", - "author", - "tenant_id", - "report_group_id", - "report_type", "status", - "created_at", - "updated_at", - "is_archived" + "updated_at" ], - "title": "PublicReport" + "title": "SubdomainStatus" }, - "PublishReportPayload": { + "SubdomainTag": { "properties": { - "title": { + "label": { + "type": "string", + "title": "Label" + }, + "keyword": { + "type": "string", + "title": "Keyword" + }, + "span": { + "items": { + "type": "integer" + }, + "type": "array", + "title": "Span" + } + }, + "type": "object", + "required": [ + "label", + "keyword", + "span" + ], + "title": "SubdomainTag" + }, + "TagListPayload": { + "properties": { + "name": { "anyOf": [ { "type": "string" @@ -9025,31 +28848,30 @@ "type": "null" } ], - "title": "Title" + "title": "Name" + }, + "repository_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Repository Name" } }, "type": "object", - "title": "PublishReportPayload" + "title": "Tag" }, - "PydanticThreatFlowReport": { + "TenantMetadataResponse": { "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": { + "uid": { "type": "string", - "title": "Title" + "title": "Uid" }, - "subtitle": { + "notes": { "anyOf": [ { "type": "string" @@ -9058,15 +28880,7 @@ "type": "null" } ], - "title": "Subtitle" - }, - "summary": { - "type": "string", - "title": "Summary" - }, - "content": { - "type": "string", - "title": "Content" + "title": "Notes" }, "tags": { "items": { @@ -9075,21 +28889,7 @@ "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": { + "severity": { "anyOf": [ { "type": "string" @@ -9098,35 +28898,52 @@ "type": "null" } ], - "title": "Prompt Preset Uid" + "title": "Severity" + } + }, + "type": "object", + "required": [ + "uid", + "notes", + "tags", + "severity" + ], + "title": "TenantMetadataResponse" + }, + "TenantPayload": { + "properties": { + "id": { + "type": "integer", + "title": "Id" }, - "created_at": { + "name": { "type": "string", - "format": "date-time", - "title": "Created At" + "title": "Name" }, - "published_at": { + "type": { + "type": "string", + "title": "Type" + }, + "description": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Published At" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "title": "Updated At" + "title": "Description" }, - "reading_time": { + "organization_id": { "type": "integer", - "title": "Reading Time" + "title": "Organization Id" }, - "tenant_id": { + "urn": { + "type": "string", + "title": "Urn" + }, + "number_of_employees": { "anyOf": [ { "type": "integer" @@ -9135,9 +28952,32 @@ "type": "null" } ], - "title": "Tenant Id" + "title": "Number Of Employees" }, - "organization_id": { + "industry": { + "anyOf": [ + { + "type": "string" + }, + { + "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" + }, + "identifier_limit": { "anyOf": [ { "type": "integer" @@ -9146,238 +28986,317 @@ "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" - ], - "title": "PydanticThreatFlowReport" - }, - "QueryStringQuery": { - "properties": { - "type": { - "type": "string", - "const": "query_string", - "title": "Type" + "title": "Identifier Limit" + }, + "permissions": { + "items": { + "$ref": "#/components/schemas/UserPermissions" + }, + "type": "array", + "title": "Permissions" + }, + "prevent_global_search": { + "type": "boolean", + "title": "Prevent Global Search" + }, + "access_end_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Access End At" }, - "query_string": { - "type": "string", - "maxLength": 10000, - "title": "Query String" + "hubspot_tenant_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Hubspot Tenant Id" } }, "type": "object", "required": [ + "id", + "name", "type", - "query_string" - ], - "title": "QueryStringQuery" + "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" }, - "RansomLeakData": { - "properties": { - "type": { - "type": "string", - "const": "ransomleak", - "title": "Type", - "default": "ransomleak" - }, - "source": { - "type": "string", - "minLength": 1, - "title": "Source" - }, - "id": { - "type": "string", - "minLength": 1, - "title": "Id" - } - }, - "type": "object", - "required": [ - "source", - "id" + "TenantRoleType": { + "type": "string", + "enum": [ + "viewer", + "editor", + "admin" ], - "title": "RansomLeakData" + "title": "TenantRoleType" }, - "RansomLeakEvent": { + "TenantUserAccess": { "properties": { - "event_type": { - "type": "string", - "const": "ransomleak", - "title": "Event Type", - "default": "ransomleak" - }, - "data": { - "$ref": "#/components/schemas/RansomLeakEventData" + "tenant_id": { + "type": "integer", + "title": "Tenant Id" }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" + "tenant_role": { + "$ref": "#/components/schemas/TenantRoleType" } }, "type": "object", "required": [ - "data", - "metadata" + "tenant_id", + "tenant_role" ], - "title": "Ransom Leak" + "title": "TenantUserAccess" }, - "RansomLeakEventData": { + "TenantWithEnrichmentsPayload": { "properties": { - "url": { + "tenant": { + "$ref": "#/components/schemas/TenantPayload" + }, + "user_count": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Url", - "description": "The URL of the ransom leak post." + "title": "User Count" }, - "response_url": { + "identifier_count": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Response Url", - "description": "The URL of the response to the ransom leak post." + "title": "Identifier Count" }, - "title": { + "identifier_limit": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Title", - "description": "The title of the ransom leak post." + "title": "Identifier Limit" }, - "content": { + "global_search_calls_limit": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Content", - "description": "The content of the ransom leak post." + "title": "Global Search Calls Limit" }, - "body": { + "global_search_calls_count": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Body", - "description": "The body of the ransom leak post." + "title": "Global Search Calls Count" }, - "victim_information": { + "identifier_rotation_count": { + "type": "integer", + "title": "Identifier Rotation Count" + }, + "identifier_rotation_limit": { "anyOf": [ { - "$ref": "#/components/schemas/pyro__findings__ransomleaks__datamodels__VictimInformation" + "type": "integer" }, { "type": "null" } ], - "description": "The information relating to the victim of the ransom leak." + "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" } }, "type": "object", "required": [ - "url", - "response_url", - "title", - "content", - "body", - "victim_information" - ], - "title": "RansomLeakEventData" + "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" }, - "Recommendation": { + "TestTenantIntegrationPayload": { "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "data": { + "params": { "oneOf": [ { - "$ref": "#/components/schemas/DomainData" - }, - { - "$ref": "#/components/schemas/AzureTenantData" + "$ref": "#/components/schemas/EntraIDInputParams" }, { - "$ref": "#/components/schemas/EmailData" + "$ref": "#/components/schemas/ForetraceInputParams" }, { - "$ref": "#/components/schemas/UsernameData" + "$ref": "#/components/schemas/OktaInputParams" } ], - "title": "Data", + "title": "Params", "discriminator": { - "propertyName": "type", + "propertyName": "params_type", "mapping": { - "azure_tenant": "#/components/schemas/AzureTenantData", - "domain": "#/components/schemas/DomainData", - "email": "#/components/schemas/EmailData", - "username": "#/components/schemas/UsernameData" + "entra_id": "#/components/schemas/EntraIDInputParams", + "flare_community": "#/components/schemas/ForetraceInputParams", + "okta": "#/components/schemas/OktaInputParams" } } } }, "type": "object", "required": [ - "id", - "data" + "params" ], - "title": "Recommendation" + "title": "TestTenantIntegrationPayload" }, - "RelatedConversationRequest": { + "ThreadType": { + "type": "string", + "enum": [ + "chat_channel", + "forum_thread" + ], + "title": "ThreadType" + }, + "ThreatActorEntityAPIResponse": { "properties": { - "uid": { + "uuid": { "type": "string", - "title": "Uid" + "title": "Uuid" }, - "direction": { - "$ref": "#/components/schemas/ConversationSearchAfterDirection", - "default": "next" + "type": { + "$ref": "#/components/schemas/EntityType" }, - "size": { - "type": "integer", - "title": "Size", - "default": 10 + "name": { + "type": "string", + "title": "Name" }, - "search_after": { + "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" @@ -9386,34 +29305,37 @@ "type": "null" } ], - "title": "Search After" + "title": "Description" }, - "should_translate": { - "type": "boolean", - "title": "Should Translate", - "default": false - } - }, - "type": "object", - "required": [ - "uid" - ], - "title": "RelatedConversationRequest" - }, - "RelatedConversationResponse": { - "properties": { - "conversation_messages": { + "threat_actor_types": { "items": { - "$ref": "#/components/schemas/ConversationMessage" + "type": "string" + }, + "type": "array", + "title": "Threat Actor Types" + }, + "aliases": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Aliases" + }, + "roles": { + "items": { + "type": "string" }, "type": "array", - "title": "Conversation Messages" + "title": "Roles" }, - "conversation_name": { - "type": "string", - "title": "Conversation Name" + "goals": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Goals" }, - "conversation_name_en": { + "sophistication": { "anyOf": [ { "type": "string" @@ -9422,9 +29344,9 @@ "type": "null" } ], - "title": "Conversation Name En" + "title": "Sophistication" }, - "next": { + "resource_level": { "anyOf": [ { "type": "string" @@ -9433,9 +29355,9 @@ "type": "null" } ], - "title": "Next" + "title": "Resource Level" }, - "previous": { + "primary_motivation": { "anyOf": [ { "type": "string" @@ -9444,70 +29366,102 @@ "type": "null" } ], - "title": "Previous" + "title": "Primary Motivation" + }, + "secondary_motivation": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Secondary Motivation" + }, + "personal_motivations": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Personal Motivations" + }, + "marking_definitions": { + "items": { + "$ref": "#/components/schemas/MarkingDefinition" + }, + "type": "array", + "title": "Marking Definitions" } }, "type": "object", "required": [ - "conversation_messages", - "conversation_name" - ], - "title": "RelatedConversationResponse" - }, - "ReportDownloadFormat": { - "type": "string", - "enum": [ - "docx", - "pdf", - "csv", - "zip" - ], - "title": "ReportDownloadFormat" + "uuid", + "type", + "name", + "created_by", + "sources", + "created_at", + "updated_at", + "description", + "threat_actor_types", + "aliases", + "roles", + "goals", + "sophistication", + "resource_level", + "primary_motivation", + "secondary_motivation", + "personal_motivations", + "marking_definitions" + ], + "title": "ThreatActorEntityAPIResponse" }, - "ReportRequestInfoResponse": { + "ThreatActorGroupEntityAPIResponse": { "properties": { - "status": { - "$ref": "#/components/schemas/RequestStatus" + "uuid": { + "type": "string", + "title": "Uuid" }, - "report": { + "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": [ { - "$ref": "#/components/schemas/ApiReport" + "type": "string", + "format": "date-time" }, { "type": "null" } - ] - } - }, - "type": "object", - "required": [ - "status" - ], - "title": "ReportRequestInfoResponse" - }, - "ReportRequestPayload": { - "properties": { - "report_title": { - "type": "string", - "title": "Report Title" + ], + "title": "Created At" }, - "question": { + "updated_at": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Question" - }, - "time_range_type": { - "$ref": "#/components/schemas/TimeRangeType", - "default": "all" + "title": "Updated At" }, - "time_range_from": { + "first_seen_at": { "anyOf": [ { "type": "string", @@ -9517,9 +29471,9 @@ "type": "null" } ], - "title": "Time Range From" + "title": "First Seen At" }, - "time_range_to": { + "last_seen_at": { "anyOf": [ { "type": "string", @@ -9529,302 +29483,325 @@ "type": "null" } ], - "title": "Time Range To" + "title": "Last Seen At" }, - "included_keywords": { + "confidence": { "anyOf": [ { - "items": { - "type": "string" - }, - "type": "array" + "type": "integer" }, { "type": "null" } ], - "title": "Included Keywords" + "title": "Confidence" }, - "excluded_keywords": { + "description": { "anyOf": [ { - "items": { - "type": "string" - }, - "type": "array" + "type": "string" }, { "type": "null" } ], - "title": "Excluded Keywords" - } - }, - "type": "object", - "required": [ - "report_title" - ], - "title": "ReportRequestPayload" - }, - "ReportRequestResponse": { - "properties": { - "request_id": { - "type": "string", - "format": "uuid", - "title": "Request Id" + "title": "Description" + }, + "aliases": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Aliases" + }, + "goals": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Goals" + }, + "resource_level": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Resource Level" + }, + "primary_motivation": { + "anyOf": [ + { + "type": "string" + }, + { + "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" } }, "type": "object", "required": [ - "request_id" - ], - "title": "ReportRequestResponse" + "uuid", + "type", + "name", + "created_by", + "sources", + "created_at", + "updated_at", + "description", + "aliases", + "goals", + "resource_level", + "primary_motivation", + "secondary_motivations", + "marking_definitions" + ], + "title": "ThreatActorGroupEntityAPIResponse" }, - "ReportStatus": { + "ThreatFlowReportDownloadFormat": { "type": "string", "enum": [ - "draft", - "processing", - "completed", - "scheduled", - "paused" + "docx", + "pdf" ], - "title": "ReportStatus" + "title": "ThreatFlowReportDownloadFormat" }, - "ReportType-Output": { + "ThreatFlowReportFormatType": { "type": "string", "enum": [ - "v1", - "event_based", - "feed_based" + "simple_summary", + "expanded_summary", + "finished_intel_standard" ], - "title": "ReportType" + "title": "ThreatFlowReportFormatType" }, - "RequestStatus": { + "TimeRangeType": { "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" + "all", + "last_24h", + "last_2d", + "last_7d", + "last_1m", + "last_3m", + "last_6m", + "range" ], - "title": "RoleData" + "title": "TimeRangeType" }, - "SearchQueryData": { + "TimelineBySearchTypeResponse": { "properties": { - "type": { - "type": "string", - "const": "search_query", - "title": "Type", - "default": "search_query" - }, - "search_query": { - "type": "string", - "minLength": 1, - "title": "Search Query" + "items": { + "items": { + "$ref": "#/components/schemas/TimelineSearchTypeWithValues" + }, + "type": "array", + "title": "Items" } }, "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" + "items" ], - "title": "SearchType" + "title": "TimelineBySearchTypeResponse" }, - "SecretData": { + "TimelineDateCount": { "properties": { - "type": { + "date": { "type": "string", - "const": "secret", - "title": "Type", - "default": "secret" + "format": "date-time", + "title": "Date" }, - "secret": { - "type": "string", - "minLength": 1, - "title": "Secret" + "count": { + "type": "integer", + "title": "Count" } }, "type": "object", "required": [ - "secret" + "date", + "count" ], - "title": "SecretData" + "title": "TimelineDateCount" }, - "SecretQuery": { + "TimelineSearchTypeWithValues": { "properties": { - "type": { - "type": "string", - "const": "secret", - "title": "Type" + "search_type": { + "$ref": "#/components/schemas/SearchType" }, - "secret": { - "type": "string", - "title": "Secret" + "values": { + "items": { + "$ref": "#/components/schemas/TimelineDateCount" + }, + "type": "array", + "title": "Values" } }, "type": "object", "required": [ - "type", - "secret" + "search_type", + "values" ], - "title": "SecretQuery" + "title": "TimelineSearchTypeWithValues" }, -"ServiceEvent": { + "Times": { "properties": { - "event_type": { + "field": { "type": "string", - "const": "service", - "title": "Event Type", - "default": "service" + "title": "Field", + "default": "metadata.estimated_created_at" }, - "data": { - "$ref": "#/components/schemas/ServiceEventData" + "gt": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Gt" }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" + "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", - "required": [ - "data", - "metadata" - ], - "title": "Service" + "title": "Times" }, - "ServiceEventData": { + "ToolEntityAPIResponse": { "properties": { - "url": { + "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" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Url", - "description": "The URL to the service. This may be an IP address and port combination." + "title": "Created At" }, - "asn": { + "updated_at": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Asn", - "description": "The Autonomous System Number." + "title": "Updated At" }, - "content": { + "first_seen_at": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Content", - "description": "The raw content returned by the service." + "title": "First Seen At" }, - "service": { + "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" @@ -9833,10 +29810,23 @@ "type": "null" } ], - "title": "Service", - "description": "The protocol of the service e.g. https" + "title": "Description" }, - "product": { + "tool_types": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Tool Types" + }, + "kill_chain_phases": { + "items": { + "$ref": "#/components/schemas/KillChainAPIResponse" + }, + "type": "array", + "title": "Kill Chain Phases" + }, + "tool_version": { "anyOf": [ { "type": "string" @@ -9845,141 +29835,160 @@ "type": "null" } ], - "title": "Product", - "description": "The software product that powers the service e.g. Apache httpd" + "title": "Tool Version" }, - "port": { + "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", + "tool_types", + "kill_chain_phases", + "tool_version", + "marking_definitions" + ], + "title": "ToolEntityAPIResponse" + }, + "TopActorsSummaryOutput": { + "properties": { + "top_actors": { + "type": "string", + "title": "Top Actors", + "description": "Single paragraph summarizing the most active actors in the forum thread." + } + }, + "type": "object", + "required": [ + "top_actors" + ], + "title": "TopActorsSummaryOutput" + }, + "Types": { + "properties": { + "is_guide": { "anyOf": [ { - "type": "integer" + "type": "boolean" }, { "type": "null" } ], - "title": "Port", - "description": "The port the service listens on." + "title": "Is Guide", + "description": "Whether the listing is a guide. Ex: 'How to extort a website'" }, - "ip_address": { + "is_service": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Ip Address", - "description": "The IP address of the service." + "title": "Is Service", + "description": "Whether the listing is offering a service. Ex: 'I will help you extort a website'" }, - "organization": { + "is_software": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Organization", - "description": "The organization that manages the IP address, often a hosting provider." + "title": "Is Software", + "description": "Whether the listing is offering software. Ex: 'I will sell you a software to extort a website'" }, - "hostname": { + "is_hardware": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Hostname", - "description": "The hostname the service is served under." + "title": "Is Hardware", + "description": "Whether the listing is offering hardware. Ex: 'I will sell you a hardware'" }, - "country_code": { + "is_data": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Country Code", - "description": "The country code of the IP address." - }, - "vulnerabilities": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Vulnerabilities", - "description": "CVE identifiers of vulnerabilities the service is potentially affected by." + "title": "Is Data", + "description": "Whether the listing is offering data. Ex: 'I will sell you victim data'" } }, "type": "object", - "title": "ServiceEventData" - }, - "Severity": { - "type": "string", - "enum": [ - "info", - "low", - "medium", - "high", - "critical" - ], - "title": "Severity" + "title": "Types" }, - "SocialMediaEvent": { + "UpdateMatchingPolicyBody": { "properties": { - "event_type": { + "name": { "type": "string", - "const": "social_media_account", - "title": "Event Type", - "default": "social_media_account" - }, - "data": { - "$ref": "#/components/schemas/SocialMediaEventData" + "minLength": 1, + "title": "Name", + "description": "The new name of the matching policy" }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" + "value": { + "$ref": "#/components/schemas/PolicyValue", + "description": "The new value of the matching policy depending on its type" } }, "type": "object", "required": [ - "data", - "metadata" + "name", + "value" ], - "title": "Social Media Account" + "title": "UpdateMatchingPolicyBody" }, - "SocialMediaEventData": { + "UpdateTenantMetadataBody": { "properties": { - "url": { + "tags": { "anyOf": [ { - "type": "string" + "items": { + "type": "string" + }, + "type": "array" }, { "type": "null" } ], - "title": "Url", - "description": "The URL to the profile page of the social media account." + "title": "Tags" }, - "site": { + "severity": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/Severity" }, { "type": "null" } - ], - "title": "Site", - "description": "The name of the platform where the account was found." + ] }, - "username": { + "notes": { "anyOf": [ { "type": "string" @@ -9988,53 +29997,20 @@ "type": "null" } ], - "title": "Username", - "description": "The username of the account that was found." + "title": "Notes" } }, "type": "object", - "title": "SocialMediaEventData" + "title": "UpdateTenantMetadataBody" }, - "SourceV2": { + "UpdateTenantRequestBody": { "properties": { - "id": { - "type": "string", - "title": "Id" - }, "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "type": "string", + "minLength": 1, "title": "Name" }, - "description_en": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Description En" - }, - "description_fr": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Description Fr" - }, - "breached_at": { + "description": { "anyOf": [ { "type": "string" @@ -10043,210 +30019,309 @@ "type": "null" } ], - "title": "Breached At" + "title": "Description" }, - "leaked_at": { + "number_of_employees": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Leaked At" + "title": "Number Of Employees" }, - "is_alert_enabled": { - "type": "boolean", - "title": "Is Alert Enabled" + "industry": { + "$ref": "#/components/schemas/TenantIndustry" }, - "pii_tags": { + "identifier_limit": { "anyOf": [ { - "items": { - "type": "string" - }, - "type": "array" + "type": "integer" }, { "type": "null" } ], - "title": "Pii Tags" + "title": "Identifier Limit" }, - "url": { + "prevent_global_search": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Url" + "title": "Prevent Global Search" } }, "type": "object", "required": [ - "id", "name", - "description_en", - "description_fr", - "breached_at", - "leaked_at", - "is_alert_enabled", - "pii_tags", - "url" + "description", + "number_of_employees", + "industry", + "identifier_limit", + "prevent_global_search" ], - "title": "SourceV2" + "title": "UpdateTenantRequestBody" }, - "StealerLogCookie": { + "UrlSubmission": { "properties": { - "host_key": { - "type": "string", - "title": "Host Key" - }, - "path": { + "url": { "type": "string", - "title": "Path" - }, - "expires_utc": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Expires Utc" + "title": "Url" }, - "name": { - "type": "string", - "title": "Name" + "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" }, - "value": { - "type": "string", - "title": "Value" + "tenant_role": { + "$ref": "#/components/schemas/TenantRoleType" } }, "type": "object", "required": [ - "host_key", - "path", - "expires_utc", - "name", - "value" + "user_id", + "tenant_role" ], - "title": "StealerLogCookie" + "title": "UserTenantAccess" }, - "StealerLogCredential": { + "UsernameData": { "properties": { - "url": { + "type": { "type": "string", - "title": "Url" + "const": "username", + "title": "Type", + "default": "username" }, "username": { "type": "string", + "minLength": 1, "title": "Username" - }, - "password": { + } + }, + "type": "object", + "required": [ + "username" + ], + "title": "UsernameData" + }, + "UsernameQuery": { + "properties": { + "type": { "type": "string", - "title": "Password" + "const": "username", + "title": "Type" }, - "application": { + "username": { "type": "string", - "title": "Application" + "title": "Username" } }, "type": "object", "required": [ - "url", - "username", - "password", - "application" + "type", + "username" ], - "title": "StealerLogCredential" + "title": "UsernameQuery" }, - "StealerLogEventData": { + "ValidCredentialEvent": { "properties": { - "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." + "event_type": { + "type": "string", + "const": "valid_credential", + "title": "Event Type", + "default": "valid_credential" }, - "malware_information": { - "anyOf": [ - { - "$ref": "#/components/schemas/MalwareInformation" - }, - { - "type": "null" - } - ], - "description": "Collection of data that relates to the malware that was used to infect the victim's device." + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + }, + "data": { + "$ref": "#/components/schemas/CredentialEventData" } }, "type": "object", "required": [ - "victim_information", - "malware_information" + "metadata", + "data" ], - "title": "StealerLogEventData" + "title": "Valid Credential" }, - "SubdomainStatus": { + "ValidationError": { "properties": { - "status": { - "$ref": "#/components/schemas/DomainStatus" + "loc": { + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ] + }, + "type": "array", + "title": "Location" }, - "updated_at": { + "msg": { "type": "string", - "format": "date-time", - "title": "Updated At" + "title": "Message" + }, + "type": { + "type": "string", + "title": "Error Type" + }, + "input": { + "title": "Input" + }, + "ctx": { + "type": "object", + "title": "Context" } }, "type": "object", "required": [ - "status", - "updated_at" + "loc", + "msg", + "type" ], - "title": "SubdomainStatus" + "title": "ValidationError" }, - "SubdomainTag": { + "VipIdentityDataRequestBody": { "properties": { - "label": { - "type": "string", - "title": "Label" - }, - "keyword": { + "type": { "type": "string", - "title": "Keyword" + "const": "identity", + "title": "Type" }, - "span": { + "attributes": { + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/EmailData" + }, + { + "$ref": "#/components/schemas/NameData" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "email": "#/components/schemas/EmailData", + "name": "#/components/schemas/NameData" + } + } + }, + "type": "array", + "maxItems": 10, + "minItems": 1, + "title": "Attributes" + } + }, + "type": "object", + "required": [ + "type", + "attributes" + ], + "title": "VipIdentityDataRequestBody" + }, + "VipProtectionBulkDeleteBody": { + "properties": { + "identifier_ids": { "items": { "type": "integer" }, "type": "array", - "title": "Span" + "minItems": 1, + "title": "Identifier Ids" } }, "type": "object", "required": [ - "label", - "keyword", - "span" + "identifier_ids" ], - "title": "SubdomainTag" + "title": "VipProtectionBulkDeleteBody" }, - "Tag": { + "VipProtectionCreateBody": { "properties": { + "data": { + "$ref": "#/components/schemas/VipIdentityDataRequestBody" + }, "name": { "anyOf": [ { @@ -10257,47 +30332,58 @@ } ], "title": "Name" - }, - "repository_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Repository Name" } }, "type": "object", - "title": "Tag" + "required": [ + "data" + ], + "title": "VipProtectionCreateBody" }, - "TenantMetadataResponse": { + "VipProtectionListItem": { "properties": { - "uid": { - "type": "string", - "title": "Uid" + "id": { + "type": "integer", + "title": "Id" }, - "notes": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Notes" + "name": { + "type": "string", + "title": "Name" }, - "tags": { + "email": { "items": { "type": "string" }, "type": "array", - "title": "Tags" + "title": "Email" + } + }, + "type": "object", + "required": [ + "id", + "name", + "email" + ], + "title": "VipProtectionListItem" + }, + "VipProtectionResponse": { + "properties": { + "identifier": { + "$ref": "#/components/schemas/Identifier" + } + }, + "type": "object", + "required": [ + "identifier" + ], + "title": "VipProtectionResponse" + }, + "VipProtectionUpdateRequestBody": { + "properties": { + "data": { + "$ref": "#/components/schemas/VipIdentityDataRequestBody" }, - "severity": { + "name": { "anyOf": [ { "type": "string" @@ -10306,294 +30392,285 @@ "type": "null" } ], - "title": "Severity" + "title": "Name" } }, "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" + "data" ], - "title": "TimeRangeType" + "title": "VipProtectionUpdateRequestBody" }, - "Types": { + "VulnerabilityEntityAPIResponse": { "properties": { - "is_guide": { + "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": "boolean" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Is Guide", - "description": "Whether the listing is a guide. Ex: 'How to extort a website'" + "title": "Created At" }, - "is_service": { + "updated_at": { "anyOf": [ { - "type": "boolean" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Is Service", - "description": "Whether the listing is offering a service. Ex: 'I will help you extort a website'" + "title": "Updated At" }, - "is_software": { + "first_seen_at": { "anyOf": [ { - "type": "boolean" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Is Software", - "description": "Whether the listing is offering software. Ex: 'I will sell you a software to extort a website'" + "title": "First Seen At" }, - "is_hardware": { + "last_seen_at": { "anyOf": [ { - "type": "boolean" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Is Hardware", - "description": "Whether the listing is offering hardware. Ex: 'I will sell you a hardware'" + "title": "Last Seen At" }, - "is_data": { + "confidence": { "anyOf": [ { - "type": "boolean" + "type": "integer" }, { "type": "null" } ], - "title": "Is Data", - "description": "Whether the listing is offering data. Ex: 'I will sell you victim data'" + "title": "Confidence" + }, + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Description" + }, + "marking_definitions": { + "items": { + "$ref": "#/components/schemas/MarkingDefinition" + }, + "type": "array", + "title": "Marking Definitions" } }, "type": "object", - "title": "Types" + "required": [ + "uuid", + "type", + "name", + "created_by", + "sources", + "created_at", + "updated_at", + "description", + "marking_definitions" + ], + "title": "VulnerabilityEntityAPIResponse" }, - "UpdateMatchingPolicyBody": { + "WebhookBasicAuth": { "properties": { - "name": { + "username": { "type": "string", - "minLength": 1, - "title": "Name", - "description": "The new name of the matching policy" + "title": "Username" }, - "value": { - "$ref": "#/components/schemas/PolicyValue", - "description": "The new value of the matching policy depending on its type" + "password": { + "type": "string", + "title": "Password" } }, "type": "object", "required": [ - "name", - "value" + "username", + "password" ], - "title": "UpdateMatchingPolicyBody" + "title": "WebhookBasicAuth" }, - "UpdateTenantMetadataBody": { + "WhoisRdapInfo": { "properties": { - "tags": { + "registrar": { "anyOf": [ { - "items": { - "type": "string" - }, - "type": "array" + "type": "string" }, { "type": "null" } ], - "title": "Tags" + "title": "Registrar" }, - "severity": { + "contact_email": { "anyOf": [ { - "$ref": "#/components/schemas/Severity" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Contact Email" }, - "notes": { + "epp_status": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Epp Status" + }, + "registered_date": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Notes" - } - }, - "type": "object", - "title": "UpdateTenantMetadataBody" - }, - "UsernameData": { - "properties": { - "type": { - "type": "string", - "const": "username", - "title": "Type", - "default": "username" + "title": "Registered Date" }, - "username": { - "type": "string", - "minLength": 1, - "title": "Username" + "updated_date": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Updated Date" + }, + "expires_date": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Expires Date" } }, "type": "object", - "required": [ - "username" + "title": "WhoisRdapInfo" + }, + "pyro__entities__domain__domain_browser_sort_type__SortType": { + "type": "string", + "enum": [ + "severity", + "fqdn", + "discovered_at", + "updated_at" ], - "title": "UsernameData" + "title": "SortType" }, - "UsernameQuery": { - "properties": { - "type": { - "type": "string", - "const": "username", - "title": "Type" - }, - "username": { - "type": "string", - "title": "Username" - } - }, - "type": "object", - "required": [ - "type", - "username" + "pyro__entities__domain__profile__sort_type__SortType": { + "type": "string", + "enum": [ + "date", + "event_type", + "severity" ], - "title": "UsernameQuery" + "title": "SortType" }, - "ValidCredentialEvent": { - "properties": { - "event_type": { - "type": "string", - "const": "valid_credential", - "title": "Event Type", - "default": "valid_credential" - }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" - }, - "data": { - "$ref": "#/components/schemas/CredentialEventData" - } - }, - "type": "object", - "required": [ - "metadata", - "data" + "pyro__entities__identities__identity_browser_sort_type__SortType": { + "type": "string", + "enum": [ + "severity", + "name", + "email", + "last_seen_at" ], - "title": "Valid Credential" + "title": "SortType" }, - "ValidationError": { - "properties": { - "loc": { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ] - }, - "type": "array", - "title": "Location" - }, - "msg": { - "type": "string", - "title": "Message" - }, - "type": { - "type": "string", - "title": "Error Type" - }, - "input": { - "title": "Input" - }, - "ctx": { - "type": "object", - "title": "Context" - } - }, - "type": "object", - "required": [ - "loc", - "msg", - "type" + "pyro__entities__identities__profile__sort_type__SortType": { + "type": "string", + "enum": [ + "creation_date", + "credentials_count", + "event_type", + "information_type", + "ip_address", + "last_seen", + "leaked_date", + "password", + "source_name" ], - "title": "ValidationError" + "title": "SortType" }, - "WebhookBasicAuth": { + "pyro__events__event_datamodels__StealerLogEvent": { "properties": { - "username": { + "type": { "type": "string", - "title": "Username" + "const": "stealer_log", + "title": "Type", + "default": "stealer_log" }, - "password": { - "type": "string", - "title": "Password" + "data": { + "$ref": "#/components/schemas/StealerLogData" + }, + "actions": { + "$ref": "#/components/schemas/StealerLogActions" } }, "type": "object", "required": [ - "username", - "password" + "data", + "actions" ], - "title": "WebhookBasicAuth" + "title": "StealerLogEvent" }, "pyro__findings__chat_messages__datamodels__ChatMessageEventData__Actor": { "properties": { diff --git a/docs/docs.json b/docs/docs.json index 195a03e..927f290 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -330,6 +330,7 @@ "event-types-v2/forum-post", "event-types-v2/invalid-credential", "event-types-v2/leaked-credential", + "event-types-v2/docker_repository", "event-types-v2/listing", "event-types-v2/mitigated-credential", "event-types-v2/paste", diff --git a/docs/event-types-v2/docker_repository.mdx b/docs/event-types-v2/docker_repository.mdx new file mode 100644 index 0000000..6be5338 --- /dev/null +++ b/docs/event-types-v2/docker_repository.mdx @@ -0,0 +1,10 @@ +--- +title: "Docker Repository" +--- + +import DockerRepositoryExample from '/snippets/event_model_examples/docker_repository.mdx' + +The `docker_repository` type represents an individual message or reply made within a forum thread on an underground or hacker-oriented site. +Each record contains the message text, author alias, message context, and metadata such as timestamps. + + diff --git a/docs/event-types-v2/overview.mdx b/docs/event-types-v2/overview.mdx index ed256b9..96dd209 100644 --- a/docs/event-types-v2/overview.mdx +++ b/docs/event-types-v2/overview.mdx @@ -14,6 +14,7 @@ Currently these event type models are supported on the | `bucket` | [Bucket ](/event-types-v2/bucket) | | `chat_message` | [Chat Message ](/event-types-v2/chat-message) | | `credit_card` | [Chat Message ](/event-types-v2/chat-message) | +| `docker_registry` | [Docker Repository ](/event-types-v2/docker_repository) | | `document` | [Ransomleak (document) ](/event-types-v2/ransom-leak) | | `domain` | [Lookalike Domain (domain) ](/event-types-v2/domain) | | `forum_post` | [Forum Post & Topic ](/event-types-v2/forum-post) | diff --git a/docs/snippets/event_model_examples/docker_image.mdx b/docs/snippets/event_model_examples/docker_image.mdx new file mode 100644 index 0000000..5a59e84 --- /dev/null +++ b/docs/snippets/event_model_examples/docker_image.mdx @@ -0,0 +1,41 @@ +{/* + If you are in pyro: + - If this file changes, you should also modify the API docs. + - https://github.com/flared/docs-api/ + + If you are in mintlify: + - Don't edit this directly, edit the generator in pyro. + - pyro/pyro/mintlify/test_firework_event_models.py +*/} + +```json Docker Image +{ + "event_type": "docker_image", + "data": { + "content": "Docker image description", + "browser_url": "https://hub.docker.com/r/flared/docker", + "digest": "sha256:e4b991038fd226016a60046db2109bf634f7f4b4ea9a2c548b559d3652e4cc38", + "architecture": "amd64", + "variant": null, + "os": "linux", + "os_features": [], + "os_version": null, + "last_pushed_at": "2025-01-01T00:00:00", + "last_pulled_at": "2025-01-01T00:00:00", + "tags": [ + { + "name": "latest", + "repository_name": "flared/docker" + } + ], + "size": 12345678 + }, + "metadata": { + "estimated_created_at": "2025-01-01T00:00:00", + "flare_url": "https://app.flare.io/#/uid", + "matched_at": null, + "severity": "info", + "uid": "index/source/id" + } +} +``` diff --git a/docs/snippets/event_model_examples/events_overview.mdx b/docs/snippets/event_model_examples/events_overview.mdx index e0bb23f..9497515 100644 --- a/docs/snippets/event_model_examples/events_overview.mdx +++ b/docs/snippets/event_model_examples/events_overview.mdx @@ -16,6 +16,10 @@ import ChatMessage from '/snippets/event_model_examples/chat_message.mdx' import CreditCard from '/snippets/event_model_examples/credit_card.mdx' +import DockerImage from '/snippets/event_model_examples/docker_image.mdx' + +import DockerRepository from '/snippets/event_model_examples/docker_repository.mdx' + import ForumPost from '/snippets/event_model_examples/forum_post.mdx' import Listing from '/snippets/event_model_examples/listing.mdx' @@ -35,6 +39,8 @@ import StealerLog from '/snippets/event_model_examples/stealer_log.mdx' + + @@ -42,4 +48,4 @@ import StealerLog from '/snippets/event_model_examples/stealer_log.mdx' - + \ No newline at end of file From 3a45b01f441a4a3c39aeedcd5f143736d63f9a06 Mon Sep 17 00:00:00 2001 From: Matei Date: Tue, 21 Jul 2026 11:15:43 -0400 Subject: [PATCH 3/9] fix openapi v4 spec --- .../spec/firework-v4-openapi.json | 32475 +++------------- 1 file changed, 6199 insertions(+), 26276 deletions(-) diff --git a/docs/api-reference/spec/firework-v4-openapi.json b/docs/api-reference/spec/firework-v4-openapi.json index 625f4a9..5e14d2b 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,113 @@ } } }, - "/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/InvalidCredentialEvent" + }, + { + "$ref": "#/components/schemas/LeakedCredentialEvent" + }, + { + "$ref": "#/components/schemas/ListingEvent" + }, + { + "$ref": "#/components/schemas/LookalikeDomainEvent" + }, + { + "$ref": "#/components/schemas/MitigatedCredentialEvent" + }, + { + "$ref": "#/components/schemas/PasteEvent" + }, + { + "$ref": "#/components/schemas/RansomLeakEvent" + }, + { + "$ref": "#/components/schemas/ServiceEvent" + }, + { + "$ref": "#/components/schemas/SocialMediaEvent" + }, + { + "$ref": "#/components/schemas/pyro__findings__stealerlogs__datamodels__StealerLogEvent" + }, + { + "$ref": "#/components/schemas/ValidCredentialEvent" + } + ], + "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", + "invalid_credential": "#/components/schemas/InvalidCredentialEvent", + "leaked_credential": "#/components/schemas/LeakedCredentialEvent", + "listing": "#/components/schemas/ListingEvent", + "lookalike": "#/components/schemas/LookalikeDomainEvent", + "mitigated_credential": "#/components/schemas/MitigatedCredentialEvent", + "paste": "#/components/schemas/PasteEvent", + "ransomleak": "#/components/schemas/RansomLeakEvent", + "service": "#/components/schemas/ServiceEvent", + "social_media_account": "#/components/schemas/SocialMediaEvent", + "stealer_log": "#/components/schemas/pyro__findings__stealerlogs__datamodels__StealerLogEvent", + "valid_credential": "#/components/schemas/ValidCredentialEvent" + } + } + }, + { + "$ref": "#/components/schemas/EmptyFireworkEvent" + } + ], + "title": "Response Get Event Events Get" + } + } + } }, "422": { "description": "Validation Error", @@ -533,42 +495,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 +533,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 +558,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FeatureFlagResponse" + "$ref": "#/components/schemas/PaginatedResults_GlobalFeedItem_str_" } } } @@ -625,90 +576,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 +627,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 +678,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 +709,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 +740,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 +780,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 +804,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MemberMutationPayload" + "$ref": "#/components/schemas/UpdateTenantMetadataBody" } } } @@ -1025,7 +814,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/TenantMetadataResponse" + } } } }, @@ -1042,90 +833,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 +918,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 +952,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 +1053,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 +1071,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 +1111,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 +1134,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/PublicIdentifierResponse" + } } } }, @@ -1477,151 +1151,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, - "schema": { - "type": "integer", - "title": "Organization Id" - } - }, - { - "name": "restricted_term_id", - "in": "path", - "required": true, + "name": "from", + "in": "query", + "required": false, "schema": { - "type": "string", - "title": "Restricted Term Id" + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "From" } }, { - "name": "remove_related_requests", + "name": "size", "in": "query", "required": false, "schema": { - "type": "boolean", - "default": true, - "title": "Remove Related Requests" + "type": "integer", + "maximum": 100, + "exclusiveMinimum": 0, + "default": 20, + "title": "Size" } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } + }, + { + "name": "order_by", + "in": "query", + "required": false, + "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 +1301,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 +1336,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SearchQueryAllowedResponse" + "$ref": "#/components/schemas/PublicIdentifierResponse" } } } @@ -1679,23 +1352,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 +1393,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 +1434,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 +1475,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EnableFlareCommunityResponse" + "$ref": "#/components/schemas/MatchingPolicyPayload" } } } @@ -1810,18 +1494,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", - "parameters": [ + "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": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "From" + } + }, + { + "name": "size", + "in": "query", + "required": false, "schema": { "type": "integer", - "title": "Tenant Id" + "maximum": 25, + "exclusiveMinimum": 0, + "default": 25, + "title": "Size" + } + }, + { + "name": "order", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/OrderType", + "default": "desc" } } ], @@ -1831,7 +1544,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TenantFlareCommunityIsEnabledResponse" + "$ref": "#/components/schemas/PaginatedResults_MatchingPolicyPayload_str_" } } } @@ -1847,30 +1560,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 +1614,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 +1681,7 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_InviteLinkResponse_datetime_" - } + "schema": {} } } }, @@ -1954,41 +1696,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 +1745,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 +1771,7 @@ "schema": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" @@ -2045,24 +1786,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 +1807,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedResults_TenantFlareCommunityUser_int_" + "$ref": "#/components/schemas/PaginatedResults_PolicyAssignedIdentifierPayload_str_" } } } @@ -2088,34 +1823,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,42 +1873,43 @@ } } } - } - }, - "/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" } } ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyAssignmentsBody" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } } }, "422": { @@ -2181,30 +1925,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 +1997,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/PaginatedResults_PublicReport_str_" + } } } }, @@ -2228,49 +2014,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 +2060,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 +2117,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 +2161,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 +2186,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedResults_ThreatFlowReportResponse_str_" + "$ref": "#/components/schemas/PaginatedResults_PydanticThreatFlowReport_str_" } } } @@ -2432,13 +2204,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 +2228,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ThreatFlowReportResponse" + "$ref": "#/components/schemas/pyro__threat_flow__web__v4__reports__models__ReportResponse" } } } @@ -2473,12 +2245,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 +2262,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 +2284,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 +2318,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateLLMRecommendationsResponse" + "$ref": "#/components/schemas/pyro__threat_flow__web__v4__reports__models__ReportResponse" } } } @@ -2566,22 +2336,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 +2368,7 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ActorUid" - } + "schema": {} } } }, @@ -2609,18 +2385,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 +2408,7 @@ "content": { "application/json": { "schema": { - "type": "string", - "title": "Response Get Asset Uuid Actors Uuid Post" + "$ref": "#/components/schemas/RelatedConversationResponse" } } } @@ -2651,161 +2426,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" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActorMetadata" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } + "summary": "Create Report Request", + "operationId": "create_report_request_threat_flow_reports_requests_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReportRequestPayload" } } - } - } - } - }, - "/firework/v4/actors/{asset_uuid}/timeline": { - "get": { - "tags": [ - "private" - ], - "summary": "Get Actor Timeline", - "operationId": "get_actor_timeline_actors__asset_uuid__timeline_get", - "parameters": [ - { - "name": "asset_uuid", - "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" - } - } - ], + "required": true + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActorTimeline" + "$ref": "#/components/schemas/ReportRequestResponse" } } } @@ -2823,22 +2467,22 @@ } } }, - "/firework/v4/actors/{asset_uuid}/threads": { + "/firework/v4/threat_flow/reports/requests/{request_info_id}": { "get": { "tags": [ - "private" + "public" ], - "summary": "Get Actor Threads", - "operationId": "get_actor_threads_actors__asset_uuid__threads_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" + "title": "Request Info Id" } } ], @@ -2848,11 +2492,7 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ActorThread" - }, - "title": "Response Get Actor Threads Actors Asset Uuid Threads Get" + "$ref": "#/components/schemas/ReportRequestInfoResponse" } } } @@ -2870,76 +2510,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 +2550,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,19368 +2589,186 @@ } } } - }, - "/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" - } - } - } - } - } - } - }, - "/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/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/_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/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": "status", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdentifierRecommendationState" - }, - { - "type": "null" - } - ], - "title": "Status" - } - }, - { - "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/": { - "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/{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/reports": { - "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_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", - "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" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedResults_PublicReport_str_" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/firework/v4/reports/{report_id}": { - "get": { - "tags": [ - "public", - "team=data-intelligence", - "feature=reports" - ], - "summary": "Get Report", - "operationId": "get_report_reports__report_id__get", - "parameters": [ - { - "name": "report_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Id" - } - }, - { - "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/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/reports/{report_id}/download": { - "get": { - "tags": [ - "public", - "team=data-intelligence", - "feature=reports" - ], - "summary": "Download Report", - "operationId": "download_report_reports__report_id__download_get", - "parameters": [ - { - "name": "report_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Id" - } - }, - { - "name": "report_group_id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "title": "Report Group 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/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/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" - }, - "AddressData": { - "properties": { - "type": { - "type": "string", - "const": "address_data", - "title": "Type", - "default": "address_data" - }, - "street": { - "type": "string", - "minLength": 1, - "title": "Street" - }, - "city": { - "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", - "maxLength": 2, - "minLength": 2, - "title": "Country" - }, - "state": { - "type": "string", - "minLength": 1, - "title": "State" - } - }, - "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" - }, - "custom_fields": { - "anyOf": [ - { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Custom Fields" - } - }, - "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" - }, - "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" - }, - "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" - }, - "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" - }, - "BinQuery": { - "properties": { - "type": { - "type": "string", - "const": "bin", - "title": "Type" - }, - "bin": { - "type": "string", - "title": "Bin" - } - }, - "type": "object", - "required": [ - "type", - "bin" - ], - "title": "BinQuery" - }, - "BirthYearData": { - "properties": { - "type": { - "type": "string", - "const": "birth_year", - "title": "Type", - "default": "birth_year" - }, - "year": { - "type": "integer", - "maximum": 2100.0, - "minimum": 1900.0, - "title": "Year" - } - }, - "type": "object", - "required": [ - "year" - ], - "title": "BirthYearData" - }, - "BinaryInputContent": { - "properties": { - "type": { - "type": "string", - "const": "binary", - "title": "Type", - "default": "binary" - }, - "mimeType": { - "type": "string", - "title": "Mimetype" - }, - "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Id" - }, - "url": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Url" - }, - "data": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Data" - }, - "filename": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Filename" - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "mimeType" - ], - "title": "BinaryInputContent", - "description": "A deprecated binary payload reference in a multimodal user message." - }, - "BirthYearData": { - "properties": { - "type": { - "type": "string", - "const": "birth_year", - "title": "Type", - "default": "birth_year" - }, - "year": { - "type": "integer", - "maximum": 2100.0, - "minimum": 1900.0, - "title": "Year" - } - }, - "type": "object", - "required": [ - "year" - ], - "title": "BirthYearData" - }, - "BlacklistedTermLocation": { - "type": "string", - "enum": [ - "identifier_creation", - "identifier_update", - "event_search", - "credentials_browser_search", - "leaks_browser_api_search", - "entities_search" - ], - "title": "BlacklistedTermLocation" - }, - "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" - }, - "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" - }, - "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" - }, - "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" - }, - "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" - }, - "urls": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Urls" - } - }, - "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" - }, - "CredentialEventData": { - "properties": { - "identity_name": { - "type": "string", - "title": "Identity Name", - "description": "The email or username associated with the credential." - }, - "credential_hash": { - "type": "string", - "title": "Credential Hash", - "description": "A hash uniquely identifying the credential." - }, - "tenant_integration_id": { - "type": "string", - "title": "Tenant Integration Id", - "description": "The UUID of the tenant's IdP integration that validated the credential." - } - }, - "type": "object", - "required": [ - "identity_name", - "credential_hash", - "tenant_integration_id" - ], - "title": "CredentialEventData" - }, - "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" - }, - "DomainMatchMode": { - "type": "string", - "enum": [ - "email_domain_only", - "auth_domain_and_email_domain", - "auth_domain_only" - ], - "title": "DomainMatchMode" - }, - "DomainQuery": { - "properties": { - "type": { - "type": "string", - "const": "domain", - "title": "Type" - }, - "fqdn": { - "type": "string", - "title": "Fqdn" - } - }, - "type": "object", - "required": [ - "type", - "fqdn" - ], - "title": "DomainQuery" - }, - "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": { - "event_type": { - "$ref": "#/components/schemas/ActivityModelName" - }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" - }, - "data": { - "additionalProperties": true, - "type": "object", - "title": "Data" - } - }, - "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" - }, - "EventSeverity": { - "type": "string", - "enum": [ - "info", - "low", - "medium", - "high", - "critical" - ], - "title": "EventSeverity" - }, - "ExpandableField": { - "type": "string", - "enum": [ - "credentials", - "cookies" - ], - "title": "ExpandableField" - }, - "ExternalIdData": { - "properties": { - "type": { - "type": "string", - "const": "external_id", - "title": "Type", - "default": "external_id" - }, - "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", - "minLength": 1, - "title": "Source" - } - }, - "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": "ExternalIdData" - }, - "FeedAlertChannelParams": { - "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": "FeedAlertChannelParams" - }, - "FeedAlertDiscordParams": { - "properties": { - "type": { - "type": "string", - "const": "discord", - "title": "Type" - }, - "webhook_url": { - "type": "string", - "title": "Webhook Url" - } - }, - "type": "object", - "required": [ - "type", - "webhook_url" - ], - "title": "FeedAlertDiscordParams" - }, - "FeedAlertEmailParams": { - "properties": { - "type": { - "type": "string", - "const": "email", - "title": "Type" - }, - "email": { - "type": "string", - "title": "Email" - }, - "json_attachment": { - "type": "boolean", - "title": "Json Attachment" - }, - "csv_attachment": { - "type": "boolean", - "title": "Csv Attachment" - }, - "subject_tag": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Subject Tag" - }, - "language": { - "$ref": "#/components/schemas/Language" - } - }, - "type": "object", - "required": [ - "type", - "email", - "json_attachment", - "csv_attachment", - "subject_tag", - "language" - ], - "title": "FeedAlertEmailParams" - }, - "FeedAlertJiraParams": { - "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" - }, - "issue_type": { - "type": "string", - "title": "Issue Type" - }, - "custom_fields": { - "anyOf": [ - { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Custom Fields" - } - }, - "type": "object", - "required": [ - "type", - "server_netloc", - "email", - "api_token", - "project_key", - "labels", - "issue_type", - "custom_fields" - ], - "title": "FeedAlertJiraParams" - }, - "FeedAlertLegacySentinelParams": { - "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": "FeedAlertLegacySentinelParams" - }, - "FeedAlertSentinelV2Params": { - "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": "FeedAlertSentinelV2Params" - }, - "FeedAlertServiceNowParams": { - "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": "FeedAlertServiceNowParams" - }, - "FeedAlertSlackParams": { - "properties": { - "type": { - "type": "string", - "const": "slack", - "title": "Type" - }, - "webhook_url": { - "type": "string", - "title": "Webhook Url" - } - }, - "type": "object", - "required": [ - "type", - "webhook_url" - ], - "title": "FeedAlertSlackParams" - }, - "FeedAlertSplunkParams": { - "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" - } - }, - "type": "object", - "required": [ - "type", - "api_token", - "netloc", - "index", - "labels" - ], - "title": "FeedAlertSplunkParams" - }, - "FeedAlertTeamsParams": { - "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": "FeedAlertTeamsParams" - }, - "FeedAlertWebhookParams": { - "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/FeedWebhookBasicAuth" - }, - { - "type": "null" - } - ] - }, - "custom_headers": { - "anyOf": [ - { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Custom Headers" - } - }, - "type": "object", - "required": [ - "type", - "webhook_url", - "secret", - "basic_auth", - "custom_headers" - ], - "title": "FeedAlertWebhookParams" - }, - "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" - }, - "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" - }, - "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" - }, - "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": { + } + }, + "components": { + "schemas": { + "ActivityModelName": { "type": "string", "enum": [ - "ungrouped", - "relationship_nature" + "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", + "entity_summarization", + "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": "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" + "title": "ActivityModelName" }, - "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" + "AddressData": { + "properties": { + "type": { + "type": "string", + "const": "address_data", + "title": "Type", + "default": "address_data" }, - "top_domains": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Top Domains" + "street": { + "type": "string", + "minLength": 1, + "title": "Street" }, - "count": { - "type": "integer", - "title": "Count" + "city": { + "type": "string", + "minLength": 1, + "title": "City" }, - "type": { - "$ref": "#/components/schemas/ApplicationExposureNodeType", - "readOnly": true + "country": { + "type": "string", + "maxLength": 2, + "minLength": 2, + "title": "Country" }, - "id": { + "state": { "type": "string", - "title": "Id", - "readOnly": true + "minLength": 1, + "title": "State" } }, "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" - }, - "HubspotLifecycleStage": { - "type": "string", - "enum": [ - "1281177943" + "street", + "city", + "country", + "state" ], - "title": "HubspotLifecycleStage" + "title": "AddressData" }, - "HubspotWebhookFlareSyncEvent": { + "Alert": { "properties": { - "hubspot_id": { - "type": "integer", - "title": "Hubspot Id" + "feed_definition": { + "$ref": "#/components/schemas/FeedDefinition" }, - "domain": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Domain" + "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": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "type": "string", "title": "Name" }, + "tenant_id": { + "type": "integer", + "title": "Tenant Id" + }, "organization_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], + "type": "integer", "title": "Organization Id" }, - "lifecycle_stage": { - "anyOf": [ - { - "$ref": "#/components/schemas/HubspotLifecycleStage" - }, - { - "type": "null" - } - ] - }, - "merged_object_ids": { + "search_types": { "items": { - "type": "integer" + "$ref": "#/components/schemas/SearchType" }, "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" + "title": "Search Types" }, - "merged_object_ids": { + "experimental_search_types": { "items": { - "type": "integer" + "type": "string" }, "type": "array", - "title": "Merged Object Ids", - "default": [] + "title": "Experimental Search Types" }, - "flare_tenant_name": { - "type": "string", - "title": "Flare Tenant Name" + "risks": { + "items": { + "$ref": "#/components/schemas/RiskScore" + }, + "type": "array", + "title": "Risks" }, - "organization_id": { + "alert_channel_id": { "anyOf": [ { "type": "integer" @@ -22378,129 +2777,58 @@ "type": "null" } ], - "title": "Organization Id" + "title": "Alert Channel Id" }, - "tenant_id": { + "alert_channel": { "anyOf": [ { - "type": "integer" + "$ref": "#/components/schemas/AlertChannelSummary" }, { "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": { + "frequency": { + "type": "number", + "title": "Frequency" + }, + "start_at": { "type": "string", - "format": "uuid", - "title": "Application Uuid" + "title": "Start At" }, - "domain": { + "identifier_scope": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/IdentifierScope" }, { "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", + "feed_definition", "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" + "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": "IdPUserAccountType" + "title": "Alert" }, - "Identifier": { + "AlertChannel": { "properties": { "id": { "type": "integer", @@ -22510,578 +2838,519 @@ "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" + "$ref": "#/components/schemas/AlertType" }, - "asset_uuid": { - "type": "string", - "title": "Asset Uuid" + "state": { + "$ref": "#/components/schemas/AlertChannelState" }, - "data": { + "params": { "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/AlertChannelEmailParams" }, { - "$ref": "#/components/schemas/EmailData" + "$ref": "#/components/schemas/AlertChannelSlackParams" }, { - "$ref": "#/components/schemas/SecretData" + "$ref": "#/components/schemas/AlertChannelDiscordParams" }, { - "$ref": "#/components/schemas/CredentialsData" + "$ref": "#/components/schemas/AlertChannelSplunkParams" }, { - "$ref": "#/components/schemas/IdentityData" + "$ref": "#/components/schemas/AlertChannelChannelParams" }, { - "$ref": "#/components/schemas/RansomLeakData" + "$ref": "#/components/schemas/AlertChannelLegacySentinelParams" }, { - "$ref": "#/components/schemas/AddressData" + "$ref": "#/components/schemas/AlertChannelSentinelV2Params" }, { - "$ref": "#/components/schemas/BirthYearData" + "$ref": "#/components/schemas/AlertChannelTeamsParams" }, { - "$ref": "#/components/schemas/RoleData" + "$ref": "#/components/schemas/AlertChannelJiraParams" }, { - "$ref": "#/components/schemas/PhoneNumberData" + "$ref": "#/components/schemas/AlertChannelServiceNowParams" }, { - "$ref": "#/components/schemas/ExternalIdData" + "$ref": "#/components/schemas/AlertChannelWebhookParams" } ], - "title": "Data", + "title": "Params", "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" + "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" }, - "collection": { + "alert_channel_id": { "anyOf": [ { - "$ref": "#/components/schemas/IdentifierCollectionGroupId" + "type": "integer" }, { - "$ref": "#/components/schemas/IdentifierCollectionGroupType" + "type": "null" } ], - "title": "Collection" + "title": "Alert Channel Id" + } + }, + "type": "object", + "required": [ + "type", + "alert_channel_id" + ], + "title": "AlertChannelChannelParams" + }, + "AlertChannelDiscordParams": { + "properties": { + "type": { + "type": "string", + "const": "discord", + "title": "Type" }, - "urn": { + "webhook_url": { "type": "string", - "title": "Urn" + "title": "Webhook Url" + } + }, + "type": "object", + "required": [ + "type", + "webhook_url" + ], + "title": "AlertChannelDiscordParams" + }, + "AlertChannelEmailParams": { + "properties": { + "type": { + "type": "string", + "const": "email", + "title": "Type" }, - "entity": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdentityIdentifierEntity" - }, - { - "type": "null" - } - ] + "email": { + "type": "string", + "title": "Email" }, - "enrichments": { + "json_attachment": { + "type": "boolean", + "title": "Json Attachment", + "default": false + }, + "csv_attachment": { + "type": "boolean", + "title": "Csv Attachment", + "default": false + }, + "subject_tag": { "anyOf": [ { - "items": { - "$ref": "#/components/schemas/DomainAssetEnrichment" - }, - "type": "array" + "type": "string" }, { "type": "null" } ], - "title": "Enrichments" - }, - "metadata": { - "$ref": "#/components/schemas/IdentifierMetadata" + "title": "Subject Tag" }, - "state": { - "$ref": "#/components/schemas/IdentifierState" + "language": { + "$ref": "#/components/schemas/Language", + "default": "en" } }, "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" + "email" ], - "title": "IdentifierAuthorizationStatus" + "title": "AlertChannelEmailParams" }, - "IdentifierCollectionGroupId": { + "AlertChannelJiraParams": { "properties": { "type": { "type": "string", - "const": "group_id", - "title": "Type" + "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" }, - "group_id": { + "custom_fields": { "anyOf": [ { - "type": "integer" + "additionalProperties": { + "type": "string" + }, + "type": "object" }, { "type": "null" } ], - "title": "Group Id" + "title": "Custom Fields" } }, "type": "object", "required": [ "type", - "group_id" + "server_netloc", + "email", + "api_token", + "project_key", + "issue_type" ], - "title": "IdentifierCollectionGroupId" + "title": "AlertChannelJiraParams" }, - "IdentifierCollectionGroupType": { + "AlertChannelLegacySentinelParams": { "properties": { "type": { "type": "string", - "const": "group_type", + "const": "azure_sentinel", "title": "Type" }, - "group_type": { - "$ref": "#/components/schemas/IdentifierGroupType" + "workspace_id": { + "type": "string", + "title": "Workspace Id" + }, + "shared_key": { + "type": "string", + "title": "Shared Key" } }, "type": "object", "required": [ "type", - "group_type" + "workspace_id", + "shared_key" ], - "title": "IdentifierCollectionGroupType" + "title": "AlertChannelLegacySentinelParams" }, - "IdentifierEnrichments": { + "AlertChannelSentinelV2Params": { "properties": { - "domain_reachable_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Domain Reachable At" + "type": { + "type": "string", + "const": "azure_sentinel_v2", + "title": "Type" }, - "domain_resolves_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Domain Resolves At" + "entra_client_id": { + "type": "string", + "title": "Entra Client Id" }, - "usage_count": { - "type": "integer", - "title": "Usage Count" + "entra_tenant_id": { + "type": "string", + "title": "Entra Tenant Id" }, - "event_count": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Event Count" + "entra_secret": { + "type": "string", + "title": "Entra Secret" }, - "authorization_status": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdentifierAuthorizationStatus" - }, - { - "type": "null" - } - ], - "examples": [ - "authorized", - "pending", - "rejected" - ] + "url": { + "type": "string", + "title": "Url" } }, "type": "object", "required": [ - "domain_reachable_at", - "domain_resolves_at", - "usage_count", - "event_count", - "authorization_status" - ], - "title": "IdentifierEnrichments" - }, - "IdentifierEntityType": { - "type": "string", - "enum": [ - "identity" + "type", + "entra_client_id", + "entra_tenant_id", + "entra_secret", + "url" ], - "title": "IdentifierEntityType" + "title": "AlertChannelSentinelV2Params" }, - "IdentifierFeed": { + "AlertChannelServiceNowParams": { "properties": { - "id": { - "type": "integer", - "title": "Id" + "type": { + "type": "string", + "const": "servicenow", + "title": "Type" }, - "owner_id": { - "type": "integer", - "title": "Owner Id" + "server_url": { + "type": "string", + "title": "Server Url" + }, + "api_key": { + "type": "string", + "title": "Api Key" + }, + "table_name": { + "type": "string", + "title": "Table Name" } }, "type": "object", "required": [ - "id", - "owner_id" + "type", + "server_url", + "api_key", + "table_name" ], - "title": "IdentifierFeed" + "title": "AlertChannelServiceNowParams" }, - "IdentifierFeedRateLimit": { + "AlertChannelSlackParams": { "properties": { - "activity_type": { - "type": "string", - "title": "Activity Type" - }, - "first_rate_limited_at": { + "type": { "type": "string", - "format": "date-time", - "title": "First Rate Limited At" + "const": "slack", + "title": "Type" }, - "last_rate_limited_at": { + "webhook_url": { "type": "string", - "format": "date-time", - "title": "Last Rate Limited At" + "title": "Webhook Url" } }, "type": "object", "required": [ - "activity_type", - "first_rate_limited_at", - "last_rate_limited_at" + "type", + "webhook_url" ], - "title": "IdentifierFeedRateLimit" + "title": "AlertChannelSlackParams" }, - "IdentifierFeedRateLimits": { + "AlertChannelSplunkParams": { "properties": { - "first_rate_limited_at": { + "type": { "type": "string", - "format": "date-time", - "title": "First Rate Limited At" + "const": "splunk", + "title": "Type" }, - "last_rate_limited_at": { + "api_token": { "type": "string", - "format": "date-time", - "title": "Last Rate Limited At" + "title": "Api Token" }, - "activity_types": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Activity Types" + "netloc": { + "type": "string", + "title": "Netloc" }, - "items": { + "index": { + "type": "string", + "title": "Index" + }, + "labels": { "items": { - "$ref": "#/components/schemas/IdentifierFeedRateLimit" + "type": "string" }, "type": "array", - "title": "Items" - } - }, - "type": "object", - "required": [ - "first_rate_limited_at", - "last_rate_limited_at", - "activity_types", - "items" - ], - "title": "IdentifierFeedRateLimits" - }, - "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 + "title": "Labels", + "default": [] } }, "type": "object", "required": [ - "matching_policy_uuid" + "type", + "api_token", + "netloc", + "index" ], - "title": "IdentifierMatchingPolicyBody" + "title": "AlertChannelSplunkParams" }, - "IdentifierMetadata": { + "AlertChannelState": { "properties": { - "critical": { - "type": "boolean", - "title": "Critical" + "status": { + "$ref": "#/components/schemas/AlertChannelStatus" }, - "is_disabled": { - "type": "boolean", - "title": "Is Disabled" + "message": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Message" } }, "type": "object", "required": [ - "critical", - "is_disabled" + "status" ], - "title": "IdentifierMetadata" + "title": "AlertChannelState" }, - "IdentifierOrderBy": { + "AlertChannelStatus": { "type": "string", "enum": [ - "id", - "name", - "type" - ], - "title": "IdentifierOrderBy" - }, - "IdentifierRecommendationAction": { - "properties": { - "type": { - "$ref": "#/components/schemas/IdentifierRecommendationActionType" - } - }, - "type": "object", - "required": [ - "type" + "untested", + "error", + "success" ], - "title": "IdentifierRecommendationAction" + "title": "AlertChannelStatus" }, - "IdentifierRecommendationActionTarget": { + "AlertChannelSummary": { "properties": { "id": { "type": "integer", "title": "Id" + }, + "name": { + "type": "string", + "title": "Name" } }, "type": "object", "required": [ - "id" - ], - "title": "IdentifierRecommendationActionTarget" - }, - "IdentifierRecommendationActionType": { - "type": "string", - "enum": [ - "accept", - "reject" + "id", + "name" ], - "title": "IdentifierRecommendationActionType" + "title": "AlertChannelSummary" }, - "IdentifierRecommendationActionsBody": { + "AlertChannelTeamsParams": { "properties": { - "targets": { - "items": { - "$ref": "#/components/schemas/IdentifierRecommendationActionTarget" - }, - "type": "array", - "maxItems": 100, - "title": "Targets" + "type": { + "type": "string", + "const": "teams", + "title": "Type" }, - "action": { - "$ref": "#/components/schemas/IdentifierRecommendationAction" + "teams_webhook_url": { + "type": "string", + "title": "Teams Webhook Url" } }, "type": "object", "required": [ - "action" - ], - "title": "IdentifierRecommendationActionsBody" - }, - "IdentifierRecommendationState": { - "type": "string", - "enum": [ - "recommended", - "accepted", - "rejected" + "type", + "teams_webhook_url" ], - "title": "IdentifierRecommendationState" + "title": "AlertChannelTeamsParams" }, - "IdentifierRequestBody": { + "AlertChannelWebhookParams": { "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" - }, + "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/UsernameData" + "$ref": "#/components/schemas/WebhookBasicAuth" }, { - "$ref": "#/components/schemas/SecretData" - }, + "type": "null" + } + ] + }, + "custom_headers": { + "anyOf": [ { - "$ref": "#/components/schemas/NameData" + "additionalProperties": { + "type": "string" + }, + "type": "object" }, { - "$ref": "#/components/schemas/IdentityDataRequestBody" + "type": "null" } ], - "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" - } - } + "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" }, - "name": { + "format_type": { + "$ref": "#/components/schemas/ThreatFlowReportFormatType", + "default": "simple_summary" + }, + "title": { + "type": "string", + "title": "Title" + }, + "subtitle": { "anyOf": [ { "type": "string" @@ -23090,448 +3359,477 @@ "type": "null" } ], - "title": "Name" + "title": "Subtitle" }, - "feed_config": { - "$ref": "#/components/schemas/FeedConfiguration" + "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" }, - "collection": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdentifierCollectionGroupId" - }, - { - "$ref": "#/components/schemas/IdentifierCollectionGroupType" - } - ], - "title": "Collection" + "related_activity_uids": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Related Activity Uids" }, - "metadata": { - "$ref": "#/components/schemas/IdentifierMetadata" + "created_at": { + "type": "string", + "format": "date-time", + "title": "Created At" }, - "matching_policies": { + "tenant_id": { "anyOf": [ { - "items": { - "$ref": "#/components/schemas/IdentifierMatchingPolicyBody" - }, - "type": "array" + "type": "integer" }, { "type": "null" } ], - "title": "Matching Policies" + "title": "Tenant Id" } }, "type": "object", "required": [ - "data", - "name", - "feed_config", - "collection", - "metadata" + "id", + "title", + "subtitle", + "summary", + "content", + "tags", + "highlights", + "related_activity_uids", + "created_at", + "tenant_id" ], - "title": "IdentifierRequestBody" + "title": "ApiReport" }, - "IdentifierResponse": { + "AssetEnrichmentType": { + "type": "string", + "enum": [ + "domain" + ], + "title": "AssetEnrichmentType" + }, + "AstpCookiesValue": { "properties": { - "identifier": { - "anyOf": [ - { - "$ref": "#/components/schemas/Identifier" - }, - { - "type": "null" - } - ] + "cookie_names": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Cookie Names", + "description": "The cookie names to monitor" }, - "is_materialized": { + "match_subdomains": { "type": "boolean", - "title": "Is Materialized", + "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": { + "type": "string", + "const": "auth_domain", + "title": "Type" }, - "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" + "fqdn": { + "type": "string", + "title": "Fqdn" } }, "type": "object", - "title": "IdentifierResponse" + "required": [ + "type", + "fqdn" + ], + "title": "AuthDomainQuery" }, - "IdentifierScope": { + "AzureTenantData": { "properties": { - "name": { + "type": { "type": "string", - "title": "Name" + "const": "azure_tenant", + "title": "Type", + "default": "azure_tenant" }, - "is_disabled": { - "type": "boolean", - "title": "Is Disabled", - "default": false + "tenant_id": { + "type": "string", + "minLength": 1, + "title": "Tenant Id" } }, "type": "object", "required": [ - "name" + "tenant_id" ], - "title": "IdentifierScope" + "title": "AzureTenantData" }, - "IdentifierSource": { - "type": "string", - "enum": [ - "USER", - "SYSTEM_RELATION", - "SELF_ONBOARDING", - "ATTRIBUTE", - "AUTO_MONITOR", - "IDP_SYNC" + "AzureTenantQuery": { + "properties": { + "type": { + "type": "string", + "const": "azure_tenant", + "title": "Type" + }, + "tenant_id": { + "type": "string", + "title": "Tenant Id" + } + }, + "type": "object", + "required": [ + "type", + "tenant_id" ], - "title": "IdentifierSource" + "title": "AzureTenantQuery" }, - "IdentifierState": { + "BinQuery": { "properties": { - "source": { - "$ref": "#/components/schemas/IdentifierSource" + "type": { + "type": "string", + "const": "bin", + "title": "Type" }, - "data_updated_at": { + "bin": { "type": "string", - "format": "date-time", - "title": "Data Updated At" + "title": "Bin" + } + }, + "type": "object", + "required": [ + "type", + "bin" + ], + "title": "BinQuery" + }, + "BirthYearData": { + "properties": { + "type": { + "type": "string", + "const": "birth_year", + "title": "Type", + "default": "birth_year" }, - "event_count": { + "year": { + "type": "integer", + "maximum": 2100.0, + "minimum": 1900.0, + "title": "Year" + } + }, + "type": "object", + "required": [ + "year" + ], + "title": "BirthYearData" + }, + "BlogPostData": { + "properties": { + "url": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Event Count" - }, - "usage_count": { - "type": "integer", - "title": "Usage Count" + "title": "Url", + "description": "The URL of the blog post." }, - "rate_limits": { + "content": { "anyOf": [ { - "$ref": "#/components/schemas/IdentifierFeedRateLimits" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Content", + "description": "The content of the blog post." }, - "validation_status": { + "description": { "anyOf": [ { - "$ref": "#/components/schemas/IdentifierValidationStatus" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Description", + "description": "The description of the blog post." }, - "authorization_request_status": { + "posted_at": { "anyOf": [ { - "$ref": "#/components/schemas/IdentifierAuthorizationRequestStatus" + "type": "string", + "format": "date-time" }, { "type": "null" } - ] + ], + "title": "Posted At", + "description": "The date and time the blog post was posted." } }, "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", - "external_id", - "address_data", - "birth_year", - "role", - "phone_number" - ], - "title": "IdentifierType" - }, - "IdentifierValidationStatus": { - "type": "string", - "enum": [ - "FIRST_PARTY" + "url", + "content", + "description", + "posted_at" ], - "title": "IdentifierValidationStatus" + "title": "BlogPostData" }, - "IdentityAttribute": { + "BlogPostEvent": { "properties": { - "asset_uuid": { + "event_type": { "type": "string", - "title": "Asset Uuid" + "const": "blog_post", + "title": "Event Type", + "default": "blog_post" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" }, "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" - } - } + "$ref": "#/components/schemas/BlogPostData" } }, "type": "object", "required": [ - "asset_uuid", + "metadata", "data" ], - "title": "IdentityAttribute" + "title": "Blog Post" }, - "IdentityBrowserCounts": { + "BrandData": { "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" + "type": { + "type": "string", + "const": "brand", + "title": "Type", + "default": "brand" }, - "open_web": { - "type": "integer", - "title": "Open Web" + "name": { + "type": "string", + "minLength": 1, + "title": "Name" } }, "type": "object", "required": [ - "passwords", - "stealer_logs", - "pii", - "illicit_networks", - "open_web" + "name" ], - "title": "IdentityBrowserCounts" + "title": "BrandData" }, - "IdentityBrowserItemResponse": { + "BrandQuery": { "properties": { - "asset_uuid": { + "type": { "type": "string", - "title": "Asset Uuid" + "const": "brand", + "title": "Type" }, - "risk": { + "name": { + "type": "string", + "title": "Name" + } + }, + "type": "object", + "required": [ + "type", + "name" + ], + "title": "BrandQuery" + }, + "BucketData": { + "properties": { + "host": { "anyOf": [ { - "$ref": "#/components/schemas/PhoneNumberData" + "type": "string" + }, + { + "type": "null" } ], - "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" + "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": [ - "asset_uuid", - "data" + "host", + "provider" ], - "title": "IdentityAttribute" + "title": "BucketData" }, - "IdentityData": { + "BucketEvent": { "properties": { - "type": { + "event_type": { "type": "string", - "const": "identity", - "title": "Type", - "default": "identity" + "const": "bucket", + "title": "Event Type", + "default": "bucket" }, - "uuid": { - "type": "string", - "minLength": 1, - "title": "Uuid" + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + }, + "data": { + "$ref": "#/components/schemas/BucketEventData" } }, "type": "object", "required": [ - "uuid" + "metadata", + "data" ], - "title": "IdentityData" + "title": "Bucket" }, - "IdentityDataRequestBody": { + "BucketEventData": { "properties": { - "type": { - "type": "string", - "const": "identity", - "title": "Type" - }, - "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" - } + "url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" } - }, - "type": "array", - "maxItems": 15, - "minItems": 1, - "title": "Attributes" + ], + "title": "Url", + "description": "The URL to the bucket." + }, + "bucket": { + "$ref": "#/components/schemas/BucketData" } }, "type": "object", "required": [ - "type", - "attributes" + "url", + "bucket" ], - "title": "IdentityDataRequestBody" + "title": "BucketEventData" }, - "IdentityIdentifierEntity": { + "CCBinData": { "properties": { "type": { - "$ref": "#/components/schemas/IdentifierEntityType" + "type": "string", + "const": "bin", + "title": "Type", + "default": "bin" }, - "attributes": { - "items": { - "$ref": "#/components/schemas/IdentityAttribute" - }, - "type": "array", - "title": "Attributes" + "bin": { + "type": "string", + "minLength": 1, + "title": "Bin" } }, "type": "object", "required": [ - "type", - "attributes" + "bin" ], - "title": "IdentityIdentifierEntity" + "title": "CCBinData" }, - "IdentityNode": { + "ChatMessageEvent": { "properties": { - "primary_email": { + "event_type": { "type": "string", - "title": "Primary Email" + "const": "chat_message", + "title": "Event Type", + "default": "chat_message" }, - "first_name": { + "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" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "First Name" + "title": "Posted At", + "description": "The time the chat message was posted." }, - "last_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" @@ -23540,68 +3838,72 @@ "type": "null" } ], - "title": "Last Name" + "title": "Content", + "description": "The content of the chat message." }, - "type": { - "$ref": "#/components/schemas/ApplicationExposureNodeType", - "readOnly": true + "parent_context": { + "$ref": "#/components/schemas/ParentContext", + "description": "Collection of data about the context of the parent chat message." }, - "id": { - "type": "string", - "title": "Id", - "readOnly": true + "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", - "required": [ - "primary_email", - "first_name", - "last_name", - "type", - "id" - ], - "title": "IdentityNode" + "title": "ChatMessageEventData" }, - "IdentityProfileBanner": { + "Classes": { "properties": { - "uuid": { - "type": "string", - "format": "uuid", - "title": "Uuid" - }, - "email": { + "is_carding": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Email" + "title": "Is Carding", + "description": "Whether the listing is classified as carding." }, - "display_name": { + "is_bypass": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Display Name" + "title": "Is Bypass", + "description": "Whether the listing is classified as a bypass." }, - "account_type": { + "is_ident_fraud": { "anyOf": [ { - "$ref": "#/components/schemas/IdPUserAccountType" + "type": "boolean" }, { "type": "null" } - ] + ], + "title": "Is Ident Fraud", + "description": "Whether the listing is classified as identity fraud." }, - "is_on_premises_sync_enabled": { + "is_doc_fraud": { "anyOf": [ { "type": "boolean" @@ -23610,9 +3912,10 @@ "type": "null" } ], - "title": "Is On Premises Sync Enabled" + "title": "Is Doc Fraud", + "description": "Whether the listing is classified as document fraud." }, - "is_active": { + "is_phishing": { "anyOf": [ { "type": "boolean" @@ -23621,9 +3924,10 @@ "type": "null" } ], - "title": "Is Active" + "title": "Is Phishing", + "description": "Whether the listing is classified as phishing." }, - "vip": { + "is_money_xfer": { "anyOf": [ { "type": "boolean" @@ -23632,158 +3936,101 @@ "type": "null" } ], - "title": "Vip" + "title": "Is Money Xfer", + "description": "Whether the listing is classified as money transfer." }, - "alert_level": { + "is_cashout": { "anyOf": [ { - "$ref": "#/components/schemas/RiskScore" + "type": "boolean" }, { "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" + ], + "title": "Is Cashout", + "description": "Whether the listing is classified as a cashout." }, - "tenant_id": { + "is_virt_currency": { "anyOf": [ { - "type": "integer" + "type": "boolean" }, { "type": "null" } ], - "title": "Tenant Id" - } - }, - "type": "object", - "required": [ - "metadata", - "data", - "content" - ], - "title": "ImportExperimentalEventModel" - }, - "IncludeOptions": { - "type": "string", - "enum": [ - "known_password_id", - "auth_domains", - "urls" - ], - "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" + "title": "Is Virt Currency", + "description": "Whether the listing is classified as a virtual currency transaction." }, - "created_at": { + "is_hacking": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "boolean" }, { "type": "null" } ], - "title": "Created At" + "title": "Is Hacking", + "description": "Whether the listing is classified as hacking activities." }, - "updated_at": { + "is_misc_financial": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "boolean" }, { "type": "null" } ], - "title": "Updated At" + "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" + }, + "ConversationMessage": { + "properties": { + "uid": { + "type": "string", + "title": "Uid" + }, + "message": { + "type": "string", + "title": "Message" }, - "first_seen_at": { + "message_en": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "First Seen At" + "title": "Message En" }, - "last_seen_at": { + "author_name": { + "type": "string", + "title": "Author Name" + }, + "date_time": { "anyOf": [ { "type": "string", @@ -23793,202 +4040,318 @@ "type": "null" } ], - "title": "Last Seen At" + "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": "Name" }, - "confidence": { - "anyOf": [ + "params": { + "oneOf": [ { - "type": "integer" + "$ref": "#/components/schemas/AlertChannelEmailParams" }, { - "type": "null" - } - ], - "title": "Confidence" - }, - "pattern": { - "type": "string", - "title": "Pattern" - }, - "pattern_version": { - "anyOf": [ + "$ref": "#/components/schemas/AlertChannelSlackParams" + }, { - "type": "string" + "$ref": "#/components/schemas/AlertChannelDiscordParams" }, { - "type": "null" - } - ], - "title": "Pattern Version" - }, - "indicator_types": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Indicator Types" - }, - "description": { - "anyOf": [ + "$ref": "#/components/schemas/AlertChannelSplunkParams" + }, { - "type": "string" + "$ref": "#/components/schemas/AlertChannelChannelParams" }, { - "type": "null" - } - ], - "title": "Description" - }, - "valid_from": { - "anyOf": [ + "$ref": "#/components/schemas/AlertChannelLegacySentinelParams" + }, { - "type": "string", - "format": "date-time" + "$ref": "#/components/schemas/AlertChannelSentinelV2Params" }, { - "type": "null" + "$ref": "#/components/schemas/AlertChannelTeamsParams" + }, + { + "$ref": "#/components/schemas/AlertChannelJiraParams" + }, + { + "$ref": "#/components/schemas/AlertChannelServiceNowParams" + }, + { + "$ref": "#/components/schemas/AlertChannelWebhookParams" } ], - "title": "Valid From" + "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" + } + } }, - "valid_until": { + "state": { "anyOf": [ { - "type": "string", - "format": "date-time" + "$ref": "#/components/schemas/AlertChannelState" }, { "type": "null" } - ], - "title": "Valid Until" + ] + } + }, + "type": "object", + "required": [ + "name", + "params" + ], + "title": "CreateAlertChannel" + }, + "CreateAstpCookiesBody": { + "properties": { + "name": { + "type": "string", + "minLength": 1, + "title": "Name", + "description": "The name of the matching policy" }, - "kill_chain_phases": { - "items": { - "$ref": "#/components/schemas/KillChainAPIResponse" - }, - "type": "array", - "title": "Kill Chain Phases" + "type": { + "type": "string", + "const": "ASTP_COOKIES", + "title": "Type" }, - "marking_definitions": { - "items": { - "$ref": "#/components/schemas/MarkingDefinition" - }, - "type": "array", - "title": "Marking Definitions" + "value": { + "$ref": "#/components/schemas/AstpCookiesValue", + "description": "The value of the matching policy in the form of cookie names" } }, "type": "object", "required": [ - "uuid", + "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", - "created_by", - "sources", - "created_at", - "updated_at", - "pattern", - "pattern_version", - "indicator_types", - "description", - "valid_from", - "valid_until", - "kill_chain_phases", - "marking_definitions" + "type", + "value" ], - "title": "IndicatorEntityAPIResponse" + "title": "CreateAstpDomainBody" }, - "IndicatorType": { - "type": "string", - "enum": [ - "URL" + "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": "IndicatorType" + "title": "CreateExcludedKeywordsBody" }, - "InfrastructureEntityAPIResponse": { + "CreateIncludedKeywordsBody": { "properties": { - "uuid": { + "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" + }, + "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" + }, + "Credential": { + "properties": { + "id": { + "type": "integer", + "title": "Id" + }, + "identity_name": { "type": "string", - "title": "Uuid" + "title": "Identity Name" }, - "type": { - "$ref": "#/components/schemas/EntityType" + "domain": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Domain" }, - "name": { + "source_id": { "type": "string", - "title": "Name" + "title": "Source Id" }, - "created_by": { + "imported_at": { "type": "string", - "title": "Created By" - }, - "sources": { - "items": { - "$ref": "#/components/schemas/CTIEntitySourceAPIResponse" - }, - "type": "array", - "title": "Sources" + "title": "Imported At" }, - "created_at": { + "hash": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Created At" + "title": "Hash" }, - "updated_at": { + "hash_type": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Updated At" + "title": "Hash Type" }, - "first_seen_at": { + "source": { "anyOf": [ { - "type": "string", - "format": "date-time" + "$ref": "#/components/schemas/SourceV2" }, { "type": "null" } - ], - "title": "First Seen At" + ] }, - "last_seen_at": { + "known_password_id": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "integer" }, { "type": "null" } ], - "title": "Last Seen At" + "title": "Known Password Id" }, - "confidence": { + "credential_hash": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Confidence" + "title": "Credential Hash" }, - "description": { + "event_uid": { "anyOf": [ { "type": "string" @@ -23997,414 +4360,507 @@ "type": "null" } ], - "title": "Description" + "title": "Event Uid" }, - "infrastructure_types": { + "auth_domains": { "items": { "type": "string" }, "type": "array", - "title": "Infrastructure Types" - }, - "kill_chain_phases": { - "items": { - "$ref": "#/components/schemas/KillChainAPIResponse" - }, - "type": "array", - "title": "Kill Chain Phases" + "title": "Auth Domains" }, - "marking_definitions": { + "urls": { "items": { - "$ref": "#/components/schemas/MarkingDefinition" + "type": "string" }, "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" - }, - "InvalidCredentialEvent": { - "properties": { - "event_type": { - "type": "string", - "const": "invalid_credential", - "title": "Event Type", - "default": "invalid_credential" - }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" - }, - "data": { - "$ref": "#/components/schemas/CredentialEventData" - } - }, - "type": "object", - "required": [ - "metadata", - "data" - ], - "title": "Invalid Credential" - }, - "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" + "title": "Urls" } }, "type": "object", "required": [ - "keyword" + "id", + "identity_name", + "domain", + "source_id", + "imported_at", + "hash", + "hash_type", + "source", + "known_password_id", + "credential_hash", + "event_uid" ], - "title": "KeywordData" + "title": "Credential" }, - "KeywordQuery": { + "CredentialActionBody": { "properties": { "type": { - "type": "string", - "const": "keyword", - "title": "Type" - }, - "keyword": { - "type": "string", - "title": "Keyword" + "$ref": "#/components/schemas/LeakedCredentialsBulkActionType" } }, "type": "object", "required": [ - "type", - "keyword" + "type" ], - "title": "KeywordQuery" + "title": "CredentialActionBody" }, - "KeywordsValue": { + "CredentialActionRequestBody": { "properties": { - "keywords": { + "targets": { "items": { - "type": "string" + "$ref": "#/components/schemas/CredentialActionTarget" }, "type": "array", - "title": "Keywords" + "maxItems": 100, + "title": "Targets" + }, + "action": { + "$ref": "#/components/schemas/CredentialActionBody" } }, "type": "object", "required": [ - "keywords" - ], - "title": "KeywordsValue" - }, - "Language": { - "type": "string", - "enum": [ - "en", - "fr" + "targets", + "action" ], - "title": "Language" + "title": "CredentialActionRequestBody" }, - "LeakedCredentialEvent": { + "CredentialActionTarget": { "properties": { - "event_type": { + "credential_hash": { "type": "string", - "const": "leaked_credential", - "title": "Event Type", - "default": "leaked_credential" - }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" - }, - "data": { - "$ref": "#/components/schemas/LeakedCredentialEventData" + "title": "Credential Hash" } }, "type": "object", "required": [ - "metadata", - "data" + "credential_hash" ], - "title": "Leaked Credential" + "title": "CredentialActionTarget" }, - "LeakedCredentialEventData": { + "CredentialEventData": { "properties": { "identity_name": { "type": "string", "title": "Identity Name", - "description": "The email or username associated with the leaked credential." - }, - "imported_at": { - "type": "string", - "format": "date-time", - "title": "Imported At", - "description": "When the credential was imported into Flare." - }, - "password": { - "type": "string", - "title": "Password", - "description": "The leaked password, or its hash if not available in cleartext." + "description": "The email or username associated with the credential." }, - "source": { - "$ref": "#/components/schemas/LeakedCredentialEventSource", - "description": "The source the credential was leaked from." - } - }, - "type": "object", - "required": [ - "identity_name", - "imported_at", - "password", - "source" - ], - "title": "LeakedCredentialEventData" - }, - "LeakedCredentialEventSource": { - "properties": { - "id": { + "credential_hash": { "type": "string", - "title": "Id", - "description": "The identifier of the leak source category." + "title": "Credential Hash", + "description": "A hash uniquely identifying the credential." }, - "name": { + "tenant_integration_id": { "type": "string", - "title": "Name", - "description": "The name of the leak source category." + "title": "Tenant Integration Id", + "description": "The UUID of the tenant's IdP integration that validated the credential." } }, "type": "object", "required": [ - "id", - "name" - ], - "title": "LeakedCredentialEventSource" - }, - "LeakedCredentialsBulkActionType": { - "type": "string", - "enum": [ - "remediate", - "unremediate", - "ignore", - "unignore" + "identity_name", + "credential_hash", + "tenant_integration_id" ], - "title": "LeakedCredentialsBulkActionType" + "title": "CredentialEventData" }, - "ListingEvent": { + "CredentialsData": { "properties": { - "event_type": { + "type": { "type": "string", - "const": "listing", - "title": "Event Type", - "default": "listing" + "const": "credentials", + "title": "Type", + "default": "credentials" }, - "data": { - "$ref": "#/components/schemas/ListingEventData" + "username": { + "type": "string", + "minLength": 1, + "title": "Username" }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" + "password": { + "type": "string", + "minLength": 1, + "title": "Password" } }, "type": "object", "required": [ - "data", - "metadata" + "username", + "password" ], - "title": "Listing" + "title": "CredentialsData" }, - "ListingEventData": { + "CredentialsDateFilter": { "properties": { - "url": { + "gte": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Url", - "description": "The URL to the listing." + "title": "Gte" }, - "title": { + "lte": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Title", - "description": "The title of the listing." + "title": "Lte" + } + }, + "type": "object", + "title": "CredentialsDateFilter" + }, + "CredentialsQuery": { + "properties": { + "type": { + "type": "string", + "const": "credentials", + "title": "Type" }, - "content": { - "anyOf": [ + "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": [ { - "type": "string" + "$ref": "#/components/schemas/DomainQuery" }, { - "type": "null" - } - ], - "title": "Content", - "description": "The content within the listing." - }, - "currency": { - "anyOf": [ - { - "type": "string" + "$ref": "#/components/schemas/EmailQuery" }, { - "type": "null" - } - ], - "title": "Currency", - "description": "The currency expected in the listing." - }, - "escrow": { - "anyOf": [ + "$ref": "#/components/schemas/KeywordQuery" + }, { - "type": "boolean" + "$ref": "#/components/schemas/SecretQuery" }, { - "type": "null" + "$ref": "#/components/schemas/AuthDomainQuery" } ], - "title": "Escrow", - "description": "Whether the listing requires escrow." + "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" + } + } }, - "price": { + "filters": { + "$ref": "#/components/schemas/CredentialsQueryFilters" + }, + "from": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Price", - "description": "The price of the listing." + "title": "From" }, - "ship_to": { + "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" + }, + "DomainAssetEnrichment": { + "properties": { + "type": { + "$ref": "#/components/schemas/AssetEnrichmentType" + }, + "sources": { "items": { "type": "string" }, "type": "array", - "title": "Ship To", - "description": "The countries eligible for shipping.", - "default": [] + "title": "Sources" }, - "ship_from": { + "entries": { "items": { "type": "string" }, "type": "array", - "title": "Ship From", - "description": "The countries eligible for shipping.", - "default": [] + "title": "Entries" }, - "stock_count": { + "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": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Stock Count", - "description": "The quantity of the items or service in stock." + "title": "Title" + } + }, + "type": "object", + "required": [ + "type", + "sources", + "entries", + "tags", + "statuses", + "external_links", + "title" + ], + "title": "DomainAssetEnrichment" + }, + "DomainData": { + "properties": { + "type": { + "type": "string", + "const": "domain", + "title": "Type", + "default": "domain" }, - "actor": { - "$ref": "#/components/schemas/pyro__findings__listing__datamodels__ListingEventData__Actor", - "description": "Data about the seller." + "fqdn": { + "type": "string", + "minLength": 1, + "title": "Fqdn" + } + }, + "type": "object", + "required": [ + "fqdn" + ], + "title": "DomainData" + }, + "DomainMatchMode": { + "type": "string", + "enum": [ + "email_domain_only", + "auth_domain_and_email_domain", + "auth_domain_only" + ], + "title": "DomainMatchMode" + }, + "DomainQuery": { + "properties": { + "type": { + "type": "string", + "const": "domain", + "title": "Type" }, - "classification": { - "$ref": "#/components/schemas/Classification", - "description": "Data about the possible classifications of the listing." + "fqdn": { + "type": "string", + "title": "Fqdn" + } + }, + "type": "object", + "required": [ + "type", + "fqdn" + ], + "title": "DomainQuery" + }, + "DomainStatus": { + "type": "string", + "enum": [ + "found", + "resolves", + "reachable" + ], + "title": "DomainStatus" + }, + "EmailData": { + "properties": { + "type": { + "type": "string", + "const": "email", + "title": "Type", + "default": "email" }, - "context": { - "$ref": "#/components/schemas/pyro__findings__listing__datamodels__ListingEventData__Context", - "description": "Data offering context to the listing." + "email": { + "type": "string", + "format": "email", + "title": "Email" } }, "type": "object", - "title": "ListingEventData" + "required": [ + "email" + ], + "title": "EmailData" }, - "LookalikeDomainEvent": { + "EmailQuery": { "properties": { - "event_type": { + "type": { "type": "string", - "const": "lookalike", - "title": "Event Type", - "default": "lookalike" + "const": "email", + "title": "Type" }, - "data": { - "$ref": "#/components/schemas/LookalikeDomainEventData" + "email": { + "type": "string", + "title": "Email" + } + }, + "type": "object", + "required": [ + "type", + "email" + ], + "title": "EmailQuery" + }, + "EmptyFireworkEvent": { + "properties": { + "event_type": { + "$ref": "#/components/schemas/ActivityModelName" }, "metadata": { "$ref": "#/components/schemas/EventMetadata" + }, + "data": { + "additionalProperties": true, + "type": "object", + "title": "Data" } }, "type": "object", "required": [ - "data", + "event_type", "metadata" ], - "title": "Lookalike Domain" + "title": "EmptyFireworkEvent" }, - "LookalikeDomainEventData": { + "EventAction": { "properties": { - "domain": { + "type": { "type": "string", - "title": "Domain", - "description": "The domain of the lookalike domain." + "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" }, - "registered_at": { + "action": { + "$ref": "#/components/schemas/EventAction" + } + }, + "type": "object", + "required": [ + "action" + ], + "title": "EventActionsBody" + }, + "EventMetadata": { + "properties": { + "estimated_created_at": { "anyOf": [ { "type": "string", @@ -24414,125 +4870,140 @@ "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" + "title": "Estimated Created At" }, - "feed": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Feed", - "description": "The feed where the lookalike domain was found" + "flare_url": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Flare Url" }, - "cert_data": { + "matched_at": { "anyOf": [ { - "additionalProperties": true, - "type": "object" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Cert Data", - "description": "The certificate data of the lookalike domain." + "title": "Matched At" }, - "subject": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Subject", - "description": "The subject of the certificate of the lookalike domain." + "severity": { + "$ref": "#/components/schemas/EventSeverity" }, - "issuer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Issuer", - "description": "The issuer of the certificate of the lookalike domain." + "uid": { + "type": "string", + "title": "Uid" } }, "type": "object", "required": [ - "domain", - "registered_at", - "identifier_domains", - "feed", - "cert_data", - "subject", - "issuer" + "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": "LookalikeDomainEventData" + "title": "ExpandableField" }, - "LuceneValue": { + "ExternalIdData": { "properties": { - "query": { + "type": { "type": "string", - "title": "Query", - "description": "The lucene query of the matching policy" + "const": "external_id", + "title": "Type", + "default": "external_id" + }, + "id": { + "type": "string", + "minLength": 1, + "title": "Id" + }, + "source": { + "type": "string", + "minLength": 1, + "title": "Source" } }, "type": "object", "required": [ - "query" + "id", + "source" ], - "title": "LuceneValue" + "title": "ExternalIdData" }, - "MalwareEntityAPIResponse": { + "FeedConfiguration": { "properties": { - "uuid": { - "type": "string", - "title": "Uuid" - }, - "type": { - "$ref": "#/components/schemas/EntityType" - }, - "name": { - "type": "string", - "title": "Name" + "search_types": { + "items": { + "$ref": "#/components/schemas/SearchType" + }, + "type": "array", + "title": "Search Types" }, - "created_by": { - "type": "string", - "title": "Created By" + "experimental_search_types": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Experimental Search Types" }, - "sources": { + "risks": { "items": { - "$ref": "#/components/schemas/CTIEntitySourceAPIResponse" + "$ref": "#/components/schemas/RiskScore" }, "type": "array", - "title": "Sources" + "title": "Risks" }, - "created_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", @@ -24542,9 +5013,9 @@ "type": "null" } ], - "title": "Created At" + "title": "Gt" }, - "updated_at": { + "gte": { "anyOf": [ { "type": "string", @@ -24554,9 +5025,9 @@ "type": "null" } ], - "title": "Updated At" + "title": "Gte" }, - "first_seen_at": { + "lt": { "anyOf": [ { "type": "string", @@ -24566,9 +5037,9 @@ "type": "null" } ], - "title": "First Seen At" + "title": "Lt" }, - "last_seen_at": { + "lte": { "anyOf": [ { "type": "string", @@ -24578,9 +5049,18 @@ "type": "null" } ], - "title": "Last Seen At" + "title": "Lte" + } + }, + "type": "object", + "title": "FeedDateFilter" + }, + "FeedDefinition": { + "properties": { + "type": { + "$ref": "#/components/schemas/FeedType" }, - "confidence": { + "id": { "anyOf": [ { "type": "integer" @@ -24589,72 +5069,173 @@ "type": "null" } ], - "title": "Confidence" - }, - "description": { + "title": "Id" + } + }, + "type": "object", + "required": [ + "type" + ], + "title": "FeedDefinition" + }, + "FeedFilters": { + "properties": { + "severity": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/Severity" }, { - "type": "null" + "items": { + "$ref": "#/components/schemas/Severity" + }, + "type": "array" } ], - "title": "Description" + "title": "Severity" }, - "malware_types": { + "type": { "items": { - "type": "string" + "$ref": "#/components/schemas/SearchType" }, "type": "array", - "title": "Malware Types" + "title": "Type" + }, + "estimated_created_at": { + "$ref": "#/components/schemas/FeedDateFilter" }, - "kill_chain_phases": { + "materialized_at": { + "$ref": "#/components/schemas/FeedDateFilter" + }, + "tags": { "items": { - "$ref": "#/components/schemas/KillChainAPIResponse" + "type": "string" }, "type": "array", - "title": "Kill Chain Phases" + "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" }, - "marking_definitions": { + "identifiers": { "items": { - "$ref": "#/components/schemas/MarkingDefinition" + "$ref": "#/components/schemas/FeedItemIdentifier" }, "type": "array", - "title": "Marking Definitions" + "title": "Identifiers" + }, + "highlights": { + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + }, + "type": "object", + "title": "Highlights" } }, "type": "object", "required": [ - "uuid", - "type", - "name", - "created_by", - "sources", - "created_at", - "updated_at", - "description", - "malware_types", - "kill_chain_phases", - "marking_definitions" + "metadata" ], - "title": "MalwareEntityAPIResponse" + "title": "FeedItem" }, - "MalwareInformation": { + "FeedItemIdentifier": { "properties": { - "malware_family": { + "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" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Malware Family", - "description": "The malware family used for device infection." + "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" + } + ] }, - "build_id": { + "notes": { "anyOf": [ { "type": "string" @@ -24663,22 +5244,28 @@ "type": "null" } ], - "title": "Build Id", - "description": "The build ID of the malware used for device infection." + "title": "Notes" }, - "file_location": { + "tags": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Tags" + }, + "remediated_at": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "File Location", - "description": "The file location of the malware used for device infection." + "title": "Remediated At" }, - "infected_at": { + "ignored_at": { "anyOf": [ { "type": "string", @@ -24688,452 +5275,506 @@ "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" - }, - "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" + "title": "Ignored At" } }, "type": "object", - "required": [ - "matching_policy", - "assigned_at", - "clean_past_events" - ], - "title": "MatchingPolicyAssignmentPayload" + "title": "FeedItemTenantMetadata" }, - "MatchingPolicyPayload": { + "FeedItemTenantMetadataSeverity": { "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" + "original": { + "$ref": "#/components/schemas/Severity" }, - "last_updated_at": { - "type": "string", - "format": "date-time", - "title": "Last Updated At", - "description": "The date and time the matching policy was last updated" + "override": { + "$ref": "#/components/schemas/Severity" } }, "type": "object", "required": [ - "uuid", - "name", - "policy_type", - "value", - "created_at", - "last_updated_at" + "original", + "override" ], - "title": "MatchingPolicyPayload" + "title": "FeedItemTenantMetadataSeverity" }, - "MatchingPolicyType": { + "FeedOrder": { "type": "string", "enum": [ - "INCLUDED_KEYWORDS", - "EXCLUDED_KEYWORDS", - "LUCENE_QUERY", - "ASTP_COOKIES", - "ASTP_DOMAIN" + "asc", + "desc" ], - "title": "MatchingPolicyType" + "title": "FeedOrder" }, - "MitigatedCredentialEvent": { + "FeedRequestBody": { "properties": { - "event_type": { - "type": "string", - "const": "mitigated_credential", - "title": "Event Type", - "default": "mitigated_credential" - }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" + "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" + } + ] }, - "data": { - "$ref": "#/components/schemas/MitigatedCredentialEventData" - } - }, - "type": "object", - "required": [ - "metadata", - "data" - ], - "title": "Mitigated Credential" - }, - "MitigatedCredentialEventData": { - "properties": { - "identity_name": { - "type": "string", - "title": "Identity Name", - "description": "The email or username associated with the credential." + "filters": { + "$ref": "#/components/schemas/FeedFilters" }, - "credential_hash": { - "type": "string", - "title": "Credential Hash", - "description": "A hash uniquely identifying the credential." + "order": { + "$ref": "#/components/schemas/FeedOrder", + "default": "desc" }, - "tenant_integration_id": { - "type": "string", - "title": "Tenant Integration Id", - "description": "The UUID of the tenant's IdP integration that validated the credential." + "from": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "From" }, - "mitigation_action": { - "type": "string", - "title": "Mitigation Action", - "description": "The action the tenant's IdP integration took to mitigate the credential" + "size": { + "type": "integer", + "maximum": 10.0, + "exclusiveMinimum": 0.0, + "title": "Size", + "default": 10 } - }, - "type": "object", - "required": [ - "identity_name", - "credential_hash", - "tenant_integration_id", - "mitigation_action" + }, + "type": "object", + "title": "FeedRequestBody" + }, + "FeedType": { + "type": "string", + "enum": [ + "tenant", + "identifier", + "group" ], - "title": "MitigatedCredentialEventData" + "title": "FeedType" }, - "NameBody": { + "FilterSeverities": { "properties": { - "first_name": { - "type": "string", - "title": "First Name", - "default": "" - }, - "last_name": { - "type": "string", - "title": "Last Name", - "default": "" + "severities": { + "items": { + "$ref": "#/components/schemas/FilterSeverity" + }, + "type": "array", + "title": "Severities" } }, "type": "object", - "title": "NameBody" + "title": "FilterSeverities" }, - "NameData": { + "FilterSeverity": { "properties": { - "type": { + "value": { "type": "string", - "const": "name", - "title": "Type", - "default": "name" + "title": "Value" }, - "first_name": { + "label": { "type": "string", - "title": "First Name" + "title": "Label" }, - "last_name": { + "color": { "type": "string", - "title": "Last Name" - }, - "is_strict": { - "type": "boolean", - "title": "Is Strict" + "title": "Color" } }, "type": "object", "required": [ - "first_name", - "last_name", - "is_strict" + "value", + "label", + "color" ], - "title": "NameData" + "title": "FilterSeverity" }, - "NameQuery": { + "FilterSourceType": { "properties": { - "type": { - "type": "string", - "const": "name", - "title": "Type" - }, - "first_name": { + "value": { "type": "string", - "title": "First Name" + "title": "Value" }, - "last_name": { + "label": { "type": "string", - "title": "Last Name" - }, - "is_strict": { - "type": "boolean", - "title": "Is Strict" + "title": "Label" } }, "type": "object", "required": [ - "type", - "first_name", - "last_name", - "is_strict" - ], - "title": "NameQuery" - }, - "OrderType": { - "type": "string", - "enum": [ - "asc", - "desc" + "value", + "label" ], - "title": "OrderType" + "title": "FilterSourceType" }, - "OrganizationBanner": { + "FilterSourceTypeCategory": { "properties": { - "organization_id": { - "type": "integer", - "title": "Organization Id" - }, - "organization_name": { + "value": { "type": "string", - "title": "Organization Name" + "title": "Value" }, - "message": { + "label": { "type": "string", - "title": "Message" + "title": "Label" }, - "variant": { - "$ref": "#/components/schemas/BannerVariant" + "types": { + "items": { + "$ref": "#/components/schemas/FilterSourceType" + }, + "type": "array", + "title": "Types" } }, "type": "object", "required": [ - "organization_id", - "organization_name", - "message", - "variant" + "value", + "label" ], - "title": "OrganizationBanner" + "title": "FilterSourceTypeCategory" }, - "OrganizationEventStatsResponse": { + "FilterSourceTypes": { "properties": { - "organization_id": { - "type": "integer", - "title": "Organization Id" + "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" }, - "total_count": { - "type": "integer", - "title": "Total Count" + "data": { + "$ref": "#/components/schemas/FinancialEventData" }, - "identifier_ratio": { - "type": "number", - "title": "Identifier Ratio" + "metadata": { + "$ref": "#/components/schemas/EventMetadata" } }, "type": "object", "required": [ - "organization_id", - "total_count", - "identifier_ratio" + "data", + "metadata" ], - "title": "OrganizationEventStatsResponse" + "title": "Credit Card" }, - "OrganizationLogoResponse": { + "FinancialEventData": { "properties": { - "url": { + "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": "string" + "type": "boolean" }, { "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." + "title": "Has Mother Maiden Name", + "description": "Whether the mother's maiden name was included in the leaked data." }, - "actor_intent": { + "has_phone": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "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" + "title": "Has Phone", + "description": "Whether the phone number was included in the leaked data." }, - "next": { + "has_pin": { "anyOf": [ { - "type": "integer" + "type": "boolean" }, { "type": "null" } ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PagedCookieConfigurations" - }, - "PaginatedResult_int_str_": { - "properties": { - "item": { - "type": "integer", - "title": "Item" + "title": "Has Pin", + "description": "Whether the card's PIN was included in the leaked data." }, - "next": { + "has_ssn": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "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" + "title": "Has Ssn", + "description": "Whether the card owner's SSN was included in the leaked data." }, - "next": { + "has_track_1": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Next" + "title": "Has Track 1", + "description": "Whether the card's track 1 (magnetic stripe data) was included in the leaked data." }, - "total_count": { + "has_vbv": { "anyOf": [ { - "type": "integer" + "type": "boolean" }, { "type": "null" } ], - "title": "Total Count" + "title": "Has Vbv", + "description": "Whether the card's VBV (Verified by Visa) data was included in the leaked data." } }, "type": "object", "required": [ - "items", - "next" + "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": "PaginatedResultsWithTotalCount[AuditEventItemResponse, str]" + "title": "FinancialEventData" }, - "PaginatedResultsWithTotalCount_DomainBrowserItemResponse_str_": { + "ForumPostData": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/DomainBrowserItemResponse" - }, - "type": "array", - "title": "Items" + "actor": { + "$ref": "#/components/schemas/pyro__findings__forum_posts__datamodels__ForumPostData__Actor", + "description": "Details about the author of the forum post." }, - "next": { + "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" @@ -25142,37 +5783,57 @@ "type": "null" } ], - "title": "Next" + "title": "Content", + "description": "Content of the forum post." }, - "total_count": { + "url": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Total Count" + "title": "Url", + "description": "URL to the forum post." } }, "type": "object", "required": [ - "items", - "next" + "actor", + "context", + "posted_at", + "content", + "url" ], - "title": "PaginatedResultsWithTotalCount[DomainBrowserItemResponse, str]" + "title": "ForumPostData" }, - "PaginatedResultsWithTotalCount_IdentityBrowserItemResponse_str_": { + "ForumPostEvent": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/IdentityBrowserItemResponse" - }, - "type": "array", - "title": "Items" + "event_type": { + "type": "string", + "const": "forum_post", + "title": "Event Type", + "default": "forum_post" }, - "next": { + "data": { + "$ref": "#/components/schemas/ForumPostData" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + } + }, + "type": "object", + "required": [ + "data", + "metadata" + ], + "title": "Forum Post" + }, + "ForwardInfo": { + "properties": { + "forwarded_from": { "anyOf": [ { "type": "string" @@ -25181,9 +5842,22 @@ "type": "null" } ], - "title": "Next" + "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." }, - "total_count": { + "forwarded_from_chat_id": { "anyOf": [ { "type": "integer" @@ -25192,26 +5866,10 @@ "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" + "title": "Forwarded From Chat Id", + "description": "The ID of the chat the message is being forwarded from." }, - "next": { + "forwarded_from_conversation_id": { "anyOf": [ { "type": "string" @@ -25220,9 +5878,10 @@ "type": "null" } ], - "title": "Next" + "title": "Forwarded From Conversation Id", + "description": "The conversation ID the message is being forwarded from." }, - "total_count": { + "forwarded_from_user_id": { "anyOf": [ { "type": "integer" @@ -25231,166 +5890,191 @@ "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" + "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." }, - "next": { + "forwarded_message_time": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Next" + "title": "Forwarded Message Time", + "description": "The time the message was forwarded." } }, "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[ASTPCookiePayload, str]" + "title": "ForwardInfo" }, - "PaginatedResults_Alert_str_": { + "GithubRepositoryData": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/Alert" - }, - "type": "array", - "title": "Items" + "type": { + "type": "string", + "const": "github_repository", + "title": "Type", + "default": "github_repository" }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" + "repo_name": { + "type": "string", + "minLength": 1, + "title": "Repo Name" + }, + "repo_owner": { + "type": "string", + "minLength": 1, + "title": "Repo Owner" } }, "type": "object", "required": [ - "items", - "next" + "repo_name", + "repo_owner" ], - "title": "PaginatedResults[Alert, str]" + "title": "GithubRepositoryData" }, - "PaginatedResults_CTIEntityRelationshipResponse_str_": { + "GithubRepositoryQuery": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/CTIEntityRelationshipResponse" - }, - "type": "array", - "title": "Items" + "type": { + "type": "string", + "const": "github_repository", + "title": "Type" }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" + "repo_owner": { + "type": "string", + "title": "Repo Owner" + }, + "repo_name": { + "type": "string", + "title": "Repo Name" } }, "type": "object", "required": [ - "items", - "next" + "type", + "repo_owner", + "repo_name" ], - "title": "PaginatedResults[CTIEntityRelationshipResponse, str]" + "title": "GithubRepositoryQuery" }, - "PaginatedResults_CredentialValidationReponse_str_": { + "GlobalFeedItem": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/CredentialValidationReponse" - }, - "type": "array", - "title": "Items" + "metadata": { + "$ref": "#/components/schemas/FeedItemMetadata" }, - "next": { - "anyOf": [ - { + "tenant_metadata": { + "$ref": "#/components/schemas/FeedItemTenantMetadata" + }, + "highlights": { + "additionalProperties": { + "items": { "type": "string" }, - { - "type": "null" - } - ], - "title": "Next" + "type": "array" + }, + "type": "object", + "title": "Highlights" } }, "type": "object", "required": [ - "items", - "next" + "metadata" ], - "title": "PaginatedResults[CredentialValidationReponse, str]" + "title": "GlobalFeedItem" }, - "PaginatedResults_Credential_str_": { + "GlobalSearchRequestBody": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/Credential" - }, - "type": "array", - "title": "Items" - }, - "next": { - "anyOf": [ + "query": { + "oneOf": [ { - "type": "string" + "$ref": "#/components/schemas/GithubRepositoryQuery" }, { - "type": "null" + "$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": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[Credential, str]" - }, - "PaginatedResults_FeedItem_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/FeedItem" - }, - "type": "array", - "title": "Items" + "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" + } + } }, - "next": { + "filters": { + "$ref": "#/components/schemas/FeedFilters" + }, + "order": { + "$ref": "#/components/schemas/FeedOrder", + "default": "desc" + }, + "from": { "anyOf": [ { "type": "string" @@ -25399,54 +6083,49 @@ "type": "null" } ], - "title": "Next" + "title": "From" + }, + "size": { + "type": "integer", + "maximum": 10.0, + "exclusiveMinimum": 0.0, + "title": "Size", + "default": 10 } }, "type": "object", "required": [ - "items", - "next" + "query" ], - "title": "PaginatedResults[FeedItem, str]" + "title": "GlobalSearchRequestBody" }, - "PaginatedResults_GlobalFeedItem_str_": { + "HTTPValidationError": { "properties": { - "items": { + "detail": { "items": { - "$ref": "#/components/schemas/GlobalFeedItem" + "$ref": "#/components/schemas/ValidationError" }, "type": "array", - "title": "Items" - }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" + "title": "Detail" } }, "type": "object", - "required": [ - "items", - "next" + "title": "HTTPValidationError" + }, + "HubspotLifecycleStage": { + "type": "string", + "enum": [ + "1281177943" ], - "title": "PaginatedResults[GlobalFeedItem, str]" + "title": "HubspotLifecycleStage" }, - "PaginatedResults_IdentifierRelation_str_": { + "HubspotWebhookFlareSyncEvent": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/IdentifierRelation" - }, - "type": "array", - "title": "Items" + "hubspot_id": { + "type": "integer", + "title": "Hubspot Id" }, - "next": { + "domain": { "anyOf": [ { "type": "string" @@ -25455,26 +6134,9 @@ "type": "null" } ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[IdentifierRelation, str]" - }, - "PaginatedResults_Identifier_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/Identifier" - }, - "type": "array", - "title": "Items" + "title": "Domain" }, - "next": { + "name": { "anyOf": [ { "type": "string" @@ -25483,503 +6145,391 @@ "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" + "title": "Name" }, - "next": { + "organization_id": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "integer" }, { "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" + "title": "Organization Id" }, - "next": { + "lifecycle_stage": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/HubspotLifecycleStage" }, { "type": "null" } - ], - "title": "Next" + ] + }, + "merged_object_ids": { + "items": { + "type": "integer" + }, + "type": "array", + "title": "Merged Object Ids", + "default": [] } }, "type": "object", "required": [ - "items", - "next" + "hubspot_id" ], - "title": "PaginatedResults[MatchingPolicyPayload, str]" + "title": "HubspotWebhookFlareSyncEvent" }, - "PaginatedResults_PartialAlertChannel_str_": { + "HubspotWebhookFlareSyncTenantEvent": { "properties": { - "items": { + "hubspot_company_id": { + "type": "integer", + "title": "Hubspot Company Id" + }, + "hubspot_tenant_id": { + "type": "integer", + "title": "Hubspot Tenant Id" + }, + "merged_object_ids": { "items": { - "$ref": "#/components/schemas/PartialAlertChannel" + "type": "integer" }, "type": "array", - "title": "Items" + "title": "Merged Object Ids", + "default": [] }, - "next": { + "flare_tenant_name": { + "type": "string", + "title": "Flare Tenant Name" + }, + "organization_id": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[PartialAlertChannel, str]" - }, - "PaginatedResults_PolicyAssignedIdentifierPayload_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/PolicyAssignedIdentifierPayload" - }, - "type": "array", - "title": "Items" + "title": "Organization Id" }, - "next": { + "tenant_id": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Next" + "title": "Tenant Id" } }, "type": "object", "required": [ - "items", - "next" + "hubspot_company_id", + "hubspot_tenant_id", + "flare_tenant_name" ], - "title": "PaginatedResults[PolicyAssignedIdentifierPayload, str]" + "title": "HubspotWebhookFlareSyncTenantEvent" }, - "PaginatedResults_PortfolioItemResponse_str_": { + "IPData": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/PortfolioItemResponse" - }, - "type": "array", - "title": "Items" + "type": { + "type": "string", + "const": "ip", + "title": "Type", + "default": "ip" }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" + "ip": { + "type": "string", + "minLength": 1, + "title": "Ip" } }, "type": "object", "required": [ - "items", - "next" + "ip" ], - "title": "PaginatedResults[PortfolioItemResponse, str]" + "title": "IPData" }, - "PaginatedResults_PublicIdentifierResponse_str_": { + "Identifier": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/PublicIdentifierResponse" - }, - "type": "array", - "title": "Items" + "id": { + "type": "integer", + "title": "Id" }, - "next": { - "anyOf": [ + "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" + }, { - "type": "string" + "$ref": "#/components/schemas/RansomLeakData" }, { - "type": "null" - } - ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[PublicIdentifierResponse, str]" - }, - "PaginatedResults_PydanticThreatFlowReport_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/PublicReport" - }, - "type": "array", - "title": "Items" - }, - "next": { - "anyOf": [ + "$ref": "#/components/schemas/AddressData" + }, { - "type": "string" + "$ref": "#/components/schemas/BirthYearData" }, { - "type": "null" - } - ], - "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" - }, - "next": { - "anyOf": [ + "$ref": "#/components/schemas/RoleData" + }, { - "type": "string" + "$ref": "#/components/schemas/PhoneNumberData" }, { - "type": "null" + "$ref": "#/components/schemas/ExternalIdData" } ], - "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": "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" + } + } }, - "next": { + "collection": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/IdentifierCollectionGroupId" }, { - "type": "null" + "$ref": "#/components/schemas/IdentifierCollectionGroupType" } ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[ReportData, str]" - }, - "PaginatedResults_ReportGroupData_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/ReportGroupData" - }, - "type": "array", - "title": "Items" + "title": "Collection" }, - "next": { + "urn": { + "type": "string", + "title": "Urn" + }, + "entity": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/IdentityIdentifierEntity" }, { "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": { + "enrichments": { "anyOf": [ { - "type": "string" + "items": { + "$ref": "#/components/schemas/DomainAssetEnrichment" + }, + "type": "array" }, { "type": "null" } ], - "title": "Next" + "title": "Enrichments" + }, + "metadata": { + "$ref": "#/components/schemas/IdentifierMetadata" + }, + "state": { + "$ref": "#/components/schemas/IdentifierState" } }, "type": "object", "required": [ - "items", - "next" + "id", + "name", + "tenant_id", + "type", + "feed", + "feed_config", + "asset_uuid", + "data", + "collection", + "urn", + "entity", + "enrichments", + "metadata", + "state" ], - "title": "PaginatedResults[ReportSectionPayload, str]" + "title": "Identifier" }, - "PaginatedResults_Report_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/Report" - }, - "type": "array", - "title": "Items" - }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" + "IdentifierAuthorizationRequestStatus": { + "type": "string", + "enum": [ + "pending", + "rejected" ], - "title": "PaginatedResults[Report, str]" + "title": "IdentifierAuthorizationRequestStatus" }, - "PaginatedResults_SandboxSampleSubmission_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/SandboxSampleSubmission" - }, - "type": "array", - "title": "Items" - }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" + "IdentifierAuthorizationStatus": { + "type": "string", + "enum": [ + "pending", + "rejected", + "authorized" ], - "title": "PaginatedResults[SandboxSampleSubmission, str]" + "title": "IdentifierAuthorizationStatus" }, - "PaginatedResults_SecretItem_str_": { + "IdentifierCollectionGroupId": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/SecretItem" - }, - "type": "array", - "title": "Items" + "type": { + "type": "string", + "const": "group_id", + "title": "Type" }, - "next": { + "group_id": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Next" + "title": "Group Id" } }, "type": "object", "required": [ - "items", - "next" + "type", + "group_id" ], - "title": "PaginatedResults[SecretItem, str]" + "title": "IdentifierCollectionGroupId" }, - "PaginatedResults_SourceWithTenantCount_str_": { + "IdentifierCollectionGroupType": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/SourceWithTenantCount" - }, - "type": "array", - "title": "Items" + "type": { + "type": "string", + "const": "group_type", + "title": "Type" }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" + "group_type": { + "$ref": "#/components/schemas/IdentifierGroupType" } }, "type": "object", "required": [ - "items", - "next" + "type", + "group_type" ], - "title": "PaginatedResults[SourceWithTenantCount, str]" + "title": "IdentifierCollectionGroupType" }, - "PaginatedResults_StealerLogCookie_str_": { + "IdentifierEnrichments": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/StealerLogCookie" - }, - "type": "array", - "title": "Items" - }, - "next": { + "domain_reachable_at": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[StealerLogCookie, str]" - }, - "PaginatedResults_StealerLogCredential_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/StealerLogCredential" - }, - "type": "array", - "title": "Items" + "title": "Domain Reachable At" }, - "next": { + "domain_resolves_at": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[StealerLogCredential, str]" - }, - "PaginatedResults_TenantFlareCommunityUser_int_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/TenantFlareCommunityUser" - }, - "type": "array", - "title": "Items" + "title": "Domain Resolves At" }, - "next": { + "usage_count": { + "type": "integer", + "title": "Usage Count" + }, + "event_count": { "anyOf": [ { "type": "integer" @@ -25988,344 +6538,306 @@ "type": "null" } ], - "title": "Next" - } - }, - "type": "object", - "required": [ - "items", - "next" - ], - "title": "PaginatedResults[TenantFlareCommunityUser, int]" - }, - "PaginatedResults_TenantIntegrationItem_str_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/TenantIntegrationItem" - }, - "type": "array", - "title": "Items" + "title": "Event Count" }, - "next": { + "authorization_status": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/IdentifierAuthorizationStatus" }, { "type": "null" } ], - "title": "Next" + "examples": [ + "authorized", + "pending", + "rejected" + ] } }, "type": "object", "required": [ - "items", - "next" + "domain_reachable_at", + "domain_resolves_at", + "usage_count", + "event_count", + "authorization_status" ], - "title": "PaginatedResults[TenantIntegrationItem, str]" + "title": "IdentifierEnrichments" + }, + "IdentifierEntityType": { + "type": "string", + "enum": [ + "identity" + ], + "title": "IdentifierEntityType" }, - "PaginatedResults_ThreatFlowReportResponse_str_": { + "IdentifierFeed": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/ThreatFlowReportResponse" - }, - "type": "array", - "title": "Items" + "id": { + "type": "integer", + "title": "Id" }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" + "owner_id": { + "type": "integer", + "title": "Owner Id" } }, "type": "object", "required": [ - "items", - "next" + "id", + "owner_id" ], - "title": "PaginatedResults[ThreatFlowReportResponse, str]" + "title": "IdentifierFeed" }, - "PaginatedResults_Union_EnrichedCredential__EnrichedCookie__str_": { + "IdentifierFeedRateLimit": { "properties": { - "items": { - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/EnrichedCredential" - }, - { - "$ref": "#/components/schemas/EnrichedCookie" - } - ] - }, - "type": "array", - "title": "Items" + "activity_type": { + "type": "string", + "title": "Activity Type" }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" + "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": [ - "items", - "next" + "activity_type", + "first_rate_limited_at", + "last_rate_limited_at" ], - "title": "PaginatedResults[Union[EnrichedCredential, EnrichedCookie], str]" + "title": "IdentifierFeedRateLimit" }, - "PaginatedSources": { + "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/Source" + "$ref": "#/components/schemas/IdentifierFeedRateLimit" }, "type": "array", "title": "Items" + } + }, + "type": "object", + "required": [ + "first_rate_limited_at", + "last_rate_limited_at", + "activity_types", + "items" + ], + "title": "IdentifierFeedRateLimits" + }, + "IdentifierGroupType": { + "type": "string", + "enum": [ + "person", + "corporate_identities" + ], + "title": "IdentifierGroupType" + }, + "IdentifierMatchingPolicyBody": { + "properties": { + "matching_policy_uuid": { + "type": "string", + "format": "uuid", + "title": "Matching Policy Uuid" }, - "next": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Next" - }, - "total_count": { - "type": "integer", - "title": "Total 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": [ - "items", - "next", - "total_count" + "matching_policy_uuid" ], - "title": "PaginatedSources" + "title": "IdentifierMatchingPolicyBody" }, - "ParentContext": { + "IdentifierMetadata": { "properties": { - "parent_uid": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Parent Uid" + "critical": { + "type": "boolean", + "title": "Critical" }, - "parent_type": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Parent Type" + "is_disabled": { + "type": "boolean", + "title": "Is Disabled" } }, "type": "object", - "title": "ParentContext" + "required": [ + "critical", + "is_disabled" + ], + "title": "IdentifierMetadata" }, - "PartialAlertChannel": { + "IdentifierOrderBy": { + "type": "string", + "enum": [ + "id", + "name", + "type" + ], + "title": "IdentifierOrderBy" + }, + "IdentifierRecommendationAction": { "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "name": { - "type": "string", - "title": "Name" - }, "type": { - "$ref": "#/components/schemas/AlertType" - }, - "state": { - "$ref": "#/components/schemas/AlertChannelState" - }, - "alert_count": { - "type": "integer", - "title": "Alert Count" + "$ref": "#/components/schemas/IdentifierRecommendationActionType" } }, "type": "object", "required": [ - "id", - "name", - "type", - "state", - "alert_count" + "type" ], - "title": "PartialAlertChannel" + "title": "IdentifierRecommendationAction" }, - "PasswordPolicy": { - "type": "string", - "enum": [ - "min_eight_chars", - "special_symbols", - "uppercase", - "lowercase", - "number" + "IdentifierRecommendationActionTarget": { + "properties": { + "id": { + "type": "integer", + "title": "Id" + } + }, + "type": "object", + "required": [ + "id" ], - "title": "PasswordPolicy" + "title": "IdentifierRecommendationActionTarget" }, - "PasswordPolicyOperator": { + "IdentifierRecommendationActionType": { "type": "string", "enum": [ - "include", - "exclude" + "accept", + "reject" ], - "title": "PasswordPolicyOperator" + "title": "IdentifierRecommendationActionType" }, - "PasteEvent": { + "IdentifierRecommendationActionsBody": { "properties": { - "event_type": { - "type": "string", - "const": "paste", - "title": "Event Type", - "default": "paste" - }, - "data": { - "$ref": "#/components/schemas/PasteEventData" + "targets": { + "items": { + "$ref": "#/components/schemas/IdentifierRecommendationActionTarget" + }, + "type": "array", + "maxItems": 100, + "title": "Targets" }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" + "action": { + "$ref": "#/components/schemas/IdentifierRecommendationAction" } }, "type": "object", "required": [ - "data", - "metadata" + "action" ], - "title": "Paste" + "title": "IdentifierRecommendationActionsBody" }, - "PasteEventData": { + "IdentifierRecommendationState": { + "type": "string", + "enum": [ + "recommended", + "accepted", + "rejected" + ], + "title": "IdentifierRecommendationState" + }, + "IdentifierRequestBody": { "properties": { - "url": { - "anyOf": [ + "data": { + "oneOf": [ { - "type": "string" + "$ref": "#/components/schemas/CCBinData" }, { - "type": "null" - } - ], - "title": "Url" - }, - "title": { - "anyOf": [ + "$ref": "#/components/schemas/IPData" + }, { - "type": "string" + "$ref": "#/components/schemas/BrandData" }, { - "type": "null" - } - ], - "title": "Title" - }, - "content": { - "anyOf": [ + "$ref": "#/components/schemas/KeywordData" + }, { - "type": "string" + "$ref": "#/components/schemas/AzureTenantData" }, { - "type": "null" - } - ], - "title": "Content" - }, - "actor": { - "anyOf": [ + "$ref": "#/components/schemas/DomainData" + }, { - "$ref": "#/components/schemas/pyro__findings__paste__datamodels__PasteEventData__Actor" + "$ref": "#/components/schemas/SearchQueryData" }, { - "type": "null" - } - ] - }, - "expires_at": { - "anyOf": [ + "$ref": "#/components/schemas/GithubRepositoryData" + }, { - "type": "string", - "format": "date-time" + "$ref": "#/components/schemas/CredentialsData" }, { - "type": "null" - } - ], - "title": "Expires At" - }, - "syntax": { - "anyOf": [ + "$ref": "#/components/schemas/EmailData" + }, { - "type": "string" + "$ref": "#/components/schemas/UsernameData" }, { - "type": "null" + "$ref": "#/components/schemas/SecretData" + }, + { + "$ref": "#/components/schemas/NameData" + }, + { + "$ref": "#/components/schemas/IdentityDataRequestBody" } ], - "title": "Syntax" - } - }, - "type": "object", - "title": "PasteEventData" - }, - "PiiCollection_StealerLogFindingCookie_": { - "properties": { - "type": { - "type": "string", - "const": "phone_number", - "title": "Type", - "default": "phone_number" - }, - "phone_number": { - "type": "string", - "minLength": 7, - "title": "Phone Number" - } - }, - "type": "object", - "required": [ - "phone_number" - ], - "title": "PhoneNumberData" - }, - "PiiExposureItem": { - "properties": { - "created_at": { - "type": "string", - "format": "date-time", - "title": "Created At" - }, - "affected_identity": { - "type": "string", - "title": "Affected Identity" + "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" + } + } }, - "website": { + "name": { "anyOf": [ { "type": "string" @@ -26334,686 +6846,612 @@ "type": "null" } ], - "title": "Website" - }, - "type": { - "type": "string", - "title": "Type" - }, - "pii_category": { - "type": "string", - "title": "Pii Category" - } - }, - "type": "object", - "required": [ - "created_at", - "affected_identity", - "website", - "type", - "pii_category" - ], - "title": "PiiExposureItem" - }, - "PolicyAssignedIdentifierPayload": { - "properties": { - "identifier_id": { - "type": "integer", - "title": "Identifier Id", - "description": "The ID of the identifier this policy is assigned to" - }, - "identifier_name": { - "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" - }, - "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": { - "type": "integer" - }, - "type": "array", - "title": "Identifier Ids", - "description": "The IDs of the identifiers to assign the policy to" - }, - "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" + "title": "Name" }, - { - "$ref": "#/components/schemas/AstpDomainValue" - } - ] - }, - "PresetRestrictedTerm": { - "properties": { - "type": { - "type": "string", - "const": "preset", - "title": "Type" + "feed_config": { + "$ref": "#/components/schemas/FeedConfiguration" }, - "id": { - "type": "string", - "title": "Id" + "collection": { + "anyOf": [ + { + "$ref": "#/components/schemas/IdentifierCollectionGroupId" + }, + { + "$ref": "#/components/schemas/IdentifierCollectionGroupType" + } + ], + "title": "Collection" }, - "display_name": { - "type": "string", - "title": "Display Name" + "metadata": { + "$ref": "#/components/schemas/IdentifierMetadata" }, - "description": { + "matching_policies": { "anyOf": [ { - "type": "string" + "items": { + "$ref": "#/components/schemas/IdentifierMatchingPolicyBody" + }, + "type": "array" }, { "type": "null" } ], - "title": "Description" - }, - "terms": { - "items": { - "$ref": "#/components/schemas/PresetRestrictedTermItem" - }, - "type": "array", - "title": "Terms" - } - }, - "type": "object", - "required": [ - "type", - "id", - "display_name", - "terms" - ], - "title": "PresetRestrictedTerm" - }, - "PresetRestrictedTermItem": { - "properties": { - "type": { - "type": "string", - "enum": [ - "keyword", - "domain" - ], - "title": "Type" - }, - "term": { - "type": "string", - "title": "Term" + "title": "Matching Policies" } }, "type": "object", "required": [ - "type", - "term" + "data", + "name", + "feed_config", + "collection", + "metadata" ], - "title": "PresetRestrictedTermItem" + "title": "IdentifierRequestBody" }, - "PreviewAlerts": { + "IdentifierResponse": { "properties": { - "alert_channel_id": { - "type": "integer", - "title": "Alert Channel Id" + "identifier": { + "anyOf": [ + { + "$ref": "#/components/schemas/Identifier" + }, + { + "type": "null" + } + ] }, - "event_uids": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Event Uids" - } - }, - "type": "object", - "required": [ - "alert_channel_id", - "event_uids" - ], - "title": "PreviewAlerts" - }, - "ProvisionUserItemRequest": { - "properties": { - "email": { - "type": "string", - "title": "Email" + "is_materialized": { + "type": "boolean", + "title": "Is Materialized", + "default": false }, - "idp_user_uuid": { + "created_at": { "anyOf": [ { "type": "string", - "format": "uuid" + "format": "date-time" }, { "type": "null" } ], - "title": "Idp User Uuid" + "title": "Created At" }, - "full_name": { + "last_updated_at": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Full Name" + "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": [ - "email" + "name" ], - "title": "ProvisionUserItemRequest" + "title": "IdentifierScope" }, - "PublicAuditEventAffectedResourceType": { + "IdentifierSource": { "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" - ] + "USER", + "SYSTEM_RELATION", + "SELF_ONBOARDING", + "ATTRIBUTE", + "AUTO_MONITOR", + "IDP_SYNC" + ], + "title": "IdentifierSource" }, - "PublicIdentifierRequestBody": { + "IdentifierState": { "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" - }, + "source": { + "$ref": "#/components/schemas/IdentifierSource" + }, + "data_updated_at": { + "type": "string", + "format": "date-time", + "title": "Data Updated At" + }, + "event_count": { + "anyOf": [ { - "$ref": "#/components/schemas/SecretData" + "type": "integer" }, { - "$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": "Event Count" }, - "name": { + "usage_count": { + "type": "integer", + "title": "Usage Count" + }, + "rate_limits": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/IdentifierFeedRateLimits" }, { "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" + "validation_status": { + "anyOf": [ + { + "$ref": "#/components/schemas/IdentifierValidationStatus" + }, + { + "type": "null" + } + ] }, - "group_id": { + "authorization_request_status": { "anyOf": [ { - "type": "integer" + "$ref": "#/components/schemas/IdentifierAuthorizationRequestStatus" }, { "type": "null" } - ], - "title": "Group Id" + ] } }, "type": "object", "required": [ - "data", - "categories", - "emerging_categories", - "severities" + "source", + "data_updated_at", + "event_count", + "usage_count", + "rate_limits", + "validation_status", + "authorization_request_status" ], - "title": "PublicIdentifierRequestBody" + "title": "IdentifierState" }, - "PublicIdentifierResponse": { + "IdentifierType": { + "type": "string", + "enum": [ + "domain", + "name", + "keyword", + "github_repository", + "username", + "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": "IdentifierValidationStatus" + }, + "IdentityAttribute": { "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "name": { + "asset_uuid": { "type": "string", - "title": "Name" - }, - "tenant_id": { - "type": "integer", - "title": "Tenant Id" + "title": "Asset Uuid" }, "data": { "oneOf": [ { - "$ref": "#/components/schemas/CCBinData" - }, - { - "$ref": "#/components/schemas/IPData" + "$ref": "#/components/schemas/EmailData" }, { - "$ref": "#/components/schemas/KeywordData" + "$ref": "#/components/schemas/UsernameData" }, { - "$ref": "#/components/schemas/AzureTenantData" + "$ref": "#/components/schemas/NameData" }, { - "$ref": "#/components/schemas/DomainData" + "$ref": "#/components/schemas/ExternalIdData" }, { - "$ref": "#/components/schemas/SearchQueryData" + "$ref": "#/components/schemas/AddressData" }, { - "$ref": "#/components/schemas/GithubRepositoryData" + "$ref": "#/components/schemas/BirthYearData" }, { - "$ref": "#/components/schemas/SecretData" + "$ref": "#/components/schemas/RoleData" }, { - "$ref": "#/components/schemas/PublicIdentityData" + "$ref": "#/components/schemas/PhoneNumberData" } ], "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" + "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": [ + "asset_uuid", + "data" + ], + "title": "IdentityAttribute" + }, + "IdentityData": { + "properties": { + "type": { + "type": "string", + "const": "identity", + "title": "Type", + "default": "identity" }, - "categories": { - "items": { - "$ref": "#/components/schemas/SearchType" - }, - "type": "array", - "title": "Categories" + "uuid": { + "type": "string", + "minLength": 1, + "title": "Uuid" + } + }, + "type": "object", + "required": [ + "uuid" + ], + "title": "IdentityData" + }, + "IdentityDataRequestBody": { + "properties": { + "type": { + "type": "string", + "const": "identity", + "title": "Type" }, - "emerging_categories": { + "attributes": { "items": { - "type": "string" + "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", - "title": "Emerging Categories" + "maxItems": 15, + "minItems": 1, + "title": "Attributes" + } + }, + "type": "object", + "required": [ + "type", + "attributes" + ], + "title": "IdentityDataRequestBody" + }, + "IdentityIdentifierEntity": { + "properties": { + "type": { + "$ref": "#/components/schemas/IdentifierEntityType" }, - "severities": { + "attributes": { "items": { - "$ref": "#/components/schemas/Severity" + "$ref": "#/components/schemas/IdentityAttribute" }, "type": "array", - "title": "Severities" - }, - "group_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Group Id" + "title": "Attributes" + } + }, + "type": "object", + "required": [ + "type", + "attributes" + ], + "title": "IdentityIdentifierEntity" + }, + "IncludeOptions": { + "type": "string", + "enum": [ + "known_password_id", + "auth_domains", + "urls" + ], + "title": "IncludeOptions" + }, + "IntelType": { + "type": "string", + "enum": [ + "unit_summary_based", + "custom_intel" + ], + "title": "IntelType" + }, + "InvalidCredentialEvent": { + "properties": { + "event_type": { + "type": "string", + "const": "invalid_credential", + "title": "Event Type", + "default": "invalid_credential" }, - "enrichments": { - "anyOf": [ - { - "$ref": "#/components/schemas/IdentifierEnrichments" - }, - { - "type": "null" - } - ] + "metadata": { + "$ref": "#/components/schemas/EventMetadata" }, - "is_disabled": { - "type": "boolean", - "title": "Is Disabled" + "data": { + "$ref": "#/components/schemas/CredentialEventData" + } + }, + "type": "object", + "required": [ + "metadata", + "data" + ], + "title": "Invalid Credential" + }, + "IpQuery": { + "properties": { + "type": { + "type": "string", + "const": "ip", + "title": "Type" }, - "updated_at": { + "ip": { "type": "string", - "format": "date-time", - "title": "Updated At" + "title": "Ip" } }, "type": "object", "required": [ - "id", - "name", - "tenant_id", - "data", - "categories", - "emerging_categories", - "severities", - "group_id", - "enrichments", - "is_disabled", - "updated_at" + "type", + "ip" ], - "title": "IdentifierResponse" + "title": "IpQuery" }, - "PublicIdentifierUpdateRequestBody": { + "KeywordData": { "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" - }, - { - "$ref": "#/components/schemas/SecretData" - }, - { - "$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" - } - } - }, - "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Name" + "type": { + "type": "string", + "const": "keyword", + "title": "Type", + "default": "keyword" }, - "categories": { - "items": { - "$ref": "#/components/schemas/SearchType" - }, - "type": "array", - "title": "Categories" + "keyword": { + "type": "string", + "minLength": 1, + "title": "Keyword" + } + }, + "type": "object", + "required": [ + "keyword" + ], + "title": "KeywordData" + }, + "KeywordQuery": { + "properties": { + "type": { + "type": "string", + "const": "keyword", + "title": "Type" }, - "emerging_categories": { + "keyword": { + "type": "string", + "title": "Keyword" + } + }, + "type": "object", + "required": [ + "type", + "keyword" + ], + "title": "KeywordQuery" + }, + "KeywordsValue": { + "properties": { + "keywords": { "items": { "type": "string" }, "type": "array", - "title": "Emerging Categories" - }, - "severities": { - "items": { - "$ref": "#/components/schemas/Severity" - }, - "type": "array", - "title": "Severities" - }, - "group_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Group Id" - }, - "is_disabled": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is Disabled" + "title": "Keywords" + } + }, + "type": "object", + "required": [ + "keywords" + ], + "title": "KeywordsValue" + }, + "Language": { + "type": "string", + "enum": [ + "en", + "fr" + ], + "title": "Language" + }, + "LeakedCredentialEvent": { + "properties": { + "event_type": { + "type": "string", + "const": "leaked_credential", + "title": "Event Type", + "default": "leaked_credential" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + }, + "data": { + "$ref": "#/components/schemas/LeakedCredentialEventData" } }, "type": "object", "required": [ - "data", - "categories", - "emerging_categories", - "severities" + "metadata", + "data" ], - "title": "PublicIdentifierUpdateRequestBody" + "title": "Leaked Credential" }, - "PublicIdentityData": { + "LeakedCredentialEventData": { "properties": { - "type": { + "identity_name": { "type": "string", - "const": "identity", - "title": "Type", - "default": "identity" + "title": "Identity Name", + "description": "The email or username associated with the leaked credential." }, - "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" + "imported_at": { + "type": "string", + "format": "date-time", + "title": "Imported At", + "description": "When the credential was imported into Flare." + }, + "password": { + "type": "string", + "title": "Password", + "description": "The leaked password, or its hash if not available in cleartext." + }, + "source": { + "$ref": "#/components/schemas/LeakedCredentialEventSource", + "description": "The source the credential was leaked from." } }, "type": "object", "required": [ - "attributes" + "identity_name", + "imported_at", + "password", + "source" ], - "title": "IdentityData" + "title": "LeakedCredentialEventData" }, - "PublicReport": { + "LeakedCredentialEventSource": { "properties": { "id": { - "type": "integer", - "title": "Id" - }, - "title": { "type": "string", - "title": "Title" + "title": "Id", + "description": "The identifier of the leak source category." }, - "author": { + "name": { "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": { + "title": "Name", + "description": "The name of the leak source category." + } + }, + "type": "object", + "required": [ + "id", + "name" + ], + "title": "LeakedCredentialEventSource" + }, + "LeakedCredentialsBulkActionType": { + "type": "string", + "enum": [ + "remediate", + "unremediate", + "ignore", + "unignore" + ], + "title": "LeakedCredentialsBulkActionType" + }, + "ListingEvent": { + "properties": { + "event_type": { "type": "string", - "format": "date-time", - "title": "Created At" + "const": "listing", + "title": "Event Type", + "default": "listing" }, - "updated_at": { - "type": "string", - "format": "date-time", - "title": "Updated At" + "data": { + "$ref": "#/components/schemas/ListingEventData" }, - "is_archived": { - "type": "boolean", - "title": "Is Archived" + "metadata": { + "$ref": "#/components/schemas/EventMetadata" } }, "type": "object", "required": [ - "id", - "title", - "author", - "tenant_id", - "report_group_id", - "report_type", - "status", - "created_at", - "updated_at", - "is_archived" + "data", + "metadata" ], - "title": "PublicReport" + "title": "Listing" }, - "PublishReportPayload": { + "ListingEventData": { "properties": { - "title": { + "url": { "anyOf": [ { "type": "string" @@ -27022,31 +7460,10 @@ "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": "Url", + "description": "The URL to the listing." }, "title": { - "type": "string", - "title": "Title" - }, - "subtitle": { "anyOf": [ { "type": "string" @@ -27055,38 +7472,10 @@ "type": "null" } ], - "title": "Subtitle" - }, - "summary": { - "type": "string", - "title": "Summary" + "title": "Title", + "description": "The title of the listing." }, "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" @@ -27095,46 +7484,64 @@ "type": "null" } ], - "title": "Prompt Preset Uid" - }, - "created_at": { - "type": "string", - "format": "date-time", - "title": "Created At" + "title": "Content", + "description": "The content within the listing." }, - "published_at": { + "currency": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Published At" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "title": "Updated At" + "title": "Currency", + "description": "The currency expected in the listing." }, - "reading_time": { - "type": "integer", - "title": "Reading Time" + "escrow": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Escrow", + "description": "Whether the listing requires escrow." }, - "tenant_id": { + "price": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Tenant Id" + "title": "Price", + "description": "The price of the listing." }, - "organization_id": { + "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" @@ -27143,85 +7550,35 @@ "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" - ], - "title": "PydanticThreatFlowReport" - }, - "QueryStringQuery": { - "properties": { - "type": { - "type": "string", - "const": "query_string", - "title": "Type" + "title": "Stock Count", + "description": "The quantity of the items or service in stock." }, - "query_string": { - "type": "string", - "maxLength": 10000, - "title": "Query String" - } - }, - "type": "object", - "required": [ - "type", - "query_string" - ], - "title": "QueryStringQuery" - }, - "RansomLeakData": { - "properties": { - "type": { - "type": "string", - "const": "ransomleak", - "title": "Type", - "default": "ransomleak" + "actor": { + "$ref": "#/components/schemas/pyro__findings__listing__datamodels__ListingEventData__Actor", + "description": "Data about the seller." }, - "source": { - "type": "string", - "minLength": 1, - "title": "Source" + "classification": { + "$ref": "#/components/schemas/Classification", + "description": "Data about the possible classifications of the listing." }, - "id": { - "type": "string", - "minLength": 1, - "title": "Id" + "context": { + "$ref": "#/components/schemas/pyro__findings__listing__datamodels__ListingEventData__Context", + "description": "Data offering context to the listing." } }, "type": "object", - "required": [ - "source", - "id" - ], - "title": "RansomLeakData" + "title": "ListingEventData" }, - "RansomLeakEvent": { + "LookalikeDomainEvent": { "properties": { "event_type": { "type": "string", - "const": "ransomleak", + "const": "lookalike", "title": "Event Type", - "default": "ransomleak" + "default": "lookalike" }, "data": { - "$ref": "#/components/schemas/RansomLeakEventData" + "$ref": "#/components/schemas/LookalikeDomainEventData" }, "metadata": { "$ref": "#/components/schemas/EventMetadata" @@ -27232,35 +7589,44 @@ "data", "metadata" ], - "title": "Ransom Leak" + "title": "Lookalike Domain" }, - "RansomLeakEventData": { + "LookalikeDomainEventData": { "properties": { - "url": { + "domain": { + "type": "string", + "title": "Domain", + "description": "The domain of the lookalike domain." + }, + "registered_at": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Url", - "description": "The URL of the ransom leak post." + "title": "Registered At", + "description": "The date and time the lookalike domain was registered." }, - "response_url": { + "identifier_domains": { "anyOf": [ { - "type": "string" + "items": { + "type": "string" + }, + "type": "array" }, { "type": "null" } ], - "title": "Response Url", - "description": "The URL of the response to the ransom leak post." + "title": "Identifier Domains", + "description": "Domain identifiers matching the lookalike domains" }, - "title": { + "feed": { "anyOf": [ { "type": "string" @@ -27269,22 +7635,23 @@ "type": "null" } ], - "title": "Title", - "description": "The title of the ransom leak post." + "title": "Feed", + "description": "The feed where the lookalike domain was found" }, - "content": { + "cert_data": { "anyOf": [ { - "type": "string" + "additionalProperties": true, + "type": "object" }, { "type": "null" } ], - "title": "Content", - "description": "The content of the ransom leak post." + "title": "Cert Data", + "description": "The certificate data of the lookalike domain." }, - "body": { + "subject": { "anyOf": [ { "type": "string" @@ -27293,336 +7660,320 @@ "type": "null" } ], - "title": "Body", - "description": "The body of the ransom leak post." + "title": "Subject", + "description": "The subject of the certificate of the lookalike domain." }, - "victim_information": { + "issuer": { "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": "Issuer", + "description": "The issuer of the certificate of the lookalike domain." } }, "type": "object", "required": [ - "url", - "response_url", - "title", - "content", - "body", - "victim_information" + "domain", + "registered_at", + "identifier_domains", + "feed", + "cert_data", + "subject", + "issuer" ], - "title": "RansomLeakEventData" + "title": "LookalikeDomainEventData" }, - "RecentActivityCountResponse": { + "LuceneValue": { "properties": { - "count": { - "type": "integer", - "title": "Count" + "query": { + "type": "string", + "title": "Query", + "description": "The lucene query of the matching policy" } }, "type": "object", "required": [ - "count" + "query" ], - "title": "RecentActivityCountResponse" + "title": "LuceneValue" }, - "RecentActivityExposedPII": { + "MalwareInformation": { "properties": { - "type": { - "$ref": "#/components/schemas/SearchType" - }, - "uid": { - "type": "string", - "title": "Uid" - }, - "leaked_date": { - "type": "string", - "format": "date-time", - "title": "Leaked Date" + "malware_family": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Malware Family", + "description": "The malware family used for device infection." }, - "attribute": { - "type": "string", - "title": "Attribute" + "build_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Build Id", + "description": "The build ID of the malware used for device infection." }, - "information_type": { - "type": "string", - "title": "Information Type" + "file_location": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "File Location", + "description": "The file location of the malware used for device infection." }, - "source_name": { - "type": "string", - "title": "Source Name" + "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": [ - "type", - "uid", - "leaked_date", - "attribute", - "information_type", - "source_name" + "malware_family", + "build_id", + "file_location", + "infected_at" ], - "title": "RecentActivityExposedPII" + "title": "MalwareInformation" }, - "RecentActivityOpenWebIllicitNetwork": { + "MatchingPolicyAssignmentPayload": { "properties": { - "type": { - "$ref": "#/components/schemas/SearchType" - }, - "uid": { - "type": "string", - "title": "Uid" + "matching_policy": { + "$ref": "#/components/schemas/MatchingPolicyPayload" }, - "creation_date": { + "assigned_at": { "type": "string", "format": "date-time", - "title": "Creation Date" - }, - "attribute": { - "type": "string", - "title": "Attribute" - }, - "event_type": { - "type": "string", - "title": "Event Type" + "title": "Assigned At", + "description": "The date and time this policy was assigned to the identifier" }, - "source_name": { - "type": "string", - "title": "Source Name" + "clean_past_events": { + "type": "boolean", + "title": "Clean Past Events", + "description": "Whether this policy has been applied to historical events" } }, "type": "object", "required": [ - "type", - "uid", - "creation_date", - "attribute", - "event_type", - "source_name" + "matching_policy", + "assigned_at", + "clean_past_events" ], - "title": "RecentActivityOpenWebIllicitNetwork" + "title": "MatchingPolicyAssignmentPayload" }, - "RecentActivityPassword": { + "MatchingPolicyPayload": { "properties": { - "type": { + "uuid": { "type": "string", - "title": "Type", - "default": "identity_profile_password" + "format": "uuid4", + "title": "Uuid", + "description": "The UUID of the matching policy" }, - "last_seen": { + "name": { "type": "string", - "format": "date-time", - "title": "Last Seen" + "title": "Name", + "description": "The name of the matching policy" }, - "attribute": { - "type": "string", - "title": "Attribute" + "policy_type": { + "$ref": "#/components/schemas/MatchingPolicyType", + "description": "The type of the matching policy" }, - "password": { - "type": "string", - "title": "Password" + "value": { + "$ref": "#/components/schemas/PolicyValue", + "description": "The value of the matching policy depending on its type" }, - "source_count": { - "type": "integer", - "title": "Source Count" + "created_at": { + "type": "string", + "format": "date-time", + "title": "Created At", + "description": "The date and time the matching policy was created" }, - "validation": { - "anyOf": [ - { - "$ref": "#/components/schemas/CredentialValidation" - }, - { - "type": "null" - } - ] + "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": [ - "last_seen", - "attribute", - "password", - "source_count", - "validation" + "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": "RecentActivityPassword" + "title": "MatchingPolicyType" }, - "RecentActivityResponse": { + "MitigatedCredentialEvent": { "properties": { - "items": { - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/RecentActivityStealerLog" - }, - { - "$ref": "#/components/schemas/RecentActivityExposedPII" - }, - { - "$ref": "#/components/schemas/RecentActivityOpenWebIllicitNetwork" - }, - { - "$ref": "#/components/schemas/RecentActivityPassword" - } - ] - }, - "type": "array", - "title": "Items" + "event_type": { + "type": "string", + "const": "mitigated_credential", + "title": "Event Type", + "default": "mitigated_credential" }, - "next": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Next" + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + }, + "data": { + "$ref": "#/components/schemas/MitigatedCredentialEventData" } }, "type": "object", "required": [ - "items" + "metadata", + "data" ], - "title": "RecentActivityResponse" + "title": "Mitigated Credential" }, - "RecentActivityStealerLog": { + "MitigatedCredentialEventData": { "properties": { - "type": { - "$ref": "#/components/schemas/SearchType" - }, - "uid": { + "identity_name": { "type": "string", - "title": "Uid" + "title": "Identity Name", + "description": "The email or username associated with the credential." }, - "creation_date": { + "credential_hash": { "type": "string", - "format": "date-time", - "title": "Creation Date" + "title": "Credential Hash", + "description": "A hash uniquely identifying the credential." }, - "attribute": { + "tenant_integration_id": { "type": "string", - "title": "Attribute" + "title": "Tenant Integration Id", + "description": "The UUID of the tenant's IdP integration that validated the credential." }, - "ip_address": { + "mitigation_action": { "type": "string", - "title": "Ip Address" - }, - "credentials_count": { - "type": "integer", - "title": "Credentials Count" + "title": "Mitigation Action", + "description": "The action the tenant's IdP integration took to mitigate the credential" } }, "type": "object", "required": [ - "type", - "uid", - "creation_date", - "attribute", - "ip_address", - "credentials_count" + "identity_name", + "credential_hash", + "tenant_integration_id", + "mitigation_action" ], - "title": "RecentActivityStealerLog" + "title": "MitigatedCredentialEventData" }, - "Recommendation": { + "NameData": { "properties": { - "id": { - "type": "integer", - "title": "Id" + "type": { + "type": "string", + "const": "name", + "title": "Type", + "default": "name" }, - "data": { - "oneOf": [ - { - "$ref": "#/components/schemas/DomainData" - }, - { - "$ref": "#/components/schemas/AzureTenantData" - }, - { - "$ref": "#/components/schemas/EmailData" - }, - { - "$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" - } - } + "first_name": { + "type": "string", + "title": "First Name" + }, + "last_name": { + "type": "string", + "title": "Last Name" + }, + "is_strict": { + "type": "boolean", + "title": "Is Strict" } }, "type": "object", "required": [ - "id", - "data" + "first_name", + "last_name", + "is_strict" ], - "title": "Recommendation" + "title": "NameData" }, - "RelatedConversationRequest": { + "NameQuery": { "properties": { - "uid": { + "type": { "type": "string", - "title": "Uid" - }, - "direction": { - "$ref": "#/components/schemas/ConversationSearchAfterDirection", - "default": "next" + "const": "name", + "title": "Type" }, - "size": { - "type": "integer", - "title": "Size", - "default": 10 + "first_name": { + "type": "string", + "title": "First Name" }, - "search_after": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Search After" + "last_name": { + "type": "string", + "title": "Last Name" }, - "should_translate": { + "is_strict": { "type": "boolean", - "title": "Should Translate", - "default": false + "title": "Is Strict" } }, "type": "object", "required": [ - "uid" + "type", + "first_name", + "last_name", + "is_strict" ], - "title": "RelatedConversationRequest" + "title": "NameQuery" }, - "RelatedConversationResponse": { + "OrderType": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "title": "OrderType" + }, + "PaginatedResults_Alert_str_": { "properties": { - "conversation_messages": { + "items": { "items": { - "$ref": "#/components/schemas/ConversationMessage" + "$ref": "#/components/schemas/Alert" }, "type": "array", - "title": "Conversation Messages" - }, - "conversation_name": { - "type": "string", - "title": "Conversation Name" + "title": "Items" }, - "conversation_name_en": { + "next": { "anyOf": [ { "type": "string" @@ -27631,7 +7982,24 @@ "type": "null" } ], - "title": "Conversation Name En" + "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" }, "next": { "anyOf": [ @@ -27643,8 +8011,25 @@ } ], "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" }, - "previous": { + "next": { "anyOf": [ { "type": "string" @@ -27653,55 +8038,54 @@ "type": "null" } ], - "title": "Previous" + "title": "Next" } }, "type": "object", "required": [ - "conversation_messages", - "conversation_name" - ], - "title": "RelatedConversationResponse" - }, - "ReportDownloadFormat": { - "type": "string", - "enum": [ - "docx", - "pdf", - "csv", - "zip" + "items", + "next" ], - "title": "ReportDownloadFormat" + "title": "PaginatedResults[FeedItem, str]" }, - "ReportRequestInfoResponse": { + "PaginatedResults_GlobalFeedItem_str_": { "properties": { - "status": { - "$ref": "#/components/schemas/RequestStatus" + "items": { + "items": { + "$ref": "#/components/schemas/GlobalFeedItem" + }, + "type": "array", + "title": "Items" }, - "report": { + "next": { "anyOf": [ { - "$ref": "#/components/schemas/ApiReport" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Next" } }, "type": "object", "required": [ - "status" + "items", + "next" ], - "title": "ReportRequestInfoResponse" + "title": "PaginatedResults[GlobalFeedItem, str]" }, - "ReportRequestPayload": { + "PaginatedResults_MatchingPolicyPayload_str_": { "properties": { - "report_title": { - "type": "string", - "title": "Report Title" + "items": { + "items": { + "$ref": "#/components/schemas/MatchingPolicyPayload" + }, + "type": "array", + "title": "Items" }, - "question": { + "next": { "anyOf": [ { "type": "string" @@ -27710,279 +8094,194 @@ "type": "null" } ], - "title": "Question" - }, - "time_range_type": { - "$ref": "#/components/schemas/TimeRangeType", - "default": "all" - }, - "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" - }, - "included_keywords": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Included Keywords" + "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" }, - "excluded_keywords": { + "next": { "anyOf": [ { - "items": { - "type": "string" - }, - "type": "array" + "type": "string" }, { "type": "null" } ], - "title": "Excluded Keywords" - } - }, - "type": "object", - "required": [ - "report_title" - ], - "title": "ReportRequestPayload" - }, - "ReportRequestResponse": { - "properties": { - "request_id": { - "type": "string", - "format": "uuid", - "title": "Request Id" + "title": "Next" } }, "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 + "items", + "next" ], - "title": "RiskScore" + "title": "PaginatedResults[PartialAlertChannel, str]" }, - "SAMLConfigurationData-Input": { + "PaginatedResults_PolicyAssignedIdentifierPayload_str_": { "properties": { - "type": { - "type": "string", - "const": "role", - "title": "Type", - "default": "role" + "items": { + "items": { + "$ref": "#/components/schemas/PolicyAssignedIdentifierPayload" + }, + "type": "array", + "title": "Items" }, - "role": { - "type": "string", - "minLength": 1, - "title": "Role" + "next": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Next" } }, "type": "object", "required": [ - "is_enabled", - "is_mandatory", - "type", - "configuration", - "mappings" + "items", + "next" ], - "title": "SAMLSSOConfigurationData" + "title": "PaginatedResults[PolicyAssignedIdentifierPayload, str]" }, - "SandboxSampleSubmission": { + "PaginatedResults_PublicIdentifierResponse_str_": { "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": { - "type": "string", - "title": "Submitted By" - }, - "status": { - "$ref": "#/components/schemas/SandboxSubmissionStatus" - }, - "external_submission_id": { - "type": "integer", - "title": "External Submission Id" - }, - "external_sample_id": { - "type": "integer", - "title": "External Sample Id" + "items": { + "items": { + "$ref": "#/components/schemas/PublicIdentifierResponse" + }, + "type": "array", + "title": "Items" }, - "external_job_id": { + "next": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "External Job Id" + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[PublicIdentifierResponse, str]" + }, + "PaginatedResults_PublicReport_str_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/PublicReport" + }, + "type": "array", + "title": "Items" }, - "size": { + "next": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "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": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[PublicReport, str]" + }, + "PaginatedResults_PydanticThreatFlowReport_str_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/PydanticThreatFlowReport" + }, + "type": "array", + "title": "Items" }, - "verdict": { + "next": { "anyOf": [ { - "$ref": "#/components/schemas/SandboxSubmissionVerdict" + "type": "string" }, { "type": "null" } - ] - }, - "is_archived": { - "type": "boolean", - "title": "Is Archived" + ], + "title": "Next" } }, "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" + "items", + "next" ], - "title": "SandboxSubmissionReportStatus" + "title": "PaginatedResults[PydanticThreatFlowReport, str]" }, - "SandboxSubmissionResponse": { + "PaginatedResults_Recommendation_str_": { "properties": { - "job_id": { + "items": { + "items": { + "$ref": "#/components/schemas/Recommendation" + }, + "type": "array", + "title": "Items" + }, + "next": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Job 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" }, - "job_status": { + "next": { "anyOf": [ { "type": "string" @@ -27991,63 +8290,47 @@ "type": "null" } ], - "title": "Job Status" + "title": "Next" } }, "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" + "items", + "next" ], - "title": "SandboxSubmissionVerdict" + "title": "PaginatedResults[StealerLogCookie, str]" }, - "SandboxUploadUrlResponse": { + "PaginatedResults_StealerLogCredential_str_": { "properties": { - "upload_url": { - "type": "string", - "title": "Upload Url" + "items": { + "items": { + "$ref": "#/components/schemas/StealerLogCredential" + }, + "type": "array", + "title": "Items" }, - "upload_fields": { - "additionalProperties": true, - "type": "object", - "title": "Upload Fields" + "next": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Next" } }, "type": "object", "required": [ - "upload_url", - "upload_fields" + "items", + "next" ], - "title": "SandboxUploadUrlResponse" + "title": "PaginatedResults[StealerLogCredential, str]" }, - "SandboxVNCUrlResponse": { + "ParentContext": { "properties": { - "vnc_url": { + "parent_uid": { "anyOf": [ { "type": "string" @@ -28056,109 +8339,79 @@ "type": "null" } ], - "title": "Vnc Url" + "title": "Parent Uid" }, - "job_status": { - "type": "string", - "title": "Job Status" + "parent_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Parent Type" } }, "type": "object", - "required": [ - "vnc_url", - "job_status" - ], - "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": "ParentContext" }, - "ScreenshotInfo": { + "PartialAlertChannel": { "properties": { - "asset_hash": { + "id": { + "type": "integer", + "title": "Id" + }, + "name": { "type": "string", - "title": "Asset Hash" + "title": "Name" }, - "hashes": { - "additionalProperties": { - "type": "string" - }, - "propertyNames": { - "$ref": "#/components/schemas/ScreenshotHashType" - }, - "type": "object", - "title": "Hashes" + "type": { + "$ref": "#/components/schemas/AlertType" + }, + "state": { + "$ref": "#/components/schemas/AlertChannelState" + }, + "alert_count": { + "type": "integer", + "title": "Alert Count" } }, "type": "object", "required": [ - "asset_hash", - "hashes" + "id", + "name", + "type", + "state", + "alert_count" ], - "title": "ScreenshotInfo" + "title": "PartialAlertChannel" }, - "SearchQueryAllowedRequest": { + "PasteEvent": { "properties": { - "search_query": { + "event_type": { "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" + "const": "paste", + "title": "Event Type", + "default": "paste" }, - "scopes": { - "items": { - "$ref": "#/components/schemas/Scope" - }, - "type": "array", - "title": "Scopes" + "data": { + "$ref": "#/components/schemas/PasteEventData" }, - "ip": { + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + } + }, + "type": "object", + "required": [ + "data", + "metadata" + ], + "title": "Paste" + }, + "PasteEventData": { + "properties": { + "url": { "anyOf": [ { "type": "string" @@ -28167,9 +8420,9 @@ "type": "null" } ], - "title": "Ip" + "title": "Url" }, - "user_agent": { + "title": { "anyOf": [ { "type": "string" @@ -28178,9 +8431,9 @@ "type": "null" } ], - "title": "User Agent" + "title": "Title" }, - "flare_referer": { + "content": { "anyOf": [ { "type": "string" @@ -28189,31 +8442,31 @@ "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" + "title": "Content" + }, + "actor": { + "anyOf": [ + { + "$ref": "#/components/schemas/pyro__findings__paste__datamodels__PasteEventData__Actor" + }, + { + "type": "null" + } + ] + }, + "expires_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Expires At" }, - "restricted_term": { + "syntax": { "anyOf": [ { "type": "string" @@ -28222,213 +8475,153 @@ "type": "null" } ], - "title": "Restricted Term" + "title": "Syntax" } }, "type": "object", - "required": [ - "is_allowed", - "restricted_term" - ], - "title": "SearchQueryAllowedResponse" + "title": "PasteEventData" }, - "SearchQueryData": { + "PhoneNumberData": { "properties": { "type": { "type": "string", - "const": "search_query", + "const": "phone_number", "title": "Type", - "default": "search_query" + "default": "phone_number" }, - "search_query": { + "phone_number": { "type": "string", - "minLength": 1, - "title": "Search Query" + "minLength": 7, + "title": "Phone Number" } }, "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" + "phone_number" ], - "title": "SearchType" + "title": "PhoneNumberData" }, - "SecretData": { + "PolicyAssignedIdentifierPayload": { "properties": { - "type": { + "identifier_id": { + "type": "integer", + "title": "Identifier Id", + "description": "The ID of the identifier this policy is assigned to" + }, + "identifier_name": { "type": "string", - "const": "secret", - "title": "Type", - "default": "secret" + "title": "Identifier Name", + "description": "The name of the identifier this policy is assigned to" }, - "secret": { + "clean_past_events": { + "type": "boolean", + "title": "Clean Past Events", + "description": "Whether this policy has been applied to historical events" + }, + "assigned_at": { "type": "string", - "minLength": 1, - "title": "Secret" + "format": "date-time", + "title": "Assigned At", + "description": "The date and time this policy was assigned to the identifier" } }, "type": "object", "required": [ - "secret" + "identifier_id", + "identifier_name", + "clean_past_events", + "assigned_at" ], - "title": "SecretData" + "title": "PolicyAssignedIdentifierPayload" }, - "SecretQuery": { + "PolicyAssignmentsBody": { "properties": { - "type": { - "type": "string", - "const": "secret", - "title": "Type" + "identifier_ids": { + "items": { + "type": "integer" + }, + "type": "array", + "title": "Identifier Ids", + "description": "The IDs of the identifiers to assign the policy to" }, - "secret": { - "type": "string", - "title": "Secret" + "clean_past_events": { + "type": "boolean", + "title": "Clean Past Events", + "description": "Whether this policy will be applied to historical events", + "default": false } }, "type": "object", "required": [ - "type", - "secret" + "identifier_ids" ], - "title": "SecretQuery" + "title": "PolicyAssignmentsBody" }, -"ServiceEvent": { - "properties": { - "event_type": { - "type": "string", - "const": "service", - "title": "Event Type", - "default": "service" + "PolicyValue": { + "anyOf": [ + { + "$ref": "#/components/schemas/KeywordsValue" }, - "data": { - "$ref": "#/components/schemas/ServiceEventData" + { + "$ref": "#/components/schemas/LuceneValue" }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" + { + "$ref": "#/components/schemas/AstpCookiesValue" + }, + { + "$ref": "#/components/schemas/AstpDomainValue" } - }, - "type": "object", - "required": [ - "data", - "metadata" - ], - "title": "Service" + ] }, - "ServiceEventData": { + "PublicIdentifierRequestBody": { "properties": { - "url": { - "anyOf": [ + "data": { + "oneOf": [ { - "type": "string" + "$ref": "#/components/schemas/CCBinData" }, { - "type": "null" - } - ], - "title": "Url", - "description": "The URL to the service. This may be an IP address and port combination." - }, - "asn": { - "anyOf": [ + "$ref": "#/components/schemas/IPData" + }, { - "type": "string" + "$ref": "#/components/schemas/KeywordData" }, { - "type": "null" - } - ], - "title": "Asn", - "description": "The Autonomous System Number." - }, - "content": { - "anyOf": [ + "$ref": "#/components/schemas/AzureTenantData" + }, { - "type": "string" + "$ref": "#/components/schemas/DomainData" }, { - "type": "null" - } - ], - "title": "Content", - "description": "The raw content returned by the service." - }, - "service": { - "anyOf": [ + "$ref": "#/components/schemas/SearchQueryData" + }, { - "type": "string" + "$ref": "#/components/schemas/GithubRepositoryData" }, { - "type": "null" + "$ref": "#/components/schemas/SecretData" + }, + { + "$ref": "#/components/schemas/PublicIdentityData" } ], - "title": "Service", - "description": "The protocol of the service e.g. https" + "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" + } + } }, - "product": { + "name": { "anyOf": [ { "type": "string" @@ -28437,10 +8630,30 @@ "type": "null" } ], - "title": "Product", - "description": "The software product that powers the service e.g. Apache httpd" + "title": "Name" }, - "port": { + "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": "integer" @@ -28449,195 +8662,195 @@ "type": "null" } ], - "title": "Port", - "description": "The port the service listens on." + "title": "Group Id" + } + }, + "type": "object", + "required": [ + "data", + "categories", + "emerging_categories", + "severities" + ], + "title": "PublicIdentifierRequestBody" + }, + "PublicIdentifierResponse": { + "properties": { + "id": { + "type": "integer", + "title": "Id" }, - "ip_address": { - "anyOf": [ + "name": { + "type": "string", + "title": "Name" + }, + "tenant_id": { + "type": "integer", + "title": "Tenant Id" + }, + "data": { + "oneOf": [ { - "type": "string" + "$ref": "#/components/schemas/CCBinData" }, { - "type": "null" - } - ], - "title": "Ip Address", - "description": "The IP address of the service." - }, - "organization": { - "anyOf": [ + "$ref": "#/components/schemas/IPData" + }, { - "type": "string" + "$ref": "#/components/schemas/KeywordData" }, { - "type": "null" - } - ], - "title": "Organization", - "description": "The organization that manages the IP address, often a hosting provider." - }, - "hostname": { - "anyOf": [ + "$ref": "#/components/schemas/AzureTenantData" + }, { - "type": "string" + "$ref": "#/components/schemas/DomainData" }, { - "type": "null" - } - ], - "title": "Hostname", - "description": "The hostname the service is served under." - }, - "country_code": { - "anyOf": [ + "$ref": "#/components/schemas/SearchQueryData" + }, { - "type": "string" + "$ref": "#/components/schemas/GithubRepositoryData" }, { - "type": "null" + "$ref": "#/components/schemas/SecretData" + }, + { + "$ref": "#/components/schemas/PublicIdentityData" } ], - "title": "Country Code", - "description": "The country code of the IP address." + "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" + } + } }, - "vulnerabilities": { + "categories": { + "items": { + "$ref": "#/components/schemas/SearchType" + }, + "type": "array", + "title": "Categories" + }, + "emerging_categories": { "items": { "type": "string" }, "type": "array", - "title": "Vulnerabilities", - "description": "CVE identifiers of vulnerabilities the service is potentially affected by." - } - }, - "type": "object", - "title": "ServiceEventData" - }, - "Severity": { - "type": "string", - "enum": [ - "info", - "low", - "medium", - "high", - "critical" - ], - "title": "Severity" - }, - "SocialMediaEvent": { - "properties": { - "event_type": { - "type": "string", - "const": "social_media_account", - "title": "Event Type", - "default": "social_media_account" + "title": "Emerging Categories" }, - "data": { - "$ref": "#/components/schemas/SocialMediaEventData" + "severities": { + "items": { + "$ref": "#/components/schemas/Severity" + }, + "type": "array", + "title": "Severities" }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" - } - }, - "type": "object", - "required": [ - "data", - "metadata" - ], - "title": "Social Media Account" - }, - "SocialMediaEventData": { - "properties": { - "url": { + "group_id": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Url", - "description": "The URL to the profile page of the social media account." + "title": "Group Id" }, - "site": { + "enrichments": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/IdentifierEnrichments" }, { "type": "null" } - ], - "title": "Site", - "description": "The name of the platform where the account was found." + ] }, - "username": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Username", - "description": "The username of the account that was found." + "is_disabled": { + "type": "boolean", + "title": "Is Disabled" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "title": "Updated At" } }, "type": "object", - "title": "SocialMediaEventData" + "required": [ + "id", + "name", + "tenant_id", + "data", + "categories", + "emerging_categories", + "severities", + "group_id", + "enrichments", + "is_disabled", + "updated_at" + ], + "title": "IdentifierResponse" }, - "SourceV2": { + "PublicIdentifierUpdateRequestBody": { "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/KeywordData" }, { - "type": "null" - } - ], - "title": "Description En" - }, - "description_fr": { - "anyOf": [ + "$ref": "#/components/schemas/AzureTenantData" + }, { - "type": "string" + "$ref": "#/components/schemas/DomainData" }, { - "type": "null" - } - ], - "title": "Description Fr" - }, - "breached_at": { - "anyOf": [ + "$ref": "#/components/schemas/SearchQueryData" + }, { - "type": "string" + "$ref": "#/components/schemas/GithubRepositoryData" }, { - "type": "null" + "$ref": "#/components/schemas/SecretData" + }, + { + "$ref": "#/components/schemas/PublicIdentityData" } ], - "title": "Breached At" + "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" + } + } }, - "leaked_at": { + "name": { "anyOf": [ { "type": "string" @@ -28646,211 +8859,164 @@ "type": "null" } ], - "title": "Leaked At" + "title": "Name" }, - "is_alert_enabled": { - "type": "boolean", - "title": "Is Alert Enabled" + "categories": { + "items": { + "$ref": "#/components/schemas/SearchType" + }, + "type": "array", + "title": "Categories" }, - "pii_tags": { + "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": "string" - }, - "type": "array" + "type": "integer" }, { "type": "null" } ], - "title": "Pii Tags" + "title": "Group Id" }, - "url": { + "is_disabled": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Url" + "title": "Is Disabled" } }, "type": "object", "required": [ - "id", - "name", - "description_en", - "description_fr", - "breached_at", - "leaked_at", - "is_alert_enabled", - "pii_tags", - "url" + "data", + "categories", + "emerging_categories", + "severities" ], - "title": "SourceV2" + "title": "PublicIdentifierUpdateRequestBody" }, - "StealerLogCookie": { + "PublicIdentityData": { "properties": { - "host_key": { - "type": "string", - "title": "Host Key" - }, - "path": { + "type": { "type": "string", - "title": "Path" + "const": "identity", + "title": "Type", + "default": "identity" }, - "expires_utc": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" + "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" + } } - ], - "title": "Expires Utc" - }, - "name": { - "type": "string", - "title": "Name" - }, - "value": { - "type": "string", - "title": "Value" + }, + "type": "array", + "maxItems": 15, + "minItems": 1, + "title": "Attributes" } }, "type": "object", "required": [ - "host_key", - "path", - "expires_utc", - "name", - "value" + "attributes" ], - "title": "StealerLogCookie" + "title": "IdentityData" }, - "StealerLogCredential": { + "PublicReport": { "properties": { - "url": { - "type": "string", - "title": "Url" + "id": { + "type": "integer", + "title": "Id" }, - "username": { + "title": { "type": "string", - "title": "Username" + "title": "Title" }, - "password": { + "author": { "type": "string", - "title": "Password" + "title": "Author" }, - "application": { - "type": "string", - "title": "Application" - } - }, - "type": "object", - "required": [ - "url", - "username", - "password", - "application" - ], - "title": "StealerLogCredential" - }, - "StealerLogEventData": { - "properties": { - "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." + "tenant_id": { + "type": "integer", + "title": "Tenant Id" + }, + "report_group_id": { + "type": "integer", + "title": "Report Group Id" + }, + "report_type": { + "$ref": "#/components/schemas/ReportType-Output" }, - "malware_information": { - "anyOf": [ - { - "$ref": "#/components/schemas/MalwareInformation" - }, - { - "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" - }, - "SubdomainStatus": { - "properties": { "status": { - "$ref": "#/components/schemas/DomainStatus" + "$ref": "#/components/schemas/ReportStatus" }, - "updated_at": { + "created_at": { "type": "string", "format": "date-time", - "title": "Updated At" - } - }, - "type": "object", - "required": [ - "status", - "updated_at" - ], - "title": "SubdomainStatus" - }, - "SubdomainTag": { - "properties": { - "label": { - "type": "string", - "title": "Label" + "title": "Created At" }, - "keyword": { + "updated_at": { "type": "string", - "title": "Keyword" + "format": "date-time", + "title": "Updated At" }, - "span": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Span" + "is_archived": { + "type": "boolean", + "title": "Is Archived" } }, "type": "object", "required": [ - "label", - "keyword", - "span" + "id", + "title", + "author", + "tenant_id", + "report_group_id", + "report_type", + "status", + "created_at", + "updated_at", + "is_archived" ], - "title": "SubdomainTag" + "title": "PublicReport" }, - "TagListPayload": { + "PublishReportPayload": { "properties": { - "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Name" - }, - "repository_name": { + "title": { "anyOf": [ { "type": "string" @@ -28859,19 +9025,31 @@ "type": "null" } ], - "title": "Repository Name" + "title": "Title" } }, "type": "object", - "title": "Tag" + "title": "PublishReportPayload" }, - "TenantMetadataResponse": { + "PydanticThreatFlowReport": { "properties": { - "uid": { + "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": "Uid" + "title": "Title" }, - "notes": { + "subtitle": { "anyOf": [ { "type": "string" @@ -28880,7 +9058,15 @@ "type": "null" } ], - "title": "Notes" + "title": "Subtitle" + }, + "summary": { + "type": "string", + "title": "Summary" + }, + "content": { + "type": "string", + "title": "Content" }, "tags": { "items": { @@ -28889,42 +9075,21 @@ "type": "array", "title": "Tags" }, - "severity": { - "anyOf": [ - { - "type": "string" - }, - { - "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" + "highlights": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Highlights" }, - "type": { - "type": "string", - "title": "Type" + "related_activity_uids": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Related Activity Uids" }, - "description": { + "prompt_preset_uid": { "anyOf": [ { "type": "string" @@ -28933,51 +9098,35 @@ "type": "null" } ], - "title": "Description" - }, - "organization_id": { - "type": "integer", - "title": "Organization Id" + "title": "Prompt Preset Uid" }, - "urn": { + "created_at": { "type": "string", - "title": "Urn" - }, - "number_of_employees": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Number Of Employees" + "format": "date-time", + "title": "Created At" }, - "industry": { + "published_at": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Industry" - }, - "is_disabled": { - "type": "boolean", - "title": "Is Disabled" + "title": "Published At" }, - "is_archived": { - "type": "boolean", - "title": "Is Archived" + "updated_at": { + "type": "string", + "format": "date-time", + "title": "Updated At" }, - "feed_id": { + "reading_time": { "type": "integer", - "title": "Feed Id" + "title": "Reading Time" }, - "identifier_limit": { + "tenant_id": { "anyOf": [ { "type": "integer" @@ -28986,32 +9135,9 @@ "type": "null" } ], - "title": "Identifier Limit" - }, - "permissions": { - "items": { - "$ref": "#/components/schemas/UserPermissions" - }, - "type": "array", - "title": "Permissions" - }, - "prevent_global_search": { - "type": "boolean", - "title": "Prevent Global Search" - }, - "access_end_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Access End At" + "title": "Tenant Id" }, - "hubspot_tenant_id": { + "organization_id": { "anyOf": [ { "type": "integer" @@ -29020,283 +9146,274 @@ "type": "null" } ], - "title": "Hubspot Tenant Id" + "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" + ], + "title": "PydanticThreatFlowReport" + }, + "QueryStringQuery": { + "properties": { + "type": { + "type": "string", + "const": "query_string", + "title": "Type" + }, + "query_string": { + "type": "string", + "maxLength": 10000, + "title": "Query String" + } + }, + "type": "object", + "required": [ + "type", + "query_string" + ], + "title": "QueryStringQuery" + }, + "RansomLeakData": { + "properties": { + "type": { + "type": "string", + "const": "ransomleak", + "title": "Type", + "default": "ransomleak" + }, + "source": { + "type": "string", + "minLength": 1, + "title": "Source" + }, + "id": { + "type": "string", + "minLength": 1, + "title": "Id" } }, "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" + "source", + "id" ], - "title": "TenantRoleType" + "title": "RansomLeakData" }, - "TenantUserAccess": { + "RansomLeakEvent": { "properties": { - "tenant_id": { - "type": "integer", - "title": "Tenant Id" + "event_type": { + "type": "string", + "const": "ransomleak", + "title": "Event Type", + "default": "ransomleak" }, - "tenant_role": { - "$ref": "#/components/schemas/TenantRoleType" + "data": { + "$ref": "#/components/schemas/RansomLeakEventData" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" } }, "type": "object", "required": [ - "tenant_id", - "tenant_role" + "data", + "metadata" ], - "title": "TenantUserAccess" + "title": "Ransom Leak" }, - "TenantWithEnrichmentsPayload": { + "RansomLeakEventData": { "properties": { - "tenant": { - "$ref": "#/components/schemas/TenantPayload" - }, - "user_count": { + "url": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "User Count" + "title": "Url", + "description": "The URL of the ransom leak post." }, - "identifier_count": { + "response_url": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Identifier Count" + "title": "Response Url", + "description": "The URL of the response to the ransom leak post." }, - "identifier_limit": { + "title": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Identifier Limit" + "title": "Title", + "description": "The title of the ransom leak post." }, - "global_search_calls_limit": { + "content": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Global Search Calls Limit" + "title": "Content", + "description": "The content of the ransom leak post." }, - "global_search_calls_count": { + "body": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Global Search Calls Count" - }, - "identifier_rotation_count": { - "type": "integer", - "title": "Identifier Rotation Count" + "title": "Body", + "description": "The body of the ransom leak post." }, - "identifier_rotation_limit": { + "victim_information": { "anyOf": [ { - "type": "integer" + "$ref": "#/components/schemas/pyro__findings__ransomleaks__datamodels__VictimInformation" }, { "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" + "description": "The information relating to the victim of the ransom leak." } }, "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" + "url", + "response_url", + "title", + "content", + "body", + "victim_information" + ], + "title": "RansomLeakEventData" }, - "TestTenantIntegrationPayload": { + "Recommendation": { "properties": { - "params": { + "id": { + "type": "integer", + "title": "Id" + }, + "data": { "oneOf": [ { - "$ref": "#/components/schemas/EntraIDInputParams" + "$ref": "#/components/schemas/DomainData" + }, + { + "$ref": "#/components/schemas/AzureTenantData" }, { - "$ref": "#/components/schemas/ForetraceInputParams" + "$ref": "#/components/schemas/EmailData" }, { - "$ref": "#/components/schemas/OktaInputParams" + "$ref": "#/components/schemas/UsernameData" } ], - "title": "Params", + "title": "Data", "discriminator": { - "propertyName": "params_type", + "propertyName": "type", "mapping": { - "entra_id": "#/components/schemas/EntraIDInputParams", - "flare_community": "#/components/schemas/ForetraceInputParams", - "okta": "#/components/schemas/OktaInputParams" + "azure_tenant": "#/components/schemas/AzureTenantData", + "domain": "#/components/schemas/DomainData", + "email": "#/components/schemas/EmailData", + "username": "#/components/schemas/UsernameData" } } } }, "type": "object", "required": [ - "params" - ], - "title": "TestTenantIntegrationPayload" - }, - "ThreadType": { - "type": "string", - "enum": [ - "chat_channel", - "forum_thread" + "id", + "data" ], - "title": "ThreadType" + "title": "Recommendation" }, - "ThreatActorEntityAPIResponse": { + "RelatedConversationRequest": { "properties": { - "uuid": { - "type": "string", - "title": "Uuid" - }, - "type": { - "$ref": "#/components/schemas/EntityType" - }, - "name": { - "type": "string", - "title": "Name" - }, - "created_by": { + "uid": { "type": "string", - "title": "Created By" - }, - "sources": { - "items": { - "$ref": "#/components/schemas/CTIEntitySourceAPIResponse" - }, - "type": "array", - "title": "Sources" + "title": "Uid" }, - "created_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Created At" + "direction": { + "$ref": "#/components/schemas/ConversationSearchAfterDirection", + "default": "next" }, - "updated_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Updated At" + "size": { + "type": "integer", + "title": "Size", + "default": 10 }, - "first_seen_at": { + "search_after": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "First Seen At" + "title": "Search After" }, - "last_seen_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Last Seen At" + "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" }, - "confidence": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Confidence" + "conversation_name": { + "type": "string", + "title": "Conversation Name" }, - "description": { + "conversation_name_en": { "anyOf": [ { "type": "string" @@ -29305,37 +9422,9 @@ "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" - }, - "goals": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Goals" + "title": "Conversation Name En" }, - "sophistication": { + "next": { "anyOf": [ { "type": "string" @@ -29344,9 +9433,9 @@ "type": "null" } ], - "title": "Sophistication" + "title": "Next" }, - "resource_level": { + "previous": { "anyOf": [ { "type": "string" @@ -29355,113 +9444,70 @@ "type": "null" } ], - "title": "Resource Level" + "title": "Previous" + } + }, + "type": "object", + "required": [ + "conversation_messages", + "conversation_name" + ], + "title": "RelatedConversationResponse" + }, + "ReportDownloadFormat": { + "type": "string", + "enum": [ + "docx", + "pdf", + "csv", + "zip" + ], + "title": "ReportDownloadFormat" + }, + "ReportRequestInfoResponse": { + "properties": { + "status": { + "$ref": "#/components/schemas/RequestStatus" }, - "primary_motivation": { + "report": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/ApiReport" }, { "type": "null" } - ], - "title": "Primary Motivation" - }, - "secondary_motivation": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Secondary Motivation" - }, - "personal_motivations": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Personal Motivations" - }, - "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", - "threat_actor_types", - "aliases", - "roles", - "goals", - "sophistication", - "resource_level", - "primary_motivation", - "secondary_motivation", - "personal_motivations", - "marking_definitions" - ], - "title": "ThreatActorEntityAPIResponse" + "status" + ], + "title": "ReportRequestInfoResponse" }, - "ThreatActorGroupEntityAPIResponse": { + "ReportRequestPayload": { "properties": { - "uuid": { - "type": "string", - "title": "Uuid" - }, - "type": { - "$ref": "#/components/schemas/EntityType" - }, - "name": { - "type": "string", - "title": "Name" - }, - "created_by": { + "report_title": { "type": "string", - "title": "Created By" - }, - "sources": { - "items": { - "$ref": "#/components/schemas/CTIEntitySourceAPIResponse" - }, - "type": "array", - "title": "Sources" + "title": "Report Title" }, - "created_at": { + "question": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Created At" + "title": "Question" }, - "updated_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Updated At" + "time_range_type": { + "$ref": "#/components/schemas/TimeRangeType", + "default": "all" }, - "first_seen_at": { + "time_range_from": { "anyOf": [ { "type": "string", @@ -29471,9 +9517,9 @@ "type": "null" } ], - "title": "First Seen At" + "title": "Time Range From" }, - "last_seen_at": { + "time_range_to": { "anyOf": [ { "type": "string", @@ -29483,325 +9529,302 @@ "type": "null" } ], - "title": "Last Seen At" - }, - "confidence": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Confidence" + "title": "Time Range To" }, - "description": { + "included_keywords": { "anyOf": [ { - "type": "string" + "items": { + "type": "string" + }, + "type": "array" }, { "type": "null" } ], - "title": "Description" - }, - "aliases": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Aliases" - }, - "goals": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Goals" - }, - "resource_level": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Resource Level" + "title": "Included Keywords" }, - "primary_motivation": { + "excluded_keywords": { "anyOf": [ { - "type": "string" + "items": { + "type": "string" + }, + "type": "array" }, { "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": "Excluded Keywords" } }, "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" + "report_title" + ], + "title": "ReportRequestPayload" }, - "ThreatFlowReportDownloadFormat": { + "ReportRequestResponse": { + "properties": { + "request_id": { + "type": "string", + "format": "uuid", + "title": "Request Id" + } + }, + "type": "object", + "required": [ + "request_id" + ], + "title": "ReportRequestResponse" + }, + "ReportStatus": { "type": "string", "enum": [ - "docx", - "pdf" + "draft", + "processing", + "completed", + "scheduled", + "paused" ], - "title": "ThreatFlowReportDownloadFormat" + "title": "ReportStatus" }, - "ThreatFlowReportFormatType": { + "ReportType-Output": { "type": "string", "enum": [ - "simple_summary", - "expanded_summary", - "finished_intel_standard" + "v1", + "event_based", + "feed_based" ], - "title": "ThreatFlowReportFormatType" + "title": "ReportType" }, - "TimeRangeType": { + "RequestStatus": { "type": "string", "enum": [ - "all", - "last_24h", - "last_2d", - "last_7d", - "last_1m", - "last_3m", - "last_6m", - "range" + "processing", + "completed", + "error" ], - "title": "TimeRangeType" + "title": "RequestStatus" + }, + "RiskScore": { + "type": "integer", + "enum": [ + 1, + 2, + 3, + 4, + 5 + ], + "title": "RiskScore" }, - "TimelineBySearchTypeResponse": { + "RoleData": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/TimelineSearchTypeWithValues" - }, - "type": "array", - "title": "Items" + "type": { + "type": "string", + "const": "role", + "title": "Type", + "default": "role" + }, + "role": { + "type": "string", + "minLength": 1, + "title": "Role" } }, "type": "object", "required": [ - "items" + "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": "TimelineBySearchTypeResponse" + "title": "SearchType" }, - "TimelineDateCount": { + "SecretData": { "properties": { - "date": { + "type": { "type": "string", - "format": "date-time", - "title": "Date" + "const": "secret", + "title": "Type", + "default": "secret" }, - "count": { - "type": "integer", - "title": "Count" + "secret": { + "type": "string", + "minLength": 1, + "title": "Secret" } }, "type": "object", "required": [ - "date", - "count" + "secret" ], - "title": "TimelineDateCount" + "title": "SecretData" }, - "TimelineSearchTypeWithValues": { + "SecretQuery": { "properties": { - "search_type": { - "$ref": "#/components/schemas/SearchType" + "type": { + "type": "string", + "const": "secret", + "title": "Type" }, - "values": { - "items": { - "$ref": "#/components/schemas/TimelineDateCount" - }, - "type": "array", - "title": "Values" + "secret": { + "type": "string", + "title": "Secret" } }, "type": "object", "required": [ - "search_type", - "values" + "type", + "secret" ], - "title": "TimelineSearchTypeWithValues" + "title": "SecretQuery" }, - "Times": { +"ServiceEvent": { "properties": { - "field": { + "event_type": { "type": "string", - "title": "Field", - "default": "metadata.estimated_created_at" - }, - "gt": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Gt" - }, - "gte": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Gte" + "const": "service", + "title": "Event Type", + "default": "service" }, - "lt": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Lt" + "data": { + "$ref": "#/components/schemas/ServiceEventData" }, - "lte": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Lte" + "metadata": { + "$ref": "#/components/schemas/EventMetadata" } }, "type": "object", - "title": "Times" + "required": [ + "data", + "metadata" + ], + "title": "Service" }, - "ToolEntityAPIResponse": { + "ServiceEventData": { "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": { + "url": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "First Seen At" + "title": "Url", + "description": "The URL to the service. This may be an IP address and port combination." }, - "last_seen_at": { + "asn": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Last Seen At" + "title": "Asn", + "description": "The Autonomous System Number." }, - "confidence": { + "content": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Confidence" + "title": "Content", + "description": "The raw content returned by the service." }, - "description": { + "service": { "anyOf": [ { "type": "string" @@ -29810,23 +9833,10 @@ "type": "null" } ], - "title": "Description" - }, - "tool_types": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Tool Types" - }, - "kill_chain_phases": { - "items": { - "$ref": "#/components/schemas/KillChainAPIResponse" - }, - "type": "array", - "title": "Kill Chain Phases" + "title": "Service", + "description": "The protocol of the service e.g. https" }, - "tool_version": { + "product": { "anyOf": [ { "type": "string" @@ -29835,160 +9845,141 @@ "type": "null" } ], - "title": "Tool Version" + "title": "Product", + "description": "The software product that powers the service e.g. Apache httpd" }, - "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", - "tool_types", - "kill_chain_phases", - "tool_version", - "marking_definitions" - ], - "title": "ToolEntityAPIResponse" - }, - "TopActorsSummaryOutput": { - "properties": { - "top_actors": { - "type": "string", - "title": "Top Actors", - "description": "Single paragraph summarizing the most active actors in the forum thread." - } - }, - "type": "object", - "required": [ - "top_actors" - ], - "title": "TopActorsSummaryOutput" - }, - "Types": { - "properties": { - "is_guide": { + "port": { "anyOf": [ { - "type": "boolean" + "type": "integer" }, { "type": "null" } ], - "title": "Is Guide", - "description": "Whether the listing is a guide. Ex: 'How to extort a website'" + "title": "Port", + "description": "The port the service listens on." }, - "is_service": { + "ip_address": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "type": "null" } ], - "title": "Is Service", - "description": "Whether the listing is offering a service. Ex: 'I will help you extort a website'" + "title": "Ip Address", + "description": "The IP address of the service." }, - "is_software": { + "organization": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "type": "null" } ], - "title": "Is Software", - "description": "Whether the listing is offering software. Ex: 'I will sell you a software to extort a website'" + "title": "Organization", + "description": "The organization that manages the IP address, often a hosting provider." }, - "is_hardware": { + "hostname": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "type": "null" } ], - "title": "Is Hardware", - "description": "Whether the listing is offering hardware. Ex: 'I will sell you a hardware'" + "title": "Hostname", + "description": "The hostname the service is served under." }, - "is_data": { + "country_code": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "type": "null" } ], - "title": "Is Data", - "description": "Whether the listing is offering data. Ex: 'I will sell you victim data'" + "title": "Country Code", + "description": "The country code of the IP address." + }, + "vulnerabilities": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Vulnerabilities", + "description": "CVE identifiers of vulnerabilities the service is potentially affected by." } }, "type": "object", - "title": "Types" + "title": "ServiceEventData" }, - "UpdateMatchingPolicyBody": { + "Severity": { + "type": "string", + "enum": [ + "info", + "low", + "medium", + "high", + "critical" + ], + "title": "Severity" + }, + "SocialMediaEvent": { "properties": { - "name": { + "event_type": { "type": "string", - "minLength": 1, - "title": "Name", - "description": "The new name of the matching policy" + "const": "social_media_account", + "title": "Event Type", + "default": "social_media_account" }, - "value": { - "$ref": "#/components/schemas/PolicyValue", - "description": "The new value of the matching policy depending on its type" + "data": { + "$ref": "#/components/schemas/SocialMediaEventData" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" } }, "type": "object", "required": [ - "name", - "value" + "data", + "metadata" ], - "title": "UpdateMatchingPolicyBody" + "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" @@ -29997,20 +9988,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" @@ -30019,370 +10010,243 @@ "type": "null" } ], - "title": "Description" + "title": "Name" }, - "number_of_employees": { + "description_en": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Number Of Employees" + "title": "Description En" }, - "industry": { - "$ref": "#/components/schemas/TenantIndustry" + "description_fr": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Description Fr" }, - "identifier_limit": { + "breached_at": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Identifier Limit" + "title": "Breached At" }, - "prevent_global_search": { + "leaked_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" + "title": "Leaked At" }, - "live_interaction": { + "is_alert_enabled": { "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" - }, - "username": { - "type": "string", - "title": "Username" - } - }, - "type": "object", - "required": [ - "type", - "username" - ], - "title": "UsernameQuery" - }, - "ValidCredentialEvent": { - "properties": { - "event_type": { - "type": "string", - "const": "valid_credential", - "title": "Event Type", - "default": "valid_credential" - }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" + "title": "Is Alert Enabled" }, - "data": { - "$ref": "#/components/schemas/CredentialEventData" - } - }, - "type": "object", - "required": [ - "metadata", - "data" - ], - "title": "Valid Credential" - }, - "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" - }, - "ctx": { - "type": "object", - "title": "Context" + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Pii Tags" + }, + "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": { + "Tag": { "properties": { - "data": { - "$ref": "#/components/schemas/VipIdentityDataRequestBody" - }, "name": { "anyOf": [ { @@ -30393,284 +10257,343 @@ } ], "title": "Name" + }, + "repository_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Repository Name" } }, "type": "object", - "required": [ - "data" - ], - "title": "VipProtectionUpdateRequestBody" + "title": "Tag" }, - "VulnerabilityEntityAPIResponse": { + "TenantMetadataResponse": { "properties": { - "uuid": { - "type": "string", - "title": "Uuid" - }, - "type": { - "$ref": "#/components/schemas/EntityType" - }, - "name": { + "uid": { "type": "string", - "title": "Name" + "title": "Uid" }, - "created_by": { - "type": "string", - "title": "Created By" + "notes": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" + "title": "UpdateTenantMetadataBody" }, - "pyro__entities__domain__profile__sort_type__SortType": { - "type": "string", - "enum": [ - "date", - "event_type", - "severity" + "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__identity_browser_sort_type__SortType": { - "type": "string", - "enum": [ - "severity", - "name", - "email", - "last_seen_at" + "UsernameQuery": { + "properties": { + "type": { + "type": "string", + "const": "username", + "title": "Type" + }, + "username": { + "type": "string", + "title": "Username" + } + }, + "type": "object", + "required": [ + "type", + "username" ], - "title": "SortType" + "title": "UsernameQuery" }, - "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" + "ValidCredentialEvent": { + "properties": { + "event_type": { + "type": "string", + "const": "valid_credential", + "title": "Event Type", + "default": "valid_credential" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + }, + "data": { + "$ref": "#/components/schemas/CredentialEventData" + } + }, + "type": "object", + "required": [ + "metadata", + "data" ], - "title": "SortType" + "title": "Valid Credential" }, - "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": { From d3907d2b70df67b034bc912b856ef702b2527304 Mon Sep 17 00:00:00 2001 From: Matei Date: Tue, 21 Jul 2026 13:00:06 -0400 Subject: [PATCH 4/9] Update openapi spect --- .../spec/firework-v4-openapi.json | 478 +++++++++++++++++- 1 file changed, 477 insertions(+), 1 deletion(-) diff --git a/docs/api-reference/spec/firework-v4-openapi.json b/docs/api-reference/spec/firework-v4-openapi.json index 5e14d2b..e4ba7c9 100644 --- a/docs/api-reference/spec/firework-v4-openapi.json +++ b/docs/api-reference/spec/firework-v4-openapi.json @@ -408,18 +408,30 @@ { "$ref": "#/components/schemas/BucketEvent" }, + { + "$ref": "#/components/schemas/BucketObjectEvent" + }, { "$ref": "#/components/schemas/ChatMessageEvent" }, { "$ref": "#/components/schemas/FinancialEvent" }, + { + "$ref": "#/components/schemas/DockerImageEvent" + }, + { + "$ref": "#/components/schemas/DockerRepositoryEvent" + }, { "$ref": "#/components/schemas/ForumPostEvent" }, { "$ref": "#/components/schemas/InvalidCredentialEvent" }, + { + "$ref": "#/components/schemas/LeakEvent" + }, { "$ref": "#/components/schemas/LeakedCredentialEvent" }, @@ -456,10 +468,14 @@ "mapping": { "blog_post": "#/components/schemas/BlogPostEvent", "bucket": "#/components/schemas/BucketEvent", + "bucket_object": "#/components/schemas/BucketObjectEvent", "chat_message": "#/components/schemas/ChatMessageEvent", "cc": "#/components/schemas/FinancialEvent", + "docker_image": "#/components/schemas/DockerImageEvent", + "docker_repository": "#/components/schemas/DockerRepositoryEvent", "forum_post": "#/components/schemas/ForumPostEvent", "invalid_credential": "#/components/schemas/InvalidCredentialEvent", + "leak": "#/components/schemas/LeakEvent", "leaked_credential": "#/components/schemas/LeakedCredentialEvent", "listing": "#/components/schemas/ListingEvent", "lookalike": "#/components/schemas/LookalikeDomainEvent", @@ -2510,6 +2526,48 @@ } } }, + "/firework/v4/sandbox/uploads": { + "post": { + "tags": [ + "public", + "team=integration" + ], + "summary": "Upload File Presigned Post", + "operationId": "upload_file_presigned_post_sandbox_uploads_post", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SandboxUploadUrlRequest" + } + } + } + }, + "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/hubspot/flare_sync_webhook": { "post": { "tags": [ @@ -3764,6 +3822,53 @@ ], "title": "BucketEventData" }, + "BucketObjectEvent": { + "properties": { + "event_type": { + "type": "string", + "const": "bucket_object", + "title": "Event Type", + "default": "bucket_object" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + }, + "data": { + "$ref": "#/components/schemas/BucketObjectEventData" + } + }, + "type": "object", + "required": [ + "metadata", + "data" + ], + "title": "Bucket Object" + }, + "BucketObjectEventData": { + "properties": { + "url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Url", + "description": "The URL to the bucket object." + }, + "bucket": { + "$ref": "#/components/schemas/BucketData" + } + }, + "type": "object", + "required": [ + "url", + "bucket" + ], + "title": "BucketObjectEventData" + }, "CCBinData": { "properties": { "type": { @@ -4625,6 +4730,232 @@ ], "title": "CredentialsQueryPayload" }, + "DockerImageEvent": { + "properties": { + "event_type": { + "type": "string", + "const": "docker_image", + "title": "Event Type", + "default": "docker_image" + }, + "data": { + "$ref": "#/components/schemas/DockerImageEventData" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + } + }, + "type": "object", + "required": [ + "data", + "metadata" + ], + "title": "Docker Image" + }, + "DockerImageEventData": { + "properties": { + "content": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Content" + }, + "digest": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Digest" + }, + "architecture": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Architecture" + }, + "os": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Os" + }, + "last_pushed_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Pushed At" + }, + "last_pulled_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Pulled At" + }, + "tags": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/Tag" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Tags", + "default": [] + } + }, + "type": "object", + "title": "DockerImageEventData" + }, + "DockerRepositoryEvent": { + "properties": { + "event_type": { + "type": "string", + "const": "docker_repository", + "title": "Event Type", + "default": "docker_repository" + }, + "data": { + "$ref": "#/components/schemas/DockerRepositoryEventData" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + } + }, + "type": "object", + "required": [ + "data", + "metadata" + ], + "title": "Docker Repository" + }, + "DockerRepositoryEventData": { + "properties": { + "url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Url", + "description": "The URL of the Docker repository." + }, + "star_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Star Count", + "description": "The number of stars the repository has received." + }, + "pull_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Pull Count", + "description": "The total number of pulls made against the repository." + }, + "collaborator_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Collaborator Count", + "description": "The number of collaborators associated with the repository." + }, + "last_updated_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Updated At", + "description": "The timestamp at which the repository was last updated." + }, + "last_modified_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Modified At", + "description": "The timestamp at which the repository's metadata was last modified." + }, + "registered_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Registered At", + "description": "The timestamp at which the repository was first registered." + } + }, + "type": "object", + "title": "DockerRepositoryEventData" + }, "DomainAssetEnrichment": { "properties": { "type": { @@ -7343,6 +7674,119 @@ ], "title": "Language" }, + "LeakEvent": { + "properties": { + "event_type": { + "type": "string", + "const": "leak", + "title": "Event Type", + "default": "leak" + }, + "metadata": { + "$ref": "#/components/schemas/EventMetadata" + }, + "data": { + "$ref": "#/components/schemas/LeakEventData" + } + }, + "type": "object", + "required": [ + "metadata", + "data" + ], + "title": "Leak" + }, + "LeakEventData": { + "properties": { + "term": { + "type": "string", + "title": "Term", + "description": "The search term that matched this leak." + }, + "site_url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Site Url", + "description": "The URL of the site the leak originated from." + }, + "leaked_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Leaked At", + "description": "When the leak occurred." + }, + "breached_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Breached At", + "description": "When the breach was disclosed." + }, + "leaked_credential_count": { + "type": "integer", + "title": "Leaked Credential Count", + "description": "Number of credentials contained in this leak." + }, + "pii_tags": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Pii Tags", + "description": "PII categories present in this leak." + }, + "source": { + "$ref": "#/components/schemas/LeakEventSource", + "description": "The source of the leak." + } + }, + "type": "object", + "required": [ + "term", + "leaked_credential_count", + "source" + ], + "title": "LeakEventData" + }, + "LeakEventSource": { + "properties": { + "id": { + "type": "string", + "title": "Id", + "description": "The identifier of the leak source category." + }, + "name": { + "type": "string", + "title": "Name", + "description": "The name of the leak source category." + } + }, + "type": "object", + "required": [ + "id", + "name" + ], + "title": "LeakEventSource" + }, "LeakedCredentialEvent": { "properties": { "event_type": { @@ -9640,6 +10084,38 @@ ], "title": "RoleData" }, + "SandboxUploadUrlRequest": { + "properties": { + "filename": { + "type": "string", + "title": "Filename" + } + }, + "type": "object", + "required": [ + "filename" + ], + "title": "SandboxUploadUrlRequest" + }, + "SandboxUploadUrlResponse": { + "properties": { + "upload_url": { + "type": "string", + "title": "Upload Url" + }, + "upload_fields": { + "additionalProperties": true, + "type": "object", + "title": "Upload Fields" + } + }, + "type": "object", + "required": [ + "upload_url", + "upload_fields" + ], + "title": "SandboxUploadUrlResponse" + }, "SearchQueryData": { "properties": { "type": { @@ -9764,7 +10240,7 @@ ], "title": "SecretQuery" }, -"ServiceEvent": { + "ServiceEvent": { "properties": { "event_type": { "type": "string", From c96d8a6dec93e1e50a8863572385358a20451e41 Mon Sep 17 00:00:00 2001 From: Matei Date: Tue, 21 Jul 2026 13:08:47 -0400 Subject: [PATCH 5/9] move docker image to it's own branch --- .../event_model_examples/docker_image.mdx | 41 ------------------- .../event_model_examples/events_overview.mdx | 2 - 2 files changed, 43 deletions(-) delete mode 100644 docs/snippets/event_model_examples/docker_image.mdx diff --git a/docs/snippets/event_model_examples/docker_image.mdx b/docs/snippets/event_model_examples/docker_image.mdx deleted file mode 100644 index 5a59e84..0000000 --- a/docs/snippets/event_model_examples/docker_image.mdx +++ /dev/null @@ -1,41 +0,0 @@ -{/* - If you are in pyro: - - If this file changes, you should also modify the API docs. - - https://github.com/flared/docs-api/ - - If you are in mintlify: - - Don't edit this directly, edit the generator in pyro. - - pyro/pyro/mintlify/test_firework_event_models.py -*/} - -```json Docker Image -{ - "event_type": "docker_image", - "data": { - "content": "Docker image description", - "browser_url": "https://hub.docker.com/r/flared/docker", - "digest": "sha256:e4b991038fd226016a60046db2109bf634f7f4b4ea9a2c548b559d3652e4cc38", - "architecture": "amd64", - "variant": null, - "os": "linux", - "os_features": [], - "os_version": null, - "last_pushed_at": "2025-01-01T00:00:00", - "last_pulled_at": "2025-01-01T00:00:00", - "tags": [ - { - "name": "latest", - "repository_name": "flared/docker" - } - ], - "size": 12345678 - }, - "metadata": { - "estimated_created_at": "2025-01-01T00:00:00", - "flare_url": "https://app.flare.io/#/uid", - "matched_at": null, - "severity": "info", - "uid": "index/source/id" - } -} -``` diff --git a/docs/snippets/event_model_examples/events_overview.mdx b/docs/snippets/event_model_examples/events_overview.mdx index 9497515..e36a10e 100644 --- a/docs/snippets/event_model_examples/events_overview.mdx +++ b/docs/snippets/event_model_examples/events_overview.mdx @@ -16,7 +16,6 @@ import ChatMessage from '/snippets/event_model_examples/chat_message.mdx' import CreditCard from '/snippets/event_model_examples/credit_card.mdx' -import DockerImage from '/snippets/event_model_examples/docker_image.mdx' import DockerRepository from '/snippets/event_model_examples/docker_repository.mdx' @@ -39,7 +38,6 @@ import StealerLog from '/snippets/event_model_examples/stealer_log.mdx' - From 6c3b86974588d886013fa3f11a2835afb764015e Mon Sep 17 00:00:00 2001 From: Matei Date: Tue, 21 Jul 2026 13:17:50 -0400 Subject: [PATCH 6/9] remove stuff that shouldn't be in this PR --- .../spec/firework-v4-openapi.json | 357 ------------------ 1 file changed, 357 deletions(-) diff --git a/docs/api-reference/spec/firework-v4-openapi.json b/docs/api-reference/spec/firework-v4-openapi.json index e4ba7c9..a6b661b 100644 --- a/docs/api-reference/spec/firework-v4-openapi.json +++ b/docs/api-reference/spec/firework-v4-openapi.json @@ -408,18 +408,12 @@ { "$ref": "#/components/schemas/BucketEvent" }, - { - "$ref": "#/components/schemas/BucketObjectEvent" - }, { "$ref": "#/components/schemas/ChatMessageEvent" }, { "$ref": "#/components/schemas/FinancialEvent" }, - { - "$ref": "#/components/schemas/DockerImageEvent" - }, { "$ref": "#/components/schemas/DockerRepositoryEvent" }, @@ -429,9 +423,6 @@ { "$ref": "#/components/schemas/InvalidCredentialEvent" }, - { - "$ref": "#/components/schemas/LeakEvent" - }, { "$ref": "#/components/schemas/LeakedCredentialEvent" }, @@ -468,14 +459,11 @@ "mapping": { "blog_post": "#/components/schemas/BlogPostEvent", "bucket": "#/components/schemas/BucketEvent", - "bucket_object": "#/components/schemas/BucketObjectEvent", "chat_message": "#/components/schemas/ChatMessageEvent", "cc": "#/components/schemas/FinancialEvent", - "docker_image": "#/components/schemas/DockerImageEvent", "docker_repository": "#/components/schemas/DockerRepositoryEvent", "forum_post": "#/components/schemas/ForumPostEvent", "invalid_credential": "#/components/schemas/InvalidCredentialEvent", - "leak": "#/components/schemas/LeakEvent", "leaked_credential": "#/components/schemas/LeakedCredentialEvent", "listing": "#/components/schemas/ListingEvent", "lookalike": "#/components/schemas/LookalikeDomainEvent", @@ -2526,48 +2514,6 @@ } } }, - "/firework/v4/sandbox/uploads": { - "post": { - "tags": [ - "public", - "team=integration" - ], - "summary": "Upload File Presigned Post", - "operationId": "upload_file_presigned_post_sandbox_uploads_post", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SandboxUploadUrlRequest" - } - } - } - }, - "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/hubspot/flare_sync_webhook": { "post": { "tags": [ @@ -3822,53 +3768,6 @@ ], "title": "BucketEventData" }, - "BucketObjectEvent": { - "properties": { - "event_type": { - "type": "string", - "const": "bucket_object", - "title": "Event Type", - "default": "bucket_object" - }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" - }, - "data": { - "$ref": "#/components/schemas/BucketObjectEventData" - } - }, - "type": "object", - "required": [ - "metadata", - "data" - ], - "title": "Bucket Object" - }, - "BucketObjectEventData": { - "properties": { - "url": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Url", - "description": "The URL to the bucket object." - }, - "bucket": { - "$ref": "#/components/schemas/BucketData" - } - }, - "type": "object", - "required": [ - "url", - "bucket" - ], - "title": "BucketObjectEventData" - }, "CCBinData": { "properties": { "type": { @@ -4730,117 +4629,6 @@ ], "title": "CredentialsQueryPayload" }, - "DockerImageEvent": { - "properties": { - "event_type": { - "type": "string", - "const": "docker_image", - "title": "Event Type", - "default": "docker_image" - }, - "data": { - "$ref": "#/components/schemas/DockerImageEventData" - }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" - } - }, - "type": "object", - "required": [ - "data", - "metadata" - ], - "title": "Docker Image" - }, - "DockerImageEventData": { - "properties": { - "content": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Content" - }, - "digest": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Digest" - }, - "architecture": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Architecture" - }, - "os": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Os" - }, - "last_pushed_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Last Pushed At" - }, - "last_pulled_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Last Pulled At" - }, - "tags": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/Tag" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Tags", - "default": [] - } - }, - "type": "object", - "title": "DockerImageEventData" - }, "DockerRepositoryEvent": { "properties": { "event_type": { @@ -7674,119 +7462,6 @@ ], "title": "Language" }, - "LeakEvent": { - "properties": { - "event_type": { - "type": "string", - "const": "leak", - "title": "Event Type", - "default": "leak" - }, - "metadata": { - "$ref": "#/components/schemas/EventMetadata" - }, - "data": { - "$ref": "#/components/schemas/LeakEventData" - } - }, - "type": "object", - "required": [ - "metadata", - "data" - ], - "title": "Leak" - }, - "LeakEventData": { - "properties": { - "term": { - "type": "string", - "title": "Term", - "description": "The search term that matched this leak." - }, - "site_url": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Site Url", - "description": "The URL of the site the leak originated from." - }, - "leaked_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Leaked At", - "description": "When the leak occurred." - }, - "breached_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Breached At", - "description": "When the breach was disclosed." - }, - "leaked_credential_count": { - "type": "integer", - "title": "Leaked Credential Count", - "description": "Number of credentials contained in this leak." - }, - "pii_tags": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Pii Tags", - "description": "PII categories present in this leak." - }, - "source": { - "$ref": "#/components/schemas/LeakEventSource", - "description": "The source of the leak." - } - }, - "type": "object", - "required": [ - "term", - "leaked_credential_count", - "source" - ], - "title": "LeakEventData" - }, - "LeakEventSource": { - "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "The identifier of the leak source category." - }, - "name": { - "type": "string", - "title": "Name", - "description": "The name of the leak source category." - } - }, - "type": "object", - "required": [ - "id", - "name" - ], - "title": "LeakEventSource" - }, "LeakedCredentialEvent": { "properties": { "event_type": { @@ -10084,38 +9759,6 @@ ], "title": "RoleData" }, - "SandboxUploadUrlRequest": { - "properties": { - "filename": { - "type": "string", - "title": "Filename" - } - }, - "type": "object", - "required": [ - "filename" - ], - "title": "SandboxUploadUrlRequest" - }, - "SandboxUploadUrlResponse": { - "properties": { - "upload_url": { - "type": "string", - "title": "Upload Url" - }, - "upload_fields": { - "additionalProperties": true, - "type": "object", - "title": "Upload Fields" - } - }, - "type": "object", - "required": [ - "upload_url", - "upload_fields" - ], - "title": "SandboxUploadUrlResponse" - }, "SearchQueryData": { "properties": { "type": { From 53c500e854ef0fe2e54db89b499ab05d4967d936 Mon Sep 17 00:00:00 2001 From: Matei Date: Tue, 21 Jul 2026 13:20:30 -0400 Subject: [PATCH 7/9] fix error in label --- docs/event-types-v2/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/event-types-v2/overview.mdx b/docs/event-types-v2/overview.mdx index 96dd209..c6f0bd4 100644 --- a/docs/event-types-v2/overview.mdx +++ b/docs/event-types-v2/overview.mdx @@ -14,7 +14,7 @@ Currently these event type models are supported on the | `bucket` | [Bucket ](/event-types-v2/bucket) | | `chat_message` | [Chat Message ](/event-types-v2/chat-message) | | `credit_card` | [Chat Message ](/event-types-v2/chat-message) | -| `docker_registry` | [Docker Repository ](/event-types-v2/docker_repository) | +| `docker_repository`| [Docker Repository ](/event-types-v2/docker_repository) | | `document` | [Ransomleak (document) ](/event-types-v2/ransom-leak) | | `domain` | [Lookalike Domain (domain) ](/event-types-v2/domain) | | `forum_post` | [Forum Post & Topic ](/event-types-v2/forum-post) | From 1adf91b5512dbcb76582c98e6b444c4e6127b09f Mon Sep 17 00:00:00 2001 From: Matei Date: Tue, 21 Jul 2026 13:43:28 -0400 Subject: [PATCH 8/9] update docker repository description --- docs/docs.json | 2 +- docs/event-types-v2/docker-repository.mdx | 9 +++++++++ docs/event-types-v2/docker_repository.mdx | 10 ---------- 3 files changed, 10 insertions(+), 11 deletions(-) create mode 100644 docs/event-types-v2/docker-repository.mdx delete mode 100644 docs/event-types-v2/docker_repository.mdx diff --git a/docs/docs.json b/docs/docs.json index 927f290..6c994fc 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -330,7 +330,7 @@ "event-types-v2/forum-post", "event-types-v2/invalid-credential", "event-types-v2/leaked-credential", - "event-types-v2/docker_repository", + "event-types-v2/docker-repository", "event-types-v2/listing", "event-types-v2/mitigated-credential", "event-types-v2/paste", diff --git a/docs/event-types-v2/docker-repository.mdx b/docs/event-types-v2/docker-repository.mdx new file mode 100644 index 0000000..62b90cc --- /dev/null +++ b/docs/event-types-v2/docker-repository.mdx @@ -0,0 +1,9 @@ +--- +title: "Docker Repository" +--- + +import DockerRepositoryExample from '/snippets/event_model_examples/docker_repository.mdx' + +The `docker_repository` type represents a Docker repository description that has been recently created or updated. Repository descriptions are scanned for identifiers and secrets. + + diff --git a/docs/event-types-v2/docker_repository.mdx b/docs/event-types-v2/docker_repository.mdx deleted file mode 100644 index 6be5338..0000000 --- a/docs/event-types-v2/docker_repository.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "Docker Repository" ---- - -import DockerRepositoryExample from '/snippets/event_model_examples/docker_repository.mdx' - -The `docker_repository` type represents an individual message or reply made within a forum thread on an underground or hacker-oriented site. -Each record contains the message text, author alias, message context, and metadata such as timestamps. - - From c3037bcb7ed314d0a30c5b4e359de0ce7b63aca3 Mon Sep 17 00:00:00 2001 From: Matei Date: Tue, 21 Jul 2026 13:49:48 -0400 Subject: [PATCH 9/9] fix broken link --- docs/event-types-v2/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/event-types-v2/overview.mdx b/docs/event-types-v2/overview.mdx index c6f0bd4..4916028 100644 --- a/docs/event-types-v2/overview.mdx +++ b/docs/event-types-v2/overview.mdx @@ -14,7 +14,7 @@ Currently these event type models are supported on the | `bucket` | [Bucket ](/event-types-v2/bucket) | | `chat_message` | [Chat Message ](/event-types-v2/chat-message) | | `credit_card` | [Chat Message ](/event-types-v2/chat-message) | -| `docker_repository`| [Docker Repository ](/event-types-v2/docker_repository) | +| `docker_repository`| [Docker Repository ](/event-types-v2/docker-repository) | | `document` | [Ransomleak (document) ](/event-types-v2/ransom-leak) | | `domain` | [Lookalike Domain (domain) ](/event-types-v2/domain) | | `forum_post` | [Forum Post & Topic ](/event-types-v2/forum-post) |