{ "paths": { "/v1beta/projects/{project}/configurations/{configuration}/revisions": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "get": { "operationId": "ListConfigurationRevisions", "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListConfigurationRevisionsResponse" } } } } }, "description": "List configuration revisions that meet the filter criteria.", "tags": [ "threatintelligence" ], "parameters": [ { "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", "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": "configuration", "schema": { "type": "string" }, "required": true }, { "name": "filter", "description": "Optional. An AIP-160 filter string", "in": "query", "schema": { "type": "string" } }, { "description": "Optional. Specify ordering of response", "in": "query", "name": "orderBy", "schema": { "type": "string" } }, { "name": "pageSize", "description": "Optional. Page Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageToken", "description": "Optional. A page token provided by the API", "in": "query", "schema": { "type": "string" } } ], "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}/findings": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "get": { "tags": [ "threatintelligence" ], "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" }, { "description": "Optional. Filter criteria.", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "schema": { "type": "string" }, "name": "orderBy", "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" }, "description": "Optional. Page token.", "in": "query", "name": "pageToken" }, { "schema": { "type": "integer", "format": "int32" }, "description": "Optional. Page size.", "in": "query", "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": [] } ], "description": "Get a list of findings that meet the filter criteria.\nThe `parent` field in ListFindingsRequest should have the format:\nprojects/{project}", "operationId": "ListFindings", "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListFindingsResponse" } } } } } } }, "/v1beta/projects/{project}/alerts/{alert}:benign": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "post": { "tags": [ "threatintelligence" ], "parameters": [ { "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.", "required": true, "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.", "required": true, "schema": { "type": "string" } } ], "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 benign - BENIGN.", "operationId": "MarkAlertAsBenign", "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkAlertAsBenignRequest" } } } }, "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } } } } } }, "/v1beta/projects/{project}:generateOrgProfile": { "post": { "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateOrgProfileConfigurationOperation" } } } } }, "operationId": "GenerateOrgProfileConfiguration", "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateOrgProfileConfigurationRequest" } } } }, "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", "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" } } ], "x-google-lro": "true", "description": "Triggers the generation of a Customer Profile for a project." }, "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", "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Finding" } } } } }, "tags": [ "threatintelligence" ], "parameters": [ { "required": true, "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.", "in": "path" }, { "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": "finding" } ], "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 finding by name.\nThe `name` field should have the format:\n`projects/{project}/findings/{finding}`" } }, "/v1beta/projects/{project}/alerts/{alert}": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "get": { "operationId": "GetAlert", "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } } } }, "tags": [ "threatintelligence" ], "parameters": [ { "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", "schema": { "type": "string" }, "required": true }, { "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": "alert" } ], "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 an alert by name." } }, "/v1beta/projects/{project}/alerts:enumerateFacets": { "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, "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" }, { "name": "filter", "description": "Optional. Filter on what alerts will be enumerated.", "in": "query", "schema": { "type": "string" } } ], "security": [ { "google_oauth_implicit": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "google_oauth_code": [ "https://www.googleapis.com/auth/cloud-platform" ] }, { "bearer_auth": [] } ], "description": "EnumerateAlertFacets returns the facets and the number of alerts that meet\nthe filter criteria and have that value for each facet.", "operationId": "EnumerateAlertFacets", "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnumerateAlertFacetsResponse" } } } } } } }, "/v1beta/projects/{project}/alerts/{alert}:notActionable": { "post": { "description": "Marks an alert as not actionable - NOT_ACTIONABLE.", "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", "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" }, "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.", "required": true, "schema": { "type": "string" }, "in": "path" } ], "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } } } }, "operationId": "MarkAlertAsNotActionable", "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkAlertAsNotActionableRequest" } } } } }, "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": { "operationId": "ListAlerts", "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAlertsResponse" } } } } }, "description": "Get a list of alerts that meet the filter criteria.", "tags": [ "threatintelligence" ], "parameters": [ { "required": true, "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.", "in": "path" }, { "name": "filter", "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", "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`", "in": "query", "name": "orderBy", "schema": { "type": "string" } }, { "schema": { "type": "string" }, "description": "Optional. Page token to retrieve the next page of results.", "in": "query", "name": "pageToken" }, { "schema": { "type": "integer", "format": "int32" }, "description": "Optional. Page size. Default to 100 alerts per page. Maximum is 1000 alerts per page.", "in": "query", "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": [] } ] } }, "/v1beta/projects/{project}/alerts/{alert}:resolve": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "post": { "tags": [ "threatintelligence" ], "parameters": [ { "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", "schema": { "type": "string" }, "required": true }, { "in": "path", "required": true, "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." } ], "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 to closed state - RESOLVED.", "operationId": "MarkAlertAsResolved", "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkAlertAsResolvedRequest" } } } }, "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } } } } } }, "/v1beta/projects/{project}/alerts/{alert}:escalate": { "post": { "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } } } }, "operationId": "MarkAlertAsEscalated", "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkAlertAsEscalatedRequest" } } } }, "description": "Marks an alert as escalated - ESCALATED.", "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": [ { "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" }, "required": true, "in": "path" }, { "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.", "required": true, "schema": { "type": "string" } } ] }, "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ] }, "/v1beta/projects/{project}/findings:search": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "get": { "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchFindingsResponse" } } } } }, "operationId": "SearchFindings", "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", "required": true, "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." }, { "name": "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\\\"\")`", "in": "query", "schema": { "type": "string" } }, { "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" }, { "schema": { "type": "string" }, "description": "Optional. Page token.", "in": "query", "name": "pageToken" }, { "description": "Optional. Page size.", "in": "query", "name": "pageSize", "schema": { "type": "integer", "format": "int32" } } ], "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\\\"\")`" } }, "/v1beta/projects/{project}/alerts/{alert}:triage": { "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": [] } ], "tags": [ "threatintelligence" ], "parameters": [ { "required": true, "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.", "in": "path" }, { "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": "alert" } ], "description": "Marks an alert as triaged - TRIAGED.", "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } } } }, "operationId": "MarkAlertAsTriaged", "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkAlertAsTriagedRequest" } } } } } }, "/v1beta/projects/{project}/configurations": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "get": { "description": "Get a list of configurations that meet the filter criteria.", "tags": [ "threatintelligence" ], "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.", "name": "project", "schema": { "type": "string" }, "required": true, "in": "path" }, { "schema": { "type": "string" }, "description": "Optional. Filter criteria.", "in": "query", "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", "name": "pageSize", "schema": { "type": "integer", "format": "int32" } } ], "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", "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListConfigurationsResponse" } } } } } } }, "/v1beta/projects/{project}/alerts/{alert}/documents/{document}": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "get": { "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": [ { "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", "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": "alert", "schema": { "type": "string" }, "required": true, "in": "path" }, { "name": "document", "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" }, "in": "path" } ], "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertDocument" } } } } }, "operationId": "GetAlertDocument" } }, "/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.", "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", "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" }, { "required": true, "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.", "in": "path" } ], "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } } } }, "operationId": "MarkAlertAsTrackedExternally", "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkAlertAsTrackedExternallyRequest" } } } } } }, "/v1beta/projects/{project}/configurations/{configuration}": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "get": { "operationId": "GetConfiguration", "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Configuration" } } } } }, "tags": [ "threatintelligence" ], "parameters": [ { "required": true, "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.", "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": "configuration", "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": [] } ], "description": "Get a configuration by name." } }, "/v1beta/projects/{project}/alerts/{alert}:read": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "post": { "operationId": "MarkAlertAsRead", "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkAlertAsReadRequest" } } } }, "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } } } }, "tags": [ "threatintelligence" ], "parameters": [ { "in": "path", "required": true, "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." }, { "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": "alert", "schema": { "type": "string" }, "required": true } ], "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 read - READ." } }, "/v1beta/projects/{project}/alerts/{alert}:duplicate": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "post": { "tags": [ "threatintelligence" ], "parameters": [ { "in": "path", "required": true, "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." }, { "required": true, "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.", "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": [] } ], "description": "Marks an alert as a duplicate of another alert. - DUPLICATE.", "operationId": "MarkAlertAsDuplicate", "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkAlertAsDuplicateRequest" } } } }, "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } } } } } }, "/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": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertConfigurationResponse" } } } } }, "operationId": "UpsertConfiguration", "requestBody": { "description": "Required. Configuration we are creating or updating.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Configuration" } } } }, "description": "Creates or updates a configuration.", "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", "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" }, "required": true }, { "schema": { "type": "string", "format": "date-time" }, "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.", "in": "query", "name": "publishTime" } ] } }, "/v1beta/projects/{project}/alerts/{alert}:getPassword": { "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ], "get": { "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } } } }, "operationId": "GetPassword", "description": "Get the decrypted password of 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": [ { "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" }, "required": true, "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.", "required": true, "schema": { "type": "string" }, "in": "path" } ] } }, "/v1beta/projects/{project}/alerts/{alert}:falsePositive": { "post": { "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": [ { "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" }, "required": true, "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.", "required": true, "schema": { "type": "string" }, "in": "path" } ], "description": "Marks an alert as a false positive - FALSE_POSITIVE.", "responses": { "default": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } } } }, "operationId": "MarkAlertAsFalsePositive", "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkAlertAsFalsePositiveRequest" } } } } }, "parameters": [ { "$ref": "#/components/parameters/alt" }, { "$ref": "#/components/parameters/callback" }, { "$ref": "#/components/parameters/prettyPrint" }, { "$ref": "#/components/parameters/_.xgafv" } ] } }, "info": { "x-google-revision": "20260803", "title": "Threat Intelligence API", "description": "threatintelligence.googleapis.com API.", "version": "v1beta" }, "servers": [ { "url": "https://threatintelligence.googleapis.com", "description": "Global Endpoint" }, { "url": "https://threatintelligence.us-central1.rep.googleapis.com/", "x-google-endpoint-location": "us-central1", "description": "Regional Endpoint" } ], "openapi": "3.0.3", "externalDocs": { "description": "Find more info here.", "url": "https://docs.cloud.google.com/threatintelligence/" }, "components": { "schemas": { "CustomerProfileWebPresence": { "type": "object", "required": [ "domain" ], "properties": { "domain": { "type": "string", "description": "Required. The domain name of the web presence." }, "citationIds": { "type": "array", "items": { "type": "string" }, "description": "Optional. The citation ids for the web presence." } }, "description": "Web presence information for the customer profile." }, "MarkAlertAsTrackedExternallyRequest": { "description": "Request message for MarkAlertAsTrackedExternally.", "type": "object" }, "Association": { "type": "object", "required": [ "id", "type" ], "description": "Represents an association with a vulnerability.", "properties": { "id": { "description": "Required. The ID of the association.", "type": "string" }, "type": { "description": "Required. The type of the association.", "allOf": [ { "$ref": "#/components/schemas/ThreatIntelObjectType" } ] } } }, "MarkAlertAsFalsePositiveRequest": { "type": "object", "description": "Request message for MarkAlertAsFalsePositive." }, "Finding": { "properties": { "detail": { "description": "Required. Holder of the domain specific details of the finding.", "allOf": [ { "$ref": "#/components/schemas/FindingDetail" } ] }, "relevanceAnalysis": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/RelevanceAnalysis" } ], "description": "Output only. High-Precision Relevance Analysis verdict for the finding." }, "severity": { "deprecated": true, "type": "number", "format": "float", "description": "Optional. Deprecated: Use the `severity_analysis` field instead.\nBase severity score from the finding source." }, "name": { "description": "Identifier. Server generated name for the finding (leave clear during creation).\nFormat: projects/{project}/findings/{finding}", "type": "string", "x-google-identifier": true }, "severityAnalysis": { "description": "Output only. High-Precision Severity Analysis verdict for the finding.", "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/SeverityAnalysis" } ] }, "configurations": { "description": "Optional. Configuration names that are bound to this finding.", "type": "array", "items": { "type": "string" } }, "reoccurrenceTimes": { "type": "array", "items": { "type": "string", "format": "date-time" }, "readOnly": true, "description": "Output only. When identical finding (same labels and same details) has re-occurred." }, "provider": { "description": "Required. Logical source of this finding (name of the sub-engine).", "type": "string" }, "audit": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "description": "Output only. Audit data about the finding." }, "aiSummary": { "description": "Optional. AI summary of the finding.", "type": "string" }, "alert": { "description": "Optional. Name of the alert that this finding is bound to.", "type": "string" }, "displayName": { "description": "Required. A short descriptive title for the finding \u003c= 250 chars.\nEX: \"Actor 'baddy' offering $1000 for credentials of 'goodguy'\".", "type": "string" } }, "description": "A ‘stateless’ and a point in time event that a check produced a result\nof interest.", "type": "object", "required": [ "provider", "displayName", "detail" ] }, "CustomThreatScenarioConfig": { "type": "object", "required": [ "documentCondition" ], "description": "CustomThreatScenarioConfig represents a user-defined threat scenario\nconfiguration.", "properties": { "documentCondition": { "type": "string", "description": "Required. The condition driving the scenario, stored as a stringified JSON.\nThis is used to query/filter documents." } } }, "VulnerabilityMatch": { "description": "Contains details about a vulnerability match.", "properties": { "riskRating": { "description": "Required. The risk rating of the vulnerability.", "enum": [ "RISK_RATING_UNSPECIFIED", "LOW", "MEDIUM", "HIGH", "CRITICAL", "UNRATED" ], "type": "string", "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." ] }, "description": { "type": "string", "description": "Required. A description of the vulnerability." }, "publicExploits": { "type": "array", "items": { "$ref": "#/components/schemas/PublicExploit" }, "description": "Optional. List of public exploits." }, "cvss3Score": { "type": "number", "format": "float", "description": "Required. The CVSS score of the vulnerability. Evaluates to CVSS v3 when available\nwith a fallback to v2 and v4. Example: 6.4." }, "exploitationVectors": { "description": "Optional. List of exploitation vectors for the vulnerability.", "type": "array", "items": { "type": "string", "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." ], "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" ] } }, "associations": { "type": "array", "items": { "$ref": "#/components/schemas/Association" }, "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." }, "matchedTechnologies": { "type": "array", "items": { "type": "string" }, "description": "Optional. The specific technologies from the configured watchlist that triggered the\nmatch. Ex: \"Apache Struts\"." }, "disclosureTime": { "description": "Optional. The disclosure time of the vulnerability.", "type": "string", "format": "date-time" }, "publiclyAvailableExploit": { "type": "boolean", "description": "Output only. Whether a publicly available exploit exists.", "readOnly": true }, "collectionId": { "description": "Required. The collection ID of the vulnerability.\nEx: \"vulnerability--cve-2025-9876\".", "type": "string" }, "exploitationState": { "description": "Required. The exploitation state of the vulnerability.", "allOf": [ { "$ref": "#/components/schemas/ExploitationState" } ] }, "cveId": { "description": "Required. The CVE ID of the vulnerability. Ex: \"CVE-2025-9876\".\nSee https://www.cve.org/ for more information.", "type": "string" }, "technologies": { "type": "array", "items": { "type": "string" }, "description": "Required. All technologies affected by the vulnerability. Ex: \"Apache Struts\"." }, "productFixes": { "description": "Optional. List of product fixes for the vulnerability.", "type": "array", "items": { "$ref": "#/components/schemas/ProductFix" } }, "exploitationConsequences": { "description": "Optional. List of exploitation consequences for the vulnerability.", "type": "array", "items": { "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" ], "type": "string", "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." ] } }, "priority": { "enum": [ "PRIORITY_UNSPECIFIED", "P0", "P1", "P2", "P3", "P4" ], "type": "string", "x-google-enum-descriptions": [ "Unspecified priority.", "Priority level 0.", "Priority level 1.", "Priority level 2.", "Priority level 3.", "Priority level 4." ], "description": "Optional. The priority level of the vulnerability data. Ex: \"P1\"." }, "epssScore": { "description": "Optional. The EPSS score, representing the probability of exploitation. Example:\n0.87.", "type": "number", "format": "float" } }, "type": "object", "required": [ "cveId", "collectionId", "description", "technologies", "cvss3Score", "riskRating", "exploitationState" ] }, "ExploitationState": { "enum": [ "EXPLOITATION_STATE_UNSPECIFIED", "EXPLOITATION_STATE_NO_KNOWN", "EXPLOITATION_STATE_REPORTED", "EXPLOITATION_STATE_SUSPECTED", "EXPLOITATION_STATE_CONFIRMED", "EXPLOITATION_STATE_WIDESPREAD" ], "type": "string", "x-google-enum-descriptions": [ "Unspecified exploitation state.", "No known exploitation.", "Exploitation has been reported.", "Exploitation is suspected.", "Exploitation is confirmed.", "Widespread exploitation." ] }, "PriorityLevel": { "enum": [ "PRIORITY_LEVEL_UNSPECIFIED", "PRIORITY_LEVEL_LOW", "PRIORITY_LEVEL_MEDIUM", "PRIORITY_LEVEL_HIGH", "PRIORITY_LEVEL_CRITICAL" ], "type": "string", "x-google-enum-descriptions": [ "Default value, should never be set.", "Low Priority.", "Medium Priority.", "High Priority.", "Critical Priority." ] }, "CustomerProfileLocation": { "type": "object", "required": [ "brand", "address" ], "properties": { "facilityType": { "type": "string", "description": "Optional. The type of location." }, "address": { "type": "string", "description": "Required. The address of the location." }, "citationIds": { "type": "array", "items": { "type": "string" }, "description": "Optional. The citation ids for the location." }, "brand": { "type": "string", "description": "Required. The brand of the location." } }, "description": "Location information for the customer profile." }, "CustomerProfileCompany": { "description": "Company information for the customer profile.", "properties": { "company": { "type": "string", "description": "Required. The name of the company." }, "citationIds": { "type": "array", "items": { "type": "string" }, "description": "Optional. The citation ids for the company." } }, "type": "object", "required": [ "company" ] }, "ConfidenceLevel": { "type": "string", "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." ], "enum": [ "CONFIDENCE_LEVEL_UNSPECIFIED", "CONFIDENCE_LEVEL_LOW", "CONFIDENCE_LEVEL_MEDIUM", "CONFIDENCE_LEVEL_HIGH" ] }, "ProductFix": { "type": "object", "required": [ "displayName", "sourceId" ], "description": "Contains details about a product fix.", "properties": { "displayName": { "description": "Required. The name of the fix. Ex: \"Magento\".", "type": "string" }, "sourceId": { "type": "string", "description": "Required. The source ID of the fix. Ex: \"APPSEC-1420\"." }, "publishTime": { "description": "Optional. The published time of the fix.", "type": "string", "format": "date-time" }, "uri": { "type": "string", "description": "Optional. The URI of the fix." } } }, "OperationMetadata": { "type": "object", "properties": { "createTime": { "description": "The time the operation was created.", "type": "string", "format": "date-time" }, "updateTime": { "description": "The time the operation was last updated.", "type": "string", "format": "date-time" } }, "description": "Metadata for the long-running operation." }, "MarkAlertAsTriagedRequest": { "description": "Request message for MarkAlertAsTriaged.", "type": "object" }, "AlertDocument": { "properties": { "sourceUri": { "description": "Output only. URI of the intel item from the source.", "readOnly": true, "type": "string" }, "author": { "readOnly": true, "description": "Output only. The author of the document.", "type": "string" }, "name": { "x-google-identifier": true, "type": "string", "description": "Identifier. Server generated name for the alert document.\nformat is projects/{project}/alerts/{alert}/documents/{document}" }, "content": { "description": "Output only. The content of the document.", "readOnly": true, "type": "string" }, "languageCode": { "readOnly": true, "description": "Output only. The language code of the document.", "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. The timestamp of the original external publication of the document.", "type": "string", "format": "date-time" }, "aiSummary": { "type": "string", "readOnly": true, "description": "Output only. AI summary of the document." }, "translation": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/AlertDocumentTranslation" } ], "description": "Output only. The translation of the document, if available." }, "title": { "type": "string", "readOnly": true, "description": "Output only. The title of the document, if available." }, "collectionTime": { "type": "string", "format": "date-time", "description": "Output only. Time when the origin source collected the intel.", "readOnly": true }, "sourceUpdateTime": { "readOnly": true, "description": "Output only. Time when the intel was last updated by the source.", "type": "string", "format": "date-time" }, "source": { "type": "string", "readOnly": true, "description": "Output only. Source of the intel item, e.g. DarkMarket." }, "ingestTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Output only. Time when GTI received the intel." } }, "description": "A document that is associated with an alert.", "type": "object" }, "CustomerProfileSecurityConsiderations": { "type": "object", "description": "Security considerations for the customer profile.", "properties": { "considerations": { "description": "Optional. A series of considerations for the security of the organization,\nsuch as \"high risk of compromise\" or \"vulnerable to cyberbullying\".", "type": "array", "items": { "type": "string" } }, "note": { "type": "string", "description": "Optional. A note about the security considerations." } } }, "TargetTechnologyAlertDetail": { "type": "object", "description": "Contains details for a technology watchlist alert.", "properties": { "vulnerabilityMatch": { "allOf": [ { "$ref": "#/components/schemas/VulnerabilityMatch" } ], "description": "Optional. The vulnerability match details." } } }, "SeverityLevel": { "type": "string", "x-google-enum-descriptions": [ "Default value, should never be set.", "Low Severity.", "Medium Severity.", "High Severity." ], "enum": [ "SEVERITY_LEVEL_UNSPECIFIED", "SEVERITY_LEVEL_LOW", "SEVERITY_LEVEL_MEDIUM", "SEVERITY_LEVEL_HIGH" ] }, "GenerateOrgProfileConfigurationOperation": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseOperation" }, { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/OperationMetadata" }, "response": { "$ref": "#/components/schemas/Configuration" } } } ], "description": "This resource represents a long-running operation where metadata and response fields are strongly typed." }, "UpsertConfigurationResponse": { "type": "object", "properties": { "configuration": { "description": "Output only. Created configuration ID with server assigned id.", "readOnly": true, "type": "string" } }, "description": "Response message for UpsertConfiguration." }, "TargetTechnologyFindingDetail": { "properties": { "vulnerabilityMatch": { "allOf": [ { "$ref": "#/components/schemas/VulnerabilityMatch" } ], "description": "Optional. The vulnerability match details." } }, "description": "Contains details for a technology watchlist finding.", "type": "object" }, "RelevanceLevel": { "type": "string", "x-google-enum-descriptions": [ "Default value, should never be set.", "Low Relevance.", "Medium Relevance.", "High Relevance." ], "enum": [ "RELEVANCE_LEVEL_UNSPECIFIED", "RELEVANCE_LEVEL_LOW", "RELEVANCE_LEVEL_MEDIUM", "RELEVANCE_LEVEL_HIGH" ] }, "CustomerProfileSummary": { "type": "object", "description": "A summarized version of the customer profile.\nGenerated by the backend.", "properties": { "areaServed": { "description": "Optional. The area the customer serves.", "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ] }, "title": { "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ], "description": "Optional. The official name of the customer." }, "productsSummary": { "description": "Optional. A narrative summary of products.", "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ] }, "entityType": { "description": "Optional. The entity type of the customer.", "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ] }, "headquarters": { "description": "Optional. The headquarters of the customer.", "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ] }, "primaryWebsite": { "description": "Optional. The primary website of the customer.", "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ] }, "servicesSummary": { "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ], "description": "Optional. A narrative summary of services." }, "keyPeopleSummary": { "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ], "description": "Optional. A narrative summary of key people." }, "parentCompany": { "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ], "description": "Optional. The parent company of the customer." }, "brands": { "description": "Optional. A narrative summary of brands.", "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ] }, "industry": { "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ], "description": "Optional. The industry the customer is in." }, "founded": { "description": "Optional. The date the customer was founded.", "allOf": [ { "$ref": "#/components/schemas/CustomerProfileCitedString" } ] } } }, "CustomerProfilePerson": { "type": "object", "required": [ "name" ], "properties": { "name": { "description": "Required. The name of the person.", "type": "string" }, "citationIds": { "description": "Optional. The citation ids for the person.", "type": "array", "items": { "type": "string" } }, "title": { "type": "string", "description": "Optional. The title of the person." } }, "description": "Person information for the customer profile." }, "CustomerProfileCitedString": { "type": "object", "required": [ "value" ], "description": "A string with citation ids.", "properties": { "citationIds": { "description": "Optional. The citation ids for the string.", "type": "array", "items": { "type": "string" } }, "value": { "type": "string", "description": "Required. The value of the string." } } }, "CustomerProfileConfig": { "type": "object", "required": [ "org" ], "properties": { "orgSummary": { "description": "Optional. A summary of the organization.", "type": "string" }, "contactInfo": { "description": "Optional. Contact information for the organization.", "type": "array", "items": { "$ref": "#/components/schemas/CustomerProfileContactInfo" } }, "org": { "type": "string", "description": "Required. The name of the organization." }, "securityConsiderations": { "description": "Optional. Security considerations for the organization.", "allOf": [ { "$ref": "#/components/schemas/CustomerProfileSecurityConsiderations" } ] }, "parentCompanies": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerProfileCompany" }, "description": "Optional. The parent companies of the organization." }, "summary": { "allOf": [ { "$ref": "#/components/schemas/CustomerProfileSummary" } ], "description": "Optional. A summarized version of the customer profile." }, "executives": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerProfilePerson" }, "description": "Optional. Executives of the organization." }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerProfileProduct" }, "description": "Optional. Product information for the organization." }, "technologyPresence": { "type": "string", "description": "Optional. Technology presence of the organization." }, "citations": { "description": "Optional. Citations for the organization profile.", "type": "array", "items": { "$ref": "#/components/schemas/CustomerProfileCitation" } }, "industries": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerProfileIndustry" }, "description": "Optional. The industries the organization is involved in." }, "locations": { "description": "Optional. Locations the organization is present or conducts business in.", "type": "array", "items": { "$ref": "#/components/schemas/CustomerProfileLocation" } }, "webPresences": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerProfileWebPresence" }, "description": "Optional. Web presence of the organization." } }, "description": "CustomerProfileConfig is the configuration for the customer profile." }, "MarkAlertAsReadRequest": { "type": "object", "description": "Request message for MarkAlertAsRead." }, "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": { "details": { "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL." } } }, "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" }, "code": { "type": "integer", "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code." } } }, "MarkAlertAsEscalatedRequest": { "description": "Request message for MarkAlertAsEscalated.", "type": "object" }, "SeverityAnalysis": { "type": "object", "description": "Structured severity analysis for a threat.", "properties": { "confidence": { "allOf": [ { "$ref": "#/components/schemas/ConfidenceLevel" } ], "description": "The level of confidence in the given verdict." }, "reasoning": { "type": "string", "description": "Human-readable explanation from the model, detailing why a particular\nresult is considered to have a certain severity." }, "severityLevel": { "description": "The level of severity.", "allOf": [ { "$ref": "#/components/schemas/SeverityLevel" } ] } } }, "TechnologyWatchListAlertThreshold": { "type": "object", "properties": { "riskRatingMinimum": { "enum": [ "RISK_RATING_UNSPECIFIED", "LOW", "MEDIUM", "HIGH", "CRITICAL", "UNRATED" ], "type": "string", "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." ], "description": "Optional. The minimum risk rating for the alert." }, "priorityMinimum": { "enum": [ "PRIORITY_UNSPECIFIED", "P0", "P1", "P2", "P3", "P4" ], "type": "string", "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." }, "epssScoreMinimum": { "description": "Optional. The minimum epss score for the alert. Ex: 0.8. Valid range is [0.0, 1.0].", "type": "number", "format": "float" }, "exploitationStates": { "type": "array", "items": { "$ref": "#/components/schemas/ExploitationState" }, "description": "Optional. The exploitation states of the alert." }, "cvssScoreMinimum": { "type": "number", "format": "float", "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]." } }, "description": "TechnologyWatchListAlertThreshold contains the thresholds for alerting." }, "DataLeakAlertDetail": { "type": "object", "required": [ "severity", "discoveryDocumentIds" ], "description": "Captures the specific details of Data Leak alert.", "properties": { "severity": { "type": "string", "description": "Required. The severity of the Data Leak 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" } } } }, "CustomerProfileContactInfo": { "type": "object", "description": "Contact information for the customer profile.", "properties": { "citationIds": { "description": "Optional. The citation ids for the contact information.", "type": "array", "items": { "type": "string" } }, "phone": { "type": "string", "description": "The phone number of the contact." }, "address": { "description": "The address of the contact.", "type": "string" }, "email": { "description": "The email address of the contact.", "type": "string" }, "other": { "description": "The other contact information.", "type": "string" }, "label": { "description": "Optional. The name of the contact.", "type": "string" } } }, "FindingDetail": { "properties": { "insiderThreat": { "description": "Insider Threat finding detail type.", "allOf": [ { "$ref": "#/components/schemas/InsiderThreatFindingDetail" } ] }, "detailType": { "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.", "type": "string" }, "initialAccessBroker": { "allOf": [ { "$ref": "#/components/schemas/InitialAccessBrokerFindingDetail" } ], "description": "Initial Access Broker finding detail type." }, "dataLeak": { "description": "Data Leak finding detail type.", "allOf": [ { "$ref": "#/components/schemas/DataLeakFindingDetail" } ] }, "targetTechnology": { "description": "Technology Watchlist finding detail type.", "allOf": [ { "$ref": "#/components/schemas/TargetTechnologyFindingDetail" } ] } }, "description": "Wrapper class that contains the union struct for all the various findings\ndetail specific classes.", "type": "object" }, "ListFindingsResponse": { "description": "Response message for ListFindings.", "properties": { "findings": { "type": "array", "items": { "$ref": "#/components/schemas/Finding" }, "description": "List of findings." }, "nextPageToken": { "type": "string", "description": "Page token." } }, "type": "object" }, "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": { "response": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL." }, "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`." }, "metadata": { "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.", "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL." } } } } ] }, "Audit": { "description": "Tracks basic CRUD facts.", "properties": { "createTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Output only. Time of creation." }, "updater": { "type": "string", "readOnly": true, "description": "Output only. Agent that last updated the record, could be a UserId or a JobId." }, "updateTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Output only. Time of creation or last update." }, "creator": { "readOnly": true, "description": "Output only. Agent that created or updated the record, could be a UserId or a JobId.", "type": "string" } }, "type": "object" }, "DataLeakFindingDetail": { "type": "object", "required": [ "matchScore", "severity", "documentId" ], "description": "A detail object for a Data Leak finding.", "properties": { "matchScore": { "type": "number", "format": "float", "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." }, "severity": { "enum": [ "SEVERITY_UNSPECIFIED", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "type": "string", "x-google-enum-descriptions": [ "Default value, should never be set.", "Low severity.", "Medium severity.", "High severity.", "Critical severity." ], "description": "Required. The severity of the Data Leak finding. This indicates the potential\nimpact of the threat." }, "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" } } }, "InitialAccessBrokerAlertDetail": { "type": "object", "required": [ "severity", "discoveryDocumentIds" ], "description": "Captures the specific details of InitialAccessBroker (IAB) alert.", "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": { "type": "array", "items": { "type": "string" }, "description": "Required. Array of ids to accommodate multiple discovery documents" } } }, "GenerateOrgProfileConfigurationRequest": { "type": "object", "required": [ "domain", "displayName" ], "description": "Request message for GenerateOrgProfileConfiguration.", "properties": { "displayName": { "type": "string", "description": "Required. The display name of the organization to generate the profile for." }, "domain": { "type": "string", "description": "Required. The domain of the organization to generate the profile for." } } }, "AlertDocumentTranslation": { "type": "object", "properties": { "translatedTitle": { "type": "string", "description": "Output only. The translated title of the document.", "readOnly": true }, "translatedContent": { "readOnly": true, "description": "Output only. The translated content of the document.", "type": "string" } }, "description": "The translation of an alert document." }, "PriorityAnalysis": { "type": "object", "description": "Structured priority analysis for a threat.", "properties": { "priorityLevel": { "allOf": [ { "$ref": "#/components/schemas/PriorityLevel" } ], "description": "The level of Priority." }, "confidence": { "allOf": [ { "$ref": "#/components/schemas/ConfidenceLevel" } ], "description": "The level of confidence in the given verdict." }, "reasoning": { "description": "Human-readable explanation from the model, detailing why a particular\nresult is considered to have a certain priority.", "type": "string" } } }, "InitialAccessBrokerFindingDetail": { "type": "object", "required": [ "matchScore", "severity", "documentId" ], "description": "A detail object for an Initial Access Broker (IAB) finding.", "properties": { "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." }, "severity": { "description": "Required. The severity of the IAB finding. This indicates the potential\nimpact of the threat.", "type": "string", "x-google-enum-descriptions": [ "", "", "", "", "" ], "enum": [ "SEVERITY_UNSPECIFIED", "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "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." } } }, "ConfigurationDetail": { "properties": { "customThreatScenario": { "description": "Custom Threat Scenario detail config.", "allOf": [ { "$ref": "#/components/schemas/CustomThreatScenarioConfig" } ] }, "customerProfile": { "description": "Customer Profile detail config.", "allOf": [ { "$ref": "#/components/schemas/CustomerProfileConfig" } ] }, "technologyWatchlist": { "description": "Technology Watchlist detail config.", "allOf": [ { "$ref": "#/components/schemas/TechnologyWatchListConfig" } ] }, "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." } }, "description": "Wrapper class that contains the union struct for all the various\nconfiguration detail specific classes.", "type": "object" }, "InsiderThreatFindingDetail": { "properties": { "matchScore": { "type": "number", "format": "float", "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." }, "severity": { "enum": [ "SEVERITY_UNSPECIFIED", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "type": "string", "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." }, "documentId": { "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.", "type": "string" } }, "description": "A detail object for a InsiderThreat finding.", "type": "object", "required": [ "matchScore", "severity", "documentId" ] }, "EnumerateAlertFacetsResponse": { "type": "object", "description": "Response message for EnumerateAlertFacets.", "properties": { "facets": { "type": "array", "items": { "$ref": "#/components/schemas/Facet" }, "description": "List of facets and the counts." } } }, "MarkAlertAsResolvedRequest": { "type": "object", "description": "Request message for MarkAlertAsResolved." }, "MarkAlertAsNotActionableRequest": { "description": "Request message for MarkAlertAsNotActionable.", "type": "object" }, "ThreatIntelObjectType": { "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" ], "type": "string", "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." ] }, "Facet": { "properties": { "minValue": { "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.", "type": "string" }, "facet": { "type": "string", "description": "Name of the facet. This is also the string that needs to be used in the\nfiltering expression." }, "totalCount": { "type": "string", "format": "int64", "description": "Total number of records that contain this facet with ANY value." }, "facetCounts": { "description": "List of counts for the facet (if categorical).", "type": "array", "items": { "$ref": "#/components/schemas/FacetCount" } }, "facetType": { "type": "string", "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." }, "maxValue": { "description": "Max value of the facet stringified based on type. Will be populated and\nformatted the same as min_value.", "type": "string" } }, "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.", "type": "object" }, "ConfigurationRevision": { "properties": { "snapshot": { "description": "The snapshot of the configuration", "allOf": [ { "$ref": "#/components/schemas/Configuration" } ] }, "createTime": { "description": "Output only. The time the Revision was created", "readOnly": true, "type": "string", "format": "date-time" }, "name": { "description": "Identifier. The name of the ConfigurationRevision\nFormat: projects//configurations//revisions/", "type": "string", "x-google-identifier": true } }, "description": "A ConfigurationRevision is a snapshot of a Configuration at a point in time.\nIt is immutable.", "type": "object" }, "AlertDetail": { "type": "object", "description": "Container for different types of alert details.", "properties": { "dataLeak": { "description": "Data Leak alert detail type.", "allOf": [ { "$ref": "#/components/schemas/DataLeakAlertDetail" } ] }, "targetTechnology": { "description": "Technology Watchlist alert detail type.", "allOf": [ { "$ref": "#/components/schemas/TargetTechnologyAlertDetail" } ] }, "initialAccessBroker": { "description": "Initial Access Broker alert detail type.", "allOf": [ { "$ref": "#/components/schemas/InitialAccessBrokerAlertDetail" } ] }, "insiderThreat": { "allOf": [ { "$ref": "#/components/schemas/InsiderThreatAlertDetail" } ], "description": "Insider Threat alert detail type." }, "detailType": { "type": "string", "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 } } }, "Configuration": { "type": "object", "required": [ "provider", "detail" ], "description": "A configuration represents a behavior an engine should follow when producing\nnew findings.", "properties": { "version": { "type": "string", "description": "Optional. A user-manipulatable version. Does not adhere to a specific format" }, "name": { "type": "string", "x-google-identifier": true, "description": "Identifier. Server generated name for the configuration.\nformat is projects/{project}/configurations/{configuration}" }, "detail": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationDetail" } ], "description": "Required. Domain specific details for the configuration." }, "description": { "description": "Optional. A description of the configuration.", "type": "string" }, "displayName": { "description": "Output only. Human readable name for the configuration.", "readOnly": true, "type": "string" }, "etag": { "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.", "type": "string" }, "provider": { "description": "Required. Name of the service that provides the configuration.", "type": "string" }, "audit": { "description": "Output only. Audit information for the configuration.", "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Audit" } ] }, "state": { "type": "string", "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." ], "enum": [ "STATE_UNSPECIFIED", "ENABLED", "DISABLED", "DEPRECATED" ], "description": "Optional. State of the configuration." } } }, "MarkAlertAsBenignRequest": { "description": "Request message for MarkAlertAsBenign.", "type": "object" }, "Alert": { "type": "object", "properties": { "detail": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/AlertDetail" } ], "description": "Output only. Details object for the alert, not all alerts will have a details object." }, "duplicatedBy": { "readOnly": true, "description": "Output only. alert names of the alerts that are duplicates of this alert.\nFormat: projects/{project}/alerts/{alert}", "type": "array", "items": { "type": "string" } }, "findingCount": { "type": "string", "format": "int64", "description": "Output only. The number of findings associated with this alert.", "readOnly": true }, "severityAnalysis": { "description": "Output only. High-Precision Severity Analysis for the alert.", "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/SeverityAnalysis" } ] }, "name": { "description": "Identifier. Server generated name for the alert.\nformat is projects/{project}/alerts/{alert}", "type": "string", "x-google-identifier": true }, "state": { "readOnly": true, "type": "string", "description": "Output only. State of the alert.", "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." ], "enum": [ "STATE_UNSPECIFIED", "NEW", "READ", "TRIAGED", "ESCALATED", "RESOLVED", "DUPLICATE", "FALSE_POSITIVE", "NOT_ACTIONABLE", "BENIGN", "TRACKED_EXTERNALLY" ] }, "displayName": { "type": "string", "description": "Output only. A short title for the alert.", "readOnly": true }, "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" }, "relevanceAnalysis": { "description": "Output only. High-Precision Relevance Analysis verdict for the alert.", "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/RelevanceAnalysis" } ] }, "configurations": { "description": "Output only. The resource names of the Configurations bound to this alert.\nFormat: projects/{project}/configurations/{configuration}", "readOnly": true, "type": "array", "items": { "type": "string" } }, "externalId": { "type": "string", "description": "Output only. External ID for the alert. This is used internally to provide protection\nagainst out of order updates.", "readOnly": true }, "duplicateOf": { "description": "Output only. alert name of the alert this alert is a duplicate of.\nFormat: projects/{project}/alerts/{alert}", "readOnly": true, "type": "string" }, "findings": { "description": "Output only. Findings that are covered by this alert.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "audit": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Audit" } ], "description": "Output only. Audit information for the alert." }, "priorityAnalysis": { "description": "Output only. High-Precision Priority Analysis for the alert.", "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/PriorityAnalysis" } ] }, "aiSummary": { "type": "string", "description": "Optional. AI summary of the alert." } }, "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." }, "TechnologyWatchListConfig": { "description": "TechnologyWatchListConfig is the configuration for the technology watchlist.", "properties": { "alertThreshold": { "description": "Optional. Alert thresholds to effectively reduce noise.", "allOf": [ { "$ref": "#/components/schemas/TechnologyWatchListAlertThreshold" } ] }, "technologies": { "type": "array", "items": { "type": "string" }, "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:*:*:*:*:*:*:*:*" } }, "type": "object" }, "BaseOperation": { "type": "object", "properties": { "done": { "type": "boolean", "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." }, "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": { "description": "The error result of the operation in case of failure or cancellation.", "allOf": [ { "$ref": "#/components/schemas/Status" } ] } }, "description": "This resource represents a long-running operation that is the result of a\nnetwork API call." }, "SearchFindingsResponse": { "type": "object", "description": "Response message for SearchFindings.", "properties": { "findings": { "description": "List of findings.", "type": "array", "items": { "$ref": "#/components/schemas/Finding" } }, "nextPageToken": { "type": "string", "description": "Page token." } } }, "InsiderThreatAlertDetail": { "description": "Captures the specific details of InsiderThreat alert.", "properties": { "severity": { "description": "Required. The severity of the Insider Threat alert.\nAllowed values are:\n* `LOW`\n* `MEDIUM`\n* `HIGH`\n* `CRITICAL`", "type": "string" }, "discoveryDocumentIds": { "type": "array", "items": { "type": "string" }, "description": "Required. Array of ids to accommodate multiple discovery documents" } }, "type": "object", "required": [ "severity", "discoveryDocumentIds" ] }, "ListConfigurationsResponse": { "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "Page token." }, "configurations": { "type": "array", "items": { "$ref": "#/components/schemas/Configuration" }, "description": "List of configurations." } }, "description": "Response message for ListConfigurations." }, "RelevanceAnalysis": { "type": "object", "description": "Structured relevance analysis for a threat.", "properties": { "confidence": { "description": "The level of confidence in the given verdict.", "allOf": [ { "$ref": "#/components/schemas/ConfidenceLevel" } ] }, "reasoning": { "description": "Human-readable explanation from the matcher, detailing why a particular\nresult is considered relevant or not relevant.", "type": "string" }, "relevanceLevel": { "description": "The level of relevance.", "allOf": [ { "$ref": "#/components/schemas/RelevanceLevel" } ] }, "relevant": { "type": "boolean", "description": "Indicates whether the threat is considered relevant." }, "evidence": { "description": "Evidence supporting the verdict, including matched and unmatched items.", "allOf": [ { "$ref": "#/components/schemas/Evidence" } ] } } }, "PublicExploit": { "description": "Contains details about a public exploit.", "properties": { "exploitName": { "type": "string", "description": "Required. The name of the exploit. Ex: \"Magentounauth.php.txt\"." }, "releaseTime": { "description": "Optional. The release time of the exploit.", "type": "string", "format": "date-time" }, "sizeBytes": { "description": "Optional. The size of the exploit.", "type": "string", "format": "int64" }, "exploitReliability": { "description": "Optional. The reliability of the exploit. Ex: \"Unreviewed\".", "type": "string", "x-google-enum-descriptions": [ "Unspecified exploit reliability.", "Confirmed exploit reliability.", "Uncorroborated exploit reliability.", "Unconfirmed exploit reliability." ], "enum": [ "EXPLOIT_RELIABILITY_UNSPECIFIED", "UNREVIEWED", "REVIEWED", "TESTED" ] }, "uri": { "type": "string", "description": "Optional. The URI of the exploit." }, "exploitGrade": { "description": "Optional. The grade of the exploit. Ex: \"non-weaponized\".", "type": "string", "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." ], "enum": [ "EXPLOIT_GRADE_UNSPECIFIED", "UNEVALUATED", "PROOF_OF_CONCEPT", "NON_WEAPONIZED", "WEAPONIZED", "SCANNER", "FAKE" ] } }, "type": "object", "required": [ "exploitName" ] }, "MarkAlertAsDuplicateRequest": { "type": "object", "properties": { "duplicateOf": { "type": "string", "description": "Optional. Name of the alert to mark as a duplicate of.\nFormat: projects/{project}/alerts/{alert}" } }, "description": "Request message for MarkAlertAsDuplicate." }, "CustomerProfileIndustry": { "properties": { "industry": { "type": "string", "description": "Required. The name of the industry." }, "citationIds": { "description": "Optional. The citation ids for the industry.", "type": "array", "items": { "type": "string" } } }, "description": "Industry information for the customer profile.", "type": "object", "required": [ "industry" ] }, "FacetCount": { "description": "FacetCount represents a count of records with each facet value.", "properties": { "value": { "type": "string", "description": "Value of the facet stringified.\nTimestamps will be formatted using RFC3339." }, "count": { "description": "Count of records with the value.", "type": "integer", "format": "int32" } }, "type": "object" }, "CustomerProfileProduct": { "properties": { "brand": { "type": "string", "description": "Required. The brand of the product." }, "product": { "description": "Required. The name of the product.", "type": "string" }, "citationIds": { "description": "Optional. The citation ids for the product.", "type": "array", "items": { "type": "string" } } }, "description": "Product information for the customer profile.", "type": "object", "required": [ "product", "brand" ] }, "ListConfigurationRevisionsResponse": { "properties": { "nextPageToken": { "type": "string", "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." }, "revisions": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationRevision" }, "description": "The Configuration Revisions associated with the specified Configuration" } }, "description": "Response message for ListConfigurationRevisions.", "type": "object" }, "ListAlertsResponse": { "type": "object", "properties": { "alerts": { "description": "List of alerts.", "type": "array", "items": { "$ref": "#/components/schemas/Alert" } }, "nextPageToken": { "description": "Page token.", "type": "string" } }, "description": "Response message for ListAlerts." }, "Evidence": { "type": "object", "description": "Details the evidence used to determine the relevance verdict.", "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", "items": { "type": "string" }, "description": "A list of semantic themes or descriptions unique to one source or\nsemantically distant." } } }, "CustomerProfileCitation": { "description": "Citation information for the customer profile.", "properties": { "uri": { "description": "Optional. The url of the citation.", "type": "string" }, "source": { "type": "string", "description": "Required. The source of the citation." }, "document": { "type": "string", "description": "Required. The name of the document the citation is from." }, "citationId": { "type": "string", "description": "Required. The citation id for the citation. Should be unique within the profile." }, "retrievalTime": { "type": "string", "format": "date-time", "description": "The time the citation was retrieved." } }, "type": "object", "required": [ "citationId", "source", "document" ] } }, "parameters": { "prettyPrint": { "description": "Returns response with indentations and line breaks.", "in": "query", "name": "$prettyPrint", "schema": { "default": "true", "type": "boolean" } }, "alt": { "name": "$alt", "description": "Data format for response.", "in": "query", "schema": { "enum": [ "json", "media", "proto" ], "default": "json", "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" ], "type": "string" } }, "callback": { "description": "JSONP", "in": "query", "name": "$callback", "schema": { "type": "string" } }, "_.xgafv": { "description": "V1 error format.", "in": "query", "name": "$.xgafv", "schema": { "x-google-enum-descriptions": [ "v1 error format", "v2 error format" ], "type": "string", "enum": [ "1", "2" ] } } }, "securitySchemes": { "google_oauth_code": { "type": "oauth2", "flows": { "authorizationCode": { "refreshUrl": "https://oauth2.googleapis.com/token", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "tokenUrl": "https://oauth2.googleapis.com/token", "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." }, "bearer_auth": { "type": "http", "description": "Http bearer authentication.", "scheme": "bearer" }, "google_oauth_implicit": { "type": "oauth2", "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." } } }, "description": "Google Oauth 2.0 implicit authentication flow." } } } }