{ "documentationLink": "https://docs.cloud.google.com/threatintelligence/", "basePath": "", "version": "v1beta", "protocol": "rest", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "rootUrl": "https://threatintelligence.googleapis.com/", "version_module": true, "resources": { "projects": { "methods": { "generateOrgProfile": { "parameters": { "name": { "description": "Required. The name of the project to generate the profile for. Format: projects/{project}", "required": true, "type": "string", "pattern": "^projects/[^/]+$", "location": "path" } }, "description": "Triggers the generation of a Customer Profile for a project.", "flatPath": "v1beta/projects/{projectsId}:generateOrgProfile", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GenerateOrgProfileConfigurationRequest" }, "response": { "$ref": "Operation" }, "id": "threatintelligence.projects.generateOrgProfile", "path": "v1beta/{+name}:generateOrgProfile", "httpMethod": "POST", "parameterOrder": [ "name" ] } }, "resources": { "configurations": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/configurations/[^/]+$", "required": true, "type": "string", "description": "Required. Name of the configuration to get. Format: vaults/{vault}/configurations/{configuration}" } }, "description": "Get a configuration by name.", "flatPath": "v1beta/projects/{projectsId}/configurations/{configurationsId}", "id": "threatintelligence.projects.configurations.get", "path": "v1beta/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "Configuration" } }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "orderBy": { "description": "Optional. Order by criteria in the csv format: \"field1,field2 desc\" or \"field1,field2\" or \"field1 asc, field2\".", "location": "query", "type": "string" }, "parent": { "type": "string", "required": true, "description": "Required. Parent of the configuration. Format: vaults/{vault}", "location": "path", "pattern": "^projects/[^/]+$" }, "filter": { "description": "Optional. Filter criteria.", "location": "query", "type": "string" }, "pageToken": { "description": "Optional. Page token.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. Page size.", "location": "query", "type": "integer", "format": "int32" } }, "description": "Get a list of configurations that meet the filter criteria.", "flatPath": "v1beta/projects/{projectsId}/configurations", "id": "threatintelligence.projects.configurations.list", "path": "v1beta/{+parent}/configurations", "httpMethod": "GET", "parameterOrder": [ "parent" ], "response": { "$ref": "ListConfigurationsResponse" } }, "upsert": { "flatPath": "v1beta/projects/{projectsId}/configurations:upsert", "description": "Creates or updates a configuration.", "parameters": { "parent": { "description": "Required. Parent of the configuration.", "required": true, "type": "string", "pattern": "^projects/[^/]+$", "location": "path" }, "publishTime": { "description": "Optional. Time that the configuration should be considered to have been published. This is an advanced feature used when onboarding and bulk loading data from other systems. Do not set this field without consulting with the API team.", "location": "query", "type": "string", "format": "google-datetime" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "UpsertConfigurationResponse" }, "request": { "$ref": "Configuration" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "path": "v1beta/{+parent}/configurations:upsert", "id": "threatintelligence.projects.configurations.upsert" } }, "resources": { "revisions": { "methods": { "list": { "path": "v1beta/{+parent}/revisions", "httpMethod": "GET", "parameterOrder": [ "parent" ], "id": "threatintelligence.projects.configurations.revisions.list", "response": { "$ref": "ListConfigurationRevisionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/configurations/{configurationsId}/revisions", "parameters": { "orderBy": { "description": "Optional. Specify ordering of response", "location": "query", "type": "string" }, "parent": { "description": "Required. The name of the Configuration to retrieve Revisions for", "type": "string", "required": true, "pattern": "^projects/[^/]+/configurations/[^/]+$", "location": "path" }, "filter": { "location": "query", "type": "string", "description": "Optional. An AIP-160 filter string" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "Optional. Page Size" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A page token provided by the API" } }, "description": "List configuration revisions that meet the filter criteria." } } } } }, "findings": { "methods": { "search": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "SearchFindings is a more powerful version of ListFindings that supports complex queries like \"findings for alerts\" using functions such as `has_alert` in the query string. The `parent` field in SearchFindingsRequest should have the format: projects/{project} Example to search for findings for a specific issue: `has_alert(\"name=\\\"projects/gti-12345/alerts/alert-12345\\\"\")`", "parameters": { "parent": { "description": "Required. Parent of the findings. Format: vaults/{vault}", "type": "string", "required": true, "pattern": "^projects/[^/]+$", "location": "path" }, "query": { "description": "Optional. Query on what findings will be returned. This supports the same filter criteria as FindingService.ListFindings as well as the following relationship query `has_alert`. Example: - `has_alert(\"name=\\\"projects/gti-12345/alerts/alert-12345\\\"\")`", "location": "query", "type": "string" }, "pageToken": { "description": "Optional. Page token.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. Page size.", "location": "query", "type": "integer", "format": "int32" }, "orderBy": { "description": "Optional. Order by criteria in the csv format: \"field1,field2 desc\" or \"field1,field2\" or \"field1 asc, field2\".", "location": "query", "type": "string" } }, "flatPath": "v1beta/projects/{projectsId}/findings:search", "id": "threatintelligence.projects.findings.search", "httpMethod": "GET", "parameterOrder": [ "parent" ], "path": "v1beta/{+parent}/findings:search", "response": { "$ref": "SearchFindingsResponse" } }, "get": { "response": { "$ref": "Finding" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1beta/{+name}", "id": "threatintelligence.projects.findings.get", "flatPath": "v1beta/projects/{projectsId}/findings/{findingsId}", "description": "Get a finding by name. The `name` field should have the format: `projects/{project}/findings/{finding}`", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/findings/[^/]+$", "required": true, "type": "string", "description": "Required. Name of the finding to get." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "response": { "$ref": "ListFindingsResponse" }, "id": "threatintelligence.projects.findings.list", "path": "v1beta/{+parent}/findings", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "pageToken": { "description": "Optional. Page token.", "location": "query", "type": "string" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "Optional. Page size." }, "parent": { "pattern": "^projects/[^/]+$", "location": "path", "description": "Required. Parent of the findings.", "type": "string", "required": true }, "filter": { "location": "query", "type": "string", "description": "Optional. Filter criteria." }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Order by criteria in the csv format: \"field1,field2 desc\" or \"field1,field2\" or \"field1 asc, field2\"." } }, "description": "Get a list of findings that meet the filter criteria. The `parent` field in ListFindingsRequest should have the format: projects/{project}", "flatPath": "v1beta/projects/{projectsId}/findings", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "alerts": { "methods": { "notActionable": { "parameters": { "name": { "pattern": "^projects/[^/]+/alerts/[^/]+$", "location": "path", "description": "Required. Name of the alert to mark as a not actionable. Format: projects/{project}/alerts/{alert}", "required": true, "type": "string" } }, "description": "Marks an alert as not actionable - NOT_ACTIONABLE.", "flatPath": "v1beta/projects/{projectsId}/alerts/{alertsId}:notActionable", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "MarkAlertAsNotActionableRequest" }, "response": { "$ref": "Alert" }, "id": "threatintelligence.projects.alerts.notActionable", "path": "v1beta/{+name}:notActionable", "httpMethod": "POST", "parameterOrder": [ "name" ] }, "resolve": { "response": { "$ref": "Alert" }, "request": { "$ref": "MarkAlertAsResolvedRequest" }, "id": "threatintelligence.projects.alerts.resolve", "httpMethod": "POST", "parameterOrder": [ "name" ], "path": "v1beta/{+name}:resolve", "description": "Marks an alert to closed state - RESOLVED.", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/alerts/[^/]+$", "required": true, "type": "string", "description": "Required. Name of the alert to mark as resolved. Format: projects/{project}/alerts/{alert}" } }, "flatPath": "v1beta/projects/{projectsId}/alerts/{alertsId}:resolve", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "getPassword": { "response": { "$ref": "GetPasswordResponse" }, "id": "threatintelligence.projects.alerts.getPassword", "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1beta/{+name}:getPassword", "description": "Get the decrypted password of an alert.", "parameters": { "name": { "description": "Required. Name of the alert to get password for. Format: projects/{project}/alerts/{alert}", "required": true, "type": "string", "pattern": "^projects/[^/]+/alerts/[^/]+$", "location": "path" } }, "flatPath": "v1beta/projects/{projectsId}/alerts/{alertsId}:getPassword", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "triage": { "path": "v1beta/{+name}:triage", "httpMethod": "POST", "parameterOrder": [ "name" ], "id": "threatintelligence.projects.alerts.triage", "request": { "$ref": "MarkAlertAsTriagedRequest" }, "response": { "$ref": "Alert" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/alerts/{alertsId}:triage", "parameters": { "name": { "type": "string", "required": true, "description": "Required. Name of the alert to mark as a triaged. Format: projects/{project}/alerts/{alert}", "location": "path", "pattern": "^projects/[^/]+/alerts/[^/]+$" } }, "description": "Marks an alert as triaged - TRIAGED." }, "trackExternally": { "request": { "$ref": "MarkAlertAsTrackedExternallyRequest" }, "response": { "$ref": "Alert" }, "path": "v1beta/{+name}:trackExternally", "httpMethod": "POST", "parameterOrder": [ "name" ], "id": "threatintelligence.projects.alerts.trackExternally", "flatPath": "v1beta/projects/{projectsId}/alerts/{alertsId}:trackExternally", "parameters": { "name": { "required": true, "type": "string", "description": "Required. Name of the alert to mark as tracked externally. Format: projects/{project}/alerts/{alert}", "location": "path", "pattern": "^projects/[^/]+/alerts/[^/]+$" } }, "description": "Marks an alert as tracked externally - TRACKED_EXTERNALLY.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "id": "threatintelligence.projects.alerts.get", "path": "v1beta/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "Alert" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/alerts/[^/]+$", "location": "path", "description": "Required. Name of the alert to get. Format: projects/{project}/alerts/{alert}", "type": "string", "required": true } }, "description": "Get an alert by name.", "flatPath": "v1beta/projects/{projectsId}/alerts/{alertsId}" }, "list": { "path": "v1beta/{+parent}/alerts", "httpMethod": "GET", "parameterOrder": [ "parent" ], "id": "threatintelligence.projects.alerts.list", "response": { "$ref": "ListAlertsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/alerts", "parameters": { "orderBy": { "description": "Optional. Order by criteria in the csv format: \"field1, field2 desc\" or \"field1, field2\" or \"field1 asc, field2\". If a field is specified without `asc` or `desc`, ascending order is used by default. Supported fields for ordering are identical to those supported for filtering. Examples: * `audit.create_time desc` * `audit.update_time asc` * `audit.create_time desc, severity_analysis.severity_level desc`", "location": "query", "type": "string" }, "parent": { "location": "path", "pattern": "^projects/[^/]+$", "required": true, "type": "string", "description": "Required. Parent of the alerts. Format: projects/{project}" }, "filter": { "description": "Optional. Filter criteria. Supported fields for filtering include: * `audit.create_time` * `audit.creator` * `audit.update_time` * `audit.updater` * `detail.data_leak.discovery_document_ids` * `detail.data_leak.severity` * `detail.detail_type` * `detail.initial_access_broker.discovery_document_ids` * `detail.initial_access_broker.severity` * `detail.insider_threat.discovery_document_ids` * `detail.insider_threat.severity` * `finding_count` * `priority_analysis.priority_level` * `relevance_analysis.confidence` * `relevance_analysis.relevance_level` * `relevance_analysis.relevant` * `severity_analysis.severity_level` * `state` Examples: * `detail.detail_type = \"initial_access_broker\"` * `detail.detail_type != \"data_leak\"` * `detail.insider_threat.severity = \"HIGH\"` * `audit.create_time \u003e= \"2026-04-03T00:00:00Z\" AND audit.create_time \u003c \"2026-04-06T00:00:00Z\"` * `state = \"NEW\" OR state = \"TRIAGED\"` * `severity_analysis.severity_level = \"SEVERITY_LEVEL_CRITICAL\"`", "location": "query", "type": "string" }, "pageToken": { "description": "Optional. Page token to retrieve the next page of results.", "location": "query", "type": "string" }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "Optional. Page size. Default to 100 alerts per page. Maximum is 1000 alerts per page." } }, "description": "Get a list of alerts that meet the filter criteria." }, "enumerateFacets": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "EnumerateAlertFacets returns the facets and the number of alerts that meet the filter criteria and have that value for each facet.", "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+$", "type": "string", "required": true, "description": "Required. Parent of the alerts." }, "filter": { "description": "Optional. Filter on what alerts will be enumerated.", "location": "query", "type": "string" } }, "flatPath": "v1beta/projects/{projectsId}/alerts:enumerateFacets", "id": "threatintelligence.projects.alerts.enumerateFacets", "httpMethod": "GET", "parameterOrder": [ "parent" ], "path": "v1beta/{+parent}/alerts:enumerateFacets", "response": { "$ref": "EnumerateAlertFacetsResponse" } }, "benign": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/alerts/{alertsId}:benign", "parameters": { "name": { "type": "string", "required": true, "description": "Required. Name of the alert to mark as a benign. Format: projects/{project}/alerts/{alert}", "location": "path", "pattern": "^projects/[^/]+/alerts/[^/]+$" } }, "description": "Marks an alert as benign - BENIGN.", "path": "v1beta/{+name}:benign", "httpMethod": "POST", "parameterOrder": [ "name" ], "id": "threatintelligence.projects.alerts.benign", "request": { "$ref": "MarkAlertAsBenignRequest" }, "response": { "$ref": "Alert" } }, "duplicate": { "response": { "$ref": "Alert" }, "request": { "$ref": "MarkAlertAsDuplicateRequest" }, "id": "threatintelligence.projects.alerts.duplicate", "httpMethod": "POST", "parameterOrder": [ "name" ], "path": "v1beta/{+name}:duplicate", "description": "Marks an alert as a duplicate of another alert. - DUPLICATE.", "parameters": { "name": { "pattern": "^projects/[^/]+/alerts/[^/]+$", "location": "path", "description": "Required. Name of the alert to mark as a duplicate. Format: projects/{project}/alerts/{alert}", "required": true, "type": "string" } }, "flatPath": "v1beta/projects/{projectsId}/alerts/{alertsId}:duplicate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "escalate": { "path": "v1beta/{+name}:escalate", "httpMethod": "POST", "parameterOrder": [ "name" ], "id": "threatintelligence.projects.alerts.escalate", "request": { "$ref": "MarkAlertAsEscalatedRequest" }, "response": { "$ref": "Alert" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/alerts/{alertsId}:escalate", "parameters": { "name": { "type": "string", "required": true, "description": "Required. Name of the alert to mark as escalated. Format: projects/{project}/alerts/{alert}", "location": "path", "pattern": "^projects/[^/]+/alerts/[^/]+$" } }, "description": "Marks an alert as escalated - ESCALATED." }, "read": { "response": { "$ref": "Alert" }, "request": { "$ref": "MarkAlertAsReadRequest" }, "httpMethod": "POST", "parameterOrder": [ "name" ], "path": "v1beta/{+name}:read", "id": "threatintelligence.projects.alerts.read", "flatPath": "v1beta/projects/{projectsId}/alerts/{alertsId}:read", "description": "Marks an alert as read - READ.", "parameters": { "name": { "pattern": "^projects/[^/]+/alerts/[^/]+$", "location": "path", "description": "Required. Name of the alert to mark as read. Format: projects/{project}/alerts/{alert}", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "falsePositive": { "id": "threatintelligence.projects.alerts.falsePositive", "httpMethod": "POST", "parameterOrder": [ "name" ], "path": "v1beta/{+name}:falsePositive", "response": { "$ref": "Alert" }, "request": { "$ref": "MarkAlertAsFalsePositiveRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Marks an alert as a false positive - FALSE_POSITIVE.", "parameters": { "name": { "pattern": "^projects/[^/]+/alerts/[^/]+$", "location": "path", "description": "Required. Name of the alert to mark as a false positive. Format: projects/{project}/alerts/{alert}", "required": true, "type": "string" } }, "flatPath": "v1beta/projects/{projectsId}/alerts/{alertsId}:falsePositive" } }, "resources": { "documents": { "methods": { "get": { "response": { "$ref": "AlertDocument" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1beta/{+name}", "id": "threatintelligence.projects.alerts.documents.get", "flatPath": "v1beta/projects/{projectsId}/alerts/{alertsId}/documents/{documentsId}", "description": "Gets a specific document associated with an alert.", "parameters": { "name": { "type": "string", "required": true, "description": "Required. Name of the alert document to get. Format: projects/{project}/alerts/{alert}/documents/{document}", "location": "path", "pattern": "^projects/[^/]+/alerts/[^/]+/documents/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } } } }, "parameters": { "prettyPrint": { "description": "Returns response with indentations and line breaks.", "default": "true", "type": "boolean", "location": "query" }, "access_token": { "description": "OAuth access token.", "type": "string", "location": "query" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" }, "$.xgafv": { "enum": [ "1", "2" ], "location": "query", "enumDescriptions": [ "v1 error format", "v2 error format" ], "description": "V1 error format.", "type": "string" }, "key": { "type": "string", "location": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, "upload_protocol": { "type": "string", "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "quotaUser": { "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "type": "string", "location": "query" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, "callback": { "type": "string", "location": "query", "description": "JSONP" }, "fields": { "type": "string", "location": "query", "description": "Selector specifying which fields to include in a partial response." }, "alt": { "type": "string", "default": "json", "description": "Data format for response.", "location": "query", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "enum": [ "json", "media", "proto" ] } }, "schemas": { "CustomerProfileLocation": { "type": "object", "properties": { "facilityType": { "type": "string", "description": "Optional. The type of location." }, "address": { "description": "Required. The address of the location.", "type": "string" }, "citationIds": { "type": "array", "items": { "type": "string" }, "description": "Optional. The citation ids for the location." }, "brand": { "type": "string", "description": "Required. The brand of the location." } }, "id": "CustomerProfileLocation", "description": "Location information for the customer profile." }, "InitialAccessBrokerFindingDetail": { "type": "object", "properties": { "documentId": { "type": "string", "description": "Required. The unique identifier of the document that triggered the IAB finding. This ID can be used to retrieve the content of the document for further analysis." }, "severity": { "description": "Required. The severity of the IAB finding. This indicates the potential impact of the threat.", "enum": [ "SEVERITY_UNSPECIFIED", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "enumDescriptions": [ "", "", "", "", "" ], "type": "string" }, "matchScore": { "description": "Required. Reference to the match score of the IAB finding. This is a float value between 0 and 1 calculated by the matching engine based on the similarity of the document and the user provided configurations.", "type": "number", "format": "float" } }, "id": "InitialAccessBrokerFindingDetail", "description": "A detail object for an Initial Access Broker (IAB) finding." }, "PublicExploit": { "id": "PublicExploit", "description": "Contains details about a public exploit.", "properties": { "uri": { "description": "Optional. The URI of the exploit.", "type": "string" }, "releaseTime": { "type": "string", "format": "google-datetime", "description": "Optional. The release time of the exploit." }, "exploitName": { "description": "Required. The name of the exploit. Ex: \"Magentounauth.php.txt\".", "type": "string" }, "exploitReliability": { "type": "string", "enumDescriptions": [ "Unspecified exploit reliability.", "Confirmed exploit reliability.", "Uncorroborated exploit reliability.", "Unconfirmed exploit reliability." ], "enum": [ "EXPLOIT_RELIABILITY_UNSPECIFIED", "UNREVIEWED", "REVIEWED", "TESTED" ], "description": "Optional. The reliability of the exploit. Ex: \"Unreviewed\"." }, "sizeBytes": { "format": "int64", "type": "string", "description": "Optional. The size of the exploit." }, "exploitGrade": { "enum": [ "EXPLOIT_GRADE_UNSPECIFIED", "UNEVALUATED", "PROOF_OF_CONCEPT", "NON_WEAPONIZED", "WEAPONIZED", "SCANNER", "FAKE" ], "description": "Optional. The grade of the exploit. Ex: \"non-weaponized\".", "type": "string", "enumDescriptions": [ "Unspecified exploit grade.", "Unevaluated exploit grade.", "Proof-of-concept exploit grade.", "Non-weaponized exploit grade.", "Weaponized exploit grade.", "Scanner exploit grade.", "Fake exploit grade." ] } }, "type": "object" }, "TargetTechnologyAlertDetail": { "id": "TargetTechnologyAlertDetail", "description": "Contains details for a technology watchlist alert.", "type": "object", "properties": { "vulnerabilityMatch": { "description": "Optional. The vulnerability match details.", "$ref": "VulnerabilityMatch" } } }, "Facet": { "type": "object", "properties": { "facetType": { "description": "The type of the facet. Options include \"string\", \"int\", \"float\", \"bool\", \"enum\", \"timestamp\", \"user\" and are useful to show the right sort of UI controls when building a AIP-160 style filtering string.", "type": "string" }, "minValue": { "type": "string", "description": "Min value of the facet stringified based on type. This is only populated for facets that have a clear ordering, for types like enum it will be left empty. Timestamps will be formatted using RFC3339." }, "facet": { "type": "string", "description": "Name of the facet. This is also the string that needs to be used in the filtering expression." }, "maxValue": { "description": "Max value of the facet stringified based on type. Will be populated and formatted the same as min_value.", "type": "string" }, "facetCounts": { "description": "List of counts for the facet (if categorical).", "type": "array", "items": { "$ref": "FacetCount" } }, "totalCount": { "description": "Total number of records that contain this facet with ANY value.", "format": "int64", "type": "string" } }, "id": "Facet", "description": "Facet represents a sub element of a resource for filtering. The results from this method are used to populate the filterable facets in the UI." }, "MarkAlertAsEscalatedRequest": { "id": "MarkAlertAsEscalatedRequest", "description": "Request message for MarkAlertAsEscalated.", "type": "object", "properties": {} }, "CustomerProfileProduct": { "properties": { "product": { "type": "string", "description": "Required. The name of the product." }, "brand": { "type": "string", "description": "Required. The brand of the product." }, "citationIds": { "description": "Optional. The citation ids for the product.", "type": "array", "items": { "type": "string" } } }, "type": "object", "id": "CustomerProfileProduct", "description": "Product information for the customer profile." }, "TargetTechnologyFindingDetail": { "type": "object", "properties": { "vulnerabilityMatch": { "description": "Optional. The vulnerability match details.", "$ref": "VulnerabilityMatch" } }, "id": "TargetTechnologyFindingDetail", "description": "Contains details for a technology watchlist finding." }, "Operation": { "id": "Operation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "done": { "type": "boolean", "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available." }, "name": { "type": "string", "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`." }, "metadata": { "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" }, "response": { "type": "object", "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" } } }, "CustomerProfileConfig": { "id": "CustomerProfileConfig", "description": "CustomerProfileConfig is the configuration for the customer profile.", "properties": { "locations": { "type": "array", "items": { "$ref": "CustomerProfileLocation" }, "description": "Optional. Locations the organization is present or conducts business in." }, "technologyPresence": { "description": "Optional. Technology presence of the organization.", "type": "string" }, "citations": { "description": "Optional. Citations for the organization profile.", "type": "array", "items": { "$ref": "CustomerProfileCitation" } }, "products": { "type": "array", "items": { "$ref": "CustomerProfileProduct" }, "description": "Optional. Product information for the organization." }, "executives": { "type": "array", "items": { "$ref": "CustomerProfilePerson" }, "description": "Optional. Executives of the organization." }, "industries": { "type": "array", "items": { "$ref": "CustomerProfileIndustry" }, "description": "Optional. The industries the organization is involved in." }, "parentCompanies": { "type": "array", "items": { "$ref": "CustomerProfileCompany" }, "description": "Optional. The parent companies of the organization." }, "org": { "type": "string", "description": "Required. The name of the organization." }, "webPresences": { "description": "Optional. Web presence of the organization.", "type": "array", "items": { "$ref": "CustomerProfileWebPresence" } }, "orgSummary": { "type": "string", "description": "Optional. A summary of the organization." }, "contactInfo": { "description": "Optional. Contact information for the organization.", "type": "array", "items": { "$ref": "CustomerProfileContactInfo" } }, "securityConsiderations": { "description": "Optional. Security considerations for the organization.", "$ref": "CustomerProfileSecurityConsiderations" }, "summary": { "description": "Optional. A summarized version of the customer profile.", "$ref": "CustomerProfileSummary" } }, "type": "object" }, "CustomerProfileCompany": { "id": "CustomerProfileCompany", "description": "Company information for the customer profile.", "properties": { "citationIds": { "description": "Optional. The citation ids for the company.", "type": "array", "items": { "type": "string" } }, "company": { "description": "Required. The name of the company.", "type": "string" } }, "type": "object" }, "SearchFindingsResponse": { "id": "SearchFindingsResponse", "description": "Response message for SearchFindings.", "properties": { "findings": { "type": "array", "items": { "$ref": "Finding" }, "description": "List of findings." }, "nextPageToken": { "type": "string", "description": "Page token." } }, "type": "object" }, "MarkAlertAsNotActionableRequest": { "id": "MarkAlertAsNotActionableRequest", "description": "Request message for MarkAlertAsNotActionable.", "type": "object", "properties": {} }, "FacetCount": { "properties": { "value": { "type": "string", "description": "Value of the facet stringified. Timestamps will be formatted using RFC3339." }, "count": { "description": "Count of records with the value.", "type": "integer", "format": "int32" } }, "type": "object", "id": "FacetCount", "description": "FacetCount represents a count of records with each facet value." }, "MarkAlertAsTrackedExternallyRequest": { "id": "MarkAlertAsTrackedExternallyRequest", "description": "Request message for MarkAlertAsTrackedExternally.", "properties": {}, "type": "object" }, "CustomerProfileWebPresence": { "id": "CustomerProfileWebPresence", "description": "Web presence information for the customer profile.", "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." } }, "type": "object" }, "CustomerProfileCitedString": { "id": "CustomerProfileCitedString", "description": "A string with citation ids.", "properties": { "value": { "type": "string", "description": "Required. The value of the string." }, "citationIds": { "type": "array", "items": { "type": "string" }, "description": "Optional. The citation ids for the string." } }, "type": "object" }, "TechnologyWatchListConfig": { "id": "TechnologyWatchListConfig", "description": "TechnologyWatchListConfig is the configuration for the technology watchlist.", "properties": { "technologies": { "type": "array", "items": { "type": "string" }, "description": "Optional. List of vendor, technology or cpe fingerprint. example: Microsoft office 360 Apache Server 3.5 cpe:2.3:a:microsoft:outlook:*:*:*:*:*:*:*:*" }, "alertThreshold": { "description": "Optional. Alert thresholds to effectively reduce noise.", "$ref": "TechnologyWatchListAlertThreshold" } }, "type": "object" }, "InsiderThreatFindingDetail": { "type": "object", "properties": { "matchScore": { "format": "float", "type": "number", "description": "Required. Reference to the match score of the InsiderThreat finding. This is a float value greater than 0 and less than or equal to 1 calculated by the matching engine based on the similarity of the document and the user provided configurations." }, "severity": { "description": "Required. The severity of the InsiderThreat finding. This indicates the potential impact of the threat.", "enum": [ "SEVERITY_UNSPECIFIED", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "enumDescriptions": [ "Default value, should never be set.", "Low severity.", "Medium severity.", "High severity.", "Critical severity." ], "type": "string" }, "documentId": { "description": "Required. The unique identifier of the document that triggered the InsiderThreat finding. This ID can be used to retrieve the content of the document for further analysis.", "type": "string" } }, "id": "InsiderThreatFindingDetail", "description": "A detail object for a InsiderThreat finding." }, "MarkAlertAsResolvedRequest": { "id": "MarkAlertAsResolvedRequest", "description": "Request message for MarkAlertAsResolved.", "properties": {}, "type": "object" }, "CustomerProfileIndustry": { "id": "CustomerProfileIndustry", "description": "Industry information for the customer profile.", "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" } } }, "type": "object" }, "InsiderThreatAlertDetail": { "type": "object", "properties": { "severity": { "description": "Required. The severity of the Insider Threat alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL`", "type": "string" }, "discoveryDocumentIds": { "description": "Required. Array of ids to accommodate multiple discovery documents", "type": "array", "items": { "type": "string" } } }, "id": "InsiderThreatAlertDetail", "description": "Captures the specific details of InsiderThreat alert." }, "AlertDocumentTranslation": { "type": "object", "properties": { "translatedTitle": { "readOnly": true, "type": "string", "description": "Output only. The translated title of the document." }, "translatedContent": { "description": "Output only. The translated content of the document.", "readOnly": true, "type": "string" } }, "id": "AlertDocumentTranslation", "description": "The translation of an alert document." }, "SeverityAnalysis": { "id": "SeverityAnalysis", "description": "Structured severity analysis for a threat.", "properties": { "severityLevel": { "description": "The level of severity.", "enum": [ "SEVERITY_LEVEL_UNSPECIFIED", "SEVERITY_LEVEL_LOW", "SEVERITY_LEVEL_MEDIUM", "SEVERITY_LEVEL_HIGH" ], "enumDescriptions": [ "Default value, should never be set.", "Low Severity.", "Medium Severity.", "High Severity." ], "type": "string" }, "confidence": { "type": "string", "enumDescriptions": [ "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" ], "description": "The level of confidence in the given verdict." }, "reasoning": { "type": "string", "description": "Human-readable explanation from the model, detailing why a particular result is considered to have a certain severity." } }, "type": "object" }, "MarkAlertAsTriagedRequest": { "type": "object", "properties": {}, "id": "MarkAlertAsTriagedRequest", "description": "Request message for MarkAlertAsTriaged." }, "Association": { "properties": { "type": { "enumDescriptions": [ "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." ], "type": "string", "description": "Required. The type of the association.", "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" ] }, "id": { "description": "Required. The ID of the association.", "type": "string" } }, "type": "object", "id": "Association", "description": "Represents an association with a vulnerability." }, "ListAlertsResponse": { "id": "ListAlertsResponse", "description": "Response message for ListAlerts.", "properties": { "alerts": { "description": "List of alerts.", "type": "array", "items": { "$ref": "Alert" } }, "nextPageToken": { "description": "Page token.", "type": "string" } }, "type": "object" }, "ListConfigurationsResponse": { "properties": { "configurations": { "type": "array", "items": { "$ref": "Configuration" }, "description": "List of configurations." }, "nextPageToken": { "description": "Page token.", "type": "string" } }, "type": "object", "id": "ListConfigurationsResponse", "description": "Response message for ListConfigurations." }, "CustomerProfileSummary": { "type": "object", "properties": { "primaryWebsite": { "description": "Optional. The primary website of the customer.", "$ref": "CustomerProfileCitedString" }, "areaServed": { "description": "Optional. The area the customer serves.", "$ref": "CustomerProfileCitedString" }, "headquarters": { "description": "Optional. The headquarters of the customer.", "$ref": "CustomerProfileCitedString" }, "brands": { "description": "Optional. A narrative summary of brands.", "$ref": "CustomerProfileCitedString" }, "entityType": { "description": "Optional. The entity type of the customer.", "$ref": "CustomerProfileCitedString" }, "title": { "description": "Optional. The official name of the customer.", "$ref": "CustomerProfileCitedString" }, "keyPeopleSummary": { "description": "Optional. A narrative summary of key people.", "$ref": "CustomerProfileCitedString" }, "productsSummary": { "description": "Optional. A narrative summary of products.", "$ref": "CustomerProfileCitedString" }, "parentCompany": { "description": "Optional. The parent company of the customer.", "$ref": "CustomerProfileCitedString" }, "industry": { "description": "Optional. The industry the customer is in.", "$ref": "CustomerProfileCitedString" }, "servicesSummary": { "description": "Optional. A narrative summary of services.", "$ref": "CustomerProfileCitedString" }, "founded": { "description": "Optional. The date the customer was founded.", "$ref": "CustomerProfileCitedString" } }, "id": "CustomerProfileSummary", "description": "A summarized version of the customer profile. Generated by the backend." }, "Evidence": { "properties": { "distinctThemes": { "type": "array", "items": { "type": "string" }, "description": "A list of semantic themes or descriptions unique to one source or semantically distant." }, "commonThemes": { "type": "array", "items": { "type": "string" }, "description": "A list of semantic themes or concepts found to be common, related, or aligned between the sources, supporting the verdict." } }, "type": "object", "id": "Evidence", "description": "Details the evidence used to determine the relevance verdict." }, "CustomerProfileCitation": { "type": "object", "properties": { "uri": { "description": "Optional. The url of the citation.", "type": "string" }, "citationId": { "type": "string", "description": "Required. The citation id for the citation. Should be unique within the profile." }, "retrievalTime": { "format": "google-datetime", "type": "string", "description": "The time the citation was retrieved." }, "source": { "type": "string", "description": "Required. The source of the citation." }, "document": { "type": "string", "description": "Required. The name of the document the citation is from." } }, "id": "CustomerProfileCitation", "description": "Citation information for the customer profile." }, "GenerateOrgProfileConfigurationRequest": { "id": "GenerateOrgProfileConfigurationRequest", "description": "Request message for GenerateOrgProfileConfiguration.", "type": "object", "properties": { "domain": { "description": "Required. The domain of the organization to generate the profile for.", "type": "string" }, "displayName": { "type": "string", "description": "Required. The display name of the organization to generate the profile for." } } }, "CustomerProfileContactInfo": { "properties": { "label": { "type": "string", "description": "Optional. The name of the contact." }, "phone": { "type": "string", "description": "The phone number of the contact." }, "address": { "description": "The address of the contact.", "type": "string" }, "other": { "type": "string", "description": "The other contact information." }, "citationIds": { "type": "array", "items": { "type": "string" }, "description": "Optional. The citation ids for the contact information." }, "email": { "description": "The email address of the contact.", "type": "string" } }, "type": "object", "id": "CustomerProfileContactInfo", "description": "Contact information for the customer profile." }, "CustomerProfileSecurityConsiderations": { "type": "object", "properties": { "note": { "description": "Optional. A note about the security considerations.", "type": "string" }, "considerations": { "description": "Optional. A series of considerations for the security of the organization, such as \"high risk of compromise\" or \"vulnerable to cyberbullying\".", "type": "array", "items": { "type": "string" } } }, "id": "CustomerProfileSecurityConsiderations", "description": "Security considerations for the customer profile." }, "CustomThreatScenarioConfig": { "id": "CustomThreatScenarioConfig", "description": "CustomThreatScenarioConfig represents a user-defined threat scenario configuration.", "type": "object", "properties": { "documentCondition": { "description": "Required. The condition driving the scenario, stored as a stringified JSON. This is used to query/filter documents.", "type": "string" } } }, "DataLeakAlertDetail": { "id": "DataLeakAlertDetail", "description": "Captures the specific details of Data Leak alert.", "properties": { "severity": { "description": "Required. The severity of the Data Leak alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL`", "type": "string" }, "discoveryDocumentIds": { "description": "Required. Array of ids to accommodate multiple discovery documents", "type": "array", "items": { "type": "string" } } }, "type": "object" }, "MarkAlertAsFalsePositiveRequest": { "id": "MarkAlertAsFalsePositiveRequest", "description": "Request message for MarkAlertAsFalsePositive.", "type": "object", "properties": {} }, "InitialAccessBrokerAlertDetail": { "id": "InitialAccessBrokerAlertDetail", "description": "Captures the specific details of InitialAccessBroker (IAB) alert.", "type": "object", "properties": { "severity": { "type": "string", "description": "Required. The severity of the Initial Access Broker (IAB) alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL`" }, "discoveryDocumentIds": { "type": "array", "items": { "type": "string" }, "description": "Required. Array of ids to accommodate multiple discovery documents" } } }, "Status": { "id": "Status", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "properties": { "code": { "format": "int32", "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code." }, "message": { "type": "string", "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client." }, "details": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use." } }, "type": "object" }, "FindingDetail": { "properties": { "insiderThreat": { "description": "Insider Threat finding detail type.", "$ref": "InsiderThreatFindingDetail" }, "dataLeak": { "description": "Data Leak finding detail type.", "$ref": "DataLeakFindingDetail" }, "targetTechnology": { "description": "Technology Watchlist finding detail type.", "$ref": "TargetTechnologyFindingDetail" }, "detailType": { "readOnly": true, "type": "string", "description": "Output only. Name of the detail type. Will be set by the server during creation to the name of the field that is set in the detail union." }, "initialAccessBroker": { "description": "Initial Access Broker finding detail type.", "$ref": "InitialAccessBrokerFindingDetail" } }, "type": "object", "id": "FindingDetail", "description": "Wrapper class that contains the union struct for all the various findings detail specific classes." }, "GetPasswordResponse": { "id": "GetPasswordResponse", "description": "Response message for GetPassword.", "type": "object", "properties": { "password": { "description": "The decrypted cleartext password for the compromised credential.", "type": "string" } } }, "ConfigurationDetail": { "properties": { "detailType": { "description": "Output only. Name of the detail type. Will be set by the server during creation to the name of the field that is set in the detail union.", "readOnly": true, "type": "string" }, "customThreatScenario": { "description": "Custom Threat Scenario detail config.", "$ref": "CustomThreatScenarioConfig" }, "customerProfile": { "description": "Customer Profile detail config.", "$ref": "CustomerProfileConfig" }, "technologyWatchlist": { "description": "Technology Watchlist detail config.", "$ref": "TechnologyWatchListConfig" } }, "type": "object", "id": "ConfigurationDetail", "description": "Wrapper class that contains the union struct for all the various configuration detail specific classes." }, "Configuration": { "id": "Configuration", "description": "A configuration represents a behavior an engine should follow when producing new findings.", "properties": { "audit": { "readOnly": true, "description": "Output only. Audit information for the configuration.", "$ref": "Audit" }, "version": { "type": "string", "description": "Optional. A user-manipulatable version. Does not adhere to a specific format" }, "name": { "description": "Identifier. Server generated name for the configuration. format is projects/{project}/configurations/{configuration}", "type": "string" }, "provider": { "description": "Required. Name of the service that provides the configuration.", "type": "string" }, "detail": { "description": "Required. Domain specific details for the configuration.", "$ref": "ConfigurationDetail" }, "description": { "type": "string", "description": "Optional. A description of the configuration." }, "state": { "enumDescriptions": [ "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", "description": "Optional. State of the configuration.", "enum": [ "STATE_UNSPECIFIED", "ENABLED", "DISABLED", "DEPRECATED" ] }, "displayName": { "description": "Output only. Human readable name for the configuration.", "readOnly": true, "type": "string" }, "etag": { "type": "string", "description": "If included when updating a configuration, this should be set to the current etag of the configuration. If the etags do not match, the update will be rejected and an ABORTED error will be returned." } }, "type": "object" }, "Alert": { "id": "Alert", "description": "Stateful object representing a group of Findings. Key feature to an Alert is that it expresses the user's intent towards the findings of that group, even those that haven't occurred yet.", "type": "object", "properties": { "findings": { "description": "Output only. Findings that are covered by this alert.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "detail": { "description": "Output only. Details object for the alert, not all alerts will have a details object.", "$ref": "AlertDetail", "readOnly": true }, "externalId": { "description": "Output only. External ID for the alert. This is used internally to provide protection against out of order updates.", "readOnly": true, "type": "string" }, "severityAnalysis": { "readOnly": true, "description": "Output only. High-Precision Severity Analysis for the alert.", "$ref": "SeverityAnalysis" }, "name": { "type": "string", "description": "Identifier. Server generated name for the alert. format is projects/{project}/alerts/{alert}" }, "audit": { "description": "Output only. Audit information for the alert.", "$ref": "Audit", "readOnly": true }, "configurations": { "description": "Output only. The resource names of the Configurations bound to this alert. Format: projects/{project}/configurations/{configuration}", "readOnly": true, "type": "array", "items": { "type": "string" } }, "priorityAnalysis": { "description": "Output only. High-Precision Priority Analysis for the alert.", "$ref": "PriorityAnalysis", "readOnly": true }, "duplicateOf": { "description": "Output only. alert name of the alert this alert is a duplicate of. Format: projects/{project}/alerts/{alert}", "readOnly": true, "type": "string" }, "aiSummary": { "description": "Optional. AI summary of the alert.", "type": "string" }, "etag": { "description": "Optional. If included when updating an alert, this should be set to the current etag of the alert. If the etags do not match, the update will be rejected and an ABORTED error will be returned.", "type": "string" }, "findingCount": { "description": "Output only. The number of findings associated with this alert.", "readOnly": true, "type": "string", "format": "int64" }, "duplicatedBy": { "readOnly": true, "type": "array", "items": { "type": "string" }, "description": "Output only. alert names of the alerts that are duplicates of this alert. Format: projects/{project}/alerts/{alert}" }, "state": { "enum": [ "STATE_UNSPECIFIED", "NEW", "READ", "TRIAGED", "ESCALATED", "RESOLVED", "DUPLICATE", "FALSE_POSITIVE", "NOT_ACTIONABLE", "BENIGN", "TRACKED_EXTERNALLY" ], "readOnly": true, "enumDescriptions": [ "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." ], "description": "Output only. State of the alert.", "type": "string" }, "displayName": { "readOnly": true, "type": "string", "description": "Output only. A short title for the alert." }, "relevanceAnalysis": { "readOnly": true, "description": "Output only. High-Precision Relevance Analysis verdict for the alert.", "$ref": "RelevanceAnalysis" } } }, "MarkAlertAsReadRequest": { "id": "MarkAlertAsReadRequest", "description": "Request message for MarkAlertAsRead.", "type": "object", "properties": {} }, "ConfigurationRevision": { "id": "ConfigurationRevision", "description": "A ConfigurationRevision is a snapshot of a Configuration at a point in time. It is immutable.", "type": "object", "properties": { "createTime": { "description": "Output only. The time the Revision was created", "format": "google-datetime", "readOnly": true, "type": "string" }, "name": { "description": "Identifier. The name of the ConfigurationRevision Format: projects//configurations//revisions/", "type": "string" }, "snapshot": { "description": "The snapshot of the configuration", "$ref": "Configuration" } } }, "CustomerProfilePerson": { "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": { "description": "Optional. The title of the person.", "type": "string" } }, "type": "object", "id": "CustomerProfilePerson", "description": "Person information for the customer profile." }, "TechnologyWatchListAlertThreshold": { "type": "object", "properties": { "cvssScoreMinimum": { "description": "Optional. The minimum CVSS score for the alert. Evaluates to CVSS v3 when available with a fallback to v2 and v4. Ex: 7.0. Valid range is [0.0, 10.0].", "type": "number", "format": "float" }, "riskRatingMinimum": { "enum": [ "RISK_RATING_UNSPECIFIED", "LOW", "MEDIUM", "HIGH", "CRITICAL", "UNRATED" ], "description": "Optional. The minimum risk rating for the alert.", "type": "string", "enumDescriptions": [ "Unspecified risk rating. This is the default value when the risk rating is 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 not be determined or assigned." ] }, "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": { "description": "Optional. The exploitation states of the alert.", "type": "array", "items": { "enum": [ "EXPLOITATION_STATE_UNSPECIFIED", "EXPLOITATION_STATE_NO_KNOWN", "EXPLOITATION_STATE_REPORTED", "EXPLOITATION_STATE_SUSPECTED", "EXPLOITATION_STATE_CONFIRMED", "EXPLOITATION_STATE_WIDESPREAD" ], "enumDescriptions": [ "Unspecified exploitation state.", "No known exploitation.", "Exploitation has been reported.", "Exploitation is suspected.", "Exploitation is confirmed.", "Widespread exploitation." ], "type": "string" } }, "priorityMinimum": { "enum": [ "PRIORITY_UNSPECIFIED", "P0", "P1", "P2", "P3", "P4" ], "description": "Optional. The minimum priority for the alert.", "type": "string", "enumDescriptions": [ "Unspecified priority.", "Priority level 0.", "Priority level 1.", "Priority level 2.", "Priority level 3.", "Priority level 4." ] } }, "id": "TechnologyWatchListAlertThreshold", "description": "TechnologyWatchListAlertThreshold contains the thresholds for alerting." }, "ProductFix": { "properties": { "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": "google-datetime" }, "displayName": { "type": "string", "description": "Required. The name of the fix. Ex: \"Magento\"." }, "uri": { "description": "Optional. The URI of the fix.", "type": "string" } }, "type": "object", "id": "ProductFix", "description": "Contains details about a product fix." }, "UpsertConfigurationResponse": { "properties": { "configuration": { "readOnly": true, "type": "string", "description": "Output only. Created configuration ID with server assigned id." } }, "type": "object", "id": "UpsertConfigurationResponse", "description": "Response message for UpsertConfiguration." }, "AlertDocument": { "id": "AlertDocument", "description": "A document that is associated with an alert.", "type": "object", "properties": { "name": { "type": "string", "description": "Identifier. Server generated name for the alert document. format is projects/{project}/alerts/{alert}/documents/{document}" }, "collectionTime": { "description": "Output only. Time when the origin source collected the intel.", "readOnly": true, "type": "string", "format": "google-datetime" }, "title": { "description": "Output only. The title of the document, if available.", "readOnly": true, "type": "string" }, "author": { "readOnly": true, "type": "string", "description": "Output only. The author of the document." }, "source": { "description": "Output only. Source of the intel item, e.g. DarkMarket.", "readOnly": true, "type": "string" }, "languageCode": { "readOnly": true, "type": "string", "description": "Output only. The language code of the document." }, "content": { "description": "Output only. The content of the document.", "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. The timestamp of the original external publication of the document.", "format": "google-datetime", "readOnly": true, "type": "string" }, "sourceUpdateTime": { "description": "Output only. Time when the intel was last updated by the source.", "readOnly": true, "type": "string", "format": "google-datetime" }, "ingestTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. Time when GTI received the intel." }, "aiSummary": { "readOnly": true, "type": "string", "description": "Output only. AI summary of the document." }, "translation": { "description": "Output only. The translation of the document, if available.", "$ref": "AlertDocumentTranslation", "readOnly": true }, "sourceUri": { "readOnly": true, "type": "string", "description": "Output only. URI of the intel item from the source." } } }, "VulnerabilityMatch": { "type": "object", "properties": { "productFixes": { "description": "Optional. List of product fixes for the vulnerability.", "type": "array", "items": { "$ref": "ProductFix" } }, "priority": { "enumDescriptions": [ "Unspecified priority.", "Priority level 0.", "Priority level 1.", "Priority level 2.", "Priority level 3.", "Priority level 4." ], "type": "string", "description": "Optional. The priority level of the vulnerability data. Ex: \"P1\".", "enum": [ "PRIORITY_UNSPECIFIED", "P0", "P1", "P2", "P3", "P4" ] }, "matchedTechnologies": { "type": "array", "items": { "type": "string" }, "description": "Optional. The specific technologies from the configured watchlist that triggered the match. Ex: \"Apache Struts\"." }, "associations": { "description": "Optional. Associated threat actors, malware, etc. This is embedded as a snapshot because the details of the association at the time of the vulnerability match are important for context and reporting.", "type": "array", "items": { "$ref": "Association" } }, "exploitationConsequences": { "description": "Optional. List of exploitation consequences for the vulnerability.", "type": "array", "items": { "enumDescriptions": [ "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": { "type": "string", "description": "Required. A description of the vulnerability." }, "cveId": { "type": "string", "description": "Required. The CVE ID of the vulnerability. Ex: \"CVE-2025-9876\". See https://www.cve.org/ for more information." }, "epssScore": { "type": "number", "format": "float", "description": "Optional. The EPSS score, representing the probability of exploitation. Example: 0.87." }, "cvss3Score": { "type": "number", "format": "float", "description": "Required. The CVSS score of the vulnerability. Evaluates to CVSS v3 when available with a fallback to v2 and v4. Example: 6.4." }, "exploitationState": { "enumDescriptions": [ "Unspecified exploitation state.", "No known exploitation.", "Exploitation has been reported.", "Exploitation is suspected.", "Exploitation is confirmed.", "Widespread exploitation." ], "type": "string", "description": "Required. The exploitation state of the vulnerability.", "enum": [ "EXPLOITATION_STATE_UNSPECIFIED", "EXPLOITATION_STATE_NO_KNOWN", "EXPLOITATION_STATE_REPORTED", "EXPLOITATION_STATE_SUSPECTED", "EXPLOITATION_STATE_CONFIRMED", "EXPLOITATION_STATE_WIDESPREAD" ] }, "riskRating": { "type": "string", "enumDescriptions": [ "Unspecified risk rating. This is the default value when the risk rating is 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 not be determined or assigned." ], "enum": [ "RISK_RATING_UNSPECIFIED", "LOW", "MEDIUM", "HIGH", "CRITICAL", "UNRATED" ], "description": "Required. The risk rating of the vulnerability." }, "collectionId": { "type": "string", "description": "Required. The collection ID of the vulnerability. Ex: \"vulnerability--cve-2025-9876\"." }, "disclosureTime": { "type": "string", "format": "google-datetime", "description": "Optional. The disclosure time of the vulnerability." }, "publicExploits": { "description": "Optional. List of public exploits.", "type": "array", "items": { "$ref": "PublicExploit" } }, "technologies": { "type": "array", "items": { "type": "string" }, "description": "Required. All technologies affected by the vulnerability. Ex: \"Apache Struts\"." }, "exploitationVectors": { "type": "array", "items": { "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" ], "type": "string", "enumDescriptions": [ "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": "Optional. List of exploitation vectors for the vulnerability." }, "publiclyAvailableExploit": { "readOnly": true, "type": "boolean", "description": "Output only. Whether a publicly available exploit exists." } }, "id": "VulnerabilityMatch", "description": "Contains details about a vulnerability match." }, "Finding": { "type": "object", "properties": { "alert": { "description": "Optional. Name of the alert that this finding is bound to.", "type": "string" }, "provider": { "description": "Required. Logical source of this finding (name of the sub-engine).", "type": "string" }, "relevanceAnalysis": { "readOnly": true, "description": "Output only. High-Precision Relevance Analysis verdict for the finding.", "$ref": "RelevanceAnalysis" }, "name": { "description": "Identifier. Server generated name for the finding (leave clear during creation). Format: projects/{project}/findings/{finding}", "type": "string" }, "severityAnalysis": { "description": "Output only. High-Precision Severity Analysis verdict for the finding.", "$ref": "SeverityAnalysis", "readOnly": true }, "reoccurrenceTimes": { "description": "Output only. When identical finding (same labels and same details) has re-occurred.", "readOnly": true, "type": "array", "items": { "format": "google-datetime", "type": "string" } }, "audit": { "description": "Output only. Audit data about the finding.", "$ref": "Audit", "readOnly": true }, "configurations": { "type": "array", "items": { "type": "string" }, "description": "Optional. Configuration names that are bound to this finding." }, "severity": { "description": "Optional. Deprecated: Use the `severity_analysis` field instead. Base severity score from the finding source.", "type": "number", "deprecated": true, "format": "float" }, "displayName": { "type": "string", "description": "Required. A short descriptive title for the finding \u003c= 250 chars. EX: \"Actor 'baddy' offering $1000 for credentials of 'goodguy'\"." }, "aiSummary": { "description": "Optional. AI summary of the finding.", "type": "string" }, "detail": { "description": "Required. Holder of the domain specific details of the finding.", "$ref": "FindingDetail" } }, "id": "Finding", "description": "A ‘stateless’ and a point in time event that a check produced a result of interest." }, "PriorityAnalysis": { "id": "PriorityAnalysis", "description": "Structured priority analysis for a threat.", "type": "object", "properties": { "priorityLevel": { "type": "string", "enumDescriptions": [ "Default value, should never be set.", "Low Priority.", "Medium Priority.", "High Priority.", "Critical Priority." ], "enum": [ "PRIORITY_LEVEL_UNSPECIFIED", "PRIORITY_LEVEL_LOW", "PRIORITY_LEVEL_MEDIUM", "PRIORITY_LEVEL_HIGH", "PRIORITY_LEVEL_CRITICAL" ], "description": "The level of Priority." }, "confidence": { "enum": [ "CONFIDENCE_LEVEL_UNSPECIFIED", "CONFIDENCE_LEVEL_LOW", "CONFIDENCE_LEVEL_MEDIUM", "CONFIDENCE_LEVEL_HIGH" ], "description": "The level of confidence in the given verdict.", "type": "string", "enumDescriptions": [ "Default value. Confidence level is not specified.", "Low confidence in the verdict.", "Medium confidence in the verdict.", "High confidence in the verdict." ] }, "reasoning": { "type": "string", "description": "Human-readable explanation from the model, detailing why a particular result is considered to have a certain priority." } } }, "ListConfigurationRevisionsResponse": { "id": "ListConfigurationRevisionsResponse", "description": "Response message for ListConfigurationRevisions.", "properties": { "revisions": { "type": "array", "items": { "$ref": "ConfigurationRevision" }, "description": "The Configuration Revisions associated with the specified Configuration" }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." } }, "type": "object" }, "RelevanceAnalysis": { "id": "RelevanceAnalysis", "description": "Structured relevance analysis for a threat.", "properties": { "relevant": { "description": "Indicates whether the threat is considered relevant.", "type": "boolean" }, "evidence": { "description": "Evidence supporting the verdict, including matched and unmatched items.", "$ref": "Evidence" }, "relevanceLevel": { "type": "string", "enumDescriptions": [ "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" ], "description": "The level of relevance." }, "confidence": { "type": "string", "enumDescriptions": [ "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" ], "description": "The level of confidence in the given verdict." }, "reasoning": { "description": "Human-readable explanation from the matcher, detailing why a particular result is considered relevant or not relevant.", "type": "string" } }, "type": "object" }, "Audit": { "type": "object", "properties": { "createTime": { "description": "Output only. Time of creation.", "format": "google-datetime", "readOnly": true, "type": "string" }, "creator": { "description": "Output only. Agent that created or updated the record, could be a UserId or a JobId.", "readOnly": true, "type": "string" }, "updateTime": { "description": "Output only. Time of creation or last update.", "format": "google-datetime", "readOnly": true, "type": "string" }, "updater": { "readOnly": true, "type": "string", "description": "Output only. Agent that last updated the record, could be a UserId or a JobId." } }, "id": "Audit", "description": "Tracks basic CRUD facts." }, "EnumerateAlertFacetsResponse": { "properties": { "facets": { "description": "List of facets and the counts.", "type": "array", "items": { "$ref": "Facet" } } }, "type": "object", "id": "EnumerateAlertFacetsResponse", "description": "Response message for EnumerateAlertFacets." }, "MarkAlertAsDuplicateRequest": { "id": "MarkAlertAsDuplicateRequest", "description": "Request message for MarkAlertAsDuplicate.", "type": "object", "properties": { "duplicateOf": { "type": "string", "description": "Optional. Name of the alert to mark as a duplicate of. Format: projects/{project}/alerts/{alert}" } } }, "MarkAlertAsBenignRequest": { "id": "MarkAlertAsBenignRequest", "description": "Request message for MarkAlertAsBenign.", "type": "object", "properties": {} }, "DataLeakFindingDetail": { "properties": { "documentId": { "description": "Required. The unique identifier of the document that triggered the Data Leak finding. This ID can be used to retrieve the content of the document for further analysis.", "type": "string" }, "matchScore": { "format": "float", "type": "number", "description": "Required. Reference to the match score of the Data Leak finding. This is a float value greater than 0 and less than or equal to 1 calculated by the matching engine based on the similarity of the document and the user provided configurations." }, "severity": { "description": "Required. The severity of the Data Leak finding. This indicates the potential impact of the threat.", "enum": [ "SEVERITY_UNSPECIFIED", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "enumDescriptions": [ "Default value, should never be set.", "Low severity.", "Medium severity.", "High severity.", "Critical severity." ], "type": "string" } }, "type": "object", "id": "DataLeakFindingDetail", "description": "A detail object for a Data Leak finding." }, "ListFindingsResponse": { "type": "object", "properties": { "findings": { "type": "array", "items": { "$ref": "Finding" }, "description": "List of findings." }, "nextPageToken": { "description": "Page token.", "type": "string" } }, "id": "ListFindingsResponse", "description": "Response message for ListFindings." }, "AlertDetail": { "properties": { "insiderThreat": { "description": "Insider Threat alert detail type.", "$ref": "InsiderThreatAlertDetail" }, "dataLeak": { "description": "Data Leak alert detail type.", "$ref": "DataLeakAlertDetail" }, "targetTechnology": { "description": "Technology Watchlist alert detail type.", "$ref": "TargetTechnologyAlertDetail" }, "detailType": { "readOnly": true, "type": "string", "description": "Output only. Name of the detail type. Will be set by the server during creation to the name of the field that is set in the detail union." }, "initialAccessBroker": { "description": "Initial Access Broker alert detail type.", "$ref": "InitialAccessBrokerAlertDetail" } }, "type": "object", "id": "AlertDetail", "description": "Container for different types of alert details." } }, "mtlsRootUrl": "https://threatintelligence.mtls.googleapis.com/", "id": "threatintelligence:v1beta", "name": "threatintelligence", "batchPath": "batch", "endpoints": [ { "location": "us-central1", "endpointUrl": "https://threatintelligence.us-central1.rep.googleapis.com/", "description": "Regional Endpoint" } ], "ownerName": "Google", "ownerDomain": "google.com", "kind": "discovery#restDescription", "baseUrl": "https://threatintelligence.googleapis.com/", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "canonicalName": "Threat Intelligence Service", "fullyEncodeReservedExpansion": true, "title": "Threat Intelligence API", "discoveryVersion": "v1", "revision": "20260809", "servicePath": "", "description": "threatintelligence.googleapis.com API." }