From f49e7ea40d759a46f713d74e9728e1537938b91b Mon Sep 17 00:00:00 2001 From: Simon Roy Date: Wed, 16 Sep 2026 15:49:30 -0400 Subject: [PATCH 1/6] make generate --- .../spec/firework-v2-openapi.json | 6904 ---------------- .../spec/firework-v2-swagger.json | 6933 ----------------- .../spec/firework-v3-openapi.json | 7 +- .../spec/firework-v3-swagger.json | 43 +- .../spec/firework-v4-openapi.json | 89 +- openapitools.json | 7 + 6 files changed, 121 insertions(+), 13862 deletions(-) delete mode 100644 docs/api-reference/spec/firework-v2-openapi.json create mode 100644 openapitools.json diff --git a/docs/api-reference/spec/firework-v2-openapi.json b/docs/api-reference/spec/firework-v2-openapi.json deleted file mode 100644 index 786930c5..00000000 --- a/docs/api-reference/spec/firework-v2-openapi.json +++ /dev/null @@ -1,6904 +0,0 @@ -{ - "openapi": "3.0.1", - "info": { - "description": "\nManage and access Firework resources.\n\n### Steps to use the Api\n\n1. `Send` a POST request to `https://api.flare.systems/tokens/generate` with your **Firework** credentials using [Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication) to get a authentication token.\n---\n2. On the current page, click on the **Authorize** button and insert the token using the following format: `Bearer {token}`\n\n Example value: `Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e30.Et9HFtf9R3GEMA0IICOfFMVXY7kkTX1wr4qCyhIf58U`\n---\n3. You should now be able to use SwaggerUI's built-in tools to query the documented endpoints.\n", - "title": "Firework API", - "version": "v2" - }, - "servers": [ - { - "url": "https://api.flare.io/" - } - ], - "security": [ - { - "BearerAuth": [] - } - ], - "tags": [ - { - "description": "Searches the threat activity database.", - "name": "search" - }, - { - "description": "Manage a user's or organization's identifiers", - "name": "Identifiers" - }, - { - "description": "Perform actions on activities.", - "name": "activities" - }, - { - "description": "Perform actions on the current user.", - "name": "me" - }, - { - "description": "Manage tenants.", - "name": "tenants" - }, - { - "description": "Admin management of organizations.", - "name": "organizations" - }, - { - "description": "Manage reporting as an admin.", - "name": "reporting" - } - ], - "paths": { - "/firework/v2/activities/": { - "get": { - "operationId": "get_activity_endpoint_/activities/", - "parameters": [ - { - "in": "query", - "name": "uid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": {}, - "description": "Returns the activity" - }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Activity not found" - } - }, - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/actor/profile/{actor_name}": { - "get": { - "operationId": "get_actor_/activities/actor/profile/", - "parameters": [ - { - "in": "path", - "name": "actor_name", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": " Limit results to those found in this time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z", - "in": "query", - "name": "actor_time", - "schema": { - "type": "string" - } - }, - { - "description": "Maximum number of hits returned per query.", - "in": "query", - "name": "actor_size", - "schema": { - "default": 100, - "type": "integer" - } - }, - { - "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, use the latest response's `search_after` attribute for the next request to get the next page of results.", - "in": "query", - "name": "actor_search_after", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": {}, - "description": "Returns the actor" - } - }, - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/document/{source}/{id}/extensions": { - "get": { - "operationId": "get_ransom_leak_file_extensions_endpoint_/activities/document///extensions", - "parameters": [ - { - "in": "path", - "name": "source", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": {}, - "description": "Returns all the different file extensions that were found in the files of a ransom leak." - }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Activity not found" - } - }, - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/document/{source}/{id}/files": { - "get": { - "operationId": "get_ransom_leak_files_endpoint_/activities/document///files", - "parameters": [ - { - "in": "path", - "name": "source", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": {}, - "description": "Returns the files in a ransom leak matching the specified query" - }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Activity not found" - } - }, - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/leak/{source}/{keyword}": { - "get": { - "operationId": "get_leak_endpoint_/activities/leak//", - "parameters": [ - { - "in": "path", - "name": "source", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "keyword", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": {}, - "description": "Returns the leak activity" - }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Leak activity not found" - } - }, - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/leak/{source}/{keyword}/count": { - "get": { - "operationId": "get_leak_count_/activities/leak///count", - "parameters": [ - { - "in": "path", - "name": "source", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "keyword", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": {}, - "description": "Success" - } - }, - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id_}/user_metadata": { - "get": { - "operationId": "get_activity_user_metadata_resource_/activities////user_metadata", - "parameters": [ - { - "in": "path", - "name": "index", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "source", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "id_", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActivityUserMetadata" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id_}/user_metadata/ignored": { - "put": { - "operationId": "put_activity_user_metadata_ignored_/activities////user_metadata/ignored", - "parameters": [ - { - "in": "path", - "name": "index", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "source", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "id_", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActivityUserMetadataIgnored" - } - } - }, - "required": true - }, - "responses": { - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Query is invalid." - }, - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActivityUserMetadata" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "activities" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/activities/{index}/{source}/{id_}/user_metadata/notes": { - "put": { - "operationId": "put_activity_user_metadata_notes_/activities////user_metadata/notes", - "parameters": [ - { - "in": "path", - "name": "index", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "source", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "id_", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActivityUserNotes" - } - } - }, - "required": true - }, - "responses": { - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Query is invalid." - }, - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActivityUserMetadata" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "activities" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/activities/{index}/{source}/{id_}/user_metadata/remediated": { - "put": { - "operationId": "put_activity_user_metadata_remediated_/activities////user_metadata/remediated", - "parameters": [ - { - "in": "path", - "name": "index", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "source", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "id_", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActivityUserMetadataRemediated" - } - } - }, - "required": true - }, - "responses": { - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Query is invalid." - }, - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActivityUserMetadata" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "activities" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/activities/{index}/{source}/{id_}/user_metadata/risk_score": { - "put": { - "operationId": "put_activity_user_metadata_risk_score_/activities////user_metadata/risk_score", - "parameters": [ - { - "in": "path", - "name": "index", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "source", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "id_", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActivityUserRiskScore" - } - } - }, - "required": true - }, - "responses": { - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Query is invalid." - }, - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActivityUserMetadata" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "activities" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/activities/{index}/{source}/{id_}/user_metadata/tags": { - "delete": { - "operationId": "delete_activity_user_metadata_tags_/activities////user_metadata/tags", - "parameters": [ - { - "in": "path", - "name": "index", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "source", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "id_", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": {}, - "description": "Success" - } - }, - "tags": [ - "activities" - ] - }, - "get": { - "operationId": "get_activity_user_metadata_tags_/activities////user_metadata/tags", - "parameters": [ - { - "in": "path", - "name": "index", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "source", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "id_", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActivityUserMetadata" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "activities" - ] - }, - "put": { - "operationId": "put_activity_user_metadata_tags_/activities////user_metadata/tags", - "parameters": [ - { - "in": "path", - "name": "index", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "source", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "id_", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActivityUserTags" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActivityUserMetadata" - } - } - }, - "description": "Success" - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Query is invalid." - } - }, - "tags": [ - "activities" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/activities/{index}/{source}/{id}": { - "get": { - "operationId": "get_activity_endpoint_deprecated_/activities///", - "parameters": [ - { - "in": "path", - "name": "index", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "source", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": {}, - "description": "Returns the activity" - }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Activity not found" - } - }, - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id}/ai_assistance": { - "get": { - "operationId": "get_activity_assistance_resource_/activities////ai_assistance", - "parameters": [ - { - "in": "path", - "name": "index", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "source", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/get_activity_assistance_resource__activities__string_index___string_source___path_id__ai_assistance_200_response" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id}/enrichment": { - "get": { - "operationId": "get_activity_enrichment_endpoint_/activities////enrichment", - "parameters": [ - { - "in": "path", - "name": "index", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "source", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": {}, - "description": "Returns the activity enrichment" - }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Activity not found" - } - }, - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id}/events": { - "get": { - "operationId": "get_entity_events_/activities////events", - "parameters": [ - { - "in": "path", - "name": "index", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "source", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Start from this key when paginating events.", - "in": "query", - "name": "from", - "schema": { - "type": "integer" - } - }, - { - "description": "Limit the events per page.", - "in": "query", - "name": "size", - "schema": { - "default": 100, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": {}, - "description": "Returns events associated with the entity" - } - }, - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id}/highlights": { - "post": { - "operationId": "post_activity_highlights_/activities////highlights", - "parameters": [ - { - "in": "path", - "name": "index", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "source", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HighlightPayload" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": {}, - "description": "Returns the highlights of an activity" - }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Activity not found" - } - }, - "tags": [ - "activities" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/activities/{index}/{source}/{id}/leaked_data": { - "get": { - "operationId": "get_leaked_data_/activities////leaked_data", - "parameters": [ - { - "in": "path", - "name": "index", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "source", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Activity not found" - }, - "200": { - "content": {}, - "description": "Returns the related leaked_data" - } - }, - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id}/messages": { - "get": { - "operationId": "get_activity_messages_/activities////messages", - "parameters": [ - { - "in": "path", - "name": "index", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "source", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": {}, - "description": "Returns the related messages" - }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Activity not found" - } - }, - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id}/parent_chat_data": { - "get": { - "operationId": "get_parent_activity_data_/activities////parent_chat_data", - "parameters": [ - { - "in": "path", - "name": "index", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "source", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Activity not found" - }, - "200": { - "content": {}, - "description": "Returns the related parent_uids data" - } - }, - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id}/related/{context}": { - "get": { - "operationId": "get_related_items_/activities////related/", - "parameters": [ - { - "in": "path", - "name": "index", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "source", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "context", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "ID of an identifier.", - "explode": true, - "in": "query", - "name": "identifier_ids", - "schema": { - "items": { - "type": "integer" - }, - "type": "array" - }, - "style": "form" - } - ], - "responses": { - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Activity have no related items" - }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Activity not found" - }, - "200": { - "content": {}, - "description": "Returns related activities" - } - }, - "tags": [ - "activities" - ] - } - }, - "/firework/v2/assets/": { - "get": { - "operationId": "get_assets_/assets/", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/get_assets__assets__200_response" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "Identifiers" - ] - }, - "post": { - "operationId": "post_assets_/assets/", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IdentifierCreate" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/post_assets__assets__200_response" - } - } - }, - "description": "Success" - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Query is invalid." - } - }, - "tags": [ - "Identifiers" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/assets/groups/": { - "get": { - "operationId": "get_assets_groups_/assets/groups/", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/get_assets_groups__assets_groups__200_response" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "Identifiers" - ] - }, - "post": { - "operationId": "post_assets_groups_/assets/groups/", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IdentifierGroup" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/post_assets_groups__assets_groups__200_response" - } - } - }, - "description": "Success" - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Query is invalid." - } - }, - "tags": [ - "Identifiers" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/assets/groups/{assets_group_id}": { - "delete": { - "operationId": "delete_assets_group_api_/assets/groups/", - "parameters": [ - { - "in": "path", - "name": "assets_group_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": {}, - "description": "Success" - } - }, - "tags": [ - "Identifiers" - ] - }, - "get": { - "operationId": "get_assets_group_api_/assets/groups/", - "parameters": [ - { - "in": "path", - "name": "assets_group_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/post_assets_groups__assets_groups__200_response" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "Identifiers" - ] - }, - "put": { - "operationId": "put_assets_group_api_/assets/groups/", - "parameters": [ - { - "in": "path", - "name": "assets_group_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateGroupData" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/post_assets_groups__assets_groups__200_response" - } - } - }, - "description": "Success" - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Query is invalid." - } - }, - "tags": [ - "Identifiers" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/assets/groups/{assets_group_id}/alerts": { - "get": { - "operationId": "get_assets_group_alerts_/assets/groups//alerts", - "parameters": [ - { - "in": "path", - "name": "assets_group_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/get_assets_group_alerts__assets_groups__int_assets_group_id__alerts_200_response" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "Identifiers" - ] - }, - "post": { - "operationId": "post_assets_group_alerts_/assets/groups//alerts", - "parameters": [ - { - "in": "path", - "name": "assets_group_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FeedAlert" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FeedAlert" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "Identifiers" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/assets/groups/{assets_group_id}/alerts/{alert_id}": { - "delete": { - "operationId": "delete_assets_group_alert_/assets/groups//alerts/", - "parameters": [ - { - "in": "path", - "name": "assets_group_id", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "path", - "name": "alert_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": {}, - "description": "Success" - } - }, - "tags": [ - "Identifiers" - ] - }, - "put": { - "operationId": "put_assets_group_alert_/assets/groups//alerts/", - "parameters": [ - { - "in": "path", - "name": "assets_group_id", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "path", - "name": "alert_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FeedAlert" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FeedAlert" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "Identifiers" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/assets/groups/{assets_group_id}/feed": { - "get": { - "operationId": "get_assets_group_feed_/assets/groups//feed", - "parameters": [ - { - "in": "path", - "name": "assets_group_id", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", - "explode": true, - "in": "query", - "name": "fields", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z", - "in": "query", - "name": "time", - "schema": { - "type": "string" - } - }, - { - "description": "The `size` parameter is used to limit the number of results returned for the search query.", - "in": "query", - "name": "size", - "schema": { - "default": 10, - "type": "integer" - } - }, - { - "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results.", - "in": "query", - "name": "search_after", - "schema": { - "type": "string" - } - }, - { - "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results.", - "in": "query", - "name": "from", - "schema": { - "type": "string" - } - }, - { - "description": "User defined tags used to filter search results", - "explode": true, - "in": "query", - "name": "tags", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "User defined operator to apply to tags filter", - "in": "query", - "name": "tags_query_operator", - "schema": { - "type": "string" - } - }, - { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", - "explode": true, - "in": "query", - "name": "types", - "schema": { - "enum": [ - "attachment", - "listing", - "ransomleak", - "forum_post", - "forum_topic", - "forum_profile", - "blog_post", - "seller", - "paste", - "leak", - "chat_message", - "domain", - "bot", - "stealer_log", - "infected_devices", - "driller", - "driller_forum_topic", - "driller_forum_post", - "driller_profile", - "cc", - "ccbin", - "financial_data", - "leaked_data", - "leaked_file", - "document", - "account", - "actor", - "forum_content", - "blog_content", - "profile", - "leaked_credential", - "valid_credential", - "invalid_credential", - "mitigated_credential", - "illicit_networks", - "open_web", - "domains", - "intelligence_object", - "leaks", - "social_media_account", - "social_media", - "source_code", - "source_code_secrets_np", - "source_code_secrets", - "source_code_files", - "docker", - "stack_exchange", - "google", - "service", - "driller_host", - "buckets", - "bucket", - "bucket_object", - "whois", - "ad", - "ads", - "cookie", - "pii", - "experimental" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Type of experimental activities to search through.", - "explode": true, - "in": "query", - "name": "experimental_types", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "query", - "name": "event_action", - "schema": { - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ], - "type": "string" - } - }, - { - "explode": true, - "in": "query", - "name": "event_actions", - "schema": { - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "explode": true, - "in": "query", - "name": "risks", - "schema": { - "enum": [ - "1", - "2", - "3", - "4", - "5" - ], - "items": { - "type": "integer" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "query", - "name": "order", - "schema": { - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "sort_by", - "schema": { - "default": "created", - "enum": [ - "created", - "indexed", - "updated", - "alertable-materialized", - "materialized", - "searchable" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "use_global_policies", - "schema": { - "default": true, - "type": "boolean" - } - }, - { - "description": "The time zone used to compute the statistics.", - "in": "query", - "name": "time_zone", - "schema": { - "type": "string" - } - }, - { - "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax.", - "in": "query", - "name": "query", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "has_modified_risk_score", - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "in": "query", - "name": "has_notes", - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "responses": { - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Identifier group does not exist." - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Query is invalid." - }, - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Search" - } - } - }, - "description": "Returns the search result(s)." - } - }, - "tags": [ - "Identifiers" - ] - }, - "post": { - "operationId": "post_assets_group_feed_/assets/groups//feed", - "parameters": [ - { - "in": "path", - "name": "assets_group_id", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", - "explode": true, - "in": "query", - "name": "fields", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z", - "in": "query", - "name": "time", - "schema": { - "type": "string" - } - }, - { - "description": "The `size` parameter is used to limit the number of results returned for the search query.", - "in": "query", - "name": "size", - "schema": { - "default": 10, - "type": "integer" - } - }, - { - "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results.", - "in": "query", - "name": "search_after", - "schema": { - "type": "string" - } - }, - { - "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results.", - "in": "query", - "name": "from", - "schema": { - "type": "string" - } - }, - { - "description": "User defined tags used to filter search results", - "explode": true, - "in": "query", - "name": "tags", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "User defined operator to apply to tags filter", - "in": "query", - "name": "tags_query_operator", - "schema": { - "type": "string" - } - }, - { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", - "explode": true, - "in": "query", - "name": "types", - "schema": { - "enum": [ - "attachment", - "listing", - "ransomleak", - "forum_post", - "forum_topic", - "forum_profile", - "blog_post", - "seller", - "paste", - "leak", - "chat_message", - "domain", - "bot", - "stealer_log", - "infected_devices", - "driller", - "driller_forum_topic", - "driller_forum_post", - "driller_profile", - "cc", - "ccbin", - "financial_data", - "leaked_data", - "leaked_file", - "document", - "account", - "actor", - "forum_content", - "blog_content", - "profile", - "leaked_credential", - "valid_credential", - "invalid_credential", - "mitigated_credential", - "illicit_networks", - "open_web", - "domains", - "intelligence_object", - "leaks", - "social_media_account", - "social_media", - "source_code", - "source_code_secrets_np", - "source_code_secrets", - "source_code_files", - "docker", - "stack_exchange", - "google", - "service", - "driller_host", - "buckets", - "bucket", - "bucket_object", - "whois", - "ad", - "ads", - "cookie", - "pii", - "experimental" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Type of experimental activities to search through.", - "explode": true, - "in": "query", - "name": "experimental_types", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "query", - "name": "event_action", - "schema": { - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ], - "type": "string" - } - }, - { - "explode": true, - "in": "query", - "name": "event_actions", - "schema": { - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "explode": true, - "in": "query", - "name": "risks", - "schema": { - "enum": [ - "1", - "2", - "3", - "4", - "5" - ], - "items": { - "type": "integer" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "query", - "name": "order", - "schema": { - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "sort_by", - "schema": { - "default": "created", - "enum": [ - "created", - "indexed", - "updated", - "alertable-materialized", - "materialized", - "searchable" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "use_global_policies", - "schema": { - "default": true, - "type": "boolean" - } - }, - { - "description": "The time zone used to compute the statistics.", - "in": "query", - "name": "time_zone", - "schema": { - "type": "string" - } - }, - { - "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax.", - "in": "query", - "name": "query", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "has_modified_risk_score", - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "in": "query", - "name": "has_notes", - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "responses": { - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Identifier group does not exist." - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Query is invalid." - }, - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Search" - } - } - }, - "description": "Returns the search result(s)." - } - }, - "tags": [ - "Identifiers" - ] - } - }, - "/firework/v2/assets/{asset_id}": { - "delete": { - "operationId": "delete_asset_api_/assets/", - "parameters": [ - { - "in": "path", - "name": "asset_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": {}, - "description": "Success" - } - }, - "tags": [ - "Identifiers" - ] - }, - "get": { - "operationId": "get_asset_api_/assets/", - "parameters": [ - { - "in": "path", - "name": "asset_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/post_assets__assets__200_response" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "Identifiers" - ] - }, - "put": { - "operationId": "put_asset_api_/assets/", - "parameters": [ - { - "in": "path", - "name": "asset_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Identifier" - } - } - }, - "required": true - }, - "responses": { - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Query is invalid." - }, - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/post_assets__assets__200_response" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "Identifiers" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/assets/{asset_id}/alerts": { - "get": { - "operationId": "get_asset_alerts_/assets//alerts", - "parameters": [ - { - "in": "path", - "name": "asset_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/get_assets_group_alerts__assets_groups__int_assets_group_id__alerts_200_response" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "Identifiers" - ] - }, - "post": { - "operationId": "post_asset_alerts_/assets//alerts", - "parameters": [ - { - "in": "path", - "name": "asset_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FeedAlert" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FeedAlert" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "Identifiers" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/assets/{asset_id}/alerts/{alert_id}": { - "delete": { - "operationId": "delete_asset_alert_/assets//alerts/", - "parameters": [ - { - "in": "path", - "name": "asset_id", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "path", - "name": "alert_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": {}, - "description": "Success" - } - }, - "tags": [ - "Identifiers" - ] - }, - "put": { - "operationId": "put_asset_alert_/assets//alerts/", - "parameters": [ - { - "in": "path", - "name": "asset_id", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "path", - "name": "alert_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FeedAlert" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FeedAlert" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "Identifiers" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/assets/{asset_id}/feed": { - "get": { - "operationId": "get_asset_feed_/assets//feed", - "parameters": [ - { - "in": "path", - "name": "asset_id", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", - "explode": true, - "in": "query", - "name": "fields", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z", - "in": "query", - "name": "time", - "schema": { - "type": "string" - } - }, - { - "description": "The `size` parameter is used to limit the number of results returned for the search query.", - "in": "query", - "name": "size", - "schema": { - "default": 10, - "type": "integer" - } - }, - { - "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results.", - "in": "query", - "name": "search_after", - "schema": { - "type": "string" - } - }, - { - "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results.", - "in": "query", - "name": "from", - "schema": { - "type": "string" - } - }, - { - "description": "User defined tags used to filter search results", - "explode": true, - "in": "query", - "name": "tags", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "User defined operator to apply to tags filter", - "in": "query", - "name": "tags_query_operator", - "schema": { - "type": "string" - } - }, - { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", - "explode": true, - "in": "query", - "name": "types", - "schema": { - "enum": [ - "attachment", - "listing", - "ransomleak", - "forum_post", - "forum_topic", - "forum_profile", - "blog_post", - "seller", - "paste", - "leak", - "chat_message", - "domain", - "bot", - "stealer_log", - "infected_devices", - "driller", - "driller_forum_topic", - "driller_forum_post", - "driller_profile", - "cc", - "ccbin", - "financial_data", - "leaked_data", - "leaked_file", - "document", - "account", - "actor", - "forum_content", - "blog_content", - "profile", - "leaked_credential", - "valid_credential", - "invalid_credential", - "mitigated_credential", - "illicit_networks", - "open_web", - "domains", - "intelligence_object", - "leaks", - "social_media_account", - "social_media", - "source_code", - "source_code_secrets_np", - "source_code_secrets", - "source_code_files", - "docker", - "stack_exchange", - "google", - "service", - "driller_host", - "buckets", - "bucket", - "bucket_object", - "whois", - "ad", - "ads", - "cookie", - "pii", - "experimental" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Type of experimental activities to search through.", - "explode": true, - "in": "query", - "name": "experimental_types", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "query", - "name": "event_action", - "schema": { - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ], - "type": "string" - } - }, - { - "explode": true, - "in": "query", - "name": "event_actions", - "schema": { - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "explode": true, - "in": "query", - "name": "risks", - "schema": { - "enum": [ - "1", - "2", - "3", - "4", - "5" - ], - "items": { - "type": "integer" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "query", - "name": "order", - "schema": { - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "sort_by", - "schema": { - "default": "created", - "enum": [ - "created", - "indexed", - "updated", - "alertable-materialized", - "materialized", - "searchable" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "use_global_policies", - "schema": { - "default": true, - "type": "boolean" - } - }, - { - "description": "The time zone used to compute the statistics.", - "in": "query", - "name": "time_zone", - "schema": { - "type": "string" - } - }, - { - "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax.", - "in": "query", - "name": "query", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "has_modified_risk_score", - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "in": "query", - "name": "has_notes", - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "responses": { - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Identifier does not exist." - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Query is invalid." - }, - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Search" - } - } - }, - "description": "Returns the search result(s)." - } - }, - "tags": [ - "Identifiers" - ] - }, - "post": { - "operationId": "post_asset_feed_/assets//feed", - "parameters": [ - { - "in": "path", - "name": "asset_id", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", - "explode": true, - "in": "query", - "name": "fields", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z", - "in": "query", - "name": "time", - "schema": { - "type": "string" - } - }, - { - "description": "The `size` parameter is used to limit the number of results returned for the search query.", - "in": "query", - "name": "size", - "schema": { - "default": 10, - "type": "integer" - } - }, - { - "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results.", - "in": "query", - "name": "search_after", - "schema": { - "type": "string" - } - }, - { - "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results.", - "in": "query", - "name": "from", - "schema": { - "type": "string" - } - }, - { - "description": "User defined tags used to filter search results", - "explode": true, - "in": "query", - "name": "tags", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "User defined operator to apply to tags filter", - "in": "query", - "name": "tags_query_operator", - "schema": { - "type": "string" - } - }, - { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", - "explode": true, - "in": "query", - "name": "types", - "schema": { - "enum": [ - "attachment", - "listing", - "ransomleak", - "forum_post", - "forum_topic", - "forum_profile", - "blog_post", - "seller", - "paste", - "leak", - "chat_message", - "domain", - "bot", - "stealer_log", - "infected_devices", - "driller", - "driller_forum_topic", - "driller_forum_post", - "driller_profile", - "cc", - "ccbin", - "financial_data", - "leaked_data", - "leaked_file", - "document", - "account", - "actor", - "forum_content", - "blog_content", - "profile", - "leaked_credential", - "valid_credential", - "invalid_credential", - "mitigated_credential", - "illicit_networks", - "open_web", - "domains", - "intelligence_object", - "leaks", - "social_media_account", - "social_media", - "source_code", - "source_code_secrets_np", - "source_code_secrets", - "source_code_files", - "docker", - "stack_exchange", - "google", - "service", - "driller_host", - "buckets", - "bucket", - "bucket_object", - "whois", - "ad", - "ads", - "cookie", - "pii", - "experimental" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Type of experimental activities to search through.", - "explode": true, - "in": "query", - "name": "experimental_types", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "query", - "name": "event_action", - "schema": { - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ], - "type": "string" - } - }, - { - "explode": true, - "in": "query", - "name": "event_actions", - "schema": { - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "explode": true, - "in": "query", - "name": "risks", - "schema": { - "enum": [ - "1", - "2", - "3", - "4", - "5" - ], - "items": { - "type": "integer" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "query", - "name": "order", - "schema": { - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "sort_by", - "schema": { - "default": "created", - "enum": [ - "created", - "indexed", - "updated", - "alertable-materialized", - "materialized", - "searchable" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "use_global_policies", - "schema": { - "default": true, - "type": "boolean" - } - }, - { - "description": "The time zone used to compute the statistics.", - "in": "query", - "name": "time_zone", - "schema": { - "type": "string" - } - }, - { - "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax.", - "in": "query", - "name": "query", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "has_modified_risk_score", - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "in": "query", - "name": "has_notes", - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "responses": { - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Identifier does not exist." - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Query is invalid." - }, - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Search" - } - } - }, - "description": "Returns the search result(s)." - } - }, - "tags": [ - "Identifiers" - ] - } - }, - "/firework/v2/assets/{asset_id}/highlights/{index}/{source}/{id}": { - "get": { - "operationId": "get_identifier_activity_highlights_/assets//highlights///", - "parameters": [ - { - "in": "path", - "name": "asset_id", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "path", - "name": "index", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "source", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": {}, - "description": "Returns the highlights of the identifier data matching on an activity content." - }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Identifier or activity does not exist." - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Query is invalid." - } - }, - "tags": [ - "Identifiers" - ] - } - }, - "/firework/v2/assets/{asset_id}/toggle": { - "post": { - "operationId": "post_identifier_toggle_/assets//toggle", - "parameters": [ - { - "in": "path", - "name": "asset_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IdentifierToggle" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/post_assets__assets__200_response" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "Identifiers" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/me/feed": { - "get": { - "operationId": "get_current_user_home_feed_/me/feed", - "parameters": [ - { - "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z", - "in": "query", - "name": "time", - "schema": { - "type": "string" - } - }, - { - "description": "The `size` parameter is used to limit the number of results returned for the search query.", - "in": "query", - "name": "size", - "schema": { - "default": 10, - "type": "integer" - } - }, - { - "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results.", - "in": "query", - "name": "search_after", - "schema": { - "type": "string" - } - }, - { - "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results.", - "in": "query", - "name": "from", - "schema": { - "type": "string" - } - }, - { - "description": "User defined tags used to filter search results", - "explode": true, - "in": "query", - "name": "tags", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "User defined operator to apply to tags filter", - "in": "query", - "name": "tags_query_operator", - "schema": { - "type": "string" - } - }, - { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", - "explode": true, - "in": "query", - "name": "types", - "schema": { - "enum": [ - "attachment", - "listing", - "ransomleak", - "forum_post", - "forum_topic", - "forum_profile", - "blog_post", - "seller", - "paste", - "leak", - "chat_message", - "domain", - "bot", - "stealer_log", - "infected_devices", - "driller", - "driller_forum_topic", - "driller_forum_post", - "driller_profile", - "cc", - "ccbin", - "financial_data", - "leaked_data", - "leaked_file", - "document", - "account", - "actor", - "forum_content", - "blog_content", - "profile", - "leaked_credential", - "valid_credential", - "invalid_credential", - "mitigated_credential", - "illicit_networks", - "open_web", - "domains", - "intelligence_object", - "leaks", - "social_media_account", - "social_media", - "source_code", - "source_code_secrets_np", - "source_code_secrets", - "source_code_files", - "docker", - "stack_exchange", - "google", - "service", - "driller_host", - "buckets", - "bucket", - "bucket_object", - "whois", - "ad", - "ads", - "cookie", - "pii", - "experimental" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Type of experimental activities to search through.", - "explode": true, - "in": "query", - "name": "experimental_types", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "query", - "name": "event_action", - "schema": { - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ], - "type": "string" - } - }, - { - "explode": true, - "in": "query", - "name": "event_actions", - "schema": { - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "explode": true, - "in": "query", - "name": "risks", - "schema": { - "enum": [ - "1", - "2", - "3", - "4", - "5" - ], - "items": { - "type": "integer" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "query", - "name": "order", - "schema": { - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "sort_by", - "schema": { - "default": "created", - "enum": [ - "created", - "indexed", - "updated", - "alertable-materialized", - "materialized", - "searchable" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "use_global_policies", - "schema": { - "default": true, - "type": "boolean" - } - }, - { - "description": "The time zone used to compute the statistics.", - "in": "query", - "name": "time_zone", - "schema": { - "type": "string" - } - }, - { - "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax.", - "in": "query", - "name": "query", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "has_modified_risk_score", - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "in": "query", - "name": "has_notes", - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Search" - } - } - }, - "description": "The user's home feed activities" - } - }, - "tags": [ - "me" - ] - }, - "post": { - "operationId": "post_current_user_home_feed_/me/feed", - "parameters": [ - { - "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z", - "in": "query", - "name": "time", - "schema": { - "type": "string" - } - }, - { - "description": "The `size` parameter is used to limit the number of results returned for the search query.", - "in": "query", - "name": "size", - "schema": { - "default": 10, - "type": "integer" - } - }, - { - "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results.", - "in": "query", - "name": "search_after", - "schema": { - "type": "string" - } - }, - { - "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results.", - "in": "query", - "name": "from", - "schema": { - "type": "string" - } - }, - { - "description": "User defined tags used to filter search results", - "explode": true, - "in": "query", - "name": "tags", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "User defined operator to apply to tags filter", - "in": "query", - "name": "tags_query_operator", - "schema": { - "type": "string" - } - }, - { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", - "explode": true, - "in": "query", - "name": "types", - "schema": { - "enum": [ - "attachment", - "listing", - "ransomleak", - "forum_post", - "forum_topic", - "forum_profile", - "blog_post", - "seller", - "paste", - "leak", - "chat_message", - "domain", - "bot", - "stealer_log", - "infected_devices", - "driller", - "driller_forum_topic", - "driller_forum_post", - "driller_profile", - "cc", - "ccbin", - "financial_data", - "leaked_data", - "leaked_file", - "document", - "account", - "actor", - "forum_content", - "blog_content", - "profile", - "leaked_credential", - "valid_credential", - "invalid_credential", - "mitigated_credential", - "illicit_networks", - "open_web", - "domains", - "intelligence_object", - "leaks", - "social_media_account", - "social_media", - "source_code", - "source_code_secrets_np", - "source_code_secrets", - "source_code_files", - "docker", - "stack_exchange", - "google", - "service", - "driller_host", - "buckets", - "bucket", - "bucket_object", - "whois", - "ad", - "ads", - "cookie", - "pii", - "experimental" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Type of experimental activities to search through.", - "explode": true, - "in": "query", - "name": "experimental_types", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "query", - "name": "event_action", - "schema": { - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ], - "type": "string" - } - }, - { - "explode": true, - "in": "query", - "name": "event_actions", - "schema": { - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "explode": true, - "in": "query", - "name": "risks", - "schema": { - "enum": [ - "1", - "2", - "3", - "4", - "5" - ], - "items": { - "type": "integer" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "query", - "name": "order", - "schema": { - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "sort_by", - "schema": { - "default": "created", - "enum": [ - "created", - "indexed", - "updated", - "alertable-materialized", - "materialized", - "searchable" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "use_global_policies", - "schema": { - "default": true, - "type": "boolean" - } - }, - { - "description": "The time zone used to compute the statistics.", - "in": "query", - "name": "time_zone", - "schema": { - "type": "string" - } - }, - { - "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax.", - "in": "query", - "name": "query", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "has_modified_risk_score", - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "in": "query", - "name": "has_notes", - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Search" - } - } - }, - "description": "The user's home feed activities" - } - }, - "tags": [ - "me" - ] - } - }, - "/firework/v2/me/feed/credentials": { - "get": { - "operationId": "get_leaked_credentials_feed_endpoint_/me/feed/credentials", - "parameters": [ - { - "in": "query", - "name": "size", - "schema": { - "default": 20, - "type": "integer" - } - }, - { - "in": "query", - "name": "from", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "order_type", - "schema": { - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedCredentials" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "me" - ] - }, - "post": { - "operationId": "post_leaked_credentials_feed_endpoint_/me/feed/credentials", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserUpdate" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaginatedCredentials" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "me" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/me/profile": { - "get": { - "operationId": "get_current_user_profile_/me/profile", - "responses": { - "200": { - "content": {}, - "description": "Returns the current user's profile" - } - }, - "tags": [ - "me" - ] - }, - "put": { - "operationId": "put_current_user_profile_/me/profile", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserUpdate" - } - } - }, - "required": true - }, - "responses": { - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Update is invalid" - }, - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/put_current_user_profile__me_profile_200_response" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "me" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/me/tenants": { - "get": { - "operationId": "get_current_user_tenants_/me/tenants", - "responses": { - "200": { - "content": {}, - "description": "Returns the current user's tenants." - } - }, - "tags": [ - "me" - ] - } - }, - "/firework/v2/organizations/{organization_id}/members": { - "get": { - "operationId": "get_organization_members_api_/organizations//members", - "parameters": [ - { - "in": "path", - "name": "organization_id", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "size", - "schema": { - "default": 20, - "type": "integer" - } - }, - { - "in": "query", - "name": "from", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "q", - "schema": { - "type": "string" - } - } - ], - "responses": { - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Organization not found" - }, - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrganizationMemberPage" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "organizations" - ] - }, - "post": { - "operationId": "post_organization_members_api_/organizations//members", - "parameters": [ - { - "in": "path", - "name": "organization_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrganizationMemberData" - } - } - }, - "required": true - }, - "responses": { - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Organization not found" - }, - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/post_organization_members_api__organizations__int_organization_id__members_200_response" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "organizations" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/organizations/{organization_id}/members/count": { - "get": { - "operationId": "get_organization_members_count_api_/organizations//members/count", - "parameters": [ - { - "in": "path", - "name": "organization_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Organization not found" - }, - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrganizationMembersCount" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "organizations" - ] - } - }, - "/firework/v2/organizations/{organization_id}/members/{user_id}": { - "get": { - "operationId": "get_organization_member_api_/organizations//members/", - "parameters": [ - { - "in": "path", - "name": "organization_id", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "path", - "name": "user_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/post_organization_members_api__organizations__int_organization_id__members_200_response" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "organizations" - ] - }, - "put": { - "operationId": "put_organization_member_api_/organizations//members/", - "parameters": [ - { - "in": "path", - "name": "organization_id", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "path", - "name": "user_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrganizationMember" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/post_organization_members_api__organizations__int_organization_id__members_200_response" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "organizations" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/organizations/{organization_id}/members/{user_id}/disable": { - "post": { - "operationId": "post_organization_member_disable_/organizations//members//disable", - "parameters": [ - { - "in": "path", - "name": "organization_id", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "path", - "name": "user_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EnableState" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "organizations" - ] - } - }, - "/firework/v2/organizations/{organization_id}/members/{user_id}/enable": { - "post": { - "operationId": "post_organization_member_enable_/organizations//members//enable", - "parameters": [ - { - "in": "path", - "name": "organization_id", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "path", - "name": "user_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EnableState" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "organizations" - ] - } - }, - "/firework/v2/organizations/{organization_id}/members/{user_id}/permissions": { - "post": { - "operationId": "post_organization_member_permissions_api_/organizations//members//permissions", - "parameters": [ - { - "in": "path", - "name": "organization_id", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "path", - "name": "user_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PermissionData" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdatedPermission" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "organizations" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/organizations/{organization_id}/members/{user_id}/tenants": { - "get": { - "operationId": "get_organization_member_tenants_/organizations//members//tenants", - "parameters": [ - { - "in": "path", - "name": "organization_id", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "path", - "name": "user_id", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "size", - "schema": { - "default": 20, - "type": "integer" - } - }, - { - "in": "query", - "name": "from", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "include_disabled_demo", - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "in": "query", - "name": "q", - "schema": { - "type": "string" - } - }, - { - "explode": true, - "in": "query", - "name": "types[]", - "schema": { - "enum": [ - "regular", - "service-firm", - "micro", - "starter", - "essential", - "core", - "enterprise", - "demo", - "training" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantWithCounts" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "organizations" - ] - } - }, - "/firework/v2/organizations/{organization_id}/tenants": { - "get": { - "operationId": "get_organization_tenants_api_/organizations//tenants", - "parameters": [ - { - "in": "path", - "name": "organization_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantWithCounts" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "organizations" - ] - }, - "post": { - "operationId": "post_organization_tenants_api_/organizations//tenants", - "parameters": [ - { - "in": "path", - "name": "organization_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NewTenantInfo" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tenant" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "organizations" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/reporting/reports": { - "get": { - "operationId": "get_reports_endpoint_/reporting/reports", - "responses": { - "200": { - "content": {}, - "description": "Lists reports for the current tenant, ordered from newest to oldest." - } - }, - "tags": [ - "reporting" - ] - }, - "post": { - "operationId": "post_reports_endpoint_/reporting/reports", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NewReport" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": {}, - "description": "Creates a new report on the current tenant." - } - }, - "tags": [ - "reporting" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/reporting/reports/{report_id}": { - "delete": { - "operationId": "delete_report_endpoint_/reporting/reports/", - "parameters": [ - { - "in": "path", - "name": "report_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": {}, - "description": "Deletes a report." - } - }, - "tags": [ - "reporting" - ] - }, - "get": { - "operationId": "get_report_endpoint_/reporting/reports/", - "parameters": [ - { - "in": "path", - "name": "report_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": {}, - "description": "Returns a report and its elements." - } - }, - "tags": [ - "reporting" - ] - }, - "patch": { - "operationId": "patch_report_endpoint_/reporting/reports/", - "parameters": [ - { - "in": "path", - "name": "report_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdatedReport" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": {}, - "description": "Updates a report." - } - }, - "tags": [ - "reporting" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/reporting/reports/{report_id}/archive": { - "post": { - "operationId": "post_archive_report_endpoint_/reporting/reports//archive", - "parameters": [ - { - "in": "path", - "name": "report_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": {}, - "description": "Archives a report." - } - }, - "tags": [ - "reporting" - ] - } - }, - "/firework/v2/reporting/reports/{report_id}/download": { - "get": { - "operationId": "get_report_download_endpoint_/reporting/reports//download", - "parameters": [ - { - "in": "path", - "name": "report_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": {}, - "description": "Download a report." - } - }, - "tags": [ - "reporting" - ] - } - }, - "/firework/v2/search/": { - "get": { - "operationId": "get_search_/search/", - "parameters": [ - { - "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", - "explode": true, - "in": "query", - "name": "fields", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z", - "in": "query", - "name": "time", - "schema": { - "type": "string" - } - }, - { - "description": "The `size` parameter is used to limit the number of results returned for the search query.", - "in": "query", - "name": "size", - "schema": { - "default": 10, - "type": "integer" - } - }, - { - "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results.", - "in": "query", - "name": "search_after", - "schema": { - "type": "string" - } - }, - { - "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results.", - "in": "query", - "name": "from", - "schema": { - "type": "string" - } - }, - { - "description": "User defined tags used to filter search results", - "explode": true, - "in": "query", - "name": "tags", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "User defined operator to apply to tags filter", - "in": "query", - "name": "tags_query_operator", - "schema": { - "type": "string" - } - }, - { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", - "explode": true, - "in": "query", - "name": "types", - "schema": { - "enum": [ - "attachment", - "listing", - "ransomleak", - "forum_post", - "forum_topic", - "forum_profile", - "blog_post", - "seller", - "paste", - "leak", - "chat_message", - "domain", - "bot", - "stealer_log", - "infected_devices", - "driller", - "driller_forum_topic", - "driller_forum_post", - "driller_profile", - "cc", - "ccbin", - "financial_data", - "leaked_data", - "leaked_file", - "document", - "account", - "actor", - "forum_content", - "blog_content", - "profile", - "leaked_credential", - "valid_credential", - "invalid_credential", - "mitigated_credential", - "illicit_networks", - "open_web", - "domains", - "intelligence_object", - "leaks", - "social_media_account", - "social_media", - "source_code", - "source_code_secrets_np", - "source_code_secrets", - "source_code_files", - "docker", - "stack_exchange", - "google", - "service", - "driller_host", - "buckets", - "bucket", - "bucket_object", - "whois", - "cookie", - "pii", - "experimental" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Type of experimental activities to search through.", - "explode": true, - "in": "query", - "name": "experimental_types", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "query", - "name": "event_action", - "schema": { - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ], - "type": "string" - } - }, - { - "explode": true, - "in": "query", - "name": "event_actions", - "schema": { - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "explode": true, - "in": "query", - "name": "risks", - "schema": { - "enum": [ - "1", - "2", - "3", - "4", - "5" - ], - "items": { - "type": "integer" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "query", - "name": "order", - "schema": { - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "sort_by", - "schema": { - "default": "created", - "enum": [ - "created", - "indexed", - "updated", - "alertable-materialized", - "materialized", - "searchable" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "use_global_policies", - "schema": { - "default": true, - "type": "boolean" - } - }, - { - "description": "The time zone used to compute the statistics.", - "in": "query", - "name": "time_zone", - "schema": { - "type": "string" - } - }, - { - "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax.", - "in": "query", - "name": "query", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "has_modified_risk_score", - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "in": "query", - "name": "has_notes", - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "responses": { - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Query is invalid." - }, - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Search" - } - } - }, - "description": "Returns the search result(s)." - } - }, - "tags": [ - "search" - ] - }, - "post": { - "operationId": "post_search_/search/", - "parameters": [ - { - "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", - "explode": true, - "in": "query", - "name": "fields", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z", - "in": "query", - "name": "time", - "schema": { - "type": "string" - } - }, - { - "description": "The `size` parameter is used to limit the number of results returned for the search query.", - "in": "query", - "name": "size", - "schema": { - "default": 10, - "type": "integer" - } - }, - { - "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results.", - "in": "query", - "name": "search_after", - "schema": { - "type": "string" - } - }, - { - "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results.", - "in": "query", - "name": "from", - "schema": { - "type": "string" - } - }, - { - "description": "User defined tags used to filter search results", - "explode": true, - "in": "query", - "name": "tags", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "User defined operator to apply to tags filter", - "in": "query", - "name": "tags_query_operator", - "schema": { - "type": "string" - } - }, - { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", - "explode": true, - "in": "query", - "name": "types", - "schema": { - "enum": [ - "attachment", - "listing", - "ransomleak", - "forum_post", - "forum_topic", - "forum_profile", - "blog_post", - "seller", - "paste", - "leak", - "chat_message", - "domain", - "bot", - "stealer_log", - "infected_devices", - "driller", - "driller_forum_topic", - "driller_forum_post", - "driller_profile", - "cc", - "ccbin", - "financial_data", - "leaked_data", - "leaked_file", - "document", - "account", - "actor", - "forum_content", - "blog_content", - "profile", - "leaked_credential", - "valid_credential", - "invalid_credential", - "mitigated_credential", - "illicit_networks", - "open_web", - "domains", - "intelligence_object", - "leaks", - "social_media_account", - "social_media", - "source_code", - "source_code_secrets_np", - "source_code_secrets", - "source_code_files", - "docker", - "stack_exchange", - "google", - "service", - "driller_host", - "buckets", - "bucket", - "bucket_object", - "whois", - "cookie", - "pii", - "experimental" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Type of experimental activities to search through.", - "explode": true, - "in": "query", - "name": "experimental_types", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "query", - "name": "event_action", - "schema": { - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ], - "type": "string" - } - }, - { - "explode": true, - "in": "query", - "name": "event_actions", - "schema": { - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "explode": true, - "in": "query", - "name": "risks", - "schema": { - "enum": [ - "1", - "2", - "3", - "4", - "5" - ], - "items": { - "type": "integer" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "query", - "name": "order", - "schema": { - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "sort_by", - "schema": { - "default": "created", - "enum": [ - "created", - "indexed", - "updated", - "alertable-materialized", - "materialized", - "searchable" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "use_global_policies", - "schema": { - "default": true, - "type": "boolean" - } - }, - { - "description": "The time zone used to compute the statistics.", - "in": "query", - "name": "time_zone", - "schema": { - "type": "string" - } - }, - { - "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax.", - "in": "query", - "name": "query", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "has_modified_risk_score", - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "in": "query", - "name": "has_notes", - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "responses": { - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HttpError" - } - } - }, - "description": "Query is invalid." - }, - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Search" - } - } - }, - "description": "Returns the search result(s)." - } - }, - "tags": [ - "search" - ] - } - }, - "/firework/v2/tenants/{tenant_id}": { - "get": { - "operationId": "get_tenant_api_/tenants/", - "parameters": [ - { - "in": "path", - "name": "tenant_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantWithCounts" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "tenants" - ] - }, - "put": { - "operationId": "put_tenant_api_/tenants/", - "parameters": [ - { - "in": "path", - "name": "tenant_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantData" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantWithCounts" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "tenants" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/tenants/{tenant_id}/archive": { - "post": { - "operationId": "post_tenant_archive_api_/tenants//archive", - "parameters": [ - { - "in": "path", - "name": "tenant_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": {}, - "description": "Success" - } - }, - "tags": [ - "tenants" - ] - } - }, - "/firework/v2/tenants/{tenant_id}/users": { - "get": { - "operationId": "get_tenant_users_api_/tenants//users", - "parameters": [ - { - "in": "path", - "name": "tenant_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantUsers" - } - } - }, - "description": "Success" - } - }, - "tags": [ - "tenants" - ] - }, - "post": { - "operationId": "post_tenant_users_api_/tenants//users", - "parameters": [ - { - "in": "path", - "name": "tenant_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserTenantAccessRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": {}, - "description": "Users were successfully added to tenant." - } - }, - "tags": [ - "tenants" - ], - "x-codegen-request-body-name": "payload" - } - }, - "/firework/v2/tenants/{tenant_id}/users/{user_id}": { - "delete": { - "operationId": "delete_tenant_users_access_api_/tenants//users/", - "parameters": [ - { - "in": "path", - "name": "tenant_id", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "path", - "name": "user_id", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": {}, - "description": "User was successfully removed from the tenant." - } - }, - "tags": [ - "tenants" - ] - } - } - }, - "components": { - "responses": { - "ParseError": { - "content": {}, - "description": "When a mask can't be parsed" - }, - "MaskError": { - "content": {}, - "description": "When any error occurs on mask" - }, - "HTTPException": { - "content": {}, - "description": "" - } - }, - "schemas": { - "HttpError": { - "properties": { - "message": { - "type": "string" - }, - "code": { - "type": "string" - } - }, - "type": "object" - }, - "Search": { - "properties": { - "items": { - "items": { - "properties": {}, - "type": "object" - }, - "type": "array" - }, - "nb_hits": { - "type": "integer" - }, - "links": { - "$ref": "#/components/schemas/SearchLinks" - }, - "search_after": { - "type": "string" - } - }, - "type": "object" - }, - "SearchLinks": { - "properties": { - "next": { - "type": "string" - } - }, - "type": "object" - }, - "IdentifierCreate": { - "properties": { - "name": { - "minLength": 1, - "type": "string" - }, - "type": { - "enum": [ - "domain", - "name", - "keyword", - "github_repository", - "username", - "email", - "search_query", - "bin", - "ip", - "secret", - "azure_tenant", - "identity", - "ransomleak", - "external_id", - "address_data", - "birth_year", - "role", - "phone_number" - ], - "example": "domain", - "type": "string" - }, - "search_types": { - "items": { - "enum": [ - "leak", - "invalid_credential", - "stealer_log", - "domain", - "mitigated_credential", - "chat_message", - "forum_profile", - "stack_exchange", - "forum_post", - "paste", - "docker", - "valid_credential", - "service", - "social_media_account", - "financial_data", - "bucket", - "ad", - "ransomleak", - "blog_post", - "listing", - "google", - "bot", - "seller", - "source_code_secrets", - "source_code_files", - "forum_topic", - "bucket_object", - "illicit_networks", - "open_web", - "buckets", - "source_code", - "leaks", - "domains", - "forum_content", - "blog_content", - "profile", - "ads", - "infected_devices", - "social_media" - ], - "example": "leak", - "type": "string" - }, - "type": "array" - }, - "experimental_search_types": { - "items": { - "type": "string" - }, - "type": "array" - }, - "risks": { - "items": { - "type": "integer" - }, - "type": "array" - }, - "data": { - "properties": {}, - "type": "object" - } - }, - "required": [ - "data", - "name", - "search_types", - "type" - ], - "type": "object" - }, - "Identifier": { - "properties": { - "id": { - "type": "integer" - }, - "tenant_id": { - "type": "integer" - }, - "feed_id": { - "type": "integer" - }, - "type": { - "enum": [ - "domain", - "name", - "keyword", - "github_repository", - "username", - "email", - "search_query", - "bin", - "ip", - "secret", - "azure_tenant", - "identity", - "ransomleak", - "external_id", - "address_data", - "birth_year", - "role", - "phone_number" - ], - "example": "domain", - "type": "string" - }, - "search_types": { - "items": { - "enum": [ - "leak", - "invalid_credential", - "stealer_log", - "domain", - "mitigated_credential", - "chat_message", - "forum_profile", - "stack_exchange", - "forum_post", - "paste", - "docker", - "valid_credential", - "service", - "social_media_account", - "financial_data", - "bucket", - "ransomleak", - "blog_post", - "listing", - "google", - "bot", - "seller", - "source_code_secrets", - "source_code_files", - "forum_topic", - "bucket_object", - "illicit_networks", - "open_web", - "buckets", - "source_code", - "leaks", - "domains", - "forum_content", - "blog_content", - "profile", - "infected_devices", - "social_media" - ], - "example": "leak", - "type": "string" - }, - "type": "array" - }, - "experimental_search_types": { - "items": { - "type": "string" - }, - "type": "array" - }, - "v3_refs": { - "$ref": "#/components/schemas/V3_Refs" - }, - "risks": { - "items": { - "type": "integer" - }, - "type": "array" - }, - "name": { - "minLength": 1, - "type": "string" - }, - "data": { - "properties": {}, - "type": "object" - }, - "fetching_progress": { - "type": "integer" - }, - "count": { - "type": "integer" - }, - "urn": { - "description": "The uniform resource name of the identifier.", - "type": "string" - }, - "is_disabled": { - "type": "boolean" - }, - "source": { - "enum": [ - "USER", - "SYSTEM_RELATION", - "SELF_ONBOARDING", - "ATTRIBUTE", - "AUTO_MONITOR", - "IDP_SYNC" - ], - "example": "USER", - "type": "string" - }, - "data_updated_at": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "data", - "name", - "search_types", - "type" - ], - "type": "object" - }, - "V3_Refs": { - "properties": { - "asset_uuid": { - "type": "string" - } - }, - "type": "object" - }, - "IdentifierToggle": { - "properties": { - "is_disabled": { - "default": true, - "description": "The `is_disabled` parameter is used to toggle the asset as either enabled or disabled.", - "type": "boolean" - } - }, - "required": [ - "is_disabled" - ], - "type": "object" - }, - "FeedAlert": { - "properties": { - "name": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "type": { - "enum": [ - "email", - "channel", - "azure_sentinel", - "azure_sentinel_v2", - "slack", - "discord", - "splunk", - "jira", - "teams", - "servicenow", - "webhook" - ], - "example": "email", - "type": "string" - }, - "feed_url": { - "type": "string" - }, - "feed_target_type": { - "enum": [ - "assets/groups", - "assets", - "home" - ], - "example": "assets/groups", - "type": "string" - }, - "feed_target_id": { - "type": "integer" - }, - "frequency": { - "type": "integer" - }, - "start_at": { - "format": "date-time", - "type": "string" - }, - "created_at": { - "format": "date-time", - "type": "string" - }, - "params": { - "properties": {}, - "type": "object" - }, - "tenant_id": { - "type": "integer" - }, - "organization_id": { - "type": "integer" - }, - "search_types": { - "items": { - "enum": [ - "attachment", - "listing", - "ransomleak", - "forum_post", - "forum_topic", - "forum_profile", - "blog_post", - "seller", - "paste", - "leak", - "chat_message", - "domain", - "bot", - "stealer_log", - "infected_devices", - "driller", - "driller_forum_topic", - "driller_forum_post", - "driller_profile", - "cc", - "ccbin", - "financial_data", - "leaked_data", - "leaked_file", - "document", - "account", - "actor", - "forum_content", - "blog_content", - "profile", - "leaked_credential", - "valid_credential", - "invalid_credential", - "mitigated_credential", - "illicit_networks", - "open_web", - "domains", - "intelligence_object", - "leaks", - "social_media_account", - "social_media", - "source_code", - "source_code_secrets_np", - "source_code_secrets", - "source_code_files", - "docker", - "stack_exchange", - "google", - "service", - "driller_host", - "buckets", - "bucket", - "bucket_object", - "whois", - "ad", - "ads", - "cookie", - "pii", - "experimental" - ], - "example": "attachment", - "type": "string" - }, - "type": "array" - }, - "experimental_search_types": { - "items": { - "type": "string" - }, - "type": "array" - }, - "risks": { - "items": { - "type": "integer" - }, - "type": "array" - }, - "tenant_alert_channel_id": { - "type": "integer" - } - }, - "required": [ - "frequency", - "params", - "start_at", - "type" - ], - "type": "object" - }, - "IdentifierGroup": { - "properties": { - "id": { - "type": "integer" - }, - "tenant_id": { - "type": "integer" - }, - "feed_id": { - "type": "integer" - }, - "feed_owner_id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "urn": { - "description": "The uniform resource name of the identifier group.", - "type": "string" - } - }, - "type": "object" - }, - "UpdateGroupData": { - "properties": { - "name": { - "type": "string" - } - }, - "type": "object" - }, - "NewTenantInfo": { - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "industry": { - "enum": [ - "global", - "transport", - "education", - "energy", - "finance", - "healthcare", - "manufacturing", - "retail", - "software", - "telecommunication" - ], - "example": "global", - "type": "string" - } - }, - "type": "object" - }, - "Tenant": { - "properties": { - "id": { - "description": "Tenant ID", - "type": "integer" - }, - "name": { - "description": "Tenant name", - "type": "string" - }, - "type": { - "description": "Tenant type", - "type": "string" - }, - "description": { - "description": "This tenant's purpose", - "type": "string" - }, - "organization_id": { - "description": "ID of the owner organization", - "type": "integer" - }, - "urn": { - "description": "The uniform resource name of the tenant.", - "type": "string" - }, - "number_of_employees": { - "description": "The number of employees for the tenant.", - "type": "integer" - }, - "industry": { - "description": "The industry of the tenant.", - "type": "string" - }, - "is_disabled": { - "description": "Indicates if the tenant is disabled", - "type": "boolean" - }, - "is_archived": { - "description": "Indicates if the tenant is archived", - "type": "boolean" - }, - "feed_id": { - "description": "ID of the feed", - "type": "integer" - }, - "permissions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "prevent_global_search": { - "description": "Indicates if the tenant can perform global searches", - "type": "boolean" - } - }, - "type": "object" - }, - "TenantWithCounts": { - "properties": { - "next": { - "type": "string" - }, - "items": { - "$ref": "#/components/schemas/TenantWithCounts" - } - }, - "type": "object" - }, - "UpdatedPermission": { - "properties": { - "updated_value": { - "type": "boolean" - } - }, - "type": "object" - }, - "OrganizationMemberData": { - "properties": { - "name": { - "type": "string" - }, - "surname": { - "type": "string" - }, - "email": { - "type": "string" - }, - "organization_member_permissions": { - "properties": {}, - "type": "object" - }, - "user_permissions": { - "properties": {}, - "type": "object" - }, - "memberships": { - "items": { - "$ref": "#/components/schemas/UserTenantMembership" - }, - "type": "array" - }, - "send_welcome_email": { - "default": true, - "type": "boolean" - } - }, - "required": [ - "email", - "name", - "organization_member_permissions", - "surname" - ], - "type": "object" - }, - "UserTenantMembership": { - "properties": { - "tenant_id": { - "type": "integer" - }, - "is_readonly": { - "type": "boolean" - }, - "role": { - "enum": [ - "viewer", - "editor", - "admin" - ], - "example": "viewer", - "type": "string" - } - }, - "required": [ - "tenant_id" - ], - "type": "object" - }, - "OrganizationMemberWithMetadata": { - "properties": { - "user": { - "$ref": "#/components/schemas/OrganizationMember" - }, - "tenant_count": { - "type": "integer" - } - }, - "type": "object" - }, - "OrganizationMember": { - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "surname": { - "type": "string" - }, - "email": { - "type": "string" - }, - "organization_member_permissions": { - "$ref": "#/components/schemas/OrganizationMemberPermission" - }, - "is_disabled": { - "type": "boolean" - }, - "registered_at": { - "format": "date-time", - "type": "string" - }, - "urn": { - "description": "The uniform resource name of the member.", - "type": "string" - } - }, - "type": "object" - }, - "OrganizationMemberPermission": { - "properties": { - "*": { - "additionalProperties": { - "type": "boolean" - }, - "type": "object" - } - }, - "type": "object" - }, - "OrganizationMemberPage": { - "properties": { - "members": { - "items": { - "$ref": "#/components/schemas/OrganizationMemberWithMetadata" - }, - "type": "array" - } - }, - "type": "object" - }, - "OrganizationMembersCount": { - "properties": { - "count": { - "type": "integer" - } - }, - "type": "object" - }, - "EnableState": { - "properties": { - "is_disabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "PermissionData": { - "properties": { - "permission": { - "type": "string" - }, - "value": { - "type": "boolean" - } - }, - "required": [ - "permission", - "value" - ], - "type": "object" - }, - "HighlightPayload": { - "properties": { - "query_string": { - "type": "string" - }, - "identifier_ids": { - "items": { - "type": "integer" - }, - "type": "array" - } - }, - "type": "object" - }, - "ActivityUserNotes": { - "properties": { - "notes": { - "type": "string" - } - }, - "required": [ - "notes" - ], - "type": "object" - }, - "ActivityUserMetadata": { - "properties": { - "uid": { - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "risk_score_updated_at": { - "format": "date-time", - "type": "string" - }, - "remediated_at": { - "format": "date-time", - "type": "string" - }, - "ignored_at": { - "format": "date-time", - "type": "string" - }, - "remediated_asset_uuid": { - "type": "string" - } - }, - "type": "object" - }, - "ActivityUserRiskScore": { - "properties": { - "risk_score": { - "type": "integer" - } - }, - "required": [ - "risk_score" - ], - "type": "object" - }, - "ActivityUserMetadataRemediated": { - "properties": { - "is_remediated": { - "type": "boolean" - }, - "identifier_id": { - "type": "integer" - } - }, - "required": [ - "is_remediated" - ], - "type": "object" - }, - "ActivityUserMetadataIgnored": { - "properties": { - "is_ignored": { - "type": "boolean" - }, - "identifier_id": { - "type": "integer" - } - }, - "required": [ - "is_ignored" - ], - "type": "object" - }, - "ActivityAiAssistance": { - "properties": { - "uid": { - "type": "string" - }, - "prompt": { - "type": "string" - }, - "response": { - "type": "string" - } - }, - "type": "object" - }, - "ActivityUserTags": { - "properties": { - "tags": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "tags" - ], - "type": "object" - }, - "UserUpdate": { - "properties": { - "name": { - "type": "string" - }, - "surname": { - "type": "string" - }, - "settings": { - "properties": {}, - "type": "object" - }, - "language": { - "type": "string" - }, - "color_scheme": { - "enum": [ - "auto", - "light", - "dark" - ], - "example": "auto", - "type": "string" - } - }, - "required": [ - "color_scheme", - "name", - "settings", - "surname" - ], - "type": "object" - }, - "UserProfile": { - "allOf": [ - { - "$ref": "#/components/schemas/User" - }, - { - "properties": { - "settings": { - "$ref": "#/components/schemas/UserSettings" - }, - "feature_flags": { - "$ref": "#/components/schemas/UserProfile_allOf_feature_flags" - }, - "tenants": { - "items": { - "$ref": "#/components/schemas/Tenant" - }, - "type": "array" - }, - "is_sso_mandatory": { - "type": "boolean" - }, - "has_password": { - "type": "boolean" - }, - "urn": { - "type": "string" - }, - "needs_eusa": { - "type": "boolean" - }, - "domain": { - "type": "string" - }, - "language": { - "type": "string" - }, - "should_provide_signup_intent": { - "type": "boolean" - } - }, - "type": "object" - } - ] - }, - "User": { - "properties": { - "id": { - "type": "integer" - }, - "name": { - "description": "Users's name", - "type": "string" - }, - "surname": { - "description": "User's surname", - "type": "string" - }, - "email": { - "description": "User's email", - "type": "string" - }, - "organization_id": { - "description": "ID of the owner organization", - "type": "integer" - }, - "settings": { - "$ref": "#/components/schemas/UserSettings" - }, - "is_disabled": { - "type": "boolean" - }, - "feature_flags": { - "properties": {}, - "type": "object" - }, - "registered_at": { - "format": "date-time", - "type": "string" - }, - "urn": { - "description": "The uniform resource name of the user.", - "type": "string" - }, - "organization_member_permissions": { - "properties": {}, - "type": "object" - }, - "language": { - "description": "User's language", - "type": "string" - }, - "color_scheme": { - "enum": [ - "auto", - "light", - "dark" - ], - "example": "auto", - "type": "string" - }, - "flare_role": { - "type": "string" - } - }, - "required": [ - "color_scheme", - "email", - "language", - "name" - ], - "type": "object" - }, - "UserSettings": { - "properties": { - "default_search": { - "type": "string" - }, - "permissions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "organization_member_permissions": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "PaginatedCredentials": { - "properties": { - "next": { - "type": "string" - }, - "items": { - "$ref": "#/components/schemas/LeakActivityCredential" - } - }, - "type": "object" - }, - "LeakActivityCredential": { - "properties": { - "id": { - "type": "integer" - }, - "source_id": { - "type": "string" - }, - "imported_at": { - "type": "string" - }, - "identity_name": { - "type": "string" - }, - "hash": { - "type": "string" - }, - "domain": { - "type": "string" - }, - "source": { - "$ref": "#/components/schemas/source" - }, - "remediated_at": { - "format": "date-time", - "type": "string" - }, - "ignored_at": { - "format": "date-time", - "type": "string" - }, - "known_password_id": { - "type": "integer" - }, - "credential_hash": { - "type": "string" - } - }, - "required": [ - "id", - "identity_name", - "imported_at", - "source_id" - ], - "type": "object" - }, - "source": { - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description_en": { - "type": "string" - }, - "description_fr": { - "type": "string" - }, - "breached_at": { - "type": "string" - }, - "leaked_at": { - "type": "string" - }, - "pii_tags": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "TenantData": { - "properties": { - "name": { - "description": "The Tenant display name", - "type": "string" - }, - "description": { - "description": "The Tenant's purpose / description", - "type": "string" - }, - "number_of_employees": { - "description": "The number of employees for the tenant", - "type": "integer" - }, - "industry": { - "description": "The Tenant's industry", - "enum": [ - "global", - "transport", - "education", - "energy", - "finance", - "healthcare", - "manufacturing", - "retail", - "software", - "telecommunication" - ], - "example": "global", - "type": "string" - }, - "global_search_calls_limit": { - "description": "The number of API calls allowed for the tenant.", - "type": "integer" - }, - "prevent_global_search": { - "type": "boolean" - } - }, - "required": [ - "description", - "industry", - "name", - "number_of_employees" - ], - "type": "object" - }, - "UserTenantAccessRequest": { - "properties": { - "users": { - "items": { - "allOf": [ - { - "$ref": "#/components/schemas/UserTenantAccess" - } - ], - "description": "User given access to a tenant.", - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - }, - "UserTenantAccess": { - "properties": { - "user_id": { - "description": "The ID of the user to add to the tenant", - "type": "integer" - }, - "is_readonly": { - "description": "Access given to the user for the tenant", - "type": "boolean" - }, - "role": { - "description": "Role given to the user for the tenant", - "enum": [ - "viewer", - "editor", - "admin" - ], - "example": "viewer", - "type": "string" - } - }, - "required": [ - "user_id" - ], - "type": "object" - }, - "TenantUsers": { - "properties": { - "next": { - "type": "integer" - }, - "items": { - "$ref": "#/components/schemas/TenantUser" - } - }, - "type": "object" - }, - "TenantUser": { - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "surname": { - "type": "string" - }, - "email": { - "type": "string" - }, - "is_readonly": { - "type": "boolean" - }, - "role": { - "enum": [ - "viewer", - "editor", - "admin" - ], - "example": "viewer", - "type": "string" - }, - "is_disabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "NewReport": { - "properties": { - "title": { - "type": "string" - }, - "author": { - "type": "string" - }, - "elements": { - "items": { - "$ref": "#/components/schemas/ReportElementUpdate" - }, - "type": "array" - }, - "audience": { - "enum": [ - "technical", - "general" - ], - "example": "technical", - "type": "string" - } - }, - "required": [ - "author", - "title" - ], - "type": "object" - }, - "ReportElementUpdate": { - "properties": { - "id": { - "type": "integer" - }, - "position": { - "type": "integer" - }, - "enabled": { - "type": "boolean" - }, - "sort_by": { - "enum": [ - "custom", - "alphabetical", - "date" - ], - "example": "custom", - "type": "string" - }, - "time_interval": { - "type": "string" - } - }, - "type": "object" - }, - "UpdatedReport": { - "properties": { - "title": { - "type": "string" - }, - "author": { - "type": "string" - }, - "elements": { - "items": { - "$ref": "#/components/schemas/ReportElementUpdate" - }, - "type": "array" - }, - "audience": { - "enum": [ - "technical", - "general" - ], - "example": "technical", - "type": "string" - } - }, - "type": "object" - }, - "get_activity_assistance_resource__activities__string_index___string_source___path_id__ai_assistance_200_response": { - "properties": { - "activity_ai_assistance": { - "$ref": "#/components/schemas/ActivityAiAssistance" - } - }, - "type": "object" - }, - "get_assets__assets__200_response": { - "properties": { - "assets": { - "$ref": "#/components/schemas/Identifier" - } - }, - "type": "object" - }, - "post_assets__assets__200_response": { - "properties": { - "asset": { - "$ref": "#/components/schemas/Identifier" - } - }, - "type": "object" - }, - "get_assets_groups__assets_groups__200_response": { - "properties": { - "assets_groups": { - "$ref": "#/components/schemas/IdentifierGroup" - } - }, - "type": "object" - }, - "post_assets_groups__assets_groups__200_response": { - "properties": { - "assets_group": { - "$ref": "#/components/schemas/IdentifierGroup" - } - }, - "type": "object" - }, - "get_assets_group_alerts__assets_groups__int_assets_group_id__alerts_200_response": { - "properties": { - "alerts": { - "$ref": "#/components/schemas/FeedAlert" - } - }, - "type": "object" - }, - "put_current_user_profile__me_profile_200_response": { - "properties": { - "profile": { - "$ref": "#/components/schemas/UserProfile" - } - }, - "type": "object" - }, - "post_organization_members_api__organizations__int_organization_id__members_200_response": { - "properties": { - "member": { - "$ref": "#/components/schemas/OrganizationMemberWithMetadata" - } - }, - "type": "object" - }, - "UserProfile_allOf_feature_flags": { - "properties": {}, - "type": "object" - } - }, - "securitySchemes": { - "BearerAuth": { - "type": "http", - "scheme": "bearer" - } - } - }, - "x-original-swagger-version": "2.0" -} \ No newline at end of file diff --git a/docs/api-reference/spec/firework-v2-swagger.json b/docs/api-reference/spec/firework-v2-swagger.json index 06c1efc9..e69de29b 100644 --- a/docs/api-reference/spec/firework-v2-swagger.json +++ b/docs/api-reference/spec/firework-v2-swagger.json @@ -1,6933 +0,0 @@ -{ - "swagger": "2.0", - "basePath": "/", - "paths": { - "/firework/v2/activities/": { - "get": { - "responses": { - "200": { - "description": "Returns the activity" - }, - "404": { - "description": "Activity not found", - "schema": { - "$ref": "#/definitions/HttpError" - } - } - }, - "operationId": "get_activity_endpoint_/activities/", - "parameters": [ - { - "name": "uid", - "in": "query", - "type": "string", - "required": true - } - ], - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/actor/profile/{actor_name}": { - "parameters": [ - { - "name": "actor_name", - "in": "path", - "required": true, - "type": "string" - } - ], - "get": { - "responses": { - "200": { - "description": "Returns the actor" - } - }, - "operationId": "get_actor_/activities/actor/profile/", - "parameters": [ - { - "name": "actor_time", - "in": "query", - "type": "string", - "description": " Limit results to those found in this time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z" - }, - { - "name": "actor_size", - "in": "query", - "type": "integer", - "description": "Maximum number of hits returned per query.", - "default": 100 - }, - { - "name": "actor_search_after", - "in": "query", - "type": "string", - "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, use the latest response's `search_after` attribute for the next request to get the next page of results." - } - ], - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/document/{source}/{id}/extensions": { - "parameters": [ - { - "name": "source", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - } - ], - "get": { - "responses": { - "200": { - "description": "Returns all the different file extensions that were found in the files of a ransom leak." - }, - "404": { - "description": "Activity not found", - "schema": { - "$ref": "#/definitions/HttpError" - } - } - }, - "operationId": "get_ransom_leak_file_extensions_endpoint_/activities/document///extensions", - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/document/{source}/{id}/files": { - "parameters": [ - { - "name": "source", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - } - ], - "get": { - "responses": { - "200": { - "description": "Returns the files in a ransom leak matching the specified query" - }, - "404": { - "description": "Activity not found", - "schema": { - "$ref": "#/definitions/HttpError" - } - } - }, - "operationId": "get_ransom_leak_files_endpoint_/activities/document///files", - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/leak/{source}/{keyword}": { - "parameters": [ - { - "name": "source", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "keyword", - "in": "path", - "required": true, - "type": "string" - } - ], - "get": { - "responses": { - "200": { - "description": "Returns the leak activity" - }, - "404": { - "description": "Leak activity not found", - "schema": { - "$ref": "#/definitions/HttpError" - } - } - }, - "operationId": "get_leak_endpoint_/activities/leak//", - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/leak/{source}/{keyword}/count": { - "parameters": [ - { - "name": "source", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "keyword", - "in": "path", - "required": true, - "type": "string" - } - ], - "get": { - "responses": { - "200": { - "description": "Success" - } - }, - "operationId": "get_leak_count_/activities/leak///count", - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id_}/user_metadata": { - "parameters": [ - { - "name": "index", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "source", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id_", - "in": "path", - "required": true, - "type": "string" - } - ], - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ActivityUserMetadata" - } - } - }, - "operationId": "get_activity_user_metadata_resource_/activities////user_metadata", - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id_}/user_metadata/ignored": { - "parameters": [ - { - "name": "index", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "source", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id_", - "in": "path", - "required": true, - "type": "string" - } - ], - "put": { - "responses": { - "400": { - "description": "Query is invalid.", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ActivityUserMetadata" - } - } - }, - "operationId": "put_activity_user_metadata_ignored_/activities////user_metadata/ignored", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/ActivityUserMetadataIgnored" - } - } - ], - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id_}/user_metadata/notes": { - "parameters": [ - { - "name": "index", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "source", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id_", - "in": "path", - "required": true, - "type": "string" - } - ], - "put": { - "responses": { - "400": { - "description": "Query is invalid.", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ActivityUserMetadata" - } - } - }, - "operationId": "put_activity_user_metadata_notes_/activities////user_metadata/notes", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/ActivityUserNotes" - } - } - ], - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id_}/user_metadata/remediated": { - "parameters": [ - { - "name": "index", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "source", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id_", - "in": "path", - "required": true, - "type": "string" - } - ], - "put": { - "responses": { - "400": { - "description": "Query is invalid.", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ActivityUserMetadata" - } - } - }, - "operationId": "put_activity_user_metadata_remediated_/activities////user_metadata/remediated", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/ActivityUserMetadataRemediated" - } - } - ], - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id_}/user_metadata/risk_score": { - "parameters": [ - { - "name": "index", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "source", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id_", - "in": "path", - "required": true, - "type": "string" - } - ], - "put": { - "responses": { - "400": { - "description": "Query is invalid.", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ActivityUserMetadata" - } - } - }, - "operationId": "put_activity_user_metadata_risk_score_/activities////user_metadata/risk_score", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/ActivityUserRiskScore" - } - } - ], - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id_}/user_metadata/tags": { - "parameters": [ - { - "name": "index", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "source", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id_", - "in": "path", - "required": true, - "type": "string" - } - ], - "put": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ActivityUserMetadata" - } - }, - "400": { - "description": "Query is invalid.", - "schema": { - "$ref": "#/definitions/HttpError" - } - } - }, - "operationId": "put_activity_user_metadata_tags_/activities////user_metadata/tags", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/ActivityUserTags" - } - } - ], - "tags": [ - "activities" - ] - }, - "delete": { - "responses": { - "200": { - "description": "Success" - } - }, - "operationId": "delete_activity_user_metadata_tags_/activities////user_metadata/tags", - "tags": [ - "activities" - ] - }, - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ActivityUserMetadata" - } - } - }, - "operationId": "get_activity_user_metadata_tags_/activities////user_metadata/tags", - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id}": { - "parameters": [ - { - "name": "index", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "source", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - } - ], - "get": { - "responses": { - "200": { - "description": "Returns the activity" - }, - "404": { - "description": "Activity not found", - "schema": { - "$ref": "#/definitions/HttpError" - } - } - }, - "operationId": "get_activity_endpoint_deprecated_/activities///", - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id}/ai_assistance": { - "parameters": [ - { - "name": "index", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "source", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - } - ], - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "properties": { - "activity_ai_assistance": { - "$ref": "#/definitions/ActivityAiAssistance" - } - } - } - } - }, - "operationId": "get_activity_assistance_resource_/activities////ai_assistance", - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id}/enrichment": { - "parameters": [ - { - "name": "index", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "source", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - } - ], - "get": { - "responses": { - "200": { - "description": "Returns the activity enrichment" - }, - "404": { - "description": "Activity not found", - "schema": { - "$ref": "#/definitions/HttpError" - } - } - }, - "operationId": "get_activity_enrichment_endpoint_/activities////enrichment", - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id}/events": { - "parameters": [ - { - "name": "index", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "source", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - } - ], - "get": { - "responses": { - "200": { - "description": "Returns events associated with the entity" - } - }, - "operationId": "get_entity_events_/activities////events", - "parameters": [ - { - "name": "from", - "in": "query", - "type": "integer", - "description": "Start from this key when paginating events." - }, - { - "name": "size", - "in": "query", - "type": "integer", - "description": "Limit the events per page.", - "default": 100 - } - ], - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id}/highlights": { - "parameters": [ - { - "name": "index", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "source", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - } - ], - "post": { - "responses": { - "200": { - "description": "Returns the highlights of an activity" - }, - "404": { - "description": "Activity not found", - "schema": { - "$ref": "#/definitions/HttpError" - } - } - }, - "operationId": "post_activity_highlights_/activities////highlights", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/HighlightPayload" - } - } - ], - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id}/leaked_data": { - "parameters": [ - { - "name": "index", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "source", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - } - ], - "get": { - "responses": { - "404": { - "description": "Activity not found", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "200": { - "description": "Returns the related leaked_data" - } - }, - "operationId": "get_leaked_data_/activities////leaked_data", - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id}/messages": { - "parameters": [ - { - "name": "index", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "source", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - } - ], - "get": { - "responses": { - "200": { - "description": "Returns the related messages" - }, - "404": { - "description": "Activity not found", - "schema": { - "$ref": "#/definitions/HttpError" - } - } - }, - "operationId": "get_activity_messages_/activities////messages", - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id}/parent_chat_data": { - "parameters": [ - { - "name": "index", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "source", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - } - ], - "get": { - "responses": { - "404": { - "description": "Activity not found", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "200": { - "description": "Returns the related parent_uids data" - } - }, - "operationId": "get_parent_activity_data_/activities////parent_chat_data", - "tags": [ - "activities" - ] - } - }, - "/firework/v2/activities/{index}/{source}/{id}/related/{context}": { - "parameters": [ - { - "name": "index", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "source", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "context", - "in": "path", - "required": true, - "type": "string" - } - ], - "get": { - "responses": { - "400": { - "description": "Activity have no related items", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "404": { - "description": "Activity not found", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "200": { - "description": "Returns related activities" - } - }, - "operationId": "get_related_items_/activities////related/", - "parameters": [ - { - "name": "identifier_ids", - "in": "query", - "type": "array", - "description": "ID of an identifier.", - "items": { - "type": "integer" - }, - "collectionFormat": "multi" - } - ], - "tags": [ - "activities" - ] - } - }, - "/firework/v2/assets/": { - "post": { - "responses": { - "200": { - "description": "Success", - "schema": { - "properties": { - "asset": { - "$ref": "#/definitions/Identifier" - } - } - } - }, - "400": { - "description": "Query is invalid.", - "schema": { - "$ref": "#/definitions/HttpError" - } - } - }, - "operationId": "post_assets_/assets/", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/IdentifierCreate" - } - } - ], - "tags": [ - "Identifiers" - ] - }, - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "properties": { - "assets": { - "$ref": "#/definitions/Identifier" - } - } - } - } - }, - "operationId": "get_assets_/assets/", - "tags": [ - "Identifiers" - ] - } - }, - "/firework/v2/assets/groups/": { - "post": { - "responses": { - "200": { - "description": "Success", - "schema": { - "properties": { - "assets_group": { - "$ref": "#/definitions/IdentifierGroup" - } - } - } - }, - "400": { - "description": "Query is invalid.", - "schema": { - "$ref": "#/definitions/HttpError" - } - } - }, - "operationId": "post_assets_groups_/assets/groups/", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/IdentifierGroup" - } - } - ], - "tags": [ - "Identifiers" - ] - }, - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "properties": { - "assets_groups": { - "$ref": "#/definitions/IdentifierGroup" - } - } - } - } - }, - "operationId": "get_assets_groups_/assets/groups/", - "tags": [ - "Identifiers" - ] - } - }, - "/firework/v2/assets/groups/{assets_group_id}": { - "parameters": [ - { - "name": "assets_group_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "put": { - "responses": { - "200": { - "description": "Success", - "schema": { - "properties": { - "assets_group": { - "$ref": "#/definitions/IdentifierGroup" - } - } - } - }, - "400": { - "description": "Query is invalid.", - "schema": { - "$ref": "#/definitions/HttpError" - } - } - }, - "operationId": "put_assets_group_api_/assets/groups/", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/UpdateGroupData" - } - } - ], - "tags": [ - "Identifiers" - ] - }, - "delete": { - "responses": { - "200": { - "description": "Success" - } - }, - "operationId": "delete_assets_group_api_/assets/groups/", - "tags": [ - "Identifiers" - ] - }, - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "properties": { - "assets_group": { - "$ref": "#/definitions/IdentifierGroup" - } - } - } - } - }, - "operationId": "get_assets_group_api_/assets/groups/", - "tags": [ - "Identifiers" - ] - } - }, - "/firework/v2/assets/groups/{assets_group_id}/alerts": { - "parameters": [ - { - "name": "assets_group_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "post": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FeedAlert" - } - } - }, - "operationId": "post_assets_group_alerts_/assets/groups//alerts", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/FeedAlert" - } - } - ], - "tags": [ - "Identifiers" - ] - }, - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "properties": { - "alerts": { - "$ref": "#/definitions/FeedAlert" - } - } - } - } - }, - "operationId": "get_assets_group_alerts_/assets/groups//alerts", - "tags": [ - "Identifiers" - ] - } - }, - "/firework/v2/assets/groups/{assets_group_id}/alerts/{alert_id}": { - "parameters": [ - { - "name": "assets_group_id", - "in": "path", - "required": true, - "type": "integer" - }, - { - "name": "alert_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "put": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FeedAlert" - } - } - }, - "operationId": "put_assets_group_alert_/assets/groups//alerts/", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/FeedAlert" - } - } - ], - "tags": [ - "Identifiers" - ] - }, - "delete": { - "responses": { - "200": { - "description": "Success" - } - }, - "operationId": "delete_assets_group_alert_/assets/groups//alerts/", - "tags": [ - "Identifiers" - ] - } - }, - "/firework/v2/assets/groups/{assets_group_id}/feed": { - "parameters": [ - { - "name": "assets_group_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "post": { - "responses": { - "404": { - "description": "Identifier group does not exist.", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "400": { - "description": "Query is invalid.", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "200": { - "description": "Returns the search result(s).", - "schema": { - "$ref": "#/definitions/Search" - } - } - }, - "operationId": "post_assets_group_feed_/assets/groups//feed", - "parameters": [ - { - "name": "fields", - "in": "query", - "type": "array", - "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "time", - "in": "query", - "type": "string", - "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z" - }, - { - "name": "size", - "in": "query", - "type": "integer", - "description": "The `size` parameter is used to limit the number of results returned for the search query.", - "default": 10 - }, - { - "name": "search_after", - "in": "query", - "type": "string", - "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results." - }, - { - "name": "from", - "in": "query", - "type": "string", - "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results." - }, - { - "name": "tags", - "in": "query", - "type": "array", - "description": "User defined tags used to filter search results", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "tags_query_operator", - "in": "query", - "type": "string", - "description": "User defined operator to apply to tags filter" - }, - { - "name": "types", - "in": "query", - "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "enum": [ - "attachment", - "listing", - "ransomleak", - "forum_post", - "forum_topic", - "forum_profile", - "blog_post", - "seller", - "paste", - "leak", - "chat_message", - "domain", - "bot", - "stealer_log", - "infected_devices", - "driller", - "driller_forum_topic", - "driller_forum_post", - "driller_profile", - "cc", - "ccbin", - "financial_data", - "leaked_data", - "leaked_file", - "document", - "account", - "actor", - "forum_content", - "blog_content", - "profile", - "leaked_credential", - "valid_credential", - "invalid_credential", - "mitigated_credential", - "illicit_networks", - "open_web", - "domains", - "intelligence_object", - "leaks", - "social_media_account", - "social_media", - "source_code", - "source_code_secrets_np", - "source_code_secrets", - "source_code_files", - "docker", - "stack_exchange", - "google", - "service", - "driller_host", - "buckets", - "bucket", - "bucket_object", - "whois", - "ad", - "ads", - "cookie", - "pii", - "experimental" - ] - }, - { - "name": "experimental_types", - "in": "query", - "type": "array", - "description": "Type of experimental activities to search through.", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "event_action", - "in": "query", - "type": "string", - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ] - }, - { - "name": "event_actions", - "in": "query", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ] - }, - { - "name": "risks", - "in": "query", - "type": "array", - "items": { - "type": "integer" - }, - "collectionFormat": "multi", - "enum": [ - 1, - 2, - 3, - 4, - 5 - ] - }, - { - "name": "order", - "in": "query", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - { - "name": "sort_by", - "in": "query", - "type": "string", - "default": "created", - "enum": [ - "created", - "indexed", - "updated", - "alertable-materialized", - "materialized", - "searchable" - ] - }, - { - "name": "use_global_policies", - "in": "query", - "type": "boolean", - "default": true - }, - { - "name": "time_zone", - "in": "query", - "type": "string", - "description": "The time zone used to compute the statistics." - }, - { - "name": "query", - "in": "query", - "type": "string", - "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax." - }, - { - "name": "has_modified_risk_score", - "in": "query", - "type": "boolean", - "default": false - }, - { - "name": "has_notes", - "in": "query", - "type": "boolean", - "default": false - } - ], - "tags": [ - "Identifiers" - ] - }, - "get": { - "responses": { - "404": { - "description": "Identifier group does not exist.", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "400": { - "description": "Query is invalid.", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "200": { - "description": "Returns the search result(s).", - "schema": { - "$ref": "#/definitions/Search" - } - } - }, - "operationId": "get_assets_group_feed_/assets/groups//feed", - "parameters": [ - { - "name": "fields", - "in": "query", - "type": "array", - "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "time", - "in": "query", - "type": "string", - "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z" - }, - { - "name": "size", - "in": "query", - "type": "integer", - "description": "The `size` parameter is used to limit the number of results returned for the search query.", - "default": 10 - }, - { - "name": "search_after", - "in": "query", - "type": "string", - "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results." - }, - { - "name": "from", - "in": "query", - "type": "string", - "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results." - }, - { - "name": "tags", - "in": "query", - "type": "array", - "description": "User defined tags used to filter search results", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "tags_query_operator", - "in": "query", - "type": "string", - "description": "User defined operator to apply to tags filter" - }, - { - "name": "types", - "in": "query", - "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "enum": [ - "attachment", - "listing", - "ransomleak", - "forum_post", - "forum_topic", - "forum_profile", - "blog_post", - "seller", - "paste", - "leak", - "chat_message", - "domain", - "bot", - "stealer_log", - "infected_devices", - "driller", - "driller_forum_topic", - "driller_forum_post", - "driller_profile", - "cc", - "ccbin", - "financial_data", - "leaked_data", - "leaked_file", - "document", - "account", - "actor", - "forum_content", - "blog_content", - "profile", - "leaked_credential", - "valid_credential", - "invalid_credential", - "mitigated_credential", - "illicit_networks", - "open_web", - "domains", - "intelligence_object", - "leaks", - "social_media_account", - "social_media", - "source_code", - "source_code_secrets_np", - "source_code_secrets", - "source_code_files", - "docker", - "stack_exchange", - "google", - "service", - "driller_host", - "buckets", - "bucket", - "bucket_object", - "whois", - "ad", - "ads", - "cookie", - "pii", - "experimental" - ] - }, - { - "name": "experimental_types", - "in": "query", - "type": "array", - "description": "Type of experimental activities to search through.", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "event_action", - "in": "query", - "type": "string", - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ] - }, - { - "name": "event_actions", - "in": "query", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ] - }, - { - "name": "risks", - "in": "query", - "type": "array", - "items": { - "type": "integer" - }, - "collectionFormat": "multi", - "enum": [ - 1, - 2, - 3, - 4, - 5 - ] - }, - { - "name": "order", - "in": "query", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - { - "name": "sort_by", - "in": "query", - "type": "string", - "default": "created", - "enum": [ - "created", - "indexed", - "updated", - "alertable-materialized", - "materialized", - "searchable" - ] - }, - { - "name": "use_global_policies", - "in": "query", - "type": "boolean", - "default": true - }, - { - "name": "time_zone", - "in": "query", - "type": "string", - "description": "The time zone used to compute the statistics." - }, - { - "name": "query", - "in": "query", - "type": "string", - "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax." - }, - { - "name": "has_modified_risk_score", - "in": "query", - "type": "boolean", - "default": false - }, - { - "name": "has_notes", - "in": "query", - "type": "boolean", - "default": false - } - ], - "tags": [ - "Identifiers" - ] - } - }, - "/firework/v2/assets/{asset_id}": { - "parameters": [ - { - "name": "asset_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "put": { - "responses": { - "400": { - "description": "Query is invalid.", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "200": { - "description": "Success", - "schema": { - "properties": { - "asset": { - "$ref": "#/definitions/Identifier" - } - } - } - } - }, - "operationId": "put_asset_api_/assets/", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/Identifier" - } - } - ], - "tags": [ - "Identifiers" - ] - }, - "delete": { - "responses": { - "200": { - "description": "Success" - } - }, - "operationId": "delete_asset_api_/assets/", - "tags": [ - "Identifiers" - ] - }, - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "properties": { - "asset": { - "$ref": "#/definitions/Identifier" - } - } - } - } - }, - "operationId": "get_asset_api_/assets/", - "tags": [ - "Identifiers" - ] - } - }, - "/firework/v2/assets/{asset_id}/alerts": { - "parameters": [ - { - "name": "asset_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "post": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FeedAlert" - } - } - }, - "operationId": "post_asset_alerts_/assets//alerts", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/FeedAlert" - } - } - ], - "tags": [ - "Identifiers" - ] - }, - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "properties": { - "alerts": { - "$ref": "#/definitions/FeedAlert" - } - } - } - } - }, - "operationId": "get_asset_alerts_/assets//alerts", - "tags": [ - "Identifiers" - ] - } - }, - "/firework/v2/assets/{asset_id}/alerts/{alert_id}": { - "parameters": [ - { - "name": "asset_id", - "in": "path", - "required": true, - "type": "integer" - }, - { - "name": "alert_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "put": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FeedAlert" - } - } - }, - "operationId": "put_asset_alert_/assets//alerts/", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/FeedAlert" - } - } - ], - "tags": [ - "Identifiers" - ] - }, - "delete": { - "responses": { - "200": { - "description": "Success" - } - }, - "operationId": "delete_asset_alert_/assets//alerts/", - "tags": [ - "Identifiers" - ] - } - }, - "/firework/v2/assets/{asset_id}/feed": { - "parameters": [ - { - "name": "asset_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "post": { - "responses": { - "404": { - "description": "Identifier does not exist.", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "400": { - "description": "Query is invalid.", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "200": { - "description": "Returns the search result(s).", - "schema": { - "$ref": "#/definitions/Search" - } - } - }, - "operationId": "post_asset_feed_/assets//feed", - "parameters": [ - { - "name": "fields", - "in": "query", - "type": "array", - "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "time", - "in": "query", - "type": "string", - "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z" - }, - { - "name": "size", - "in": "query", - "type": "integer", - "description": "The `size` parameter is used to limit the number of results returned for the search query.", - "default": 10 - }, - { - "name": "search_after", - "in": "query", - "type": "string", - "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results." - }, - { - "name": "from", - "in": "query", - "type": "string", - "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results." - }, - { - "name": "tags", - "in": "query", - "type": "array", - "description": "User defined tags used to filter search results", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "tags_query_operator", - "in": "query", - "type": "string", - "description": "User defined operator to apply to tags filter" - }, - { - "name": "types", - "in": "query", - "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "enum": [ - "attachment", - "listing", - "ransomleak", - "forum_post", - "forum_topic", - "forum_profile", - "blog_post", - "seller", - "paste", - "leak", - "chat_message", - "domain", - "bot", - "stealer_log", - "infected_devices", - "driller", - "driller_forum_topic", - "driller_forum_post", - "driller_profile", - "cc", - "ccbin", - "financial_data", - "leaked_data", - "leaked_file", - "document", - "account", - "actor", - "forum_content", - "blog_content", - "profile", - "leaked_credential", - "valid_credential", - "invalid_credential", - "mitigated_credential", - "illicit_networks", - "open_web", - "domains", - "intelligence_object", - "leaks", - "social_media_account", - "social_media", - "source_code", - "source_code_secrets_np", - "source_code_secrets", - "source_code_files", - "docker", - "stack_exchange", - "google", - "service", - "driller_host", - "buckets", - "bucket", - "bucket_object", - "whois", - "ad", - "ads", - "cookie", - "pii", - "experimental" - ] - }, - { - "name": "experimental_types", - "in": "query", - "type": "array", - "description": "Type of experimental activities to search through.", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "event_action", - "in": "query", - "type": "string", - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ] - }, - { - "name": "event_actions", - "in": "query", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ] - }, - { - "name": "risks", - "in": "query", - "type": "array", - "items": { - "type": "integer" - }, - "collectionFormat": "multi", - "enum": [ - 1, - 2, - 3, - 4, - 5 - ] - }, - { - "name": "order", - "in": "query", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - { - "name": "sort_by", - "in": "query", - "type": "string", - "default": "created", - "enum": [ - "created", - "indexed", - "updated", - "alertable-materialized", - "materialized", - "searchable" - ] - }, - { - "name": "use_global_policies", - "in": "query", - "type": "boolean", - "default": true - }, - { - "name": "time_zone", - "in": "query", - "type": "string", - "description": "The time zone used to compute the statistics." - }, - { - "name": "query", - "in": "query", - "type": "string", - "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax." - }, - { - "name": "has_modified_risk_score", - "in": "query", - "type": "boolean", - "default": false - }, - { - "name": "has_notes", - "in": "query", - "type": "boolean", - "default": false - } - ], - "tags": [ - "Identifiers" - ] - }, - "get": { - "responses": { - "404": { - "description": "Identifier does not exist.", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "400": { - "description": "Query is invalid.", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "200": { - "description": "Returns the search result(s).", - "schema": { - "$ref": "#/definitions/Search" - } - } - }, - "operationId": "get_asset_feed_/assets//feed", - "parameters": [ - { - "name": "fields", - "in": "query", - "type": "array", - "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "time", - "in": "query", - "type": "string", - "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z" - }, - { - "name": "size", - "in": "query", - "type": "integer", - "description": "The `size` parameter is used to limit the number of results returned for the search query.", - "default": 10 - }, - { - "name": "search_after", - "in": "query", - "type": "string", - "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results." - }, - { - "name": "from", - "in": "query", - "type": "string", - "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results." - }, - { - "name": "tags", - "in": "query", - "type": "array", - "description": "User defined tags used to filter search results", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "tags_query_operator", - "in": "query", - "type": "string", - "description": "User defined operator to apply to tags filter" - }, - { - "name": "types", - "in": "query", - "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "enum": [ - "attachment", - "listing", - "ransomleak", - "forum_post", - "forum_topic", - "forum_profile", - "blog_post", - "seller", - "paste", - "leak", - "chat_message", - "domain", - "bot", - "stealer_log", - "infected_devices", - "driller", - "driller_forum_topic", - "driller_forum_post", - "driller_profile", - "cc", - "ccbin", - "financial_data", - "leaked_data", - "leaked_file", - "document", - "account", - "actor", - "forum_content", - "blog_content", - "profile", - "leaked_credential", - "valid_credential", - "invalid_credential", - "mitigated_credential", - "illicit_networks", - "open_web", - "domains", - "intelligence_object", - "leaks", - "social_media_account", - "social_media", - "source_code", - "source_code_secrets_np", - "source_code_secrets", - "source_code_files", - "docker", - "stack_exchange", - "google", - "service", - "driller_host", - "buckets", - "bucket", - "bucket_object", - "whois", - "ad", - "ads", - "cookie", - "pii", - "experimental" - ] - }, - { - "name": "experimental_types", - "in": "query", - "type": "array", - "description": "Type of experimental activities to search through.", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "event_action", - "in": "query", - "type": "string", - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ] - }, - { - "name": "event_actions", - "in": "query", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ] - }, - { - "name": "risks", - "in": "query", - "type": "array", - "items": { - "type": "integer" - }, - "collectionFormat": "multi", - "enum": [ - 1, - 2, - 3, - 4, - 5 - ] - }, - { - "name": "order", - "in": "query", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - { - "name": "sort_by", - "in": "query", - "type": "string", - "default": "created", - "enum": [ - "created", - "indexed", - "updated", - "alertable-materialized", - "materialized", - "searchable" - ] - }, - { - "name": "use_global_policies", - "in": "query", - "type": "boolean", - "default": true - }, - { - "name": "time_zone", - "in": "query", - "type": "string", - "description": "The time zone used to compute the statistics." - }, - { - "name": "query", - "in": "query", - "type": "string", - "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax." - }, - { - "name": "has_modified_risk_score", - "in": "query", - "type": "boolean", - "default": false - }, - { - "name": "has_notes", - "in": "query", - "type": "boolean", - "default": false - } - ], - "tags": [ - "Identifiers" - ] - } - }, - "/firework/v2/assets/{asset_id}/highlights/{index}/{source}/{id}": { - "parameters": [ - { - "name": "asset_id", - "in": "path", - "required": true, - "type": "integer" - }, - { - "name": "index", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "source", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - } - ], - "get": { - "responses": { - "200": { - "description": "Returns the highlights of the identifier data matching on an activity content." - }, - "404": { - "description": "Identifier or activity does not exist.", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "400": { - "description": "Query is invalid.", - "schema": { - "$ref": "#/definitions/HttpError" - } - } - }, - "operationId": "get_identifier_activity_highlights_/assets//highlights///", - "tags": [ - "Identifiers" - ] - } - }, - "/firework/v2/assets/{asset_id}/toggle": { - "parameters": [ - { - "name": "asset_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "post": { - "responses": { - "200": { - "description": "Success", - "schema": { - "properties": { - "asset": { - "$ref": "#/definitions/Identifier" - } - } - } - } - }, - "operationId": "post_identifier_toggle_/assets//toggle", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/IdentifierToggle" - } - } - ], - "tags": [ - "Identifiers" - ] - } - }, - "/firework/v2/me/feed": { - "post": { - "responses": { - "200": { - "description": "The user's home feed activities", - "schema": { - "$ref": "#/definitions/Search" - } - } - }, - "operationId": "post_current_user_home_feed_/me/feed", - "parameters": [ - { - "name": "time", - "in": "query", - "type": "string", - "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z" - }, - { - "name": "size", - "in": "query", - "type": "integer", - "description": "The `size` parameter is used to limit the number of results returned for the search query.", - "default": 10 - }, - { - "name": "search_after", - "in": "query", - "type": "string", - "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results." - }, - { - "name": "from", - "in": "query", - "type": "string", - "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results." - }, - { - "name": "tags", - "in": "query", - "type": "array", - "description": "User defined tags used to filter search results", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "tags_query_operator", - "in": "query", - "type": "string", - "description": "User defined operator to apply to tags filter" - }, - { - "name": "types", - "in": "query", - "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "enum": [ - "attachment", - "listing", - "ransomleak", - "forum_post", - "forum_topic", - "forum_profile", - "blog_post", - "seller", - "paste", - "leak", - "chat_message", - "domain", - "bot", - "stealer_log", - "infected_devices", - "driller", - "driller_forum_topic", - "driller_forum_post", - "driller_profile", - "cc", - "ccbin", - "financial_data", - "leaked_data", - "leaked_file", - "document", - "account", - "actor", - "forum_content", - "blog_content", - "profile", - "leaked_credential", - "valid_credential", - "invalid_credential", - "mitigated_credential", - "illicit_networks", - "open_web", - "domains", - "intelligence_object", - "leaks", - "social_media_account", - "social_media", - "source_code", - "source_code_secrets_np", - "source_code_secrets", - "source_code_files", - "docker", - "stack_exchange", - "google", - "service", - "driller_host", - "buckets", - "bucket", - "bucket_object", - "whois", - "ad", - "ads", - "cookie", - "pii", - "experimental" - ] - }, - { - "name": "experimental_types", - "in": "query", - "type": "array", - "description": "Type of experimental activities to search through.", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "event_action", - "in": "query", - "type": "string", - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ] - }, - { - "name": "event_actions", - "in": "query", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ] - }, - { - "name": "risks", - "in": "query", - "type": "array", - "items": { - "type": "integer" - }, - "collectionFormat": "multi", - "enum": [ - 1, - 2, - 3, - 4, - 5 - ] - }, - { - "name": "order", - "in": "query", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - { - "name": "sort_by", - "in": "query", - "type": "string", - "default": "created", - "enum": [ - "created", - "indexed", - "updated", - "alertable-materialized", - "materialized", - "searchable" - ] - }, - { - "name": "use_global_policies", - "in": "query", - "type": "boolean", - "default": true - }, - { - "name": "time_zone", - "in": "query", - "type": "string", - "description": "The time zone used to compute the statistics." - }, - { - "name": "query", - "in": "query", - "type": "string", - "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax." - }, - { - "name": "has_modified_risk_score", - "in": "query", - "type": "boolean", - "default": false - }, - { - "name": "has_notes", - "in": "query", - "type": "boolean", - "default": false - } - ], - "tags": [ - "me" - ] - }, - "get": { - "responses": { - "200": { - "description": "The user's home feed activities", - "schema": { - "$ref": "#/definitions/Search" - } - } - }, - "operationId": "get_current_user_home_feed_/me/feed", - "parameters": [ - { - "name": "time", - "in": "query", - "type": "string", - "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z" - }, - { - "name": "size", - "in": "query", - "type": "integer", - "description": "The `size` parameter is used to limit the number of results returned for the search query.", - "default": 10 - }, - { - "name": "search_after", - "in": "query", - "type": "string", - "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results." - }, - { - "name": "from", - "in": "query", - "type": "string", - "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results." - }, - { - "name": "tags", - "in": "query", - "type": "array", - "description": "User defined tags used to filter search results", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "tags_query_operator", - "in": "query", - "type": "string", - "description": "User defined operator to apply to tags filter" - }, - { - "name": "types", - "in": "query", - "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "enum": [ - "attachment", - "listing", - "ransomleak", - "forum_post", - "forum_topic", - "forum_profile", - "blog_post", - "seller", - "paste", - "leak", - "chat_message", - "domain", - "bot", - "stealer_log", - "infected_devices", - "driller", - "driller_forum_topic", - "driller_forum_post", - "driller_profile", - "cc", - "ccbin", - "financial_data", - "leaked_data", - "leaked_file", - "document", - "account", - "actor", - "forum_content", - "blog_content", - "profile", - "leaked_credential", - "valid_credential", - "invalid_credential", - "mitigated_credential", - "illicit_networks", - "open_web", - "domains", - "intelligence_object", - "leaks", - "social_media_account", - "social_media", - "source_code", - "source_code_secrets_np", - "source_code_secrets", - "source_code_files", - "docker", - "stack_exchange", - "google", - "service", - "driller_host", - "buckets", - "bucket", - "bucket_object", - "whois", - "ad", - "ads", - "cookie", - "pii", - "experimental" - ] - }, - { - "name": "experimental_types", - "in": "query", - "type": "array", - "description": "Type of experimental activities to search through.", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "event_action", - "in": "query", - "type": "string", - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ] - }, - { - "name": "event_actions", - "in": "query", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ] - }, - { - "name": "risks", - "in": "query", - "type": "array", - "items": { - "type": "integer" - }, - "collectionFormat": "multi", - "enum": [ - 1, - 2, - 3, - 4, - 5 - ] - }, - { - "name": "order", - "in": "query", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - { - "name": "sort_by", - "in": "query", - "type": "string", - "default": "created", - "enum": [ - "created", - "indexed", - "updated", - "alertable-materialized", - "materialized", - "searchable" - ] - }, - { - "name": "use_global_policies", - "in": "query", - "type": "boolean", - "default": true - }, - { - "name": "time_zone", - "in": "query", - "type": "string", - "description": "The time zone used to compute the statistics." - }, - { - "name": "query", - "in": "query", - "type": "string", - "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax." - }, - { - "name": "has_modified_risk_score", - "in": "query", - "type": "boolean", - "default": false - }, - { - "name": "has_notes", - "in": "query", - "type": "boolean", - "default": false - } - ], - "tags": [ - "me" - ] - } - }, - "/firework/v2/me/feed/credentials": { - "post": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PaginatedCredentials" - } - } - }, - "operationId": "post_leaked_credentials_feed_endpoint_/me/feed/credentials", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/UserUpdate" - } - } - ], - "tags": [ - "me" - ] - }, - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PaginatedCredentials" - } - } - }, - "operationId": "get_leaked_credentials_feed_endpoint_/me/feed/credentials", - "parameters": [ - { - "name": "size", - "in": "query", - "type": "integer", - "default": 20 - }, - { - "name": "from", - "in": "query", - "type": "string" - }, - { - "name": "order_type", - "in": "query", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - } - ], - "tags": [ - "me" - ] - } - }, - "/firework/v2/me/profile": { - "put": { - "responses": { - "400": { - "description": "Update is invalid", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "200": { - "description": "Success", - "schema": { - "properties": { - "profile": { - "$ref": "#/definitions/UserProfile" - } - } - } - } - }, - "operationId": "put_current_user_profile_/me/profile", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/UserUpdate" - } - } - ], - "tags": [ - "me" - ] - }, - "get": { - "responses": { - "200": { - "description": "Returns the current user's profile" - } - }, - "operationId": "get_current_user_profile_/me/profile", - "tags": [ - "me" - ] - } - }, - "/firework/v2/me/tenants": { - "get": { - "responses": { - "200": { - "description": "Returns the current user's tenants." - } - }, - "operationId": "get_current_user_tenants_/me/tenants", - "tags": [ - "me" - ] - } - }, - "/firework/v2/organizations/{organization_id}/members": { - "parameters": [ - { - "name": "organization_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "post": { - "responses": { - "404": { - "description": "Organization not found", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "200": { - "description": "Success", - "schema": { - "properties": { - "member": { - "$ref": "#/definitions/OrganizationMemberWithMetadata" - } - } - } - } - }, - "operationId": "post_organization_members_api_/organizations//members", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/OrganizationMemberData" - } - } - ], - "tags": [ - "organizations" - ] - }, - "get": { - "responses": { - "404": { - "description": "Organization not found", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OrganizationMemberPage" - } - } - }, - "operationId": "get_organization_members_api_/organizations//members", - "parameters": [ - { - "name": "size", - "in": "query", - "type": "integer", - "default": 20 - }, - { - "name": "from", - "in": "query", - "type": "string" - }, - { - "name": "q", - "in": "query", - "type": "string" - } - ], - "tags": [ - "organizations" - ] - } - }, - "/firework/v2/organizations/{organization_id}/members/count": { - "parameters": [ - { - "name": "organization_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "get": { - "responses": { - "404": { - "description": "Organization not found", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OrganizationMembersCount" - } - } - }, - "operationId": "get_organization_members_count_api_/organizations//members/count", - "tags": [ - "organizations" - ] - } - }, - "/firework/v2/organizations/{organization_id}/members/{user_id}": { - "parameters": [ - { - "name": "organization_id", - "in": "path", - "required": true, - "type": "integer" - }, - { - "name": "user_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "put": { - "responses": { - "200": { - "description": "Success", - "schema": { - "properties": { - "member": { - "$ref": "#/definitions/OrganizationMemberWithMetadata" - } - } - } - } - }, - "operationId": "put_organization_member_api_/organizations//members/", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/OrganizationMember" - } - } - ], - "tags": [ - "organizations" - ] - }, - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "properties": { - "member": { - "$ref": "#/definitions/OrganizationMemberWithMetadata" - } - } - } - } - }, - "operationId": "get_organization_member_api_/organizations//members/", - "tags": [ - "organizations" - ] - } - }, - "/firework/v2/organizations/{organization_id}/members/{user_id}/disable": { - "parameters": [ - { - "name": "organization_id", - "in": "path", - "required": true, - "type": "integer" - }, - { - "name": "user_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "post": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/EnableState" - } - } - }, - "operationId": "post_organization_member_disable_/organizations//members//disable", - "tags": [ - "organizations" - ] - } - }, - "/firework/v2/organizations/{organization_id}/members/{user_id}/enable": { - "parameters": [ - { - "name": "organization_id", - "in": "path", - "required": true, - "type": "integer" - }, - { - "name": "user_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "post": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/EnableState" - } - } - }, - "operationId": "post_organization_member_enable_/organizations//members//enable", - "tags": [ - "organizations" - ] - } - }, - "/firework/v2/organizations/{organization_id}/members/{user_id}/permissions": { - "parameters": [ - { - "name": "organization_id", - "in": "path", - "required": true, - "type": "integer" - }, - { - "name": "user_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "post": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/UpdatedPermission" - } - } - }, - "operationId": "post_organization_member_permissions_api_/organizations//members//permissions", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/PermissionData" - } - } - ], - "tags": [ - "organizations" - ] - } - }, - "/firework/v2/organizations/{organization_id}/members/{user_id}/tenants": { - "parameters": [ - { - "name": "organization_id", - "in": "path", - "required": true, - "type": "integer" - }, - { - "name": "user_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/TenantWithCounts" - } - } - }, - "operationId": "get_organization_member_tenants_/organizations//members//tenants", - "parameters": [ - { - "name": "size", - "in": "query", - "type": "integer", - "default": 20 - }, - { - "name": "from", - "in": "query", - "type": "string" - }, - { - "name": "include_disabled_demo", - "in": "query", - "type": "boolean", - "default": false - }, - { - "name": "q", - "in": "query", - "type": "string" - }, - { - "name": "types[]", - "in": "query", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "enum": [ - "regular", - "service-firm", - "micro", - "starter", - "essential", - "core", - "enterprise", - "demo", - "training" - ] - } - ], - "tags": [ - "organizations" - ] - } - }, - "/firework/v2/organizations/{organization_id}/tenants": { - "parameters": [ - { - "name": "organization_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "post": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Tenant" - } - } - }, - "operationId": "post_organization_tenants_api_/organizations//tenants", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/NewTenantInfo" - } - } - ], - "tags": [ - "organizations" - ] - }, - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/TenantWithCounts" - } - } - }, - "operationId": "get_organization_tenants_api_/organizations//tenants", - "tags": [ - "organizations" - ] - } - }, - "/firework/v2/reporting/reports": { - "post": { - "responses": { - "200": { - "description": "Creates a new report on the current tenant." - } - }, - "operationId": "post_reports_endpoint_/reporting/reports", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/NewReport" - } - } - ], - "tags": [ - "reporting" - ] - }, - "get": { - "responses": { - "200": { - "description": "Lists reports for the current tenant, ordered from newest to oldest." - } - }, - "operationId": "get_reports_endpoint_/reporting/reports", - "tags": [ - "reporting" - ] - } - }, - "/firework/v2/reporting/reports/{report_id}": { - "parameters": [ - { - "name": "report_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "patch": { - "responses": { - "200": { - "description": "Updates a report." - } - }, - "operationId": "patch_report_endpoint_/reporting/reports/", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/UpdatedReport" - } - } - ], - "tags": [ - "reporting" - ] - }, - "delete": { - "responses": { - "200": { - "description": "Deletes a report." - } - }, - "operationId": "delete_report_endpoint_/reporting/reports/", - "tags": [ - "reporting" - ] - }, - "get": { - "responses": { - "200": { - "description": "Returns a report and its elements." - } - }, - "operationId": "get_report_endpoint_/reporting/reports/", - "tags": [ - "reporting" - ] - } - }, - "/firework/v2/reporting/reports/{report_id}/archive": { - "parameters": [ - { - "name": "report_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "post": { - "responses": { - "200": { - "description": "Archives a report." - } - }, - "operationId": "post_archive_report_endpoint_/reporting/reports//archive", - "tags": [ - "reporting" - ] - } - }, - "/firework/v2/reporting/reports/{report_id}/download": { - "parameters": [ - { - "name": "report_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "get": { - "responses": { - "200": { - "description": "Download a report." - } - }, - "operationId": "get_report_download_endpoint_/reporting/reports//download", - "tags": [ - "reporting" - ] - } - }, - "/firework/v2/search/": { - "post": { - "responses": { - "400": { - "description": "Query is invalid.", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "200": { - "description": "Returns the search result(s).", - "schema": { - "$ref": "#/definitions/Search" - } - } - }, - "operationId": "post_search_/search/", - "parameters": [ - { - "name": "fields", - "in": "query", - "type": "array", - "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "time", - "in": "query", - "type": "string", - "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z" - }, - { - "name": "size", - "in": "query", - "type": "integer", - "description": "The `size` parameter is used to limit the number of results returned for the search query.", - "default": 10 - }, - { - "name": "search_after", - "in": "query", - "type": "string", - "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results." - }, - { - "name": "from", - "in": "query", - "type": "string", - "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results." - }, - { - "name": "tags", - "in": "query", - "type": "array", - "description": "User defined tags used to filter search results", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "tags_query_operator", - "in": "query", - "type": "string", - "description": "User defined operator to apply to tags filter" - }, - { - "name": "types", - "in": "query", - "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "enum": [ - "attachment", - "listing", - "ransomleak", - "forum_post", - "forum_topic", - "forum_profile", - "blog_post", - "seller", - "paste", - "leak", - "chat_message", - "domain", - "bot", - "stealer_log", - "infected_devices", - "driller", - "driller_forum_topic", - "driller_forum_post", - "driller_profile", - "cc", - "ccbin", - "financial_data", - "leaked_data", - "leaked_file", - "document", - "account", - "actor", - "forum_content", - "blog_content", - "profile", - "leaked_credential", - "valid_credential", - "invalid_credential", - "mitigated_credential", - "illicit_networks", - "open_web", - "domains", - "intelligence_object", - "leaks", - "social_media_account", - "social_media", - "source_code", - "source_code_secrets_np", - "source_code_secrets", - "source_code_files", - "docker", - "stack_exchange", - "google", - "service", - "driller_host", - "buckets", - "bucket", - "bucket_object", - "whois", - "cookie", - "pii", - "experimental" - ] - }, - { - "name": "experimental_types", - "in": "query", - "type": "array", - "description": "Type of experimental activities to search through.", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "event_action", - "in": "query", - "type": "string", - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ] - }, - { - "name": "event_actions", - "in": "query", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ] - }, - { - "name": "risks", - "in": "query", - "type": "array", - "items": { - "type": "integer" - }, - "collectionFormat": "multi", - "enum": [ - 1, - 2, - 3, - 4, - 5 - ] - }, - { - "name": "order", - "in": "query", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - { - "name": "sort_by", - "in": "query", - "type": "string", - "default": "created", - "enum": [ - "created", - "indexed", - "updated", - "alertable-materialized", - "materialized", - "searchable" - ] - }, - { - "name": "use_global_policies", - "in": "query", - "type": "boolean", - "default": true - }, - { - "name": "time_zone", - "in": "query", - "type": "string", - "description": "The time zone used to compute the statistics." - }, - { - "name": "query", - "in": "query", - "type": "string", - "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax." - }, - { - "name": "has_modified_risk_score", - "in": "query", - "type": "boolean", - "default": false - }, - { - "name": "has_notes", - "in": "query", - "type": "boolean", - "default": false - } - ], - "tags": [ - "search" - ] - }, - "get": { - "responses": { - "400": { - "description": "Query is invalid.", - "schema": { - "$ref": "#/definitions/HttpError" - } - }, - "200": { - "description": "Returns the search result(s).", - "schema": { - "$ref": "#/definitions/Search" - } - } - }, - "operationId": "get_search_/search/", - "parameters": [ - { - "name": "fields", - "in": "query", - "type": "array", - "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "time", - "in": "query", - "type": "string", - "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z" - }, - { - "name": "size", - "in": "query", - "type": "integer", - "description": "The `size` parameter is used to limit the number of results returned for the search query.", - "default": 10 - }, - { - "name": "search_after", - "in": "query", - "type": "string", - "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results." - }, - { - "name": "from", - "in": "query", - "type": "string", - "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results." - }, - { - "name": "tags", - "in": "query", - "type": "array", - "description": "User defined tags used to filter search results", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "tags_query_operator", - "in": "query", - "type": "string", - "description": "User defined operator to apply to tags filter" - }, - { - "name": "types", - "in": "query", - "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "enum": [ - "attachment", - "listing", - "ransomleak", - "forum_post", - "forum_topic", - "forum_profile", - "blog_post", - "seller", - "paste", - "leak", - "chat_message", - "domain", - "bot", - "stealer_log", - "infected_devices", - "driller", - "driller_forum_topic", - "driller_forum_post", - "driller_profile", - "cc", - "ccbin", - "financial_data", - "leaked_data", - "leaked_file", - "document", - "account", - "actor", - "forum_content", - "blog_content", - "profile", - "leaked_credential", - "valid_credential", - "invalid_credential", - "mitigated_credential", - "illicit_networks", - "open_web", - "domains", - "intelligence_object", - "leaks", - "social_media_account", - "social_media", - "source_code", - "source_code_secrets_np", - "source_code_secrets", - "source_code_files", - "docker", - "stack_exchange", - "google", - "service", - "driller_host", - "buckets", - "bucket", - "bucket_object", - "whois", - "cookie", - "pii", - "experimental" - ] - }, - { - "name": "experimental_types", - "in": "query", - "type": "array", - "description": "Type of experimental activities to search through.", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "event_action", - "in": "query", - "type": "string", - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ] - }, - { - "name": "event_actions", - "in": "query", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "enum": [ - "default", - "ignored", - "remediated", - "risk_score_edited", - "exclude_ignored", - "ignored_or_remediated" - ] - }, - { - "name": "risks", - "in": "query", - "type": "array", - "items": { - "type": "integer" - }, - "collectionFormat": "multi", - "enum": [ - 1, - 2, - 3, - 4, - 5 - ] - }, - { - "name": "order", - "in": "query", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - { - "name": "sort_by", - "in": "query", - "type": "string", - "default": "created", - "enum": [ - "created", - "indexed", - "updated", - "alertable-materialized", - "materialized", - "searchable" - ] - }, - { - "name": "use_global_policies", - "in": "query", - "type": "boolean", - "default": true - }, - { - "name": "time_zone", - "in": "query", - "type": "string", - "description": "The time zone used to compute the statistics." - }, - { - "name": "query", - "in": "query", - "type": "string", - "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax." - }, - { - "name": "has_modified_risk_score", - "in": "query", - "type": "boolean", - "default": false - }, - { - "name": "has_notes", - "in": "query", - "type": "boolean", - "default": false - } - ], - "tags": [ - "search" - ] - } - }, - "/firework/v2/tenants/{tenant_id}": { - "parameters": [ - { - "name": "tenant_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "put": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/TenantWithCounts" - } - } - }, - "operationId": "put_tenant_api_/tenants/", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/TenantData" - } - } - ], - "tags": [ - "tenants" - ] - }, - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/TenantWithCounts" - } - } - }, - "operationId": "get_tenant_api_/tenants/", - "tags": [ - "tenants" - ] - } - }, - "/firework/v2/tenants/{tenant_id}/archive": { - "parameters": [ - { - "name": "tenant_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "post": { - "responses": { - "200": { - "description": "Success" - } - }, - "operationId": "post_tenant_archive_api_/tenants//archive", - "tags": [ - "tenants" - ] - } - }, - "/firework/v2/tenants/{tenant_id}/users": { - "parameters": [ - { - "name": "tenant_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "post": { - "responses": { - "200": { - "description": "Users were successfully added to tenant." - } - }, - "operationId": "post_tenant_users_api_/tenants//users", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/UserTenantAccessRequest" - } - } - ], - "tags": [ - "tenants" - ] - }, - "get": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/TenantUsers" - } - } - }, - "operationId": "get_tenant_users_api_/tenants//users", - "tags": [ - "tenants" - ] - } - }, - "/firework/v2/tenants/{tenant_id}/users/{user_id}": { - "parameters": [ - { - "name": "tenant_id", - "in": "path", - "required": true, - "type": "integer" - }, - { - "name": "user_id", - "in": "path", - "required": true, - "type": "integer" - } - ], - "delete": { - "responses": { - "200": { - "description": "User was successfully removed from the tenant." - } - }, - "operationId": "delete_tenant_users_access_api_/tenants//users/", - "tags": [ - "tenants" - ] - } - } - }, - "info": { - "title": "Firework API", - "version": "v2", - "description": "\nManage and access Firework resources.\n\n### Steps to use the Api\n\n1. `Send` a POST request to `https://api.flare.systems/tokens/generate` with your **Firework** credentials using [Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication) to get a authentication token.\n---\n2. On the current page, click on the **Authorize** button and insert the token using the following format: `Bearer {token}`\n\n Example value: `Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e30.Et9HFtf9R3GEMA0IICOfFMVXY7kkTX1wr4qCyhIf58U`\n---\n3. You should now be able to use SwaggerUI's built-in tools to query the documented endpoints.\n" - }, - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ], - "securityDefinitions": { - "BearerAuth": { - "type": "apiKey", - "name": "Authorization", - "in": "header" - } - }, - "security": [ - { - "BearerAuth": [] - } - ], - "tags": [ - { - "name": "search", - "description": "Searches the threat activity database." - }, - { - "name": "Identifiers", - "description": "Manage a user's or organization's identifiers" - }, - { - "name": "activities", - "description": "Perform actions on activities." - }, - { - "name": "me", - "description": "Perform actions on the current user." - }, - { - "name": "tenants", - "description": "Manage tenants." - }, - { - "name": "organizations", - "description": "Admin management of organizations." - }, - { - "name": "reporting", - "description": "Manage reporting as an admin." - } - ], - "definitions": { - "HttpError": { - "properties": { - "message": { - "type": "string" - }, - "code": { - "type": "string" - } - }, - "type": "object" - }, - "Search": { - "properties": { - "items": { - "type": "array", - "items": { - "type": "object" - } - }, - "nb_hits": { - "type": "integer" - }, - "links": { - "$ref": "#/definitions/SearchLinks" - }, - "search_after": { - "type": "string" - } - }, - "type": "object" - }, - "SearchLinks": { - "properties": { - "next": { - "type": "string" - } - }, - "type": "object" - }, - "IdentifierCreate": { - "required": [ - "data", - "name", - "search_types", - "type" - ], - "properties": { - "name": { - "type": "string", - "minLength": 1 - }, - "type": { - "type": "string", - "example": "domain", - "enum": [ - "domain", - "name", - "keyword", - "github_repository", - "username", - "email", - "search_query", - "bin", - "ip", - "secret", - "azure_tenant", - "identity", - "ransomleak", - "external_id", - "address_data", - "birth_year", - "role", - "phone_number" - ] - }, - "search_types": { - "type": "array", - "items": { - "type": "string", - "example": "leak", - "enum": [ - "leak", - "invalid_credential", - "stealer_log", - "domain", - "mitigated_credential", - "chat_message", - "forum_profile", - "stack_exchange", - "forum_post", - "paste", - "docker", - "valid_credential", - "service", - "social_media_account", - "financial_data", - "bucket", - "ad", - "ransomleak", - "blog_post", - "listing", - "google", - "bot", - "seller", - "source_code_secrets", - "source_code_files", - "forum_topic", - "bucket_object", - "illicit_networks", - "open_web", - "buckets", - "source_code", - "leaks", - "domains", - "forum_content", - "blog_content", - "profile", - "ads", - "infected_devices", - "social_media" - ] - } - }, - "experimental_search_types": { - "type": "array", - "items": { - "type": "string" - } - }, - "risks": { - "type": "array", - "items": { - "type": "integer" - } - }, - "data": { - "type": "object" - } - }, - "type": "object" - }, - "Identifier": { - "required": [ - "data", - "name", - "search_types", - "type" - ], - "properties": { - "id": { - "type": "integer" - }, - "tenant_id": { - "type": "integer" - }, - "feed_id": { - "type": "integer" - }, - "type": { - "type": "string", - "example": "domain", - "enum": [ - "domain", - "name", - "keyword", - "github_repository", - "username", - "email", - "search_query", - "bin", - "ip", - "secret", - "azure_tenant", - "identity", - "ransomleak", - "external_id", - "address_data", - "birth_year", - "role", - "phone_number" - ] - }, - "search_types": { - "type": "array", - "items": { - "type": "string", - "example": "leak", - "enum": [ - "leak", - "invalid_credential", - "stealer_log", - "domain", - "mitigated_credential", - "chat_message", - "forum_profile", - "stack_exchange", - "forum_post", - "paste", - "docker", - "valid_credential", - "service", - "social_media_account", - "financial_data", - "bucket", - "ransomleak", - "blog_post", - "listing", - "google", - "bot", - "seller", - "source_code_secrets", - "source_code_files", - "forum_topic", - "bucket_object", - "illicit_networks", - "open_web", - "buckets", - "source_code", - "leaks", - "domains", - "forum_content", - "blog_content", - "profile", - "infected_devices", - "social_media" - ] - } - }, - "experimental_search_types": { - "type": "array", - "items": { - "type": "string" - } - }, - "v3_refs": { - "$ref": "#/definitions/V3_Refs" - }, - "risks": { - "type": "array", - "items": { - "type": "integer" - } - }, - "name": { - "type": "string", - "minLength": 1 - }, - "data": { - "type": "object" - }, - "assets_group_id": { - "type": [ - "integer", - "null" - ], - "example": "nullable integer" - }, - "fetching_progress": { - "type": "integer" - }, - "count": { - "type": "integer" - }, - "urn": { - "type": "string", - "description": "The uniform resource name of the identifier." - }, - "is_disabled": { - "type": "boolean" - }, - "source": { - "type": "string", - "example": "USER", - "enum": [ - "USER", - "SYSTEM_RELATION", - "SELF_ONBOARDING", - "ATTRIBUTE", - "AUTO_MONITOR", - "IDP_SYNC" - ] - }, - "data_updated_at": { - "type": "string", - "format": "date-time" - }, - "monitored_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "example": "nullable date" - } - }, - "type": "object" - }, - "V3_Refs": { - "properties": { - "asset_uuid": { - "type": "string" - } - }, - "type": "object" - }, - "IdentifierToggle": { - "required": [ - "is_disabled" - ], - "properties": { - "is_disabled": { - "type": "boolean", - "description": "The `is_disabled` parameter is used to toggle the asset as either enabled or disabled.", - "default": true - } - }, - "type": "object" - }, - "FeedAlert": { - "required": [ - "frequency", - "params", - "start_at", - "type" - ], - "properties": { - "name": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "type": { - "type": "string", - "example": "email", - "enum": [ - "email", - "channel", - "azure_sentinel", - "azure_sentinel_v2", - "slack", - "discord", - "splunk", - "jira", - "teams", - "servicenow", - "webhook" - ] - }, - "feed_url": { - "type": "string" - }, - "feed_target_type": { - "type": "string", - "example": "assets/groups", - "enum": [ - "assets/groups", - "assets", - "home" - ] - }, - "feed_target_id": { - "type": "integer" - }, - "frequency": { - "type": "integer" - }, - "start_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "last_processed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "example": "nullable date" - }, - "last_result_date": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "example": "nullable date" - }, - "params": { - "type": "object" - }, - "tenant_id": { - "type": "integer" - }, - "organization_id": { - "type": "integer" - }, - "search_types": { - "type": "array", - "items": { - "type": "string", - "example": "attachment", - "enum": [ - "attachment", - "listing", - "ransomleak", - "forum_post", - "forum_topic", - "forum_profile", - "blog_post", - "seller", - "paste", - "leak", - "chat_message", - "domain", - "bot", - "stealer_log", - "infected_devices", - "driller", - "driller_forum_topic", - "driller_forum_post", - "driller_profile", - "cc", - "ccbin", - "financial_data", - "leaked_data", - "leaked_file", - "document", - "account", - "actor", - "forum_content", - "blog_content", - "profile", - "leaked_credential", - "valid_credential", - "invalid_credential", - "mitigated_credential", - "illicit_networks", - "open_web", - "domains", - "intelligence_object", - "leaks", - "social_media_account", - "social_media", - "source_code", - "source_code_secrets_np", - "source_code_secrets", - "source_code_files", - "docker", - "stack_exchange", - "google", - "service", - "driller_host", - "buckets", - "bucket", - "bucket_object", - "whois", - "ad", - "ads", - "cookie", - "pii", - "experimental" - ] - } - }, - "experimental_search_types": { - "type": "array", - "items": { - "type": "string" - } - }, - "risks": { - "type": "array", - "items": { - "type": "integer" - } - }, - "tenant_alert_channel_id": { - "type": "integer" - } - }, - "type": "object" - }, - "IdentifierGroup": { - "properties": { - "id": { - "type": "integer" - }, - "tenant_id": { - "type": "integer" - }, - "feed_id": { - "type": "integer" - }, - "feed_owner_id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "urn": { - "type": "string", - "description": "The uniform resource name of the identifier group." - }, - "parent_group_id": { - "type": [ - "integer", - "null" - ], - "example": "nullable integer" - }, - "group_type": { - "type": [ - "string", - "null" - ], - "example": "nullable string", - "enum": [ - null, - "person", - "corporate_identities" - ] - } - }, - "type": "object" - }, - "UpdateGroupData": { - "properties": { - "name": { - "type": "string" - }, - "parent_group_id": { - "type": [ - "integer", - "null" - ], - "example": "nullable integer" - }, - "group_type": { - "type": [ - "string", - "null" - ], - "example": "nullable string", - "enum": [ - null, - "person", - "corporate_identities" - ] - } - }, - "type": "object" - }, - "Organization": { - "required": [ - "name" - ], - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string", - "description": "Display name" - }, - "type": { - "type": "string", - "example": "direct", - "enum": [ - "direct", - "service-firm", - "training" - ] - }, - "settings": { - "$ref": "#/definitions/OrganizationSettings" - }, - "file_analysis_enabled": { - "type": "boolean" - }, - "user_limit": { - "type": "integer" - }, - "access_level": { - "type": "integer" - }, - "urn": { - "type": "string", - "description": "The uniform resource name of the organization." - }, - "access_end_at": { - "type": "string", - "format": "date-time" - }, - "identifier_limit": { - "type": [ - "integer", - "null" - ], - "example": "nullable integer" - }, - "hubspot_company_id": { - "type": [ - "integer", - "null" - ], - "example": "nullable integer" - }, - "domain": { - "type": [ - "string", - "null" - ], - "example": "nullable string" - }, - "archived_at": { - "type": "string", - "format": "date-time" - }, - "authorization_workflow_enabled": { - "type": "boolean" - }, - "allow_support_access": { - "type": "boolean" - } - }, - "type": "object" - }, - "OrganizationSettings": { - "properties": { - "permissions": { - "type": "array", - "items": { - "type": "string" - } - }, - "through_distributor": { - "type": "boolean" - }, - "demo_tenant_limit": { - "type": [ - "integer", - "null" - ], - "example": "nullable integer" - }, - "demo_identifier_limit": { - "type": [ - "integer", - "null" - ], - "example": "nullable integer" - }, - "demo_search_limit": { - "type": [ - "integer", - "null" - ], - "example": "nullable integer" - }, - "demo_duration": { - "type": [ - "integer", - "null" - ], - "example": "nullable integer" - }, - "demo_show_passwords": { - "type": [ - "boolean", - "null" - ], - "example": "nullable bool" - }, - "hs_takedown_properties": { - "anyOf": [ - { - "$ref": "#/definitions/OrganizationHSProperties" - }, - { - "type": [ - "object", - "null" - ] - } - ] - }, - "hs_contact_email": { - "type": [ - "string", - "null" - ], - "example": "nullable string" - } - }, - "type": "object" - }, - "OrganizationHSProperties": { - "properties": { - "takedowns_in_subscription": { - "type": [ - "integer", - "null" - ], - "example": "nullable integer" - }, - "annual_takedowns_used": { - "type": [ - "integer", - "null" - ], - "example": "nullable integer" - } - }, - "type": "object" - }, - "NewTenantInfo": { - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "industry": { - "type": "string", - "example": "global", - "enum": [ - "global", - "transport", - "education", - "energy", - "finance", - "healthcare", - "manufacturing", - "retail", - "software", - "telecommunication" - ] - }, - "number_of_employees": { - "type": [ - "integer", - "null" - ], - "example": "nullable integer" - }, - "identifier_limit": { - "type": [ - "integer", - "null" - ], - "example": "nullable integer" - } - }, - "type": "object" - }, - "Tenant": { - "properties": { - "id": { - "type": "integer", - "description": "Tenant ID" - }, - "name": { - "type": "string", - "description": "Tenant name" - }, - "type": { - "type": "string", - "description": "Tenant type" - }, - "description": { - "type": "string", - "description": "This tenant's purpose" - }, - "organization_id": { - "type": "integer", - "description": "ID of the owner organization" - }, - "urn": { - "type": "string", - "description": "The uniform resource name of the tenant." - }, - "number_of_employees": { - "type": "integer", - "description": "The number of employees for the tenant." - }, - "industry": { - "type": "string", - "description": "The industry of the tenant." - }, - "is_disabled": { - "type": "boolean", - "description": "Indicates if the tenant is disabled" - }, - "is_archived": { - "type": "boolean", - "description": "Indicates if the tenant is archived" - }, - "feed_id": { - "type": "integer", - "description": "ID of the feed" - }, - "identifier_limit": { - "type": [ - "integer", - "null" - ], - "description": "The number of identifiers allowed for the tenant.", - "example": "nullable integer" - }, - "permissions": { - "type": "array", - "items": { - "type": "string" - } - }, - "prevent_global_search": { - "type": "boolean", - "description": "Indicates if the tenant can perform global searches" - }, - "access_end_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date when tenant access ends", - "example": "nullable date" - }, - "hubspot_tenant_id": { - "type": [ - "integer", - "null" - ], - "description": "The HubSpot tenant ID", - "example": "nullable integer" - } - }, - "type": "object" - }, - "TenantWithCounts": { - "properties": { - "next": { - "type": "string" - }, - "items": { - "$ref": "#/definitions/TenantWithCounts" - }, - "total_count": { - "type": [ - "integer", - "null" - ], - "example": "nullable integer" - } - }, - "type": "object" - }, - "UpdatedPermission": { - "properties": { - "updated_value": { - "type": "boolean" - } - }, - "type": "object" - }, - "AuditEvent": { - "required": [ - "data" - ], - "properties": { - "id": { - "type": "integer" - }, - "user_id": { - "type": "integer" - }, - "organization_id": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "data": { - "type": "object" - }, - "original_data": { - "type": "object" - }, - "affected_entities": { - "type": "object" - }, - "actor_data": { - "type": "object" - } - }, - "type": "object" - }, - "OrganizationMemberData": { - "required": [ - "email", - "name", - "organization_member_permissions", - "surname" - ], - "properties": { - "name": { - "type": "string" - }, - "surname": { - "type": "string" - }, - "email": { - "type": "string" - }, - "organization_member_permissions": { - "type": "object" - }, - "user_permissions": { - "type": "object" - }, - "memberships": { - "type": "array", - "items": { - "$ref": "#/definitions/UserTenantMembership" - } - }, - "send_welcome_email": { - "type": "boolean", - "default": true - }, - "auth_tenant_id": { - "type": [ - "integer", - "null" - ], - "example": "nullable integer" - } - }, - "type": "object" - }, - "UserTenantMembership": { - "required": [ - "tenant_id" - ], - "properties": { - "tenant_id": { - "type": "integer" - }, - "is_readonly": { - "type": "boolean" - }, - "role": { - "type": "string", - "example": "viewer", - "enum": [ - "viewer", - "editor", - "admin" - ] - } - }, - "type": "object" - }, - "OrganizationMemberWithMetadata": { - "properties": { - "user": { - "$ref": "#/definitions/OrganizationMember" - }, - "tenant_count": { - "type": "integer" - }, - "is_mfa_enabled": { - "type": [ - "boolean", - "null" - ], - "example": "nullable bool" - } - }, - "type": "object" - }, - "OrganizationMember": { - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "surname": { - "type": "string" - }, - "email": { - "type": "string" - }, - "organization_member_permissions": { - "$ref": "#/definitions/OrganizationMemberPermission" - }, - "is_disabled": { - "type": "boolean" - }, - "registered_at": { - "type": "string", - "format": "date-time" - }, - "urn": { - "type": "string", - "description": "The uniform resource name of the member." - }, - "auth_tenant_id": { - "type": [ - "integer", - "null" - ], - "example": "nullable integer" - } - }, - "type": "object" - }, - "OrganizationMemberPermission": { - "properties": { - "*": { - "type": "object", - "additionalProperties": { - "type": "boolean" - } - } - }, - "type": "object" - }, - "OrganizationMemberPage": { - "properties": { - "members": { - "type": "array", - "items": { - "$ref": "#/definitions/OrganizationMemberWithMetadata" - } - }, - "next": { - "type": [ - "string", - "null" - ], - "example": "nullable string" - } - }, - "type": "object" - }, - "OrganizationMembersCount": { - "properties": { - "count": { - "type": "integer" - } - }, - "type": "object" - }, - "EnableState": { - "properties": { - "is_disabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "PermissionData": { - "required": [ - "permission", - "value" - ], - "properties": { - "permission": { - "type": "string" - }, - "value": { - "type": "boolean" - } - }, - "type": "object" - }, - "OrganizationMonthlyUsage": { - "properties": { - "timestamp": { - "type": "string" - }, - "identifier_count": { - "type": "integer" - }, - "idp_synced_identifier_count": { - "type": "integer" - }, - "global_search_calls_count": { - "type": "integer" - } - }, - "type": "object" - }, - "HighlightPayload": { - "properties": { - "query_string": { - "type": "string" - }, - "identifier_ids": { - "type": "array", - "items": { - "type": "integer" - } - } - }, - "type": "object" - }, - "ActivityUserNotes": { - "required": [ - "notes" - ], - "properties": { - "notes": { - "type": "string" - } - }, - "type": "object" - }, - "ActivityUserMetadata": { - "properties": { - "uid": { - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "risk_score": { - "type": [ - "integer", - "null" - ], - "example": "nullable integer" - }, - "notes": { - "type": [ - "string", - "null" - ], - "example": "nullable string" - }, - "risk_score_updated_at": { - "type": "string", - "format": "date-time" - }, - "remediated_at": { - "type": "string", - "format": "date-time" - }, - "ignored_at": { - "type": "string", - "format": "date-time" - }, - "remediated_asset_uuid": { - "type": "string" - } - }, - "type": "object" - }, - "ActivityUserRiskScore": { - "required": [ - "risk_score" - ], - "properties": { - "risk_score": { - "type": "integer" - } - }, - "type": "object" - }, - "ActivityUserMetadataRemediated": { - "required": [ - "is_remediated" - ], - "properties": { - "is_remediated": { - "type": "boolean" - }, - "identifier_id": { - "type": "integer" - } - }, - "type": "object" - }, - "ActivityUserMetadataIgnored": { - "required": [ - "is_ignored" - ], - "properties": { - "is_ignored": { - "type": "boolean" - }, - "identifier_id": { - "type": "integer" - } - }, - "type": "object" - }, - "ActivityAiAssistance": { - "properties": { - "uid": { - "type": "string" - }, - "prompt": { - "type": "string" - }, - "response": { - "type": "string" - } - }, - "type": "object" - }, - "ActivityUserTags": { - "required": [ - "tags" - ], - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "type": "object" - }, - "UserUpdate": { - "required": [ - "color_scheme", - "name", - "settings", - "surname" - ], - "properties": { - "name": { - "type": "string" - }, - "surname": { - "type": "string" - }, - "settings": { - "type": "object" - }, - "language": { - "type": "string" - }, - "color_scheme": { - "type": "string", - "example": "auto", - "enum": [ - "auto", - "light", - "dark" - ] - } - }, - "type": "object" - }, - "UserProfile": { - "allOf": [ - { - "$ref": "#/definitions/User" - }, - { - "properties": { - "settings": { - "$ref": "#/definitions/UserSettings" - }, - "feature_flags": { - "type": "object" - }, - "tenants": { - "type": "array", - "items": { - "$ref": "#/definitions/Tenant" - } - }, - "default_tenant_id": { - "type": [ - "integer", - "null" - ], - "example": "nullable integer" - }, - "is_sso_mandatory": { - "type": "boolean" - }, - "has_password": { - "type": "boolean" - }, - "urn": { - "type": "string" - }, - "needs_eusa": { - "type": "boolean" - }, - "domain": { - "type": "string" - }, - "language": { - "type": "string" - }, - "trial_source": { - "type": [ - "string", - "null" - ], - "example": "nullable string" - }, - "should_provide_signup_intent": { - "type": "boolean" - } - }, - "type": "object" - } - ] - }, - "User": { - "required": [ - "color_scheme", - "email", - "language", - "name" - ], - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string", - "description": "Users's name" - }, - "surname": { - "type": "string", - "description": "User's surname" - }, - "email": { - "type": "string", - "description": "User's email" - }, - "organization_id": { - "type": "integer", - "description": "ID of the owner organization" - }, - "settings": { - "$ref": "#/definitions/UserSettings" - }, - "is_disabled": { - "type": "boolean" - }, - "feature_flags": { - "type": "object" - }, - "registered_at": { - "type": "string", - "format": "date-time" - }, - "urn": { - "type": "string", - "description": "The uniform resource name of the user." - }, - "organization_member_permissions": { - "type": "object" - }, - "language": { - "type": "string", - "description": "User's language" - }, - "color_scheme": { - "type": "string", - "example": "auto", - "enum": [ - "auto", - "light", - "dark" - ] - }, - "flare_role": { - "type": "string" - } - }, - "type": "object" - }, - "UserSettings": { - "properties": { - "default_search": { - "type": "string" - }, - "permissions": { - "type": "array", - "items": { - "type": "string" - } - }, - "organization_member_permissions": { - "type": "array", - "items": { - "type": "string" - } - }, - "should_show_guided_tenant_wizard": { - "type": [ - "boolean", - "null" - ], - "example": "nullable bool" - }, - "hide_impersonation_warning": { - "type": [ - "boolean", - "null" - ], - "example": "nullable bool" - } - }, - "type": "object" - }, - "PaginatedCredentials": { - "properties": { - "next": { - "type": "string" - }, - "items": { - "$ref": "#/definitions/LeakActivityCredential" - }, - "total_count": { - "type": [ - "integer", - "null" - ], - "example": "nullable integer" - } - }, - "type": "object" - }, - "LeakActivityCredential": { - "required": [ - "id", - "identity_name", - "imported_at", - "source_id" - ], - "properties": { - "id": { - "type": "integer" - }, - "source_id": { - "type": "string" - }, - "imported_at": { - "type": "string" - }, - "identity_name": { - "type": "string" - }, - "hash": { - "type": "string" - }, - "domain": { - "type": "string" - }, - "source": { - "$ref": "#/definitions/source" - }, - "remediated_at": { - "type": "string", - "format": "date-time" - }, - "ignored_at": { - "type": "string", - "format": "date-time" - }, - "known_password_id": { - "type": "integer" - }, - "credential_hash": { - "type": "string" - } - }, - "type": "object" - }, - "source": { - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description_en": { - "type": "string" - }, - "description_fr": { - "type": "string" - }, - "breached_at": { - "type": "string" - }, - "leaked_at": { - "type": "string" - }, - "pii_tags": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "type": "object" - }, - "GroupedFeedAlerts": { - "required": [ - "alerts", - "key", - "organization_settings", - "params", - "type" - ], - "properties": { - "key": { - "type": "string" - }, - "type": { - "type": "string" - }, - "params": { - "type": "object" - }, - "alerts": { - "$ref": "#/definitions/FeedAlert" - }, - "organization_settings": { - "$ref": "#/definitions/OrganizationSettings" - } - }, - "type": "object" - }, - "AlertUpdate": { - "properties": { - "id": { - "type": "integer" - }, - "processed_at": { - "type": "string", - "format": "date" - }, - "last_result_date": { - "type": "string", - "format": "date" - } - }, - "type": "object" - }, - "PageView": { - "required": [ - "route" - ], - "properties": { - "route": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - } - }, - "type": "object" - }, - "TenantIgnoredTerms": { - "required": [ - "clean_past_events", - "created_at", - "name", - "search_types", - "uuid" - ], - "properties": { - "uuid": { - "type": "string" - }, - "name": { - "type": "string" - }, - "terms": { - "type": "array", - "items": { - "type": "string" - } - }, - "search_types": { - "type": "array", - "items": { - "type": "string", - "example": "attachment", - "enum": [ - "attachment", - "listing", - "ransomleak", - "forum_post", - "forum_topic", - "forum_profile", - "blog_post", - "seller", - "paste", - "leak", - "chat_message", - "domain", - "bot", - "stealer_log", - "infected_devices", - "driller", - "driller_forum_topic", - "driller_forum_post", - "driller_profile", - "cc", - "ccbin", - "financial_data", - "leaked_data", - "leaked_file", - "document", - "account", - "actor", - "forum_content", - "blog_content", - "profile", - "leaked_credential", - "valid_credential", - "invalid_credential", - "mitigated_credential", - "illicit_networks", - "open_web", - "domains", - "intelligence_object", - "leaks", - "social_media_account", - "social_media", - "source_code", - "source_code_secrets_np", - "source_code_secrets", - "source_code_files", - "docker", - "stack_exchange", - "google", - "service", - "driller_host", - "buckets", - "bucket", - "bucket_object", - "whois", - "ad", - "ads", - "cookie", - "pii", - "experimental" - ] - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "clean_past_events": { - "type": "boolean" - } - }, - "type": "object" - }, - "TenantData": { - "required": [ - "description", - "industry", - "name", - "number_of_employees" - ], - "properties": { - "name": { - "type": "string", - "description": "The Tenant display name" - }, - "description": { - "type": "string", - "description": "The Tenant's purpose / description" - }, - "number_of_employees": { - "type": "integer", - "description": "The number of employees for the tenant" - }, - "industry": { - "type": "string", - "description": "The Tenant's industry", - "example": "global", - "enum": [ - "global", - "transport", - "education", - "energy", - "finance", - "healthcare", - "manufacturing", - "retail", - "software", - "telecommunication" - ] - }, - "global_search_calls_limit": { - "type": "integer", - "description": "The number of API calls allowed for the tenant." - }, - "prevent_global_search": { - "type": "boolean" - } - }, - "type": "object" - }, - "UserTenantAccessRequest": { - "properties": { - "users": { - "type": "array", - "items": { - "description": "User given access to a tenant.", - "allOf": [ - { - "$ref": "#/definitions/UserTenantAccess" - } - ] - } - } - }, - "type": "object" - }, - "UserTenantAccess": { - "required": [ - "user_id" - ], - "properties": { - "user_id": { - "type": "integer", - "description": "The ID of the user to add to the tenant" - }, - "is_readonly": { - "type": "boolean", - "description": "Access given to the user for the tenant" - }, - "role": { - "type": "string", - "description": "Role given to the user for the tenant", - "example": "viewer", - "enum": [ - "viewer", - "editor", - "admin" - ] - } - }, - "type": "object" - }, - "TenantUsers": { - "properties": { - "next": { - "type": "integer" - }, - "items": { - "$ref": "#/definitions/TenantUser" - }, - "total_count": { - "type": [ - "integer", - "null" - ], - "example": "nullable integer" - } - }, - "type": "object" - }, - "TenantUser": { - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "surname": { - "type": "string" - }, - "email": { - "type": "string" - }, - "is_readonly": { - "type": "boolean" - }, - "role": { - "type": "string", - "example": "viewer", - "enum": [ - "viewer", - "editor", - "admin" - ] - }, - "is_disabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "TenantDiscoveryPolicy": { - "properties": { - "id": { - "type": "integer" - }, - "tenant_id": { - "type": "integer" - }, - "type": { - "type": "string", - "example": "auto-accept", - "enum": [ - "auto-accept", - "ignore-pattern" - ] - }, - "identifier_types": { - "type": "array", - "items": { - "type": "string", - "example": "domain", - "enum": [ - "domain", - "name", - "keyword", - "github_repository", - "username", - "email", - "search_query", - "bin", - "ip", - "secret", - "azure_tenant", - "identity", - "ransomleak", - "external_id", - "address_data", - "birth_year", - "role", - "phone_number" - ] - } - }, - "terms": { - "type": "array", - "items": { - "type": "string" - } - }, - "enabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "NewReport": { - "required": [ - "author", - "title" - ], - "properties": { - "title": { - "type": "string" - }, - "author": { - "type": "string" - }, - "elements": { - "type": "array", - "items": { - "$ref": "#/definitions/ReportElementUpdate" - } - }, - "audience": { - "type": "string", - "example": "technical", - "enum": [ - "technical", - "general" - ] - } - }, - "type": "object" - }, - "ReportElementUpdate": { - "properties": { - "id": { - "type": "integer" - }, - "position": { - "type": "integer" - }, - "enabled": { - "type": "boolean" - }, - "sort_by": { - "type": "string", - "example": "custom", - "enum": [ - "custom", - "alphabetical", - "date" - ] - }, - "time_interval": { - "type": "string" - } - }, - "type": "object" - }, - "UpdatedReport": { - "properties": { - "title": { - "type": "string" - }, - "author": { - "type": "string" - }, - "elements": { - "type": "array", - "items": { - "$ref": "#/definitions/ReportElementUpdate" - } - }, - "audience": { - "type": "string", - "example": "technical", - "enum": [ - "technical", - "general" - ] - } - }, - "type": "object" - }, - "PriorityActionHeader": { - "required": [ - "created_at", - "snooze_until", - "status", - "status_last_updated_at", - "tags", - "title", - "type", - "uuid" - ], - "properties": { - "uuid": { - "type": "string" - }, - "type": { - "type": "string" - }, - "status": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "status_last_updated_at": { - "type": "string", - "format": "date-time" - }, - "snooze_until": { - "type": "string", - "format": "date-time" - }, - "title": { - "$ref": "#/definitions/InsightText" - }, - "summary": { - "$ref": "#/definitions/InsightText" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "type": "object" - }, - "InsightText": { - "required": [ - "text" - ], - "properties": { - "text": { - "type": "string", - "description": "Text for the insight" - }, - "params": { - "type": "object", - "description": "Relevant data related to the text" - } - }, - "type": "object" - }, - "Details": { - "required": [ - "title" - ], - "properties": { - "title": { - "$ref": "#/definitions/InsightText" - }, - "summary": { - "$ref": "#/definitions/InsightText" - } - }, - "type": "object" - }, - "Mitre": { - "required": [ - "mitigation", - "techniques" - ], - "properties": { - "techniques": { - "$ref": "#/definitions/MitreLink" - }, - "mitigation": { - "$ref": "#/definitions/MitreLink" - } - }, - "type": "object" - }, - "MitreLink": { - "required": [ - "id", - "text", - "url" - ], - "properties": { - "id": { - "type": "string", - "description": "Mitre's id" - }, - "text": { - "type": "string", - "description": "Mitre's text" - }, - "url": { - "type": "string", - "description": "Link to the Mitre url page" - } - }, - "type": "object" - }, - "PriorityActionRelatedActivity": { - "required": [ - "remediated", - "tenant_id", - "uid", - "uuid" - ], - "properties": { - "uuid": { - "type": "string" - }, - "tenant_id": { - "type": "integer" - }, - "uid": { - "type": "string" - }, - "remediated": { - "type": "boolean" - } - }, - "type": "object" - }, - "ExportPriorityActionVisualizationData": { - "required": [ - "format", - "stream" - ], - "properties": { - "stream": { - "type": "string" - }, - "format": { - "type": "string", - "example": "csv", - "enum": [ - "csv" - ] - } - }, - "type": "object" - }, - "Insight": { - "required": [ - "analysis", - "date", - "paragraph", - "title", - "type" - ], - "properties": { - "type": { - "type": "string" - }, - "date": { - "type": "string", - "format": "date-time" - }, - "title": { - "$ref": "#/definitions/InsightText" - }, - "paragraph": { - "$ref": "#/definitions/InsightText" - }, - "analysis": { - "$ref": "#/definitions/InsightText" - }, - "visualization": { - "type": "array", - "items": { - "$ref": "#/definitions/FootprintVisualizationChart" - } - } - }, - "type": "object" - }, - "FootprintVisualizationChart": { - "required": [ - "data", - "id", - "type" - ], - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": "string", - "example": "comparison_chart", - "enum": [ - "comparison_chart", - "tabular_chart", - "radial_chart", - "line_chart", - "bar_chart", - "radar_chart" - ] - }, - "data": { - "type": "object" - }, - "title": { - "type": "string" - } - }, - "type": "object" - }, - "RansomLeakData": { - "required": [ - "breached_at", - "event_created_at", - "identifiers", - "publisher", - "risk_score", - "uid", - "victim" - ], - "properties": { - "uid": { - "type": "string", - "description": "event uid of the ransomleak" - }, - "breached_at": { - "type": "string", - "format": "date-time", - "description": "Date of the ransomleak" - }, - "event_created_at": { - "type": "string", - "format": "date-time", - "description": "Date of the ransomleak event in the feed" - }, - "risk_score": { - "type": "integer", - "description": "Computed risk of the ransomleak" - }, - "publisher": { - "type": "string", - "description": "Publisher of the ransomleak" - }, - "victim": { - "type": "string", - "description": "Victim of the ransomleak" - }, - "domain": { - "type": "string", - "description": "Domain of the victim" - }, - "country": { - "type": "string", - "description": "Country of the victim" - }, - "industry": { - "type": "string", - "description": "Industry of the victim" - }, - "employee_count": { - "type": "integer", - "description": "Number of employee of the victim" - }, - "user_metadata": { - "$ref": "#/definitions/ActivityUserMetadata" - }, - "identifiers": { - "type": "array", - "items": { - "$ref": "#/definitions/RansomLeakIdentifierData" - } - } - }, - "type": "object" - }, - "RansomLeakIdentifierData": { - "properties": { - "id": { - "type": "integer" - }, - "identifier_type": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "type": "object" - }, - "date_count": { - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "count": { - "type": "integer" - } - }, - "type": "object" - }, - "Import": { - "required": [ - "id", - "integration", - "tenant_id", - "type" - ], - "properties": { - "id": { - "type": "integer" - }, - "type": { - "type": "string", - "example": "identifiers", - "enum": [ - "identifiers" - ] - }, - "integration": { - "type": "string", - "example": "csv", - "enum": [ - "csv" - ] - }, - "tenant_id": { - "type": "integer" - }, - "committed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "example": "nullable date" - } - }, - "type": "object" - }, - "ImportItemFailures": { - "required": [ - "message", - "type" - ], - "properties": { - "type": { - "type": "string", - "example": "unknown_identifier_type", - "enum": [ - "unknown_identifier_type", - "bad_identifier_query", - "above_max_group_nesting", - "unknown_identifier_source", - "identifier_not_allowed", - "identifier_type_not_allowed", - "too_many_attributes", - "invalid_attribute_format", - "missing_attributes" - ] - }, - "message": { - "type": "string" - } - }, - "type": "object" - }, - "Subdomains": { - "required": [ - "subdomain" - ], - "properties": { - "subdomain": { - "type": "string" - } - }, - "type": "object" - }, - "CredentialUrl": { - "properties": { - "url": { - "type": "string" - }, - "credential_hash": { - "type": "string" - }, - "domain": { - "type": "string" - }, - "is_stealer_log": { - "type": "boolean" - } - }, - "type": "object" - }, - "PartialSource": { - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "type": "object" - }, - "count_by_search_type": { - "properties": { - "search_type": { - "type": "string" - }, - "values": { - "type": "array", - "items": { - "$ref": "#/definitions/date_count" - } - } - }, - "type": "object" - }, - "count_by_risk_score": { - "properties": { - "risk_score": { - "type": "integer" - }, - "values": { - "type": "array", - "items": { - "$ref": "#/definitions/date_count" - } - } - }, - "type": "object" - }, - "average_by_search_type": { - "properties": { - "search_type": { - "type": "string" - }, - "values": { - "type": "array", - "items": { - "$ref": "#/definitions/date_count" - } - } - }, - "type": "object" - }, - "average_by_risk_score": { - "properties": { - "risk_score": { - "type": "integer" - }, - "values": { - "type": "array", - "items": { - "$ref": "#/definitions/date_count" - } - } - }, - "type": "object" - }, - "IdentifierRelationData": { - "required": [ - "asset_relation_uuid", - "identifier_id" - ], - "properties": { - "identifier_id": { - "type": "integer" - }, - "asset_relation_uuid": { - "type": "string" - } - }, - "type": "object" - }, - "ArchiveFile": { - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "source": { - "type": "string" - }, - "type": { - "type": "string" - }, - "password": { - "type": "string" - }, - "status": { - "type": "string" - }, - "data": { - "$ref": "#/definitions/ArchiveFileData" - }, - "ransomleak_uid": { - "type": "string" - }, - "metadata": { - "$ref": "#/definitions/ArchiveFileMetadata" - }, - "status_updated_at": { - "type": "string", - "format": "date-time" - }, - "errors": { - "$ref": "#/definitions/ArchiveFileErrors" - }, - "retry_count": { - "type": "integer" - }, - "retry_after": { - "type": "string", - "format": "date-time" - } - }, - "type": "object" - }, - "ArchiveFileData": { - "properties": { - "parts": { - "type": "array", - "items": { - "$ref": "#/definitions/MultiPartData" - } - } - }, - "type": "object" - }, - "MultiPartData": { - "properties": { - "url": { - "type": "string" - }, - "size": { - "type": "integer" - } - }, - "type": "object" - }, - "ArchiveFileMetadata": { - "properties": { - "first_crawled_at": { - "type": "string", - "format": "date-time" - }, - "last_crawled_at": { - "type": "string", - "format": "date-time" - }, - "estimated_created_at": { - "type": "string", - "format": "date-time" - }, - "scraper_id": { - "type": "string" - }, - "scraped_at": { - "type": "string", - "format": "date-time" - }, - "event_id": { - "type": "integer" - }, - "event_id_v2": { - "type": "string" - } - }, - "type": "object" - }, - "ArchiveFileErrors": { - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ArchiveFileErrorData" - } - } - }, - "type": "object" - }, - "ArchiveFileErrorData": { - "properties": { - "type": { - "type": "string" - }, - "traceback": { - "type": "string" - } - }, - "type": "object" - } - }, - "responses": { - "ParseError": { - "description": "When a mask can't be parsed" - }, - "MaskError": { - "description": "When any error occurs on mask" - }, - "HTTPException": { - "description": "" - } - }, - "host": "api.flare.io", - "schemes": [ - "https" - ] -} diff --git a/docs/api-reference/spec/firework-v3-openapi.json b/docs/api-reference/spec/firework-v3-openapi.json index f97a2c10..6cfe04e3 100644 --- a/docs/api-reference/spec/firework-v3-openapi.json +++ b/docs/api-reference/spec/firework-v3-openapi.json @@ -569,7 +569,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, forum_profile, financial_data, blog_post, forum_topic, forum_post, stealer_log, seller, listing, bot, ransomleak\n- open_web: social_media_account, google, bucket, source_code_secrets, docker, service, stack_exchange, bucket_object, source_code_files, paste\n- leaks: invalid_credential, leak, valid_credential, mitigated_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -620,6 +620,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -893,7 +894,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, forum_profile, financial_data, blog_post, forum_topic, forum_post, stealer_log, seller, listing, bot, ransomleak\n- open_web: social_media_account, google, bucket, source_code_secrets, docker, service, stack_exchange, bucket_object, source_code_files, paste\n- leaks: invalid_credential, leak, valid_credential, mitigated_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -944,6 +945,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -2348,6 +2350,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", diff --git a/docs/api-reference/spec/firework-v3-swagger.json b/docs/api-reference/spec/firework-v3-swagger.json index 87d68bcf..febf2331 100644 --- a/docs/api-reference/spec/firework-v3-swagger.json +++ b/docs/api-reference/spec/firework-v3-swagger.json @@ -409,7 +409,7 @@ "type": "string" } ], - "post": { + "get": { "responses": { "403": { "description": "Forbidden.", @@ -430,7 +430,7 @@ } } }, - "operationId": "post_asset_feeds_api_/assets//feed", + "operationId": "get_asset_feeds_api_/assets//feed", "parameters": [ { "name": "fields", @@ -487,7 +487,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, forum_profile, financial_data, blog_post, forum_topic, forum_post, stealer_log, seller, listing, bot, ransomleak\n- open_web: social_media_account, google, bucket, source_code_secrets, docker, service, stack_exchange, bucket_object, source_code_files, paste\n- leaks: invalid_credential, leak, valid_credential, mitigated_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -538,6 +538,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -669,7 +670,7 @@ "assets" ] }, - "get": { + "post": { "responses": { "403": { "description": "Forbidden.", @@ -690,7 +691,7 @@ } } }, - "operationId": "get_asset_feeds_api_/assets//feed", + "operationId": "post_asset_feeds_api_/assets//feed", "parameters": [ { "name": "fields", @@ -747,7 +748,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, ransomleak, stealer_log, chat_message, forum_profile, blog_post, listing, bot, seller, forum_post, forum_topic\n- open_web: service, stack_exchange, google, source_code_secrets, social_media_account, source_code_files, paste, docker, bucket_object, bucket\n- leaks: mitigated_credential, valid_credential, leak, invalid_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, forum_profile, financial_data, blog_post, forum_topic, forum_post, stealer_log, seller, listing, bot, ransomleak\n- open_web: social_media_account, google, bucket, source_code_secrets, docker, service, stack_exchange, bucket_object, source_code_files, paste\n- leaks: invalid_credential, leak, valid_credential, mitigated_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -798,6 +799,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -1432,20 +1434,6 @@ "type": "integer" } ], - "post": { - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PaginatedCredentials" - } - } - }, - "operationId": "post_leaked_credentials_feed_endpoint_/identifiers//feed/credentials", - "tags": [ - "identifiers" - ] - }, "get": { "responses": { "200": { @@ -1472,6 +1460,20 @@ "tags": [ "identifiers" ] + }, + "post": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PaginatedCredentials" + } + } + }, + "operationId": "post_leaked_credentials_feed_endpoint_/identifiers//feed/credentials", + "tags": [ + "identifiers" + ] } }, "/firework/v3/identifiers/{identifier_id}/relations": { @@ -2050,6 +2052,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", diff --git a/docs/api-reference/spec/firework-v4-openapi.json b/docs/api-reference/spec/firework-v4-openapi.json index 3d1d0995..64341e11 100644 --- a/docs/api-reference/spec/firework-v4-openapi.json +++ b/docs/api-reference/spec/firework-v4-openapi.json @@ -3151,6 +3151,7 @@ "seller", "service", "social_media_account", + "source_code_observation", "source_code_secret", "stealer_log", "attachment/telegram", @@ -6816,6 +6817,20 @@ ], "title": "Intent Ids" }, + "observable_types": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/StixCyberObservableType" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Observable Types" + }, "confidence": { "$ref": "#/components/schemas/IntRangeFilter" }, @@ -9212,7 +9227,7 @@ "matched": { "type": "boolean", "title": "Matched", - "description": "Whether the identifier's own search query matched the event" + "description": "Whether the identifier's own search query matched the event. See 'matched_uid' for the document the terms were found in" }, "applicable": { "type": "boolean", @@ -9236,7 +9251,19 @@ }, "type": "object", "title": "Highlights", - "description": "Excerpts of the event fields the identifier's terms matched, with each match wrapped in tags" + "description": "Excerpts of the fields the identifier's terms matched, with each match wrapped in tags. The keys are field names on the document identified by 'matched_uid'" + }, + "matched_uid": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Matched Uid", + "description": "The uid of the document the identifier's terms were found in. Usually the event's own uid; for events that merge attached files into their content it can be the uid of one of those files. Null when 'matched' is false" } }, "type": "object", @@ -9889,6 +9916,17 @@ ], "title": "Pattern Version" }, + "pattern_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Pattern Type" + }, "indicator_types": { "items": { "type": "string" @@ -9896,6 +9934,13 @@ "type": "array", "title": "Indicator Types" }, + "observable_types": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Observable Types" + }, "valid_from": { "anyOf": [ { @@ -9941,7 +9986,9 @@ "pattern", "description", "pattern_version", + "pattern_type", "indicator_types", + "observable_types", "valid_from", "valid_until", "kill_chain_phases", @@ -10316,6 +10363,17 @@ ], "title": "Web Search Queries", "description": "The queries used for web search" + }, + "time_range_type": { + "anyOf": [ + { + "$ref": "#/components/schemas/TimeRangeType" + }, + { + "type": "null" + } + ], + "description": "The time range inferred from the question" } }, "type": "object", @@ -13682,6 +13740,7 @@ "source_code_secrets_np", "source_code_secrets", "source_code_files", + "secret", "docker", "stack_exchange", "google", @@ -13952,7 +14011,7 @@ "properties": { "event_severity": { "$ref": "#/components/schemas/RiskScore", - "description": "The severity computed for the event" + "description": "The severity computed for the event from the currently active scoring rules" }, "allowed_severities": { "items": { @@ -14257,6 +14316,30 @@ "type": "object", "title": "StealerLogEventData" }, + "StixCyberObservableType": { + "type": "string", + "enum": [ + "artifact", + "autonomous-system", + "directory", + "domain-name", + "email-addr", + "email-message", + "file", + "ipv4-addr", + "ipv6-addr", + "mac-addr", + "mutex", + "network-traffic", + "process", + "software", + "url", + "user-account", + "windows-registry-key", + "x509-certificate" + ], + "title": "StixCyberObservableType" + }, "SubdomainStatus": { "properties": { "status": { diff --git a/openapitools.json b/openapitools.json new file mode 100644 index 00000000..8dd0d745 --- /dev/null +++ b/openapitools.json @@ -0,0 +1,7 @@ +{ + "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json", + "spaces": 2, + "generator-cli": { + "version": "7.25.0" + } +} From 6b4d6ff7a38d7a0a29048952122b69bdace4cac1 Mon Sep 17 00:00:00 2001 From: Simon Roy Date: Wed, 16 Sep 2026 16:07:34 -0400 Subject: [PATCH 2/6] add explain identifier event to sidebar --- docs/docs.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/docs.json b/docs/docs.json index 1dfe9c26..ac111960 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -83,7 +83,8 @@ "api-reference/v2/endpoints/activities/get-fireworkv2activities--ai_assistance", "api-reference/v4/endpoints/event-actions", "api-reference/v4/endpoints/credential-actions", - "api-reference/v4/endpoints/public/update-tenant-metadata" + "api-reference/v4/endpoints/public/update-tenant-metadata", + "api-reference/v4/endpoints/explain-identifier-event" ] }, { From fa7399142d0d1b43b0975eefc4eda3ce6f581ce5 Mon Sep 17 00:00:00 2001 From: Simon Roy Date: Wed, 16 Sep 2026 16:08:28 -0400 Subject: [PATCH 3/6] add node_modules/ to gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index db3b6b1b..dd3428bc 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ /.venv __pycache__/ +node_modules/ \ No newline at end of file From d115078daa7849944f4999c0e0370e72fc8ca52a Mon Sep 17 00:00:00 2001 From: Simon Roy Date: Wed, 16 Sep 2026 16:13:01 -0400 Subject: [PATCH 4/6] add explain identifier event to changelog --- docs/changelog/overview.mdx | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/changelog/overview.mdx b/docs/changelog/overview.mdx index 750002e6..3fde5aae 100644 --- a/docs/changelog/overview.mdx +++ b/docs/changelog/overview.mdx @@ -12,6 +12,11 @@ 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 a new [Explain Identifier Event URL Endpoint ](/api-reference/v4/endpoints/explain-identifier-event) to provide evidence as to how an event matches to an identifier. + + + Added a new [Create Presigned Upload URL Endpoint ](/api-reference/v4/endpoints/create-presigned-upload-url) to upload files for later submission to Sandbox for analysis. From c03fa45f11be1a08062f4b55a6dd48af0756ac04 Mon Sep 17 00:00:00 2001 From: Simon Roy Date: Wed, 16 Sep 2026 16:24:44 -0400 Subject: [PATCH 5/6] remove openapitools.json --- openapitools.json | 7 ------- 1 file changed, 7 deletions(-) delete mode 100644 openapitools.json diff --git a/openapitools.json b/openapitools.json deleted file mode 100644 index 8dd0d745..00000000 --- a/openapitools.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json", - "spaces": 2, - "generator-cli": { - "version": "7.25.0" - } -} From 47b393f8b45491c9adeeb9c7f0ddba9bc5910036 Mon Sep 17 00:00:00 2001 From: Simon Roy Date: Wed, 16 Sep 2026 16:27:15 -0400 Subject: [PATCH 6/6] make generate (again) --- .../spec/firework-v2-openapi.json | 6951 ++++++++++++++++ .../spec/firework-v2-swagger.json | 6975 +++++++++++++++++ .../spec/firework-v3-openapi.json | 4 +- .../spec/firework-v3-swagger.json | 4 +- 4 files changed, 13930 insertions(+), 4 deletions(-) create mode 100644 docs/api-reference/spec/firework-v2-openapi.json diff --git a/docs/api-reference/spec/firework-v2-openapi.json b/docs/api-reference/spec/firework-v2-openapi.json new file mode 100644 index 00000000..4e99883b --- /dev/null +++ b/docs/api-reference/spec/firework-v2-openapi.json @@ -0,0 +1,6951 @@ +{ + "openapi": "3.0.1", + "info": { + "description": "\nManage and access Firework resources.\n\n### Steps to use the Api\n\n1. `Send` a POST request to `https://api.flare.systems/tokens/generate` with your **Firework** credentials using [Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication) to get a authentication token.\n---\n2. On the current page, click on the **Authorize** button and insert the token using the following format: `Bearer {token}`\n\n Example value: `Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e30.Et9HFtf9R3GEMA0IICOfFMVXY7kkTX1wr4qCyhIf58U`\n---\n3. You should now be able to use SwaggerUI's built-in tools to query the documented endpoints.\n", + "title": "Firework API", + "version": "v2" + }, + "servers": [ + { + "url": "https://api.flare.io/" + } + ], + "security": [ + { + "BearerAuth": [] + } + ], + "tags": [ + { + "description": "Searches the threat activity database.", + "name": "search" + }, + { + "description": "Manage a user's or organization's identifiers", + "name": "Identifiers" + }, + { + "description": "Perform actions on activities.", + "name": "activities" + }, + { + "description": "Perform actions on the current user.", + "name": "me" + }, + { + "description": "Manage tenants.", + "name": "tenants" + }, + { + "description": "Admin management of organizations.", + "name": "organizations" + }, + { + "description": "Manage reporting as an admin.", + "name": "reporting" + } + ], + "paths": { + "/firework/v2/activities/": { + "get": { + "operationId": "get_activity_endpoint_/activities/", + "parameters": [ + { + "in": "query", + "name": "uid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "Returns the activity" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Activity not found" + } + }, + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/actor/profile/{actor_name}": { + "get": { + "operationId": "get_actor_/activities/actor/profile/", + "parameters": [ + { + "in": "path", + "name": "actor_name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": " Limit results to those found in this time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z", + "in": "query", + "name": "actor_time", + "schema": { + "type": "string" + } + }, + { + "description": "Maximum number of hits returned per query.", + "in": "query", + "name": "actor_size", + "schema": { + "default": 100, + "type": "integer" + } + }, + { + "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, use the latest response's `search_after` attribute for the next request to get the next page of results.", + "in": "query", + "name": "actor_search_after", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "Returns the actor" + } + }, + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/document/{source}/{id}/extensions": { + "get": { + "operationId": "get_ransom_leak_file_extensions_endpoint_/activities/document///extensions", + "parameters": [ + { + "in": "path", + "name": "source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "Returns all the different file extensions that were found in the files of a ransom leak." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Activity not found" + } + }, + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/document/{source}/{id}/files": { + "get": { + "operationId": "get_ransom_leak_files_endpoint_/activities/document///files", + "parameters": [ + { + "in": "path", + "name": "source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "Returns the files in a ransom leak matching the specified query" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Activity not found" + } + }, + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/leak/{source}/{keyword}": { + "get": { + "operationId": "get_leak_endpoint_/activities/leak//", + "parameters": [ + { + "in": "path", + "name": "source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "keyword", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "Returns the leak activity" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Leak activity not found" + } + }, + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/leak/{source}/{keyword}/count": { + "get": { + "operationId": "get_leak_count_/activities/leak///count", + "parameters": [ + { + "in": "path", + "name": "source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "keyword", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "Success" + } + }, + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id_}/user_metadata": { + "get": { + "operationId": "get_activity_user_metadata_resource_/activities////user_metadata", + "parameters": [ + { + "in": "path", + "name": "index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "id_", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActivityUserMetadata" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id_}/user_metadata/ignored": { + "put": { + "operationId": "put_activity_user_metadata_ignored_/activities////user_metadata/ignored", + "parameters": [ + { + "in": "path", + "name": "index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "id_", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActivityUserMetadataIgnored" + } + } + }, + "required": true + }, + "responses": { + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Query is invalid." + }, + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActivityUserMetadata" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "activities" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/activities/{index}/{source}/{id_}/user_metadata/notes": { + "put": { + "operationId": "put_activity_user_metadata_notes_/activities////user_metadata/notes", + "parameters": [ + { + "in": "path", + "name": "index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "id_", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActivityUserNotes" + } + } + }, + "required": true + }, + "responses": { + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Query is invalid." + }, + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActivityUserMetadata" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "activities" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/activities/{index}/{source}/{id_}/user_metadata/remediated": { + "put": { + "operationId": "put_activity_user_metadata_remediated_/activities////user_metadata/remediated", + "parameters": [ + { + "in": "path", + "name": "index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "id_", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActivityUserMetadataRemediated" + } + } + }, + "required": true + }, + "responses": { + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Query is invalid." + }, + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActivityUserMetadata" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "activities" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/activities/{index}/{source}/{id_}/user_metadata/risk_score": { + "put": { + "operationId": "put_activity_user_metadata_risk_score_/activities////user_metadata/risk_score", + "parameters": [ + { + "in": "path", + "name": "index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "id_", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActivityUserRiskScore" + } + } + }, + "required": true + }, + "responses": { + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Query is invalid." + }, + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActivityUserMetadata" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "activities" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/activities/{index}/{source}/{id_}/user_metadata/tags": { + "delete": { + "operationId": "delete_activity_user_metadata_tags_/activities////user_metadata/tags", + "parameters": [ + { + "in": "path", + "name": "index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "id_", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "Success" + } + }, + "tags": [ + "activities" + ] + }, + "get": { + "operationId": "get_activity_user_metadata_tags_/activities////user_metadata/tags", + "parameters": [ + { + "in": "path", + "name": "index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "id_", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActivityUserMetadata" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "activities" + ] + }, + "put": { + "operationId": "put_activity_user_metadata_tags_/activities////user_metadata/tags", + "parameters": [ + { + "in": "path", + "name": "index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "id_", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActivityUserTags" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActivityUserMetadata" + } + } + }, + "description": "Success" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Query is invalid." + } + }, + "tags": [ + "activities" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/activities/{index}/{source}/{id}": { + "get": { + "operationId": "get_activity_endpoint_deprecated_/activities///", + "parameters": [ + { + "in": "path", + "name": "index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "Returns the activity" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Activity not found" + } + }, + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id}/ai_assistance": { + "get": { + "operationId": "get_activity_assistance_resource_/activities////ai_assistance", + "parameters": [ + { + "in": "path", + "name": "index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/get_activity_assistance_resource__activities__string_index___string_source___path_id__ai_assistance_200_response" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id}/enrichment": { + "get": { + "operationId": "get_activity_enrichment_endpoint_/activities////enrichment", + "parameters": [ + { + "in": "path", + "name": "index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "Returns the activity enrichment" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Activity not found" + } + }, + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id}/events": { + "get": { + "operationId": "get_entity_events_/activities////events", + "parameters": [ + { + "in": "path", + "name": "index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Start from this key when paginating events.", + "in": "query", + "name": "from", + "schema": { + "type": "integer" + } + }, + { + "description": "Limit the events per page.", + "in": "query", + "name": "size", + "schema": { + "default": 100, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "Returns events associated with the entity" + } + }, + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id}/highlights": { + "post": { + "operationId": "post_activity_highlights_/activities////highlights", + "parameters": [ + { + "in": "path", + "name": "index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HighlightPayload" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": {}, + "description": "Returns the highlights of an activity" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Activity not found" + } + }, + "tags": [ + "activities" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/activities/{index}/{source}/{id}/leaked_data": { + "get": { + "operationId": "get_leaked_data_/activities////leaked_data", + "parameters": [ + { + "in": "path", + "name": "index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Activity not found" + }, + "200": { + "content": {}, + "description": "Returns the related leaked_data" + } + }, + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id}/messages": { + "get": { + "operationId": "get_activity_messages_/activities////messages", + "parameters": [ + { + "in": "path", + "name": "index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "Returns the related messages" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Activity not found" + } + }, + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id}/parent_chat_data": { + "get": { + "operationId": "get_parent_activity_data_/activities////parent_chat_data", + "parameters": [ + { + "in": "path", + "name": "index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Activity not found" + }, + "200": { + "content": {}, + "description": "Returns the related parent_uids data" + } + }, + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id}/related/{context}": { + "get": { + "operationId": "get_related_items_/activities////related/", + "parameters": [ + { + "in": "path", + "name": "index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "context", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "ID of an identifier.", + "explode": true, + "in": "query", + "name": "identifier_ids", + "schema": { + "items": { + "type": "integer" + }, + "type": "array" + }, + "style": "form" + } + ], + "responses": { + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Activity have no related items" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Activity not found" + }, + "200": { + "content": {}, + "description": "Returns related activities" + } + }, + "tags": [ + "activities" + ] + } + }, + "/firework/v2/assets/": { + "get": { + "operationId": "get_assets_/assets/", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/get_assets__assets__200_response" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "Identifiers" + ] + }, + "post": { + "operationId": "post_assets_/assets/", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IdentifierCreate" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post_assets__assets__200_response" + } + } + }, + "description": "Success" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Query is invalid." + } + }, + "tags": [ + "Identifiers" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/assets/groups/": { + "get": { + "operationId": "get_assets_groups_/assets/groups/", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/get_assets_groups__assets_groups__200_response" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "Identifiers" + ] + }, + "post": { + "operationId": "post_assets_groups_/assets/groups/", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IdentifierGroup" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post_assets_groups__assets_groups__200_response" + } + } + }, + "description": "Success" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Query is invalid." + } + }, + "tags": [ + "Identifiers" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/assets/groups/{assets_group_id}": { + "delete": { + "operationId": "delete_assets_group_api_/assets/groups/", + "parameters": [ + { + "in": "path", + "name": "assets_group_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "Success" + } + }, + "tags": [ + "Identifiers" + ] + }, + "get": { + "operationId": "get_assets_group_api_/assets/groups/", + "parameters": [ + { + "in": "path", + "name": "assets_group_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post_assets_groups__assets_groups__200_response" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "Identifiers" + ] + }, + "put": { + "operationId": "put_assets_group_api_/assets/groups/", + "parameters": [ + { + "in": "path", + "name": "assets_group_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateGroupData" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post_assets_groups__assets_groups__200_response" + } + } + }, + "description": "Success" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Query is invalid." + } + }, + "tags": [ + "Identifiers" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/assets/groups/{assets_group_id}/alerts": { + "get": { + "operationId": "get_assets_group_alerts_/assets/groups//alerts", + "parameters": [ + { + "in": "path", + "name": "assets_group_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/get_assets_group_alerts__assets_groups__int_assets_group_id__alerts_200_response" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "Identifiers" + ] + }, + "post": { + "operationId": "post_assets_group_alerts_/assets/groups//alerts", + "parameters": [ + { + "in": "path", + "name": "assets_group_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FeedAlert" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FeedAlert" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "Identifiers" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/assets/groups/{assets_group_id}/alerts/{alert_id}": { + "delete": { + "operationId": "delete_assets_group_alert_/assets/groups//alerts/", + "parameters": [ + { + "in": "path", + "name": "assets_group_id", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "in": "path", + "name": "alert_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "Success" + } + }, + "tags": [ + "Identifiers" + ] + }, + "put": { + "operationId": "put_assets_group_alert_/assets/groups//alerts/", + "parameters": [ + { + "in": "path", + "name": "assets_group_id", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "in": "path", + "name": "alert_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FeedAlert" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FeedAlert" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "Identifiers" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/assets/groups/{assets_group_id}/feed": { + "get": { + "operationId": "get_assets_group_feed_/assets/groups//feed", + "parameters": [ + { + "in": "path", + "name": "assets_group_id", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", + "explode": true, + "in": "query", + "name": "fields", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z", + "in": "query", + "name": "time", + "schema": { + "type": "string" + } + }, + { + "description": "The `size` parameter is used to limit the number of results returned for the search query.", + "in": "query", + "name": "size", + "schema": { + "default": 10, + "type": "integer" + } + }, + { + "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results.", + "in": "query", + "name": "search_after", + "schema": { + "type": "string" + } + }, + { + "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results.", + "in": "query", + "name": "from", + "schema": { + "type": "string" + } + }, + { + "description": "User defined tags used to filter search results", + "explode": true, + "in": "query", + "name": "tags", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "User defined operator to apply to tags filter", + "in": "query", + "name": "tags_query_operator", + "schema": { + "type": "string" + } + }, + { + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", + "explode": true, + "in": "query", + "name": "types", + "schema": { + "enum": [ + "attachment", + "listing", + "ransomleak", + "forum_post", + "forum_topic", + "forum_profile", + "blog_post", + "seller", + "paste", + "leak", + "chat_message", + "domain", + "bot", + "stealer_log", + "infected_devices", + "driller", + "driller_forum_topic", + "driller_forum_post", + "driller_profile", + "cc", + "ccbin", + "financial_data", + "leaked_data", + "leaked_file", + "document", + "account", + "actor", + "forum_content", + "blog_content", + "profile", + "leaked_credential", + "valid_credential", + "invalid_credential", + "mitigated_credential", + "illicit_networks", + "open_web", + "domains", + "intelligence_object", + "leaks", + "social_media_account", + "social_media", + "source_code", + "source_code_secrets_np", + "source_code_secrets", + "source_code_files", + "secret", + "docker", + "stack_exchange", + "google", + "service", + "driller_host", + "buckets", + "bucket", + "bucket_object", + "whois", + "ad", + "ads", + "cookie", + "pii", + "experimental" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Type of experimental activities to search through.", + "explode": true, + "in": "query", + "name": "experimental_types", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "query", + "name": "event_action", + "schema": { + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ], + "type": "string" + } + }, + { + "explode": true, + "in": "query", + "name": "event_actions", + "schema": { + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "explode": true, + "in": "query", + "name": "risks", + "schema": { + "enum": [ + "1", + "2", + "3", + "4", + "5" + ], + "items": { + "type": "integer" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "query", + "name": "order", + "schema": { + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "type": "string" + } + }, + { + "in": "query", + "name": "sort_by", + "schema": { + "default": "created", + "enum": [ + "created", + "indexed", + "updated", + "alertable-materialized", + "materialized", + "searchable" + ], + "type": "string" + } + }, + { + "in": "query", + "name": "use_global_policies", + "schema": { + "default": true, + "type": "boolean" + } + }, + { + "description": "The time zone used to compute the statistics.", + "in": "query", + "name": "time_zone", + "schema": { + "type": "string" + } + }, + { + "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax.", + "in": "query", + "name": "query", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "has_modified_risk_score", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "in": "query", + "name": "has_notes", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Identifier group does not exist." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Query is invalid." + }, + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Search" + } + } + }, + "description": "Returns the search result(s)." + } + }, + "tags": [ + "Identifiers" + ] + }, + "post": { + "operationId": "post_assets_group_feed_/assets/groups//feed", + "parameters": [ + { + "in": "path", + "name": "assets_group_id", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", + "explode": true, + "in": "query", + "name": "fields", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z", + "in": "query", + "name": "time", + "schema": { + "type": "string" + } + }, + { + "description": "The `size` parameter is used to limit the number of results returned for the search query.", + "in": "query", + "name": "size", + "schema": { + "default": 10, + "type": "integer" + } + }, + { + "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results.", + "in": "query", + "name": "search_after", + "schema": { + "type": "string" + } + }, + { + "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results.", + "in": "query", + "name": "from", + "schema": { + "type": "string" + } + }, + { + "description": "User defined tags used to filter search results", + "explode": true, + "in": "query", + "name": "tags", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "User defined operator to apply to tags filter", + "in": "query", + "name": "tags_query_operator", + "schema": { + "type": "string" + } + }, + { + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", + "explode": true, + "in": "query", + "name": "types", + "schema": { + "enum": [ + "attachment", + "listing", + "ransomleak", + "forum_post", + "forum_topic", + "forum_profile", + "blog_post", + "seller", + "paste", + "leak", + "chat_message", + "domain", + "bot", + "stealer_log", + "infected_devices", + "driller", + "driller_forum_topic", + "driller_forum_post", + "driller_profile", + "cc", + "ccbin", + "financial_data", + "leaked_data", + "leaked_file", + "document", + "account", + "actor", + "forum_content", + "blog_content", + "profile", + "leaked_credential", + "valid_credential", + "invalid_credential", + "mitigated_credential", + "illicit_networks", + "open_web", + "domains", + "intelligence_object", + "leaks", + "social_media_account", + "social_media", + "source_code", + "source_code_secrets_np", + "source_code_secrets", + "source_code_files", + "secret", + "docker", + "stack_exchange", + "google", + "service", + "driller_host", + "buckets", + "bucket", + "bucket_object", + "whois", + "ad", + "ads", + "cookie", + "pii", + "experimental" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Type of experimental activities to search through.", + "explode": true, + "in": "query", + "name": "experimental_types", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "query", + "name": "event_action", + "schema": { + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ], + "type": "string" + } + }, + { + "explode": true, + "in": "query", + "name": "event_actions", + "schema": { + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "explode": true, + "in": "query", + "name": "risks", + "schema": { + "enum": [ + "1", + "2", + "3", + "4", + "5" + ], + "items": { + "type": "integer" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "query", + "name": "order", + "schema": { + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "type": "string" + } + }, + { + "in": "query", + "name": "sort_by", + "schema": { + "default": "created", + "enum": [ + "created", + "indexed", + "updated", + "alertable-materialized", + "materialized", + "searchable" + ], + "type": "string" + } + }, + { + "in": "query", + "name": "use_global_policies", + "schema": { + "default": true, + "type": "boolean" + } + }, + { + "description": "The time zone used to compute the statistics.", + "in": "query", + "name": "time_zone", + "schema": { + "type": "string" + } + }, + { + "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax.", + "in": "query", + "name": "query", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "has_modified_risk_score", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "in": "query", + "name": "has_notes", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Identifier group does not exist." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Query is invalid." + }, + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Search" + } + } + }, + "description": "Returns the search result(s)." + } + }, + "tags": [ + "Identifiers" + ] + } + }, + "/firework/v2/assets/{asset_id}": { + "delete": { + "operationId": "delete_asset_api_/assets/", + "parameters": [ + { + "in": "path", + "name": "asset_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "Success" + } + }, + "tags": [ + "Identifiers" + ] + }, + "get": { + "operationId": "get_asset_api_/assets/", + "parameters": [ + { + "in": "path", + "name": "asset_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post_assets__assets__200_response" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "Identifiers" + ] + }, + "put": { + "operationId": "put_asset_api_/assets/", + "parameters": [ + { + "in": "path", + "name": "asset_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Identifier" + } + } + }, + "required": true + }, + "responses": { + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Query is invalid." + }, + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post_assets__assets__200_response" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "Identifiers" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/assets/{asset_id}/alerts": { + "get": { + "operationId": "get_asset_alerts_/assets//alerts", + "parameters": [ + { + "in": "path", + "name": "asset_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/get_assets_group_alerts__assets_groups__int_assets_group_id__alerts_200_response" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "Identifiers" + ] + }, + "post": { + "operationId": "post_asset_alerts_/assets//alerts", + "parameters": [ + { + "in": "path", + "name": "asset_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FeedAlert" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FeedAlert" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "Identifiers" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/assets/{asset_id}/alerts/{alert_id}": { + "delete": { + "operationId": "delete_asset_alert_/assets//alerts/", + "parameters": [ + { + "in": "path", + "name": "asset_id", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "in": "path", + "name": "alert_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "Success" + } + }, + "tags": [ + "Identifiers" + ] + }, + "put": { + "operationId": "put_asset_alert_/assets//alerts/", + "parameters": [ + { + "in": "path", + "name": "asset_id", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "in": "path", + "name": "alert_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FeedAlert" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FeedAlert" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "Identifiers" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/assets/{asset_id}/feed": { + "get": { + "operationId": "get_asset_feed_/assets//feed", + "parameters": [ + { + "in": "path", + "name": "asset_id", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", + "explode": true, + "in": "query", + "name": "fields", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z", + "in": "query", + "name": "time", + "schema": { + "type": "string" + } + }, + { + "description": "The `size` parameter is used to limit the number of results returned for the search query.", + "in": "query", + "name": "size", + "schema": { + "default": 10, + "type": "integer" + } + }, + { + "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results.", + "in": "query", + "name": "search_after", + "schema": { + "type": "string" + } + }, + { + "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results.", + "in": "query", + "name": "from", + "schema": { + "type": "string" + } + }, + { + "description": "User defined tags used to filter search results", + "explode": true, + "in": "query", + "name": "tags", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "User defined operator to apply to tags filter", + "in": "query", + "name": "tags_query_operator", + "schema": { + "type": "string" + } + }, + { + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", + "explode": true, + "in": "query", + "name": "types", + "schema": { + "enum": [ + "attachment", + "listing", + "ransomleak", + "forum_post", + "forum_topic", + "forum_profile", + "blog_post", + "seller", + "paste", + "leak", + "chat_message", + "domain", + "bot", + "stealer_log", + "infected_devices", + "driller", + "driller_forum_topic", + "driller_forum_post", + "driller_profile", + "cc", + "ccbin", + "financial_data", + "leaked_data", + "leaked_file", + "document", + "account", + "actor", + "forum_content", + "blog_content", + "profile", + "leaked_credential", + "valid_credential", + "invalid_credential", + "mitigated_credential", + "illicit_networks", + "open_web", + "domains", + "intelligence_object", + "leaks", + "social_media_account", + "social_media", + "source_code", + "source_code_secrets_np", + "source_code_secrets", + "source_code_files", + "secret", + "docker", + "stack_exchange", + "google", + "service", + "driller_host", + "buckets", + "bucket", + "bucket_object", + "whois", + "ad", + "ads", + "cookie", + "pii", + "experimental" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Type of experimental activities to search through.", + "explode": true, + "in": "query", + "name": "experimental_types", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "query", + "name": "event_action", + "schema": { + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ], + "type": "string" + } + }, + { + "explode": true, + "in": "query", + "name": "event_actions", + "schema": { + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "explode": true, + "in": "query", + "name": "risks", + "schema": { + "enum": [ + "1", + "2", + "3", + "4", + "5" + ], + "items": { + "type": "integer" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "query", + "name": "order", + "schema": { + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "type": "string" + } + }, + { + "in": "query", + "name": "sort_by", + "schema": { + "default": "created", + "enum": [ + "created", + "indexed", + "updated", + "alertable-materialized", + "materialized", + "searchable" + ], + "type": "string" + } + }, + { + "in": "query", + "name": "use_global_policies", + "schema": { + "default": true, + "type": "boolean" + } + }, + { + "description": "The time zone used to compute the statistics.", + "in": "query", + "name": "time_zone", + "schema": { + "type": "string" + } + }, + { + "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax.", + "in": "query", + "name": "query", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "has_modified_risk_score", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "in": "query", + "name": "has_notes", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Identifier does not exist." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Query is invalid." + }, + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Search" + } + } + }, + "description": "Returns the search result(s)." + } + }, + "tags": [ + "Identifiers" + ] + }, + "post": { + "operationId": "post_asset_feed_/assets//feed", + "parameters": [ + { + "in": "path", + "name": "asset_id", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", + "explode": true, + "in": "query", + "name": "fields", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z", + "in": "query", + "name": "time", + "schema": { + "type": "string" + } + }, + { + "description": "The `size` parameter is used to limit the number of results returned for the search query.", + "in": "query", + "name": "size", + "schema": { + "default": 10, + "type": "integer" + } + }, + { + "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results.", + "in": "query", + "name": "search_after", + "schema": { + "type": "string" + } + }, + { + "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results.", + "in": "query", + "name": "from", + "schema": { + "type": "string" + } + }, + { + "description": "User defined tags used to filter search results", + "explode": true, + "in": "query", + "name": "tags", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "User defined operator to apply to tags filter", + "in": "query", + "name": "tags_query_operator", + "schema": { + "type": "string" + } + }, + { + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", + "explode": true, + "in": "query", + "name": "types", + "schema": { + "enum": [ + "attachment", + "listing", + "ransomleak", + "forum_post", + "forum_topic", + "forum_profile", + "blog_post", + "seller", + "paste", + "leak", + "chat_message", + "domain", + "bot", + "stealer_log", + "infected_devices", + "driller", + "driller_forum_topic", + "driller_forum_post", + "driller_profile", + "cc", + "ccbin", + "financial_data", + "leaked_data", + "leaked_file", + "document", + "account", + "actor", + "forum_content", + "blog_content", + "profile", + "leaked_credential", + "valid_credential", + "invalid_credential", + "mitigated_credential", + "illicit_networks", + "open_web", + "domains", + "intelligence_object", + "leaks", + "social_media_account", + "social_media", + "source_code", + "source_code_secrets_np", + "source_code_secrets", + "source_code_files", + "secret", + "docker", + "stack_exchange", + "google", + "service", + "driller_host", + "buckets", + "bucket", + "bucket_object", + "whois", + "ad", + "ads", + "cookie", + "pii", + "experimental" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Type of experimental activities to search through.", + "explode": true, + "in": "query", + "name": "experimental_types", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "query", + "name": "event_action", + "schema": { + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ], + "type": "string" + } + }, + { + "explode": true, + "in": "query", + "name": "event_actions", + "schema": { + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "explode": true, + "in": "query", + "name": "risks", + "schema": { + "enum": [ + "1", + "2", + "3", + "4", + "5" + ], + "items": { + "type": "integer" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "query", + "name": "order", + "schema": { + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "type": "string" + } + }, + { + "in": "query", + "name": "sort_by", + "schema": { + "default": "created", + "enum": [ + "created", + "indexed", + "updated", + "alertable-materialized", + "materialized", + "searchable" + ], + "type": "string" + } + }, + { + "in": "query", + "name": "use_global_policies", + "schema": { + "default": true, + "type": "boolean" + } + }, + { + "description": "The time zone used to compute the statistics.", + "in": "query", + "name": "time_zone", + "schema": { + "type": "string" + } + }, + { + "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax.", + "in": "query", + "name": "query", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "has_modified_risk_score", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "in": "query", + "name": "has_notes", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Identifier does not exist." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Query is invalid." + }, + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Search" + } + } + }, + "description": "Returns the search result(s)." + } + }, + "tags": [ + "Identifiers" + ] + } + }, + "/firework/v2/assets/{asset_id}/highlights/{index}/{source}/{id}": { + "get": { + "operationId": "get_identifier_activity_highlights_/assets//highlights///", + "parameters": [ + { + "in": "path", + "name": "asset_id", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "in": "path", + "name": "index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "Returns the highlights of the identifier data matching on an activity content." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Identifier or activity does not exist." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Query is invalid." + } + }, + "tags": [ + "Identifiers" + ] + } + }, + "/firework/v2/assets/{asset_id}/toggle": { + "post": { + "operationId": "post_identifier_toggle_/assets//toggle", + "parameters": [ + { + "in": "path", + "name": "asset_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IdentifierToggle" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post_assets__assets__200_response" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "Identifiers" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/me/feed": { + "get": { + "operationId": "get_current_user_home_feed_/me/feed", + "parameters": [ + { + "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z", + "in": "query", + "name": "time", + "schema": { + "type": "string" + } + }, + { + "description": "The `size` parameter is used to limit the number of results returned for the search query.", + "in": "query", + "name": "size", + "schema": { + "default": 10, + "type": "integer" + } + }, + { + "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results.", + "in": "query", + "name": "search_after", + "schema": { + "type": "string" + } + }, + { + "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results.", + "in": "query", + "name": "from", + "schema": { + "type": "string" + } + }, + { + "description": "User defined tags used to filter search results", + "explode": true, + "in": "query", + "name": "tags", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "User defined operator to apply to tags filter", + "in": "query", + "name": "tags_query_operator", + "schema": { + "type": "string" + } + }, + { + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", + "explode": true, + "in": "query", + "name": "types", + "schema": { + "enum": [ + "attachment", + "listing", + "ransomleak", + "forum_post", + "forum_topic", + "forum_profile", + "blog_post", + "seller", + "paste", + "leak", + "chat_message", + "domain", + "bot", + "stealer_log", + "infected_devices", + "driller", + "driller_forum_topic", + "driller_forum_post", + "driller_profile", + "cc", + "ccbin", + "financial_data", + "leaked_data", + "leaked_file", + "document", + "account", + "actor", + "forum_content", + "blog_content", + "profile", + "leaked_credential", + "valid_credential", + "invalid_credential", + "mitigated_credential", + "illicit_networks", + "open_web", + "domains", + "intelligence_object", + "leaks", + "social_media_account", + "social_media", + "source_code", + "source_code_secrets_np", + "source_code_secrets", + "source_code_files", + "secret", + "docker", + "stack_exchange", + "google", + "service", + "driller_host", + "buckets", + "bucket", + "bucket_object", + "whois", + "ad", + "ads", + "cookie", + "pii", + "experimental" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Type of experimental activities to search through.", + "explode": true, + "in": "query", + "name": "experimental_types", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "query", + "name": "event_action", + "schema": { + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ], + "type": "string" + } + }, + { + "explode": true, + "in": "query", + "name": "event_actions", + "schema": { + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "explode": true, + "in": "query", + "name": "risks", + "schema": { + "enum": [ + "1", + "2", + "3", + "4", + "5" + ], + "items": { + "type": "integer" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "query", + "name": "order", + "schema": { + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "type": "string" + } + }, + { + "in": "query", + "name": "sort_by", + "schema": { + "default": "created", + "enum": [ + "created", + "indexed", + "updated", + "alertable-materialized", + "materialized", + "searchable" + ], + "type": "string" + } + }, + { + "in": "query", + "name": "use_global_policies", + "schema": { + "default": true, + "type": "boolean" + } + }, + { + "description": "The time zone used to compute the statistics.", + "in": "query", + "name": "time_zone", + "schema": { + "type": "string" + } + }, + { + "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax.", + "in": "query", + "name": "query", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "has_modified_risk_score", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "in": "query", + "name": "has_notes", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Search" + } + } + }, + "description": "The user's home feed activities" + } + }, + "tags": [ + "me" + ] + }, + "post": { + "operationId": "post_current_user_home_feed_/me/feed", + "parameters": [ + { + "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z", + "in": "query", + "name": "time", + "schema": { + "type": "string" + } + }, + { + "description": "The `size` parameter is used to limit the number of results returned for the search query.", + "in": "query", + "name": "size", + "schema": { + "default": 10, + "type": "integer" + } + }, + { + "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results.", + "in": "query", + "name": "search_after", + "schema": { + "type": "string" + } + }, + { + "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results.", + "in": "query", + "name": "from", + "schema": { + "type": "string" + } + }, + { + "description": "User defined tags used to filter search results", + "explode": true, + "in": "query", + "name": "tags", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "User defined operator to apply to tags filter", + "in": "query", + "name": "tags_query_operator", + "schema": { + "type": "string" + } + }, + { + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", + "explode": true, + "in": "query", + "name": "types", + "schema": { + "enum": [ + "attachment", + "listing", + "ransomleak", + "forum_post", + "forum_topic", + "forum_profile", + "blog_post", + "seller", + "paste", + "leak", + "chat_message", + "domain", + "bot", + "stealer_log", + "infected_devices", + "driller", + "driller_forum_topic", + "driller_forum_post", + "driller_profile", + "cc", + "ccbin", + "financial_data", + "leaked_data", + "leaked_file", + "document", + "account", + "actor", + "forum_content", + "blog_content", + "profile", + "leaked_credential", + "valid_credential", + "invalid_credential", + "mitigated_credential", + "illicit_networks", + "open_web", + "domains", + "intelligence_object", + "leaks", + "social_media_account", + "social_media", + "source_code", + "source_code_secrets_np", + "source_code_secrets", + "source_code_files", + "secret", + "docker", + "stack_exchange", + "google", + "service", + "driller_host", + "buckets", + "bucket", + "bucket_object", + "whois", + "ad", + "ads", + "cookie", + "pii", + "experimental" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Type of experimental activities to search through.", + "explode": true, + "in": "query", + "name": "experimental_types", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "query", + "name": "event_action", + "schema": { + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ], + "type": "string" + } + }, + { + "explode": true, + "in": "query", + "name": "event_actions", + "schema": { + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "explode": true, + "in": "query", + "name": "risks", + "schema": { + "enum": [ + "1", + "2", + "3", + "4", + "5" + ], + "items": { + "type": "integer" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "query", + "name": "order", + "schema": { + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "type": "string" + } + }, + { + "in": "query", + "name": "sort_by", + "schema": { + "default": "created", + "enum": [ + "created", + "indexed", + "updated", + "alertable-materialized", + "materialized", + "searchable" + ], + "type": "string" + } + }, + { + "in": "query", + "name": "use_global_policies", + "schema": { + "default": true, + "type": "boolean" + } + }, + { + "description": "The time zone used to compute the statistics.", + "in": "query", + "name": "time_zone", + "schema": { + "type": "string" + } + }, + { + "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax.", + "in": "query", + "name": "query", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "has_modified_risk_score", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "in": "query", + "name": "has_notes", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Search" + } + } + }, + "description": "The user's home feed activities" + } + }, + "tags": [ + "me" + ] + } + }, + "/firework/v2/me/feed/credentials": { + "get": { + "operationId": "get_leaked_credentials_feed_endpoint_/me/feed/credentials", + "parameters": [ + { + "in": "query", + "name": "size", + "schema": { + "default": 20, + "type": "integer" + } + }, + { + "in": "query", + "name": "from", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "order_type", + "schema": { + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaginatedCredentials" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "me" + ] + }, + "post": { + "operationId": "post_leaked_credentials_feed_endpoint_/me/feed/credentials", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserUpdate" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaginatedCredentials" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "me" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/me/profile": { + "get": { + "operationId": "get_current_user_profile_/me/profile", + "responses": { + "200": { + "content": {}, + "description": "Returns the current user's profile" + } + }, + "tags": [ + "me" + ] + }, + "put": { + "operationId": "put_current_user_profile_/me/profile", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserUpdate" + } + } + }, + "required": true + }, + "responses": { + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Update is invalid" + }, + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/put_current_user_profile__me_profile_200_response" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "me" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/me/tenants": { + "get": { + "operationId": "get_current_user_tenants_/me/tenants", + "responses": { + "200": { + "content": {}, + "description": "Returns the current user's tenants." + } + }, + "tags": [ + "me" + ] + } + }, + "/firework/v2/organizations/{organization_id}/members": { + "get": { + "operationId": "get_organization_members_api_/organizations//members", + "parameters": [ + { + "in": "path", + "name": "organization_id", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "in": "query", + "name": "size", + "schema": { + "default": 20, + "type": "integer" + } + }, + { + "in": "query", + "name": "from", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "q", + "schema": { + "type": "string" + } + } + ], + "responses": { + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Organization not found" + }, + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationMemberPage" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "organizations" + ] + }, + "post": { + "operationId": "post_organization_members_api_/organizations//members", + "parameters": [ + { + "in": "path", + "name": "organization_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationMemberData" + } + } + }, + "required": true + }, + "responses": { + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Organization not found" + }, + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post_organization_members_api__organizations__int_organization_id__members_200_response" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "organizations" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/organizations/{organization_id}/members/count": { + "get": { + "operationId": "get_organization_members_count_api_/organizations//members/count", + "parameters": [ + { + "in": "path", + "name": "organization_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Organization not found" + }, + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationMembersCount" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "organizations" + ] + } + }, + "/firework/v2/organizations/{organization_id}/members/{user_id}": { + "get": { + "operationId": "get_organization_member_api_/organizations//members/", + "parameters": [ + { + "in": "path", + "name": "organization_id", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "in": "path", + "name": "user_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post_organization_members_api__organizations__int_organization_id__members_200_response" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "organizations" + ] + }, + "put": { + "operationId": "put_organization_member_api_/organizations//members/", + "parameters": [ + { + "in": "path", + "name": "organization_id", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "in": "path", + "name": "user_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationMember" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post_organization_members_api__organizations__int_organization_id__members_200_response" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "organizations" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/organizations/{organization_id}/members/{user_id}/disable": { + "post": { + "operationId": "post_organization_member_disable_/organizations//members//disable", + "parameters": [ + { + "in": "path", + "name": "organization_id", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "in": "path", + "name": "user_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EnableState" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "organizations" + ] + } + }, + "/firework/v2/organizations/{organization_id}/members/{user_id}/enable": { + "post": { + "operationId": "post_organization_member_enable_/organizations//members//enable", + "parameters": [ + { + "in": "path", + "name": "organization_id", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "in": "path", + "name": "user_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EnableState" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "organizations" + ] + } + }, + "/firework/v2/organizations/{organization_id}/members/{user_id}/permissions": { + "post": { + "operationId": "post_organization_member_permissions_api_/organizations//members//permissions", + "parameters": [ + { + "in": "path", + "name": "organization_id", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "in": "path", + "name": "user_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PermissionData" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdatedPermission" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "organizations" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/organizations/{organization_id}/members/{user_id}/tenants": { + "get": { + "operationId": "get_organization_member_tenants_/organizations//members//tenants", + "parameters": [ + { + "in": "path", + "name": "organization_id", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "in": "path", + "name": "user_id", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "in": "query", + "name": "size", + "schema": { + "default": 20, + "type": "integer" + } + }, + { + "in": "query", + "name": "from", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "include_disabled_demo", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "in": "query", + "name": "q", + "schema": { + "type": "string" + } + }, + { + "explode": true, + "in": "query", + "name": "types[]", + "schema": { + "enum": [ + "regular", + "service-firm", + "micro", + "starter", + "essential", + "core", + "enterprise", + "demo", + "training" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantWithCounts" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "organizations" + ] + } + }, + "/firework/v2/organizations/{organization_id}/tenants": { + "get": { + "operationId": "get_organization_tenants_api_/organizations//tenants", + "parameters": [ + { + "in": "path", + "name": "organization_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantWithCounts" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "organizations" + ] + }, + "post": { + "operationId": "post_organization_tenants_api_/organizations//tenants", + "parameters": [ + { + "in": "path", + "name": "organization_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NewTenantInfo" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tenant" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "organizations" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/reporting/reports": { + "get": { + "operationId": "get_reports_endpoint_/reporting/reports", + "responses": { + "200": { + "content": {}, + "description": "Lists reports for the current tenant, ordered from newest to oldest." + } + }, + "tags": [ + "reporting" + ] + }, + "post": { + "operationId": "post_reports_endpoint_/reporting/reports", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NewReport" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": {}, + "description": "Creates a new report on the current tenant." + } + }, + "tags": [ + "reporting" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/reporting/reports/{report_id}": { + "delete": { + "operationId": "delete_report_endpoint_/reporting/reports/", + "parameters": [ + { + "in": "path", + "name": "report_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "Deletes a report." + } + }, + "tags": [ + "reporting" + ] + }, + "get": { + "operationId": "get_report_endpoint_/reporting/reports/", + "parameters": [ + { + "in": "path", + "name": "report_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "Returns a report and its elements." + } + }, + "tags": [ + "reporting" + ] + }, + "patch": { + "operationId": "patch_report_endpoint_/reporting/reports/", + "parameters": [ + { + "in": "path", + "name": "report_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdatedReport" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": {}, + "description": "Updates a report." + } + }, + "tags": [ + "reporting" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/reporting/reports/{report_id}/archive": { + "post": { + "operationId": "post_archive_report_endpoint_/reporting/reports//archive", + "parameters": [ + { + "in": "path", + "name": "report_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "Archives a report." + } + }, + "tags": [ + "reporting" + ] + } + }, + "/firework/v2/reporting/reports/{report_id}/download": { + "get": { + "operationId": "get_report_download_endpoint_/reporting/reports//download", + "parameters": [ + { + "in": "path", + "name": "report_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "Download a report." + } + }, + "tags": [ + "reporting" + ] + } + }, + "/firework/v2/search/": { + "get": { + "operationId": "get_search_/search/", + "parameters": [ + { + "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", + "explode": true, + "in": "query", + "name": "fields", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z", + "in": "query", + "name": "time", + "schema": { + "type": "string" + } + }, + { + "description": "The `size` parameter is used to limit the number of results returned for the search query.", + "in": "query", + "name": "size", + "schema": { + "default": 10, + "type": "integer" + } + }, + { + "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results.", + "in": "query", + "name": "search_after", + "schema": { + "type": "string" + } + }, + { + "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results.", + "in": "query", + "name": "from", + "schema": { + "type": "string" + } + }, + { + "description": "User defined tags used to filter search results", + "explode": true, + "in": "query", + "name": "tags", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "User defined operator to apply to tags filter", + "in": "query", + "name": "tags_query_operator", + "schema": { + "type": "string" + } + }, + { + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", + "explode": true, + "in": "query", + "name": "types", + "schema": { + "enum": [ + "attachment", + "listing", + "ransomleak", + "forum_post", + "forum_topic", + "forum_profile", + "blog_post", + "seller", + "paste", + "leak", + "chat_message", + "domain", + "bot", + "stealer_log", + "infected_devices", + "driller", + "driller_forum_topic", + "driller_forum_post", + "driller_profile", + "cc", + "ccbin", + "financial_data", + "leaked_data", + "leaked_file", + "document", + "account", + "actor", + "forum_content", + "blog_content", + "profile", + "leaked_credential", + "valid_credential", + "invalid_credential", + "mitigated_credential", + "illicit_networks", + "open_web", + "domains", + "intelligence_object", + "leaks", + "social_media_account", + "social_media", + "source_code", + "source_code_secrets_np", + "source_code_secrets", + "source_code_files", + "secret", + "docker", + "stack_exchange", + "google", + "service", + "driller_host", + "buckets", + "bucket", + "bucket_object", + "whois", + "cookie", + "pii", + "experimental" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Type of experimental activities to search through.", + "explode": true, + "in": "query", + "name": "experimental_types", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "query", + "name": "event_action", + "schema": { + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ], + "type": "string" + } + }, + { + "explode": true, + "in": "query", + "name": "event_actions", + "schema": { + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "explode": true, + "in": "query", + "name": "risks", + "schema": { + "enum": [ + "1", + "2", + "3", + "4", + "5" + ], + "items": { + "type": "integer" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "query", + "name": "order", + "schema": { + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "type": "string" + } + }, + { + "in": "query", + "name": "sort_by", + "schema": { + "default": "created", + "enum": [ + "created", + "indexed", + "updated", + "alertable-materialized", + "materialized", + "searchable" + ], + "type": "string" + } + }, + { + "in": "query", + "name": "use_global_policies", + "schema": { + "default": true, + "type": "boolean" + } + }, + { + "description": "The time zone used to compute the statistics.", + "in": "query", + "name": "time_zone", + "schema": { + "type": "string" + } + }, + { + "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax.", + "in": "query", + "name": "query", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "has_modified_risk_score", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "in": "query", + "name": "has_notes", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Stealer log labels used to filter search results", + "explode": true, + "in": "query", + "name": "labels", + "schema": { + "enum": [ + "access_types", + "pii", + "facts", + "findings" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "responses": { + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Query is invalid." + }, + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Search" + } + } + }, + "description": "Returns the search result(s)." + } + }, + "tags": [ + "search" + ] + }, + "post": { + "operationId": "post_search_/search/", + "parameters": [ + { + "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", + "explode": true, + "in": "query", + "name": "fields", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z", + "in": "query", + "name": "time", + "schema": { + "type": "string" + } + }, + { + "description": "The `size` parameter is used to limit the number of results returned for the search query.", + "in": "query", + "name": "size", + "schema": { + "default": 10, + "type": "integer" + } + }, + { + "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results.", + "in": "query", + "name": "search_after", + "schema": { + "type": "string" + } + }, + { + "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results.", + "in": "query", + "name": "from", + "schema": { + "type": "string" + } + }, + { + "description": "User defined tags used to filter search results", + "explode": true, + "in": "query", + "name": "tags", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "User defined operator to apply to tags filter", + "in": "query", + "name": "tags_query_operator", + "schema": { + "type": "string" + } + }, + { + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", + "explode": true, + "in": "query", + "name": "types", + "schema": { + "enum": [ + "attachment", + "listing", + "ransomleak", + "forum_post", + "forum_topic", + "forum_profile", + "blog_post", + "seller", + "paste", + "leak", + "chat_message", + "domain", + "bot", + "stealer_log", + "infected_devices", + "driller", + "driller_forum_topic", + "driller_forum_post", + "driller_profile", + "cc", + "ccbin", + "financial_data", + "leaked_data", + "leaked_file", + "document", + "account", + "actor", + "forum_content", + "blog_content", + "profile", + "leaked_credential", + "valid_credential", + "invalid_credential", + "mitigated_credential", + "illicit_networks", + "open_web", + "domains", + "intelligence_object", + "leaks", + "social_media_account", + "social_media", + "source_code", + "source_code_secrets_np", + "source_code_secrets", + "source_code_files", + "secret", + "docker", + "stack_exchange", + "google", + "service", + "driller_host", + "buckets", + "bucket", + "bucket_object", + "whois", + "cookie", + "pii", + "experimental" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Type of experimental activities to search through.", + "explode": true, + "in": "query", + "name": "experimental_types", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "query", + "name": "event_action", + "schema": { + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ], + "type": "string" + } + }, + { + "explode": true, + "in": "query", + "name": "event_actions", + "schema": { + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "explode": true, + "in": "query", + "name": "risks", + "schema": { + "enum": [ + "1", + "2", + "3", + "4", + "5" + ], + "items": { + "type": "integer" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "query", + "name": "order", + "schema": { + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "type": "string" + } + }, + { + "in": "query", + "name": "sort_by", + "schema": { + "default": "created", + "enum": [ + "created", + "indexed", + "updated", + "alertable-materialized", + "materialized", + "searchable" + ], + "type": "string" + } + }, + { + "in": "query", + "name": "use_global_policies", + "schema": { + "default": true, + "type": "boolean" + } + }, + { + "description": "The time zone used to compute the statistics.", + "in": "query", + "name": "time_zone", + "schema": { + "type": "string" + } + }, + { + "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax.", + "in": "query", + "name": "query", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "has_modified_risk_score", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "in": "query", + "name": "has_notes", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Stealer log labels used to filter search results", + "explode": true, + "in": "query", + "name": "labels", + "schema": { + "enum": [ + "access_types", + "pii", + "facts", + "findings" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "responses": { + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Query is invalid." + }, + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Search" + } + } + }, + "description": "Returns the search result(s)." + } + }, + "tags": [ + "search" + ] + } + }, + "/firework/v2/tenants/{tenant_id}": { + "get": { + "operationId": "get_tenant_api_/tenants/", + "parameters": [ + { + "in": "path", + "name": "tenant_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantWithCounts" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "tenants" + ] + }, + "put": { + "operationId": "put_tenant_api_/tenants/", + "parameters": [ + { + "in": "path", + "name": "tenant_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantData" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantWithCounts" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "tenants" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/tenants/{tenant_id}/archive": { + "post": { + "operationId": "post_tenant_archive_api_/tenants//archive", + "parameters": [ + { + "in": "path", + "name": "tenant_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "Success" + } + }, + "tags": [ + "tenants" + ] + } + }, + "/firework/v2/tenants/{tenant_id}/users": { + "get": { + "operationId": "get_tenant_users_api_/tenants//users", + "parameters": [ + { + "in": "path", + "name": "tenant_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantUsers" + } + } + }, + "description": "Success" + } + }, + "tags": [ + "tenants" + ] + }, + "post": { + "operationId": "post_tenant_users_api_/tenants//users", + "parameters": [ + { + "in": "path", + "name": "tenant_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserTenantAccessRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": {}, + "description": "Users were successfully added to tenant." + } + }, + "tags": [ + "tenants" + ], + "x-codegen-request-body-name": "payload" + } + }, + "/firework/v2/tenants/{tenant_id}/users/{user_id}": { + "delete": { + "operationId": "delete_tenant_users_access_api_/tenants//users/", + "parameters": [ + { + "in": "path", + "name": "tenant_id", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "in": "path", + "name": "user_id", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "User was successfully removed from the tenant." + } + }, + "tags": [ + "tenants" + ] + } + } + }, + "components": { + "responses": { + "ParseError": { + "content": {}, + "description": "When a mask can't be parsed" + }, + "MaskError": { + "content": {}, + "description": "When any error occurs on mask" + }, + "HTTPException": { + "content": {}, + "description": "" + } + }, + "schemas": { + "HttpError": { + "properties": { + "message": { + "type": "string" + }, + "code": { + "type": "string" + } + }, + "type": "object" + }, + "Search": { + "properties": { + "items": { + "items": { + "properties": {}, + "type": "object" + }, + "type": "array" + }, + "nb_hits": { + "type": "integer" + }, + "links": { + "$ref": "#/components/schemas/SearchLinks" + }, + "search_after": { + "type": "string" + } + }, + "type": "object" + }, + "SearchLinks": { + "properties": { + "next": { + "type": "string" + } + }, + "type": "object" + }, + "IdentifierCreate": { + "properties": { + "name": { + "minLength": 1, + "type": "string" + }, + "type": { + "enum": [ + "domain", + "name", + "keyword", + "github_repository", + "username", + "email", + "search_query", + "bin", + "ip", + "secret", + "azure_tenant", + "identity", + "ransomleak", + "external_id", + "address_data", + "birth_year", + "role", + "phone_number" + ], + "example": "domain", + "type": "string" + }, + "search_types": { + "items": { + "enum": [ + "google", + "financial_data", + "invalid_credential", + "service", + "blog_post", + "source_code_secrets", + "leak", + "forum_post", + "chat_message", + "ransomleak", + "mitigated_credential", + "paste", + "docker", + "bucket", + "forum_profile", + "source_code_files", + "stealer_log", + "ad", + "forum_topic", + "listing", + "valid_credential", + "bot", + "seller", + "stack_exchange", + "domain", + "bucket_object", + "social_media_account", + "illicit_networks", + "open_web", + "buckets", + "source_code", + "leaks", + "domains", + "forum_content", + "blog_content", + "profile", + "ads", + "infected_devices", + "social_media" + ], + "example": "google", + "type": "string" + }, + "type": "array" + }, + "experimental_search_types": { + "items": { + "type": "string" + }, + "type": "array" + }, + "risks": { + "items": { + "type": "integer" + }, + "type": "array" + }, + "data": { + "properties": {}, + "type": "object" + } + }, + "required": [ + "data", + "name", + "search_types", + "type" + ], + "type": "object" + }, + "Identifier": { + "properties": { + "id": { + "type": "integer" + }, + "tenant_id": { + "type": "integer" + }, + "feed_id": { + "type": "integer" + }, + "type": { + "enum": [ + "domain", + "name", + "keyword", + "github_repository", + "username", + "email", + "search_query", + "bin", + "ip", + "secret", + "azure_tenant", + "identity", + "ransomleak", + "external_id", + "address_data", + "birth_year", + "role", + "phone_number" + ], + "example": "domain", + "type": "string" + }, + "search_types": { + "items": { + "enum": [ + "google", + "financial_data", + "invalid_credential", + "service", + "blog_post", + "source_code_secrets", + "leak", + "forum_post", + "chat_message", + "ransomleak", + "mitigated_credential", + "paste", + "docker", + "bucket", + "forum_profile", + "source_code_files", + "stealer_log", + "forum_topic", + "listing", + "valid_credential", + "bot", + "seller", + "stack_exchange", + "domain", + "bucket_object", + "social_media_account", + "illicit_networks", + "open_web", + "buckets", + "source_code", + "leaks", + "domains", + "forum_content", + "blog_content", + "profile", + "infected_devices", + "social_media" + ], + "example": "google", + "type": "string" + }, + "type": "array" + }, + "experimental_search_types": { + "items": { + "type": "string" + }, + "type": "array" + }, + "v3_refs": { + "$ref": "#/components/schemas/V3_Refs" + }, + "risks": { + "items": { + "type": "integer" + }, + "type": "array" + }, + "name": { + "minLength": 1, + "type": "string" + }, + "data": { + "properties": {}, + "type": "object" + }, + "fetching_progress": { + "type": "integer" + }, + "count": { + "type": "integer" + }, + "urn": { + "description": "The uniform resource name of the identifier.", + "type": "string" + }, + "is_disabled": { + "type": "boolean" + }, + "source": { + "enum": [ + "USER", + "SYSTEM_RELATION", + "SELF_ONBOARDING", + "ATTRIBUTE", + "AUTO_MONITOR", + "IDP_SYNC" + ], + "example": "USER", + "type": "string" + }, + "data_updated_at": { + "format": "date-time", + "type": "string" + } + }, + "required": [ + "data", + "name", + "search_types", + "type" + ], + "type": "object" + }, + "V3_Refs": { + "properties": { + "asset_uuid": { + "type": "string" + } + }, + "type": "object" + }, + "IdentifierToggle": { + "properties": { + "is_disabled": { + "default": true, + "description": "The `is_disabled` parameter is used to toggle the asset as either enabled or disabled.", + "type": "boolean" + } + }, + "required": [ + "is_disabled" + ], + "type": "object" + }, + "FeedAlert": { + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "type": { + "enum": [ + "email", + "channel", + "azure_sentinel", + "azure_sentinel_v2", + "slack", + "discord", + "splunk", + "jira", + "teams", + "servicenow", + "webhook" + ], + "example": "email", + "type": "string" + }, + "feed_url": { + "type": "string" + }, + "feed_target_type": { + "enum": [ + "assets/groups", + "assets", + "home" + ], + "example": "assets/groups", + "type": "string" + }, + "feed_target_id": { + "type": "integer" + }, + "frequency": { + "type": "integer" + }, + "start_at": { + "format": "date-time", + "type": "string" + }, + "created_at": { + "format": "date-time", + "type": "string" + }, + "params": { + "properties": {}, + "type": "object" + }, + "tenant_id": { + "type": "integer" + }, + "organization_id": { + "type": "integer" + }, + "search_types": { + "items": { + "enum": [ + "attachment", + "listing", + "ransomleak", + "forum_post", + "forum_topic", + "forum_profile", + "blog_post", + "seller", + "paste", + "leak", + "chat_message", + "domain", + "bot", + "stealer_log", + "infected_devices", + "driller", + "driller_forum_topic", + "driller_forum_post", + "driller_profile", + "cc", + "ccbin", + "financial_data", + "leaked_data", + "leaked_file", + "document", + "account", + "actor", + "forum_content", + "blog_content", + "profile", + "leaked_credential", + "valid_credential", + "invalid_credential", + "mitigated_credential", + "illicit_networks", + "open_web", + "domains", + "intelligence_object", + "leaks", + "social_media_account", + "social_media", + "source_code", + "source_code_secrets_np", + "source_code_secrets", + "source_code_files", + "secret", + "docker", + "stack_exchange", + "google", + "service", + "driller_host", + "buckets", + "bucket", + "bucket_object", + "whois", + "ad", + "ads", + "cookie", + "pii", + "experimental" + ], + "example": "attachment", + "type": "string" + }, + "type": "array" + }, + "experimental_search_types": { + "items": { + "type": "string" + }, + "type": "array" + }, + "risks": { + "items": { + "type": "integer" + }, + "type": "array" + }, + "tenant_alert_channel_id": { + "type": "integer" + } + }, + "required": [ + "frequency", + "params", + "start_at", + "type" + ], + "type": "object" + }, + "IdentifierGroup": { + "properties": { + "id": { + "type": "integer" + }, + "tenant_id": { + "type": "integer" + }, + "feed_id": { + "type": "integer" + }, + "feed_owner_id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "urn": { + "description": "The uniform resource name of the identifier group.", + "type": "string" + } + }, + "type": "object" + }, + "UpdateGroupData": { + "properties": { + "name": { + "type": "string" + } + }, + "type": "object" + }, + "NewTenantInfo": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "industry": { + "enum": [ + "global", + "transport", + "education", + "energy", + "finance", + "healthcare", + "manufacturing", + "retail", + "software", + "telecommunication" + ], + "example": "global", + "type": "string" + } + }, + "type": "object" + }, + "TenantWithCounts": { + "properties": { + "next": { + "type": "string" + }, + "items": { + "$ref": "#/components/schemas/TenantWithCounts" + } + }, + "type": "object" + }, + "Tenant": { + "properties": { + "id": { + "description": "Tenant ID", + "type": "integer" + }, + "name": { + "description": "Tenant name", + "type": "string" + }, + "type": { + "description": "Tenant type", + "type": "string" + }, + "description": { + "description": "This tenant's purpose", + "type": "string" + }, + "organization_id": { + "description": "ID of the owner organization", + "type": "integer" + }, + "urn": { + "description": "The uniform resource name of the tenant.", + "type": "string" + }, + "number_of_employees": { + "description": "The number of employees for the tenant.", + "type": "integer" + }, + "industry": { + "description": "The industry of the tenant.", + "type": "string" + }, + "is_disabled": { + "description": "Indicates if the tenant is disabled", + "type": "boolean" + }, + "is_archived": { + "description": "Indicates if the tenant is archived", + "type": "boolean" + }, + "feed_id": { + "description": "ID of the feed", + "type": "integer" + }, + "permissions": { + "items": { + "type": "string" + }, + "type": "array" + }, + "prevent_global_search": { + "description": "Indicates if the tenant can perform global searches", + "type": "boolean" + } + }, + "type": "object" + }, + "UpdatedPermission": { + "properties": { + "updated_value": { + "type": "boolean" + } + }, + "type": "object" + }, + "OrganizationMemberData": { + "properties": { + "name": { + "type": "string" + }, + "surname": { + "type": "string" + }, + "email": { + "type": "string" + }, + "organization_member_permissions": { + "properties": {}, + "type": "object" + }, + "user_permissions": { + "properties": {}, + "type": "object" + }, + "memberships": { + "items": { + "$ref": "#/components/schemas/UserTenantMembership" + }, + "type": "array" + }, + "send_welcome_email": { + "default": true, + "type": "boolean" + } + }, + "required": [ + "email", + "name", + "organization_member_permissions", + "surname" + ], + "type": "object" + }, + "UserTenantMembership": { + "properties": { + "tenant_id": { + "type": "integer" + }, + "is_readonly": { + "type": "boolean" + }, + "role": { + "enum": [ + "viewer", + "editor", + "admin" + ], + "example": "viewer", + "type": "string" + } + }, + "required": [ + "tenant_id" + ], + "type": "object" + }, + "OrganizationMemberPage": { + "properties": { + "members": { + "items": { + "$ref": "#/components/schemas/OrganizationMemberWithMetadata" + }, + "type": "array" + } + }, + "type": "object" + }, + "OrganizationMemberWithMetadata": { + "properties": { + "user": { + "$ref": "#/components/schemas/OrganizationMember" + }, + "tenant_count": { + "type": "integer" + } + }, + "type": "object" + }, + "OrganizationMember": { + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "surname": { + "type": "string" + }, + "email": { + "type": "string" + }, + "organization_member_permissions": { + "$ref": "#/components/schemas/OrganizationMemberPermission" + }, + "is_disabled": { + "type": "boolean" + }, + "registered_at": { + "format": "date-time", + "type": "string" + }, + "urn": { + "description": "The uniform resource name of the member.", + "type": "string" + } + }, + "type": "object" + }, + "OrganizationMemberPermission": { + "properties": { + "*": { + "additionalProperties": { + "type": "boolean" + }, + "type": "object" + } + }, + "type": "object" + }, + "OrganizationMembersCount": { + "properties": { + "count": { + "type": "integer" + } + }, + "type": "object" + }, + "EnableState": { + "properties": { + "is_disabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "PermissionData": { + "properties": { + "permission": { + "type": "string" + }, + "value": { + "type": "boolean" + } + }, + "required": [ + "permission", + "value" + ], + "type": "object" + }, + "HighlightPayload": { + "properties": { + "query_string": { + "type": "string" + }, + "identifier_ids": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "ActivityUserNotes": { + "properties": { + "notes": { + "type": "string" + } + }, + "required": [ + "notes" + ], + "type": "object" + }, + "ActivityUserMetadata": { + "properties": { + "uid": { + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "risk_score_updated_at": { + "format": "date-time", + "type": "string" + }, + "remediated_at": { + "format": "date-time", + "type": "string" + }, + "ignored_at": { + "format": "date-time", + "type": "string" + }, + "remediated_asset_uuid": { + "type": "string" + } + }, + "type": "object" + }, + "ActivityUserRiskScore": { + "properties": { + "risk_score": { + "type": "integer" + } + }, + "required": [ + "risk_score" + ], + "type": "object" + }, + "ActivityUserMetadataRemediated": { + "properties": { + "is_remediated": { + "type": "boolean" + }, + "identifier_id": { + "type": "integer" + } + }, + "required": [ + "is_remediated" + ], + "type": "object" + }, + "ActivityUserMetadataIgnored": { + "properties": { + "is_ignored": { + "type": "boolean" + }, + "identifier_id": { + "type": "integer" + } + }, + "required": [ + "is_ignored" + ], + "type": "object" + }, + "ActivityAiAssistance": { + "properties": { + "uid": { + "type": "string" + }, + "prompt": { + "type": "string" + }, + "response": { + "type": "string" + } + }, + "type": "object" + }, + "ActivityUserTags": { + "properties": { + "tags": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "tags" + ], + "type": "object" + }, + "UserUpdate": { + "properties": { + "name": { + "type": "string" + }, + "surname": { + "type": "string" + }, + "settings": { + "properties": {}, + "type": "object" + }, + "language": { + "type": "string" + }, + "color_scheme": { + "enum": [ + "auto", + "light", + "dark" + ], + "example": "auto", + "type": "string" + } + }, + "required": [ + "color_scheme", + "name", + "settings", + "surname" + ], + "type": "object" + }, + "UserProfile": { + "allOf": [ + { + "$ref": "#/components/schemas/User" + }, + { + "properties": { + "settings": { + "$ref": "#/components/schemas/UserSettings" + }, + "feature_flags": { + "$ref": "#/components/schemas/UserProfile_allOf_feature_flags" + }, + "tenants": { + "items": { + "$ref": "#/components/schemas/Tenant" + }, + "type": "array" + }, + "is_sso_mandatory": { + "type": "boolean" + }, + "has_password": { + "type": "boolean" + }, + "urn": { + "type": "string" + }, + "needs_eusa": { + "type": "boolean" + }, + "domain": { + "type": "string" + }, + "language": { + "type": "string" + }, + "should_provide_signup_intent": { + "type": "boolean" + } + }, + "type": "object" + } + ] + }, + "User": { + "properties": { + "id": { + "type": "integer" + }, + "name": { + "description": "Users's name", + "type": "string" + }, + "surname": { + "description": "User's surname", + "type": "string" + }, + "email": { + "description": "User's email", + "type": "string" + }, + "organization_id": { + "description": "ID of the owner organization", + "type": "integer" + }, + "settings": { + "$ref": "#/components/schemas/UserSettings" + }, + "is_disabled": { + "type": "boolean" + }, + "feature_flags": { + "properties": {}, + "type": "object" + }, + "registered_at": { + "format": "date-time", + "type": "string" + }, + "urn": { + "description": "The uniform resource name of the user.", + "type": "string" + }, + "organization_member_permissions": { + "properties": {}, + "type": "object" + }, + "language": { + "description": "User's language", + "type": "string" + }, + "color_scheme": { + "enum": [ + "auto", + "light", + "dark" + ], + "example": "auto", + "type": "string" + }, + "flare_role": { + "type": "string" + } + }, + "required": [ + "color_scheme", + "email", + "language", + "name" + ], + "type": "object" + }, + "UserSettings": { + "properties": { + "default_search": { + "type": "string" + }, + "permissions": { + "items": { + "type": "string" + }, + "type": "array" + }, + "organization_member_permissions": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "PaginatedCredentials": { + "properties": { + "next": { + "type": "string" + }, + "items": { + "$ref": "#/components/schemas/LeakActivityCredential" + } + }, + "type": "object" + }, + "LeakActivityCredential": { + "properties": { + "id": { + "type": "integer" + }, + "source_id": { + "type": "string" + }, + "imported_at": { + "type": "string" + }, + "identity_name": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "domain": { + "type": "string" + }, + "source": { + "$ref": "#/components/schemas/source" + }, + "remediated_at": { + "format": "date-time", + "type": "string" + }, + "ignored_at": { + "format": "date-time", + "type": "string" + }, + "known_password_id": { + "type": "integer" + }, + "credential_hash": { + "type": "string" + } + }, + "required": [ + "id", + "identity_name", + "imported_at", + "source_id" + ], + "type": "object" + }, + "source": { + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description_en": { + "type": "string" + }, + "description_fr": { + "type": "string" + }, + "breached_at": { + "type": "string" + }, + "leaked_at": { + "type": "string" + }, + "pii_tags": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "TenantData": { + "properties": { + "name": { + "description": "The Tenant display name", + "type": "string" + }, + "description": { + "description": "The Tenant's purpose / description", + "type": "string" + }, + "number_of_employees": { + "description": "The number of employees for the tenant", + "type": "integer" + }, + "industry": { + "description": "The Tenant's industry", + "enum": [ + "global", + "transport", + "education", + "energy", + "finance", + "healthcare", + "manufacturing", + "retail", + "software", + "telecommunication" + ], + "example": "global", + "type": "string" + }, + "global_search_calls_limit": { + "description": "The number of API calls allowed for the tenant.", + "type": "integer" + }, + "prevent_global_search": { + "type": "boolean" + } + }, + "required": [ + "description", + "industry", + "name", + "number_of_employees" + ], + "type": "object" + }, + "UserTenantAccessRequest": { + "properties": { + "users": { + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/UserTenantAccess" + } + ], + "description": "User given access to a tenant.", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "UserTenantAccess": { + "properties": { + "user_id": { + "description": "The ID of the user to add to the tenant", + "type": "integer" + }, + "is_readonly": { + "description": "Access given to the user for the tenant", + "type": "boolean" + }, + "role": { + "description": "Role given to the user for the tenant", + "enum": [ + "viewer", + "editor", + "admin" + ], + "example": "viewer", + "type": "string" + } + }, + "required": [ + "user_id" + ], + "type": "object" + }, + "TenantUsers": { + "properties": { + "next": { + "type": "integer" + }, + "items": { + "$ref": "#/components/schemas/TenantUser" + } + }, + "type": "object" + }, + "TenantUser": { + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "surname": { + "type": "string" + }, + "email": { + "type": "string" + }, + "is_readonly": { + "type": "boolean" + }, + "role": { + "enum": [ + "viewer", + "editor", + "admin" + ], + "example": "viewer", + "type": "string" + }, + "is_disabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "NewReport": { + "properties": { + "title": { + "type": "string" + }, + "author": { + "type": "string" + }, + "elements": { + "items": { + "$ref": "#/components/schemas/ReportElementUpdate" + }, + "type": "array" + }, + "audience": { + "enum": [ + "technical", + "general" + ], + "example": "technical", + "type": "string" + } + }, + "required": [ + "author", + "title" + ], + "type": "object" + }, + "ReportElementUpdate": { + "properties": { + "id": { + "type": "integer" + }, + "position": { + "type": "integer" + }, + "enabled": { + "type": "boolean" + }, + "sort_by": { + "enum": [ + "custom", + "alphabetical", + "date" + ], + "example": "custom", + "type": "string" + }, + "time_interval": { + "type": "string" + } + }, + "type": "object" + }, + "UpdatedReport": { + "properties": { + "title": { + "type": "string" + }, + "author": { + "type": "string" + }, + "elements": { + "items": { + "$ref": "#/components/schemas/ReportElementUpdate" + }, + "type": "array" + }, + "audience": { + "enum": [ + "technical", + "general" + ], + "example": "technical", + "type": "string" + } + }, + "type": "object" + }, + "get_activity_assistance_resource__activities__string_index___string_source___path_id__ai_assistance_200_response": { + "properties": { + "activity_ai_assistance": { + "$ref": "#/components/schemas/ActivityAiAssistance" + } + }, + "type": "object" + }, + "get_assets__assets__200_response": { + "properties": { + "assets": { + "$ref": "#/components/schemas/Identifier" + } + }, + "type": "object" + }, + "post_assets__assets__200_response": { + "properties": { + "asset": { + "$ref": "#/components/schemas/Identifier" + } + }, + "type": "object" + }, + "get_assets_groups__assets_groups__200_response": { + "properties": { + "assets_groups": { + "$ref": "#/components/schemas/IdentifierGroup" + } + }, + "type": "object" + }, + "post_assets_groups__assets_groups__200_response": { + "properties": { + "assets_group": { + "$ref": "#/components/schemas/IdentifierGroup" + } + }, + "type": "object" + }, + "get_assets_group_alerts__assets_groups__int_assets_group_id__alerts_200_response": { + "properties": { + "alerts": { + "$ref": "#/components/schemas/FeedAlert" + } + }, + "type": "object" + }, + "put_current_user_profile__me_profile_200_response": { + "properties": { + "profile": { + "$ref": "#/components/schemas/UserProfile" + } + }, + "type": "object" + }, + "post_organization_members_api__organizations__int_organization_id__members_200_response": { + "properties": { + "member": { + "$ref": "#/components/schemas/OrganizationMemberWithMetadata" + } + }, + "type": "object" + }, + "UserProfile_allOf_feature_flags": { + "properties": {}, + "type": "object" + } + }, + "securitySchemes": { + "BearerAuth": { + "type": "http", + "scheme": "bearer" + } + } + }, + "x-original-swagger-version": "2.0" +} \ No newline at end of file diff --git a/docs/api-reference/spec/firework-v2-swagger.json b/docs/api-reference/spec/firework-v2-swagger.json index e69de29b..779d8fbe 100644 --- a/docs/api-reference/spec/firework-v2-swagger.json +++ b/docs/api-reference/spec/firework-v2-swagger.json @@ -0,0 +1,6975 @@ +{ + "swagger": "2.0", + "basePath": "/", + "paths": { + "/firework/v2/activities/": { + "get": { + "responses": { + "200": { + "description": "Returns the activity" + }, + "404": { + "description": "Activity not found", + "schema": { + "$ref": "#/definitions/HttpError" + } + } + }, + "operationId": "get_activity_endpoint_/activities/", + "parameters": [ + { + "name": "uid", + "in": "query", + "type": "string", + "required": true + } + ], + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/actor/profile/{actor_name}": { + "parameters": [ + { + "name": "actor_name", + "in": "path", + "required": true, + "type": "string" + } + ], + "get": { + "responses": { + "200": { + "description": "Returns the actor" + } + }, + "operationId": "get_actor_/activities/actor/profile/", + "parameters": [ + { + "name": "actor_time", + "in": "query", + "type": "string", + "description": " Limit results to those found in this time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z" + }, + { + "name": "actor_size", + "in": "query", + "type": "integer", + "description": "Maximum number of hits returned per query.", + "default": 100 + }, + { + "name": "actor_search_after", + "in": "query", + "type": "string", + "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, use the latest response's `search_after` attribute for the next request to get the next page of results." + } + ], + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/document/{source}/{id}/extensions": { + "parameters": [ + { + "name": "source", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string" + } + ], + "get": { + "responses": { + "200": { + "description": "Returns all the different file extensions that were found in the files of a ransom leak." + }, + "404": { + "description": "Activity not found", + "schema": { + "$ref": "#/definitions/HttpError" + } + } + }, + "operationId": "get_ransom_leak_file_extensions_endpoint_/activities/document///extensions", + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/document/{source}/{id}/files": { + "parameters": [ + { + "name": "source", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string" + } + ], + "get": { + "responses": { + "200": { + "description": "Returns the files in a ransom leak matching the specified query" + }, + "404": { + "description": "Activity not found", + "schema": { + "$ref": "#/definitions/HttpError" + } + } + }, + "operationId": "get_ransom_leak_files_endpoint_/activities/document///files", + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/leak/{source}/{keyword}": { + "parameters": [ + { + "name": "source", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "keyword", + "in": "path", + "required": true, + "type": "string" + } + ], + "get": { + "responses": { + "200": { + "description": "Returns the leak activity" + }, + "404": { + "description": "Leak activity not found", + "schema": { + "$ref": "#/definitions/HttpError" + } + } + }, + "operationId": "get_leak_endpoint_/activities/leak//", + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/leak/{source}/{keyword}/count": { + "parameters": [ + { + "name": "source", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "keyword", + "in": "path", + "required": true, + "type": "string" + } + ], + "get": { + "responses": { + "200": { + "description": "Success" + } + }, + "operationId": "get_leak_count_/activities/leak///count", + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id_}/user_metadata": { + "parameters": [ + { + "name": "index", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "source", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "id_", + "in": "path", + "required": true, + "type": "string" + } + ], + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ActivityUserMetadata" + } + } + }, + "operationId": "get_activity_user_metadata_resource_/activities////user_metadata", + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id_}/user_metadata/ignored": { + "parameters": [ + { + "name": "index", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "source", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "id_", + "in": "path", + "required": true, + "type": "string" + } + ], + "put": { + "responses": { + "400": { + "description": "Query is invalid.", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ActivityUserMetadata" + } + } + }, + "operationId": "put_activity_user_metadata_ignored_/activities////user_metadata/ignored", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/ActivityUserMetadataIgnored" + } + } + ], + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id_}/user_metadata/notes": { + "parameters": [ + { + "name": "index", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "source", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "id_", + "in": "path", + "required": true, + "type": "string" + } + ], + "put": { + "responses": { + "400": { + "description": "Query is invalid.", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ActivityUserMetadata" + } + } + }, + "operationId": "put_activity_user_metadata_notes_/activities////user_metadata/notes", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/ActivityUserNotes" + } + } + ], + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id_}/user_metadata/remediated": { + "parameters": [ + { + "name": "index", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "source", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "id_", + "in": "path", + "required": true, + "type": "string" + } + ], + "put": { + "responses": { + "400": { + "description": "Query is invalid.", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ActivityUserMetadata" + } + } + }, + "operationId": "put_activity_user_metadata_remediated_/activities////user_metadata/remediated", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/ActivityUserMetadataRemediated" + } + } + ], + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id_}/user_metadata/risk_score": { + "parameters": [ + { + "name": "index", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "source", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "id_", + "in": "path", + "required": true, + "type": "string" + } + ], + "put": { + "responses": { + "400": { + "description": "Query is invalid.", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ActivityUserMetadata" + } + } + }, + "operationId": "put_activity_user_metadata_risk_score_/activities////user_metadata/risk_score", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/ActivityUserRiskScore" + } + } + ], + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id_}/user_metadata/tags": { + "parameters": [ + { + "name": "index", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "source", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "id_", + "in": "path", + "required": true, + "type": "string" + } + ], + "put": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ActivityUserMetadata" + } + }, + "400": { + "description": "Query is invalid.", + "schema": { + "$ref": "#/definitions/HttpError" + } + } + }, + "operationId": "put_activity_user_metadata_tags_/activities////user_metadata/tags", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/ActivityUserTags" + } + } + ], + "tags": [ + "activities" + ] + }, + "delete": { + "responses": { + "200": { + "description": "Success" + } + }, + "operationId": "delete_activity_user_metadata_tags_/activities////user_metadata/tags", + "tags": [ + "activities" + ] + }, + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ActivityUserMetadata" + } + } + }, + "operationId": "get_activity_user_metadata_tags_/activities////user_metadata/tags", + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id}": { + "parameters": [ + { + "name": "index", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "source", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string" + } + ], + "get": { + "responses": { + "200": { + "description": "Returns the activity" + }, + "404": { + "description": "Activity not found", + "schema": { + "$ref": "#/definitions/HttpError" + } + } + }, + "operationId": "get_activity_endpoint_deprecated_/activities///", + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id}/ai_assistance": { + "parameters": [ + { + "name": "index", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "source", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string" + } + ], + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "properties": { + "activity_ai_assistance": { + "$ref": "#/definitions/ActivityAiAssistance" + } + } + } + } + }, + "operationId": "get_activity_assistance_resource_/activities////ai_assistance", + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id}/enrichment": { + "parameters": [ + { + "name": "index", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "source", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string" + } + ], + "get": { + "responses": { + "200": { + "description": "Returns the activity enrichment" + }, + "404": { + "description": "Activity not found", + "schema": { + "$ref": "#/definitions/HttpError" + } + } + }, + "operationId": "get_activity_enrichment_endpoint_/activities////enrichment", + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id}/events": { + "parameters": [ + { + "name": "index", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "source", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string" + } + ], + "get": { + "responses": { + "200": { + "description": "Returns events associated with the entity" + } + }, + "operationId": "get_entity_events_/activities////events", + "parameters": [ + { + "name": "from", + "in": "query", + "type": "integer", + "description": "Start from this key when paginating events." + }, + { + "name": "size", + "in": "query", + "type": "integer", + "description": "Limit the events per page.", + "default": 100 + } + ], + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id}/highlights": { + "parameters": [ + { + "name": "index", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "source", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string" + } + ], + "post": { + "responses": { + "200": { + "description": "Returns the highlights of an activity" + }, + "404": { + "description": "Activity not found", + "schema": { + "$ref": "#/definitions/HttpError" + } + } + }, + "operationId": "post_activity_highlights_/activities////highlights", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/HighlightPayload" + } + } + ], + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id}/leaked_data": { + "parameters": [ + { + "name": "index", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "source", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string" + } + ], + "get": { + "responses": { + "404": { + "description": "Activity not found", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "200": { + "description": "Returns the related leaked_data" + } + }, + "operationId": "get_leaked_data_/activities////leaked_data", + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id}/messages": { + "parameters": [ + { + "name": "index", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "source", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string" + } + ], + "get": { + "responses": { + "200": { + "description": "Returns the related messages" + }, + "404": { + "description": "Activity not found", + "schema": { + "$ref": "#/definitions/HttpError" + } + } + }, + "operationId": "get_activity_messages_/activities////messages", + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id}/parent_chat_data": { + "parameters": [ + { + "name": "index", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "source", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string" + } + ], + "get": { + "responses": { + "404": { + "description": "Activity not found", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "200": { + "description": "Returns the related parent_uids data" + } + }, + "operationId": "get_parent_activity_data_/activities////parent_chat_data", + "tags": [ + "activities" + ] + } + }, + "/firework/v2/activities/{index}/{source}/{id}/related/{context}": { + "parameters": [ + { + "name": "index", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "source", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "context", + "in": "path", + "required": true, + "type": "string" + } + ], + "get": { + "responses": { + "400": { + "description": "Activity have no related items", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "404": { + "description": "Activity not found", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "200": { + "description": "Returns related activities" + } + }, + "operationId": "get_related_items_/activities////related/", + "parameters": [ + { + "name": "identifier_ids", + "in": "query", + "type": "array", + "description": "ID of an identifier.", + "items": { + "type": "integer" + }, + "collectionFormat": "multi" + } + ], + "tags": [ + "activities" + ] + } + }, + "/firework/v2/assets/": { + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "properties": { + "assets": { + "$ref": "#/definitions/Identifier" + } + } + } + } + }, + "operationId": "get_assets_/assets/", + "tags": [ + "Identifiers" + ] + }, + "post": { + "responses": { + "200": { + "description": "Success", + "schema": { + "properties": { + "asset": { + "$ref": "#/definitions/Identifier" + } + } + } + }, + "400": { + "description": "Query is invalid.", + "schema": { + "$ref": "#/definitions/HttpError" + } + } + }, + "operationId": "post_assets_/assets/", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/IdentifierCreate" + } + } + ], + "tags": [ + "Identifiers" + ] + } + }, + "/firework/v2/assets/groups/": { + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "properties": { + "assets_groups": { + "$ref": "#/definitions/IdentifierGroup" + } + } + } + } + }, + "operationId": "get_assets_groups_/assets/groups/", + "tags": [ + "Identifiers" + ] + }, + "post": { + "responses": { + "200": { + "description": "Success", + "schema": { + "properties": { + "assets_group": { + "$ref": "#/definitions/IdentifierGroup" + } + } + } + }, + "400": { + "description": "Query is invalid.", + "schema": { + "$ref": "#/definitions/HttpError" + } + } + }, + "operationId": "post_assets_groups_/assets/groups/", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/IdentifierGroup" + } + } + ], + "tags": [ + "Identifiers" + ] + } + }, + "/firework/v2/assets/groups/{assets_group_id}": { + "parameters": [ + { + "name": "assets_group_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "put": { + "responses": { + "200": { + "description": "Success", + "schema": { + "properties": { + "assets_group": { + "$ref": "#/definitions/IdentifierGroup" + } + } + } + }, + "400": { + "description": "Query is invalid.", + "schema": { + "$ref": "#/definitions/HttpError" + } + } + }, + "operationId": "put_assets_group_api_/assets/groups/", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/UpdateGroupData" + } + } + ], + "tags": [ + "Identifiers" + ] + }, + "delete": { + "responses": { + "200": { + "description": "Success" + } + }, + "operationId": "delete_assets_group_api_/assets/groups/", + "tags": [ + "Identifiers" + ] + }, + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "properties": { + "assets_group": { + "$ref": "#/definitions/IdentifierGroup" + } + } + } + } + }, + "operationId": "get_assets_group_api_/assets/groups/", + "tags": [ + "Identifiers" + ] + } + }, + "/firework/v2/assets/groups/{assets_group_id}/alerts": { + "parameters": [ + { + "name": "assets_group_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "properties": { + "alerts": { + "$ref": "#/definitions/FeedAlert" + } + } + } + } + }, + "operationId": "get_assets_group_alerts_/assets/groups//alerts", + "tags": [ + "Identifiers" + ] + }, + "post": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeedAlert" + } + } + }, + "operationId": "post_assets_group_alerts_/assets/groups//alerts", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/FeedAlert" + } + } + ], + "tags": [ + "Identifiers" + ] + } + }, + "/firework/v2/assets/groups/{assets_group_id}/alerts/{alert_id}": { + "parameters": [ + { + "name": "assets_group_id", + "in": "path", + "required": true, + "type": "integer" + }, + { + "name": "alert_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "put": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeedAlert" + } + } + }, + "operationId": "put_assets_group_alert_/assets/groups//alerts/", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/FeedAlert" + } + } + ], + "tags": [ + "Identifiers" + ] + }, + "delete": { + "responses": { + "200": { + "description": "Success" + } + }, + "operationId": "delete_assets_group_alert_/assets/groups//alerts/", + "tags": [ + "Identifiers" + ] + } + }, + "/firework/v2/assets/groups/{assets_group_id}/feed": { + "parameters": [ + { + "name": "assets_group_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "get": { + "responses": { + "404": { + "description": "Identifier group does not exist.", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "400": { + "description": "Query is invalid.", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "200": { + "description": "Returns the search result(s).", + "schema": { + "$ref": "#/definitions/Search" + } + } + }, + "operationId": "get_assets_group_feed_/assets/groups//feed", + "parameters": [ + { + "name": "fields", + "in": "query", + "type": "array", + "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "time", + "in": "query", + "type": "string", + "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z" + }, + { + "name": "size", + "in": "query", + "type": "integer", + "description": "The `size` parameter is used to limit the number of results returned for the search query.", + "default": 10 + }, + { + "name": "search_after", + "in": "query", + "type": "string", + "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results." + }, + { + "name": "from", + "in": "query", + "type": "string", + "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results." + }, + { + "name": "tags", + "in": "query", + "type": "array", + "description": "User defined tags used to filter search results", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "tags_query_operator", + "in": "query", + "type": "string", + "description": "User defined operator to apply to tags filter" + }, + { + "name": "types", + "in": "query", + "type": "array", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "enum": [ + "attachment", + "listing", + "ransomleak", + "forum_post", + "forum_topic", + "forum_profile", + "blog_post", + "seller", + "paste", + "leak", + "chat_message", + "domain", + "bot", + "stealer_log", + "infected_devices", + "driller", + "driller_forum_topic", + "driller_forum_post", + "driller_profile", + "cc", + "ccbin", + "financial_data", + "leaked_data", + "leaked_file", + "document", + "account", + "actor", + "forum_content", + "blog_content", + "profile", + "leaked_credential", + "valid_credential", + "invalid_credential", + "mitigated_credential", + "illicit_networks", + "open_web", + "domains", + "intelligence_object", + "leaks", + "social_media_account", + "social_media", + "source_code", + "source_code_secrets_np", + "source_code_secrets", + "source_code_files", + "secret", + "docker", + "stack_exchange", + "google", + "service", + "driller_host", + "buckets", + "bucket", + "bucket_object", + "whois", + "ad", + "ads", + "cookie", + "pii", + "experimental" + ] + }, + { + "name": "experimental_types", + "in": "query", + "type": "array", + "description": "Type of experimental activities to search through.", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "event_action", + "in": "query", + "type": "string", + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ] + }, + { + "name": "event_actions", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ] + }, + { + "name": "risks", + "in": "query", + "type": "array", + "items": { + "type": "integer" + }, + "collectionFormat": "multi", + "enum": [ + 1, + 2, + 3, + 4, + 5 + ] + }, + { + "name": "order", + "in": "query", + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + { + "name": "sort_by", + "in": "query", + "type": "string", + "default": "created", + "enum": [ + "created", + "indexed", + "updated", + "alertable-materialized", + "materialized", + "searchable" + ] + }, + { + "name": "use_global_policies", + "in": "query", + "type": "boolean", + "default": true + }, + { + "name": "time_zone", + "in": "query", + "type": "string", + "description": "The time zone used to compute the statistics." + }, + { + "name": "query", + "in": "query", + "type": "string", + "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax." + }, + { + "name": "has_modified_risk_score", + "in": "query", + "type": "boolean", + "default": false + }, + { + "name": "has_notes", + "in": "query", + "type": "boolean", + "default": false + } + ], + "tags": [ + "Identifiers" + ] + }, + "post": { + "responses": { + "404": { + "description": "Identifier group does not exist.", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "400": { + "description": "Query is invalid.", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "200": { + "description": "Returns the search result(s).", + "schema": { + "$ref": "#/definitions/Search" + } + } + }, + "operationId": "post_assets_group_feed_/assets/groups//feed", + "parameters": [ + { + "name": "fields", + "in": "query", + "type": "array", + "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "time", + "in": "query", + "type": "string", + "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z" + }, + { + "name": "size", + "in": "query", + "type": "integer", + "description": "The `size` parameter is used to limit the number of results returned for the search query.", + "default": 10 + }, + { + "name": "search_after", + "in": "query", + "type": "string", + "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results." + }, + { + "name": "from", + "in": "query", + "type": "string", + "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results." + }, + { + "name": "tags", + "in": "query", + "type": "array", + "description": "User defined tags used to filter search results", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "tags_query_operator", + "in": "query", + "type": "string", + "description": "User defined operator to apply to tags filter" + }, + { + "name": "types", + "in": "query", + "type": "array", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "enum": [ + "attachment", + "listing", + "ransomleak", + "forum_post", + "forum_topic", + "forum_profile", + "blog_post", + "seller", + "paste", + "leak", + "chat_message", + "domain", + "bot", + "stealer_log", + "infected_devices", + "driller", + "driller_forum_topic", + "driller_forum_post", + "driller_profile", + "cc", + "ccbin", + "financial_data", + "leaked_data", + "leaked_file", + "document", + "account", + "actor", + "forum_content", + "blog_content", + "profile", + "leaked_credential", + "valid_credential", + "invalid_credential", + "mitigated_credential", + "illicit_networks", + "open_web", + "domains", + "intelligence_object", + "leaks", + "social_media_account", + "social_media", + "source_code", + "source_code_secrets_np", + "source_code_secrets", + "source_code_files", + "secret", + "docker", + "stack_exchange", + "google", + "service", + "driller_host", + "buckets", + "bucket", + "bucket_object", + "whois", + "ad", + "ads", + "cookie", + "pii", + "experimental" + ] + }, + { + "name": "experimental_types", + "in": "query", + "type": "array", + "description": "Type of experimental activities to search through.", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "event_action", + "in": "query", + "type": "string", + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ] + }, + { + "name": "event_actions", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ] + }, + { + "name": "risks", + "in": "query", + "type": "array", + "items": { + "type": "integer" + }, + "collectionFormat": "multi", + "enum": [ + 1, + 2, + 3, + 4, + 5 + ] + }, + { + "name": "order", + "in": "query", + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + { + "name": "sort_by", + "in": "query", + "type": "string", + "default": "created", + "enum": [ + "created", + "indexed", + "updated", + "alertable-materialized", + "materialized", + "searchable" + ] + }, + { + "name": "use_global_policies", + "in": "query", + "type": "boolean", + "default": true + }, + { + "name": "time_zone", + "in": "query", + "type": "string", + "description": "The time zone used to compute the statistics." + }, + { + "name": "query", + "in": "query", + "type": "string", + "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax." + }, + { + "name": "has_modified_risk_score", + "in": "query", + "type": "boolean", + "default": false + }, + { + "name": "has_notes", + "in": "query", + "type": "boolean", + "default": false + } + ], + "tags": [ + "Identifiers" + ] + } + }, + "/firework/v2/assets/{asset_id}": { + "parameters": [ + { + "name": "asset_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "put": { + "responses": { + "400": { + "description": "Query is invalid.", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "200": { + "description": "Success", + "schema": { + "properties": { + "asset": { + "$ref": "#/definitions/Identifier" + } + } + } + } + }, + "operationId": "put_asset_api_/assets/", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/Identifier" + } + } + ], + "tags": [ + "Identifiers" + ] + }, + "delete": { + "responses": { + "200": { + "description": "Success" + } + }, + "operationId": "delete_asset_api_/assets/", + "tags": [ + "Identifiers" + ] + }, + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "properties": { + "asset": { + "$ref": "#/definitions/Identifier" + } + } + } + } + }, + "operationId": "get_asset_api_/assets/", + "tags": [ + "Identifiers" + ] + } + }, + "/firework/v2/assets/{asset_id}/alerts": { + "parameters": [ + { + "name": "asset_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "properties": { + "alerts": { + "$ref": "#/definitions/FeedAlert" + } + } + } + } + }, + "operationId": "get_asset_alerts_/assets//alerts", + "tags": [ + "Identifiers" + ] + }, + "post": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeedAlert" + } + } + }, + "operationId": "post_asset_alerts_/assets//alerts", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/FeedAlert" + } + } + ], + "tags": [ + "Identifiers" + ] + } + }, + "/firework/v2/assets/{asset_id}/alerts/{alert_id}": { + "parameters": [ + { + "name": "asset_id", + "in": "path", + "required": true, + "type": "integer" + }, + { + "name": "alert_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "put": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeedAlert" + } + } + }, + "operationId": "put_asset_alert_/assets//alerts/", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/FeedAlert" + } + } + ], + "tags": [ + "Identifiers" + ] + }, + "delete": { + "responses": { + "200": { + "description": "Success" + } + }, + "operationId": "delete_asset_alert_/assets//alerts/", + "tags": [ + "Identifiers" + ] + } + }, + "/firework/v2/assets/{asset_id}/feed": { + "parameters": [ + { + "name": "asset_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "get": { + "responses": { + "404": { + "description": "Identifier does not exist.", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "400": { + "description": "Query is invalid.", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "200": { + "description": "Returns the search result(s).", + "schema": { + "$ref": "#/definitions/Search" + } + } + }, + "operationId": "get_asset_feed_/assets//feed", + "parameters": [ + { + "name": "fields", + "in": "query", + "type": "array", + "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "time", + "in": "query", + "type": "string", + "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z" + }, + { + "name": "size", + "in": "query", + "type": "integer", + "description": "The `size` parameter is used to limit the number of results returned for the search query.", + "default": 10 + }, + { + "name": "search_after", + "in": "query", + "type": "string", + "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results." + }, + { + "name": "from", + "in": "query", + "type": "string", + "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results." + }, + { + "name": "tags", + "in": "query", + "type": "array", + "description": "User defined tags used to filter search results", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "tags_query_operator", + "in": "query", + "type": "string", + "description": "User defined operator to apply to tags filter" + }, + { + "name": "types", + "in": "query", + "type": "array", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "enum": [ + "attachment", + "listing", + "ransomleak", + "forum_post", + "forum_topic", + "forum_profile", + "blog_post", + "seller", + "paste", + "leak", + "chat_message", + "domain", + "bot", + "stealer_log", + "infected_devices", + "driller", + "driller_forum_topic", + "driller_forum_post", + "driller_profile", + "cc", + "ccbin", + "financial_data", + "leaked_data", + "leaked_file", + "document", + "account", + "actor", + "forum_content", + "blog_content", + "profile", + "leaked_credential", + "valid_credential", + "invalid_credential", + "mitigated_credential", + "illicit_networks", + "open_web", + "domains", + "intelligence_object", + "leaks", + "social_media_account", + "social_media", + "source_code", + "source_code_secrets_np", + "source_code_secrets", + "source_code_files", + "secret", + "docker", + "stack_exchange", + "google", + "service", + "driller_host", + "buckets", + "bucket", + "bucket_object", + "whois", + "ad", + "ads", + "cookie", + "pii", + "experimental" + ] + }, + { + "name": "experimental_types", + "in": "query", + "type": "array", + "description": "Type of experimental activities to search through.", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "event_action", + "in": "query", + "type": "string", + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ] + }, + { + "name": "event_actions", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ] + }, + { + "name": "risks", + "in": "query", + "type": "array", + "items": { + "type": "integer" + }, + "collectionFormat": "multi", + "enum": [ + 1, + 2, + 3, + 4, + 5 + ] + }, + { + "name": "order", + "in": "query", + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + { + "name": "sort_by", + "in": "query", + "type": "string", + "default": "created", + "enum": [ + "created", + "indexed", + "updated", + "alertable-materialized", + "materialized", + "searchable" + ] + }, + { + "name": "use_global_policies", + "in": "query", + "type": "boolean", + "default": true + }, + { + "name": "time_zone", + "in": "query", + "type": "string", + "description": "The time zone used to compute the statistics." + }, + { + "name": "query", + "in": "query", + "type": "string", + "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax." + }, + { + "name": "has_modified_risk_score", + "in": "query", + "type": "boolean", + "default": false + }, + { + "name": "has_notes", + "in": "query", + "type": "boolean", + "default": false + } + ], + "tags": [ + "Identifiers" + ] + }, + "post": { + "responses": { + "404": { + "description": "Identifier does not exist.", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "400": { + "description": "Query is invalid.", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "200": { + "description": "Returns the search result(s).", + "schema": { + "$ref": "#/definitions/Search" + } + } + }, + "operationId": "post_asset_feed_/assets//feed", + "parameters": [ + { + "name": "fields", + "in": "query", + "type": "array", + "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "time", + "in": "query", + "type": "string", + "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z" + }, + { + "name": "size", + "in": "query", + "type": "integer", + "description": "The `size` parameter is used to limit the number of results returned for the search query.", + "default": 10 + }, + { + "name": "search_after", + "in": "query", + "type": "string", + "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results." + }, + { + "name": "from", + "in": "query", + "type": "string", + "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results." + }, + { + "name": "tags", + "in": "query", + "type": "array", + "description": "User defined tags used to filter search results", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "tags_query_operator", + "in": "query", + "type": "string", + "description": "User defined operator to apply to tags filter" + }, + { + "name": "types", + "in": "query", + "type": "array", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "enum": [ + "attachment", + "listing", + "ransomleak", + "forum_post", + "forum_topic", + "forum_profile", + "blog_post", + "seller", + "paste", + "leak", + "chat_message", + "domain", + "bot", + "stealer_log", + "infected_devices", + "driller", + "driller_forum_topic", + "driller_forum_post", + "driller_profile", + "cc", + "ccbin", + "financial_data", + "leaked_data", + "leaked_file", + "document", + "account", + "actor", + "forum_content", + "blog_content", + "profile", + "leaked_credential", + "valid_credential", + "invalid_credential", + "mitigated_credential", + "illicit_networks", + "open_web", + "domains", + "intelligence_object", + "leaks", + "social_media_account", + "social_media", + "source_code", + "source_code_secrets_np", + "source_code_secrets", + "source_code_files", + "secret", + "docker", + "stack_exchange", + "google", + "service", + "driller_host", + "buckets", + "bucket", + "bucket_object", + "whois", + "ad", + "ads", + "cookie", + "pii", + "experimental" + ] + }, + { + "name": "experimental_types", + "in": "query", + "type": "array", + "description": "Type of experimental activities to search through.", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "event_action", + "in": "query", + "type": "string", + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ] + }, + { + "name": "event_actions", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ] + }, + { + "name": "risks", + "in": "query", + "type": "array", + "items": { + "type": "integer" + }, + "collectionFormat": "multi", + "enum": [ + 1, + 2, + 3, + 4, + 5 + ] + }, + { + "name": "order", + "in": "query", + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + { + "name": "sort_by", + "in": "query", + "type": "string", + "default": "created", + "enum": [ + "created", + "indexed", + "updated", + "alertable-materialized", + "materialized", + "searchable" + ] + }, + { + "name": "use_global_policies", + "in": "query", + "type": "boolean", + "default": true + }, + { + "name": "time_zone", + "in": "query", + "type": "string", + "description": "The time zone used to compute the statistics." + }, + { + "name": "query", + "in": "query", + "type": "string", + "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax." + }, + { + "name": "has_modified_risk_score", + "in": "query", + "type": "boolean", + "default": false + }, + { + "name": "has_notes", + "in": "query", + "type": "boolean", + "default": false + } + ], + "tags": [ + "Identifiers" + ] + } + }, + "/firework/v2/assets/{asset_id}/highlights/{index}/{source}/{id}": { + "parameters": [ + { + "name": "asset_id", + "in": "path", + "required": true, + "type": "integer" + }, + { + "name": "index", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "source", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string" + } + ], + "get": { + "responses": { + "200": { + "description": "Returns the highlights of the identifier data matching on an activity content." + }, + "404": { + "description": "Identifier or activity does not exist.", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "400": { + "description": "Query is invalid.", + "schema": { + "$ref": "#/definitions/HttpError" + } + } + }, + "operationId": "get_identifier_activity_highlights_/assets//highlights///", + "tags": [ + "Identifiers" + ] + } + }, + "/firework/v2/assets/{asset_id}/toggle": { + "parameters": [ + { + "name": "asset_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "post": { + "responses": { + "200": { + "description": "Success", + "schema": { + "properties": { + "asset": { + "$ref": "#/definitions/Identifier" + } + } + } + } + }, + "operationId": "post_identifier_toggle_/assets//toggle", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/IdentifierToggle" + } + } + ], + "tags": [ + "Identifiers" + ] + } + }, + "/firework/v2/me/feed": { + "get": { + "responses": { + "200": { + "description": "The user's home feed activities", + "schema": { + "$ref": "#/definitions/Search" + } + } + }, + "operationId": "get_current_user_home_feed_/me/feed", + "parameters": [ + { + "name": "time", + "in": "query", + "type": "string", + "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z" + }, + { + "name": "size", + "in": "query", + "type": "integer", + "description": "The `size` parameter is used to limit the number of results returned for the search query.", + "default": 10 + }, + { + "name": "search_after", + "in": "query", + "type": "string", + "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results." + }, + { + "name": "from", + "in": "query", + "type": "string", + "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results." + }, + { + "name": "tags", + "in": "query", + "type": "array", + "description": "User defined tags used to filter search results", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "tags_query_operator", + "in": "query", + "type": "string", + "description": "User defined operator to apply to tags filter" + }, + { + "name": "types", + "in": "query", + "type": "array", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "enum": [ + "attachment", + "listing", + "ransomleak", + "forum_post", + "forum_topic", + "forum_profile", + "blog_post", + "seller", + "paste", + "leak", + "chat_message", + "domain", + "bot", + "stealer_log", + "infected_devices", + "driller", + "driller_forum_topic", + "driller_forum_post", + "driller_profile", + "cc", + "ccbin", + "financial_data", + "leaked_data", + "leaked_file", + "document", + "account", + "actor", + "forum_content", + "blog_content", + "profile", + "leaked_credential", + "valid_credential", + "invalid_credential", + "mitigated_credential", + "illicit_networks", + "open_web", + "domains", + "intelligence_object", + "leaks", + "social_media_account", + "social_media", + "source_code", + "source_code_secrets_np", + "source_code_secrets", + "source_code_files", + "secret", + "docker", + "stack_exchange", + "google", + "service", + "driller_host", + "buckets", + "bucket", + "bucket_object", + "whois", + "ad", + "ads", + "cookie", + "pii", + "experimental" + ] + }, + { + "name": "experimental_types", + "in": "query", + "type": "array", + "description": "Type of experimental activities to search through.", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "event_action", + "in": "query", + "type": "string", + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ] + }, + { + "name": "event_actions", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ] + }, + { + "name": "risks", + "in": "query", + "type": "array", + "items": { + "type": "integer" + }, + "collectionFormat": "multi", + "enum": [ + 1, + 2, + 3, + 4, + 5 + ] + }, + { + "name": "order", + "in": "query", + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + { + "name": "sort_by", + "in": "query", + "type": "string", + "default": "created", + "enum": [ + "created", + "indexed", + "updated", + "alertable-materialized", + "materialized", + "searchable" + ] + }, + { + "name": "use_global_policies", + "in": "query", + "type": "boolean", + "default": true + }, + { + "name": "time_zone", + "in": "query", + "type": "string", + "description": "The time zone used to compute the statistics." + }, + { + "name": "query", + "in": "query", + "type": "string", + "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax." + }, + { + "name": "has_modified_risk_score", + "in": "query", + "type": "boolean", + "default": false + }, + { + "name": "has_notes", + "in": "query", + "type": "boolean", + "default": false + } + ], + "tags": [ + "me" + ] + }, + "post": { + "responses": { + "200": { + "description": "The user's home feed activities", + "schema": { + "$ref": "#/definitions/Search" + } + } + }, + "operationId": "post_current_user_home_feed_/me/feed", + "parameters": [ + { + "name": "time", + "in": "query", + "type": "string", + "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z" + }, + { + "name": "size", + "in": "query", + "type": "integer", + "description": "The `size` parameter is used to limit the number of results returned for the search query.", + "default": 10 + }, + { + "name": "search_after", + "in": "query", + "type": "string", + "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results." + }, + { + "name": "from", + "in": "query", + "type": "string", + "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results." + }, + { + "name": "tags", + "in": "query", + "type": "array", + "description": "User defined tags used to filter search results", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "tags_query_operator", + "in": "query", + "type": "string", + "description": "User defined operator to apply to tags filter" + }, + { + "name": "types", + "in": "query", + "type": "array", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "enum": [ + "attachment", + "listing", + "ransomleak", + "forum_post", + "forum_topic", + "forum_profile", + "blog_post", + "seller", + "paste", + "leak", + "chat_message", + "domain", + "bot", + "stealer_log", + "infected_devices", + "driller", + "driller_forum_topic", + "driller_forum_post", + "driller_profile", + "cc", + "ccbin", + "financial_data", + "leaked_data", + "leaked_file", + "document", + "account", + "actor", + "forum_content", + "blog_content", + "profile", + "leaked_credential", + "valid_credential", + "invalid_credential", + "mitigated_credential", + "illicit_networks", + "open_web", + "domains", + "intelligence_object", + "leaks", + "social_media_account", + "social_media", + "source_code", + "source_code_secrets_np", + "source_code_secrets", + "source_code_files", + "secret", + "docker", + "stack_exchange", + "google", + "service", + "driller_host", + "buckets", + "bucket", + "bucket_object", + "whois", + "ad", + "ads", + "cookie", + "pii", + "experimental" + ] + }, + { + "name": "experimental_types", + "in": "query", + "type": "array", + "description": "Type of experimental activities to search through.", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "event_action", + "in": "query", + "type": "string", + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ] + }, + { + "name": "event_actions", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ] + }, + { + "name": "risks", + "in": "query", + "type": "array", + "items": { + "type": "integer" + }, + "collectionFormat": "multi", + "enum": [ + 1, + 2, + 3, + 4, + 5 + ] + }, + { + "name": "order", + "in": "query", + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + { + "name": "sort_by", + "in": "query", + "type": "string", + "default": "created", + "enum": [ + "created", + "indexed", + "updated", + "alertable-materialized", + "materialized", + "searchable" + ] + }, + { + "name": "use_global_policies", + "in": "query", + "type": "boolean", + "default": true + }, + { + "name": "time_zone", + "in": "query", + "type": "string", + "description": "The time zone used to compute the statistics." + }, + { + "name": "query", + "in": "query", + "type": "string", + "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax." + }, + { + "name": "has_modified_risk_score", + "in": "query", + "type": "boolean", + "default": false + }, + { + "name": "has_notes", + "in": "query", + "type": "boolean", + "default": false + } + ], + "tags": [ + "me" + ] + } + }, + "/firework/v2/me/feed/credentials": { + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PaginatedCredentials" + } + } + }, + "operationId": "get_leaked_credentials_feed_endpoint_/me/feed/credentials", + "parameters": [ + { + "name": "size", + "in": "query", + "type": "integer", + "default": 20 + }, + { + "name": "from", + "in": "query", + "type": "string" + }, + { + "name": "order_type", + "in": "query", + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + } + ], + "tags": [ + "me" + ] + }, + "post": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PaginatedCredentials" + } + } + }, + "operationId": "post_leaked_credentials_feed_endpoint_/me/feed/credentials", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/UserUpdate" + } + } + ], + "tags": [ + "me" + ] + } + }, + "/firework/v2/me/profile": { + "put": { + "responses": { + "400": { + "description": "Update is invalid", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "200": { + "description": "Success", + "schema": { + "properties": { + "profile": { + "$ref": "#/definitions/UserProfile" + } + } + } + } + }, + "operationId": "put_current_user_profile_/me/profile", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/UserUpdate" + } + } + ], + "tags": [ + "me" + ] + }, + "get": { + "responses": { + "200": { + "description": "Returns the current user's profile" + } + }, + "operationId": "get_current_user_profile_/me/profile", + "tags": [ + "me" + ] + } + }, + "/firework/v2/me/tenants": { + "get": { + "responses": { + "200": { + "description": "Returns the current user's tenants." + } + }, + "operationId": "get_current_user_tenants_/me/tenants", + "tags": [ + "me" + ] + } + }, + "/firework/v2/organizations/{organization_id}/members": { + "parameters": [ + { + "name": "organization_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "get": { + "responses": { + "404": { + "description": "Organization not found", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OrganizationMemberPage" + } + } + }, + "operationId": "get_organization_members_api_/organizations//members", + "parameters": [ + { + "name": "size", + "in": "query", + "type": "integer", + "default": 20 + }, + { + "name": "from", + "in": "query", + "type": "string" + }, + { + "name": "q", + "in": "query", + "type": "string" + } + ], + "tags": [ + "organizations" + ] + }, + "post": { + "responses": { + "404": { + "description": "Organization not found", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "200": { + "description": "Success", + "schema": { + "properties": { + "member": { + "$ref": "#/definitions/OrganizationMemberWithMetadata" + } + } + } + } + }, + "operationId": "post_organization_members_api_/organizations//members", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/OrganizationMemberData" + } + } + ], + "tags": [ + "organizations" + ] + } + }, + "/firework/v2/organizations/{organization_id}/members/count": { + "parameters": [ + { + "name": "organization_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "get": { + "responses": { + "404": { + "description": "Organization not found", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OrganizationMembersCount" + } + } + }, + "operationId": "get_organization_members_count_api_/organizations//members/count", + "tags": [ + "organizations" + ] + } + }, + "/firework/v2/organizations/{organization_id}/members/{user_id}": { + "parameters": [ + { + "name": "organization_id", + "in": "path", + "required": true, + "type": "integer" + }, + { + "name": "user_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "put": { + "responses": { + "200": { + "description": "Success", + "schema": { + "properties": { + "member": { + "$ref": "#/definitions/OrganizationMemberWithMetadata" + } + } + } + } + }, + "operationId": "put_organization_member_api_/organizations//members/", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/OrganizationMember" + } + } + ], + "tags": [ + "organizations" + ] + }, + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "properties": { + "member": { + "$ref": "#/definitions/OrganizationMemberWithMetadata" + } + } + } + } + }, + "operationId": "get_organization_member_api_/organizations//members/", + "tags": [ + "organizations" + ] + } + }, + "/firework/v2/organizations/{organization_id}/members/{user_id}/disable": { + "parameters": [ + { + "name": "organization_id", + "in": "path", + "required": true, + "type": "integer" + }, + { + "name": "user_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "post": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnableState" + } + } + }, + "operationId": "post_organization_member_disable_/organizations//members//disable", + "tags": [ + "organizations" + ] + } + }, + "/firework/v2/organizations/{organization_id}/members/{user_id}/enable": { + "parameters": [ + { + "name": "organization_id", + "in": "path", + "required": true, + "type": "integer" + }, + { + "name": "user_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "post": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnableState" + } + } + }, + "operationId": "post_organization_member_enable_/organizations//members//enable", + "tags": [ + "organizations" + ] + } + }, + "/firework/v2/organizations/{organization_id}/members/{user_id}/permissions": { + "parameters": [ + { + "name": "organization_id", + "in": "path", + "required": true, + "type": "integer" + }, + { + "name": "user_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "post": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UpdatedPermission" + } + } + }, + "operationId": "post_organization_member_permissions_api_/organizations//members//permissions", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/PermissionData" + } + } + ], + "tags": [ + "organizations" + ] + } + }, + "/firework/v2/organizations/{organization_id}/members/{user_id}/tenants": { + "parameters": [ + { + "name": "organization_id", + "in": "path", + "required": true, + "type": "integer" + }, + { + "name": "user_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TenantWithCounts" + } + } + }, + "operationId": "get_organization_member_tenants_/organizations//members//tenants", + "parameters": [ + { + "name": "size", + "in": "query", + "type": "integer", + "default": 20 + }, + { + "name": "from", + "in": "query", + "type": "string" + }, + { + "name": "include_disabled_demo", + "in": "query", + "type": "boolean", + "default": false + }, + { + "name": "q", + "in": "query", + "type": "string" + }, + { + "name": "types[]", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "enum": [ + "regular", + "service-firm", + "micro", + "starter", + "essential", + "core", + "enterprise", + "demo", + "training" + ] + } + ], + "tags": [ + "organizations" + ] + } + }, + "/firework/v2/organizations/{organization_id}/tenants": { + "parameters": [ + { + "name": "organization_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TenantWithCounts" + } + } + }, + "operationId": "get_organization_tenants_api_/organizations//tenants", + "tags": [ + "organizations" + ] + }, + "post": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Tenant" + } + } + }, + "operationId": "post_organization_tenants_api_/organizations//tenants", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/NewTenantInfo" + } + } + ], + "tags": [ + "organizations" + ] + } + }, + "/firework/v2/reporting/reports": { + "get": { + "responses": { + "200": { + "description": "Lists reports for the current tenant, ordered from newest to oldest." + } + }, + "operationId": "get_reports_endpoint_/reporting/reports", + "tags": [ + "reporting" + ] + }, + "post": { + "responses": { + "200": { + "description": "Creates a new report on the current tenant." + } + }, + "operationId": "post_reports_endpoint_/reporting/reports", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/NewReport" + } + } + ], + "tags": [ + "reporting" + ] + } + }, + "/firework/v2/reporting/reports/{report_id}": { + "parameters": [ + { + "name": "report_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "patch": { + "responses": { + "200": { + "description": "Updates a report." + } + }, + "operationId": "patch_report_endpoint_/reporting/reports/", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/UpdatedReport" + } + } + ], + "tags": [ + "reporting" + ] + }, + "delete": { + "responses": { + "200": { + "description": "Deletes a report." + } + }, + "operationId": "delete_report_endpoint_/reporting/reports/", + "tags": [ + "reporting" + ] + }, + "get": { + "responses": { + "200": { + "description": "Returns a report and its elements." + } + }, + "operationId": "get_report_endpoint_/reporting/reports/", + "tags": [ + "reporting" + ] + } + }, + "/firework/v2/reporting/reports/{report_id}/archive": { + "parameters": [ + { + "name": "report_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "post": { + "responses": { + "200": { + "description": "Archives a report." + } + }, + "operationId": "post_archive_report_endpoint_/reporting/reports//archive", + "tags": [ + "reporting" + ] + } + }, + "/firework/v2/reporting/reports/{report_id}/download": { + "parameters": [ + { + "name": "report_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "get": { + "responses": { + "200": { + "description": "Download a report." + } + }, + "operationId": "get_report_download_endpoint_/reporting/reports//download", + "tags": [ + "reporting" + ] + } + }, + "/firework/v2/search/": { + "get": { + "responses": { + "400": { + "description": "Query is invalid.", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "200": { + "description": "Returns the search result(s).", + "schema": { + "$ref": "#/definitions/Search" + } + } + }, + "operationId": "get_search_/search/", + "parameters": [ + { + "name": "fields", + "in": "query", + "type": "array", + "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "time", + "in": "query", + "type": "string", + "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z" + }, + { + "name": "size", + "in": "query", + "type": "integer", + "description": "The `size` parameter is used to limit the number of results returned for the search query.", + "default": 10 + }, + { + "name": "search_after", + "in": "query", + "type": "string", + "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results." + }, + { + "name": "from", + "in": "query", + "type": "string", + "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results." + }, + { + "name": "tags", + "in": "query", + "type": "array", + "description": "User defined tags used to filter search results", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "tags_query_operator", + "in": "query", + "type": "string", + "description": "User defined operator to apply to tags filter" + }, + { + "name": "types", + "in": "query", + "type": "array", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "enum": [ + "attachment", + "listing", + "ransomleak", + "forum_post", + "forum_topic", + "forum_profile", + "blog_post", + "seller", + "paste", + "leak", + "chat_message", + "domain", + "bot", + "stealer_log", + "infected_devices", + "driller", + "driller_forum_topic", + "driller_forum_post", + "driller_profile", + "cc", + "ccbin", + "financial_data", + "leaked_data", + "leaked_file", + "document", + "account", + "actor", + "forum_content", + "blog_content", + "profile", + "leaked_credential", + "valid_credential", + "invalid_credential", + "mitigated_credential", + "illicit_networks", + "open_web", + "domains", + "intelligence_object", + "leaks", + "social_media_account", + "social_media", + "source_code", + "source_code_secrets_np", + "source_code_secrets", + "source_code_files", + "secret", + "docker", + "stack_exchange", + "google", + "service", + "driller_host", + "buckets", + "bucket", + "bucket_object", + "whois", + "cookie", + "pii", + "experimental" + ] + }, + { + "name": "experimental_types", + "in": "query", + "type": "array", + "description": "Type of experimental activities to search through.", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "event_action", + "in": "query", + "type": "string", + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ] + }, + { + "name": "event_actions", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ] + }, + { + "name": "risks", + "in": "query", + "type": "array", + "items": { + "type": "integer" + }, + "collectionFormat": "multi", + "enum": [ + 1, + 2, + 3, + 4, + 5 + ] + }, + { + "name": "order", + "in": "query", + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + { + "name": "sort_by", + "in": "query", + "type": "string", + "default": "created", + "enum": [ + "created", + "indexed", + "updated", + "alertable-materialized", + "materialized", + "searchable" + ] + }, + { + "name": "use_global_policies", + "in": "query", + "type": "boolean", + "default": true + }, + { + "name": "time_zone", + "in": "query", + "type": "string", + "description": "The time zone used to compute the statistics." + }, + { + "name": "query", + "in": "query", + "type": "string", + "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax." + }, + { + "name": "has_modified_risk_score", + "in": "query", + "type": "boolean", + "default": false + }, + { + "name": "has_notes", + "in": "query", + "type": "boolean", + "default": false + }, + { + "name": "labels", + "in": "query", + "type": "array", + "description": "Stealer log labels used to filter search results", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "enum": [ + "access_types", + "pii", + "facts", + "findings" + ] + } + ], + "tags": [ + "search" + ] + }, + "post": { + "responses": { + "400": { + "description": "Query is invalid.", + "schema": { + "$ref": "#/definitions/HttpError" + } + }, + "200": { + "description": "Returns the search result(s).", + "schema": { + "$ref": "#/definitions/Search" + } + } + }, + "operationId": "post_search_/search/", + "parameters": [ + { + "name": "fields", + "in": "query", + "type": "array", + "description": "Fields to includes in the results in a dotted form. For example, \"data.actor_name\" will include items similar to:```json\n \"items\": [{\n \"data\": {\n \"actor_name\": \"Seller123\"\n }\n }]\n ```\n\n By default, all fields are included in the response.\n ", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "time", + "in": "query", + "type": "string", + "description": " The `time` parameter is used to limit results to those found in the provided time span. \n\n *Expected format* : from@to \n\n *Example value* : 2019-09-03T04:00:00.000Z@2019-09-14T04:00:00.000Z" + }, + { + "name": "size", + "in": "query", + "type": "integer", + "description": "The `size` parameter is used to limit the number of results returned for the search query.", + "default": 10 + }, + { + "name": "search_after", + "in": "query", + "type": "string", + "description": "The `search_after` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `search_after` parameter in your next request with the latest response's `search_after` value to get the next page of results." + }, + { + "name": "from", + "in": "query", + "type": "string", + "description": "The `from` parameter is used to paginate through results. \n\nTo get the first page of results, omit this parameter. Afterward, include the `from` parameter in your next request with the latest response's `next` value to get the next page of results." + }, + { + "name": "tags", + "in": "query", + "type": "array", + "description": "User defined tags used to filter search results", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "tags_query_operator", + "in": "query", + "type": "string", + "description": "User defined operator to apply to tags filter" + }, + { + "name": "types", + "in": "query", + "type": "array", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "enum": [ + "attachment", + "listing", + "ransomleak", + "forum_post", + "forum_topic", + "forum_profile", + "blog_post", + "seller", + "paste", + "leak", + "chat_message", + "domain", + "bot", + "stealer_log", + "infected_devices", + "driller", + "driller_forum_topic", + "driller_forum_post", + "driller_profile", + "cc", + "ccbin", + "financial_data", + "leaked_data", + "leaked_file", + "document", + "account", + "actor", + "forum_content", + "blog_content", + "profile", + "leaked_credential", + "valid_credential", + "invalid_credential", + "mitigated_credential", + "illicit_networks", + "open_web", + "domains", + "intelligence_object", + "leaks", + "social_media_account", + "social_media", + "source_code", + "source_code_secrets_np", + "source_code_secrets", + "source_code_files", + "secret", + "docker", + "stack_exchange", + "google", + "service", + "driller_host", + "buckets", + "bucket", + "bucket_object", + "whois", + "cookie", + "pii", + "experimental" + ] + }, + { + "name": "experimental_types", + "in": "query", + "type": "array", + "description": "Type of experimental activities to search through.", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "event_action", + "in": "query", + "type": "string", + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ] + }, + { + "name": "event_actions", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "enum": [ + "default", + "ignored", + "remediated", + "risk_score_edited", + "exclude_ignored", + "ignored_or_remediated" + ] + }, + { + "name": "risks", + "in": "query", + "type": "array", + "items": { + "type": "integer" + }, + "collectionFormat": "multi", + "enum": [ + 1, + 2, + 3, + 4, + 5 + ] + }, + { + "name": "order", + "in": "query", + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + { + "name": "sort_by", + "in": "query", + "type": "string", + "default": "created", + "enum": [ + "created", + "indexed", + "updated", + "alertable-materialized", + "materialized", + "searchable" + ] + }, + { + "name": "use_global_policies", + "in": "query", + "type": "boolean", + "default": true + }, + { + "name": "time_zone", + "in": "query", + "type": "string", + "description": "The time zone used to compute the statistics." + }, + { + "name": "query", + "in": "query", + "type": "string", + "description": "Query used to filter results. Search query uses the [Lucene query](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/query-dsl-query-string-query.html#query-string-syntax) syntax." + }, + { + "name": "has_modified_risk_score", + "in": "query", + "type": "boolean", + "default": false + }, + { + "name": "has_notes", + "in": "query", + "type": "boolean", + "default": false + }, + { + "name": "labels", + "in": "query", + "type": "array", + "description": "Stealer log labels used to filter search results", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "enum": [ + "access_types", + "pii", + "facts", + "findings" + ] + } + ], + "tags": [ + "search" + ] + } + }, + "/firework/v2/tenants/{tenant_id}": { + "parameters": [ + { + "name": "tenant_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "put": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TenantWithCounts" + } + } + }, + "operationId": "put_tenant_api_/tenants/", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/TenantData" + } + } + ], + "tags": [ + "tenants" + ] + }, + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TenantWithCounts" + } + } + }, + "operationId": "get_tenant_api_/tenants/", + "tags": [ + "tenants" + ] + } + }, + "/firework/v2/tenants/{tenant_id}/archive": { + "parameters": [ + { + "name": "tenant_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "post": { + "responses": { + "200": { + "description": "Success" + } + }, + "operationId": "post_tenant_archive_api_/tenants//archive", + "tags": [ + "tenants" + ] + } + }, + "/firework/v2/tenants/{tenant_id}/users": { + "parameters": [ + { + "name": "tenant_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TenantUsers" + } + } + }, + "operationId": "get_tenant_users_api_/tenants//users", + "tags": [ + "tenants" + ] + }, + "post": { + "responses": { + "200": { + "description": "Users were successfully added to tenant." + } + }, + "operationId": "post_tenant_users_api_/tenants//users", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/UserTenantAccessRequest" + } + } + ], + "tags": [ + "tenants" + ] + } + }, + "/firework/v2/tenants/{tenant_id}/users/{user_id}": { + "parameters": [ + { + "name": "tenant_id", + "in": "path", + "required": true, + "type": "integer" + }, + { + "name": "user_id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "delete": { + "responses": { + "200": { + "description": "User was successfully removed from the tenant." + } + }, + "operationId": "delete_tenant_users_access_api_/tenants//users/", + "tags": [ + "tenants" + ] + } + } + }, + "info": { + "title": "Firework API", + "version": "v2", + "description": "\nManage and access Firework resources.\n\n### Steps to use the Api\n\n1. `Send` a POST request to `https://api.flare.systems/tokens/generate` with your **Firework** credentials using [Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication) to get a authentication token.\n---\n2. On the current page, click on the **Authorize** button and insert the token using the following format: `Bearer {token}`\n\n Example value: `Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e30.Et9HFtf9R3GEMA0IICOfFMVXY7kkTX1wr4qCyhIf58U`\n---\n3. You should now be able to use SwaggerUI's built-in tools to query the documented endpoints.\n" + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "securityDefinitions": { + "BearerAuth": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + }, + "security": [ + { + "BearerAuth": [] + } + ], + "tags": [ + { + "name": "search", + "description": "Searches the threat activity database." + }, + { + "name": "Identifiers", + "description": "Manage a user's or organization's identifiers" + }, + { + "name": "activities", + "description": "Perform actions on activities." + }, + { + "name": "me", + "description": "Perform actions on the current user." + }, + { + "name": "tenants", + "description": "Manage tenants." + }, + { + "name": "organizations", + "description": "Admin management of organizations." + }, + { + "name": "reporting", + "description": "Manage reporting as an admin." + } + ], + "definitions": { + "HttpError": { + "properties": { + "message": { + "type": "string" + }, + "code": { + "type": "string" + } + }, + "type": "object" + }, + "Search": { + "properties": { + "items": { + "type": "array", + "items": { + "type": "object" + } + }, + "nb_hits": { + "type": "integer" + }, + "links": { + "$ref": "#/definitions/SearchLinks" + }, + "search_after": { + "type": "string" + } + }, + "type": "object" + }, + "SearchLinks": { + "properties": { + "next": { + "type": "string" + } + }, + "type": "object" + }, + "IdentifierCreate": { + "required": [ + "data", + "name", + "search_types", + "type" + ], + "properties": { + "name": { + "type": "string", + "minLength": 1 + }, + "type": { + "type": "string", + "example": "domain", + "enum": [ + "domain", + "name", + "keyword", + "github_repository", + "username", + "email", + "search_query", + "bin", + "ip", + "secret", + "azure_tenant", + "identity", + "ransomleak", + "external_id", + "address_data", + "birth_year", + "role", + "phone_number" + ] + }, + "search_types": { + "type": "array", + "items": { + "type": "string", + "example": "google", + "enum": [ + "google", + "financial_data", + "invalid_credential", + "service", + "blog_post", + "source_code_secrets", + "leak", + "forum_post", + "chat_message", + "ransomleak", + "mitigated_credential", + "paste", + "docker", + "bucket", + "forum_profile", + "source_code_files", + "stealer_log", + "ad", + "forum_topic", + "listing", + "valid_credential", + "bot", + "seller", + "stack_exchange", + "domain", + "bucket_object", + "social_media_account", + "illicit_networks", + "open_web", + "buckets", + "source_code", + "leaks", + "domains", + "forum_content", + "blog_content", + "profile", + "ads", + "infected_devices", + "social_media" + ] + } + }, + "experimental_search_types": { + "type": "array", + "items": { + "type": "string" + } + }, + "risks": { + "type": "array", + "items": { + "type": "integer" + } + }, + "data": { + "type": "object" + } + }, + "type": "object" + }, + "Identifier": { + "required": [ + "data", + "name", + "search_types", + "type" + ], + "properties": { + "id": { + "type": "integer" + }, + "tenant_id": { + "type": "integer" + }, + "feed_id": { + "type": "integer" + }, + "type": { + "type": "string", + "example": "domain", + "enum": [ + "domain", + "name", + "keyword", + "github_repository", + "username", + "email", + "search_query", + "bin", + "ip", + "secret", + "azure_tenant", + "identity", + "ransomleak", + "external_id", + "address_data", + "birth_year", + "role", + "phone_number" + ] + }, + "search_types": { + "type": "array", + "items": { + "type": "string", + "example": "google", + "enum": [ + "google", + "financial_data", + "invalid_credential", + "service", + "blog_post", + "source_code_secrets", + "leak", + "forum_post", + "chat_message", + "ransomleak", + "mitigated_credential", + "paste", + "docker", + "bucket", + "forum_profile", + "source_code_files", + "stealer_log", + "forum_topic", + "listing", + "valid_credential", + "bot", + "seller", + "stack_exchange", + "domain", + "bucket_object", + "social_media_account", + "illicit_networks", + "open_web", + "buckets", + "source_code", + "leaks", + "domains", + "forum_content", + "blog_content", + "profile", + "infected_devices", + "social_media" + ] + } + }, + "experimental_search_types": { + "type": "array", + "items": { + "type": "string" + } + }, + "v3_refs": { + "$ref": "#/definitions/V3_Refs" + }, + "risks": { + "type": "array", + "items": { + "type": "integer" + } + }, + "name": { + "type": "string", + "minLength": 1 + }, + "data": { + "type": "object" + }, + "assets_group_id": { + "type": [ + "integer", + "null" + ], + "example": "nullable integer" + }, + "fetching_progress": { + "type": "integer" + }, + "count": { + "type": "integer" + }, + "urn": { + "type": "string", + "description": "The uniform resource name of the identifier." + }, + "is_disabled": { + "type": "boolean" + }, + "source": { + "type": "string", + "example": "USER", + "enum": [ + "USER", + "SYSTEM_RELATION", + "SELF_ONBOARDING", + "ATTRIBUTE", + "AUTO_MONITOR", + "IDP_SYNC" + ] + }, + "data_updated_at": { + "type": "string", + "format": "date-time" + }, + "monitored_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "example": "nullable date" + } + }, + "type": "object" + }, + "V3_Refs": { + "properties": { + "asset_uuid": { + "type": "string" + } + }, + "type": "object" + }, + "IdentifierToggle": { + "required": [ + "is_disabled" + ], + "properties": { + "is_disabled": { + "type": "boolean", + "description": "The `is_disabled` parameter is used to toggle the asset as either enabled or disabled.", + "default": true + } + }, + "type": "object" + }, + "FeedAlert": { + "required": [ + "frequency", + "params", + "start_at", + "type" + ], + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "type": { + "type": "string", + "example": "email", + "enum": [ + "email", + "channel", + "azure_sentinel", + "azure_sentinel_v2", + "slack", + "discord", + "splunk", + "jira", + "teams", + "servicenow", + "webhook" + ] + }, + "feed_url": { + "type": "string" + }, + "feed_target_type": { + "type": "string", + "example": "assets/groups", + "enum": [ + "assets/groups", + "assets", + "home" + ] + }, + "feed_target_id": { + "type": "integer" + }, + "frequency": { + "type": "integer" + }, + "start_at": { + "type": "string", + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "last_processed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "example": "nullable date" + }, + "last_result_date": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "example": "nullable date" + }, + "params": { + "type": "object" + }, + "tenant_id": { + "type": "integer" + }, + "organization_id": { + "type": "integer" + }, + "search_types": { + "type": "array", + "items": { + "type": "string", + "example": "attachment", + "enum": [ + "attachment", + "listing", + "ransomleak", + "forum_post", + "forum_topic", + "forum_profile", + "blog_post", + "seller", + "paste", + "leak", + "chat_message", + "domain", + "bot", + "stealer_log", + "infected_devices", + "driller", + "driller_forum_topic", + "driller_forum_post", + "driller_profile", + "cc", + "ccbin", + "financial_data", + "leaked_data", + "leaked_file", + "document", + "account", + "actor", + "forum_content", + "blog_content", + "profile", + "leaked_credential", + "valid_credential", + "invalid_credential", + "mitigated_credential", + "illicit_networks", + "open_web", + "domains", + "intelligence_object", + "leaks", + "social_media_account", + "social_media", + "source_code", + "source_code_secrets_np", + "source_code_secrets", + "source_code_files", + "secret", + "docker", + "stack_exchange", + "google", + "service", + "driller_host", + "buckets", + "bucket", + "bucket_object", + "whois", + "ad", + "ads", + "cookie", + "pii", + "experimental" + ] + } + }, + "experimental_search_types": { + "type": "array", + "items": { + "type": "string" + } + }, + "risks": { + "type": "array", + "items": { + "type": "integer" + } + }, + "tenant_alert_channel_id": { + "type": "integer" + } + }, + "type": "object" + }, + "IdentifierGroup": { + "properties": { + "id": { + "type": "integer" + }, + "tenant_id": { + "type": "integer" + }, + "feed_id": { + "type": "integer" + }, + "feed_owner_id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "urn": { + "type": "string", + "description": "The uniform resource name of the identifier group." + }, + "parent_group_id": { + "type": [ + "integer", + "null" + ], + "example": "nullable integer" + }, + "group_type": { + "type": [ + "string", + "null" + ], + "example": "nullable string", + "enum": [ + null, + "person", + "corporate_identities" + ] + } + }, + "type": "object" + }, + "UpdateGroupData": { + "properties": { + "name": { + "type": "string" + }, + "parent_group_id": { + "type": [ + "integer", + "null" + ], + "example": "nullable integer" + }, + "group_type": { + "type": [ + "string", + "null" + ], + "example": "nullable string", + "enum": [ + null, + "person", + "corporate_identities" + ] + } + }, + "type": "object" + }, + "Organization": { + "required": [ + "name" + ], + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string", + "description": "Display name" + }, + "type": { + "type": "string", + "example": "direct", + "enum": [ + "direct", + "service-firm", + "training" + ] + }, + "settings": { + "$ref": "#/definitions/OrganizationSettings" + }, + "file_analysis_enabled": { + "type": "boolean" + }, + "user_limit": { + "type": "integer" + }, + "access_level": { + "type": "integer" + }, + "urn": { + "type": "string", + "description": "The uniform resource name of the organization." + }, + "access_end_at": { + "type": "string", + "format": "date-time" + }, + "identifier_limit": { + "type": [ + "integer", + "null" + ], + "example": "nullable integer" + }, + "hubspot_company_id": { + "type": [ + "integer", + "null" + ], + "example": "nullable integer" + }, + "domain": { + "type": [ + "string", + "null" + ], + "example": "nullable string" + }, + "archived_at": { + "type": "string", + "format": "date-time" + }, + "authorization_workflow_enabled": { + "type": "boolean" + }, + "allow_support_access": { + "type": "boolean" + } + }, + "type": "object" + }, + "OrganizationSettings": { + "properties": { + "permissions": { + "type": "array", + "items": { + "type": "string" + } + }, + "through_distributor": { + "type": "boolean" + }, + "demo_tenant_limit": { + "type": [ + "integer", + "null" + ], + "example": "nullable integer" + }, + "demo_identifier_limit": { + "type": [ + "integer", + "null" + ], + "example": "nullable integer" + }, + "demo_search_limit": { + "type": [ + "integer", + "null" + ], + "example": "nullable integer" + }, + "demo_duration": { + "type": [ + "integer", + "null" + ], + "example": "nullable integer" + }, + "demo_show_passwords": { + "type": [ + "boolean", + "null" + ], + "example": "nullable bool" + }, + "hs_takedown_properties": { + "anyOf": [ + { + "$ref": "#/definitions/OrganizationHSProperties" + }, + { + "type": [ + "object", + "null" + ] + } + ] + }, + "hs_contact_email": { + "type": [ + "string", + "null" + ], + "example": "nullable string" + } + }, + "type": "object" + }, + "OrganizationHSProperties": { + "properties": { + "takedowns_in_subscription": { + "type": [ + "integer", + "null" + ], + "example": "nullable integer" + }, + "annual_takedowns_used": { + "type": [ + "integer", + "null" + ], + "example": "nullable integer" + } + }, + "type": "object" + }, + "NewTenantInfo": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "industry": { + "type": "string", + "example": "global", + "enum": [ + "global", + "transport", + "education", + "energy", + "finance", + "healthcare", + "manufacturing", + "retail", + "software", + "telecommunication" + ] + }, + "number_of_employees": { + "type": [ + "integer", + "null" + ], + "example": "nullable integer" + }, + "identifier_limit": { + "type": [ + "integer", + "null" + ], + "example": "nullable integer" + } + }, + "type": "object" + }, + "TenantWithCounts": { + "properties": { + "next": { + "type": "string" + }, + "items": { + "$ref": "#/definitions/TenantWithCounts" + }, + "total_count": { + "type": [ + "integer", + "null" + ], + "example": "nullable integer" + } + }, + "type": "object" + }, + "Tenant": { + "properties": { + "id": { + "type": "integer", + "description": "Tenant ID" + }, + "name": { + "type": "string", + "description": "Tenant name" + }, + "type": { + "type": "string", + "description": "Tenant type" + }, + "description": { + "type": "string", + "description": "This tenant's purpose" + }, + "organization_id": { + "type": "integer", + "description": "ID of the owner organization" + }, + "urn": { + "type": "string", + "description": "The uniform resource name of the tenant." + }, + "number_of_employees": { + "type": "integer", + "description": "The number of employees for the tenant." + }, + "industry": { + "type": "string", + "description": "The industry of the tenant." + }, + "is_disabled": { + "type": "boolean", + "description": "Indicates if the tenant is disabled" + }, + "is_archived": { + "type": "boolean", + "description": "Indicates if the tenant is archived" + }, + "feed_id": { + "type": "integer", + "description": "ID of the feed" + }, + "identifier_limit": { + "type": [ + "integer", + "null" + ], + "description": "The number of identifiers allowed for the tenant.", + "example": "nullable integer" + }, + "permissions": { + "type": "array", + "items": { + "type": "string" + } + }, + "prevent_global_search": { + "type": "boolean", + "description": "Indicates if the tenant can perform global searches" + }, + "access_end_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date when tenant access ends", + "example": "nullable date" + }, + "hubspot_tenant_id": { + "type": [ + "integer", + "null" + ], + "description": "The HubSpot tenant ID", + "example": "nullable integer" + } + }, + "type": "object" + }, + "UpdatedPermission": { + "properties": { + "updated_value": { + "type": "boolean" + } + }, + "type": "object" + }, + "AuditEvent": { + "required": [ + "data" + ], + "properties": { + "id": { + "type": "integer" + }, + "user_id": { + "type": "integer" + }, + "organization_id": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "data": { + "type": "object" + }, + "original_data": { + "type": "object" + }, + "affected_entities": { + "type": "object" + }, + "actor_data": { + "type": "object" + } + }, + "type": "object" + }, + "OrganizationMemberData": { + "required": [ + "email", + "name", + "organization_member_permissions", + "surname" + ], + "properties": { + "name": { + "type": "string" + }, + "surname": { + "type": "string" + }, + "email": { + "type": "string" + }, + "organization_member_permissions": { + "type": "object" + }, + "user_permissions": { + "type": "object" + }, + "memberships": { + "type": "array", + "items": { + "$ref": "#/definitions/UserTenantMembership" + } + }, + "send_welcome_email": { + "type": "boolean", + "default": true + }, + "auth_tenant_id": { + "type": [ + "integer", + "null" + ], + "example": "nullable integer" + } + }, + "type": "object" + }, + "UserTenantMembership": { + "required": [ + "tenant_id" + ], + "properties": { + "tenant_id": { + "type": "integer" + }, + "is_readonly": { + "type": "boolean" + }, + "role": { + "type": "string", + "example": "viewer", + "enum": [ + "viewer", + "editor", + "admin" + ] + } + }, + "type": "object" + }, + "OrganizationMemberPage": { + "properties": { + "members": { + "type": "array", + "items": { + "$ref": "#/definitions/OrganizationMemberWithMetadata" + } + }, + "next": { + "type": [ + "string", + "null" + ], + "example": "nullable string" + } + }, + "type": "object" + }, + "OrganizationMemberWithMetadata": { + "properties": { + "user": { + "$ref": "#/definitions/OrganizationMember" + }, + "tenant_count": { + "type": "integer" + }, + "is_mfa_enabled": { + "type": [ + "boolean", + "null" + ], + "example": "nullable bool" + } + }, + "type": "object" + }, + "OrganizationMember": { + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "surname": { + "type": "string" + }, + "email": { + "type": "string" + }, + "organization_member_permissions": { + "$ref": "#/definitions/OrganizationMemberPermission" + }, + "is_disabled": { + "type": "boolean" + }, + "registered_at": { + "type": "string", + "format": "date-time" + }, + "urn": { + "type": "string", + "description": "The uniform resource name of the member." + }, + "auth_tenant_id": { + "type": [ + "integer", + "null" + ], + "example": "nullable integer" + } + }, + "type": "object" + }, + "OrganizationMemberPermission": { + "properties": { + "*": { + "type": "object", + "additionalProperties": { + "type": "boolean" + } + } + }, + "type": "object" + }, + "OrganizationMembersCount": { + "properties": { + "count": { + "type": "integer" + } + }, + "type": "object" + }, + "EnableState": { + "properties": { + "is_disabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "PermissionData": { + "required": [ + "permission", + "value" + ], + "properties": { + "permission": { + "type": "string" + }, + "value": { + "type": "boolean" + } + }, + "type": "object" + }, + "OrganizationMonthlyUsage": { + "properties": { + "timestamp": { + "type": "string" + }, + "identifier_count": { + "type": "integer" + }, + "idp_synced_identifier_count": { + "type": "integer" + }, + "global_search_calls_count": { + "type": "integer" + } + }, + "type": "object" + }, + "HighlightPayload": { + "properties": { + "query_string": { + "type": "string" + }, + "identifier_ids": { + "type": "array", + "items": { + "type": "integer" + } + } + }, + "type": "object" + }, + "ActivityUserNotes": { + "required": [ + "notes" + ], + "properties": { + "notes": { + "type": "string" + } + }, + "type": "object" + }, + "ActivityUserMetadata": { + "properties": { + "uid": { + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "risk_score": { + "type": [ + "integer", + "null" + ], + "example": "nullable integer" + }, + "notes": { + "type": [ + "string", + "null" + ], + "example": "nullable string" + }, + "risk_score_updated_at": { + "type": "string", + "format": "date-time" + }, + "remediated_at": { + "type": "string", + "format": "date-time" + }, + "ignored_at": { + "type": "string", + "format": "date-time" + }, + "remediated_asset_uuid": { + "type": "string" + } + }, + "type": "object" + }, + "ActivityUserRiskScore": { + "required": [ + "risk_score" + ], + "properties": { + "risk_score": { + "type": "integer" + } + }, + "type": "object" + }, + "ActivityUserMetadataRemediated": { + "required": [ + "is_remediated" + ], + "properties": { + "is_remediated": { + "type": "boolean" + }, + "identifier_id": { + "type": "integer" + } + }, + "type": "object" + }, + "ActivityUserMetadataIgnored": { + "required": [ + "is_ignored" + ], + "properties": { + "is_ignored": { + "type": "boolean" + }, + "identifier_id": { + "type": "integer" + } + }, + "type": "object" + }, + "ActivityAiAssistance": { + "properties": { + "uid": { + "type": "string" + }, + "prompt": { + "type": "string" + }, + "response": { + "type": "string" + } + }, + "type": "object" + }, + "ActivityUserTags": { + "required": [ + "tags" + ], + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "type": "object" + }, + "UserUpdate": { + "required": [ + "color_scheme", + "name", + "settings", + "surname" + ], + "properties": { + "name": { + "type": "string" + }, + "surname": { + "type": "string" + }, + "settings": { + "type": "object" + }, + "language": { + "type": "string" + }, + "color_scheme": { + "type": "string", + "example": "auto", + "enum": [ + "auto", + "light", + "dark" + ] + } + }, + "type": "object" + }, + "UserProfile": { + "allOf": [ + { + "$ref": "#/definitions/User" + }, + { + "properties": { + "settings": { + "$ref": "#/definitions/UserSettings" + }, + "feature_flags": { + "type": "object" + }, + "tenants": { + "type": "array", + "items": { + "$ref": "#/definitions/Tenant" + } + }, + "default_tenant_id": { + "type": [ + "integer", + "null" + ], + "example": "nullable integer" + }, + "is_sso_mandatory": { + "type": "boolean" + }, + "has_password": { + "type": "boolean" + }, + "urn": { + "type": "string" + }, + "needs_eusa": { + "type": "boolean" + }, + "domain": { + "type": "string" + }, + "language": { + "type": "string" + }, + "trial_source": { + "type": [ + "string", + "null" + ], + "example": "nullable string" + }, + "should_provide_signup_intent": { + "type": "boolean" + } + }, + "type": "object" + } + ] + }, + "User": { + "required": [ + "color_scheme", + "email", + "language", + "name" + ], + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string", + "description": "Users's name" + }, + "surname": { + "type": "string", + "description": "User's surname" + }, + "email": { + "type": "string", + "description": "User's email" + }, + "organization_id": { + "type": "integer", + "description": "ID of the owner organization" + }, + "settings": { + "$ref": "#/definitions/UserSettings" + }, + "is_disabled": { + "type": "boolean" + }, + "feature_flags": { + "type": "object" + }, + "registered_at": { + "type": "string", + "format": "date-time" + }, + "urn": { + "type": "string", + "description": "The uniform resource name of the user." + }, + "organization_member_permissions": { + "type": "object" + }, + "language": { + "type": "string", + "description": "User's language" + }, + "color_scheme": { + "type": "string", + "example": "auto", + "enum": [ + "auto", + "light", + "dark" + ] + }, + "flare_role": { + "type": "string" + } + }, + "type": "object" + }, + "UserSettings": { + "properties": { + "default_search": { + "type": "string" + }, + "permissions": { + "type": "array", + "items": { + "type": "string" + } + }, + "organization_member_permissions": { + "type": "array", + "items": { + "type": "string" + } + }, + "should_show_guided_tenant_wizard": { + "type": [ + "boolean", + "null" + ], + "example": "nullable bool" + }, + "hide_impersonation_warning": { + "type": [ + "boolean", + "null" + ], + "example": "nullable bool" + } + }, + "type": "object" + }, + "PaginatedCredentials": { + "properties": { + "next": { + "type": "string" + }, + "items": { + "$ref": "#/definitions/LeakActivityCredential" + }, + "total_count": { + "type": [ + "integer", + "null" + ], + "example": "nullable integer" + } + }, + "type": "object" + }, + "LeakActivityCredential": { + "required": [ + "id", + "identity_name", + "imported_at", + "source_id" + ], + "properties": { + "id": { + "type": "integer" + }, + "source_id": { + "type": "string" + }, + "imported_at": { + "type": "string" + }, + "identity_name": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "domain": { + "type": "string" + }, + "source": { + "$ref": "#/definitions/source" + }, + "remediated_at": { + "type": "string", + "format": "date-time" + }, + "ignored_at": { + "type": "string", + "format": "date-time" + }, + "known_password_id": { + "type": "integer" + }, + "credential_hash": { + "type": "string" + } + }, + "type": "object" + }, + "source": { + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description_en": { + "type": "string" + }, + "description_fr": { + "type": "string" + }, + "breached_at": { + "type": "string" + }, + "leaked_at": { + "type": "string" + }, + "pii_tags": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "type": "object" + }, + "GroupedFeedAlerts": { + "required": [ + "alerts", + "key", + "organization_settings", + "params", + "type" + ], + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string" + }, + "params": { + "type": "object" + }, + "alerts": { + "$ref": "#/definitions/FeedAlert" + }, + "organization_settings": { + "$ref": "#/definitions/OrganizationSettings" + } + }, + "type": "object" + }, + "AlertUpdate": { + "properties": { + "id": { + "type": "integer" + }, + "processed_at": { + "type": "string", + "format": "date" + }, + "last_result_date": { + "type": "string", + "format": "date" + } + }, + "type": "object" + }, + "PageView": { + "required": [ + "route" + ], + "properties": { + "route": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "type": "object" + }, + "TenantIgnoredTerms": { + "required": [ + "clean_past_events", + "created_at", + "name", + "search_types", + "uuid" + ], + "properties": { + "uuid": { + "type": "string" + }, + "name": { + "type": "string" + }, + "terms": { + "type": "array", + "items": { + "type": "string" + } + }, + "search_types": { + "type": "array", + "items": { + "type": "string", + "example": "attachment", + "enum": [ + "attachment", + "listing", + "ransomleak", + "forum_post", + "forum_topic", + "forum_profile", + "blog_post", + "seller", + "paste", + "leak", + "chat_message", + "domain", + "bot", + "stealer_log", + "infected_devices", + "driller", + "driller_forum_topic", + "driller_forum_post", + "driller_profile", + "cc", + "ccbin", + "financial_data", + "leaked_data", + "leaked_file", + "document", + "account", + "actor", + "forum_content", + "blog_content", + "profile", + "leaked_credential", + "valid_credential", + "invalid_credential", + "mitigated_credential", + "illicit_networks", + "open_web", + "domains", + "intelligence_object", + "leaks", + "social_media_account", + "social_media", + "source_code", + "source_code_secrets_np", + "source_code_secrets", + "source_code_files", + "secret", + "docker", + "stack_exchange", + "google", + "service", + "driller_host", + "buckets", + "bucket", + "bucket_object", + "whois", + "ad", + "ads", + "cookie", + "pii", + "experimental" + ] + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "clean_past_events": { + "type": "boolean" + } + }, + "type": "object" + }, + "TenantData": { + "required": [ + "description", + "industry", + "name", + "number_of_employees" + ], + "properties": { + "name": { + "type": "string", + "description": "The Tenant display name" + }, + "description": { + "type": "string", + "description": "The Tenant's purpose / description" + }, + "number_of_employees": { + "type": "integer", + "description": "The number of employees for the tenant" + }, + "industry": { + "type": "string", + "description": "The Tenant's industry", + "example": "global", + "enum": [ + "global", + "transport", + "education", + "energy", + "finance", + "healthcare", + "manufacturing", + "retail", + "software", + "telecommunication" + ] + }, + "global_search_calls_limit": { + "type": "integer", + "description": "The number of API calls allowed for the tenant." + }, + "prevent_global_search": { + "type": "boolean" + } + }, + "type": "object" + }, + "UserTenantAccessRequest": { + "properties": { + "users": { + "type": "array", + "items": { + "description": "User given access to a tenant.", + "allOf": [ + { + "$ref": "#/definitions/UserTenantAccess" + } + ] + } + } + }, + "type": "object" + }, + "UserTenantAccess": { + "required": [ + "user_id" + ], + "properties": { + "user_id": { + "type": "integer", + "description": "The ID of the user to add to the tenant" + }, + "is_readonly": { + "type": "boolean", + "description": "Access given to the user for the tenant" + }, + "role": { + "type": "string", + "description": "Role given to the user for the tenant", + "example": "viewer", + "enum": [ + "viewer", + "editor", + "admin" + ] + } + }, + "type": "object" + }, + "TenantUsers": { + "properties": { + "next": { + "type": "integer" + }, + "items": { + "$ref": "#/definitions/TenantUser" + }, + "total_count": { + "type": [ + "integer", + "null" + ], + "example": "nullable integer" + } + }, + "type": "object" + }, + "TenantUser": { + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "surname": { + "type": "string" + }, + "email": { + "type": "string" + }, + "is_readonly": { + "type": "boolean" + }, + "role": { + "type": "string", + "example": "viewer", + "enum": [ + "viewer", + "editor", + "admin" + ] + }, + "is_disabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "TenantDiscoveryPolicy": { + "properties": { + "id": { + "type": "integer" + }, + "tenant_id": { + "type": "integer" + }, + "type": { + "type": "string", + "example": "auto-accept", + "enum": [ + "auto-accept", + "ignore-pattern" + ] + }, + "identifier_types": { + "type": "array", + "items": { + "type": "string", + "example": "domain", + "enum": [ + "domain", + "name", + "keyword", + "github_repository", + "username", + "email", + "search_query", + "bin", + "ip", + "secret", + "azure_tenant", + "identity", + "ransomleak", + "external_id", + "address_data", + "birth_year", + "role", + "phone_number" + ] + } + }, + "terms": { + "type": "array", + "items": { + "type": "string" + } + }, + "enabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "NewReport": { + "required": [ + "author", + "title" + ], + "properties": { + "title": { + "type": "string" + }, + "author": { + "type": "string" + }, + "elements": { + "type": "array", + "items": { + "$ref": "#/definitions/ReportElementUpdate" + } + }, + "audience": { + "type": "string", + "example": "technical", + "enum": [ + "technical", + "general" + ] + } + }, + "type": "object" + }, + "ReportElementUpdate": { + "properties": { + "id": { + "type": "integer" + }, + "position": { + "type": "integer" + }, + "enabled": { + "type": "boolean" + }, + "sort_by": { + "type": "string", + "example": "custom", + "enum": [ + "custom", + "alphabetical", + "date" + ] + }, + "time_interval": { + "type": "string" + } + }, + "type": "object" + }, + "UpdatedReport": { + "properties": { + "title": { + "type": "string" + }, + "author": { + "type": "string" + }, + "elements": { + "type": "array", + "items": { + "$ref": "#/definitions/ReportElementUpdate" + } + }, + "audience": { + "type": "string", + "example": "technical", + "enum": [ + "technical", + "general" + ] + } + }, + "type": "object" + }, + "PriorityActionHeader": { + "required": [ + "created_at", + "snooze_until", + "status", + "status_last_updated_at", + "tags", + "title", + "type", + "uuid" + ], + "properties": { + "uuid": { + "type": "string" + }, + "type": { + "type": "string" + }, + "status": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "status_last_updated_at": { + "type": "string", + "format": "date-time" + }, + "snooze_until": { + "type": "string", + "format": "date-time" + }, + "title": { + "$ref": "#/definitions/InsightText" + }, + "summary": { + "$ref": "#/definitions/InsightText" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "type": "object" + }, + "InsightText": { + "required": [ + "text" + ], + "properties": { + "text": { + "type": "string", + "description": "Text for the insight" + }, + "params": { + "type": "object", + "description": "Relevant data related to the text" + } + }, + "type": "object" + }, + "Details": { + "required": [ + "title" + ], + "properties": { + "title": { + "$ref": "#/definitions/InsightText" + }, + "summary": { + "$ref": "#/definitions/InsightText" + } + }, + "type": "object" + }, + "Mitre": { + "required": [ + "mitigation", + "techniques" + ], + "properties": { + "techniques": { + "$ref": "#/definitions/MitreLink" + }, + "mitigation": { + "$ref": "#/definitions/MitreLink" + } + }, + "type": "object" + }, + "MitreLink": { + "required": [ + "id", + "text", + "url" + ], + "properties": { + "id": { + "type": "string", + "description": "Mitre's id" + }, + "text": { + "type": "string", + "description": "Mitre's text" + }, + "url": { + "type": "string", + "description": "Link to the Mitre url page" + } + }, + "type": "object" + }, + "PriorityActionRelatedActivity": { + "required": [ + "remediated", + "tenant_id", + "uid", + "uuid" + ], + "properties": { + "uuid": { + "type": "string" + }, + "tenant_id": { + "type": "integer" + }, + "uid": { + "type": "string" + }, + "remediated": { + "type": "boolean" + } + }, + "type": "object" + }, + "ExportPriorityActionVisualizationData": { + "required": [ + "format", + "stream" + ], + "properties": { + "stream": { + "type": "string" + }, + "format": { + "type": "string", + "example": "csv", + "enum": [ + "csv" + ] + } + }, + "type": "object" + }, + "Insight": { + "required": [ + "analysis", + "date", + "paragraph", + "title", + "type" + ], + "properties": { + "type": { + "type": "string" + }, + "date": { + "type": "string", + "format": "date-time" + }, + "title": { + "$ref": "#/definitions/InsightText" + }, + "paragraph": { + "$ref": "#/definitions/InsightText" + }, + "analysis": { + "$ref": "#/definitions/InsightText" + }, + "visualization": { + "type": "array", + "items": { + "$ref": "#/definitions/FootprintVisualizationChart" + } + } + }, + "type": "object" + }, + "FootprintVisualizationChart": { + "required": [ + "data", + "id", + "type" + ], + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string", + "example": "comparison_chart", + "enum": [ + "comparison_chart", + "tabular_chart", + "radial_chart", + "line_chart", + "bar_chart", + "radar_chart" + ] + }, + "data": { + "type": "object" + }, + "title": { + "type": "string" + } + }, + "type": "object" + }, + "RansomLeakData": { + "required": [ + "breached_at", + "event_created_at", + "identifiers", + "publisher", + "risk_score", + "uid", + "victim" + ], + "properties": { + "uid": { + "type": "string", + "description": "event uid of the ransomleak" + }, + "breached_at": { + "type": "string", + "format": "date-time", + "description": "Date of the ransomleak" + }, + "event_created_at": { + "type": "string", + "format": "date-time", + "description": "Date of the ransomleak event in the feed" + }, + "risk_score": { + "type": "integer", + "description": "Computed risk of the ransomleak" + }, + "publisher": { + "type": "string", + "description": "Publisher of the ransomleak" + }, + "victim": { + "type": "string", + "description": "Victim of the ransomleak" + }, + "domain": { + "type": "string", + "description": "Domain of the victim" + }, + "country": { + "type": "string", + "description": "Country of the victim" + }, + "industry": { + "type": "string", + "description": "Industry of the victim" + }, + "employee_count": { + "type": "integer", + "description": "Number of employee of the victim" + }, + "user_metadata": { + "$ref": "#/definitions/ActivityUserMetadata" + }, + "identifiers": { + "type": "array", + "items": { + "$ref": "#/definitions/RansomLeakIdentifierData" + } + } + }, + "type": "object" + }, + "RansomLeakIdentifierData": { + "properties": { + "id": { + "type": "integer" + }, + "identifier_type": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "type": "object" + }, + "date_count": { + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "count": { + "type": "integer" + } + }, + "type": "object" + }, + "Import": { + "required": [ + "id", + "integration", + "tenant_id", + "type" + ], + "properties": { + "id": { + "type": "integer" + }, + "type": { + "type": "string", + "example": "identifiers", + "enum": [ + "identifiers" + ] + }, + "integration": { + "type": "string", + "example": "csv", + "enum": [ + "csv" + ] + }, + "tenant_id": { + "type": "integer" + }, + "committed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "example": "nullable date" + } + }, + "type": "object" + }, + "ImportItemFailures": { + "required": [ + "message", + "type" + ], + "properties": { + "type": { + "type": "string", + "example": "unknown_identifier_type", + "enum": [ + "unknown_identifier_type", + "bad_identifier_query", + "above_max_group_nesting", + "unknown_identifier_source", + "identifier_not_allowed", + "identifier_type_not_allowed", + "too_many_attributes", + "invalid_attribute_format", + "missing_attributes" + ] + }, + "message": { + "type": "string" + } + }, + "type": "object" + }, + "Subdomains": { + "required": [ + "subdomain" + ], + "properties": { + "subdomain": { + "type": "string" + } + }, + "type": "object" + }, + "CredentialUrl": { + "properties": { + "url": { + "type": "string" + }, + "credential_hash": { + "type": "string" + }, + "domain": { + "type": "string" + }, + "is_stealer_log": { + "type": "boolean" + } + }, + "type": "object" + }, + "PartialSource": { + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "type": "object" + }, + "count_by_search_type": { + "properties": { + "search_type": { + "type": "string" + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/date_count" + } + } + }, + "type": "object" + }, + "count_by_risk_score": { + "properties": { + "risk_score": { + "type": "integer" + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/date_count" + } + } + }, + "type": "object" + }, + "average_by_search_type": { + "properties": { + "search_type": { + "type": "string" + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/date_count" + } + } + }, + "type": "object" + }, + "average_by_risk_score": { + "properties": { + "risk_score": { + "type": "integer" + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/date_count" + } + } + }, + "type": "object" + }, + "IdentifierRelationData": { + "required": [ + "asset_relation_uuid", + "identifier_id" + ], + "properties": { + "identifier_id": { + "type": "integer" + }, + "asset_relation_uuid": { + "type": "string" + } + }, + "type": "object" + }, + "ArchiveFile": { + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "source": { + "type": "string" + }, + "type": { + "type": "string" + }, + "password": { + "type": "string" + }, + "status": { + "type": "string" + }, + "data": { + "$ref": "#/definitions/ArchiveFileData" + }, + "ransomleak_uid": { + "type": "string" + }, + "metadata": { + "$ref": "#/definitions/ArchiveFileMetadata" + }, + "status_updated_at": { + "type": "string", + "format": "date-time" + }, + "errors": { + "$ref": "#/definitions/ArchiveFileErrors" + }, + "retry_count": { + "type": "integer" + }, + "retry_after": { + "type": "string", + "format": "date-time" + } + }, + "type": "object" + }, + "ArchiveFileData": { + "properties": { + "parts": { + "type": "array", + "items": { + "$ref": "#/definitions/MultiPartData" + } + } + }, + "type": "object" + }, + "MultiPartData": { + "properties": { + "url": { + "type": "string" + }, + "size": { + "type": "integer" + } + }, + "type": "object" + }, + "ArchiveFileMetadata": { + "properties": { + "first_crawled_at": { + "type": "string", + "format": "date-time" + }, + "last_crawled_at": { + "type": "string", + "format": "date-time" + }, + "estimated_created_at": { + "type": "string", + "format": "date-time" + }, + "scraper_id": { + "type": "string" + }, + "scraped_at": { + "type": "string", + "format": "date-time" + }, + "event_id": { + "type": "integer" + }, + "event_id_v2": { + "type": "string" + } + }, + "type": "object" + }, + "ArchiveFileErrors": { + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ArchiveFileErrorData" + } + } + }, + "type": "object" + }, + "ArchiveFileErrorData": { + "properties": { + "type": { + "type": "string" + }, + "traceback": { + "type": "string" + } + }, + "type": "object" + } + }, + "responses": { + "ParseError": { + "description": "When a mask can't be parsed" + }, + "MaskError": { + "description": "When any error occurs on mask" + }, + "HTTPException": { + "description": "" + } + }, + "host": "api.flare.io", + "schemes": [ + "https" + ] +} diff --git a/docs/api-reference/spec/firework-v3-openapi.json b/docs/api-reference/spec/firework-v3-openapi.json index 6cfe04e3..9849a473 100644 --- a/docs/api-reference/spec/firework-v3-openapi.json +++ b/docs/api-reference/spec/firework-v3-openapi.json @@ -569,7 +569,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, forum_profile, financial_data, blog_post, forum_topic, forum_post, stealer_log, seller, listing, bot, ransomleak\n- open_web: social_media_account, google, bucket, source_code_secrets, docker, service, stack_exchange, bucket_object, source_code_files, paste\n- leaks: invalid_credential, leak, valid_credential, mitigated_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -894,7 +894,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, forum_profile, financial_data, blog_post, forum_topic, forum_post, stealer_log, seller, listing, bot, ransomleak\n- open_web: social_media_account, google, bucket, source_code_secrets, docker, service, stack_exchange, bucket_object, source_code_files, paste\n- leaks: invalid_credential, leak, valid_credential, mitigated_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "explode": true, "in": "query", "name": "types", diff --git a/docs/api-reference/spec/firework-v3-swagger.json b/docs/api-reference/spec/firework-v3-swagger.json index febf2331..4afa1fdb 100644 --- a/docs/api-reference/spec/firework-v3-swagger.json +++ b/docs/api-reference/spec/firework-v3-swagger.json @@ -487,7 +487,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, forum_profile, financial_data, blog_post, forum_topic, forum_post, stealer_log, seller, listing, bot, ransomleak\n- open_web: social_media_account, google, bucket, source_code_secrets, docker, service, stack_exchange, bucket_object, source_code_files, paste\n- leaks: invalid_credential, leak, valid_credential, mitigated_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "items": { "type": "string" }, @@ -748,7 +748,7 @@ "name": "types", "in": "query", "type": "array", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: chat_message, forum_profile, financial_data, blog_post, forum_topic, forum_post, stealer_log, seller, listing, bot, ransomleak\n- open_web: social_media_account, google, bucket, source_code_secrets, docker, service, stack_exchange, bucket_object, source_code_files, paste\n- leaks: invalid_credential, leak, valid_credential, mitigated_credential\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, leaked_credential, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, secret, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, financial_data, stealer_log, forum_post, seller, chat_message, ransomleak, forum_topic, listing, bot, forum_profile\n- open_web: google, source_code_secrets, source_code_files, stack_exchange, bucket_object, paste, social_media_account, service, docker, bucket\n- leaks: mitigated_credential, invalid_credential, leak, valid_credential\n- domains: domain\n", "items": { "type": "string" },