Types for Google Cloud Securitycenter v1 API¶
- class google.cloud.securitycenter_v1.types.Access(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents an access event.
- principal_email¶
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_subjectfield 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.- Type
- caller_ip_geo¶
The caller IP’s geolocation, which identifies where the call came from.
- user_agent_family¶
Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application.
- Type
- service_name¶
This is the API service that the service account made a call to, e.g. “iam.googleapis.com”.
- Type
- principal_subject¶
A string that represents the principal_subject that is associated with the identity. Unlike
principal_email,principal_subjectsupports principals that aren’t associated with email addresses, such as third party principals. For most identities, the format isprincipal://iam.googleapis.com/{identity pool name}/subject/{subject}. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy formatserviceAccount:{identity pool name}[{subject}].- Type
- service_account_key_name¶
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}”.
- Type
- service_account_delegation_info¶
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.- Type
MutableSequence[google.cloud.securitycenter_v1.types.ServiceAccountDelegationInfo]
- class google.cloud.securitycenter_v1.types.AdaptiveProtection(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInformation about Google Cloud Armor Adaptive Protection.
- confidence¶
A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the Adaptive Protection documentation for further explanation.
- Type
- class google.cloud.securitycenter_v1.types.Application(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents an application associated with a finding.
- base_uri¶
The base URI that identifies the network location of the application in which the vulnerability was detected. For example,
http://example.com.- Type
- class google.cloud.securitycenter_v1.types.Asset(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSecurity 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.
- name¶
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}”.
- Type
- security_center_properties¶
Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user.
- resource_properties¶
Resource managed properties. These properties are managed and defined by the Google Cloud resource and cannot be modified by the user.
- Type
MutableMapping[str, google.protobuf.struct_pb2.Value]
- security_marks¶
User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the asset.
- create_time¶
The time at which the asset was created in Security Command Center.
- update_time¶
The time at which the asset was last updated or added in Cloud SCC.
- iam_policy¶
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.
- canonical_name¶
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.
- Type
- class IamPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCloud 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.
- policy_blob¶
The JSON representation of the Policy associated with the asset. See https://cloud.google.com/iam/reference/rest/v1/Policy for format details.
- Type
- class ResourcePropertiesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class SecurityCenterProperties(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSecurity Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user.
- resource_name¶
The full resource name of the Google Cloud resource this asset represents. This field is immutable after create time. See: https://cloud.google.com/apis/design/resource_names#full_resource_name
- Type
- resource_type¶
The type of the Google Cloud resource. Examples include: APPLICATION, PROJECT, and ORGANIZATION. This is a case insensitive field defined by Security Command Center and/or the producer of the resource and is immutable after create time.
- Type
- resource_parent¶
The full resource name of the immediate parent of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name
- Type
- resource_project¶
The full resource name of the project the resource belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name
- Type
- resource_parent_display_name¶
The user defined display name for the parent of this resource.
- Type
- resource_project_display_name¶
The user defined display name for the project of this resource.
- Type
- folders¶
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.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Folder]
- class google.cloud.securitycenter_v1.types.Attack(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInformation about DDoS attack volume and classification.
- class google.cloud.securitycenter_v1.types.AttackExposure(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn attack exposure contains the results of an attack path simulation run.
- score¶
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.
- Type
- latest_calculation_time¶
The most recent time the attack exposure was updated on this finding.
- attack_exposure_result¶
The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example:
organizations/123/simulations/456/attackExposureResults/789- Type
- state¶
What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not.
- exposed_high_value_resources_count¶
The number of high value resources that are exposed as a result of this finding.
- Type
- exposed_medium_value_resources_count¶
The number of medium value resources that are exposed as a result of this finding.
- Type
- exposed_low_value_resources_count¶
The number of high value resources that are exposed as a result of this finding.
- Type
- class State(value)[source]¶
Bases:
proto.enums.EnumThis enum defines the various states an AttackExposure can be in.
- Values:
- STATE_UNSPECIFIED (0):
The state is not specified.
- CALCULATED (1):
The attack exposure has been calculated.
- NOT_CALCULATED (2):
The attack exposure has not been calculated.
- class google.cloud.securitycenter_v1.types.AttackPath(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA path that an attacker could take to reach an exposed resource.
- name¶
The attack path name, for example,
organizations/12/simulation/34/valuedResources/56/attackPaths/78- Type
- path_nodes¶
A list of nodes that exist in this attack path.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.AttackPath.AttackPathNode]
- edges¶
A list of the edges between nodes in this attack path.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.AttackPath.AttackPathEdge]
- class AttackPathEdge(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a connection between a source node and a destination node in this attack path.
- class AttackPathNode(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents one point that an attacker passes through in this attack path.
- resource¶
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
- Type
- resource_type¶
-
- Type
- associated_findings¶
The findings associated with this node in the attack path.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.AttackPath.AttackPathNode.PathNodeAssociatedFinding]
- attack_steps¶
A list of attack step nodes that exist in this attack path node.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.AttackPath.AttackPathNode.AttackStepNode]
- class AttackStepNode(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDetailed steps the attack can take between path nodes.
- type_¶
Attack step type. Can be either AND, OR or DEFENSE
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class NodeType(value)[source]¶
Bases:
proto.enums.EnumThe type of the incoming attack step node.
- Values:
- NODE_TYPE_UNSPECIFIED (0):
Type not specified
- NODE_TYPE_AND (1):
Incoming edge joined with AND
- NODE_TYPE_OR (2):
Incoming edge joined with OR
- NODE_TYPE_DEFENSE (3):
Incoming edge is defense
- NODE_TYPE_ATTACKER (4):
Incoming edge is attacker
- class PathNodeAssociatedFinding(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA finding that is associated with this node in the attack path.
- canonical_finding¶
Canonical name of the associated findings. Example:
organizations/123/sources/456/findings/789- Type
- class google.cloud.securitycenter_v1.types.AwsMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAWS metadata associated with the resource, only applicable if the finding’s cloud provider is Amazon Web Services.
- organization¶
The AWS organization associated with the resource.
- organizational_units¶
A list of AWS organizational units associated with the resource, ordered from lowest level (closest to the account) to highest level.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.AwsMetadata.AwsOrganizationalUnit]
- account¶
The AWS account associated with the resource.
- class AwsAccount(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn AWS account that is a member of an organization.
- class AwsOrganization(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn organization is a collection of accounts that are centrally managed together using consolidated billing, organized hierarchically with organizational units (OUs), and controlled with policies.
- class AwsOrganizationalUnit(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn Organizational Unit (OU) is a container of AWS accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs.
- id¶
The unique identifier (ID) associated with this OU. The regex pattern for an organizational unit ID string requires “ou-” followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second “-” dash and from 8 to 32 additional lowercase letters or digits. For example, “ou-ab12-cd34ef56”.
- Type
- class google.cloud.securitycenter_v1.types.AzureMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAzure metadata associated with the resource, only applicable if the finding’s cloud provider is Microsoft Azure.
- management_groups¶
A list of Azure management groups associated with the resource, ordered from lowest level (closest to the subscription) to highest level.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.AzureMetadata.AzureManagementGroup]
- subscription¶
The Azure subscription associated with the resource.
- resource_group¶
The Azure resource group associated with the resource.
- class AzureManagementGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents an Azure management group.
- id¶
The UUID of the Azure management group, for example,
20000000-0001-0000-0000-000000000000.- Type
- class AzureResourceGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents an Azure resource group.
- class AzureSubscription(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents an Azure subscription.
- class google.cloud.securitycenter_v1.types.BackupDisasterRecovery(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInformation related to Google Cloud Backup and DR Service findings.
- backup_template¶
The name of a Backup and DR template which comprises one or more backup policies. See the Backup and DR documentation for more information. For example,
snap-ov.- Type
- policies¶
The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example,
onvaults.- Type
MutableSequence[str]
- host¶
The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the Backup and DR documentation on hosts for more information. For example,
centos7-01.- Type
- applications¶
The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example,
centos7-01-vol00,centos7-01-vol01,centos7-01-vol02.- Type
MutableSequence[str]
- storage_pool¶
The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the Backup and DR documentation on storage pools. For example,
DiskPoolOne.- Type
- policy_options¶
The names of Backup and DR advanced policy options of a policy applying to an application. See the Backup and DR documentation on policy options. For example,
skipofflineappsincongrp, nounmap.- Type
MutableSequence[str]
- profile¶
The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the Backup and DR documentation on profiles. For example,
GCP.- Type
- appliance¶
The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example,
backup-server-57137.- Type
- backup_type¶
The backup type of the Backup and DR image. For example,
Snapshot,Remote Snapshot,OnVault.- Type
- backup_create_time¶
The timestamp at which the Backup and DR backup was created.
- class google.cloud.securitycenter_v1.types.BatchCreateResourceValueConfigsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message to create multiple resource value configs
- parent¶
Required. Resource name of the new ResourceValueConfig’s parent. The parent field in the CreateResourceValueConfigRequest messages must either be empty or match this field.
- Type
- requests¶
Required. The resource value configs to be created.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.CreateResourceValueConfigRequest]
- class google.cloud.securitycenter_v1.types.BatchCreateResourceValueConfigsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for BatchCreateResourceValueConfigs
- resource_value_configs¶
The resource value configs created
- Type
MutableSequence[google.cloud.securitycenter_v1.types.ResourceValueConfig]
- class google.cloud.securitycenter_v1.types.BigQueryExport(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfigures how to deliver Findings to BigQuery Instance.
- name¶
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.
- Type
- filter¶
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
ANDandOR. Parentheses are supported, andORhas higher precedence thanAND.Restrictions have the form
<field> <operator> <value>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
trueandfalsewithout quotes.
- Type
- dataset¶
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 (_).
- Type
- create_time¶
Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation.
- update_time¶
Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update.
- most_recent_editor¶
Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update.
- Type
- class google.cloud.securitycenter_v1.types.BulkMuteFindingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for bulk findings update.
Note:
- If multiple bulk update requests match the same resource, the
order in which they get executed is not defined.
Once a bulk operation is started, there is no way to stop it.
- parent¶
Required. The parent, at which bulk action needs to be applied. Its format is
organizations/[organization_id],folders/[folder_id],projects/[project_id].- Type
- filter¶
Expression that identifies findings that should be updated. The expression is a list of zero or more restrictions combined via logical operators
ANDandOR. Parentheses are supported, andORhas higher precedence thanAND.Restrictions have the form
<field> <operator> <value>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
trueandfalsewithout quotes.
- Type
- mute_annotation¶
This can be a mute configuration name or any identifier for mute/unmute of findings based on the filter.
- Type
- mute_state¶
Optional. All findings matching the given filter will have their mute state set to this value. The default value is
MUTED. Setting this toUNDEFINEDwill clear the mute state on all matching findings.
- class MuteState(value)[source]¶
Bases:
proto.enums.EnumThe mute state.
- Values:
- MUTE_STATE_UNSPECIFIED (0):
Unused.
- MUTED (1):
Matching findings will be muted (default).
- UNDEFINED (2):
Matching findings will have their mute state cleared.
- class google.cloud.securitycenter_v1.types.BulkMuteFindingsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe response to a BulkMute request. Contains the LRO information.
- class google.cloud.securitycenter_v1.types.CloudArmor(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageFields related to Google Cloud Armor findings.
- security_policy¶
Information about the Google Cloud Armor security policy relevant to the finding.
- requests¶
Information about incoming requests evaluated by Google Cloud Armor security policies.
- adaptive_protection¶
Information about potential Layer 7 DDoS attacks identified by Google Cloud Armor Adaptive Protection.
- attack¶
Information about DDoS attack volume and classification.
- threat_vector¶
Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, “L3_4” for Layer 3 and Layer 4 DDoS attacks, or “L_7” for Layer 7 DDoS attacks.
- Type
- duration¶
Duration of attack from the start until the current moment (updated every 5 minutes).
- class google.cloud.securitycenter_v1.types.CloudDlpDataProfile(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe data profile associated with the finding.
- data_profile¶
Name of the data profile, for example,
projects/123/locations/europe/tableProfiles/8383929.- Type
- parent_type¶
The resource hierarchy level at which the data profile was generated.
- class ParentType(value)[source]¶
Bases:
proto.enums.EnumParents for configurations that produce data profile findings.
- Values:
- PARENT_TYPE_UNSPECIFIED (0):
Unspecified parent type.
- ORGANIZATION (1):
Organization-level configurations.
- PROJECT (2):
Project-level configurations.
- class google.cloud.securitycenter_v1.types.CloudDlpInspection(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDetails about the Cloud Data Loss Prevention (Cloud DLP) inspection job that produced the finding.
- inspect_job¶
Name of the inspection job, for example,
projects/123/locations/europe/dlpJobs/i-8383929.- Type
- info_type¶
The type of information (or infoType) found, for example,
EMAIL_ADDRESSorSTREET_ADDRESS.- Type
- info_type_count¶
The number of times Cloud DLP found this infoType within this job and resource.
- Type
- class google.cloud.securitycenter_v1.types.CloudLoggingEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMetadata taken from a Cloud Logging LogEntry
- log_id¶
The type of the log (part of
log_name.log_nameis the resource name of the log to which this log entry belongs). For example:cloudresourcemanager.googleapis.com/activity. Note that this field is not URL-encoded, unlike theLOG_IDfield inLogEntry.- Type
- resource_container¶
The organization, folder, or project of the monitored resource that produced this log entry.
- Type
- timestamp¶
The time the event described by the log entry occurred.
- class google.cloud.securitycenter_v1.types.CloudProvider(value)[source]¶
Bases:
proto.enums.EnumEnumeration representing the various cloud providers a finding’s resource could reside in.
- Values:
- CLOUD_PROVIDER_UNSPECIFIED (0):
The cloud provider is unspecified.
- GOOGLE_CLOUD_PLATFORM (1):
The cloud provider is Google Cloud Platform.
- AMAZON_WEB_SERVICES (2):
The cloud provider is Amazon Web Services.
- MICROSOFT_AZURE (3):
The cloud provider is Microsoft Azure.
- class google.cloud.securitycenter_v1.types.Compliance(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageContains compliance information about a security standard indicating unmet recommendations.
- class google.cloud.securitycenter_v1.types.Connection(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageContains information about the IP connection associated with the finding.
- destination_ip¶
Destination IP address. Not present for sockets that are listening and not connected.
- Type
- destination_port¶
Destination port. Not present for sockets that are listening and not connected.
- Type
- protocol¶
IANA Internet Protocol Number such as TCP(6) and UDP(17).
- class Protocol(value)[source]¶
Bases:
proto.enums.EnumIANA Internet Protocol Number such as TCP(6) and UDP(17).
- Values:
- PROTOCOL_UNSPECIFIED (0):
Unspecified protocol (not HOPOPT).
- ICMP (1):
Internet Control Message Protocol.
- TCP (6):
Transmission Control Protocol.
- UDP (17):
User Datagram Protocol.
- GRE (47):
Generic Routing Encapsulation.
- ESP (50):
Encap Security Payload.
- class google.cloud.securitycenter_v1.types.Contact(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe email address of a contact.
- class google.cloud.securitycenter_v1.types.ContactDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDetails about specific contacts
- contacts¶
A list of contacts
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Contact]
- class google.cloud.securitycenter_v1.types.Container(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageContainer associated with the finding.
- uri¶
Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags.
- Type
- image_id¶
Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest.
- Type
- labels¶
Container labels, as provided by the container runtime.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Label]
- create_time¶
The time that the container was created.
- class google.cloud.securitycenter_v1.types.CreateBigQueryExportRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for creating a BigQuery export.
- parent¶
Required. The name of the parent resource of the new BigQuery export. Its format is
organizations/[organization_id],folders/[folder_id], orprojects/[project_id].- Type
- big_query_export¶
Required. The BigQuery export being created.
- class google.cloud.securitycenter_v1.types.CreateEventThreatDetectionCustomModuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to create an Event Threat Detection custom module.
- parent¶
Required. The new custom module’s parent.
Its format is:
organizations/{organization}/eventThreatDetectionSettings.folders/{folder}/eventThreatDetectionSettings.projects/{project}/eventThreatDetectionSettings.
- Type
- event_threat_detection_custom_module¶
Required. The module to create. The event_threat_detection_custom_module.name will be ignored and server generated.
- class google.cloud.securitycenter_v1.types.CreateFindingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for creating a finding.
- parent¶
Required. Resource name of the new finding’s parent. Its format should be
organizations/[organization_id]/sources/[source_id].- Type
- finding_id¶
Required. Unique identifier provided by the client within the parent scope. It must be alphanumeric and less than or equal to 32 characters and greater than 0 characters in length.
- Type
- finding¶
Required. The Finding being created. The name and security_marks will be ignored as they are both output only fields on this resource.
- class google.cloud.securitycenter_v1.types.CreateMuteConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for creating a mute config.
- parent¶
Required. Resource name of the new mute configs’s parent. Its format is
organizations/[organization_id],folders/[folder_id], orprojects/[project_id].- Type
- mute_config¶
Required. The mute config being created.
- class google.cloud.securitycenter_v1.types.CreateNotificationConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for creating a notification config.
- parent¶
Required. Resource name of the new notification config’s parent. Its format is
organizations/[organization_id],folders/[folder_id], orprojects/[project_id].- Type
- config_id¶
Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters and contain alphanumeric characters, underscores, or hyphens only.
- Type
- notification_config¶
Required. The notification config being created. The name and the service account will be ignored as they are both output only fields on this resource.
- class google.cloud.securitycenter_v1.types.CreateResourceValueConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message to create single resource value config
- resource_value_config¶
Required. The resource value config being created.
- class google.cloud.securitycenter_v1.types.CreateSecurityHealthAnalyticsCustomModuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for creating Security Health Analytics custom modules.
- parent¶
Required. Resource name of the new custom module’s parent. Its format is
organizations/{organization}/securityHealthAnalyticsSettings,folders/{folder}/securityHealthAnalyticsSettings, orprojects/{project}/securityHealthAnalyticsSettings- Type
- security_health_analytics_custom_module¶
Required. SecurityHealthAnalytics custom module to create. The provided name is ignored and reset with provided parent information and server-generated ID.
- class google.cloud.securitycenter_v1.types.CreateSourceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for creating a source.
- parent¶
Required. Resource name of the new source’s parent. Its format should be
organizations/[organization_id].- Type
- source¶
Required. The Source being created, only the display_name and description will be used. All other fields will be ignored.
- class google.cloud.securitycenter_v1.types.CustomConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDefines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify.
- predicate¶
The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
- Type
google.type.expr_pb2.Expr
- custom_output¶
Custom output properties.
- resource_selector¶
The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
- severity¶
The severity to assign to findings generated by the module.
- description¶
Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks.
- Type
- recommendation¶
An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the
nextStepsproperty of the finding JSON.- Type
- class CustomOutputSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under
sourceProperties.- properties¶
A list of custom output properties to add to the finding.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.CustomConfig.CustomOutputSpec.Property]
- class Property(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn individual name-value pair that defines a custom source property.
- value_expression¶
The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks.
- Type
google.type.expr_pb2.Expr
- class ResourceSelector(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResource for selecting resource type.
- class Severity(value)[source]¶
Bases:
proto.enums.EnumDefines the valid value options for the severity of a finding.
- Values:
- SEVERITY_UNSPECIFIED (0):
Unspecified severity.
- CRITICAL (1):
Critical severity.
- HIGH (2):
High severity.
- MEDIUM (3):
Medium severity.
- LOW (4):
Low severity.
- class google.cloud.securitycenter_v1.types.CustomModuleValidationError(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn error encountered while validating the uploaded configuration of an Event Threat Detection Custom Module.
- field_path¶
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.
- Type
- start¶
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.
This field is a member of oneof
_start.
- class google.cloud.securitycenter_v1.types.CustomModuleValidationErrors(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA list of zero or more errors encountered while validating the uploaded configuration of an Event Threat Detection Custom Module.
- errors¶
- Type
MutableSequence[google.cloud.securitycenter_v1.types.CustomModuleValidationError]
- class google.cloud.securitycenter_v1.types.Cve(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCVE stands for Common Vulnerabilities and Exposures. Information from the CVE record that describes this vulnerability.
- references¶
Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Reference]
- cvssv3¶
Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document
- impact¶
The potential impact of the vulnerability if it was to be exploited.
- exploitation_activity¶
The exploitation activity of the vulnerability in the wild.
- exploit_release_date¶
Date the first publicly available exploit or PoC was released.
- class ExploitationActivity(value)[source]¶
Bases:
proto.enums.EnumThe possible values of exploitation activity of the vulnerability in the wild.
- Values:
- EXPLOITATION_ACTIVITY_UNSPECIFIED (0):
Invalid or empty value.
- WIDE (1):
Exploitation has been reported or confirmed to widely occur.
- CONFIRMED (2):
Limited reported or confirmed exploitation activities.
- AVAILABLE (3):
Exploit is publicly available.
- ANTICIPATED (4):
No known exploitation activity, but has a high potential for exploitation.
- NO_KNOWN (5):
No known exploitation activity.
- class RiskRating(value)[source]¶
Bases:
proto.enums.EnumThe possible values of impact of the vulnerability if it was to be exploited.
- Values:
- RISK_RATING_UNSPECIFIED (0):
Invalid or empty value.
- LOW (1):
Exploitation would have little to no security impact.
- MEDIUM (2):
Exploitation would enable attackers to perform activities, or could allow attackers to have a direct impact, but would require additional steps.
- HIGH (3):
Exploitation would enable attackers to have a notable direct impact without needing to overcome any major mitigating factors.
- CRITICAL (4):
Exploitation would fundamentally undermine the security of affected systems, enable actors to perform significant attacks with minimal effort, with little to no mitigating factors to overcome.
- class google.cloud.securitycenter_v1.types.Cvssv3(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCommon Vulnerability Scoring System version 3.
- attack_vector¶
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.
- attack_complexity¶
This metric describes the conditions beyond the attacker’s control that must exist in order to exploit the vulnerability.
- privileges_required¶
This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability.
- user_interaction¶
This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component.
- scope¶
The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope.
- confidentiality_impact¶
This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability.
- integrity_impact¶
This metric measures the impact to integrity of a successfully exploited vulnerability.
- availability_impact¶
This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability.
- class AttackComplexity(value)[source]¶
Bases:
proto.enums.EnumThis metric describes the conditions beyond the attacker’s control that must exist in order to exploit the vulnerability.
- Values:
- ATTACK_COMPLEXITY_UNSPECIFIED (0):
Invalid value.
- ATTACK_COMPLEXITY_LOW (1):
Specialized access conditions or extenuating circumstances do not exist. An attacker can expect repeatable success when attacking the vulnerable component.
- ATTACK_COMPLEXITY_HIGH (2):
A successful attack depends on conditions beyond the attacker’s control. That is, a successful attack cannot be accomplished at will, but requires the attacker to invest in some measurable amount of effort in preparation or execution against the vulnerable component before a successful attack can be expected.
- class AttackVector(value)[source]¶
Bases:
proto.enums.EnumThis metric reflects the context by which vulnerability exploitation is possible.
- Values:
- ATTACK_VECTOR_UNSPECIFIED (0):
Invalid value.
- ATTACK_VECTOR_NETWORK (1):
The vulnerable component is bound to the network stack and the set of possible attackers extends beyond the other options listed below, up to and including the entire Internet.
- ATTACK_VECTOR_ADJACENT (2):
The vulnerable component is bound to the network stack, but the attack is limited at the protocol level to a logically adjacent topology.
- ATTACK_VECTOR_LOCAL (3):
The vulnerable component is not bound to the network stack and the attacker’s path is via read/write/execute capabilities.
- ATTACK_VECTOR_PHYSICAL (4):
The attack requires the attacker to physically touch or manipulate the vulnerable component.
- class Impact(value)[source]¶
Bases:
proto.enums.EnumThe Impact metrics capture the effects of a successfully exploited vulnerability on the component that suffers the worst outcome that is most directly and predictably associated with the attack.
- Values:
- IMPACT_UNSPECIFIED (0):
Invalid value.
- IMPACT_HIGH (1):
High impact.
- IMPACT_LOW (2):
Low impact.
- IMPACT_NONE (3):
No impact.
- class PrivilegesRequired(value)[source]¶
Bases:
proto.enums.EnumThis metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability.
- Values:
- PRIVILEGES_REQUIRED_UNSPECIFIED (0):
Invalid value.
- PRIVILEGES_REQUIRED_NONE (1):
The attacker is unauthorized prior to attack, and therefore does not require any access to settings or files of the vulnerable system to carry out an attack.
- PRIVILEGES_REQUIRED_LOW (2):
The attacker requires privileges that provide basic user capabilities that could normally affect only settings and files owned by a user. Alternatively, an attacker with Low privileges has the ability to access only non-sensitive resources.
- PRIVILEGES_REQUIRED_HIGH (3):
The attacker requires privileges that provide significant (e.g., administrative) control over the vulnerable component allowing access to component-wide settings and files.
- class Scope(value)[source]¶
Bases:
proto.enums.EnumThe Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope.
- Values:
- SCOPE_UNSPECIFIED (0):
Invalid value.
- SCOPE_UNCHANGED (1):
An exploited vulnerability can only affect resources managed by the same security authority.
- SCOPE_CHANGED (2):
An exploited vulnerability can affect resources beyond the security scope managed by the security authority of the vulnerable component.
- class UserInteraction(value)[source]¶
Bases:
proto.enums.EnumThis metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component.
- Values:
- USER_INTERACTION_UNSPECIFIED (0):
Invalid value.
- USER_INTERACTION_NONE (1):
The vulnerable system can be exploited without interaction from any user.
- USER_INTERACTION_REQUIRED (2):
Successful exploitation of this vulnerability requires a user to take some action before the vulnerability can be exploited.
- class google.cloud.securitycenter_v1.types.Database(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents 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 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.
- name¶
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. Cloud SQL databases). In these cases only the display name will be provided. The full resource name of the database that the user connected to, if it is supported by Cloud Asset Inventory.
- Type
- user_name¶
The username used to connect to the database. The username might not be an IAM principal and does not have a set format.
- Type
- grantees¶
The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change.
- Type
MutableSequence[str]
- version¶
The version of the database, for example, POSTGRES_14. See the complete list.
- Type
- class google.cloud.securitycenter_v1.types.DeleteBigQueryExportRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for deleting a BigQuery export.
- class google.cloud.securitycenter_v1.types.DeleteEventThreatDetectionCustomModuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to delete an Event Threat Detection custom module.
- name¶
Required. Name of the custom module to delete.
Its format is:
organizations/{organization}/eventThreatDetectionSettings/customModules/{module}.folders/{folder}/eventThreatDetectionSettings/customModules/{module}.projects/{project}/eventThreatDetectionSettings/customModules/{module}.
- Type
- class google.cloud.securitycenter_v1.types.DeleteMuteConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for deleting a mute config.
- name¶
Required. Name of the mute config to delete. Its format is
organizations/{organization}/muteConfigs/{config_id},folders/{folder}/muteConfigs/{config_id},projects/{project}/muteConfigs/{config_id},organizations/{organization}/locations/global/muteConfigs/{config_id},folders/{folder}/locations/global/muteConfigs/{config_id}, orprojects/{project}/locations/global/muteConfigs/{config_id}.- Type
- class google.cloud.securitycenter_v1.types.DeleteNotificationConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for deleting a notification config.
- class google.cloud.securitycenter_v1.types.DeleteResourceValueConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message to delete resource value config
- class google.cloud.securitycenter_v1.types.DeleteSecurityHealthAnalyticsCustomModuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for deleting Security Health Analytics custom modules.
- name¶
Required. Name of the custom module to delete. Its format is
organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule},folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}, orprojects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}- Type
- class google.cloud.securitycenter_v1.types.EffectiveEventThreatDetectionCustomModule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn EffectiveEventThreatDetectionCustomModule is the representation of an Event Threat Detection custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the
enablement_stateproperty in EffectiveEventThreatDetectionCustomModule is set to the value that is effective in the parent, instead ofINHERITED. For example, if the module is enabled in a parent organization or folder, the effectiveenablement_statefor the module in all child folders or projects is alsoenabled. EffectiveEventThreatDetectionCustomModule is read-only.- name¶
Output only. The resource name of the effective ETD custom module.
Its format is:
organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}.folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}.projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}.
- Type
- config¶
Output only. Config for the effective module.
- enablement_state¶
Output only. The effective state of enablement for the module at the given level of the hierarchy.
- class EnablementState(value)[source]¶
Bases:
proto.enums.EnumThe enablement state of the module.
- Values:
- ENABLEMENT_STATE_UNSPECIFIED (0):
Unspecified enablement state.
- ENABLED (1):
The module is enabled at the given level.
- DISABLED (2):
The module is disabled at the given level.
- class google.cloud.securitycenter_v1.types.EffectiveSecurityHealthAnalyticsCustomModule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn EffectiveSecurityHealthAnalyticsCustomModule is the representation of a Security Health Analytics custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the
enablementStateproperty in EffectiveSecurityHealthAnalyticsCustomModule is set to the value that is effective in the parent, instead ofINHERITED. For example, if the module is enabled in a parent organization or folder, the effective enablement_state for the module in all child folders or projects is alsoenabled. EffectiveSecurityHealthAnalyticsCustomModule is read-only.- name¶
Output only. The resource name of the custom module. Its format is “organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}”, or “folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}”, or “projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}”.
- Type
- custom_config¶
Output only. The user-specified configuration for the module.
- enablement_state¶
Output only. The effective state of enablement for the module at the given level of the hierarchy.
- display_name¶
Output only. The display name for the custom module. The name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.
- Type
- class EnablementState(value)[source]¶
Bases:
proto.enums.EnumThe enablement state of the module.
- Values:
- ENABLEMENT_STATE_UNSPECIFIED (0):
Unspecified enablement state.
- ENABLED (1):
The module is enabled at the given level.
- DISABLED (2):
The module is disabled at the given level.
- class google.cloud.securitycenter_v1.types.EnvironmentVariable(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA name-value pair representing an environment variable used in an operating system process.
- class google.cloud.securitycenter_v1.types.EventThreatDetectionCustomModule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents 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, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects.
- name¶
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}.
- Type
- config¶
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.
- ancestor_module¶
Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.
- Type
- enablement_state¶
The state of enablement for the module at the given level of the hierarchy.
- update_time¶
Output only. The time the module was last updated.
- class EnablementState(value)[source]¶
Bases:
proto.enums.EnumThe enablement state of the module.
- Values:
- ENABLEMENT_STATE_UNSPECIFIED (0):
Unspecified enablement state.
- ENABLED (1):
The module is enabled at the given level.
- DISABLED (2):
The module is disabled at the given level.
- INHERITED (3):
When the enablement state is inherited.
- class google.cloud.securitycenter_v1.types.ExfilResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResource where data was exfiltrated from or exfiltrated to.
- name¶
The resource’s full resource name.
- Type
- components¶
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.
- Type
MutableSequence[str]
- class google.cloud.securitycenter_v1.types.Exfiltration(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageExfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The
sourcesattribute lists the sources of the exfiltrated data. Thetargetsattribute lists the destinations the data was copied to.- sources¶
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.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.ExfilResource]
- targets¶
If there are multiple targets, each target would get a complete copy of the “joined” source data.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.ExfilResource]
- class google.cloud.securitycenter_v1.types.ExternalSystem(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresentation of third party SIEM/SOAR fields within SCC.
- name¶
Full resource name of the external system, for example: “organizations/1234/sources/5678/findings/123456/externalSystems/jira”, “folders/1234/sources/5678/findings/123456/externalSystems/jira”, “projects/1234/sources/5678/findings/123456/externalSystems/jira”.
- Type
- assignees¶
References primary/secondary etc assignees in the external system.
- Type
MutableSequence[str]
- external_uid¶
The identifier that’s used to track the finding’s corresponding case in the external system.
- Type
- status¶
The most recent status of the finding’s corresponding case, as reported by the external system.
- Type
- external_system_update_time¶
The time when the case was last updated, as reported by the external system.
- case_sla¶
The SLA of the finding’s corresponding case in the external system.
- case_create_time¶
The time when the case was created, as reported by the external system.
- case_close_time¶
The time when the case was closed, as reported by the external system.
- ticket_info¶
Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding.
- class TicketInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInformation about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding.
- update_time¶
The time when the ticket was last updated, as reported by the ticket system.
- class google.cloud.securitycenter_v1.types.File(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageFile information about the related binary/library used by an executable, or the script used by a script interpreter
- sha256¶
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.
- Type
- hashed_size¶
The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.
- Type
- disk_path¶
Path of the file in terms of underlying disk/partition identifiers.
- class DiskPath(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePath of the file in terms of underlying disk/partition identifiers.
- partition_uuid¶
UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)
- Type
- class google.cloud.securitycenter_v1.types.Finding(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSecurity 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.
- name¶
The 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}”.
- Type
- parent¶
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}”.
- Type
- resource_name¶
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.
- Type
- state¶
The state of the finding.
- category¶
The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: “XSS_FLASH_INJECTION”.
- Type
- external_uri¶
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.
- Type
- source_properties¶
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.
- Type
MutableMapping[str, google.protobuf.struct_pb2.Value]
- security_marks¶
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.
- event_time¶
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.
- create_time¶
The time at which the finding was created in Security Command Center.
- severity¶
The severity of the finding. This field is managed by the source that writes the finding.
- canonical_name¶
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.
- Type
- mute¶
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.
- finding_class¶
The class of the finding.
- indicator¶
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.
- vulnerability¶
Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)
- mute_update_time¶
Output only. The most recent time this finding was muted or unmuted.
- external_systems¶
Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields.
- Type
MutableMapping[str, google.cloud.securitycenter_v1.types.ExternalSystem]
- mitre_attack¶
MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org
- access¶
Access details associated with the finding, such as more information on the caller, which method was accessed, and from where.
- connections¶
Contains information about the IP connection associated with the finding.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Connection]
- mute_initiator¶
Records additional information about the mute operation, for example, the mute configuration that muted the finding and the user who muted the finding.
- Type
- mute_info¶
Output only. The mute information regarding this finding.
- processes¶
Represents operating system processes associated with the Finding.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Process]
- contacts¶
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" } ] } }
- Type
MutableMapping[str, google.cloud.securitycenter_v1.types.ContactDetails]
- compliances¶
Contains compliance information for security standards associated to the finding.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Compliance]
- parent_display_name¶
Output only. The human readable display name of the finding source such as “Event Threat Detection” or “Security Health Analytics”.
- Type
- exfiltration¶
Represents exfiltrations associated with the finding.
- iam_bindings¶
Represents IAM bindings associated with the finding.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.IamBinding]
- module_name¶
Unique identifier of the module which generated the finding. Example:
folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885
- Type
- containers¶
Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Container]
- kubernetes¶
Kubernetes resources associated with the finding.
- database¶
Database associated with the finding.
- attack_exposure¶
The results of an attack path simulation relevant to this finding.
- files¶
File associated with the finding.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.File]
- cloud_dlp_inspection¶
Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding.
- cloud_dlp_data_profile¶
Cloud DLP data profile that is associated with the finding.
- kernel_rootkit¶
Signature of the kernel rootkit.
- org_policies¶
Contains information about the org policies associated with the finding.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.OrgPolicy]
- application¶
Represents an application associated with the finding.
- backup_disaster_recovery¶
Fields related to Backup and DR findings.
- security_posture¶
The security posture associated with the finding.
- log_entries¶
Log entries that are relevant to the finding.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.LogEntry]
- load_balancers¶
The load balancers associated with the finding.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.LoadBalancer]
- cloud_armor¶
Fields related to Cloud Armor findings.
- notebook¶
Notebook associated with the finding.
- toxic_combination¶
Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests.
- group_memberships¶
Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.GroupMembership]
- class ContactsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class ExternalSystemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class FindingClass(value)[source]¶
Bases:
proto.enums.EnumRepresents what kind of Finding it is.
- Values:
- FINDING_CLASS_UNSPECIFIED (0):
Unspecified finding class.
- THREAT (1):
Describes unwanted or malicious activity.
- VULNERABILITY (2):
Describes a potential weakness in software that increases risk to Confidentiality & Integrity & Availability.
- MISCONFIGURATION (3):
Describes a potential weakness in cloud resource/asset configuration that increases risk.
- OBSERVATION (4):
Describes a security observation that is for informational purposes.
- SCC_ERROR (5):
Describes an error that prevents some SCC functionality.
- POSTURE_VIOLATION (6):
Describes a potential security risk due to a change in the security posture.
- TOXIC_COMBINATION (7):
Describes a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination.
- class Mute(value)[source]¶
Bases:
proto.enums.EnumMute state a finding can be in.
- Values:
- MUTE_UNSPECIFIED (0):
Unspecified.
- MUTED (1):
Finding has been muted.
- UNMUTED (2):
Finding has been unmuted.
- UNDEFINED (4):
Finding has never been muted/unmuted.
- class MuteInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules.
- static_mute¶
If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute.
- dynamic_mute_records¶
The list of dynamic mute rules that currently match the finding.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Finding.MuteInfo.DynamicMuteRecord]
- class DynamicMuteRecord(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe record of a dynamic mute rule that matches the finding.
- mute_config¶
The relative resource name of the mute rule, represented by a mute config, that created this record, for example
organizations/123/muteConfigs/mymuteconfigororganizations/123/locations/global/muteConfigs/mymuteconfig.- Type
- match_time¶
When the dynamic mute rule first matched the finding.
- class StaticMute(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInformation about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly.
- state¶
The static mute state. If the value is
MUTEDorUNMUTED, then the finding’s overall mute state will have the same value.
- apply_time¶
When the static mute was applied.
- class Severity(value)[source]¶
Bases:
proto.enums.EnumThe severity of the finding.
- Values:
- SEVERITY_UNSPECIFIED (0):
This value is used for findings when a source doesn’t write a severity value.
- CRITICAL (1):
Vulnerability:
A critical vulnerability is easily discoverable by an external actor, exploitable, and results in the direct ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. Examples include publicly accessible unprotected user data and public SSH access with weak or no passwords.
Threat:
Indicates a threat that is able to access, modify, or delete data or execute unauthorized code within existing resources.
- HIGH (2):
Vulnerability:
A high risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities in order to gain direct access and the ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. An example is a database with weak or no passwords that is only accessible internally. This database could easily be compromised by an actor that had access to the internal network.
Threat:
Indicates a threat that is able to create new computational resources in an environment but not able to access data or execute code in existing resources.
- MEDIUM (3):
Vulnerability:
A medium risk vulnerability could be used by an actor to gain access to resources or privileges that enable them to eventually (through multiple steps or a complex exploit) gain access and the ability to execute arbitrary code or exfiltrate data. An example is a service account with access to more projects than it should have. If an actor gains access to the service account, they could potentially use that access to manipulate a project the service account was not intended to.
Threat:
Indicates a threat that is able to cause operational impact but may not access data or execute unauthorized code.
- LOW (4):
Vulnerability:
A low risk vulnerability hampers a security organization’s ability to detect vulnerabilities or active threats in their deployment, or prevents the root cause investigation of security issues. An example is monitoring and logs being disabled for resource configurations and access.
Threat:
Indicates a threat that has obtained minimal access to an environment but is not able to access data, execute code, or create resources.
- class SourcePropertiesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class State(value)[source]¶
Bases:
proto.enums.EnumThe state of the finding.
- Values:
- STATE_UNSPECIFIED (0):
Unspecified state.
- ACTIVE (1):
The finding requires attention and has not been addressed yet.
- INACTIVE (2):
The finding has been fixed, triaged as a non-issue or otherwise addressed and is no longer active.
- class google.cloud.securitycenter_v1.types.Folder(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessage that contains the resource name and display name of a folder resource.
- resource_folder¶
Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name
- Type
- class google.cloud.securitycenter_v1.types.Geolocation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a geographical location for a given access.
- class google.cloud.securitycenter_v1.types.GetBigQueryExportRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for retrieving a BigQuery export.
- class google.cloud.securitycenter_v1.types.GetEffectiveEventThreatDetectionCustomModuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to get an EffectiveEventThreatDetectionCustomModule.
- name¶
Required. The resource name of the effective Event Threat Detection custom module.
Its format is:
organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}.folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}.projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}.
- Type
- class google.cloud.securitycenter_v1.types.GetEffectiveSecurityHealthAnalyticsCustomModuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for getting effective Security Health Analytics custom modules.
- name¶
Required. Name of the effective custom module to get. Its format is
organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule},folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}, orprojects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}- Type
- class google.cloud.securitycenter_v1.types.GetEventThreatDetectionCustomModuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to get an Event Threat Detection custom module.
- class google.cloud.securitycenter_v1.types.GetMuteConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for retrieving a mute config.
- name¶
Required. Name of the mute config to retrieve. Its format is
organizations/{organization}/muteConfigs/{config_id},folders/{folder}/muteConfigs/{config_id},projects/{project}/muteConfigs/{config_id},organizations/{organization}/locations/global/muteConfigs/{config_id},folders/{folder}/locations/global/muteConfigs/{config_id}, orprojects/{project}/locations/global/muteConfigs/{config_id}.- Type
- class google.cloud.securitycenter_v1.types.GetNotificationConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for getting a notification config.
- class google.cloud.securitycenter_v1.types.GetOrganizationSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for getting organization settings.
- class google.cloud.securitycenter_v1.types.GetResourceValueConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message to get resource value config
- class google.cloud.securitycenter_v1.types.GetSecurityHealthAnalyticsCustomModuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for getting Security Health Analytics custom modules.
- name¶
Required. Name of the custom module to get. Its format is
organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule},folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}, orprojects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}- Type
- class google.cloud.securitycenter_v1.types.GetSimulationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for getting simulation. Simulation name can include “latest” to retrieve the latest simulation For example, “organizations/123/simulations/latest”
- class google.cloud.securitycenter_v1.types.GetSourceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for getting a source.
- class google.cloud.securitycenter_v1.types.GetValuedResourceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for getting a valued resource.
- class google.cloud.securitycenter_v1.types.GroupAssetsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for grouping by assets.
- parent¶
Required. The name of the parent to group the assets by. Its format is
organizations/[organization_id],folders/[folder_id], orprojects/[project_id].- Type
- filter¶
Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators
ANDandOR. Parentheses are supported, andORhas higher precedence thanAND.Restrictions have the form
<field> <operator> <value>and may have a-character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include:name
security_center_properties.resource_name
resource_properties.a_property
security_marks.marks.marka
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
trueandfalsewithout quotes.
The following field and operator combinations are supported:
name:
=update_time:
=,>,<,>=,<=Usage: This should be milliseconds since epoch or an RFC3339 string. Examples:
update_time = "2019-06-10T16:07:18-07:00"update_time = 1560208038000create_time:
=,>,<,>=,<=Usage: This should be milliseconds since epoch or an RFC3339 string. Examples:
create_time = "2019-06-10T16:07:18-07:00"create_time = 1560208038000iam_policy.policy_blob:
=,:resource_properties:
=,:,>,<,>=,<=security_marks.marks:
=,:security_center_properties.resource_name:
=,:security_center_properties.resource_display_name:
=,:security_center_properties.resource_type:
=,:security_center_properties.resource_parent:
=,:security_center_properties.resource_parent_display_name:
=,:security_center_properties.resource_project:
=,:security_center_properties.resource_project_display_name:
=,:security_center_properties.resource_owners:
=,:
For example,
resource_properties.size = 100is a valid filter string.Use a partial match on the empty string to filter based on a property existing:
resource_properties.my_property : ""Use a negated partial match on the empty string to filter based on a property not existing:
-resource_properties.my_property : ""- Type
- group_by¶
Required. Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: “security_center_properties.resource_project,security_center_properties.project”.
The following fields are supported when compare_duration is not set:
security_center_properties.resource_project
security_center_properties.resource_project_display_name
security_center_properties.resource_type
security_center_properties.resource_parent
security_center_properties.resource_parent_display_name
The following fields are supported when compare_duration is set:
security_center_properties.resource_type
security_center_properties.resource_project_display_name
security_center_properties.resource_parent_display_name
- Type
- compare_duration¶
When compare_duration is set, the GroupResult’s “state_change” property is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time.
The state change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don’t affect the result. For example, the results aren’t affected if the asset is removed and re-created again.
Possible “state_change” values when compare_duration is specified:
“ADDED”: indicates that the asset was not present at the start of compare_duration, but present at reference_time.
“REMOVED”: indicates that the asset was present at the start of compare_duration, but not present at reference_time.
“ACTIVE”: indicates that the asset was present at both the start and the end of the time period defined by compare_duration and reference_time.
If compare_duration is not specified, then the only possible state_change is “UNUSED”, which will be the state_change set for all assets present at read_time.
If this field is set then
state_changemust be a specified field ingroup_by.
- read_time¶
Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API’s version of NOW.
- page_token¶
The value returned by the last
GroupAssetsResponse; indicates that this is a continuation of a priorGroupAssetscall, and that the system should return the next page of data.- Type
- class google.cloud.securitycenter_v1.types.GroupAssetsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for grouping by assets.
- group_by_results¶
Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.GroupResult]
- read_time¶
Time used for executing the groupBy request.
- next_page_token¶
Token to retrieve the next page of results, or empty if there are no more results.
- Type
- class google.cloud.securitycenter_v1.types.GroupFindingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for grouping by findings.
- parent¶
Required. Name of the source to groupBy. Its format is
organizations/[organization_id]/sources/[source_id],folders/[folder_id]/sources/[source_id], orprojects/[project_id]/sources/[source_id]. To groupBy across all sources provide a source_id of-. For example:organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-, orprojects/{project_id}/sources/-- Type
- filter¶
Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators
ANDandOR. Parentheses are supported, andORhas higher precedence thanAND.Restrictions have the form
<field> <operator> <value>and may have a-character in front of them to indicate negation. Examples include:name
source_properties.a_property
security_marks.marks.marka
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
trueandfalsewithout quotes.
The following field and operator combinations are supported:
name:
=parent:
=,:resource_name:
=,:state:
=,:category:
=,:external_uri:
=,:event_time:
=,>,<,>=,<=Usage: This should be milliseconds since epoch or an RFC3339 string. Examples:
event_time = "2019-06-10T16:07:18-07:00"event_time = 1560208038000severity:
=,:workflow_state:
=,:security_marks.marks:
=,:source_properties:
=,:,>,<,>=,<=For example,
source_properties.size = 100is a valid filter string.Use a partial match on the empty string to filter based on a property existing:
source_properties.my_property : ""Use a negated partial match on the empty string to filter based on a property not existing:
-source_properties.my_property : ""resource:
resource.name:
=,:resource.parent_name:
=,:resource.parent_display_name:
=,:resource.project_name:
=,:resource.project_display_name:
=,:resource.type:
=,:
- Type
- group_by¶
Required. Expression that defines what assets fields to use for grouping (including
state_change). The string value should follow SQL syntax: comma separated list of fields. For example: “parent,resource_name”.The following fields are supported when compare_duration is set:
state_change
- Type
- read_time¶
Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API’s version of NOW.
- compare_duration¶
When compare_duration is set, the GroupResult’s “state_change” attribute is updated to indicate whether the finding had its state changed, the finding’s state remained unchanged, or if the finding was added during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time.
The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don’t affect the result. For example, the results aren’t affected if the finding is made inactive and then active again.
Possible “state_change” values when compare_duration is specified:
“CHANGED”: indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time.
“UNCHANGED”: indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time.
“ADDED”: indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time.
“REMOVED”: indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time.
If compare_duration is not specified, then the only possible state_change is “UNUSED”, which will be the state_change set for all findings present at read_time.
If this field is set then
state_changemust be a specified field ingroup_by.
- page_token¶
The value returned by the last
GroupFindingsResponse; indicates that this is a continuation of a priorGroupFindingscall, and that the system should return the next page of data.- Type
- class google.cloud.securitycenter_v1.types.GroupFindingsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for group by findings.
- group_by_results¶
Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.GroupResult]
- read_time¶
Time used for executing the groupBy request.
- next_page_token¶
Token to retrieve the next page of results, or empty if there are no more results.
- Type
- class google.cloud.securitycenter_v1.types.GroupMembership(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageContains details about groups of which this finding is a member. A group is a collection of findings that are related in some way.
- group_type¶
Type of group.
- class GroupType(value)[source]¶
Bases:
proto.enums.EnumPossible types of groups.
- Values:
- GROUP_TYPE_UNSPECIFIED (0):
Default value.
- GROUP_TYPE_TOXIC_COMBINATION (1):
Group represents a toxic combination.
- class google.cloud.securitycenter_v1.types.GroupResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResult containing the properties and count of a groupBy request.
- properties¶
Properties matching the groupBy fields in the request.
- Type
MutableMapping[str, google.protobuf.struct_pb2.Value]
- class PropertiesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.securitycenter_v1.types.IamBinding(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a particular IAM binding, which captures a member’s role addition, removal, or state.
- action¶
The action that was performed on a Binding.
- role¶
Role that is assigned to “members”. For example, “roles/viewer”, “roles/editor”, or “roles/owner”.
- Type
- member¶
A single identity requesting access for a Cloud Platform resource, for example, “foo@google.com”.
- Type
- class Action(value)[source]¶
Bases:
proto.enums.EnumThe type of action performed on a Binding in a policy.
- Values:
- ACTION_UNSPECIFIED (0):
Unspecified.
- ADD (1):
Addition of a Binding.
- REMOVE (2):
Removal of a Binding.
- class google.cloud.securitycenter_v1.types.Indicator(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents 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.
- ip_addresses¶
The list of IP addresses that are associated with the finding.
- Type
MutableSequence[str]
- signatures¶
The list of matched signatures indicating that the given process is present in the environment.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Indicator.ProcessSignature]
- class ProcessSignature(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageIndicates what signature matched this process.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- memory_hash_signature¶
Signature indicating that a binary family was matched.
This field is a member of oneof
signature.
- yara_rule_signature¶
Signature indicating that a YARA rule was matched.
This field is a member of oneof
signature.
- signature_type¶
Describes the type of resource associated with the signature.
- class MemoryHashSignature(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA signature corresponding to memory page hashes.
- detections¶
The list of memory hash detections contributing to the binary family match.
- class Detection(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMemory hash detection contributing to the binary family match.
- class SignatureType(value)[source]¶
Bases:
proto.enums.EnumPossible resource types to be associated with a signature.
- Values:
- SIGNATURE_TYPE_UNSPECIFIED (0):
The default signature type.
- SIGNATURE_TYPE_PROCESS (1):
Used for signatures concerning processes.
- SIGNATURE_TYPE_FILE (2):
Used for signatures concerning disks.
- class YaraRuleSignature(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA signature corresponding to a YARA rule.
- class google.cloud.securitycenter_v1.types.KernelRootkit(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageKernel mode rootkit signatures.
- unexpected_code_modification¶
True if unexpected modifications of kernel code memory are present.
- Type
- unexpected_read_only_data_modification¶
True if unexpected modifications of kernel read-only data memory are present.
- Type
- unexpected_ftrace_handler¶
True if
ftracepoints are present with callbacks pointing to regions that are not in the expected kernel or module code range.- Type
- unexpected_kprobe_handler¶
True if
kprobepoints are present with callbacks pointing to regions that are not in the expected kernel or module code range.- Type
- unexpected_kernel_code_pages¶
True if kernel code pages that are not in the expected kernel or module code regions are present.
- Type
- unexpected_system_call_handler¶
True if system call handlers that are are not in the expected kernel or module code regions are present.
- Type
- unexpected_interrupt_handler¶
True if interrupt handlers that are are not in the expected kernel or module code regions are present.
- Type
- class google.cloud.securitycenter_v1.types.Kubernetes(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageKubernetes-related attributes.
- pods¶
Kubernetes Pods associated with the finding. This field contains Pod records for each container that is owned by a Pod.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Kubernetes.Pod]
- nodes¶
Provides Kubernetes node information.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Kubernetes.Node]
- node_pools¶
GKE node pools associated with the finding. This field contains node pool information for each node, when it is available.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Kubernetes.NodePool]
- roles¶
Provides Kubernetes role information for findings that involve Roles or ClusterRoles.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Kubernetes.Role]
- bindings¶
Provides Kubernetes role binding information for findings that involve RoleBindings or ClusterRoleBindings.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Kubernetes.Binding]
- access_reviews¶
Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Kubernetes.AccessReview]
- objects¶
Kubernetes objects related to the finding.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Kubernetes.Object]
- class AccessReview(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConveys 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.- ns¶
Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by “” (empty).
- Type
- verb¶
A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. “*” means all.
- Type
- class Binding(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a Kubernetes RoleBinding or ClusterRoleBinding.
- role¶
The Role or ClusterRole referenced by the binding.
- subjects¶
Represents one or more subjects that are bound to the role. Not always available for PATCH requests.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Kubernetes.Subject]
- class Node(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageKubernetes nodes associated with the finding.
- name¶
Full resource name of the Compute Engine VM running the cluster node.
- Type
- class NodePool(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageProvides GKE node pool information.
- nodes¶
Nodes associated with the finding.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Kubernetes.Node]
- class Object(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageKubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview.
- ns¶
Kubernetes object namespace. Must be a valid DNS label. Named “ns” to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/.
- Type
- name¶
Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/.
- Type
- containers¶
Pod containers associated with this finding, if any.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Container]
- class Pod(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA Kubernetes Pod.
- labels¶
Pod labels. For Kubernetes containers, these are applied to the container.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Label]
- containers¶
Pod containers associated with this finding, if any.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Container]
- class Role(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageKubernetes Role or ClusterRole.
- kind¶
Role type.
- class Kind(value)[source]¶
Bases:
proto.enums.EnumTypes of Kubernetes roles.
- Values:
- KIND_UNSPECIFIED (0):
Role type is not specified.
- ROLE (1):
Kubernetes Role.
- CLUSTER_ROLE (2):
Kubernetes ClusterRole.
- class Subject(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a Kubernetes subject.
- kind¶
Authentication type for the subject.
- class AuthType(value)[source]¶
Bases:
proto.enums.EnumAuth types that can be used for the subject’s kind field.
- Values:
- AUTH_TYPE_UNSPECIFIED (0):
Authentication is not specified.
- USER (1):
User with valid certificate.
- SERVICEACCOUNT (2):
Users managed by Kubernetes API with credentials stored as secrets.
- GROUP (3):
Collection of users.
- class google.cloud.securitycenter_v1.types.Label(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a generic name-value label. A label has separate name and value fields to support filtering with the
contains()function. For more information, see Filtering on array-type fields.
- class google.cloud.securitycenter_v1.types.ListAssetsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for listing assets.
- parent¶
Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values:
organizations/[organization_id],folders/[folder_id], orprojects/[project_id].- Type
- filter¶
Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators
ANDandOR. Parentheses are supported, andORhas higher precedence thanAND.Restrictions have the form
<field> <operator> <value>and may have a-character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include:name
security_center_properties.resource_name
resource_properties.a_property
security_marks.marks.marka
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
trueandfalsewithout quotes.
The following are the allowed field and operator combinations:
name:
=update_time:
=,>,<,>=,<=Usage: This should be milliseconds since epoch or an RFC3339 string. Examples:
update_time = "2019-06-10T16:07:18-07:00"update_time = 1560208038000create_time:
=,>,<,>=,<=Usage: This should be milliseconds since epoch or an RFC3339 string. Examples:
create_time = "2019-06-10T16:07:18-07:00"create_time = 1560208038000iam_policy.policy_blob:
=,:resource_properties:
=,:,>,<,>=,<=security_marks.marks:
=,:security_center_properties.resource_name:
=,:security_center_properties.resource_display_name:
=,:security_center_properties.resource_type:
=,:security_center_properties.resource_parent:
=,:security_center_properties.resource_parent_display_name:
=,:security_center_properties.resource_project:
=,:security_center_properties.resource_project_display_name:
=,:security_center_properties.resource_owners:
=,:
For example,
resource_properties.size = 100is a valid filter string.Use a partial match on the empty string to filter based on a property existing:
resource_properties.my_property : ""Use a negated partial match on the empty string to filter based on a property not existing:
-resource_properties.my_property : ""- Type
- order_by¶
Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: “name,resource_properties.a_property”. The default sorting order is ascending. To specify descending order for a field, a suffix ” desc” should be appended to the field name. For example: “name desc,resource_properties.a_property”. Redundant space characters in the syntax are insignificant. “name desc,resource_properties.a_property” and ” name desc , resource_properties.a_property ” are equivalent.
The following fields are supported: name update_time resource_properties security_marks.marks security_center_properties.resource_name security_center_properties.resource_display_name security_center_properties.resource_parent security_center_properties.resource_parent_display_name security_center_properties.resource_project security_center_properties.resource_project_display_name security_center_properties.resource_type
- Type
- read_time¶
Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API’s version of NOW.
- compare_duration¶
When compare_duration is set, the ListAssetsResult’s “state_change” attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time.
The state_change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don’t affect the result. For example, the results aren’t affected if the asset is removed and re-created again.
Possible “state_change” values when compare_duration is specified:
“ADDED”: indicates that the asset was not present at the start of compare_duration, but present at read_time.
“REMOVED”: indicates that the asset was present at the start of compare_duration, but not present at read_time.
“ACTIVE”: indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time.
If compare_duration is not specified, then the only possible state_change is “UNUSED”, which will be the state_change set for all assets present at read_time.
- field_mask¶
A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields.
- page_token¶
The value returned by the last
ListAssetsResponse; indicates that this is a continuation of a priorListAssetscall, and that the system should return the next page of data.- Type
- class google.cloud.securitycenter_v1.types.ListAssetsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for listing assets.
- list_assets_results¶
Assets matching the list request.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.ListAssetsResponse.ListAssetsResult]
- read_time¶
Time used for executing the list request.
- next_page_token¶
Token to retrieve the next page of results, or empty if there are no more results.
- Type
- class ListAssetsResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResult containing the Asset and its State.
- asset¶
Asset matching the search request.
- state_change¶
State change of the asset between the points in time.
- class StateChange(value)[source]¶
Bases:
proto.enums.EnumThe change in state of the asset.
When querying across two points in time this describes the change between the two points: ADDED, REMOVED, or ACTIVE. If there was no compare_duration supplied in the request the state change will be: UNUSED
- Values:
- UNUSED (0):
State change is unused, this is the canonical default for this enum.
- ADDED (1):
Asset was added between the points in time.
- REMOVED (2):
Asset was removed between the points in time.
- ACTIVE (3):
Asset was present at both point(s) in time.
- class google.cloud.securitycenter_v1.types.ListAttackPathsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for listing the attack paths for a given simulation or valued resource.
- parent¶
Required. Name of parent to list attack paths.
Valid formats:
organizations/{organization},organizations/{organization}/simulations/{simulation}organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}- Type
- filter¶
The filter expression that filters the attack path in the response. Supported fields:
valued_resourcessupports =
- Type
- page_token¶
The value returned by the last
ListAttackPathsResponse; indicates that this is a continuation of a priorListAttackPathscall, and that the system should return the next page of data.- Type
- class google.cloud.securitycenter_v1.types.ListAttackPathsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for listing the attack paths for a given simulation or valued resource.
- attack_paths¶
The attack paths that the attack path simulation identified.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.AttackPath]
- class google.cloud.securitycenter_v1.types.ListBigQueryExportsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for listing BigQuery exports at a given scope e.g. organization, folder or project.
- parent¶
Required. The parent, which owns the collection of BigQuery exports. Its format is
organizations/[organization_id],folders/[folder_id],projects/[project_id].- Type
- page_size¶
The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
- Type
- class google.cloud.securitycenter_v1.types.ListBigQueryExportsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for listing BigQuery exports.
- big_query_exports¶
The BigQuery exports from the specified parent.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.BigQueryExport]
- class google.cloud.securitycenter_v1.types.ListDescendantEventThreatDetectionCustomModulesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to list current and descendant resident Event Threat Detection custom modules.
- parent¶
Required. Name of the parent to list custom modules under.
Its format is:
organizations/{organization}/eventThreatDetectionSettings.folders/{folder}/eventThreatDetectionSettings.projects/{project}/eventThreatDetectionSettings.
- Type
- page_token¶
A page token, received from a previous
ListDescendantEventThreatDetectionCustomModulescall. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListDescendantEventThreatDetectionCustomModulesmust match the call that provided the page token.- Type
- class google.cloud.securitycenter_v1.types.ListDescendantEventThreatDetectionCustomModulesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse for listing current and descendant resident Event Threat Detection custom modules.
- event_threat_detection_custom_modules¶
Custom modules belonging to the requested parent.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.EventThreatDetectionCustomModule]
- class google.cloud.securitycenter_v1.types.ListDescendantSecurityHealthAnalyticsCustomModulesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for listing descendant Security Health Analytics custom modules.
- parent¶
Required. Name of parent to list descendant custom modules. Its format is
organizations/{organization}/securityHealthAnalyticsSettings,folders/{folder}/securityHealthAnalyticsSettings, orprojects/{project}/securityHealthAnalyticsSettings- Type
- page_size¶
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
- Type
- class google.cloud.securitycenter_v1.types.ListDescendantSecurityHealthAnalyticsCustomModulesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for listing descendant Security Health Analytics custom modules.
- security_health_analytics_custom_modules¶
Custom modules belonging to the requested parent and its descendants.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.SecurityHealthAnalyticsCustomModule]
- class google.cloud.securitycenter_v1.types.ListEffectiveEventThreatDetectionCustomModulesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to list effective Event Threat Detection custom modules.
- parent¶
Required. Name of the parent to list custom modules for.
Its format is:
organizations/{organization}/eventThreatDetectionSettings.folders/{folder}/eventThreatDetectionSettings.projects/{project}/eventThreatDetectionSettings.
- Type
- page_token¶
A page token, received from a previous
ListEffectiveEventThreatDetectionCustomModulescall. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListEffectiveEventThreatDetectionCustomModulesmust match the call that provided the page token.- Type
- class google.cloud.securitycenter_v1.types.ListEffectiveEventThreatDetectionCustomModulesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse for listing EffectiveEventThreatDetectionCustomModules.
- effective_event_threat_detection_custom_modules¶
Effective custom modules belonging to the requested parent.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.EffectiveEventThreatDetectionCustomModule]
- class google.cloud.securitycenter_v1.types.ListEffectiveSecurityHealthAnalyticsCustomModulesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for listing effective Security Health Analytics custom modules.
- parent¶
Required. Name of parent to list effective custom modules. Its format is
organizations/{organization}/securityHealthAnalyticsSettings,folders/{folder}/securityHealthAnalyticsSettings, orprojects/{project}/securityHealthAnalyticsSettings- Type
- page_size¶
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
- Type
- class google.cloud.securitycenter_v1.types.ListEffectiveSecurityHealthAnalyticsCustomModulesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for listing effective Security Health Analytics custom modules.
- effective_security_health_analytics_custom_modules¶
Effective custom modules belonging to the requested parent.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.EffectiveSecurityHealthAnalyticsCustomModule]
- class google.cloud.securitycenter_v1.types.ListEventThreatDetectionCustomModulesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to list Event Threat Detection custom modules.
- parent¶
Required. Name of the parent to list custom modules under.
Its format is:
organizations/{organization}/eventThreatDetectionSettings.folders/{folder}/eventThreatDetectionSettings.projects/{project}/eventThreatDetectionSettings.
- Type
- page_token¶
A page token, received from a previous
ListEventThreatDetectionCustomModulescall. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListEventThreatDetectionCustomModulesmust match the call that provided the page token.- Type
- class google.cloud.securitycenter_v1.types.ListEventThreatDetectionCustomModulesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse for listing Event Threat Detection custom modules.
- event_threat_detection_custom_modules¶
Custom modules belonging to the requested parent.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.EventThreatDetectionCustomModule]
- class google.cloud.securitycenter_v1.types.ListFindingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for listing findings.
- parent¶
Required. Name of the source the findings belong to. Its format is
organizations/[organization_id]/sources/[source_id],folders/[folder_id]/sources/[source_id], orprojects/[project_id]/sources/[source_id]. To list across all sources provide a source_id of-. For example:organizations/{organization_id}/sources/-,folders/{folder_id}/sources/-orprojects/{projects_id}/sources/-- Type
- filter¶
Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators
ANDandOR. Parentheses are supported, andORhas higher precedence thanAND.Restrictions have the form
<field> <operator> <value>and may have a-character in front of them to indicate negation. Examples include:name
source_properties.a_property
security_marks.marks.marka
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
trueandfalsewithout quotes.
The following field and operator combinations are supported:
name:
=parent:
=,:resource_name:
=,:state:
=,:category:
=,:external_uri:
=,:event_time:
=,>,<,>=,<=Usage: This should be milliseconds since epoch or an RFC3339 string. Examples:
event_time = "2019-06-10T16:07:18-07:00"event_time = 1560208038000severity:
=,:workflow_state:
=,:security_marks.marks:
=,:source_properties:
=,:,>,<,>=,<=For example,
source_properties.size = 100is a valid filter string.Use a partial match on the empty string to filter based on a property existing:
source_properties.my_property : ""Use a negated partial match on the empty string to filter based on a property not existing:
-source_properties.my_property : ""resource:
resource.name:
=,:resource.parent_name:
=,:resource.parent_display_name:
=,:resource.project_name:
=,:resource.project_display_name:
=,:resource.type:
=,:resource.folders.resource_folder:
=,:resource.display_name:
=,:
- Type
- order_by¶
Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: “name,resource_properties.a_property”. The default sorting order is ascending. To specify descending order for a field, a suffix ” desc” should be appended to the field name. For example: “name desc,source_properties.a_property”. Redundant space characters in the syntax are insignificant. “name desc,source_properties.a_property” and ” name desc , source_properties.a_property ” are equivalent.
The following fields are supported: name parent state category resource_name event_time source_properties security_marks.marks
- Type
- read_time¶
Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API’s version of NOW.
- compare_duration¶
When compare_duration is set, the ListFindingsResult’s “state_change” attribute is updated to indicate whether the finding had its state changed, the finding’s state remained unchanged, or if the finding was added in any state during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time.
The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don’t affect the result. For example, the results aren’t affected if the finding is made inactive and then active again.
Possible “state_change” values when compare_duration is specified:
“CHANGED”: indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time.
“UNCHANGED”: indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time.
“ADDED”: indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time.
“REMOVED”: indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time.
If compare_duration is not specified, then the only possible state_change is “UNUSED”, which will be the state_change set for all findings present at read_time.
- field_mask¶
A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.
- page_token¶
The value returned by the last
ListFindingsResponse; indicates that this is a continuation of a priorListFindingscall, and that the system should return the next page of data.- Type
- class google.cloud.securitycenter_v1.types.ListFindingsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for listing findings.
- list_findings_results¶
Findings matching the list request.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.ListFindingsResponse.ListFindingsResult]
- read_time¶
Time used for executing the list request.
- next_page_token¶
Token to retrieve the next page of results, or empty if there are no more results.
- Type
- class ListFindingsResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResult containing the Finding and its StateChange.
- finding¶
Finding matching the search request.
- state_change¶
State change of the finding between the points in time.
- resource¶
Output only. Resource that is associated with this finding.
- class Resource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInformation related to the Google Cloud resource that is associated with this finding.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- name¶
The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name
- Type
- folders¶
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.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Folder]
- cloud_provider¶
Indicates which cloud provider the finding is from.
- aws_metadata¶
The AWS metadata associated with the finding.
This field is a member of oneof
cloud_provider_metadata.
- azure_metadata¶
The Azure metadata associated with the finding.
This field is a member of oneof
cloud_provider_metadata.
- resource_path¶
Provides the path to the resource within the resource hierarchy.
- resource_path_string¶
A string representation of the resource path. For Google Cloud, it has the format of
org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id}where there can be any number of folders. For AWS, it has the format oforg/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}where there can be any number of organizational units. For Azure, it has the format ofmg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}where there can be any number of management groups.- Type
- class StateChange(value)[source]¶
Bases:
proto.enums.EnumThe change in state of the finding.
When querying across two points in time this describes the change in the finding between the two points: CHANGED, UNCHANGED, ADDED, or REMOVED. Findings can not be deleted, so REMOVED implies that the finding at timestamp does not match the filter specified, but it did at timestamp - compare_duration. If there was no compare_duration supplied in the request the state change will be: UNUSED
- Values:
- UNUSED (0):
State change is unused, this is the canonical default for this enum.
- CHANGED (1):
The finding has changed state in some way between the points in time and existed at both points.
- UNCHANGED (2):
The finding has not changed state between the points in time and existed at both points.
- ADDED (3):
The finding was created between the points in time.
- REMOVED (4):
The finding at timestamp does not match the filter specified, but it did at timestamp - compare_duration.
- class google.cloud.securitycenter_v1.types.ListMuteConfigsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for listing mute configs at a given scope e.g. organization, folder or project.
- parent¶
Required. The parent, which owns the collection of mute configs. Its format is
organizations/[organization_id],folders/[folder_id],projects/[project_id].- Type
- page_size¶
The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
- Type
- class google.cloud.securitycenter_v1.types.ListMuteConfigsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for listing mute configs.
- mute_configs¶
The mute configs from the specified parent.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.MuteConfig]
- class google.cloud.securitycenter_v1.types.ListNotificationConfigsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for listing notification configs.
- parent¶
Required. The name of the parent in which to list the notification configurations. Its format is “organizations/[organization_id]”, “folders/[folder_id]”, or “projects/[project_id]”.
- Type
- page_token¶
The value returned by the last
ListNotificationConfigsResponse; indicates that this is a continuation of a priorListNotificationConfigscall, and that the system should return the next page of data.- Type
- class google.cloud.securitycenter_v1.types.ListNotificationConfigsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for listing notification configs.
- notification_configs¶
Notification configs belonging to the requested parent.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.NotificationConfig]
- class google.cloud.securitycenter_v1.types.ListResourceValueConfigsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message to list resource value configs of a parent
- parent¶
Required. The parent, which owns the collection of resource value configs. Its format is
organizations/[organization_id]- Type
- page_size¶
The number of results to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
- Type
- page_token¶
A page token, received from a previous
ListResourceValueConfigscall. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListResourceValueConfigsmust match the call that provided the page token.page_size can be specified, and the new page_size will be used.
- Type
- class google.cloud.securitycenter_v1.types.ListResourceValueConfigsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message to list resource value configs
- resource_value_configs¶
The resource value configs from the specified parent.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.ResourceValueConfig]
- class google.cloud.securitycenter_v1.types.ListSecurityHealthAnalyticsCustomModulesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for listing Security Health Analytics custom modules.
- parent¶
Required. Name of parent to list custom modules. Its format is
organizations/{organization}/securityHealthAnalyticsSettings,folders/{folder}/securityHealthAnalyticsSettings, orprojects/{project}/securityHealthAnalyticsSettings- Type
- page_size¶
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
- Type
- class google.cloud.securitycenter_v1.types.ListSecurityHealthAnalyticsCustomModulesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for listing Security Health Analytics custom modules.
- security_health_analytics_custom_modules¶
Custom modules belonging to the requested parent.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.SecurityHealthAnalyticsCustomModule]
- class google.cloud.securitycenter_v1.types.ListSourcesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for listing sources.
- parent¶
Required. Resource name of the parent of sources to list. Its format should be
organizations/[organization_id],folders/[folder_id], orprojects/[project_id].- Type
- page_token¶
The value returned by the last
ListSourcesResponse; indicates that this is a continuation of a priorListSourcescall, and that the system should return the next page of data.- Type
- class google.cloud.securitycenter_v1.types.ListSourcesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for listing sources.
- sources¶
Sources belonging to the requested parent.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Source]
- class google.cloud.securitycenter_v1.types.ListValuedResourcesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for listing the valued resources for a given simulation.
- parent¶
Required. Name of parent to list valued resources.
Valid formats:
organizations/{organization},organizations/{organization}/simulations/{simulation}organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}- Type
- filter¶
The filter expression that filters the valued resources in the response. Supported fields:
resource_valuesupports =resource_typesupports =
- Type
- page_token¶
The value returned by the last
ListValuedResourcesResponse; indicates that this is a continuation of a priorListValuedResourcescall, and that the system should return the next page of data.- Type
- page_size¶
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
- Type
- order_by¶
Optional. The fields by which to order the valued resources response.
Supported fields:
exposed_scoreresource_valueresource_typeresourcedisplay_name
Values should be a comma separated list of fields. For example:
exposed_score,resource_value.The default sorting order is descending. To specify ascending or descending order for a field, append a
ASCor aDESCsuffix, respectively; for example:exposed_score DESC.- Type
- class google.cloud.securitycenter_v1.types.ListValuedResourcesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for listing the valued resources for a given simulation.
- valued_resources¶
The valued resources that the attack path simulation identified.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.ValuedResource]
- next_page_token¶
Token to retrieve the next page of results, or empty if there are no more results.
- Type
- class google.cloud.securitycenter_v1.types.LoadBalancer(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageContains information related to the load balancer associated with the finding.
- class google.cloud.securitycenter_v1.types.LogEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn individual entry in a log.
- class google.cloud.securitycenter_v1.types.MitreAttack(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org
- primary_tactic¶
The MITRE ATT&CK tactic most closely represented by this finding, if any.
- primary_techniques¶
The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g.
SCANNING_IP_BLOCKS), both the sub-technique and its parent technique(s) will be listed (e.g.SCANNING_IP_BLOCKS,ACTIVE_SCANNING).- Type
MutableSequence[google.cloud.securitycenter_v1.types.MitreAttack.Technique]
- additional_tactics¶
Additional MITRE ATT&CK tactics related to this finding, if any.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.MitreAttack.Tactic]
- additional_techniques¶
Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.MitreAttack.Technique]
- class Tactic(value)[source]¶
Bases:
proto.enums.EnumMITRE ATT&CK tactics that can be referenced by SCC findings. See: https://attack.mitre.org/tactics/enterprise/
- Values:
- TACTIC_UNSPECIFIED (0):
Unspecified value.
- RECONNAISSANCE (1):
TA0043
- RESOURCE_DEVELOPMENT (2):
TA0042
- INITIAL_ACCESS (5):
TA0001
- EXECUTION (3):
TA0002
- PERSISTENCE (6):
TA0003
- PRIVILEGE_ESCALATION (8):
TA0004
- DEFENSE_EVASION (7):
TA0005
- CREDENTIAL_ACCESS (9):
TA0006
- DISCOVERY (10):
TA0007
- LATERAL_MOVEMENT (11):
TA0008
- COLLECTION (12):
TA0009
- COMMAND_AND_CONTROL (4):
TA0011
- EXFILTRATION (13):
TA0010
- IMPACT (14):
TA0040
- class Technique(value)[source]¶
Bases:
proto.enums.EnumMITRE ATT&CK techniques that can be referenced by SCC findings. See: https://attack.mitre.org/techniques/enterprise/ Next ID: 65
- Values:
- TECHNIQUE_UNSPECIFIED (0):
Unspecified value.
- MASQUERADING (49):
T1036
- MATCH_LEGITIMATE_NAME_OR_LOCATION (50):
T1036.005
- BOOT_OR_LOGON_INITIALIZATION_SCRIPTS (37):
T1037
- STARTUP_ITEMS (38):
T1037.005
- NETWORK_SERVICE_DISCOVERY (32):
T1046
- PROCESS_DISCOVERY (56):
T1057
- COMMAND_AND_SCRIPTING_INTERPRETER (6):
T1059
- UNIX_SHELL (7):
T1059.004
- PYTHON (59):
T1059.006
- EXPLOITATION_FOR_PRIVILEGE_ESCALATION (63):
T1068
- PERMISSION_GROUPS_DISCOVERY (18):
T1069
- CLOUD_GROUPS (19):
T1069.003
- INDICATOR_REMOVAL_FILE_DELETION (64):
T1070.004
- APPLICATION_LAYER_PROTOCOL (45):
T1071
- DNS (46):
T1071.004
- SOFTWARE_DEPLOYMENT_TOOLS (47):
T1072
- VALID_ACCOUNTS (14):
T1078
- DEFAULT_ACCOUNTS (35):
T1078.001
- LOCAL_ACCOUNTS (15):
T1078.003
- CLOUD_ACCOUNTS (16):
T1078.004
- PROXY (9):
T1090
- EXTERNAL_PROXY (10):
T1090.002
- MULTI_HOP_PROXY (11):
T1090.003
- ACCOUNT_MANIPULATION (22):
T1098
- ADDITIONAL_CLOUD_CREDENTIALS (40):
T1098.001
- SSH_AUTHORIZED_KEYS (23):
T1098.004
- ADDITIONAL_CONTAINER_CLUSTER_ROLES (58):
T1098.006
- INGRESS_TOOL_TRANSFER (3):
T1105
- NATIVE_API (4):
T1106
- BRUTE_FORCE (44):
T1110
- SHARED_MODULES (5):
T1129
- ACCESS_TOKEN_MANIPULATION (33):
T1134
- TOKEN_IMPERSONATION_OR_THEFT (39):
T1134.001
- EXPLOIT_PUBLIC_FACING_APPLICATION (27):
T1190
- DOMAIN_POLICY_MODIFICATION (30):
T1484
- DATA_DESTRUCTION (29):
T1485
- SERVICE_STOP (52):
T1489
- INHIBIT_SYSTEM_RECOVERY (36):
T1490
- RESOURCE_HIJACKING (8):
T1496
- NETWORK_DENIAL_OF_SERVICE (17):
T1498
- CLOUD_SERVICE_DISCOVERY (48):
T1526
- STEAL_APPLICATION_ACCESS_TOKEN (42):
T1528
- ACCOUNT_ACCESS_REMOVAL (51):
T1531
- STEAL_WEB_SESSION_COOKIE (25):
T1539
- CREATE_OR_MODIFY_SYSTEM_PROCESS (24):
T1543
- ABUSE_ELEVATION_CONTROL_MECHANISM (34):
T1548
- UNSECURED_CREDENTIALS (13):
T1552
- MODIFY_AUTHENTICATION_PROCESS (28):
T1556
- IMPAIR_DEFENSES (31):
T1562
- DISABLE_OR_MODIFY_TOOLS (55):
T1562.001
- EXFILTRATION_OVER_WEB_SERVICE (20):
T1567
- EXFILTRATION_TO_CLOUD_STORAGE (21):
T1567.002
- DYNAMIC_RESOLUTION (12):
T1568
- LATERAL_TOOL_TRANSFER (41):
T1570
- MODIFY_CLOUD_COMPUTE_INFRASTRUCTURE (26):
T1578
- CREATE_SNAPSHOT (54):
T1578.001
- CLOUD_INFRASTRUCTURE_DISCOVERY (53):
T1580
- OBTAIN_CAPABILITIES (43):
T1588
- ACTIVE_SCANNING (1):
T1595
- SCANNING_IP_BLOCKS (2):
T1595.001
- CONTAINER_ADMINISTRATION_COMMAND (60):
T1609
- ESCAPE_TO_HOST (61):
T1611
- CONTAINER_AND_RESOURCE_DISCOVERY (57):
T1613
- STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES (62):
T1649
- class google.cloud.securitycenter_v1.types.MuteConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
- name¶
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}organizations/{organization}/locations/global/muteConfigs/{mute_config}folders/{folder}/locations/global/muteConfigs/{mute_config}projects/{project}/locations/global/muteConfigs/{mute_config}- Type
- filter¶
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:
=,:
- Type
- create_time¶
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.
- update_time¶
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.
- most_recent_editor¶
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.
- Type
- type_¶
Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation.
- expiry_time¶
Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.
- class MuteConfigType(value)[source]¶
Bases:
proto.enums.EnumThe type of MuteConfig.
- Values:
- MUTE_CONFIG_TYPE_UNSPECIFIED (0):
Unused.
- STATIC (1):
A static mute config, which sets the static mute state of future matching findings to muted. Once the static mute state has been set, finding or config modifications will not affect the state.
- DYNAMIC (2):
A dynamic mute config, which is applied to existing and future matching findings, setting their dynamic mute state to “muted”. If the config is updated or deleted, or a matching finding is updated, such that the finding doesn’t match the config, the config will be removed from the finding, and the finding’s dynamic mute state may become “unmuted” (unless other configs still match).
- class google.cloud.securitycenter_v1.types.Notebook(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a Jupyter notebook IPYNB file, such as a Colab Enterprise notebook file, that is associated with a finding.
- notebook_update_time¶
The most recent time the notebook was updated.
- class google.cloud.securitycenter_v1.types.NotificationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc.
- name¶
The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: “organizations/{organization_id}/notificationConfigs/notify_public_bucket”, “folders/{folder_id}/notificationConfigs/notify_public_bucket”, or “projects/{project_id}/notificationConfigs/notify_public_bucket”.
- Type
- pubsub_topic¶
The Pub/Sub topic to send notifications to. Its format is “projects/[project_id]/topics/[topic]”.
- Type
- service_account¶
Output only. The service account that needs “pubsub.topics.publish” permission to publish to the Pub/Sub topic.
- Type
- streaming_config¶
The config for triggering streaming-based notifications.
This field is a member of oneof
notify_config.
- class StreamingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe config for streaming-based notifications, which send each event as soon as it is detected.
- filter¶
Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators
ANDandOR. Parentheses are supported, andORhas higher precedence thanAND.Restrictions have the form
<field> <operator> <value>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
trueandfalsewithout quotes.
- Type
- class google.cloud.securitycenter_v1.types.NotificationMessage(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCloud SCC’s Notification
- notification_config_name¶
Name of the notification config that generated current notification.
- Type
- finding¶
If it’s a Finding based notification config, this field will be populated.
This field is a member of oneof
event.
- resource¶
The Cloud resource tied to this notification’s Finding.
- class google.cloud.securitycenter_v1.types.OrgPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageContains information about the org policies associated with the finding.
- class google.cloud.securitycenter_v1.types.OrganizationSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUser specified settings that are attached to the Security Command Center organization.
- name¶
The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: “organizations/{organization_id}/organizationSettings”.
- Type
- enable_asset_discovery¶
A flag that indicates if Asset Discovery should be enabled. If the flag is set to
true, then discovery of assets will occur. If it is set tofalse, all historical assets will remain, but discovery of future assets will not occur.- Type
- asset_discovery_config¶
The configuration used for Asset Discovery runs.
- class AssetDiscoveryConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe configuration used for Asset Discovery runs.
- inclusion_mode¶
The mode to use for filtering asset discovery.
- folder_ids¶
The folder ids to use for filtering asset discovery. It consists of only digits, e.g., 756619654966.
- Type
MutableSequence[str]
- class InclusionMode(value)[source]¶
Bases:
proto.enums.EnumThe mode of inclusion when running Asset Discovery. Asset discovery can be limited by explicitly identifying projects to be included or excluded. If INCLUDE_ONLY is set, then only those projects within the organization and their children are discovered during asset discovery. If EXCLUDE is set, then projects that don’t match those projects are discovered during asset discovery. If neither are set, then all projects within the organization are discovered during asset discovery.
- Values:
- INCLUSION_MODE_UNSPECIFIED (0):
Unspecified. Setting the mode with this value will disable inclusion/exclusion filtering for Asset Discovery.
- INCLUDE_ONLY (1):
Asset Discovery will capture only the resources within the projects specified. All other resources will be ignored.
- EXCLUDE (2):
Asset Discovery will ignore all resources under the projects specified. All other resources will be retrieved.
- class google.cloud.securitycenter_v1.types.Package(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePackage is a generic definition of a package.
- class google.cloud.securitycenter_v1.types.Position(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA position in the uploaded text version of a module.
- class google.cloud.securitycenter_v1.types.Process(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents an operating system process.
- name¶
The process name, as displayed in utilities like
topandps. This name can be accessed through/proc/[pid]/command changed withprctl(PR_SET_NAME).- Type
- binary¶
File information for the process executable.
- libraries¶
File information for libraries loaded by the process.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.File]
- script¶
When the process represents the invocation of a script,
binaryprovides information about the interpreter, whilescriptprovides information about the script file provided to the interpreter.
- env_variables¶
Process environment variables.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.EnvironmentVariable]
- class google.cloud.securitycenter_v1.types.Reference(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAdditional Links
- uri¶
Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527.
- Type
- class google.cloud.securitycenter_v1.types.Requests(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInformation about the requests relevant to the finding.
- ratio¶
For ‘Increasing deny ratio’, the ratio is the denied traffic divided by the allowed traffic. For ‘Allowed traffic spike’, the ratio is the allowed traffic in the short term divided by allowed traffic in the long term.
- Type
- class google.cloud.securitycenter_v1.types.Resource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInformation related to the Google Cloud resource.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- name¶
The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name
- Type
- folders¶
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.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.Folder]
- cloud_provider¶
Indicates which cloud provider the resource resides in.
- organization¶
Indicates which organization or tenant in the cloud provider the finding applies to.
- Type
- service¶
The parent service or product from which the resource is provided, for example, GKE or SNS.
- Type
- aws_metadata¶
The AWS metadata associated with the finding.
This field is a member of oneof
cloud_provider_metadata.
- azure_metadata¶
The Azure metadata associated with the finding.
This field is a member of oneof
cloud_provider_metadata.
- resource_path¶
Provides the path to the resource within the resource hierarchy.
- resource_path_string¶
A string representation of the resource path. For Google Cloud, it has the format of
organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id}where there can be any number of folders. For AWS, it has the format oforg/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}where there can be any number of organizational units. For Azure, it has the format ofmg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}where there can be any number of management groups.- Type
- class google.cloud.securitycenter_v1.types.ResourcePath(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents the path of resources leading up to the resource this finding is about.
- nodes¶
The list of nodes that make the up resource path, ordered from lowest level to highest level.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.ResourcePath.ResourcePathNode]
- class ResourcePathNode(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA node within the resource path. Each node represents a resource within the resource hierarchy.
- node_type¶
The type of resource this node represents.
- class ResourcePathNodeType(value)[source]¶
Bases:
proto.enums.EnumThe type of resource the node represents.
- Values:
- RESOURCE_PATH_NODE_TYPE_UNSPECIFIED (0):
Node type is unspecified.
- GCP_ORGANIZATION (1):
The node represents a Google Cloud organization.
- GCP_FOLDER (2):
The node represents a Google Cloud folder.
- GCP_PROJECT (3):
The node represents a Google Cloud project.
- AWS_ORGANIZATION (4):
The node represents an AWS organization.
- AWS_ORGANIZATIONAL_UNIT (5):
The node represents an AWS organizational unit.
- AWS_ACCOUNT (6):
The node represents an AWS account.
- AZURE_MANAGEMENT_GROUP (7):
The node represents an Azure management group.
- AZURE_SUBSCRIPTION (8):
The node represents an Azure subscription.
- AZURE_RESOURCE_GROUP (9):
The node represents an Azure resource group.
- class google.cloud.securitycenter_v1.types.ResourceValue(value)[source]¶
Bases:
proto.enums.EnumValue enum to map to a resource
- Values:
- RESOURCE_VALUE_UNSPECIFIED (0):
Unspecific value
- HIGH (1):
High resource value
- MEDIUM (2):
Medium resource value
- LOW (3):
Low resource value
- NONE (4):
No resource value, e.g. ignore these resources
- class google.cloud.securitycenter_v1.types.ResourceValueConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA resource value configuration (RVC) is a mapping configuration of user’s resources to resource values. Used in Attack path simulations.
- resource_value¶
Required. Resource value level this expression represents
- tag_values¶
Required. Tag values combined with
ANDto check against. Values in the form “tagValues/123” Example:[ "tagValues/123", "tagValues/456", "tagValues/789" ]https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing- Type
MutableSequence[str]
- resource_type¶
Apply resource_value only to resources that match resource_type. resource_type will be checked with
ANDof other resources. For example, “storage.googleapis.com/Bucket” with resource_value “HIGH” will apply “HIGH” value only to “storage.googleapis.com/Bucket” resources.- Type
- scope¶
Project or folder to scope this configuration to. For example, “project/456” would apply this configuration only to resources in “project/456” scope will be checked with
ANDof other resources.- Type
- resource_labels_selector¶
List of resource labels to search for, evaluated with
AND. For example,"resource_labels_selector": {"key": "value", "env": "prod"}will match resources with labels “key”: “value”AND“env”: “prod” https://cloud.google.com/resource-manager/docs/creating-managing-labels
- create_time¶
Output only. Timestamp this resource value configuration was created.
- update_time¶
Output only. Timestamp this resource value configuration was last updated.
- cloud_provider¶
Cloud provider this configuration applies to
- sensitive_data_protection_mapping¶
A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. “bigquery.googleapis.com/Dataset”.
- class ResourceLabelsSelectorEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class SensitiveDataProtectionMapping(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResource value mapping for Sensitive Data Protection findings. If any of these mappings have a resource value that is not unspecified, the resource_value field will be ignored when reading this configuration.
- high_sensitivity_mapping¶
Resource value mapping for high-sensitivity Sensitive Data Protection findings
- medium_sensitivity_mapping¶
Resource value mapping for medium-sensitivity Sensitive Data Protection findings
- class google.cloud.securitycenter_v1.types.ResourceValueConfigMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMetadata about a ResourceValueConfig. For example, id and name.
- class google.cloud.securitycenter_v1.types.RunAssetDiscoveryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for running asset discovery for an organization.
- class google.cloud.securitycenter_v1.types.RunAssetDiscoveryResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse of asset discovery run
- state¶
The state of an asset discovery run.
- duration¶
The duration between asset discovery run start and end
- class State(value)[source]¶
Bases:
proto.enums.EnumThe state of an asset discovery run.
- Values:
- STATE_UNSPECIFIED (0):
Asset discovery run state was unspecified.
- COMPLETED (1):
Asset discovery run completed successfully.
- SUPERSEDED (2):
Asset discovery run was cancelled with tasks still pending, as another run for the same organization was started with a higher priority.
- TERMINATED (3):
Asset discovery run was killed and terminated.
- class google.cloud.securitycenter_v1.types.SecurityBulletin(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSecurityBulletin are notifications of vulnerabilities of Google products.
- submission_time¶
Submission time of this Security Bulletin.
- class google.cloud.securitycenter_v1.types.SecurityHealthAnalyticsCustomModule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects.
- name¶
Immutable. The resource name of the custom module. Its format is “organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}”, or “folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}”, or “projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}”
The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
- Type
- display_name¶
The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.
- Type
- enablement_state¶
The enablement state of the custom module.
- update_time¶
Output only. The time at which the custom module was last updated.
- ancestor_module¶
Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise,
ancestor_modulespecifies the organization or folder from which the custom module is inherited.- Type
- custom_config¶
The user specified custom configuration for the module.
- class EnablementState(value)[source]¶
Bases:
proto.enums.EnumPossible enablement states of a custom module.
- Values:
- ENABLEMENT_STATE_UNSPECIFIED (0):
Unspecified enablement state.
- ENABLED (1):
The module is enabled at the given CRM resource.
- DISABLED (2):
The module is disabled at the given CRM resource.
- INHERITED (3):
State is inherited from an ancestor module. The module will either be effectively ENABLED or DISABLED based on its closest non-inherited ancestor module in the CRM hierarchy.
- class google.cloud.securitycenter_v1.types.SecurityMarks(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUser 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.
- name¶
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”.
- Type
- marks¶
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)
- canonical_name¶
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”.
- Type
- class MarksEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.securitycenter_v1.types.SecurityPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInformation about the Google Cloud Armor security policy relevant to the finding.
- name¶
The name of the Google Cloud Armor security policy, for example, “my-security-policy”.
- Type
- type_¶
The type of Google Cloud Armor security policy for example, ‘backend security policy’, ‘edge security policy’, ‘network edge security policy’, or ‘always-on DDoS protection’.
- Type
- class google.cloud.securitycenter_v1.types.SecurityPosture(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud.
- posture_deployment_resource¶
The project, folder, or organization on which the posture is deployed, for example,
projects/{project_number}.- Type
- posture_deployment¶
The name of the posture deployment, for example,
organizations/{org_id}/posturedeployments/{posture_deployment_id}.- Type
- changed_policy¶
The name of the updated policy, for example,
projects/{project_id}/policies/{constraint_name}.- Type
- policy_drift_details¶
The details about a change in an updated policy that violates the deployed posture.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.SecurityPosture.PolicyDriftDetails]
- class PolicyDriftDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe policy field that violates the deployed posture and its expected and detected values.
- field¶
The name of the updated field, for example constraint.implementation.policy_rules[0].enforce
- Type
- expected_value¶
The value of this field that was configured in a posture, for example,
trueorallowed_values={"projects/29831892"}.- Type
- class google.cloud.securitycenter_v1.types.ServiceAccountDelegationInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageIdentity delegation history of an authenticated service account.
- principal_subject¶
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 beprincipal://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 formatserviceAccount:{identity pool name}[{subject}]- Type
- class google.cloud.securitycenter_v1.types.SetFindingStateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for updating a finding’s state.
- name¶
Required. The 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}.- Type
- state¶
Required. The desired State of the finding.
- start_time¶
Required. The time at which the updated state takes effect.
- class google.cloud.securitycenter_v1.types.SetMuteRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for updating a finding’s mute status.
- name¶
Required. The 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}.- Type
- mute¶
Required. The desired state of the Mute.
- class google.cloud.securitycenter_v1.types.SimulateSecurityHealthAnalyticsCustomModuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message to simulate a CustomConfig against a given test resource. Maximum size of the request is 4 MB by default.
- parent¶
Required. The relative resource name of the organization, project, or folder. For more information about relative resource names, see Relative Resource Name Example:
organizations/{organization_id}- Type
- custom_config¶
Required. The custom configuration that you need to test.
- resource¶
Required. Resource data to simulate custom module against.
- class SimulatedResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageManually constructed resource name. If the custom module evaluates against only the resource data, you can omit the
iam_policy_datafield. If it evaluates only theiam_policy_datafield, you can omit the resource data.- resource_type¶
Required. The type of the resource, for example,
compute.googleapis.com/Disk.- Type
- resource_data¶
Optional. A representation of the Google Cloud resource. Should match the Google Cloud resource JSON format.
- iam_policy_data¶
Optional. A representation of the IAM policy.
- Type
google.iam.v1.policy_pb2.Policy
- class google.cloud.securitycenter_v1.types.SimulateSecurityHealthAnalyticsCustomModuleResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for simulating a
SecurityHealthAnalyticsCustomModuleagainst a given resource.- result¶
Result for test case in the corresponding request.
- class SimulatedResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePossible test result.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- finding¶
Finding that would be published for the test case, if a violation is detected.
This field is a member of oneof
result.
- class google.cloud.securitycenter_v1.types.Simulation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAttack path simulation
- create_time¶
Output only. Time simulation was created
- resource_value_configs_metadata¶
Resource value configurations’ metadata used in this simulation. Maximum of 100.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.ResourceValueConfigMetadata]
- cloud_provider¶
Indicates which cloud provider was used in this simulation.
- class google.cloud.securitycenter_v1.types.Source(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSecurity Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, and other tools.
- name¶
The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: “organizations/{organization_id}/sources/{source_id}”.
- Type
- display_name¶
The source’s display name. A source’s display name must be unique amongst its siblings, for example, two sources with the same parent can’t share the same display name. The display name must have a length between 1 and 64 characters (inclusive).
- Type
- description¶
The description of the source (max of 1024 characters). Example:
“Web Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated or insecure libraries.”.
- Type
- canonical_name¶
The canonical name of the finding source. It’s either “organizations/{organization_id}/sources/{source_id}”, “folders/{folder_id}/sources/{source_id}”, or “projects/{project_number}/sources/{source_id}”, depending on the closest CRM ancestor of the resource associated with the finding.
- Type
- class google.cloud.securitycenter_v1.types.ToxicCombination(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageContains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination.
- attack_exposure_score¶
The Attack exposure score of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack.
- Type
List of resource names of findings associated with this toxic combination. For example,
organizations/123/sources/456/findings/789.- Type
MutableSequence[str]
- class google.cloud.securitycenter_v1.types.UpdateBigQueryExportRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for updating a BigQuery export.
- big_query_export¶
Required. The BigQuery export being updated.
- update_mask¶
The list of fields to be updated. If empty all mutable fields will be updated.
- class google.cloud.securitycenter_v1.types.UpdateEventThreatDetectionCustomModuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to update an Event Threat Detection custom module.
- event_threat_detection_custom_module¶
Required. The module being updated.
- update_mask¶
The list of fields to be updated. If empty all mutable fields will be updated.
- class google.cloud.securitycenter_v1.types.UpdateExternalSystemRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for updating a ExternalSystem resource.
- external_system¶
Required. The external system resource to update.
- update_mask¶
The FieldMask to use when updating the external system resource. If empty all mutable fields will be updated.
- class google.cloud.securitycenter_v1.types.UpdateFindingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for updating or creating a finding.
- finding¶
Required. The finding resource to update or create if it does not already exist. parent, security_marks, and update_time will be ignored.
In the case of creation, the finding id portion of the name must be alphanumeric and less than or equal to 32 characters and greater than 0 characters in length.
- update_mask¶
The FieldMask to use when updating the finding resource. This field should not be specified when creating a finding.
When updating a finding, an empty mask is treated as updating all mutable fields and replacing source_properties. Individual source_properties can be added/updated by using “source_properties.” in the field mask.
- class google.cloud.securitycenter_v1.types.UpdateMuteConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for updating a mute config.
- mute_config¶
Required. The mute config being updated.
- update_mask¶
The list of fields to be updated. If empty all mutable fields will be updated.
- class google.cloud.securitycenter_v1.types.UpdateNotificationConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for updating a notification config.
- notification_config¶
Required. The notification config to update.
- update_mask¶
The FieldMask to use when updating the notification config. If empty all mutable fields will be updated.
- class google.cloud.securitycenter_v1.types.UpdateOrganizationSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for updating an organization’s settings.
- organization_settings¶
Required. The organization settings resource to update.
- update_mask¶
The FieldMask to use when updating the settings resource. If empty all mutable fields will be updated.
- class google.cloud.securitycenter_v1.types.UpdateResourceValueConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message to update resource value config
- resource_value_config¶
Required. The resource value config being updated.
- update_mask¶
The list of fields to be updated. If empty all mutable fields will be updated.
- class google.cloud.securitycenter_v1.types.UpdateSecurityHealthAnalyticsCustomModuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for updating Security Health Analytics custom modules.
- security_health_analytics_custom_module¶
Required. The SecurityHealthAnalytics custom module to update.
- update_mask¶
The list of fields to be updated. The only fields that can be updated are
enablement_stateandcustom_config. If empty or set to the wildcard value*, bothenablement_stateandcustom_configare updated.
- class google.cloud.securitycenter_v1.types.UpdateSecurityMarksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for updating a SecurityMarks resource.
- security_marks¶
Required. The security marks resource to update.
- update_mask¶
The FieldMask to use when updating the security marks resource.
The field mask must not contain duplicate fields. If empty or set to “marks”, all marks will be replaced. Individual marks can be updated using “marks.<mark_key>”.
- start_time¶
The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time. Must be earlier or equal to the server time.
- class google.cloud.securitycenter_v1.types.UpdateSourceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for updating a source.
- source¶
Required. The source resource to update.
- update_mask¶
The FieldMask to use when updating the source resource. If empty all mutable fields will be updated.
- class google.cloud.securitycenter_v1.types.ValidateEventThreatDetectionCustomModuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to validate an Event Threat Detection custom module.
- parent¶
Required. Resource name of the parent to validate the Custom Module under.
Its format is:
organizations/{organization}/eventThreatDetectionSettings.folders/{folder}/eventThreatDetectionSettings.projects/{project}/eventThreatDetectionSettings.
- Type
- raw_text¶
Required. The raw text of the module’s contents. Used to generate error messages.
- Type
- class google.cloud.securitycenter_v1.types.ValidateEventThreatDetectionCustomModuleResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse to validating an Event Threat Detection custom module.
- errors¶
A list of errors returned by the validator. If the list is empty, there were no errors.
- class google.cloud.securitycenter_v1.types.ValuedResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA resource that is determined to have value to a user’s system
- name¶
Valued resource name, for example, e.g.:
organizations/123/simulations/456/valuedResources/789- Type
- resource¶
The full resource name of the valued resource.
- Type
- resource_type¶
The resource type of the valued resource.
- Type
- resource_value¶
How valuable this resource is.
- exposed_score¶
Exposed score for this valued resource. A value of 0 means no exposure was detected exposure.
- Type
- resource_value_configs_used¶
List of resource value configurations’ metadata used to determine the value of this resource. Maximum of 100.
- Type
MutableSequence[google.cloud.securitycenter_v1.types.ResourceValueConfigMetadata]
- class ResourceValue(value)[source]¶
Bases:
proto.enums.EnumHow valuable the resource is.
- Values:
- RESOURCE_VALUE_UNSPECIFIED (0):
The resource value isn’t specified.
- RESOURCE_VALUE_LOW (1):
This is a low-value resource.
- RESOURCE_VALUE_MEDIUM (2):
This is a medium-value resource.
- RESOURCE_VALUE_HIGH (3):
This is a high-value resource.
- class google.cloud.securitycenter_v1.types.Vulnerability(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRefers to common vulnerability fields e.g. cve, cvss, cwe etc.
- cve¶
CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)
- offending_package¶
The offending package is relevant to the finding.
- fixed_package¶
The fixed package is relevant to the finding.
- security_bulletin¶
The security bulletin is relevant to this finding.
