googleapis
Version:
Google APIs Client Library for Node.js
1,088 lines • 349 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace securitycenter_v1beta2 {
export interface Options extends GlobalOptions {
version: 'v1beta2';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* 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.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* 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.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Security Command Center API
*
* Security Command Center API provides access to temporal views of assets and findings within an organization.
*
* @example
* ```js
* const {google} = require('googleapis');
* const securitycenter = google.securitycenter('v1beta2');
* ```
*/
export class Securitycenter {
context: APIRequestContext;
folders: Resource$Folders;
organizations: Resource$Organizations;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Represents an access event.
*/
export interface Schema$Access {
/**
* Caller's IP address, such as "1.1.1.1".
*/
callerIp?: string | null;
/**
* The caller IP's geolocation, which identifies where the call came from.
*/
callerIpGeo?: Schema$Geolocation;
/**
* The method that the service account called, e.g. "SetIamPolicy".
*/
methodName?: string | null;
/**
* Associated email, such as "foo@google.com". The email address of the authenticated user (or service account on behalf of third party principal) making the request. For third party identity callers, the `principal_subject` field is populated instead of this field. For privacy reasons, the principal email address is sometimes redacted. For more information, see [Caller identities in audit logs](https://cloud.google.com/logging/docs/audit#user-id).
*/
principalEmail?: string | null;
/**
* A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name\}/subjects/{subject\}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name\}[{subject\}]`
*/
principalSubject?: string | null;
/**
* Identity delegation history of an authenticated service account that makes the request. It contains information on the real authorities that try to access GCP resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events.
*/
serviceAccountDelegationInfo?: Schema$ServiceAccountDelegationInfo[];
/**
* The name of the service account key used to create or exchange credentials for authenticating the service account making the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID\}/serviceAccounts/{ACCOUNT\}/keys/{key\}"
*/
serviceAccountKeyName?: string | null;
/**
* This is the API service that the service account made a call to, e.g. "iam.googleapis.com"
*/
serviceName?: string | null;
/**
* What kind of user agent is associated, e.g. operating system shells, embedded or stand-alone applications, etc.
*/
userAgentFamily?: string | null;
/**
* A string representing a username. This is likely not an IAM principal. For instance, this may be the system user name if the finding is VM-related, or this may be some type of application login user name, depending on the type of finding.
*/
userName?: string | null;
}
/**
* Conveys information about a Kubernetes access review (e.g. kubectl auth can-i ...) that was involved in a finding.
*/
export interface Schema$AccessReview {
/**
* Group is the API Group of the Resource. "*" means all.
*/
group?: string | null;
/**
* Name is the name of the resource being requested. Empty means all.
*/
name?: string | null;
/**
* Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty).
*/
ns?: string | null;
/**
* Resource is the optional resource type requested. "*" means all.
*/
resource?: string | null;
/**
* Subresource is the optional subresource type.
*/
subresource?: string | null;
/**
* Verb is a Kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all.
*/
verb?: string | null;
/**
* Version is the API Version of the Resource. "*" means all.
*/
version?: string | null;
}
/**
* A finding that is associated with this node in the exposure path.
*/
export interface Schema$AssociatedFinding {
/**
* Canonical name of the associated findings. Example: organizations/123/sources/456/findings/789
*/
canonicalFindingName?: string | null;
/**
* The additional taxonomy group within findings from a given source.
*/
findingCategory?: string | null;
}
/**
* Contains compliance information about a security standard indicating unmet recommendations.
*/
export interface Schema$Compliance {
/**
* Policies within the standard/benchmark e.g. A.12.4.1
*/
ids?: string[] | null;
/**
* Refers to industry wide standards or benchmarks e.g. "cis", "pci", "owasp", etc.
*/
standard?: string | null;
/**
* Version of the standard/benchmark e.g. 1.1
*/
version?: string | null;
}
/**
* Configuration of a module.
*/
export interface Schema$Config {
/**
* The state of enablement for the module at its level of the resource hierarchy.
*/
moduleEnablementState?: string | null;
/**
* The configuration value for the module. The absence of this field implies its inheritance from the parent.
*/
value?: {
[key: string]: any;
} | null;
}
/**
* Contains information about the IP connection associated with the finding.
*/
export interface Schema$Connection {
/**
* Destination IP address. Not present for sockets that are listening and not connected.
*/
destinationIp?: string | null;
/**
* Destination port. Not present for sockets that are listening and not connected.
*/
destinationPort?: number | null;
/**
* IANA Internet Protocol Number such as TCP(6) and UDP(17).
*/
protocol?: string | null;
/**
* Source IP address.
*/
sourceIp?: string | null;
/**
* Source port.
*/
sourcePort?: number | null;
}
/**
* Representa a single contact's email address
*/
export interface Schema$Contact {
/**
* An email address e.g. "person123@company.com"
*/
email?: string | null;
}
/**
* The details pertaining to specific contacts
*/
export interface Schema$ContactDetails {
/**
* A list of contacts
*/
contacts?: Schema$Contact[];
}
/**
* Container associated with the finding.
*/
export interface Schema$Container {
/**
* Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest.
*/
imageId?: string | null;
/**
* Container labels, as provided by the container runtime.
*/
labels?: Schema$Label[];
/**
* Container name.
*/
name?: string | null;
/**
* Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags.
*/
uri?: string | null;
}
/**
* Resource capturing the settings for the Container Threat Detection service.
*/
export interface Schema$ContainerThreatDetectionSettings {
/**
* The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
*/
modules?: {
[key: string]: Schema$Config;
} | null;
/**
* The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings
*/
name?: string | null;
/**
* Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project.
*/
serviceAccount?: string | null;
/**
* The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
*/
serviceEnablementState?: string | null;
/**
* Output only. The time the settings were last updated.
*/
updateTime?: string | null;
}
/**
* CVE stands for Common Vulnerabilities and Exposures. More information: https://cve.mitre.org
*/
export interface Schema$Cve {
/**
* Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document
*/
cvssv3?: Schema$Cvssv3;
/**
* The unique identifier for the vulnerability. e.g. CVE-2021-34527
*/
id?: string | null;
/**
* Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527
*/
references?: Schema$Reference[];
/**
* Whether upstream fix is available for the CVE.
*/
upstreamFixAvailable?: boolean | null;
}
/**
* Common Vulnerability Scoring System version 3.
*/
export interface Schema$Cvssv3 {
/**
* This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability.
*/
attackComplexity?: string | null;
/**
* Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible.
*/
attackVector?: string | null;
/**
* This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability.
*/
availabilityImpact?: string | null;
/**
* The base score is a function of the base metric scores.
*/
baseScore?: number | null;
/**
* This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability.
*/
confidentialityImpact?: string | null;
/**
* This metric measures the impact to integrity of a successfully exploited vulnerability.
*/
integrityImpact?: string | null;
/**
* This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability.
*/
privilegesRequired?: string | null;
/**
* The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope.
*/
scope?: string | null;
/**
* This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component.
*/
userInteraction?: string | null;
}
/**
* Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of CloudSQL instances or Cloud Spanner instances), or the database instance itself. Some database resources may not have the full resource name populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. CloudSQL databases). In these cases only the display name will be provided.
*/
export interface Schema$Database {
/**
* The human readable name of the database the user connected to.
*/
displayName?: string | null;
/**
* The target usernames/roles/groups of a SQL privilege grant (not an IAM policy change).
*/
grantees?: string[] | null;
/**
* The full resource name of the database the user connected to, if it is supported by CAI. (https://google.aip.dev/122#full-resource-names)
*/
name?: string | null;
/**
* The SQL statement associated with the relevant access.
*/
query?: string | null;
/**
* The username used to connect to the DB. This may not necessarily be an IAM principal, and has no required format.
*/
userName?: string | null;
}
/**
* Details of a subscription.
*/
export interface Schema$Details {
/**
* The time the subscription has or will end.
*/
endTime?: string | null;
/**
* The time the subscription has or will start.
*/
startTime?: string | null;
/**
* The type of subscription
*/
type?: string | null;
}
/**
* Memory hash detection contributing to the binary family match.
*/
export interface Schema$Detection {
/**
* The name of the binary associated with the memory hash signature detection.
*/
binary?: string | null;
/**
* The percentage of memory page hashes in the signature that were matched.
*/
percentPagesMatched?: number | null;
}
/**
* Represents a connection between a source node and a destination node in this exposure path.
*/
export interface Schema$Edge {
/**
* This is the resource name of the destination node.
*/
destination?: string | null;
/**
* This is the resource name of the source node.
*/
source?: string | null;
}
/**
* EnvironmentVariable is a name-value pair to store environment variables for Process.
*/
export interface Schema$EnvironmentVariable {
/**
* Environment variable name as a JSON encoded string.
*/
name?: string | null;
/**
* Environment variable value as a JSON encoded string.
*/
val?: string | null;
}
/**
* Resource capturing the settings for the Event Threat Detection service.
*/
export interface Schema$EventThreatDetectionSettings {
/**
* The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
*/
modules?: {
[key: string]: Schema$Config;
} | null;
/**
* The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization\}/eventThreatDetectionSettings * folders/{folder\}/eventThreatDetectionSettings * projects/{project\}/eventThreatDetectionSettings
*/
name?: string | null;
/**
* The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
*/
serviceEnablementState?: string | null;
/**
* Output only. The time the settings were last updated.
*/
updateTime?: string | null;
}
/**
* Resource that has been exfiltrated or exfiltrated_to.
*/
export interface Schema$ExfilResource {
/**
* Subcomponents of the asset that is exfiltrated - these could be URIs used during exfiltration, table names, databases, filenames, etc. For example, multiple tables may be exfiltrated from the same CloudSQL instance, or multiple files from the same Cloud Storage bucket.
*/
components?: string[] | null;
/**
* Resource's URI (https://google.aip.dev/122#full-resource-names)
*/
name?: string | null;
}
/**
* Exfiltration represents a data exfiltration attempt of one or more sources to one or more targets. Sources represent the source of data that is exfiltrated, and Targets represents the destination the data was copied to.
*/
export interface Schema$Exfiltration {
/**
* If there are multiple sources, then the data is considered "joined" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source.
*/
sources?: Schema$ExfilResource[];
/**
* If there are multiple targets, each target would get a complete copy of the "joined" source data.
*/
targets?: Schema$ExfilResource[];
}
/**
* File information about the related binary/library used by an executable, or the script used by a script interpreter
*/
export interface Schema$File {
/**
* Prefix of the file contents as a JSON encoded string. (Currently only populated for Malicious Script Executed findings.)
*/
contents?: string | null;
/**
* The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.
*/
hashedSize?: string | null;
/**
* True when the hash covers only a prefix of the file.
*/
partiallyHashed?: boolean | null;
/**
* Absolute path of the file as a JSON encoded string.
*/
path?: string | null;
/**
* SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file.
*/
sha256?: string | null;
/**
* Size of the file in bytes.
*/
size?: string | null;
}
/**
* Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding.
*/
export interface Schema$Finding {
/**
* Access details associated to the Finding, such as more information on the caller, which method was accessed, from where, etc.
*/
access?: Schema$Access;
/**
* The canonical name of the finding. It's either "organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}", "folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}" or "projects/{project_number\}/sources/{source_id\}/findings/{finding_id\}", depending on the closest CRM ancestor of the resource associated with the finding.
*/
canonicalName?: string | null;
/**
* The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION"
*/
category?: string | null;
/**
* Contains compliance information for security standards associated to the finding.
*/
compliances?: Schema$Compliance[];
/**
* Contains information about the IP connection associated with the finding.
*/
connections?: Schema$Connection[];
/**
* Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" \}, { "email": "person2@company.com" \} ] \} \}
*/
contacts?: {
[key: string]: Schema$ContactDetails;
} | null;
/**
* Containers associated with the finding. containers provides information for both Kubernetes and non-Kubernetes containers.
*/
containers?: Schema$Container[];
/**
* The time at which the finding was created in Security Command Center.
*/
createTime?: string | null;
/**
* Database associated with the finding.
*/
database?: Schema$Database;
/**
* Contains more detail about the finding.
*/
description?: string | null;
/**
* The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp.
*/
eventTime?: string | null;
/**
* Represents exfiltration associated with the Finding.
*/
exfiltration?: Schema$Exfiltration;
/**
* Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields.
*/
externalSystems?: {
[key: string]: Schema$GoogleCloudSecuritycenterV1ExternalSystem;
} | null;
/**
* The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL.
*/
externalUri?: string | null;
/**
* The class of the finding.
*/
findingClass?: string | null;
/**
* Represents IAM bindings associated with the Finding.
*/
iamBindings?: Schema$IamBinding[];
/**
* Represents what's commonly known as an Indicator of compromise (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. Reference: https://en.wikipedia.org/wiki/Indicator_of_compromise
*/
indicator?: Schema$Indicator;
/**
* Kubernetes resources associated with the finding.
*/
kubernetes?: Schema$Kubernetes;
/**
* MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org
*/
mitreAttack?: Schema$MitreAttack;
/**
* Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute.
*/
mute?: string | null;
/**
* First known as mute_annotation. Records additional information about the mute operation e.g. mute config that muted the finding, user who muted the finding, etc. Unlike other attributes of a finding, a finding provider shouldn't set the value of mute.
*/
muteInitiator?: string | null;
/**
* Output only. The most recent time this finding was muted or unmuted.
*/
muteUpdateTime?: string | null;
/**
* The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}"
*/
name?: string | null;
/**
* Next steps associate to the finding.
*/
nextSteps?: string | null;
/**
* The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id\}/sources/{source_id\}"
*/
parent?: string | null;
/**
* Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics".
*/
parentDisplayName?: string | null;
/**
* Represents operating system processes associated with the Finding.
*/
processes?: Schema$Process[];
/**
* For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time.
*/
resourceName?: string | null;
/**
* Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.
*/
securityMarks?: Schema$SecurityMarks;
/**
* The severity of the finding. This field is managed by the source that writes the finding.
*/
severity?: string | null;
/**
* Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only.
*/
sourceProperties?: {
[key: string]: any;
} | null;
/**
* The state of the finding.
*/
state?: string | null;
/**
* Represents vulnerability specific fields like cve, cvss scores etc. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)
*/
vulnerability?: Schema$Vulnerability;
}
/**
* Message that contains the resource name and display name of a folder resource.
*/
export interface Schema$Folder {
/**
* Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name
*/
resourceFolder?: string | null;
/**
* The user defined display name for this folder.
*/
resourceFolderDisplayName?: string | null;
}
/**
* Represents a geographical location for a given access.
*/
export interface Schema$Geolocation {
/**
* A CLDR.
*/
regionCode?: string | null;
}
/**
* Response of asset discovery run
*/
export interface Schema$GoogleCloudSecuritycenterV1beta1RunAssetDiscoveryResponse {
/**
* The duration between asset discovery run start and end
*/
duration?: string | null;
/**
* The state of an asset discovery run.
*/
state?: string | null;
}
/**
* Configures how to deliver Findings to BigQuery Instance.
*/
export interface Schema$GoogleCloudSecuritycenterV1BigQueryExport {
/**
* Output only. The time at which the big query export was created. This field is set by the server and will be ignored if provided on export on creation.
*/
createTime?: string | null;
/**
* The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).
*/
dataset?: string | null;
/**
* The description of the export (max of 1024 characters).
*/
description?: string | null;
/**
* Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `\>`, `<`, `\>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.
*/
filter?: string | null;
/**
* Output only. Email address of the user who last edited the big query export. This field is set by the server and will be ignored if provided on export creation or update.
*/
mostRecentEditor?: string | null;
/**
* The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id\}/bigQueryExports/{export_id\}" Example format: "folders/{folder_id\}/bigQueryExports/{export_id\}" Example format: "projects/{project_id\}/bigQueryExports/{export_id\}" This field is provided in responses, and is ignored when provided in create requests.
*/
name?: string | null;
/**
* Output only. The service account that needs permission to create table, upload data to the big query dataset.
*/
principal?: string | null;
/**
* Output only. The most recent time at which the big export was updated. This field is set by the server and will be ignored if provided on export creation or update.
*/
updateTime?: string | null;
}
/**
* Represents a Kubernetes RoleBinding or ClusterRoleBinding.
*/
export interface Schema$GoogleCloudSecuritycenterV1Binding {
/**
* Name for binding.
*/
name?: string | null;
/**
* Namespace for binding.
*/
ns?: string | null;
/**
* The Role or ClusterRole referenced by the binding.
*/
role?: Schema$Role;
/**
* Represents the subjects(s) bound to the role. Not always available for PATCH requests.
*/
subjects?: Schema$Subject[];
}
/**
* The response to a BulkMute request. Contains the LRO information.
*/
export interface Schema$GoogleCloudSecuritycenterV1BulkMuteFindingsResponse {
}
/**
* A resource that is exposed as a result of a finding.
*/
export interface Schema$GoogleCloudSecuritycenterV1ExposedResource {
/**
* Human readable name of the resource that is exposed.
*/
displayName?: string | null;
/**
* The ways in which this resource is exposed. Examples: Read, Write
*/
methods?: string[] | null;
/**
* Exposed Resource Name e.g.: `organizations/123/attackExposureResults/456/exposedResources/789`
*/
name?: string | null;
/**
* The name of the resource that is exposed. See: https://cloud.google.com/apis/design/resource_names#full_resource_name
*/
resource?: string | null;
/**
* The resource type of the exposed resource. See: https://cloud.google.com/asset-inventory/docs/supported-asset-types
*/
resourceType?: string | null;
/**
* How valuable this resource is.
*/
resourceValue?: string | null;
}
/**
* A path that an attacker could take to reach an exposed resource.
*/
export interface Schema$GoogleCloudSecuritycenterV1ExposurePath {
/**
* A list of the edges between nodes in this exposure path.
*/
edges?: Schema$Edge[];
/**
* The leaf node of this exposure path.
*/
exposedResource?: Schema$GoogleCloudSecuritycenterV1ExposedResource;
/**
* Exposure Path Name e.g.: `organizations/123/attackExposureResults/456/exposurePaths/789`
*/
name?: string | null;
/**
* A list of nodes that exist in this exposure path.
*/
pathNodes?: Schema$PathNode[];
}
/**
* Representation of third party SIEM/SOAR fields within SCC.
*/
export interface Schema$GoogleCloudSecuritycenterV1ExternalSystem {
/**
* References primary/secondary etc assignees in the external system.
*/
assignees?: string[] | null;
/**
* The most recent time when the corresponding finding's ticket/tracker was updated in the external system.
*/
externalSystemUpdateTime?: string | null;
/**
* Identifier that's used to track the given finding in the external system.
*/
externalUid?: string | null;
/**
* External System Name e.g. jira, demisto, etc. e.g.: `organizations/1234/sources/5678/findings/123456/externalSystems/jira` `folders/1234/sources/5678/findings/123456/externalSystems/jira` `projects/1234/sources/5678/findings/123456/externalSystems/jira`
*/
name?: string | null;
/**
* Most recent status of the corresponding finding's ticket/tracker in the external system.
*/
status?: string | null;
}
/**
* A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
*/
export interface Schema$GoogleCloudSecuritycenterV1MuteConfig {
/**
* Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
*/
createTime?: string | null;
/**
* A description of the mute config.
*/
description?: string | null;
/**
* The human readable name to be displayed for the mute config.
*/
displayName?: string | null;
/**
* Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`
*/
filter?: string | null;
/**
* Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
*/
mostRecentEditor?: string | null;
/**
* This field will be ignored if provided on config creation. Format "organizations/{organization\}/muteConfigs/{mute_config\}" "folders/{folder\}/muteConfigs/{mute_config\}" "projects/{project\}/muteConfigs/{mute_config\}"
*/
name?: string | null;
/**
* Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
*/
updateTime?: string | null;
}
/**
* Cloud SCC's Notification
*/
export interface Schema$GoogleCloudSecuritycenterV1NotificationMessage {
/**
* If it's a Finding based notification config, this field will be populated.
*/
finding?: Schema$Finding;
/**
* Name of the notification config that generated current notification.
*/
notificationConfigName?: string | null;
/**
* The Cloud resource tied to this notification's Finding.
*/
resource?: Schema$GoogleCloudSecuritycenterV1Resource;
}
/**
* Security Command Center finding. A finding is a record of assessment data (security, risk, health or privacy) ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding.
*/
export interface Schema$GoogleCloudSecuritycenterV1p1beta1Finding {
/**
* The canonical name of the finding. It's either "organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}", "folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}" or "projects/{project_number\}/sources/{source_id\}/findings/{finding_id\}", depending on the closest CRM ancestor of the resource associated with the finding.
*/
canonicalName?: string | null;
/**
* The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION"
*/
category?: string | null;
/**
* The time at which the finding was created in Security Command Center.
*/
createTime?: string | null;
/**
* The time at which the event took place, or when an update to the finding occurred. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding were to be resolved afterward, this time would reflect when the finding was resolved. Must not be set to a value greater than the current timestamp.
*/
eventTime?: string | null;
/**
* The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL.
*/
externalUri?: string | null;
/**
* The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}"
*/
name?: string | null;
/**
* The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id\}/sources/{source_id\}"
*/
parent?: string | null;
/**
* For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time.
*/
resourceName?: string | null;
/**
* Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.
*/
securityMarks?: Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks;
/**
* The severity of the finding. This field is managed by the source that writes the finding.
*/
severity?: string | null;
/**
* Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only.
*/
sourceProperties?: {
[key: string]: any;
} | null;
/**
* The state of the finding.
*/
state?: string | null;
}
/**
* Message that contains the resource name and display name of a folder resource.
*/
export interface Schema$GoogleCloudSecuritycenterV1p1beta1Folder {
/**
* Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name
*/
resourceFolder?: string | null;
/**
* The user defined display name for this folder.
*/
resourceFolderDisplayName?: string | null;
}
/**
* Security Command Center's Notification
*/
export interface Schema$GoogleCloudSecuritycenterV1p1beta1NotificationMessage {
/**
* If it's a Finding based notification config, this field will be populated.
*/
finding?: Schema$GoogleCloudSecuritycenterV1p1beta1Finding;
/**
* Name of the notification config that generated current notification.
*/
notificationConfigName?: string | null;
/**
* The Cloud resource tied to the notification.
*/
resource?: Schema$GoogleCloudSecuritycenterV1p1beta1Resource;
}
/**
* Information related to the Google Cloud resource.
*/
export interface Schema$GoogleCloudSecuritycenterV1p1beta1Resource {
/**
* Output only. Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.
*/
folders?: Schema$GoogleCloudSecuritycenterV1p1beta1Folder[];
/**
* The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name
*/
name?: string | null;
/**
* The full resource name of resource's parent.
*/
parent?: string | null;
/**
* The human readable name of resource's parent.
*/
parentDisplayName?: string | null;
/**
* The full resource name of project that the resource belongs to.
*/
project?: string | null;
/**
* The project id that the resource belongs to.
*/
projectDisplayName?: string | null;
}
/**
* Response of asset discovery run
*/
export interface Schema$GoogleCloudSecuritycenterV1p1beta1RunAssetDiscoveryResponse {
/**
* The duration between asset discovery run start and end
*/
duration?: string | null;
/**
* The state of an asset discovery run.
*/
state?: string | null;
}
/**
* User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.
*/
export interface Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks {
/**
* The canonical name of the marks. Examples: "organizations/{organization_id\}/assets/{asset_id\}/securityMarks" "folders/{folder_id\}/assets/{asset_id\}/securityMarks" "projects/{project_number\}/assets/{asset_id\}/securityMarks" "organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}/securityMarks" "folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}/securityMarks" "projects/{project_number\}/sources/{source_id\}/findings/{finding_id\}/securityMarks"
*/
canonicalName?: string | null;
/**
* Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)
*/
marks?: {
[key: string]: string;
} | null;
/**
* The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id\}/assets/{asset_id\}/securityMarks" "organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}/securityMarks".
*/
name?: string | null;
}
/**
* Information related to the Google Cloud resource.
*/
export interface Schema$GoogleCloudSecuritycenterV1Resource {
/**
* The human readable name of the resource.
*/
displayName?: string | null;
/**
* Output only. Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.
*/
folders?: Schema$Folder[];
/**
* The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name
*/
name?: string | null;
/**
* The full resource name of resource's parent.
*/
parent?: string | null;
/**
* The human readable name of resource's parent.
*/
parentDisplayName?: string | null;
/**
* The full resource name of project that the resource belongs to.
*/
project?: string | null;
/**
* The project ID that the resource belongs to.
*/
projectDisplayName?: string | null;
/**
* The full resource type of the resource.
*/
type?: string | null;
}
/**
* A resource value config is a mapping configuration of user's tag values to resource values. Used by the attack path simulation.
*/
export interface Schema$GoogleCloudSecuritycenterV1ResourceValueConfig {
/**
* Name for the resource value config
*/
name?: string | null;
/**
* Required. Resource value level this expression represents
*/
resourceValue?: string | null;
/**
* Required. Tag values combined with AND to check against. Values in the form "tagValues/123" E.g. [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing
*/
tagValues?: string[] | null;
}
/**
* Response of asset discovery run
*/
export interface Schema$GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse {
/**
* The duration between asset discovery run start and end
*/
duration?: string | null;
/**
* The state of an asset discovery run.
*/
st