googleapis
Version:
Google APIs Client Library for Node.js
1,006 lines • 458 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_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
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('v1');
* ```
*/
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 a service account acting on behalf of a 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 that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name\}/subject/{subject\}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name\}[{subject\}]`.
*/
principalSubject?: string | null;
/**
* The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud 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 that was used to create or exchange credentials when authenticating the service account that made 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;
/**
* The caller's user agent string associated with the finding.
*/
userAgent?: string | null;
/**
* Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application.
*/
userAgentFamily?: string | null;
/**
* A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username.
*/
userName?: string | null;
}
/**
* Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding.
*/
export interface Schema$AccessReview {
/**
* The API group of the resource. "*" means all.
*/
group?: string | null;
/**
* 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;
/**
* The optional resource type requested. "*" means all.
*/
resource?: string | null;
/**
* The optional subresource type.
*/
subresource?: string | null;
/**
* A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. "*" means all.
*/
verb?: string | null;
/**
* The API version of the resource. "*" means all.
*/
version?: string | null;
}
/**
* Security Command Center representation of a Google Cloud resource. The Asset is a Security Command Center resource that captures information about a single Google Cloud resource. All modifications to an Asset are only within the context of Security Command Center and don't affect the referenced Google Cloud resource.
*/
export interface Schema$Asset {
/**
* The canonical name of the resource. It's either "organizations/{organization_id\}/assets/{asset_id\}", "folders/{folder_id\}/assets/{asset_id\}" or "projects/{project_number\}/assets/{asset_id\}", depending on the closest CRM ancestor of the resource.
*/
canonicalName?: string | null;
/**
* The time at which the asset was created in Security Command Center.
*/
createTime?: string | null;
/**
* Cloud IAM Policy information associated with the Google Cloud resource described by the Security Command Center asset. This information is managed and defined by the Google Cloud resource and cannot be modified by the user.
*/
iamPolicy?: Schema$IamPolicy;
/**
* The relative resource name of this asset. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id\}/assets/{asset_id\}".
*/
name?: string | null;
/**
* Resource managed properties. These properties are managed and defined by the Google Cloud resource and cannot be modified by the user.
*/
resourceProperties?: {
[key: string]: any;
} | null;
/**
* Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user.
*/
securityCenterProperties?: Schema$SecurityCenterProperties;
/**
* User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the asset.
*/
securityMarks?: Schema$SecurityMarks;
/**
* The time at which the asset was last updated or added in Cloud SCC.
*/
updateTime?: string | null;
}
/**
* The configuration used for Asset Discovery runs.
*/
export interface Schema$AssetDiscoveryConfig {
/**
* The folder ids to use for filtering asset discovery. It consists of only digits, e.g., 756619654966.
*/
folderIds?: string[] | null;
/**
* The mode to use for filtering asset discovery.
*/
inclusionMode?: string | null;
/**
* The project ids to use for filtering asset discovery.
*/
projectIds?: string[] | null;
}
/**
* An attack exposure contains the results of an attack path simulation run.
*/
export interface Schema$AttackExposure {
/**
* The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/attackExposureResults/456
*/
attackExposureResult?: string | null;
/**
* The number of high value resources that are exposed as a result of this finding.
*/
exposedHighValueResourcesCount?: number | null;
/**
* The number of high value resources that are exposed as a result of this finding.
*/
exposedLowValueResourcesCount?: number | null;
/**
* The number of medium value resources that are exposed as a result of this finding.
*/
exposedMediumValueResourcesCount?: number | null;
/**
* The most recent time the attack exposure was updated on this finding.
*/
latestCalculationTime?: string | null;
/**
* A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate.
*/
score?: number | null;
/**
* What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not.
*/
state?: string | null;
}
/**
* A path that an attacker could take to reach an exposed resource.
*/
export interface Schema$AttackPath {
/**
* A list of the edges between nodes in this attack path.
*/
edges?: Schema$AttackPathEdge[];
/**
* The attack path name, for example, `organizations/12/simulation/34/valuedResources/56/attackPaths/78`
*/
name?: string | null;
/**
* A list of nodes that exist in this attack path.
*/
pathNodes?: Schema$AttackPathNode[];
}
/**
* Represents a connection between a source node and a destination node in this attack path.
*/
export interface Schema$AttackPathEdge {
/**
* The attack node uuid of the destination node.
*/
destination?: string | null;
/**
* The attack node uuid of the source node.
*/
source?: string | null;
}
/**
* Represents one point that an attacker passes through in this attack path.
*/
export interface Schema$AttackPathNode {
/**
* The findings associated with this node in the attack path.
*/
associatedFindings?: Schema$PathNodeAssociatedFinding[];
/**
* A list of attack step nodes that exist in this attack path node.
*/
attackSteps?: Schema$AttackStepNode[];
/**
* Human-readable name of this resource.
*/
displayName?: string | null;
/**
* The name of the resource at this point in the attack path. The format of the name follows the Cloud Asset Inventory [resource name format]("https://cloud.google.com/asset-inventory/docs/resource-name-format")
*/
resource?: string | null;
/**
* The [supported resource type](http://cloud/asset-inventory/docs/supported-asset-types")
*/
resourceType?: string | null;
/**
* Unique id of the attack path node.
*/
uuid?: string | null;
}
/**
* Detailed steps the attack can take between path nodes.
*/
export interface Schema$AttackStepNode {
/**
* Attack step description
*/
description?: string | null;
/**
* User friendly name of the attack step
*/
displayName?: string | null;
/**
* Attack step labels for metadata
*/
labels?: {
[key: string]: string;
} | null;
/**
* Attack step type. Can be either AND, OR or DEFENSE
*/
type?: string | null;
/**
* Unique ID for one Node
*/
uuid?: string | null;
}
/**
* Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \}, { "log_type": "ADMIN_READ" \} ] \}, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" \}, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] \} ] \} ] \} For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
*/
export interface Schema$AuditConfig {
/**
* The configuration for logging of each type of permission.
*/
auditLogConfigs?: Schema$AuditLogConfig[];
/**
* Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
*/
service?: string | null;
}
/**
* Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \} ] \} This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
*/
export interface Schema$AuditLogConfig {
/**
* Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
*/
exemptedMembers?: string[] | null;
/**
* The log type that this config enables.
*/
logType?: string | null;
}
/**
* Request message to create multiple resource value configs
*/
export interface Schema$BatchCreateResourceValueConfigsRequest {
/**
* Required. The resource value configs to be created.
*/
requests?: Schema$CreateResourceValueConfigRequest[];
}
/**
* Response message for BatchCreateResourceValueConfigs
*/
export interface Schema$BatchCreateResourceValueConfigsResponse {
/**
* The resource value configs created
*/
resourceValueConfigs?: Schema$GoogleCloudSecuritycenterV1ResourceValueConfig[];
}
/**
* Associates `members`, or principals, with a `role`.
*/
export interface Schema$Binding {
/**
* The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
condition?: Schema$Expr;
/**
* Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid\}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid\}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid\}` and the recovered group retains the role in the binding.
*/
members?: string[] | null;
/**
* Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
*/
role?: string | null;
}
/**
* Request message for bulk findings update. Note: 1. If multiple bulk update requests match the same resource, the order in which they get executed is not defined. 2. Once a bulk operation is started, there is no way to stop it.
*/
export interface Schema$BulkMuteFindingsRequest {
/**
* Expression that identifies findings that should be updated. 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;
/**
* This can be a mute configuration name or any identifier for mute/unmute of findings based on the filter.
*/
muteAnnotation?: string | null;
}
/**
* The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding.
*/
export interface Schema$CloudDlpDataProfile {
/**
* Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`.
*/
dataProfile?: string | null;
/**
* The resource hierarchy level at which the data profile was generated.
*/
parentType?: string | null;
}
/**
* Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding.
*/
export interface Schema$CloudDlpInspection {
/**
* Whether Cloud DLP scanned the complete resource or a sampled subset.
*/
fullScan?: boolean | null;
/**
* The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`.
*/
infoType?: string | null;
/**
* The number of times Cloud DLP found this infoType within this job and resource.
*/
infoTypeCount?: string | null;
/**
* Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`.
*/
inspectJob?: string | null;
}
/**
* Contains compliance information about a security standard indicating unmet recommendations.
*/
export interface Schema$Compliance {
/**
* Policies within the standard or benchmark, for example, A.12.4.1
*/
ids?: string[] | null;
/**
* Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.
*/
standard?: string | null;
/**
* Version of the standard or benchmark, for example, 1.1
*/
version?: string | 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;
}
/**
* The email address of a contact.
*/
export interface Schema$Contact {
/**
* An email address. For example, "`person123@company.com`".
*/
email?: string | null;
}
/**
* Details about specific contacts
*/
export interface Schema$ContactDetails {
/**
* A list of contacts
*/
contacts?: Schema$Contact[];
}
/**
* Container associated with the finding.
*/
export interface Schema$Container {
/**
* The time that the container was created.
*/
createTime?: string | null;
/**
* Optional container image ID, if 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[];
/**
* Name of the container.
*/
name?: string | null;
/**
* Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags.
*/
uri?: string | null;
}
/**
* Request message to create single resource value config
*/
export interface Schema$CreateResourceValueConfigRequest {
/**
* Required. Resource name of the new ResourceValueConfig's parent.
*/
parent?: string | null;
/**
* Required. The resource value config being created.
*/
resourceValueConfig?: Schema$GoogleCloudSecuritycenterV1ResourceValueConfig;
}
/**
* An error encountered while validating the uploaded configuration of an Event Threat Detection Custom Module.
*/
export interface Schema$CustomModuleValidationError {
/**
* A description of the error, suitable for human consumption. Required.
*/
description?: string | null;
/**
* The end position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, or if one could not be computed..
*/
end?: Schema$Position;
/**
* The path, in RFC 8901 JSON Pointer format, to the field that failed validation. This may be left empty if no specific field is affected.
*/
fieldPath?: string | null;
/**
* The initial position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, or if one could not be computed.
*/
start?: Schema$Position;
}
/**
* A list of zero or more errors encountered while validating the uploaded configuration of an Event Threat Detection Custom Module.
*/
export interface Schema$CustomModuleValidationErrors {
errors?: Schema$CustomModuleValidationError[];
}
/**
* 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 Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided.
*/
export interface Schema$Database {
/**
* The human-readable name of the database that the user connected to.
*/
displayName?: string | null;
/**
* The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change.
*/
grantees?: string[] | null;
/**
* Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory.
*/
name?: string | null;
/**
* The SQL statement that is associated with the database access.
*/
query?: string | null;
/**
* The username used to connect to the database. The username might not be an IAM principal and does not have a set format.
*/
userName?: string | null;
/**
* The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion).
*/
version?: 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;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
*/
export interface Schema$Empty {
}
/**
* A name-value pair representing an environment variable used in an operating system 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;
}
/**
* Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only.
*/
export interface Schema$EventThreatDetectionCustomModule {
/**
* Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
*/
config?: {
[key: string]: any;
} | null;
/**
* The description for the module.
*/
description?: string | null;
/**
* The human readable name to be displayed for the module.
*/
displayName?: string | null;
/**
* The state of enablement for the module at the given level of the hierarchy.
*/
enablementState?: string | null;
/**
* Output only. The editor the module was last updated by.
*/
lastEditor?: string | null;
/**
* Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/customModules/{module\}".
*/
name?: string | null;
/**
* Type for the module. e.g. CONFIGURABLE_BAD_IP.
*/
type?: string | null;
/**
* Output only. The time the module was last updated.
*/
updateTime?: string | null;
}
/**
* Resource where data was exfiltrated from or exfiltrated to.
*/
export interface Schema$ExfilResource {
/**
* Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket.
*/
components?: string[] | null;
/**
* The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name).
*/
name?: string | null;
}
/**
* Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations 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[];
}
/**
* Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
*/
export interface Schema$Expr {
/**
* Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
*/
description?: string | null;
/**
* Textual representation of an expression in Common Expression Language syntax.
*/
expression?: string | null;
/**
* Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
*/
location?: string | null;
/**
* Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
*/
title?: string | null;
}
/**
* 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.
*/
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 with the finding, such as more information on the caller, which method was accessed, and from where.
*/
access?: Schema$Access;
/**
* The results of an attack path simulation relevant to this finding.
*/
attackExposure?: Schema$AttackExposure;
/**
* 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;
/**
* Cloud DLP data profile that is associated with the finding.
*/
cloudDlpDataProfile?: Schema$CloudDlpDataProfile;
/**
* Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding.
*/
cloudDlpInspection?: Schema$CloudDlpInspection;
/**
* 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. This field 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 details 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 exfiltrations 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;
/**
* File associated with the finding.
*/
files?: Schema$File[];
/**
* 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. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise).
*/
indicator?: Schema$Indicator;
/**
* Signature of the kernel rootkit.
*/
kernelRootkit?: Schema$KernelRootkit;
/**
* 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;
/**
* Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885
*/
moduleName?: string | null;
/**
* 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;
/**
* Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding.
*/
muteInitiator?: string | null;
/**
* Output only. The most recent time this finding was muted or unmuted.
*/
muteUpdateTime?: string | null;
/**
* The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}", "folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}", "projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}".
*/
name?: string | null;
/**
* Steps to address 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 and CVSS scores. 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;
}
/**
* Request message for `GetIamPolicy` method.
*/
export interface Schema$GetIamPolicyRequest {
/**
* OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
*/
options?: Schema$GetPolicyOptions;
}
/**
* Encapsulates settings provided to GetIamPolicy.
*/
export interface Schema$GetPolicyOptions {
/**
* Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has n