API documentation for securitycenter_v1.types
package.
Classes
Asset
Security Command Center representation of a Google Cloud resource.
The Asset is a Security Command Center resource that captures information about a single Google Cloud resource. All modifications to an Asset are only within the context of Security Command Center and don't affect the referenced Google Cloud resource.
CreateFindingRequest
Request message for creating a finding. .. attribute:: parent
Required. Resource name of the new finding's parent. Its format should be "organizations/[organization_id]/sources/[source_id]".
:type: str
CreateNotificationConfigRequest
Request message for creating a notification config. .. attribute:: parent
Required. Resource name of the new notification config's parent. Its format is "organizations/[organization_id]".
:type: str
CreateSourceRequest
Request message for creating a source. .. attribute:: parent
Required. Resource name of the new source's parent. Its format should be "organizations/[organization_id]".
:type: str
DeleteNotificationConfigRequest
Request message for deleting a notification config. .. attribute:: name
Required. Name of the notification config to delete. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]".
:type: str
Finding
Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding.
Folder
Message that contains the resource name and display name of a folder resource.
GetNotificationConfigRequest
Request message for getting a notification config. .. attribute:: name
Required. Name of the notification config to get. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]".
:type: str
GetOrganizationSettingsRequest
Request message for getting organization settings. .. attribute:: name
Required. Name of the organization to get organization settings for. Its format is "organizations/[organization_id]/organizationSettings".
:type: str
GetSourceRequest
Request message for getting a source. .. attribute:: name
Required. Relative resource name of the source. Its format is "organizations/[organization_id]/source/[source_id]".
:type: str
GroupAssetsRequest
Request message for grouping by assets. .. attribute:: parent
Required. Name of the organization to groupBy. Its format is "organizations/[organization_id], folders/[folder_id], or projects/[project_id]".
:type: str
GroupAssetsResponse
Response message for grouping by assets. .. attribute:: 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: Sequence[google.cloud.securitycenter_v1.types.GroupResult]
GroupFindingsRequest
Request message for grouping by findings. .. attribute:: parent
Required. Name of the source to groupBy. Its format is
"organizations/[organization_id]/sources/[source_id]",
folders/[folder_id]/sources/[source_id], or
projects/[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/-, or
projects/{project_id}/sources/-
:type: str
GroupFindingsResponse
Response message for group by findings. .. attribute:: 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: Sequence[google.cloud.securitycenter_v1.types.GroupResult]
GroupResult
Result containing the properties and count of a groupBy request.
ListAssetsRequest
Request message for listing assets. .. attribute:: parent
Required. Name of the organization assets should belong to. Its format is "organizations/[organization_id], folders/[folder_id], or projects/[project_id]".
:type: str
ListAssetsResponse
Response message for listing assets. .. attribute:: list_assets_results
Assets matching the list request.
:type: Sequence[google.cloud.securitycenter_v1.types.ListAssetsResponse.ListAssetsResult]
ListFindingsRequest
Request message for listing findings. .. attribute:: 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], or
projects/[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/- or
projects/{projects_id}/sources/-
:type: str
ListFindingsResponse
Response message for listing findings. .. attribute:: list_findings_results
Findings matching the list request.
:type: Sequence[google.cloud.securitycenter_v1.types.ListFindingsResponse.ListFindingsResult]
ListNotificationConfigsRequest
Request message for listing notification configs. .. attribute:: parent
Required. Name of the organization to list notification configs. Its format is "organizations/[organization_id]".
:type: str
ListNotificationConfigsResponse
Response message for listing notification configs. .. attribute:: notification_configs
Notification configs belonging to the requested parent.
:type: Sequence[google.cloud.securitycenter_v1.types.NotificationConfig]
ListSourcesRequest
Request message for listing sources. .. attribute:: parent
Required. Resource name of the parent of sources to list. Its format should be "organizations/[organization_id], folders/[folder_id], or projects/[project_id]".
:type: str
ListSourcesResponse
Response message for listing sources. .. attribute:: sources
Sources belonging to the requested parent.
:type: Sequence[google.cloud.securitycenter_v1.types.Source]
NotificationConfig
Cloud 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.
NotificationMessage
Cloud SCC's Notification .. attribute:: notification_config_name
Name of the notification config that generated current notification.
:type: str
OrganizationSettings
User specified settings that are attached to the Security Command Center organization.
Resource
Information related to the Google Cloud resource. .. attribute:: name
The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name
:type: str
RunAssetDiscoveryRequest
Request message for running asset discovery for an organization.
RunAssetDiscoveryResponse
Response of asset discovery run .. attribute:: state
The state of an asset discovery run.
:type: google.cloud.securitycenter_v1.types.RunAssetDiscoveryResponse.State
SecurityMarks
User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.
SetFindingStateRequest
Request message for updating a finding's state. .. attribute:: name
Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/finding/{finding_id}".
:type: str
Source
Security 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.
UpdateFindingRequest
Request message for updating or creating a finding. .. attribute:: 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.
UpdateNotificationConfigRequest
Request message for updating a notification config. .. attribute:: notification_config
Required. The notification config to update.
:type: google.cloud.securitycenter_v1.types.NotificationConfig
UpdateOrganizationSettingsRequest
Request message for updating an organization's settings. .. attribute:: organization_settings
Required. The organization settings resource to update.
:type: google.cloud.securitycenter_v1.types.OrganizationSettings
UpdateSecurityMarksRequest
Request message for updating a SecurityMarks resource. .. attribute:: security_marks
Required. The security marks resource to update.
UpdateSourceRequest
Request message for updating a source. .. attribute:: source
Required. The source resource to update.