{ "openapi": "3.0.3", "info": { "description": "threatintelligence.googleapis.com API.", "x-google-revision": "20260823", "title": "Threat Intelligence API", "version": "v1beta" }, "paths": { "/v1beta/projects/{project}/alerts/{alert}:resolve": { "post": { "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkAlertAsResolvedRequest" } } }, "description": "The request body." }, "tags": [ "threatintelligence" ], "description": "Marks an alert to closed state - RESOLVED.", "security": [ { "google_oauth_implicit": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "google_oauth_code": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "bearer_auth": [] } ], "operationId": "MarkAlertAsResolved", "parameters": [ { "in": "path", "schema": { "type": "string" }, "required": true, "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "name": "project" }, { "schema": { "type": "string" }, "in": "path", "required": true, "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "name": "alert" } ] }, "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ] }, "/v1beta/projects/{project}/alerts/{alert}:triage": { "post": { "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } } } }, "security": [ { "google_oauth_implicit": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "google_oauth_code": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "bearer_auth": [] } ], "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkAlertAsTriagedRequest" } } } }, "description": "Marks an alert as triaged - TRIAGED.", "operationId": "MarkAlertAsTriaged", "tags": [ "threatintelligence" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "project", "in": "path", "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122." }, { "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "schema": { "type": "string" }, "name": "alert", "required": true, "in": "path" } ] }, "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ] }, "/v1beta/projects/{project}/configurations": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "get": { "tags": [ "threatintelligence" ], "parameters": [ { "schema": { "type": "string" }, "required": true, "in": "path", "name": "project", "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122." }, { "description": "Optional. Filter criteria.", "in": "query", "schema": { "type": "string" }, "name": "filter" }, { "schema": { "type": "string" }, "description": "Optional. Order by criteria in the csv format: \"field1,field2 desc\" or\n\"field1,field2\" or \"field1 asc, field2\".", "in": "query", "name": "orderBy" }, { "description": "Optional. Page token.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "Optional. Page size.", "in": "query", "schema": { "format": "int32", "type": "integer" }, "name": "pageSize" } ], "security": [ { "google_oauth_implicit": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "google_oauth_code": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "bearer_auth": [] } ], "operationId": "ListConfigurations", "description": "Get a list of configurations that meet the filter criteria.", "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListConfigurationsResponse" } } } } } } }, "/v1beta/projects/{project}/configurations/{configuration}": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "get": { "description": "Get a configuration by name.", "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Configuration" } } } } }, "operationId": "GetConfiguration", "tags": [ "threatintelligence" ], "security": [ { "google_oauth_implicit": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "google_oauth_code": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "bearer_auth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "in": "path", "name": "project", "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122." }, { "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "name": "configuration", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1beta/projects/{project}/findings:search": { "get": { "tags": [ "threatintelligence" ], "security": [ { "google_oauth_implicit": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "google_oauth_code": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "bearer_auth": [] } ], "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchFindingsResponse" } } } } }, "parameters": [ { "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "in": "path", "required": true, "schema": { "type": "string" }, "name": "project" }, { "name": "query", "in": "query", "description": "Optional. Query on what findings will be returned. This supports the same filter\ncriteria as FindingService.ListFindings as well as the following\nrelationship query `has_alert`.\nExample:\n - `has_alert(\"name=\\\"projects/gti-12345/alerts/alert-12345\\\"\")`", "schema": { "type": "string" } }, { "description": "Optional. Order by criteria in the csv format: \"field1,field2 desc\" or\n\"field1,field2\" or \"field1 asc, field2\".", "in": "query", "schema": { "type": "string" }, "name": "orderBy" }, { "in": "query", "description": "Optional. Page token.", "name": "pageToken", "schema": { "type": "string" } }, { "schema": { "type": "integer", "format": "int32" }, "in": "query", "description": "Optional. Page size.", "name": "pageSize" } ], "operationId": "SearchFindings", "description": "SearchFindings is a more powerful version of ListFindings that\nsupports complex queries like \"findings for alerts\" using functions such as\n`has_alert` in the query string.\nThe `parent` field in SearchFindingsRequest should have the format:\nprojects/{project}\nExample to search for findings for a specific issue:\n`has_alert(\"name=\\\"projects/gti-12345/alerts/alert-12345\\\"\")`" }, "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ] }, "/v1beta/projects/{project}:generateOrgProfile": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "post": { "x-google-lro": "true", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateOrgProfileConfigurationRequest" } } }, "description": "The request body." }, "description": "Triggers the generation of a Customer Profile for a project.", "security": [ { "google_oauth_implicit": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "google_oauth_code": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "bearer_auth": [] } ], "parameters": [ { "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "in": "path", "required": true, "schema": { "type": "string" }, "name": "project" } ], "responses": { "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateOrgProfileConfigurationOperation" } } }, "description": "Successful operation" } }, "operationId": "GenerateOrgProfileConfiguration", "tags": [ "threatintelligence" ] } }, "/v1beta/projects/{project}/alerts/{alert}:escalate": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "post": { "description": "Marks an alert as escalated - ESCALATED.", "responses": { "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } }, "description": "Successful operation" } }, "operationId": "MarkAlertAsEscalated", "security": [ { "google_oauth_implicit": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "google_oauth_code": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "bearer_auth": [] } ], "tags": [ "threatintelligence" ], "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkAlertAsEscalatedRequest" } } } }, "parameters": [ { "required": true, "name": "project", "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "schema": { "type": "string" }, "in": "path" }, { "name": "alert", "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "schema": { "type": "string" }, "required": true, "in": "path" } ] } }, "/v1beta/projects/{project}/alerts/{alert}/documents/{document}": { "get": { "operationId": "GetAlertDocument", "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertDocument" } } } } }, "parameters": [ { "schema": { "type": "string" }, "required": true, "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "in": "path", "name": "project" }, { "name": "alert", "required": true, "in": "path", "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "schema": { "type": "string" } }, { "in": "path", "name": "document", "required": true, "schema": { "type": "string" }, "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122." } ], "description": "Gets a specific document associated with an alert.", "security": [ { "google_oauth_implicit": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "google_oauth_code": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "bearer_auth": [] } ], "tags": [ "threatintelligence" ] }, "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ] }, "/v1beta/projects/{project}/alerts/{alert}:read": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "post": { "security": [ { "google_oauth_implicit": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "google_oauth_code": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "bearer_auth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkAlertAsReadRequest" } } }, "description": "The request body." }, "responses": { "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } }, "description": "Successful operation" } }, "parameters": [ { "schema": { "type": "string" }, "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "name": "project", "in": "path", "required": true }, { "in": "path", "schema": { "type": "string" }, "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "required": true, "name": "alert" } ], "description": "Marks an alert as read - READ.", "tags": [ "threatintelligence" ], "operationId": "MarkAlertAsRead" } }, "/v1beta/projects/{project}/alerts/{alert}:falsePositive": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "post": { "operationId": "MarkAlertAsFalsePositive", "responses": { "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } }, "description": "Successful operation" } }, "parameters": [ { "schema": { "type": "string" }, "required": true, "in": "path", "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "name": "project" }, { "required": true, "in": "path", "schema": { "type": "string" }, "name": "alert", "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122." } ], "description": "Marks an alert as a false positive - FALSE_POSITIVE.", "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkAlertAsFalsePositiveRequest" } } } }, "security": [ { "google_oauth_implicit": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "google_oauth_code": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "bearer_auth": [] } ], "tags": [ "threatintelligence" ] } }, "/v1beta/projects/{project}/alerts/{alert}:duplicate": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkAlertAsDuplicateRequest" } } }, "description": "The request body." }, "tags": [ "threatintelligence" ], "security": [ { "google_oauth_implicit": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "google_oauth_code": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "bearer_auth": [] } ], "operationId": "MarkAlertAsDuplicate", "responses": { "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } }, "description": "Successful operation" } }, "description": "Marks an alert as a duplicate of another alert. - DUPLICATE.", "parameters": [ { "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "name": "project" }, { "schema": { "type": "string" }, "name": "alert", "required": true, "in": "path", "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122." } ] } }, "/v1beta/projects/{project}/alerts/{alert}:trackExternally": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "post": { "description": "Marks an alert as tracked externally - TRACKED_EXTERNALLY.", "operationId": "MarkAlertAsTrackedExternally", "tags": [ "threatintelligence" ], "responses": { "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } }, "description": "Successful operation" } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "required": true, "name": "project", "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122." }, { "name": "alert", "schema": { "type": "string" }, "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "required": true, "in": "path" } ], "security": [ { "google_oauth_implicit": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "google_oauth_code": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "bearer_auth": [] } ], "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkAlertAsTrackedExternallyRequest" } } } } } }, "/v1beta/projects/{project}/alerts:enumerateFacets": { "get": { "responses": { "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnumerateAlertFacetsResponse" } } }, "description": "Successful operation" } }, "tags": [ "threatintelligence" ], "operationId": "EnumerateAlertFacets", "description": "EnumerateAlertFacets returns the facets and the number of alerts that meet\nthe filter criteria and have that value for each facet.", "parameters": [ { "required": true, "in": "path", "schema": { "type": "string" }, "name": "project", "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122." }, { "description": "Optional. Filter on what alerts will be enumerated.", "schema": { "type": "string" }, "name": "filter", "in": "query" } ], "security": [ { "google_oauth_implicit": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "google_oauth_code": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "bearer_auth": [] } ] }, "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ] }, "/v1beta/projects/{project}/alerts/{alert}:notActionable": { "post": { "responses": { "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } }, "description": "Successful operation" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkAlertAsNotActionableRequest" } } }, "description": "The request body." }, "parameters": [ { "schema": { "type": "string" }, "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "required": true, "in": "path", "name": "project" }, { "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "in": "path", "name": "alert", "required": true, "schema": { "type": "string" } } ], "tags": [ "threatintelligence" ], "operationId": "MarkAlertAsNotActionable", "security": [ { "google_oauth_implicit": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "google_oauth_code": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "bearer_auth": [] } ], "description": "Marks an alert as not actionable - NOT_ACTIONABLE." }, "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ] }, "/v1beta/projects/{project}/configurations/{configuration}/revisions": { "get": { "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListConfigurationRevisionsResponse" } } } } }, "description": "List configuration revisions that meet the filter criteria.", "operationId": "ListConfigurationRevisions", "tags": [ "threatintelligence" ], "security": [ { "google_oauth_implicit": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "google_oauth_code": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "bearer_auth": [] } ], "parameters": [ { "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "required": true, "schema": { "type": "string" }, "name": "project", "in": "path" }, { "required": true, "name": "configuration", "in": "path", "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "schema": { "type": "string" } }, { "description": "Optional. An AIP-160 filter string", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "Optional. Specify ordering of response", "in": "query", "schema": { "type": "string" }, "name": "orderBy" }, { "name": "pageSize", "schema": { "type": "integer", "format": "int32" }, "in": "query", "description": "Optional. Page Size" }, { "name": "pageToken", "in": "query", "schema": { "type": "string" }, "description": "Optional. A page token provided by the API" } ] }, "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ] }, "/v1beta/projects/{project}/alerts/{alert}:getPassword": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "get": { "tags": [ "threatintelligence" ], "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPasswordResponse" } } } } }, "description": "Get the decrypted password of an alert.", "parameters": [ { "name": "project", "schema": { "type": "string" }, "required": true, "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "in": "path" }, { "in": "path", "name": "alert", "required": true, "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "schema": { "type": "string" } } ], "operationId": "GetPassword", "security": [ { "google_oauth_implicit": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "google_oauth_code": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "bearer_auth": [] } ] } }, "/v1beta/projects/{project}/alerts/{alert}:benign": { "post": { "description": "Marks an alert as benign - BENIGN.", "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } } } }, "operationId": "MarkAlertAsBenign", "security": [ { "google_oauth_implicit": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "google_oauth_code": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "bearer_auth": [] } ], "tags": [ "threatintelligence" ], "parameters": [ { "in": "path", "name": "project", "schema": { "type": "string" }, "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "required": true }, { "required": true, "name": "alert", "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "schema": { "type": "string" }, "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkAlertAsBenignRequest" } } }, "description": "The request body." } }, "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ] }, "/v1beta/projects/{project}/findings/{finding}": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "get": { "operationId": "GetFinding", "security": [ { "google_oauth_implicit": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "google_oauth_code": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "bearer_auth": [] } ], "parameters": [ { "name": "project", "required": true, "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "in": "path", "schema": { "type": "string" } }, { "name": "finding", "schema": { "type": "string" }, "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "in": "path", "required": true } ], "tags": [ "threatintelligence" ], "description": "Get a finding by name.\nThe `name` field should have the format:\n`projects/{project}/findings/{finding}`", "responses": { "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Finding" } } }, "description": "Successful operation" } } } }, "/v1beta/projects/{project}/findings": { "get": { "security": [ { "google_oauth_implicit": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "google_oauth_code": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "bearer_auth": [] } ], "parameters": [ { "schema": { "type": "string" }, "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "required": true, "in": "path", "name": "project" }, { "name": "filter", "in": "query", "schema": { "type": "string" }, "description": "Optional. Filter criteria." }, { "name": "orderBy", "schema": { "type": "string" }, "description": "Optional. Order by criteria in the csv format: \"field1,field2 desc\" or\n\"field1,field2\" or \"field1 asc, field2\".", "in": "query" }, { "description": "Optional. Page token.", "schema": { "type": "string" }, "name": "pageToken", "in": "query" }, { "name": "pageSize", "schema": { "format": "int32", "type": "integer" }, "description": "Optional. Page size.", "in": "query" } ], "description": "Get a list of findings that meet the filter criteria.\nThe `parent` field in ListFindingsRequest should have the format:\nprojects/{project}", "tags": [ "threatintelligence" ], "operationId": "ListFindings", "responses": { "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListFindingsResponse" } } }, "description": "Successful operation" } } }, "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ] }, "/v1beta/projects/{project}/alerts": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "get": { "responses": { "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAlertsResponse" } } }, "description": "Successful operation" } }, "parameters": [ { "name": "project", "schema": { "type": "string" }, "in": "path", "required": true, "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122." }, { "name": "filter", "schema": { "type": "string" }, "description": "Optional. Filter criteria.\n\nSupported fields for filtering include:\n\n* `audit.create_time`\n* `audit.creator`\n* `audit.update_time`\n* `audit.updater`\n* `detail.data_leak.discovery_document_ids`\n* `detail.data_leak.severity`\n* `detail.detail_type`\n* `detail.initial_access_broker.discovery_document_ids`\n* `detail.initial_access_broker.severity`\n* `detail.insider_threat.discovery_document_ids`\n* `detail.insider_threat.severity`\n* `finding_count`\n* `priority_analysis.priority_level`\n* `relevance_analysis.confidence`\n* `relevance_analysis.relevance_level`\n* `relevance_analysis.relevant`\n* `severity_analysis.severity_level`\n* `state`\n\nExamples:\n\n* `detail.detail_type = \"initial_access_broker\"`\n* `detail.detail_type != \"data_leak\"`\n* `detail.insider_threat.severity = \"HIGH\"`\n* `audit.create_time \u003e= \"2026-04-03T00:00:00Z\" AND audit.create_time \u003c\n\"2026-04-06T00:00:00Z\"`\n* `state = \"NEW\" OR state = \"TRIAGED\"`\n* `severity_analysis.severity_level = \"SEVERITY_LEVEL_CRITICAL\"`", "in": "query" }, { "in": "query", "schema": { "type": "string" }, "description": "Optional. Order by criteria in the csv format: \"field1, field2 desc\" or\n\"field1, field2\" or \"field1 asc, field2\". If a field is specified without\n`asc` or `desc`, ascending order is used by default. Supported fields for\nordering are identical to those supported for filtering.\n\nExamples:\n\n* `audit.create_time desc`\n* `audit.update_time asc`\n* `audit.create_time desc, severity_analysis.severity_level desc`", "name": "orderBy" }, { "schema": { "type": "string" }, "name": "pageToken", "in": "query", "description": "Optional. Page token to retrieve the next page of results." }, { "schema": { "type": "integer", "format": "int32" }, "in": "query", "description": "Optional. Page size. Default to 100 alerts per page. Maximum is 1000 alerts per page.", "name": "pageSize" } ], "operationId": "ListAlerts", "tags": [ "threatintelligence" ], "security": [ { "google_oauth_implicit": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "google_oauth_code": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "bearer_auth": [] } ], "description": "Get a list of alerts that meet the filter criteria." } }, "/v1beta/projects/{project}/alerts/{alert}": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "get": { "security": [ { "google_oauth_implicit": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "google_oauth_code": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "bearer_auth": [] } ], "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } } } }, "tags": [ "threatintelligence" ], "description": "Get an alert by name.", "operationId": "GetAlert", "parameters": [ { "required": true, "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "schema": { "type": "string" }, "in": "path", "name": "project" }, { "name": "alert", "in": "path", "schema": { "type": "string" }, "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.", "required": true } ] } }, "/v1beta/projects/{project}/configurations:upsert": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "post": { "responses": { "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertConfigurationResponse" } } }, "description": "Successful operation" } }, "description": "Creates or updates a configuration.", "operationId": "UpsertConfiguration", "tags": [ "threatintelligence" ], "parameters": [ { "required": true, "in": "path", "schema": { "type": "string" }, "name": "project", "description": "Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122." }, { "description": "Optional. Time that the configuration should be considered to have been published.\nThis is an advanced feature used when onboarding and bulk loading data from\nother systems. Do not set this field without consulting with the API team.", "name": "publishTime", "schema": { "type": "string", "format": "date-time" }, "in": "query" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Configuration" } } }, "description": "Required. Configuration we are creating or updating." }, "security": [ { "google_oauth_implicit": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "google_oauth_code": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "bearer_auth": [] } ] } } }, "externalDocs": { "description": "Find more info here.", "url": "https://docs.cloud.google.com/threatintelligence/" }, "servers": [ { "description": "Global Endpoint", "url": "https://threatintelligence.googleapis.com" }, { "url": "https://threatintelligence.us-central1.rep.googleapis.com/", "description": "Regional Endpoint", "x-google-endpoint-location": "us-central1" } ], "components": { "securitySchemes": { "google_oauth_code": { "flows": { "authorizationCode": { "tokenUrl": "https://oauth2.googleapis.com/token", "refreshUrl": "https://oauth2.googleapis.com/token", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "scopes": { "https://www.googleapis.com/auth/cloud-platform": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } }, "description": "Google Oauth 2.0 authorizationCode authentication flow.", "type": "oauth2" }, "google_oauth_implicit": { "flows": { "implicit": { "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "scopes": { "https://www.googleapis.com/auth/cloud-platform": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } }, "type": "oauth2", "description": "Google Oauth 2.0 implicit authentication flow." }, "bearer_auth": { "type": "http", "description": "Http bearer authentication.", "scheme": "bearer" } }, "schemas": { "ConfigurationDetail": { "description": "Wrapper class that contains the union struct for all the various\nconfiguration detail specific classes.", "properties": { "customThreatScenario": { "allOf": [ { "$ref": "#/components/schemas/CustomThreatScenarioConfig" } ], "description": "Custom Threat Scenario detail config." }, "customerProfile": { "allOf": [ { "$ref": "#/components/schemas/CustomerProfileConfig" } ], "description": "Customer Profile detail config." }, "detailType": { "description": "Output only. Name of the detail type. Will be set by the server during creation to the\nname of the field that is set in the detail union.", "readOnly": true, "type": "string" }, "technologyWatchlist": { "description": "Technology Watchlist detail config.", "allOf": [ { "$ref": "#/components/schemas/TechnologyWatchListConfig" } ] }, "domainConfiguration": { "allOf": [ { "$ref": "#/components/schemas/DomainConfiguration" } ], "description": "Domain Configuration detail config." } }, "type": "object" }, "BaseOperation": { "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", "type": "object", "properties": { "name": { "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "error": { "allOf": [ { "$ref": "#/components/schemas/Status" } ], "description": "The error result of the operation in case of failure or cancellation." }, "done": { "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", "type": "boolean" } } }, "InsiderThreatFindingDetail": { "properties": { "severity": { "x-google-enum-descriptions": [ "Default value, should never be set.", "Low severity.", "Medium severity.", "High severity.", "Critical severity." ], "description": "Required. The severity of the InsiderThreat finding. This indicates the potential\nimpact of the threat.", "type": "string", "enum": [ "SEVERITY_UNSPECIFIED", "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "matchScore": { "format": "float", "type": "number", "description": "Required. Reference to the match score of the InsiderThreat finding. This is a float\nvalue greater than 0 and less than or equal to 1 calculated by the matching\nengine based on the similarity of the document and the user provided\nconfigurations." }, "documentId": { "type": "string", "description": "Required. The unique identifier of the document that triggered the InsiderThreat\nfinding. This ID can be used to retrieve the content of the document for\nfurther analysis." } }, "required": [ "matchScore", "severity", "documentId" ], "description": "A detail object for a InsiderThreat finding.", "type": "object" }, "SeverityAnalysis": { "type": "object", "description": "Structured severity analysis for a threat.", "properties": { "confidence": { "description": "The level of confidence in the given verdict.", "allOf": [ { "$ref": "#/components/schemas/ConfidenceLevel" } ] }, "severityLevel": { "description": "The level of severity.", "allOf": [ { "$ref": "#/components/schemas/SeverityLevel" } ] }, "reasoning": { "type": "string", "description": "Human-readable explanation from the model, detailing why a particular\nresult is considered to have a certain severity." } } }, "Association": { "description": "Represents an association with a vulnerability.", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "description": "Required. The ID of the association." }, "type": { "allOf": [ { "$ref": "#/components/schemas/ThreatIntelObjectType" } ], "description": "Required. The type of the association." } }, "type": "object" }, "MarkAlertAsReadRequest": { "description": "Request message for MarkAlertAsRead.", "type": "object" }, "CustomerProfileProduct": { "type": "object", "description": "Product information for the customer profile.", "properties": { "citationIds": { "description": "Optional. The citation ids for the product.", "items": { "type": "string" }, "type": "array" }, "brand": { "type": "string", "description": "Required. The brand of the product." }, "product": { "description": "Required. The name of the product.", "type": "string" } }, "required": [ "product", "brand" ] }, "Operation": { "type": "object", "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", "allOf": [ { "$ref": "#/components/schemas/BaseOperation" }, { "type": "object", "properties": { "metadata": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL." }, "type": "object", "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any." }, "response": { "description": "The normal, successful response of the operation. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.", "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL." } } } } ] }, "GenerateOrgProfileConfigurationOperation": { "description": "This resource represents a long-running operation where metadata and response fields are strongly typed.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseOperation" }, { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/OperationMetadata" }, "response": { "$ref": "#/components/schemas/Configuration" } } } ] }, "DomainSetting": { "required": [ "domain" ], "properties": { "domain": { "description": "Required. The domain name to match against.", "type": "string" }, "state": { "description": "Output only. The verification state of the domain.", "x-google-enum-descriptions": [ "Default value. This value is unused.", "Verification is pending. The customer needs to add the TXT record.", "Verification succeeded." ], "enum": [ "STATE_UNSPECIFIED", "PENDING", "VERIFIED" ], "readOnly": true, "type": "string" }, "domainMonitoringConfig": { "allOf": [ { "$ref": "#/components/schemas/DomainMonitoringFeatureConfig" } ], "description": "Optional. If not present, Domain Monitoring is enabled." } }, "description": "Feature settings and toggles for a single specific domain.", "type": "object" }, "GenerateOrgProfileConfigurationRequest": { "required": [ "domain", "displayName" ], "type": "object", "description": "Request message for GenerateOrgProfileConfiguration.", "properties": { "displayName": { "description": "Required. The display name of the organization to generate the profile for.", "type": "string" }, "domain": { "description": "Required. The domain of the organization to generate the profile for.", "type": "string" } } }, "MarkAlertAsBenignRequest": { "type": "object", "description": "Request message for MarkAlertAsBenign." }, "TechnologyWatchListConfig": { "description": "TechnologyWatchListConfig is the configuration for the technology watchlist.", "type": "object", "properties": { "technologies": { "type": "array", "description": "Optional. List of vendor, technology or cpe fingerprint.\nexample:\n Microsoft office 360\n Apache Server 3.5\n cpe:2.3:a:microsoft:outlook:*:*:*:*:*:*:*:*", "items": { "type": "string" } }, "alertThreshold": { "description": "Optional. Alert thresholds to effectively reduce noise.", "allOf": [ { "$ref": "#/components/schemas/TechnologyWatchListAlertThreshold" } ] } } }, "MarkAlertAsNotActionableRequest": { "description": "Request message for MarkAlertAsNotActionable.", "type": "object" }, "OperationMetadata": { "type": "object", "description": "Metadata for the long-running operation.", "properties": { "updateTime": { "description": "The time the operation was last updated.", "type": "string", "format": "date-time" }, "createTime": { "format": "date-time", "description": "The time the operation was created.", "type": "string" } } }, "MarkAlertAsEscalatedRequest": { "description": "Request message for MarkAlertAsEscalated.", "type": "object" }, "ConfidenceLevel": { "type": "string", "enum": [ "CONFIDENCE_LEVEL_UNSPECIFIED", "CONFIDENCE_LEVEL_LOW", "CONFIDENCE_LEVEL_MEDIUM", "CONFIDENCE_LEVEL_HIGH" ], "x-google-enum-descriptions": [ "Default value. Confidence level is not specified.", "Low confidence in the verdict.", "Medium confidence in the verdict.", "High confidence in the verdict." ] }, "CustomThreatScenarioConfig": { "required": [ "documentCondition" ], "properties": { "legacyMonitorMetadata": { "description": "Optional. Legacy metadata associated with this scenario/monitor.", "allOf": [ { "$ref": "#/components/schemas/LegacyMetadata" } ] }, "documentQuery": { "description": "Optional. The query used to match documents.", "allOf": [ { "$ref": "#/components/schemas/DocumentQuery" } ] }, "compiledLuceneQuery": { "readOnly": true, "type": "string", "description": "Output only. The compiled Lucene query string." }, "documentCondition": { "type": "string", "description": "Required. The condition driving the scenario, stored as a stringified JSON.\nThis is used to query/filter documents." } }, "description": "CustomThreatScenarioConfig represents a user-defined threat scenario\nconfiguration.", "type": "object" }, "AlertDocumentTranslation": { "description": "The translation of an alert document.", "type": "object", "properties": { "translatedTitle": { "description": "Output only. The translated title of the document.", "type": "string", "readOnly": true }, "translatedContent": { "description": "Output only. The translated content of the document.", "type": "string", "readOnly": true } } }, "ListFindingsResponse": { "type": "object", "properties": { "findings": { "items": { "$ref": "#/components/schemas/Finding" }, "type": "array", "description": "List of findings." }, "nextPageToken": { "description": "Page token.", "type": "string" } }, "description": "Response message for ListFindings." }, "DomainMonitoringFeatureConfig": { "description": "Specific configuration for the Domain Monitoring feature.", "type": "object", "properties": { "disabled": { "type": "boolean", "description": "Optional. Whether the Domain Monitoring feature is disabled for the domain." } } }, "AlertDocument": { "type": "object", "properties": { "author": { "description": "Output only. The author of the document.", "readOnly": true, "type": "string" }, "sourceUpdateTime": { "format": "date-time", "type": "string", "description": "Output only. Time when the intel was last updated by the source.", "readOnly": true }, "content": { "description": "Output only. The content of the document.", "readOnly": true, "type": "string" }, "createTime": { "format": "date-time", "description": "Output only. The timestamp of the original external publication of the document.", "readOnly": true, "type": "string" }, "sourceUri": { "type": "string", "description": "Output only. URI of the intel item from the source.", "readOnly": true }, "translation": { "allOf": [ { "$ref": "#/components/schemas/AlertDocumentTranslation" } ], "readOnly": true, "description": "Output only. The translation of the document, if available." }, "collectionTime": { "description": "Output only. Time when the origin source collected the intel.", "readOnly": true, "type": "string", "format": "date-time" }, "title": { "description": "Output only. The title of the document, if available.", "readOnly": true, "type": "string" }, "languageCode": { "description": "Output only. The language code of the document.", "type": "string", "readOnly": true }, "source": { "description": "Output only. Source of the intel item, e.g. DarkMarket.", "type": "string", "readOnly": true }, "name": { "x-google-identifier": true, "description": "Identifier. Server generated name for the alert document.\nformat is projects/{project}/alerts/{alert}/documents/{document}", "type": "string" }, "ingestTime": { "format": "date-time", "readOnly": true, "type": "string", "description": "Output only. Time when GTI received the intel." }, "aiSummary": { "type": "string", "readOnly": true, "description": "Output only. AI summary of the document." } }, "description": "A document that is associated with an alert." }, "LegacyMetadata": { "properties": { "creatorUserId": { "description": "Optional. User ID who created the monitor.", "type": "string" }, "legacyMonitorId": { "type": "string", "description": "Optional. Unique identifier of the legacy monitor." }, "displayName": { "description": "Optional. Name of the legacy monitor.", "type": "string" }, "aggregationSimilarity": { "description": "Optional. Similarity threshold for aggregation.", "format": "double", "type": "number" }, "description": { "description": "Optional. Description of the legacy monitor.", "type": "string" }, "emailNotificationEnabled": { "description": "Optional. Whether email notifications are enabled.", "type": "boolean" }, "aggregationEnabled": { "type": "boolean", "description": "Optional. Whether aggregation is enabled for alerts from this monitor." }, "disabledReason": { "description": "Optional. Reason why the monitor is disabled (if applicable).", "type": "string" }, "templateId": { "description": "Optional. ID of the template this monitor was created from.", "type": "string" }, "emailNotificationImmediate": { "description": "Optional. Whether email notifications are intermediate/immediate.", "type": "boolean" }, "conditionVersion": { "description": "Optional. Version of the condition schema.", "format": "int32", "type": "integer" }, "tenantId": { "description": "Optional. ID of the tenant owning the monitor.", "type": "string" }, "disabledCode": { "description": "Optional. Code indicating why the monitor is disabled (if applicable).", "type": "string" }, "version": { "format": "int32", "type": "integer", "description": "Optional. Version of the monitor configuration." }, "updaterUserId": { "description": "Optional. User ID who last updated the monitor.", "type": "string" }, "staleTime": { "format": "date-time", "type": "string", "description": "Optional. Time the legacy monitor was considered stale." } }, "description": "Legacy metadata associated with this scenario/monitor.", "type": "object" }, "TargetTechnologyAlertDetail": { "description": "Contains details for a technology watchlist alert.", "type": "object", "properties": { "vulnerabilityMatch": { "allOf": [ { "$ref": "#/components/schemas/VulnerabilityMatch" } ], "description": "Optional. The vulnerability match details." } } }, "AlertDetail": { "description": "Container for different types of alert details.", "type": "object", "properties": { "detailType": { "description": "Output only. Name of the detail type. Will be set by the server during creation to the\nname of the field that is set in the detail union.", "type": "string", "readOnly": true }, "targetTechnology": { "description": "Technology Watchlist alert detail type.", "allOf": [ { "$ref": "#/components/schemas/TargetTechnologyAlertDetail" } ] }, "dataLeak": { "allOf": [ { "$ref": "#/components/schemas/DataLeakAlertDetail" } ], "description": "Data Leak alert detail type." }, "insiderThreat": { "allOf": [ { "$ref": "#/components/schemas/InsiderThreatAlertDetail" } ], "description": "Insider Threat alert detail type." }, "initialAccessBroker": { "allOf": [ { "$ref": "#/components/schemas/InitialAccessBrokerAlertDetail" } ], "description": "Initial Access Broker alert detail type." } } }, "VulnerabilityMatch": { "description": "Contains details about a vulnerability match.", "type": "object", "properties": { "technologies": { "description": "Required. All technologies affected by the vulnerability. Ex: \"Apache Struts\".", "items": { "type": "string" }, "type": "array" }, "cveId": { "description": "Required. The CVE ID of the vulnerability. Ex: \"CVE-2025-9876\".\nSee https://www.cve.org/ for more information.", "type": "string" }, "disclosureTime": { "description": "Optional. The disclosure time of the vulnerability.", "format": "date-time", "type": "string" }, "productFixes": { "type": "array", "description": "Optional. List of product fixes for the vulnerability.", "items": { "$ref": "#/components/schemas/ProductFix" } }, "publicExploits": { "description": "Optional. List of public exploits.", "items": { "$ref": "#/components/schemas/PublicExploit" }, "type": "array" }, "riskRating": { "description": "Required. The risk rating of the vulnerability.", "type": "string", "enum": [ "RISK_RATING_UNSPECIFIED", "LOW", "MEDIUM", "HIGH", "CRITICAL", "UNRATED" ], "x-google-enum-descriptions": [ "Unspecified risk rating. This is the default value when the risk rating\nis not set.", "Low risk rating.", "Medium risk rating.", "High risk rating.", "Critical risk rating.", "The vulnerability has been assessed, but a specific risk rating could\nnot be determined or assigned." ] }, "matchedTechnologies": { "type": "array", "description": "Optional. The specific technologies from the configured watchlist that triggered the\nmatch. Ex: \"Apache Struts\".", "items": { "type": "string" } }, "epssScore": { "description": "Optional. The EPSS score, representing the probability of exploitation. Example:\n0.87.", "format": "float", "type": "number" }, "cvss3Score": { "format": "float", "type": "number", "description": "Required. The CVSS score of the vulnerability. Evaluates to CVSS v3 when available\nwith a fallback to v2 and v4. Example: 6.4." }, "publiclyAvailableExploit": { "type": "boolean", "readOnly": true, "description": "Output only. Whether a publicly available exploit exists." }, "exploitationConsequences": { "items": { "x-google-enum-descriptions": [ "Unspecified exploitation consequence.", "Code execution consequence.", "Command execution consequence.", "Data loss consequence.", "Data manipulation consequence.", "Denial-of-Service consequence.", "Information disclosure consequence.", "Unauthorized access consequence.", "Privilege escalation consequence.", "Sandbox escape consequence.", "Security bypass consequence.", "Container escape consequence.", "Spoofing consequence." ], "type": "string", "enum": [ "EXPLOITATION_CONSEQUENCE_UNSPECIFIED", "CODE_EXECUTION", "COMMAND_EXECUTION", "DATA_LOSS", "DATA_MANIPULATION", "DENIAL_OF_SERVICE", "INFORMATION_DISCLOSURE", "UNAUTHORIZED_ACCESS", "PRIVILEGE_ESCALATION", "SANDBOX_ESCAPE", "SECURITY_BYPASS", "CONTAINER_ESCAPE", "SPOOFING" ] }, "description": "Optional. List of exploitation consequences for the vulnerability.", "type": "array" }, "associations": { "description": "Optional. Associated threat actors, malware, etc. This is embedded as a snapshot\nbecause the details of the association at the time of the vulnerability\nmatch are important for context and reporting.", "type": "array", "items": { "$ref": "#/components/schemas/Association" } }, "exploitationVectors": { "type": "array", "description": "Optional. List of exploitation vectors for the vulnerability.", "items": { "type": "string", "enum": [ "EXPLOITATION_VECTOR_UNSPECIFIED", "ADMINISTRATIVE_INTERFACE", "BLUETOOTH_ACCESS", "BROWSER", "COMPROMISED_COMMUNICATION_CHANNEL", "EMAIL", "EXPOSED_WEB_APPLICATION", "LOCAL_NETWORK_ACCESS", "MALICIOUS_APPLICATION", "MALICIOUS_FILE", "MALICIOUS_SERVER", "OPEN_PORT", "PHYSICAL_ACCESS", "SHORT_RANGE_RADIO", "UNSPECIFIED_LOCAL_VECTOR", "UNSPECIFIED_REMOTE_VECTOR", "VPN_ACCESS", "WIFI_ACCESS" ], "x-google-enum-descriptions": [ "Unspecified exploitation vector.", "Administrative interface vector.", "Bluetooth access vector.", "Browser vector.", "Compromised communication channel vector.", "Email vector.", "Exposed web application vector.", "Local network access vector.", "Malicious application vector.", "Malicious file vector.", "Malicious server vector.", "Open port vector.", "Physical access vector.", "Short range radio vector.", "Unspecified local vector.", "Unspecified remote vector.", "VPN access vector.", "WiFi access vector." ] } }, "description": { "description": "Required. A description of the vulnerability.", "type": "string" }, "priority": { "description": "Optional. The priority level of the vulnerability data. Ex: \"P1\".", "x-google-enum-descriptions": [ "Unspecified priority.", "Priority level 0.", "Priority level 1.", "Priority level 2.", "Priority level 3.", "Priority level 4." ], "type": "string", "enum": [ "PRIORITY_UNSPECIFIED", "P0", "P1", "P2", "P3", "P4" ] }, "collectionId": { "type": "string", "description": "Required. The collection ID of the vulnerability.\nEx: \"vulnerability--cve-2025-9876\"." }, "exploitationState": { "allOf": [ { "$ref": "#/components/schemas/ExploitationState" } ], "description": "Required. The exploitation state of the vulnerability." } }, "required": [ "cveId", "collectionId", "description", "technologies", "cvss3Score", "riskRating", "exploitationState" ] }, "ListConfigurationRevisionsResponse": { "type": "object", "description": "Response message for ListConfigurationRevisions.", "properties": { "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", "type": "string" }, "revisions": { "description": "The Configuration Revisions associated with the specified Configuration", "items": { "$ref": "#/components/schemas/ConfigurationRevision" }, "type": "array" } } }, "PriorityAnalysis": { "properties": { "priorityLevel": { "allOf": [ { "$ref": "#/components/schemas/PriorityLevel" } ], "description": "The level of Priority." }, "confidence": { "description": "The level of confidence in the given verdict.", "allOf": [ { "$ref": "#/components/schemas/ConfidenceLevel" } ] }, "reasoning": { "type": "string", "description": "Human-readable explanation from the model, detailing why a particular\nresult is considered to have a certain priority." } }, "type": "object", "description": "Structured priority analysis for a threat." }, "ThreatIntelObjectType": { "type": "string", "enum": [ "THREAT_INTEL_OBJECT_TYPE_UNSPECIFIED", "THREAT_INTEL_OBJECT_TYPE_THREAT_ACTOR", "THREAT_INTEL_OBJECT_TYPE_MALWARE", "THREAT_INTEL_OBJECT_TYPE_REPORT", "THREAT_INTEL_OBJECT_TYPE_CAMPAIGN", "THREAT_INTEL_OBJECT_TYPE_IOC_COLLECTION", "THREAT_INTEL_OBJECT_TYPE_SOFTWARE_AND_TOOLKITS", "THREAT_INTEL_OBJECT_TYPE_VULNERABILITY" ], "x-google-enum-descriptions": [ "Unspecified object type.", "Threat actor object type.", "Malware object type.", "Report object type.", "Campaign object type.", "IoC Collection object type.", "Software and toolkits object type.", "Vulnerability object type." ] }, "CustomerProfileLocation": { "type": "object", "properties": { "brand": { "description": "Required. The brand of the location.", "type": "string" }, "citationIds": { "items": { "type": "string" }, "description": "Optional. The citation ids for the location.", "type": "array" }, "facilityType": { "type": "string", "description": "Optional. The type of location." }, "address": { "description": "Required. The address of the location.", "type": "string" } }, "description": "Location information for the customer profile.", "required": [ "brand", "address" ] }, "CustomerProfileContactInfo": { "type": "object", "description": "Contact information for the customer profile.", "properties": { "citationIds": { "items": { "type": "string" }, "description": "Optional. The citation ids for the contact information.", "type": "array" }, "other": { "type": "string", "description": "The other contact information." }, "address": { "type": "string", "description": "The address of the contact." }, "phone": { "type": "string", "description": "The phone number of the contact." }, "label": { "type": "string", "description": "Optional. The name of the contact." }, "email": { "description": "The email address of the contact.", "type": "string" } } }, "GetPasswordResponse": { "type": "object", "description": "Response message for GetPassword.", "properties": { "password": { "description": "The decrypted cleartext password for the compromised credential.", "type": "string" } } }, "Audit": { "description": "Tracks basic CRUD facts.", "type": "object", "properties": { "updateTime": { "type": "string", "description": "Output only. Time of creation or last update.", "format": "date-time", "readOnly": true }, "creator": { "type": "string", "readOnly": true, "description": "Output only. Agent that created or updated the record, could be a UserId or a JobId." }, "createTime": { "type": "string", "description": "Output only. Time of creation.", "format": "date-time", "readOnly": true }, "updater": { "description": "Output only. Agent that last updated the record, could be a UserId or a JobId.", "readOnly": true, "type": "string" } } }, "MarkAlertAsDuplicateRequest": { "properties": { "duplicateOf": { "description": "Optional. Name of the alert to mark as a duplicate of.\nFormat: projects/{project}/alerts/{alert}", "type": "string" } }, "type": "object", "description": "Request message for MarkAlertAsDuplicate." }, "DataLeakAlertDetail": { "type": "object", "required": [ "severity", "discoveryDocumentIds" ], "description": "Captures the specific details of Data Leak alert.", "properties": { "severity": { "description": "Required. The severity of the Data Leak alert.\nAllowed values are:\n* `LOW`\n* `MEDIUM`\n* `HIGH`\n* `CRITICAL`", "type": "string" }, "discoveryDocumentIds": { "items": { "type": "string" }, "description": "Required. Array of ids to accommodate multiple discovery documents", "type": "array" } } }, "InitialAccessBrokerFindingDetail": { "description": "A detail object for an Initial Access Broker (IAB) finding.", "required": [ "matchScore", "severity", "documentId" ], "type": "object", "properties": { "documentId": { "type": "string", "description": "Required. The unique identifier of the document that triggered the IAB finding.\nThis ID can be used to retrieve the content of the document for further\nanalysis." }, "severity": { "description": "Required. The severity of the IAB finding. This indicates the potential\nimpact of the threat.", "type": "string", "enum": [ "SEVERITY_UNSPECIFIED", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "x-google-enum-descriptions": [ "", "", "", "", "" ] }, "matchScore": { "type": "number", "format": "float", "description": "Required. Reference to the match score of the IAB finding. This is a float value\nbetween 0 and 1 calculated by the matching engine based on the similarity\nof the document and the user provided configurations." } } }, "MarkAlertAsTrackedExternallyRequest": { "description": "Request message for MarkAlertAsTrackedExternally.", "type": "object" }, "InsiderThreatAlertDetail": { "description": "Captures the specific details of InsiderThreat alert.", "type": "object", "properties": { "severity": { "type": "string", "description": "Required. The severity of the Insider Threat alert.\nAllowed values are:\n* `LOW`\n* `MEDIUM`\n* `HIGH`\n* `CRITICAL`" }, "discoveryDocumentIds": { "description": "Required. Array of ids to accommodate multiple discovery documents", "type": "array", "items": { "type": "string" } } }, "required": [ "severity", "discoveryDocumentIds" ] }, "FacetCount": { "properties": { "value": { "type": "string", "description": "Value of the facet stringified.\nTimestamps will be formatted using RFC3339." }, "count": { "format": "int32", "type": "integer", "description": "Count of records with the value." } }, "type": "object", "description": "FacetCount represents a count of records with each facet value." }, "MarkAlertAsTriagedRequest": { "type": "object", "description": "Request message for MarkAlertAsTriaged." }, "ExploitationState": { "x-google-enum-descriptions": [ "Unspecified exploitation state.", "No known exploitation.", "Exploitation has been reported.", "Exploitation is suspected.", "Exploitation is confirmed.", "Widespread exploitation." ], "type": "string", "enum": [ "EXPLOITATION_STATE_UNSPECIFIED", "EXPLOITATION_STATE_NO_KNOWN", "EXPLOITATION_STATE_REPORTED", "EXPLOITATION_STATE_SUSPECTED", "EXPLOITATION_STATE_CONFIRMED", "EXPLOITATION_STATE_WIDESPREAD" ] }, "UpsertConfigurationResponse": { "description": "Response message for UpsertConfiguration.", "type": "object", "properties": { "configuration": { "description": "Output only. Created configuration ID with server assigned id.", "type": "string", "readOnly": true } } }, "RelevanceLevel": { "type": "string", "enum": [ "RELEVANCE_LEVEL_UNSPECIFIED", "RELEVANCE_LEVEL_LOW", "RELEVANCE_LEVEL_MEDIUM", "RELEVANCE_LEVEL_HIGH" ], "x-google-enum-descriptions": [ "Default value, should never be set.", "Low Relevance.", "Medium Relevance.", "High Relevance." ] }, "TechnologyWatchListAlertThreshold": { "type": "object", "description": "TechnologyWatchListAlertThreshold contains the thresholds for alerting.", "properties": { "riskRatingMinimum": { "description": "Optional. The minimum risk rating for the alert.", "x-google-enum-descriptions": [ "Unspecified risk rating. This is the default value when the risk rating\nis not set.", "Low risk rating.", "Medium risk rating.", "High risk rating.", "Critical risk rating.", "The vulnerability has been assessed, but a specific risk rating could\nnot be determined or assigned." ], "type": "string", "enum": [ "RISK_RATING_UNSPECIFIED", "LOW", "MEDIUM", "HIGH", "CRITICAL", "UNRATED" ] }, "exploitationStates": { "items": { "$ref": "#/components/schemas/ExploitationState" }, "type": "array", "description": "Optional. The exploitation states of the alert." }, "priorityMinimum": { "type": "string", "enum": [ "PRIORITY_UNSPECIFIED", "P0", "P1", "P2", "P3", "P4" ], "x-google-enum-descriptions": [ "Unspecified priority.", "Priority level 0.", "Priority level 1.", "Priority level 2.", "Priority level 3.", "Priority level 4." ], "description": "Optional. The minimum priority for the alert." }, "cvssScoreMinimum": { "description": "Optional. The minimum CVSS score for the alert. Evaluates to CVSS v3 when available\nwith a fallback to v2 and v4. Ex: 7.0. Valid range is [0.0, 10.0].", "format": "float", "type": "number" }, "epssScoreMinimum": { "format": "float", "description": "Optional. The minimum epss score for the alert. Ex: 0.8. Valid range is [0.0, 1.0].", "type": "number" } } }, "Alert": { "type": "object", "description": "Stateful object representing a group of Findings. Key feature to an Alert\nis that it expresses the user's intent towards the findings of that group,\neven those that haven't occurred yet.", "properties": { "findingCount": { "readOnly": true, "description": "Output only. The number of findings associated with this alert.", "type": "string", "format": "int64" }, "etag": { "description": "Optional. If included when updating an alert, this should be set to the current etag\nof the alert. If the etags do not match, the update will be rejected and\nan ABORTED error will be returned.", "type": "string" }, "priorityAnalysis": { "description": "Output only. High-Precision Priority Analysis for the alert.", "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/PriorityAnalysis" } ] }, "displayName": { "description": "Output only. A short title for the alert.", "readOnly": true, "type": "string" }, "aiSummary": { "type": "string", "description": "Optional. AI summary of the alert." }, "duplicateOf": { "type": "string", "description": "Output only. alert name of the alert this alert is a duplicate of.\nFormat: projects/{project}/alerts/{alert}", "readOnly": true }, "externalId": { "description": "Output only. External ID for the alert. This is used internally to provide protection\nagainst out of order updates.", "readOnly": true, "type": "string" }, "state": { "description": "Output only. State of the alert.", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "NEW", "READ", "TRIAGED", "ESCALATED", "RESOLVED", "DUPLICATE", "FALSE_POSITIVE", "NOT_ACTIONABLE", "BENIGN", "TRACKED_EXTERNALLY" ], "x-google-enum-descriptions": [ "Default value, should never be set.", "alert is new.", "alert was read by a human.", "alert has been triaged.", "alert has been escalated.", "alert has been resolved.", "alert is a duplicate of another alert.", "alert is a false positive and should be ignored.", "alert is not actionable.", "alert is benign.", "alert is tracked externally." ], "type": "string" }, "duplicatedBy": { "type": "array", "readOnly": true, "description": "Output only. alert names of the alerts that are duplicates of this alert.\nFormat: projects/{project}/alerts/{alert}", "items": { "type": "string" } }, "severityAnalysis": { "readOnly": true, "description": "Output only. High-Precision Severity Analysis for the alert.", "allOf": [ { "$ref": "#/components/schemas/SeverityAnalysis" } ] }, "name": { "type": "string", "description": "Identifier. Server generated name for the alert.\nformat is projects/{project}/alerts/{alert}", "x-google-identifier": true }, "configurations": { "type": "array", "items": { "type": "string" }, "description": "Output only. The resource names of the Configurations bound to this alert.\nFormat: projects/{project}/configurations/{configuration}", "readOnly": true }, "audit": { "readOnly": true, "description": "Output only. Audit information for the alert.", "allOf": [ { "$ref": "#/components/schemas/Audit" } ] }, "detail": { "description": "Output only. Details object for the alert, not all alerts will have a details object.", "allOf": [ { "$ref": "#/components/schemas/AlertDetail" } ], "readOnly": true }, "findings": { "type": "array", "items": { "type": "string" }, "readOnly": true, "description": "Output only. Findings that are covered by this alert." }, "relevanceAnalysis": { "description": "Output only. High-Precision Relevance Analysis verdict for the alert.", "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/RelevanceAnalysis" } ] } } }, "CustomerProfileCitedString": { "type": "object", "description": "A string with citation ids.", "required": [ "value" ], "properties": { "citationIds": { "description": "Optional. The citation ids for the string.", "items": { "type": "string" }, "type": "array" }, "value": { "type": "string", "description": "Required. The value of the string." } } }, "ListConfigurationsResponse": { "properties": { "nextPageToken": { "description": "Page token.", "type": "string" }, "configurations": { "description": "List of configurations.", "items": { "$ref": "#/components/schemas/Configuration" }, "type": "array" } }, "description": "Response message for ListConfigurations.", "type": "object" }, "DocumentQuery": { "required": [ "query", "queryType", "dataModel" ], "description": "Represents a query to match documents.", "properties": { "dataModel": { "type": "string", "enum": [ "DATA_MODEL_UNSPECIFIED", "DATA_MODEL_GTI" ], "description": "Required. The data model to query against.", "x-google-enum-descriptions": [ "Default value, should never be set.", "GTI data model." ] }, "query": { "type": "string", "description": "Required. The query string." }, "queryType": { "type": "string", "enum": [ "QUERY_TYPE_UNSPECIFIED", "QUERY_TYPE_LUCENE" ], "x-google-enum-descriptions": [ "Default value, should never be set.", "Lucene query type." ], "description": "Required. The type of query." } }, "type": "object" }, "CustomerProfileSecurityConsiderations": { "type": "object", "description": "Security considerations for the customer profile.", "properties": { "considerations": { "type": "array", "description": "Optional. A series of considerations for the security of the organization,\nsuch as \"high risk of compromise\" or \"vulnerable to cyberbullying\".", "items": { "type": "string" } }, "note": { "description": "Optional. A note about the security considerations.", "type": "string" } } }, "RelevanceAnalysis": { "properties": { "evidence": { "allOf": [ { "$ref": "#/components/schemas/Evidence" } ], "description": "Evidence supporting the verdict, including matched and unmatched items." }, "relevanceLevel": { "description": "The level of relevance.", "allOf": [ { "$ref": "#/components/schemas/RelevanceLevel" } ] }, "relevant": { "description": "Indicates whether the threat is considered relevant.", "type": "boolean" }, "reasoning": { "description": "Human-readable explanation from the matcher, detailing why a particular\nresult is considered relevant or not relevant.", "type": "string" }, "confidence": { "description": "The level of confidence in the given verdict.", "allOf": [ { "$ref": "#/components/schemas/ConfidenceLevel" } ] } }, "description": "Structured relevance analysis for a threat.", "type": "object" }, "PublicExploit": { "properties": { "sizeBytes": { "format": "int64", "type": "string", "description": "Optional. The size of the exploit." }, "exploitName": { "type": "string", "description": "Required. The name of the exploit. Ex: \"Magentounauth.php.txt\"." }, "releaseTime": { "type": "string", "description": "Optional. The release time of the exploit.", "format": "date-time" }, "exploitReliability": { "x-google-enum-descriptions": [ "Unspecified exploit reliability.", "Confirmed exploit reliability.", "Uncorroborated exploit reliability.", "Unconfirmed exploit reliability." ], "type": "string", "enum": [ "EXPLOIT_RELIABILITY_UNSPECIFIED", "UNREVIEWED", "REVIEWED", "TESTED" ], "description": "Optional. The reliability of the exploit. Ex: \"Unreviewed\"." }, "exploitGrade": { "type": "string", "enum": [ "EXPLOIT_GRADE_UNSPECIFIED", "UNEVALUATED", "PROOF_OF_CONCEPT", "NON_WEAPONIZED", "WEAPONIZED", "SCANNER", "FAKE" ], "description": "Optional. The grade of the exploit. Ex: \"non-weaponized\".", "x-google-enum-descriptions": [ "Unspecified exploit grade.", "Unevaluated exploit grade.", "Proof-of-concept exploit grade.", "Non-weaponized exploit grade.", "Weaponized exploit grade.", "Scanner exploit grade.", "Fake exploit grade." ] }, "uri": { "description": "Optional. The URI of the exploit.", "type": "string" } }, "description": "Contains details about a public exploit.", "required": [ "exploitName" ], "type": "object" }, "Configuration": { "required": [ "provider", "detail" ], "description": "A configuration represents a behavior an engine should follow when producing\nnew findings.", "type": "object", "properties": { "detail": { "description": "Required. Domain specific details for the configuration.", "allOf": [ { "$ref": "#/components/schemas/ConfigurationDetail" } ] }, "state": { "description": "Optional. State of the configuration.", "x-google-enum-descriptions": [ "Configuration state is unspecified. This is not expected to occur.", "Configuration is enabled for the customer.", "Configuration is disabled for the customer.", "Configuration is deprecated, no new configs are allowed to be created." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "ENABLED", "DISABLED", "DEPRECATED" ] }, "name": { "x-google-identifier": true, "description": "Identifier. Server generated name for the configuration.\nformat is projects/{project}/configurations/{configuration}", "type": "string" }, "description": { "type": "string", "description": "Optional. A description of the configuration." }, "audit": { "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "description": "Output only. Audit information for the configuration.", "readOnly": true }, "provider": { "type": "string", "description": "Required. Name of the service that provides the configuration." }, "displayName": { "readOnly": true, "type": "string", "description": "Output only. Human readable name for the configuration." }, "etag": { "type": "string", "description": "If included when updating a configuration, this should be set to the\ncurrent etag of the configuration. If the etags do not match, the update\nwill be rejected and an ABORTED error will be returned." }, "version": { "type": "string", "description": "Optional. A user-manipulatable version. Does not adhere to a specific format" } } }, "EnumerateAlertFacetsResponse": { "properties": { "facets": { "items": { "$ref": "#/components/schemas/Facet" }, "type": "array", "description": "List of facets and the counts." } }, "description": "Response message for EnumerateAlertFacets.", "type": "object" }, "CustomerProfileIndustry": { "required": [ "industry" ], "description": "Industry information for the customer profile.", "properties": { "industry": { "description": "Required. The name of the industry.", "type": "string" }, "citationIds": { "description": "Optional. The citation ids for the industry.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "DataLeakFindingDetail": { "type": "object", "properties": { "matchScore": { "type": "number", "description": "Required. Reference to the match score of the Data Leak finding. This is a float\nvalue greater than 0 and less than or equal to 1 calculated by the matching\nengine based on the similarity of the document and the user provided\nconfigurations.", "format": "float" }, "severity": { "description": "Required. The severity of the Data Leak finding. This indicates the potential\nimpact of the threat.", "type": "string", "enum": [ "SEVERITY_UNSPECIFIED", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "x-google-enum-descriptions": [ "Default value, should never be set.", "Low severity.", "Medium severity.", "High severity.", "Critical severity." ] }, "documentId": { "description": "Required. The unique identifier of the document that triggered the Data Leak finding.\nThis ID can be used to retrieve the content of the document for further\nanalysis.", "type": "string" } }, "description": "A detail object for a Data Leak finding.", "required": [ "matchScore", "severity", "documentId" ] }, "DomainConfiguration": { "description": "Configuration holding settings for one or more monitored domains.", "type": "object", "properties": { "domainSettings": { "description": "Optional. A list of settings for individual domains.", "items": { "$ref": "#/components/schemas/DomainSetting" }, "type": "array" } } }, "MarkAlertAsFalsePositiveRequest": { "description": "Request message for MarkAlertAsFalsePositive.", "type": "object" }, "CustomerProfileSummary": { "type": "object", "description": "A summarized version of the customer profile.\nGenerated by the backend.", "properties": { "title": { "description": "Optional. The official name of the customer.", "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ] }, "industry": { "description": "Optional. The industry the customer is in.", "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ] }, "keyPeopleSummary": { "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ], "description": "Optional. A narrative summary of key people." }, "headquarters": { "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ], "description": "Optional. The headquarters of the customer." }, "founded": { "description": "Optional. The date the customer was founded.", "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ] }, "areaServed": { "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ], "description": "Optional. The area the customer serves." }, "parentCompany": { "description": "Optional. The parent company of the customer.", "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ] }, "primaryWebsite": { "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ], "description": "Optional. The primary website of the customer." }, "brands": { "description": "Optional. A narrative summary of brands.", "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ] }, "productsSummary": { "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ], "description": "Optional. A narrative summary of products." }, "servicesSummary": { "description": "Optional. A narrative summary of services.", "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ] }, "entityType": { "description": "Optional. The entity type of the customer.", "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ] } } }, "FindingDetail": { "type": "object", "properties": { "targetTechnology": { "description": "Technology Watchlist finding detail type.", "allOf": [ { "$ref": "#/components/schemas/TargetTechnologyFindingDetail" } ] }, "dataLeak": { "description": "Data Leak finding detail type.", "allOf": [ { "$ref": "#/components/schemas/DataLeakFindingDetail" } ] }, "detailType": { "type": "string", "readOnly": true, "description": "Output only. Name of the detail type. Will be set by the server during creation to the\nname of the field that is set in the detail union." }, "initialAccessBroker": { "description": "Initial Access Broker finding detail type.", "allOf": [ { "$ref": "#/components/schemas/InitialAccessBrokerFindingDetail" } ] }, "insiderThreat": { "description": "Insider Threat finding detail type.", "allOf": [ { "$ref": "#/components/schemas/InsiderThreatFindingDetail" } ] } }, "description": "Wrapper class that contains the union struct for all the various findings\ndetail specific classes." }, "CustomerProfileCitation": { "type": "object", "description": "Citation information for the customer profile.", "required": [ "citationId", "source", "document" ], "properties": { "document": { "description": "Required. The name of the document the citation is from.", "type": "string" }, "source": { "description": "Required. The source of the citation.", "type": "string" }, "retrievalTime": { "description": "The time the citation was retrieved.", "type": "string", "format": "date-time" }, "citationId": { "type": "string", "description": "Required. The citation id for the citation. Should be unique within the profile." }, "uri": { "description": "Optional. The url of the citation.", "type": "string" } } }, "Status": { "type": "object", "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32", "type": "integer" }, "details": { "items": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL." } }, "type": "array", "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use." }, "message": { "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", "type": "string" } } }, "SearchFindingsResponse": { "type": "object", "description": "Response message for SearchFindings.", "properties": { "findings": { "description": "List of findings.", "type": "array", "items": { "$ref": "#/components/schemas/Finding" } }, "nextPageToken": { "description": "Page token.", "type": "string" } } }, "Finding": { "required": [ "provider", "displayName", "detail" ], "description": "A ‘stateless’ and a point in time event that a check produced a result\nof interest.", "properties": { "reoccurrenceTimes": { "items": { "format": "date-time", "type": "string" }, "description": "Output only. When identical finding (same labels and same details) has re-occurred.", "type": "array", "readOnly": true }, "severity": { "deprecated": true, "type": "number", "format": "float", "description": "Optional. Deprecated: Use the `severity_analysis` field instead.\nBase severity score from the finding source." }, "alert": { "type": "string", "description": "Optional. Name of the alert that this finding is bound to." }, "name": { "x-google-identifier": true, "type": "string", "description": "Identifier. Server generated name for the finding (leave clear during creation).\nFormat: projects/{project}/findings/{finding}" }, "provider": { "description": "Required. Logical source of this finding (name of the sub-engine).", "type": "string" }, "severityAnalysis": { "description": "Output only. High-Precision Severity Analysis verdict for the finding.", "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/SeverityAnalysis" } ] }, "aiSummary": { "type": "string", "description": "Optional. AI summary of the finding." }, "relevanceAnalysis": { "allOf": [ { "$ref": "#/components/schemas/RelevanceAnalysis" } ], "description": "Output only. High-Precision Relevance Analysis verdict for the finding.", "readOnly": true }, "configurations": { "items": { "type": "string" }, "type": "array", "description": "Optional. Configuration names that are bound to this finding." }, "displayName": { "type": "string", "description": "Required. A short descriptive title for the finding \u003c= 250 chars.\nEX: \"Actor 'baddy' offering $1000 for credentials of 'goodguy'\"." }, "detail": { "description": "Required. Holder of the domain specific details of the finding.", "allOf": [ { "$ref": "#/components/schemas/FindingDetail" } ] }, "audit": { "description": "Output only. Audit data about the finding.", "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "readOnly": true } }, "type": "object" }, "ConfigurationRevision": { "description": "A ConfigurationRevision is a snapshot of a Configuration at a point in time.\nIt is immutable.", "type": "object", "properties": { "snapshot": { "allOf": [ { "$ref": "#/components/schemas/Configuration" } ], "description": "The snapshot of the configuration" }, "name": { "x-google-identifier": true, "type": "string", "description": "Identifier. The name of the ConfigurationRevision\nFormat: projects//configurations//revisions/" }, "createTime": { "readOnly": true, "format": "date-time", "description": "Output only. The time the Revision was created", "type": "string" } } }, "TargetTechnologyFindingDetail": { "type": "object", "properties": { "vulnerabilityMatch": { "allOf": [ { "$ref": "#/components/schemas/VulnerabilityMatch" } ], "description": "Optional. The vulnerability match details." } }, "description": "Contains details for a technology watchlist finding." }, "PriorityLevel": { "x-google-enum-descriptions": [ "Default value, should never be set.", "Low Priority.", "Medium Priority.", "High Priority.", "Critical Priority." ], "type": "string", "enum": [ "PRIORITY_LEVEL_UNSPECIFIED", "PRIORITY_LEVEL_LOW", "PRIORITY_LEVEL_MEDIUM", "PRIORITY_LEVEL_HIGH", "PRIORITY_LEVEL_CRITICAL" ] }, "ListAlertsResponse": { "description": "Response message for ListAlerts.", "properties": { "alerts": { "items": { "$ref": "#/components/schemas/Alert" }, "description": "List of alerts.", "type": "array" }, "nextPageToken": { "type": "string", "description": "Page token." } }, "type": "object" }, "CustomerProfilePerson": { "type": "object", "properties": { "title": { "description": "Optional. The title of the person.", "type": "string" }, "name": { "type": "string", "description": "Required. The name of the person." }, "citationIds": { "items": { "type": "string" }, "type": "array", "description": "Optional. The citation ids for the person." } }, "required": [ "name" ], "description": "Person information for the customer profile." }, "MarkAlertAsResolvedRequest": { "description": "Request message for MarkAlertAsResolved.", "type": "object" }, "CustomerProfileWebPresence": { "required": [ "domain" ], "type": "object", "properties": { "citationIds": { "type": "array", "description": "Optional. The citation ids for the web presence.", "items": { "type": "string" } }, "domain": { "description": "Required. The domain name of the web presence.", "type": "string" } }, "description": "Web presence information for the customer profile." }, "CustomerProfileConfig": { "description": "CustomerProfileConfig is the configuration for the customer profile.", "type": "object", "required": [ "org" ], "properties": { "parentCompanies": { "description": "Optional. The parent companies of the organization.", "type": "array", "items": { "$ref": "#/components/schemas/CustomerProfileCompany" } }, "summary": { "description": "Optional. A summarized version of the customer profile.", "allOf": [ { "$ref": "#/components/schemas/CustomerProfileSummary" } ] }, "securityConsiderations": { "description": "Optional. Security considerations for the organization.", "allOf": [ { "$ref": "#/components/schemas/CustomerProfileSecurityConsiderations" } ] }, "industries": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerProfileIndustry" }, "description": "Optional. The industries the organization is involved in." }, "org": { "description": "Required. The name of the organization.", "type": "string" }, "contactInfo": { "items": { "$ref": "#/components/schemas/CustomerProfileContactInfo" }, "type": "array", "description": "Optional. Contact information for the organization." }, "technologyPresence": { "type": "string", "description": "Optional. Technology presence of the organization." }, "executives": { "description": "Optional. Executives of the organization.", "type": "array", "items": { "$ref": "#/components/schemas/CustomerProfilePerson" } }, "orgSummary": { "type": "string", "description": "Optional. A summary of the organization." }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerProfileLocation" }, "description": "Optional. Locations the organization is present or conducts business in." }, "citations": { "description": "Optional. Citations for the organization profile.", "type": "array", "items": { "$ref": "#/components/schemas/CustomerProfileCitation" } }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerProfileProduct" }, "description": "Optional. Product information for the organization." }, "webPresences": { "type": "array", "description": "Optional. Web presence of the organization.", "items": { "$ref": "#/components/schemas/CustomerProfileWebPresence" } } } }, "CustomerProfileCompany": { "type": "object", "description": "Company information for the customer profile.", "properties": { "company": { "description": "Required. The name of the company.", "type": "string" }, "citationIds": { "type": "array", "description": "Optional. The citation ids for the company.", "items": { "type": "string" } } }, "required": [ "company" ] }, "SeverityLevel": { "type": "string", "enum": [ "SEVERITY_LEVEL_UNSPECIFIED", "SEVERITY_LEVEL_LOW", "SEVERITY_LEVEL_MEDIUM", "SEVERITY_LEVEL_HIGH" ], "x-google-enum-descriptions": [ "Default value, should never be set.", "Low Severity.", "Medium Severity.", "High Severity." ] }, "ProductFix": { "description": "Contains details about a product fix.", "type": "object", "required": [ "displayName", "sourceId" ], "properties": { "displayName": { "description": "Required. The name of the fix. Ex: \"Magento\".", "type": "string" }, "publishTime": { "format": "date-time", "description": "Optional. The published time of the fix.", "type": "string" }, "uri": { "type": "string", "description": "Optional. The URI of the fix." }, "sourceId": { "description": "Required. The source ID of the fix. Ex: \"APPSEC-1420\".", "type": "string" } } }, "Evidence": { "description": "Details the evidence used to determine the relevance verdict.", "type": "object", "properties": { "commonThemes": { "description": "A list of semantic themes or concepts found to be common, related, or\naligned between the sources, supporting the verdict.", "type": "array", "items": { "type": "string" } }, "distinctThemes": { "type": "array", "description": "A list of semantic themes or descriptions unique to one source or\nsemantically distant.", "items": { "type": "string" } } } }, "Facet": { "type": "object", "properties": { "facetType": { "description": "The type of the facet. Options include \"string\", \"int\", \"float\", \"bool\",\n\"enum\", \"timestamp\", \"user\" and are useful to show the right sort of\nUI controls when building a AIP-160 style filtering string.", "type": "string" }, "totalCount": { "description": "Total number of records that contain this facet with ANY value.", "type": "string", "format": "int64" }, "facet": { "description": "Name of the facet. This is also the string that needs to be used in the\nfiltering expression.", "type": "string" }, "facetCounts": { "items": { "$ref": "#/components/schemas/FacetCount" }, "description": "List of counts for the facet (if categorical).", "type": "array" }, "minValue": { "type": "string", "description": "Min value of the facet stringified based on type. This is only populated\nfor facets that have a clear ordering, for types like enum it will be\nleft empty.\nTimestamps will be formatted using RFC3339." }, "maxValue": { "type": "string", "description": "Max value of the facet stringified based on type. Will be populated and\nformatted the same as min_value." } }, "description": "Facet represents a sub element of a resource for filtering.\nThe results from this method are used to populate the filterable facets in\nthe UI." }, "InitialAccessBrokerAlertDetail": { "properties": { "severity": { "type": "string", "description": "Required. The severity of the Initial Access Broker (IAB) alert.\nAllowed values are:\n* `LOW`\n* `MEDIUM`\n* `HIGH`\n* `CRITICAL`" }, "discoveryDocumentIds": { "description": "Required. Array of ids to accommodate multiple discovery documents", "items": { "type": "string" }, "type": "array" } }, "type": "object", "required": [ "severity", "discoveryDocumentIds" ], "description": "Captures the specific details of InitialAccessBroker (IAB) alert." } }, "parameters": { "prettyPrint": { "schema": { "type": "boolean", "default": "true" }, "name": "$prettyPrint", "description": "Returns response with indentations and line breaks.", "in": "query" }, "_.xgafv": { "in": "query", "name": "$.xgafv", "schema": { "enum": [ "1", "2" ], "type": "string", "x-google-enum-descriptions": [ "v1 error format", "v2 error format" ] }, "description": "V1 error format." }, "alt": { "in": "query", "name": "$alt", "description": "Data format for response.", "schema": { "enum": [ "json", "media", "proto" ], "type": "string", "x-google-enum-descriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "default": "json" } }, "callback": { "name": "$callback", "description": "JSONP", "schema": { "type": "string" }, "in": "query" } } } }