From 836a72020f3fdcec0487e9855878dd3cb33546e9 Mon Sep 17 00:00:00 2001 From: Jacob DENIS Date: Wed, 8 Apr 2026 16:57:43 -0400 Subject: [PATCH 01/13] docs(api): add documentation for new `matching_policies` endpoints --- .../spec/firework-v4-openapi.json | 3410 +++++++++++++++-- .../v4/endpoints/assign-policy.mdx | 3 + .../v4/endpoints/create-matching-policy.mdx | 3 + .../v4/endpoints/delete-matching-policy.mdx | 3 + .../v4/endpoints/get-matching-policy.mdx | 3 + ...ist-matching-policies-by-identifier-id.mdx | 3 + .../v4/endpoints/list-matching-policies.mdx | 3 + .../v4/endpoints/list-policy-assignments.mdx | 3 + .../v4/endpoints/unassign-policy.mdx | 3 + .../v4/endpoints/update-matching-policy.mdx | 3 + docs/docs.json | 14 + 11 files changed, 3126 insertions(+), 325 deletions(-) create mode 100644 docs/api-reference/v4/endpoints/assign-policy.mdx create mode 100644 docs/api-reference/v4/endpoints/create-matching-policy.mdx create mode 100644 docs/api-reference/v4/endpoints/delete-matching-policy.mdx create mode 100644 docs/api-reference/v4/endpoints/get-matching-policy.mdx create mode 100644 docs/api-reference/v4/endpoints/list-matching-policies-by-identifier-id.mdx create mode 100644 docs/api-reference/v4/endpoints/list-matching-policies.mdx create mode 100644 docs/api-reference/v4/endpoints/list-policy-assignments.mdx create mode 100644 docs/api-reference/v4/endpoints/unassign-policy.mdx create mode 100644 docs/api-reference/v4/endpoints/update-matching-policy.mdx diff --git a/docs/api-reference/spec/firework-v4-openapi.json b/docs/api-reference/spec/firework-v4-openapi.json index e2ef309..426d391 100644 --- a/docs/api-reference/spec/firework-v4-openapi.json +++ b/docs/api-reference/spec/firework-v4-openapi.json @@ -393,6 +393,59 @@ } } }, + "/firework/v4/admin/identifiers/{tenant_id}/free_trial_identifier": { + "post": { + "tags": [ + "private", + "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" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IdentifierRequestBody" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IdentifierResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, "/firework/v4/admin/organizations/{organization_id}/allowed_restricted_terms": { "get": { "tags": [ @@ -1406,19 +1459,19 @@ } } }, - "/firework/v4/admin/hubspot/do_sync": { + "/firework/v4/admin/identifier_recommendations/llm": { "post": { "tags": [ - "public", + "private", "team=experience" ], - "summary": "Hubspot Do Sync", - "operationId": "hubspot_do_sync_admin_hubspot_do_sync_post", + "summary": "Create Llm Recommendations", + "operationId": "create_llm_recommendations_admin_identifier_recommendations_llm_post", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/HubspotDoSyncRequest" + "$ref": "#/components/schemas/CreateLLMRecommendationsRequest" } } }, @@ -1430,8 +1483,7 @@ "content": { "application/json": { "schema": { - "type": "boolean", - "title": "Response Hubspot Do Sync Admin Hubspot Do Sync Post" + "$ref": "#/components/schemas/CreateLLMRecommendationsResponse" } } } @@ -2792,6 +2844,46 @@ } } }, + "/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/assets/by_data": { "post": { "tags": [ @@ -2971,14 +3063,14 @@ "summary": "Generate Async Request", "operationId": "generate_async_request_requests__post", "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateAsyncRequestPayload" } } - }, - "required": true + } }, "responses": { "200": { @@ -3000,6 +3092,88 @@ } } } + }, + "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}": { @@ -3331,88 +3505,198 @@ } } }, - "/firework/v4/entities": { + "/firework/v4/entities/{asset_uuid}/alert_level": { "get": { "tags": [ "private" ], - "summary": "List Entities", - "operationId": "list_entities_entities_get", + "summary": "Get Alert Level", + "operationId": "get_alert_level_entities__asset_uuid__alert_level_get", "parameters": [ { - "name": "query", - "in": "query", - "required": false, + "name": "asset_uuid", + "in": "path", + "required": true, "schema": { "type": "string", - "default": "", - "title": "Query" + "title": "Asset Uuid" } - }, - { - "name": "types", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/EntityType" - } - }, - { - "type": "null" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AlertLevelResponse" } - ], - "title": "Types" + } } }, + "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": "updated_at_time_range", - "in": "query", - "required": false, + "name": "asset_uuid", + "in": "path", + "required": true, "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/TimeRangeType" - }, - { - "type": "null" - } - ], - "title": "Updated At Time Range" + "type": "string", + "title": "Asset Uuid" } }, { - "name": "sources", + "name": "time", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "array", - "items": { - "type": "string" - } + "type": "string" }, { "type": "null" } ], - "title": "Sources" + "title": "Time" } }, { - "name": "sort_by_key", + "name": "time_zone", "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { + "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/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" } ], @@ -3479,13 +3763,13 @@ } } }, - "/firework/v4/entities/count": { + "/firework/v4/cti/entities/count": { "get": { "tags": [ "private" ], "summary": "Count Entities", - "operationId": "count_entities_entities_count_get", + "operationId": "count_entities_cti_entities_count_get", "parameters": [ { "name": "query", @@ -3559,49 +3843,7 @@ "application/json": { "schema": { "type": "integer", - "title": "Response Count Entities Entities Count Get" - } - } - } - }, - "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" + "title": "Response Count Entities Cti Entities Count Get" } } } @@ -3619,13 +3861,13 @@ } } }, - "/firework/v4/entities/{asset_uuid}/alert_level/timeline": { + "/firework/v4/cti/entities/{asset_uuid}": { "get": { "tags": [ "private" ], - "summary": "Get Exposure Level Timeline", - "operationId": "get_exposure_level_timeline_entities__asset_uuid__alert_level_timeline_get", + "summary": "Get Entity", + "operationId": "get_entity_cti_entities__asset_uuid__get", "parameters": [ { "name": "asset_uuid", @@ -3635,32 +3877,6 @@ "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": { @@ -3669,7 +3885,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AlertLevelTimelineResponse" + "$ref": "#/components/schemas/EntityAPIResponseTypes" } } } @@ -3816,6 +4032,7 @@ "anyOf": [ { "type": "string", + "contentMediaType": "application/octet-stream", "format": "base64url" }, { @@ -5933,6 +6150,49 @@ } } }, + "/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": [ @@ -6452,25 +6712,638 @@ } } }, - "/firework/v4/identities/{asset_uuid}/application_exposures": { - "get": { + "/firework/v4/matching_policies": { + "post": { "tags": [ - "private" + "public", + "team=data-engineering" ], - "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" + "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" + } + ], + "title": "Body" + } } - }, - { - "name": "time", + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MatchingPolicyPayload" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "get": { + "tags": [ + "public", + "team=data-engineering" + ], + "summary": "List Matching Policies", + "operationId": "list_matching_policies_matching_policies_get", + "parameters": [ + { + "name": "from", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "From" + } + }, + { + "name": "size", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "maximum": 25, + "exclusiveMinimum": 0, + "default": 25, + "title": "Size" + } + }, + { + "name": "order", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/OrderType", + "default": "desc" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaginatedResults_MatchingPolicyPayload_str_" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/matching_policies/{policy_uuid}": { + "put": { + "tags": [ + "public", + "team=data-engineering" + ], + "summary": "Update Matching Policy", + "operationId": "update_matching_policy_matching_policies__policy_uuid__put", + "parameters": [ + { + "name": "policy_uuid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Policy Uuid" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateMatchingPolicyBody" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MatchingPolicyPayload" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "get": { + "tags": [ + "public", + "team=data-engineering" + ], + "summary": "Get Matching Policy", + "operationId": "get_matching_policy_matching_policies__policy_uuid__get", + "parameters": [ + { + "name": "policy_uuid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Policy Uuid" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MatchingPolicyPayload" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "delete": { + "tags": [ + "public", + "team=data-engineering" + ], + "summary": "Delete Matching Policy", + "operationId": "delete_matching_policy_matching_policies__policy_uuid__delete", + "parameters": [ + { + "name": "policy_uuid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Policy Uuid" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/matching_policies/by_identifier_id/{identifier_id}": { + "get": { + "tags": [ + "public", + "team=data-engineering" + ], + "summary": "List Matching Policies By Identifier Id", + "operationId": "list_matching_policies_by_identifier_id_matching_policies_by_identifier_id__identifier_id__get", + "parameters": [ + { + "name": "identifier_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Identifier Id" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MatchingPolicyAssignmentPayload" + }, + "title": "Response List Matching Policies By Identifier Id Matching Policies By Identifier Id Identifier Id Get" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/matching_policies/{policy_uuid}/assignments": { + "get": { + "tags": [ + "public", + "team=data-engineering" + ], + "summary": "List Policy Assignments", + "operationId": "list_policy_assignments_matching_policies__policy_uuid__assignments_get", + "parameters": [ + { + "name": "policy_uuid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Policy Uuid" + } + }, + { + "name": "from", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "From" + } + }, + { + "name": "size", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "exclusiveMinimum": 0, + "default": 25, + "title": "Size" + } + }, + { + "name": "order", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/OrderType", + "default": "desc" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaginatedResults_PolicyAssignedIdentifierPayload_str_" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "post": { + "tags": [ + "public", + "team=data-engineering" + ], + "summary": "Assign Policy", + "operationId": "assign_policy_matching_policies__policy_uuid__assignments_post", + "parameters": [ + { + "name": "policy_uuid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Policy Uuid" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyAssignmentsBody" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "delete": { + "tags": [ + "public", + "team=data-engineering" + ], + "summary": "Unassign Policy", + "operationId": "unassign_policy_matching_policies__policy_uuid__assignments_delete", + "parameters": [ + { + "name": "policy_uuid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Policy Uuid" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyAssignmentsBody" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/matching_policies/{policy_uuid}/assignments/count": { + "get": { + "tags": [ + "private", + "team=data-engineering" + ], + "summary": "Count Assignments", + "operationId": "count_assignments_matching_policies__policy_uuid__assignments_count_get", + "parameters": [ + { + "name": "policy_uuid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Policy Uuid" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AssignmentCountPayload" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/identities/": { + "get": { + "tags": [ + "private" + ], + "summary": "List Identities", + "operationId": "list_identities_identities__get", + "parameters": [ + { + "name": "next", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Next" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaginatedResults_IdentityBrowserItemResponse_str_" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/identities/_count": { + "get": { + "tags": [ + "private" + ], + "summary": "Identities Count", + "operationId": "identities_count_identities__count_get", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "type": "integer", + "title": "Response Identities Count Identities Count Get" + } + } + } + }, + "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": { @@ -10014,6 +10887,17 @@ ], "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": { @@ -10146,14 +11030,243 @@ } } }, - "/firework/v4/tenants/{tenant_id}/role": { + "/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 Member Role", - "operationId": "get_tenant_member_role_tenants__tenant_id__role_get", + "summary": "Get Tenant Sso Encryption Certificate", + "operationId": "get_tenant_sso_encryption_certificate_tenants__tenant_id__sso_encryption_certificate_get", "parameters": [ { "name": "tenant_id", @@ -10171,7 +11284,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TenantMemberRoleResponse" + "$ref": "#/components/schemas/EncryptionCertificateResponse" } } } @@ -10976,14 +12089,56 @@ } } }, - "/firework/v4/sandbox/submissions/{submission_uuid}/report": { + "/firework/v4/sandbox/submissions/{submission_uuid}/sample_report": { + "get": { + "tags": [ + "private", + "team=integration" + ], + "summary": "Stream Submission Sample Report", + "operationId": "stream_submission_sample_report_sandbox_submissions__submission_uuid__sample_report_get", + "parameters": [ + { + "name": "submission_uuid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Submission Uuid" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/firework/v4/sandbox/submissions/{submission_uuid}/dynamic_report": { "get": { "tags": [ "private", "team=integration" ], - "summary": "Stream Submission Report", - "operationId": "stream_submission_report_sandbox_submissions__submission_uuid__report_get", + "summary": "Stream Submission Dynamic Report", + "operationId": "stream_submission_dynamic_report_sandbox_submissions__submission_uuid__dynamic_report_get", "parameters": [ { "name": "submission_uuid", @@ -11142,6 +12297,46 @@ } } }, + "/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/usage/global_search/by_feature": { "get": { "tags": [ @@ -11515,6 +12710,7 @@ "domain_ip_address", "domain_screenshot", "domain_title", + "domain_whois_rdap", "driller", "driller_forum_post", "driller_forum_topic", @@ -11530,23 +12726,34 @@ "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_indicator", + "sdo_infrastructure", + "sdo_malware", + "sdo_vulnerability", "seller", "service", "social_media_account", "source_code_secret", "stealer_log", "attachment/telegram", + "threat_actor_group", "threat_flow_summary", + "valid_credential", "whois" ], "title": "ActivityModelName" @@ -11693,6 +12900,17 @@ "type": "string", "title": "Name" }, + "created_by": { + "type": "string", + "title": "Created By" + }, + "sources": { + "items": { + "$ref": "#/components/schemas/CTIEntitySourceAPIResponse" + }, + "type": "array", + "title": "Sources" + }, "created_at": { "anyOf": [ { @@ -11717,13 +12935,6 @@ ], "title": "Updated At" }, - "sources": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Sources" - }, "first_seen_at": { "anyOf": [ { @@ -11748,6 +12959,17 @@ ], "title": "Last Seen At" }, + "confidence": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Confidence" + }, "description": { "anyOf": [ { @@ -11765,11 +12987,10 @@ "uuid", "type", "name", + "created_by", + "sources", "created_at", "updated_at", - "sources", - "first_seen_at", - "last_seen_at", "description" ], "title": "ActorAPIResponse" @@ -13509,55 +14730,242 @@ "asset": { "anyOf": [ { - "$ref": "#/components/schemas/Asset" + "$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", + "github_repository", + "ip", + "ipv6_addr", + "keyword", + "mac_addr", + "mitre_technique", + "mutex", + "name", + "screenshot", + "search_query", + "secret", + "thread", + "url", + "user_id", + "username", + "windows_registry_key", + "x509_certificate", + "actor", + "attack_pattern", + "campaign", + "forum_thread", + "identity", + "indicator", + "infrastructure", + "malware", + "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" + }, + "match_subdomains": { + "type": "boolean", + "title": "Match Subdomains", + "default": false + } + }, + "type": "object", + "required": [ + "cookie_names" + ], + "title": "AstpCookiesValue" + }, + "AsyncRequestStatus": { + "type": "string", + "enum": [ + "pending", + "processing", + "completed", + "error" + ], + "title": "AsyncRequestStatus" + }, + "AsyncRequestType": { + "type": "string", + "enum": [ + "actor_summary", + "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": [ - "asset" - ], - "title": "AssetResponse" - }, - "AssetType": { - "type": "string", - "enum": [ - "github_repository", - "username", - "user_id", - "domain", - "brand", + "uuid", + "type", "name", - "keyword", - "search_query", - "bin", - "ip", - "email", - "account", - "secret", - "credentials", - "favicon", - "screenshot", - "azure_tenant", - "thread", - "actor", - "cve", - "identity", - "forum_thread" - ], - "title": "AssetType" - }, - "AsyncRequestType": { - "type": "string", - "enum": [ - "actor_summary", - "intel" + "created_by", + "sources", + "created_at", + "updated_at", + "description", + "kill_chain_phases", + "marking_definitions" ], - "title": "AsyncRequestType" + "title": "AttackPatternEntityAPIResponse" }, "AuthDomainQuery": { "properties": { @@ -14297,7 +15705,7 @@ } ], "title": "Created After", - "default": "2026-03-04T00:15:18.857403Z" + "default": "2026-04-07T19:47:22.921386Z" }, "from": { "anyOf": [ @@ -14373,6 +15781,157 @@ ], "title": "CCBinData" }, + "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" + }, + "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": { @@ -15025,6 +16584,30 @@ ], "title": "CreateAlertChannel" }, + "CreateAstpCookiesBody": { + "properties": { + "name": { + "type": "string", + "title": "Name" + }, + "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" + }, "CreateAuthorizationRequest": { "properties": { "asset_uuid": { @@ -15112,11 +16695,61 @@ "type": "object", "required": [ "name", - "description", - "industry", - "number_of_employees" + "description", + "industry", + "number_of_employees" + ], + "title": "CreateDemoTenantRequestBody" + }, + "CreateExcludedKeywordsBody": { + "properties": { + "name": { + "type": "string", + "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", + "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": "CreateDemoTenantRequestBody" + "title": "CreateIncludedKeywordsBody" }, "CreateInviteLinkResponse": { "properties": { @@ -15131,12 +16764,72 @@ ], "title": "CreateInviteLinkResponse" }, - "CreateTenantIntegrationPayload": { + "CreateLLMRecommendationsRequest": { + "properties": { + "recommendations": { + "items": { + "$ref": "#/components/schemas/LLMRecommendationRequest" + }, + "type": "array", + "title": "Recommendations" + } + }, + "type": "object", + "required": [ + "recommendations" + ], + "title": "CreateLLMRecommendationsRequest" + }, + "CreateLLMRecommendationsResponse": { + "properties": { + "success": { + "type": "boolean", + "title": "Success" + }, + "recommendation_created": { + "type": "integer", + "title": "Recommendation Created" + } + }, + "type": "object", + "required": [ + "success", + "recommendation_created" + ], + "title": "CreateLLMRecommendationsResponse" + }, + "CreateLuceneQueryBody": { "properties": { "name": { "type": "string", "title": "Name", - "default": "Entra ID" + "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" + }, + "CreateTenantIntegrationPayload": { + "properties": { + "name": { + "type": "string", + "maxLength": 255, + "minLength": 1, + "title": "Name" }, "tenant_id": { "type": "integer", @@ -15174,6 +16867,7 @@ }, "type": "object", "required": [ + "name", "tenant_id", "params" ], @@ -15734,7 +17428,8 @@ "unknown", "failed", "not_found", - "mitigated" + "mitigated", + "throttled" ], "title": "CredentialValidationStatus" }, @@ -15744,6 +17439,7 @@ "match", "no_match", "unknown", + "throttled", "failed", "not_found", "mitigated", @@ -15751,6 +17447,23 @@ ], "title": "CredentialValidationStatusFilter" }, + "CredentialValidationThresholdPolicy": { + "properties": { + "max_attempts": { + "type": "integer", + "title": "Max Attempts", + "default": 10 + }, + "period_seconds": { + "type": "integer", + "minimum": 1.0, + "title": "Period Seconds", + "default": 3600 + } + }, + "type": "object", + "title": "CredentialValidationThresholdPolicy" + }, "CredentialsData": { "properties": { "type": { @@ -16312,6 +18025,19 @@ ], "title": "EmailQuery" }, + "EncryptionCertificateResponse": { + "properties": { + "encryption_certificate": { + "type": "string", + "title": "Encryption Certificate" + } + }, + "type": "object", + "required": [ + "encryption_certificate" + ], + "title": "EncryptionCertificateResponse" + }, "EnrichedBulkAction": { "properties": { "id": { @@ -16602,14 +18328,27 @@ }, { "$ref": "#/components/schemas/ForumThreadAPIResponse" + }, + { + "$ref": "#/components/schemas/AttackPatternEntityAPIResponse" + }, + { + "$ref": "#/components/schemas/CampaignEntityAPIResponse" } ] }, "EntityType": { "type": "string", "enum": [ + "attack_pattern", "actor", - "forum-thread" + "campaign", + "forum_thread", + "identity", + "indicator", + "infrastructure", + "malware", + "vulnerability" ], "title": "EntityType" }, @@ -16751,6 +18490,16 @@ "uniqueItems": true, "title": "Features" }, + "lockout_policy": { + "anyOf": [ + { + "$ref": "#/components/schemas/CredentialValidationThresholdPolicy" + }, + { + "type": "null" + } + ] + }, "entra_client_secret": { "anyOf": [ { @@ -16759,11 +18508,10 @@ "writeOnly": true }, { - "$ref": "#/components/schemas/_Unset" + "type": "null" } ], - "title": "Entra Client Secret", - "default": "__UNSET__" + "title": "Entra Client Secret" } }, "type": "object", @@ -16876,6 +18624,16 @@ "uniqueItems": true, "title": "Features" }, + "lockout_policy": { + "anyOf": [ + { + "$ref": "#/components/schemas/CredentialValidationThresholdPolicy" + }, + { + "type": "null" + } + ] + }, "entra_client_secret": { "type": "string", "format": "password", @@ -18207,6 +19965,17 @@ "type": "string", "title": "Name" }, + "created_by": { + "type": "string", + "title": "Created By" + }, + "sources": { + "items": { + "$ref": "#/components/schemas/CTIEntitySourceAPIResponse" + }, + "type": "array", + "title": "Sources" + }, "created_at": { "anyOf": [ { @@ -18231,13 +20000,6 @@ ], "title": "Updated At" }, - "sources": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Sources" - }, "first_seen_at": { "anyOf": [ { @@ -18262,6 +20024,17 @@ ], "title": "Last Seen At" }, + "confidence": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Confidence" + }, "description": { "anyOf": [ { @@ -18279,11 +20052,10 @@ "uuid", "type", "name", + "created_by", + "sources", "created_at", "updated_at", - "sources", - "first_seen_at", - "last_seen_at", "description" ], "title": "ForumThreadAPIResponse" @@ -19122,6 +20894,30 @@ ], "title": "GlobalSearchUsageFeatureValue" }, + "GoogleSSOConfigurationData": { + "properties": { + "is_enabled": { + "type": "boolean", + "title": "Is Enabled" + }, + "is_mandatory": { + "type": "boolean", + "title": "Is Mandatory" + }, + "type": { + "type": "string", + "const": "Google", + "title": "Type" + } + }, + "type": "object", + "required": [ + "is_enabled", + "is_mandatory", + "type" + ], + "title": "GoogleSSOConfigurationData" + }, "GroupByType": { "type": "string", "enum": [ @@ -19401,7 +21197,14 @@ ], "title": "HourData" }, - "HubspotDoSyncRequest": { + "HubspotLifecycleStage": { + "type": "string", + "enum": [ + "1281177943" + ], + "title": "HubspotLifecycleStage" + }, + "HubspotWebhookFlareSyncEvent": { "properties": { "hubspot_id": { "type": "integer", @@ -19418,6 +21221,17 @@ ], "title": "Domain" }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name" + }, "organization_id": { "anyOf": [ { @@ -19429,16 +21243,15 @@ ], "title": "Organization Id" }, - "name": { + "lifecycle_stage": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/HubspotLifecycleStage" }, { "type": "null" } - ], - "title": "Name" + ] }, "merged_object_ids": { "items": { @@ -19451,47 +21264,31 @@ }, "type": "object", "required": [ - "hubspot_id", - "domain", - "organization_id", - "name" - ], - "title": "HubspotDoSyncRequest" - }, - "HubspotLifecycleStage": { - "type": "string", - "enum": [ - "1281177943" + "hubspot_id" ], - "title": "HubspotLifecycleStage" + "title": "HubspotWebhookFlareSyncEvent" }, - "HubspotWebhookFlareSyncEvent": { + "HubspotWebhookFlareSyncTenantEvent": { "properties": { - "hubspot_id": { + "hubspot_company_id": { "type": "integer", - "title": "Hubspot Id" + "title": "Hubspot Company Id" }, - "domain": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Domain" + "hubspot_tenant_id": { + "type": "integer", + "title": "Hubspot Tenant Id" }, - "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Name" + "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": [ @@ -19504,30 +21301,25 @@ ], "title": "Organization Id" }, - "lifecycle_stage": { + "tenant_id": { "anyOf": [ { - "$ref": "#/components/schemas/HubspotLifecycleStage" + "type": "integer" }, { "type": "null" } - ] - }, - "merged_object_ids": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Merged Object Ids", - "default": [] + ], + "title": "Tenant Id" } }, "type": "object", "required": [ - "hubspot_id" + "hubspot_company_id", + "hubspot_tenant_id", + "flare_tenant_name" ], - "title": "HubspotWebhookFlareSyncEvent" + "title": "HubspotWebhookFlareSyncTenantEvent" }, "IPData": { "properties": { @@ -20060,6 +21852,25 @@ ], "title": "IdentifierGroupType" }, + "IdentifierMatchingPolicyBody": { + "properties": { + "matching_policy_uuid": { + "type": "string", + "format": "uuid", + "title": "Matching Policy Uuid" + }, + "clean_past_events": { + "type": "boolean", + "title": "Clean Past Events", + "default": false + } + }, + "type": "object", + "required": [ + "matching_policy_uuid" + ], + "title": "IdentifierMatchingPolicyBody" + }, "IdentifierMetadata": { "properties": { "critical": { @@ -20187,7 +21998,21 @@ { "type": "null" } - ] + ] + }, + "relevancy_score_types": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/RecommendationRelevancyScoreType" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Relevancy Score Types" }, "type": { "type": "string", @@ -20247,6 +22072,20 @@ } ] }, + "relevancy_score_types": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/RecommendationRelevancyScoreType" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Relevancy Score Types" + }, "type": { "type": "string", "const": "identifier_recommendation_group", @@ -20407,6 +22246,20 @@ }, "metadata": { "$ref": "#/components/schemas/IdentifierMetadata" + }, + "matching_policies": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/IdentifierMatchingPolicyBody" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Matching Policies" } }, "type": "object", @@ -20489,6 +22342,7 @@ "SYSTEM_RELATION", "SELF_ONBOARDING", "ATTRIBUTE", + "LOOKALIKE_DOMAIN", "IDP_SYNC" ], "title": "IdentifierSource" @@ -20501,7 +22355,8 @@ "COUNTED", "SYSTEM", "USER_AND_ATTRIBUTE", - "USER_AND_SYSTEM" + "USER_AND_SYSTEM", + "LOOKALIKE_DOMAIN" ], "title": "IdentifierSourceGroup" }, @@ -20634,6 +22489,177 @@ ], "title": "IdentityAttribute" }, + "IdentityBrowserCounts": { + "properties": { + "passwords": { + "type": "integer", + "title": "Passwords" + }, + "stealer_logs": { + "type": "integer", + "title": "Stealer Logs" + }, + "pii": { + "type": "integer", + "title": "Pii" + }, + "illicit_networks": { + "type": "integer", + "title": "Illicit Networks" + }, + "open_web": { + "type": "integer", + "title": "Open Web" + } + }, + "type": "object", + "required": [ + "passwords", + "stealer_logs", + "pii", + "illicit_networks", + "open_web" + ], + "title": "IdentityBrowserCounts" + }, + "IdentityBrowserItemResponse": { + "properties": { + "asset_uuid": { + "type": "string", + "title": "Asset Uuid" + }, + "risk": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Risk" + }, + "email": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Email" + }, + "display_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Display Name" + }, + "title": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Title" + }, + "department": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Department" + }, + "account_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Account Type" + }, + "is_active": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Is Active" + }, + "vip": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Vip" + }, + "is_on_premises_sync_enabled": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Is On Premises Sync Enabled" + }, + "last_seen_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Seen At" + }, + "counts": { + "$ref": "#/components/schemas/IdentityBrowserCounts" + } + }, + "type": "object", + "required": [ + "asset_uuid", + "risk", + "email", + "display_name", + "title", + "department", + "account_type", + "is_active", + "vip", + "is_on_premises_sync_enabled", + "last_seen_at", + "counts" + ], + "title": "IdentityBrowserItemResponse" + }, "IdentityData": { "properties": { "type": { @@ -20791,6 +22817,18 @@ ], "title": "Password Changed At" }, + "account_created_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Account Created At" + }, "refresh_tokens_valid_from": { "anyOf": [ { @@ -20861,6 +22899,7 @@ "department", "is_on_premises_sync_enabled", "password_changed_at", + "account_created_at", "refresh_tokens_valid_from", "sign_in_sessions_valid_from", "last_synced_at", @@ -21048,6 +23087,14 @@ ], "title": "IndicatorType" }, + "IntelType": { + "type": "string", + "enum": [ + "unit_summary_based", + "custom_intel" + ], + "title": "IntelType" + }, "InviteLinkResponse": { "properties": { "invite_magic_link": { @@ -21164,22 +23211,154 @@ "description": { "anyOf": [ { - "type": "string" + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Description" + } + }, + "type": "object", + "required": [ + "type", + "id", + "term" + ], + "title": "KeywordRestrictedTerm" + }, + "KeywordsValue": { + "properties": { + "keywords": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Keywords" + } + }, + "type": "object", + "required": [ + "keywords" + ], + "title": "KeywordsValue" + }, + "KillChainAPIResponse": { + "properties": { + "kill_chain_name": { + "type": "string", + "title": "Kill Chain Name" + }, + "phase_name": { + "type": "string", + "title": "Phase Name" + } + }, + "type": "object", + "required": [ + "kill_chain_name", + "phase_name" + ], + "title": "KillChainAPIResponse" + }, + "LLMRecommendationRequest": { + "properties": { + "asset": { + "oneOf": [ + { + "$ref": "#/components/schemas/CCBinData" + }, + { + "$ref": "#/components/schemas/IPData" + }, + { + "$ref": "#/components/schemas/BrandData" + }, + { + "$ref": "#/components/schemas/KeywordData" + }, + { + "$ref": "#/components/schemas/AzureTenantData" + }, + { + "$ref": "#/components/schemas/DomainData" + }, + { + "$ref": "#/components/schemas/SearchQueryData" + }, + { + "$ref": "#/components/schemas/GithubRepositoryData" + }, + { + "$ref": "#/components/schemas/CredentialsData" + }, + { + "$ref": "#/components/schemas/EmailData" }, { - "type": "null" + "$ref": "#/components/schemas/UsernameData" + }, + { + "$ref": "#/components/schemas/SecretData" + }, + { + "$ref": "#/components/schemas/NameData" + }, + { + "$ref": "#/components/schemas/IdentityDataRequestBody" } ], - "title": "Description" + "title": "Asset", + "discriminator": { + "propertyName": "type", + "mapping": { + "azure_tenant": "#/components/schemas/AzureTenantData", + "bin": "#/components/schemas/CCBinData", + "brand": "#/components/schemas/BrandData", + "credentials": "#/components/schemas/CredentialsData", + "domain": "#/components/schemas/DomainData", + "email": "#/components/schemas/EmailData", + "github_repository": "#/components/schemas/GithubRepositoryData", + "identity": "#/components/schemas/IdentityDataRequestBody", + "ip": "#/components/schemas/IPData", + "keyword": "#/components/schemas/KeywordData", + "name": "#/components/schemas/NameData", + "search_query": "#/components/schemas/SearchQueryData", + "secret": "#/components/schemas/SecretData", + "username": "#/components/schemas/UsernameData" + } + } + }, + "tenant_id": { + "type": "integer", + "title": "Tenant Id" + }, + "reason": { + "type": "string", + "title": "Reason" + }, + "relevancy_score": { + "type": "integer", + "maximum": 100.0, + "minimum": 0.0, + "title": "Relevancy Score" + }, + "seen_at": { + "type": "string", + "format": "date-time", + "title": "Seen At" } }, "type": "object", "required": [ - "type", - "id", - "term" + "asset", + "tenant_id", + "reason", + "relevancy_score", + "seen_at" ], - "title": "KeywordRestrictedTerm" + "title": "LLMRecommendationRequest" }, "Language": { "type": "string", @@ -21588,6 +23767,20 @@ ], "title": "LookalikeDomainEventData" }, + "LuceneValue": { + "properties": { + "query": { + "type": "string", + "title": "Query", + "description": "The lucene query of the matching policy" + } + }, + "type": "object", + "required": [ + "query" + ], + "title": "LuceneValue" + }, "MalwareInformation": { "properties": { "malware_family": { @@ -21662,6 +23855,126 @@ ], "title": "MarkUserAsCompromisedPayload" }, + "MarkingDefinition": { + "properties": { + "id": { + "type": "string", + "title": "Id" + }, + "definition_type": { + "$ref": "#/components/schemas/MarkingDefinitionType" + }, + "name": { + "type": "string", + "title": "Name" + } + }, + "type": "object", + "required": [ + "id", + "definition_type", + "name" + ], + "title": "MarkingDefinition" + }, + "MarkingDefinitionType": { + "type": "string", + "enum": [ + "tlp" + ], + "title": "MarkingDefinitionType" + }, + "MatchingPolicyAssignmentPayload": { + "properties": { + "matching_policy": { + "$ref": "#/components/schemas/MatchingPolicyPayload" + }, + "assigned_at": { + "type": "string", + "format": "date-time", + "title": "Assigned At", + "description": "The date and time this policy was assigned to the identifier" + }, + "clean_past_events": { + "type": "boolean", + "title": "Clean Past Events", + "description": "Whether this policy has been applied to historical events" + } + }, + "type": "object", + "required": [ + "matching_policy", + "assigned_at", + "clean_past_events" + ], + "title": "MatchingPolicyAssignmentPayload" + }, + "MatchingPolicyPayload": { + "properties": { + "uuid": { + "type": "string", + "format": "uuid4", + "title": "Uuid", + "description": "The UUID of the matching policy" + }, + "name": { + "type": "string", + "title": "Name", + "description": "The name of the matching policy" + }, + "policy_type": { + "$ref": "#/components/schemas/MatchingPolicyType", + "description": "The type of the matching policy" + }, + "value": { + "anyOf": [ + { + "$ref": "#/components/schemas/KeywordsValue" + }, + { + "$ref": "#/components/schemas/LuceneValue" + }, + { + "$ref": "#/components/schemas/AstpCookiesValue" + } + ], + "title": "Value", + "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" + ], + "title": "MatchingPolicyType" + }, "MergeIdentitiesBody": { "properties": { "from_identifier_id": { @@ -21738,6 +24051,30 @@ ], "title": "NameQuery" }, + "NotConfiguredSSOConfigurationData": { + "properties": { + "is_enabled": { + "type": "boolean", + "title": "Is Enabled" + }, + "is_mandatory": { + "type": "boolean", + "title": "Is Mandatory" + }, + "type": { + "type": "string", + "const": "not_configured", + "title": "Type" + } + }, + "type": "object", + "required": [ + "is_enabled", + "is_mandatory", + "type" + ], + "title": "NotConfiguredSSOConfigurationData" + }, "OktaFailedValidationDetails": { "properties": { "invalid_parameter_field": { @@ -21765,6 +24102,16 @@ "okta_domain": { "type": "string", "title": "Okta Domain" + }, + "lockout_policy": { + "anyOf": [ + { + "$ref": "#/components/schemas/CredentialValidationThresholdPolicy" + }, + { + "type": "null" + } + ] } }, "type": "object", @@ -21791,6 +24138,16 @@ "okta_domain": { "type": "string", "title": "Okta Domain" + }, + "lockout_policy": { + "anyOf": [ + { + "$ref": "#/components/schemas/CredentialValidationThresholdPolicy" + }, + { + "type": "null" + } + ] } }, "type": "object", @@ -22115,11 +24472,95 @@ ], "title": "PaginatedResults[EntityAPIResponseTypes, str]" }, - "PaginatedResults_FeedItem_str_": { + "PaginatedResults_FeedItem_str_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/FeedItem" + }, + "type": "array", + "title": "Items" + }, + "next": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[FeedItem, str]" + }, + "PaginatedResults_GlobalFeedItem_str_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/GlobalFeedItem" + }, + "type": "array", + "title": "Items" + }, + "next": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[GlobalFeedItem, str]" + }, + "PaginatedResults_IdentifierRelation_str_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/IdentifierRelation" + }, + "type": "array", + "title": "Items" + }, + "next": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Next" + } + }, + "type": "object", + "required": [ + "items", + "next" + ], + "title": "PaginatedResults[IdentifierRelation, str]" + }, + "PaginatedResults_Identifier_str_": { "properties": { "items": { "items": { - "$ref": "#/components/schemas/FeedItem" + "$ref": "#/components/schemas/Identifier" }, "type": "array", "title": "Items" @@ -22141,13 +24582,13 @@ "items", "next" ], - "title": "PaginatedResults[FeedItem, str]" + "title": "PaginatedResults[Identifier, str]" }, - "PaginatedResults_GlobalFeedItem_str_": { + "PaginatedResults_IdentityBrowserItemResponse_str_": { "properties": { "items": { "items": { - "$ref": "#/components/schemas/GlobalFeedItem" + "$ref": "#/components/schemas/IdentityBrowserItemResponse" }, "type": "array", "title": "Items" @@ -22169,13 +24610,13 @@ "items", "next" ], - "title": "PaginatedResults[GlobalFeedItem, str]" + "title": "PaginatedResults[IdentityBrowserItemResponse, str]" }, - "PaginatedResults_IdentifierRelation_str_": { + "PaginatedResults_InviteLinkResponse_datetime_": { "properties": { "items": { "items": { - "$ref": "#/components/schemas/IdentifierRelation" + "$ref": "#/components/schemas/InviteLinkResponse" }, "type": "array", "title": "Items" @@ -22183,7 +24624,8 @@ "next": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" @@ -22197,13 +24639,13 @@ "items", "next" ], - "title": "PaginatedResults[IdentifierRelation, str]" + "title": "PaginatedResults[InviteLinkResponse, datetime]" }, - "PaginatedResults_Identifier_str_": { + "PaginatedResults_MatchingPolicyPayload_str_": { "properties": { "items": { "items": { - "$ref": "#/components/schemas/Identifier" + "$ref": "#/components/schemas/MatchingPolicyPayload" }, "type": "array", "title": "Items" @@ -22225,13 +24667,13 @@ "items", "next" ], - "title": "PaginatedResults[Identifier, str]" + "title": "PaginatedResults[MatchingPolicyPayload, str]" }, - "PaginatedResults_InviteLinkResponse_datetime_": { + "PaginatedResults_PartialAlertChannel_str_": { "properties": { "items": { "items": { - "$ref": "#/components/schemas/InviteLinkResponse" + "$ref": "#/components/schemas/PartialAlertChannel" }, "type": "array", "title": "Items" @@ -22239,8 +24681,7 @@ "next": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" @@ -22254,13 +24695,13 @@ "items", "next" ], - "title": "PaginatedResults[InviteLinkResponse, datetime]" + "title": "PaginatedResults[PartialAlertChannel, str]" }, - "PaginatedResults_PartialAlertChannel_str_": { + "PaginatedResults_PolicyAssignedIdentifierPayload_str_": { "properties": { "items": { "items": { - "$ref": "#/components/schemas/PartialAlertChannel" + "$ref": "#/components/schemas/PolicyAssignedIdentifierPayload" }, "type": "array", "title": "Items" @@ -22282,7 +24723,7 @@ "items", "next" ], - "title": "PaginatedResults[PartialAlertChannel, str]" + "title": "PaginatedResults[PolicyAssignedIdentifierPayload, str]" }, "PaginatedResults_PydanticThreatFlowReport_str_": { "properties": { @@ -23068,6 +25509,62 @@ ], "title": "PiiCollection[StealerLogFindingCredential]" }, + "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" + }, "PresetRestrictedTerm": { "properties": { "type": { @@ -23133,6 +25630,27 @@ ], "title": "PresetRestrictedTermItem" }, + "PreviewAlerts": { + "properties": { + "alert_channel_id": { + "type": "integer", + "title": "Alert Channel Id" + }, + "event_uids": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Event Uids" + } + }, + "type": "object", + "required": [ + "alert_channel_id", + "event_uids" + ], + "title": "PreviewAlerts" + }, "PublishReportPayload": { "properties": { "title": { @@ -23160,6 +25678,10 @@ "$ref": "#/components/schemas/ThreatFlowReportFormatType", "default": "simple_summary" }, + "intel_type": { + "$ref": "#/components/schemas/IntelType", + "default": "unit_summary_based" + }, "title": { "type": "string", "title": "Title" @@ -23662,6 +26184,15 @@ ], "title": "Recommendation" }, + "RecommendationRelevancyScoreType": { + "type": "string", + "enum": [ + "HIGH", + "MEDIUM", + "LOW" + ], + "title": "RecommendationRelevancyScoreType" + }, "RelatedConversationRequest": { "properties": { "uid": { @@ -24900,6 +27431,13 @@ "type": "object", "title": "ReportUpdatePayload" }, + "RequestSigningAlgorithm": { + "type": "string", + "enum": [ + "rsa-sha256" + ], + "title": "RequestSigningAlgorithm" + }, "RequestStatus": { "type": "string", "enum": [ @@ -24995,6 +27533,169 @@ ], "title": "RiskScore" }, + "SAMLConfigurationData-Input": { + "properties": { + "MetadataURL": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Metadataurl" + }, + "MetadataFile": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Metadatafile" + }, + "EncryptedResponses": { + "type": "boolean", + "title": "Encryptedresponses", + "default": false + }, + "RequestSigningAlgorithm": { + "anyOf": [ + { + "$ref": "#/components/schemas/RequestSigningAlgorithm" + }, + { + "type": "null" + } + ] + } + }, + "type": "object", + "title": "SAMLConfigurationData" + }, + "SAMLConfigurationData-Output": { + "properties": { + "MetadataURL": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Metadataurl" + }, + "MetadataFile": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Metadatafile" + }, + "EncryptedResponses": { + "type": "boolean", + "title": "Encryptedresponses", + "default": "false" + }, + "RequestSigningAlgorithm": { + "anyOf": [ + { + "$ref": "#/components/schemas/RequestSigningAlgorithm" + }, + { + "type": "null" + } + ] + } + }, + "type": "object", + "title": "SAMLConfigurationData" + }, + "SAMLConfigurationMappings": { + "properties": { + "email": { + "type": "string", + "title": "Email" + } + }, + "type": "object", + "required": [ + "email" + ], + "title": "SAMLConfigurationMappings" + }, + "SAMLSSOConfigurationData-Input": { + "properties": { + "is_enabled": { + "type": "boolean", + "title": "Is Enabled" + }, + "is_mandatory": { + "type": "boolean", + "title": "Is Mandatory" + }, + "type": { + "type": "string", + "const": "SAML", + "title": "Type" + }, + "configuration": { + "$ref": "#/components/schemas/SAMLConfigurationData-Input" + }, + "mappings": { + "$ref": "#/components/schemas/SAMLConfigurationMappings" + } + }, + "type": "object", + "required": [ + "is_enabled", + "is_mandatory", + "type", + "configuration", + "mappings" + ], + "title": "SAMLSSOConfigurationData" + }, + "SAMLSSOConfigurationData-Output": { + "properties": { + "is_enabled": { + "type": "boolean", + "title": "Is Enabled" + }, + "is_mandatory": { + "type": "boolean", + "title": "Is Mandatory" + }, + "type": { + "type": "string", + "const": "SAML", + "title": "Type" + }, + "configuration": { + "$ref": "#/components/schemas/SAMLConfigurationData-Output" + }, + "mappings": { + "$ref": "#/components/schemas/SAMLConfigurationMappings" + } + }, + "type": "object", + "required": [ + "is_enabled", + "is_mandatory", + "type", + "configuration", + "mappings" + ], + "title": "SAMLSSOConfigurationData" + }, "SandboxSampleSubmission": { "properties": { "uuid": { @@ -25060,7 +27761,10 @@ "format": "date-time", "title": "Submitted At" }, - "report_status": { + "sample_report_status": { + "$ref": "#/components/schemas/SandboxSubmissionReportStatus" + }, + "dynamic_report_status": { "$ref": "#/components/schemas/SandboxSubmissionReportStatus" }, "verdict": { @@ -25092,7 +27796,8 @@ "external_job_id", "size", "submitted_at", - "report_status", + "sample_report_status", + "dynamic_report_status", "verdict", "is_archived" ], @@ -25514,6 +28219,7 @@ "illicit_networks", "open_web", "domains", + "intelligence_object", "leaks", "social_media_account", "social_media", @@ -25810,6 +28516,19 @@ ], "title": "Severity" }, + "SigningCertificateResponse": { + "properties": { + "signing_certificate": { + "type": "string", + "title": "Signing Certificate" + } + }, + "type": "object", + "required": [ + "signing_certificate" + ], + "title": "SigningCertificateResponse" + }, "SocialMediaEvent": { "properties": { "event_type": { @@ -27210,6 +29929,17 @@ } ], "title": "Access End At" + }, + "hubspot_tenant_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Hubspot Tenant Id" } }, "type": "object", @@ -27228,7 +29958,8 @@ "identifier_limit", "permissions", "prevent_global_search", - "access_end_at" + "access_end_at", + "hubspot_tenant_id" ], "title": "TenantPayload" }, @@ -27405,7 +30136,8 @@ "type": "string", "enum": [ "simple_summary", - "expanded_summary" + "expanded_summary", + "finished_intel_standard" ], "title": "ThreatFlowReportFormatType" }, @@ -27916,6 +30648,36 @@ ], "title": "UpdateAuthorizationRequest" }, + "UpdateMatchingPolicyBody": { + "properties": { + "name": { + "type": "string", + "title": "Name", + "description": "The new name of the matching policy" + }, + "value": { + "anyOf": [ + { + "$ref": "#/components/schemas/KeywordsValue" + }, + { + "$ref": "#/components/schemas/LuceneValue" + }, + { + "$ref": "#/components/schemas/AstpCookiesValue" + } + ], + "title": "Value", + "description": "The new value of the matching policy depending on its type" + } + }, + "type": "object", + "required": [ + "name", + "value" + ], + "title": "UpdateMatchingPolicyBody" + }, "UpdatePartialTenantIntegrationPayload": { "properties": { "name": { @@ -28082,8 +30844,9 @@ "properties": { "name": { "type": "string", - "title": "Name", - "default": "Entra ID" + "maxLength": 255, + "minLength": 1, + "title": "Name" }, "is_enabled": { "type": "boolean", @@ -28117,6 +30880,7 @@ }, "type": "object", "required": [ + "name", "params" ], "title": "UpdateTenantIntegrationPayload" @@ -28270,7 +31034,6 @@ "qa.test-bench", "ai-assist-disabled", "leaked_files.allow_download", - "stealer_logs.allow_chat_messages", "file_transfers", "supply_chain_monitoring", "threat_flow_custom_reports", @@ -28297,7 +31060,11 @@ "full_text_contents_download", "foretrace", "labs", - "iem.credentials_browser" + "iem.credentials_browser", + "iem.identity_sync", + "iem.credentials_browser_bulk_validation", + "advanced_security_mode", + "llm_recommendations" ], "title": "UserPermissions" }, @@ -28435,13 +31202,6 @@ ], "title": "WebhookBasicAuth" }, - "_Unset": { - "type": "string", - "enum": [ - "__UNSET__" - ], - "title": "_Unset" - }, "pyro__entities__domain__profile__sort_type__SortType": { "type": "string", "enum": [ diff --git a/docs/api-reference/v4/endpoints/assign-policy.mdx b/docs/api-reference/v4/endpoints/assign-policy.mdx new file mode 100644 index 0000000..472ea3e --- /dev/null +++ b/docs/api-reference/v4/endpoints/assign-policy.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/matching_policies/{policy_uuid}/assignments +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/create-matching-policy.mdx b/docs/api-reference/v4/endpoints/create-matching-policy.mdx new file mode 100644 index 0000000..d8ef0ce --- /dev/null +++ b/docs/api-reference/v4/endpoints/create-matching-policy.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /firework/v4/matching_policies +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/delete-matching-policy.mdx b/docs/api-reference/v4/endpoints/delete-matching-policy.mdx new file mode 100644 index 0000000..7accae1 --- /dev/null +++ b/docs/api-reference/v4/endpoints/delete-matching-policy.mdx @@ -0,0 +1,3 @@ +--- +openapi: delete /firework/v4/matching_policies/{policy_uuid} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/get-matching-policy.mdx b/docs/api-reference/v4/endpoints/get-matching-policy.mdx new file mode 100644 index 0000000..640a156 --- /dev/null +++ b/docs/api-reference/v4/endpoints/get-matching-policy.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/matching_policies/{policy_uuid} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/list-matching-policies-by-identifier-id.mdx b/docs/api-reference/v4/endpoints/list-matching-policies-by-identifier-id.mdx new file mode 100644 index 0000000..0c9881d --- /dev/null +++ b/docs/api-reference/v4/endpoints/list-matching-policies-by-identifier-id.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/matching_policies/by_identifier_id/{identifier_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/list-matching-policies.mdx b/docs/api-reference/v4/endpoints/list-matching-policies.mdx new file mode 100644 index 0000000..aa32e9a --- /dev/null +++ b/docs/api-reference/v4/endpoints/list-matching-policies.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/matching_policies +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/list-policy-assignments.mdx b/docs/api-reference/v4/endpoints/list-policy-assignments.mdx new file mode 100644 index 0000000..545e12e --- /dev/null +++ b/docs/api-reference/v4/endpoints/list-policy-assignments.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /firework/v4/matching_policies/{policy_uuid}/assignments +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/unassign-policy.mdx b/docs/api-reference/v4/endpoints/unassign-policy.mdx new file mode 100644 index 0000000..bdb04bc --- /dev/null +++ b/docs/api-reference/v4/endpoints/unassign-policy.mdx @@ -0,0 +1,3 @@ +--- +openapi: delete /firework/v4/matching_policies/{policy_uuid}/assignments +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/update-matching-policy.mdx b/docs/api-reference/v4/endpoints/update-matching-policy.mdx new file mode 100644 index 0000000..494548d --- /dev/null +++ b/docs/api-reference/v4/endpoints/update-matching-policy.mdx @@ -0,0 +1,3 @@ +--- +openapi: put /firework/v4/matching_policies/{policy_uuid} +--- \ No newline at end of file diff --git a/docs/docs.json b/docs/docs.json index eda5d2e..9fcd23e 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -156,6 +156,20 @@ "api-reference/v4/endpoints/create-action-for-identifier-recommendations" ] }, + { + "group": "Matching Policies", + "pages": [ + "api-reference/v4/endpoints/list-matching-policies", + "api-reference/v4/endpoints/list-matching-policies-by-identifier-id", + "api-reference/v4/endpoints/create-matching-policy", + "api-reference/v4/endpoints/update-matching-policy", + "api-reference/v4/endpoints/get-matching-policy", + "api-reference/v4/endpoints/delete-matching-policy", + "api-reference/v4/endpoints/list-policy-assignments", + "api-reference/v4/endpoints/assign-policy", + "api-reference/v4/endpoints/unassign-policy" + ] + }, { "group": "Alerts", "pages": [ From 04cc286c598af1601faab958b0b254fed1ad6a74 Mon Sep 17 00:00:00 2001 From: Jacob DENIS Date: Wed, 8 Apr 2026 17:00:29 -0400 Subject: [PATCH 02/13] docs(changelog): update for new `matching_policies` endpoints --- docs/changelog/overview.mdx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/changelog/overview.mdx b/docs/changelog/overview.mdx index d62ff10..8d1224d 100644 --- a/docs/changelog/overview.mdx +++ b/docs/changelog/overview.mdx @@ -12,6 +12,14 @@ This page lists changes to Flare's API. Release notes for the Flare Platform can be found on the [product documentation website](https://docs.flare.io/releases). + + Added new endpoints to manage [Matching Policies ](/api-reference/v4/endpoints/list-matching-policies). + + This is useful for customers who want precise control over which events appear in an Identifier’s feed, either by including or excluding events based on keywords, or by scoping results with a specific search query. + + This deprecates the use of the `blacklist` parameter (Ignored Terms) in Identifiers. + + Added new value for the `include` parameter in the [Global Search Credentials Endpoint ](/api-reference/v4/endpoints/credentials-global-search). From 4b5af067a2d80746616611aaab65c738e9880c3e Mon Sep 17 00:00:00 2001 From: Jacob DENIS Date: Thu, 9 Apr 2026 12:45:08 -0400 Subject: [PATCH 03/13] docs(guide): add `create-identifier-with-matching-policies` --- docs/docs.json | 3 +- ...ate-identifiers-with-matching-policies.mdx | 92 +++++++++++++++++++ 2 files changed, 94 insertions(+), 1 deletion(-) create mode 100644 docs/guides/create-identifiers-with-matching-policies.mdx diff --git a/docs/docs.json b/docs/docs.json index 9fcd23e..22f0c62 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -53,7 +53,8 @@ "guides/cookie-monitoring", "guides/ioc-feeds", "guides/threat-flow-report", - "guides/update-identifiers" + "guides/update-identifiers", + "guides/create-identifiers-with-matching-policies" ] } ] diff --git a/docs/guides/create-identifiers-with-matching-policies.mdx b/docs/guides/create-identifiers-with-matching-policies.mdx new file mode 100644 index 0000000..f28ccf1 --- /dev/null +++ b/docs/guides/create-identifiers-with-matching-policies.mdx @@ -0,0 +1,92 @@ +--- +title: 'Create And Assign Matching Policies to Identifiers' +--- +Identifiers (domains, keywords, identities, and other types) and Matching Policies (excluded_keywords, lucene_query and other types) can be created, updated and listed via the Management API. + +This guide covers how to create an identifier and apply a matching policy to it. + +## Steps + + + + Use the + [Create Identifier ](/api-reference/v2/endpoints/identifiers/post-fireworkv2assets) + endpoint to create an identifier. Apply filters to narrow down results to specific identifiers you want to match. + + + + Use the + [Create Matching Policy ](/api-reference/v4/endpoints/create-matching-policy) + endpoint to create a matching policy to precisely control which events should appear in the identifier's feed. + + + + Use the + [Assign Policy ](/api-reference/v4/endpoints/assign-policy) + endpoint to assign the matching policy to the identifier. + + + + +## End-to-end examples + + + + +```python +from flareio import FlareApiClient +from flareio.ratelimit import Limiter + + +api_client = FlareApiClient.from_env() + +limiter_default = Limiter.from_seconds(0.25) + +# 1. Create an Identifier +identifier_resp = api_client.post( + "/firework/v2/assets/", + json={ + "name": "scatterholt.com", + "type": "domain", + "search_types": [ + "forum_post", + ], + "data": {"type": "domain", "fqdn": "scatterholt.com"}, + "risks": [1, 2, 3, 4, 5], + }, +) + +identifier = identifier_resp.json()["asset"] +identifier_id = identifier["id"] + +# Rate limiting (default). +limiter_default.tick() + +# 2. Create a Matching Policy +matching_policy_resp = api_client.post( + "/firework/v4/matching_policies", + json={ + "name": "Terms to ignore", + "type": "EXCLUDED_KEYWORDS", + "value": {"keywords": ["term1", "term2", "term3"]}, + }, +) +matching_policy_name = matching_policy_resp.json()["name"] +matching_policy_uuid = matching_policy_resp.json()["uuid"] + +# Rate limiting (default). +limiter_default.tick() + +# 3. Assign the matching policy to the identifier +api_client.post( + f"/firework/v4/matching_policies/{matching_policy_uuid}/assignments", + json={"identifier_ids": [identifier_id], "clean_past_events": False}, +) + +print( + f"Created identifier {identifier_id} with matching policy '{matching_policy_name}' assigned to it" +) +``` + + + From 8daa52c34aed99c7af009b2f7637384d4e36adab Mon Sep 17 00:00:00 2001 From: Jacob DENIS Date: Thu, 9 Apr 2026 12:46:28 -0400 Subject: [PATCH 04/13] docs(changelog): update for new `create-identifier-with-matching-policies` guide --- docs/changelog/overview.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/changelog/overview.mdx b/docs/changelog/overview.mdx index 8d1224d..307e7bf 100644 --- a/docs/changelog/overview.mdx +++ b/docs/changelog/overview.mdx @@ -17,6 +17,10 @@ Release notes for the Flare Platform can be found on the [product documentation This is useful for customers who want precise control over which events appear in an Identifier’s feed, either by including or excluding events based on keywords, or by scoping results with a specific search query. + The guide + [Create And Assign Matching Policies to Identifiers ](/guides/create-identifiers-with-matching-policies) + was added with an example usage. + This deprecates the use of the `blacklist` parameter (Ignored Terms) in Identifiers. From 3b150d50e818dad6ae0e3658f0da4e325d4c8ecb Mon Sep 17 00:00:00 2001 From: Jacob DENIS Date: Fri, 10 Apr 2026 08:30:32 -0400 Subject: [PATCH 05/13] docs(guide): update `create-identifiers-with-matching-policies` sdk example --- docs/guides/create-identifiers-with-matching-policies.mdx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/guides/create-identifiers-with-matching-policies.mdx b/docs/guides/create-identifiers-with-matching-policies.mdx index f28ccf1..6277417 100644 --- a/docs/guides/create-identifiers-with-matching-policies.mdx +++ b/docs/guides/create-identifiers-with-matching-policies.mdx @@ -71,8 +71,9 @@ matching_policy_resp = api_client.post( "value": {"keywords": ["term1", "term2", "term3"]}, }, ) -matching_policy_name = matching_policy_resp.json()["name"] -matching_policy_uuid = matching_policy_resp.json()["uuid"] +matching_policy = matching_policy_resp.json() +matching_policy_name = matching_policy["name"] +matching_policy_uuid = matching_policy["uuid"] # Rate limiting (default). limiter_default.tick() From 5f3f1f358c31e534630576e4d4f1aa2c71db724a Mon Sep 17 00:00:00 2001 From: Jacob DENIS Date: Fri, 10 Apr 2026 09:10:11 -0400 Subject: [PATCH 06/13] docs(guide): better description for `create-identifiers-with-matching-policies` --- docs/guides/create-identifiers-with-matching-policies.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/guides/create-identifiers-with-matching-policies.mdx b/docs/guides/create-identifiers-with-matching-policies.mdx index 6277417..0140c1d 100644 --- a/docs/guides/create-identifiers-with-matching-policies.mdx +++ b/docs/guides/create-identifiers-with-matching-policies.mdx @@ -3,6 +3,8 @@ title: 'Create And Assign Matching Policies to Identifiers' --- Identifiers (domains, keywords, identities, and other types) and Matching Policies (excluded_keywords, lucene_query and other types) can be created, updated and listed via the Management API. +Matching Policies are useful for customers who want precise control over which events appear in an Identifier’s feed, either by including or excluding events based on keywords, or by scoping results with a specific search query. + This guide covers how to create an identifier and apply a matching policy to it. ## Steps From f4af6972128a8465c0fc6f5313be53ebb96df7fb Mon Sep 17 00:00:00 2001 From: Jacob DENIS Date: Fri, 10 Apr 2026 09:10:36 -0400 Subject: [PATCH 07/13] docs(api): add missing description for `clean_past_events` --- docs/api-reference/spec/firework-v4-openapi.json | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/api-reference/spec/firework-v4-openapi.json b/docs/api-reference/spec/firework-v4-openapi.json index 426d391..c674624 100644 --- a/docs/api-reference/spec/firework-v4-openapi.json +++ b/docs/api-reference/spec/firework-v4-openapi.json @@ -21862,6 +21862,7 @@ "clean_past_events": { "type": "boolean", "title": "Clean Past Events", + "description": "Whether this policy will be applied to historical events", "default": false } }, From fe6c2e1072dbb35a0884bdeea88425551e1c5d76 Mon Sep 17 00:00:00 2001 From: Jacob DENIS Date: Fri, 10 Apr 2026 11:39:54 -0400 Subject: [PATCH 08/13] docs(changelog): update warning message --- docs/changelog/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/changelog/overview.mdx b/docs/changelog/overview.mdx index 307e7bf..8ab540e 100644 --- a/docs/changelog/overview.mdx +++ b/docs/changelog/overview.mdx @@ -21,7 +21,7 @@ Release notes for the Flare Platform can be found on the [product documentation [Create And Assign Matching Policies to Identifiers ](/guides/create-identifiers-with-matching-policies) was added with an example usage. - This deprecates the use of the `blacklist` parameter (Ignored Terms) in Identifiers. + This deprecates the use of the 'blacklist' parameter (Ignored Terms) in identifiers. It will continue to work, but could be removed in the future. From 29598544aa22d08c96d7082bc2bf7fc91e259e64 Mon Sep 17 00:00:00 2001 From: Jacob DENIS Date: Fri, 10 Apr 2026 11:40:20 -0400 Subject: [PATCH 09/13] docs(snippets): add `beta-endpoint` --- docs/snippets/beta-endpoint.mdx | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 docs/snippets/beta-endpoint.mdx diff --git a/docs/snippets/beta-endpoint.mdx b/docs/snippets/beta-endpoint.mdx new file mode 100644 index 0000000..2b6cce9 --- /dev/null +++ b/docs/snippets/beta-endpoint.mdx @@ -0,0 +1,5 @@ +export const name = "This"; + + + The {name} endpoint is still in beta and is subject to change. + \ No newline at end of file From 436adc4b319485c92cdd170bae75b62233107d32 Mon Sep 17 00:00:00 2001 From: Jacob DENIS Date: Fri, 10 Apr 2026 11:40:51 -0400 Subject: [PATCH 10/13] docs(api): use beta snippet in `get-event` --- docs/api-reference/v4/endpoints/get-event.mdx | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/api-reference/v4/endpoints/get-event.mdx b/docs/api-reference/v4/endpoints/get-event.mdx index dbd4c71..264fa2e 100644 --- a/docs/api-reference/v4/endpoints/get-event.mdx +++ b/docs/api-reference/v4/endpoints/get-event.mdx @@ -4,11 +4,10 @@ openapi: firework-v4-openapi get /firework/v4/events/ --- import EventResponses from '/snippets/event_model_examples/events_overview.mdx' +import BetaEndpoint from '/snippets/beta-endpoint.mdx' - -The Retrieve Event V2 endpoint is still in beta and is subject to change. - + \ No newline at end of file From fd6da8533639c5bcd5878e50c35977f105ecd996 Mon Sep 17 00:00:00 2001 From: Jacob DENIS Date: Fri, 10 Apr 2026 11:57:22 -0400 Subject: [PATCH 11/13] docs(api): make `matching_policies` beta --- docs/api-reference/v4/endpoints/assign-policy.mdx | 7 ++++++- docs/api-reference/v4/endpoints/create-matching-policy.mdx | 7 ++++++- docs/api-reference/v4/endpoints/delete-matching-policy.mdx | 7 ++++++- docs/api-reference/v4/endpoints/get-matching-policy.mdx | 7 ++++++- .../endpoints/list-matching-policies-by-identifier-id.mdx | 7 ++++++- docs/api-reference/v4/endpoints/list-matching-policies.mdx | 7 ++++++- .../api-reference/v4/endpoints/list-policy-assignments.mdx | 7 ++++++- docs/api-reference/v4/endpoints/unassign-policy.mdx | 7 ++++++- docs/api-reference/v4/endpoints/update-matching-policy.mdx | 7 ++++++- 9 files changed, 54 insertions(+), 9 deletions(-) diff --git a/docs/api-reference/v4/endpoints/assign-policy.mdx b/docs/api-reference/v4/endpoints/assign-policy.mdx index 472ea3e..adefe4c 100644 --- a/docs/api-reference/v4/endpoints/assign-policy.mdx +++ b/docs/api-reference/v4/endpoints/assign-policy.mdx @@ -1,3 +1,8 @@ --- +title: "Assign Policy (Beta)" openapi: post /firework/v4/matching_policies/{policy_uuid}/assignments ---- \ No newline at end of file +--- + +import BetaEndpoint from '/snippets/beta-endpoint.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/create-matching-policy.mdx b/docs/api-reference/v4/endpoints/create-matching-policy.mdx index d8ef0ce..a5c6b43 100644 --- a/docs/api-reference/v4/endpoints/create-matching-policy.mdx +++ b/docs/api-reference/v4/endpoints/create-matching-policy.mdx @@ -1,3 +1,8 @@ --- +title: "Create Matching Policy (Beta)" openapi: post /firework/v4/matching_policies ---- \ No newline at end of file +--- + +import BetaEndpoint from '/snippets/beta-endpoint.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/delete-matching-policy.mdx b/docs/api-reference/v4/endpoints/delete-matching-policy.mdx index 7accae1..78c4406 100644 --- a/docs/api-reference/v4/endpoints/delete-matching-policy.mdx +++ b/docs/api-reference/v4/endpoints/delete-matching-policy.mdx @@ -1,3 +1,8 @@ --- +title: "Delete Matching Policy (Beta)" openapi: delete /firework/v4/matching_policies/{policy_uuid} ---- \ No newline at end of file +--- + +import BetaEndpoint from '/snippets/beta-endpoint.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/get-matching-policy.mdx b/docs/api-reference/v4/endpoints/get-matching-policy.mdx index 640a156..744480f 100644 --- a/docs/api-reference/v4/endpoints/get-matching-policy.mdx +++ b/docs/api-reference/v4/endpoints/get-matching-policy.mdx @@ -1,3 +1,8 @@ --- +title: "Get Matching Policy (Beta)" openapi: get /firework/v4/matching_policies/{policy_uuid} ---- \ No newline at end of file +--- + +import BetaEndpoint from '/snippets/beta-endpoint.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/list-matching-policies-by-identifier-id.mdx b/docs/api-reference/v4/endpoints/list-matching-policies-by-identifier-id.mdx index 0c9881d..9e9231b 100644 --- a/docs/api-reference/v4/endpoints/list-matching-policies-by-identifier-id.mdx +++ b/docs/api-reference/v4/endpoints/list-matching-policies-by-identifier-id.mdx @@ -1,3 +1,8 @@ --- +title: "List Matching Policies By Identifier Id (Beta)" openapi: get /firework/v4/matching_policies/by_identifier_id/{identifier_id} ---- \ No newline at end of file +--- + +import BetaEndpoint from '/snippets/beta-endpoint.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/list-matching-policies.mdx b/docs/api-reference/v4/endpoints/list-matching-policies.mdx index aa32e9a..f4f9326 100644 --- a/docs/api-reference/v4/endpoints/list-matching-policies.mdx +++ b/docs/api-reference/v4/endpoints/list-matching-policies.mdx @@ -1,3 +1,8 @@ --- +title: "List Matching Policies (Beta)" openapi: get /firework/v4/matching_policies ---- \ No newline at end of file +--- + +import BetaEndpoint from '/snippets/beta-endpoint.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/list-policy-assignments.mdx b/docs/api-reference/v4/endpoints/list-policy-assignments.mdx index 545e12e..71e3891 100644 --- a/docs/api-reference/v4/endpoints/list-policy-assignments.mdx +++ b/docs/api-reference/v4/endpoints/list-policy-assignments.mdx @@ -1,3 +1,8 @@ --- +title: "List Policy Assignments (Beta)" openapi: get /firework/v4/matching_policies/{policy_uuid}/assignments ---- \ No newline at end of file +--- + +import BetaEndpoint from '/snippets/beta-endpoint.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/unassign-policy.mdx b/docs/api-reference/v4/endpoints/unassign-policy.mdx index bdb04bc..9cce868 100644 --- a/docs/api-reference/v4/endpoints/unassign-policy.mdx +++ b/docs/api-reference/v4/endpoints/unassign-policy.mdx @@ -1,3 +1,8 @@ --- +title: "Unassign Policy (Beta)" openapi: delete /firework/v4/matching_policies/{policy_uuid}/assignments ---- \ No newline at end of file +--- + +import BetaEndpoint from '/snippets/beta-endpoint.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/update-matching-policy.mdx b/docs/api-reference/v4/endpoints/update-matching-policy.mdx index 494548d..19b13eb 100644 --- a/docs/api-reference/v4/endpoints/update-matching-policy.mdx +++ b/docs/api-reference/v4/endpoints/update-matching-policy.mdx @@ -1,3 +1,8 @@ --- +title: "Update Matching Policy (Beta)" openapi: put /firework/v4/matching_policies/{policy_uuid} ---- \ No newline at end of file +--- + +import BetaEndpoint from '/snippets/beta-endpoint.mdx' + + \ No newline at end of file From fc51b189369f3a9cde57cc41090bcb5caae81019 Mon Sep 17 00:00:00 2001 From: Jacob DENIS Date: Fri, 10 Apr 2026 12:02:28 -0400 Subject: [PATCH 12/13] docs(snippet): fix `beta-endpoint` --- docs/snippets/beta-endpoint.mdx | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/snippets/beta-endpoint.mdx b/docs/snippets/beta-endpoint.mdx index 2b6cce9..a1598f2 100644 --- a/docs/snippets/beta-endpoint.mdx +++ b/docs/snippets/beta-endpoint.mdx @@ -1,5 +1,3 @@ -export const name = "This"; - The {name} endpoint is still in beta and is subject to change. \ No newline at end of file From e8e0f9896ccdea53e41bb41cf5d32df1f7232454 Mon Sep 17 00:00:00 2001 From: Jacob DENIS Date: Fri, 10 Apr 2026 12:05:50 -0400 Subject: [PATCH 13/13] docs(api): update `get-matching-policy` title --- docs/api-reference/v4/endpoints/get-matching-policy.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api-reference/v4/endpoints/get-matching-policy.mdx b/docs/api-reference/v4/endpoints/get-matching-policy.mdx index 744480f..152e64c 100644 --- a/docs/api-reference/v4/endpoints/get-matching-policy.mdx +++ b/docs/api-reference/v4/endpoints/get-matching-policy.mdx @@ -1,8 +1,8 @@ --- -title: "Get Matching Policy (Beta)" +title: "Retrieve Matching Policy (Beta)" openapi: get /firework/v4/matching_policies/{policy_uuid} --- import BetaEndpoint from '/snippets/beta-endpoint.mdx' - \ No newline at end of file + \ No newline at end of file